cisco.ise.node_services_profiler_probe_config – Resource module for Node Services Profiler Probe Config

Note

This plugin is part of the cisco.ise collection (version 2.1.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.ise.

To use it in a playbook, specify: cisco.ise.node_services_profiler_probe_config.

New in version 2.1.0: of cisco.ise

Synopsis

  • Manage operation update of the resource Node Services Profiler Probe Config.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • ciscoisesdk >= 1.3.0

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
activeDirectory
dictionary
The Active Directory probe queries the Active Directory for Windows information.
daysBeforeRescan
integer
Node Services Profiler Probe Config's daysBeforeRescan.
dhcp
dictionary
The DHCP probe listens for DHCP packets from IP helpers.
interfaces
list / elements=string
Node Services Profiler Probe Config's interfaces.
interface
string
Node Services Profiler Probe Config's interface.
port
integer
Node Services Profiler Probe Config's port.
dhcpSpan
dictionary
The DHCP SPAN probe collects DHCP packets.
interfaces
list / elements=string
Node Services Profiler Probe Config's interfaces.
interface
string
Node Services Profiler Probe Config's interface.
dns
dictionary
The DNS probe performs a DNS lookup for the FQDN.
timeout
integer
Node Services Profiler Probe Config's timeout.
hostname
string
Hostname path parameter. Hostname of the node.
http
dictionary
The HTTP probe receives and parses HTTP packets.
interfaces
list / elements=string
Node Services Profiler Probe Config's interfaces.
interface
string
Node Services Profiler Probe Config's interface.
ise_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Identity Services Engine SDK to enable debugging.
ise_hostname
string / required
The Identity Services Engine hostname.
ise_password
string / required
The Identity Services Engine password to authenticate.
ise_username
string / required
The Identity Services Engine username to authenticate.
ise_uses_api_gateway
boolean
added in 1.1.0 of cisco.ise
    Choices:
  • no
  • yes ←
Flag that informs the SDK whether to use the Identity Services Engine's API Gateway to send requests.
If it is true, it uses the ISE's API Gateway and sends requests to https://{{ise_hostname}}.
If it is false, it sends the requests to https://{{ise_hostname}}:{{port}}, where the port value depends on the Service used (ERS, Mnt, UI, PxGrid).
ise_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
ise_version
string
Default:
"3.1.1"
Informs the SDK which version of Identity Services Engine to use.
ise_wait_on_rate_limit
boolean
    Choices:
  • no
  • yes ←
Flag for Identity Services Engine SDK to enable automatic rate-limit handling.
netflow
dictionary
The NetFlow probe collects the NetFlow packets that are sent to it from routers.
interfaces
list / elements=string
Node Services Profiler Probe Config's interfaces.
interface
string
Node Services Profiler Probe Config's interface.
port
integer
Node Services Profiler Probe Config's port.
nmap
list / elements=dictionary
The NMAP probe scans endpoints for open ports and OS.
pxgrid
list / elements=dictionary
The pxGrid probe fetches attributes of MAC address or IP address as a subscriber from the pxGrid queue.
radius
list / elements=dictionary
The RADIUS probe collects RADIUS session attributes as well as CDP, LLDP, DHCP, HTTP, and MDM attributes from IOS Sensors.
snmpQuery
dictionary
The SNMP query probe collects details from network devices such as interface, CDP, LLDP, and ARP.
eventTimeout
integer
Node Services Profiler Probe Config's eventTimeout.
retries
integer
Node Services Profiler Probe Config's retries.
timeout
integer
Node Services Profiler Probe Config's timeout.
snmpTrap
dictionary
The SNMP trap probe receives linkup, linkdown, and MAC notification traps from network devices.
interfaces
list / elements=string
Node Services Profiler Probe Config's interfaces.
interface
string
Node Services Profiler Probe Config's interface.
linkTrapQuery
boolean
    Choices:
  • no
  • yes
LinkTrapQuery flag.
macTrapQuery
boolean
    Choices:
  • no
  • yes
MacTrapQuery flag.
port
integer
Node Services Profiler Probe Config's port.

Notes

Note

  • Does not support check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco ISE SDK

  • The parameters starting with ise_ are used by the Cisco ISE Python SDK to establish the connection

See Also

See also

Node Services Profiler Probe Config reference

Complete reference of the Node Services Profiler Probe Config object model.

Examples

- name: Update by name
  cisco.ise.node_services_profiler_probe_config:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    activeDirectory:
      daysBeforeRescan: 0
    dhcp:
      interfaces:
      - interface: string
      port: 0
    dhcpSpan:
      interfaces:
      - interface: string
    dns:
      timeout: 0
    hostname: string
    http:
      interfaces:
      - interface: string
    netflow:
      interfaces:
      - interface: string
      port: 0
    nmap:
    - {}
    pxgrid:
    - {}
    radius:
    - {}
    snmpQuery:
      eventTimeout: 0
      retries: 0
      timeout: 0
    snmpTrap:
      interfaces:
      - interface: string
      linkTrapQuery: true
      macTrapQuery: true
      port: 0

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
ise_response
dictionary
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "activeDirectory": { "daysBeforeRescan": 0 }, "dhcp": { "interfaces": [ { "interface": "string" } ], "port": 0 }, "dhcpSpan": { "interfaces": [ { "interface": "string" } ] }, "dns": { "timeout": 0 }, "http": { "interfaces": [ { "interface": "string" } ] }, "netflow": { "interfaces": [ { "interface": "string" } ], "port": 0 }, "nmap": [ {} ], "pxgrid": [ {} ], "radius": [ {} ], "snmpQuery": { "eventTimeout": 0, "retries": 0, "timeout": 0 }, "snmpTrap": { "interfaces": [ { "interface": "string" } ], "linkTrapQuery": true, "macTrapQuery": true, "port": 0 } }
ise_update_response
dictionary
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "success": { "message": "string" }, "version": "string" }


Authors

  • Rafael Campos (@racampos)