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

Note

This module is part of the cisco.ise collection (version 2.3.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.

• This API updates the profiler probe configuration of a PSN. Set probe value as null to disable probe.

Note

This module has a corresponding action plugin.

Requirements

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

• ciscoisesdk >= 2.0.1

• python >= 3.5

Parameters

Parameter	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=dictionary	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=dictionary	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=dictionary	Node Services Profiler Probe Config’s interfaces.
interface string	Node Services Profiler Probe Config’s interface.
ise_debug boolean	Flag for Identity Services Engine SDK to enable debugging. Choices: no ← (default) yes
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	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). Choices: no yes ← (default)
ise_uses_csrf_token boolean added in 3.0.0 of cisco.ise	Flag that informs the SDK whether we send the CSRF token to ISE’s ERS APIs. If it is True, the SDK assumes that your ISE CSRF Check is enabled. If it is True, it assumes you need the SDK to manage the CSRF token automatically for you. Choices: no ← (default) yes
ise_verify boolean	Flag to enable or disable SSL certificate verification. Choices: no yes ← (default)
ise_version string	Informs the SDK which version of Identity Services Engine to use. Default: “3.1.1”
ise_wait_on_rate_limit boolean	Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: no yes ← (default)
netflow dictionary	The NetFlow probe collects the NetFlow packets that are sent to it from routers.
interfaces list / elements=dictionary	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=dictionary	Node Services Profiler Probe Config’s interfaces.
interface string	Node Services Profiler Probe Config’s interface.
linkTrapQuery boolean	LinkTrapQuery flag. Choices: no yes
macTrapQuery boolean	MacTrapQuery flag. Choices: no yes
port integer	Node Services Profiler Probe Config’s port.

Notes

Note

• SDK Method used are node_services.NodeServices.set_profiler_probe_config,

• Paths used are put /api/v1/profile/{hostname}

• 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

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	Description
ise_response dictionary	A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: “{\n \”activeDirectory\”: {\n \”daysBeforeRescan\”: 0\n },\n \”dhcp\”: {\n \”interfaces\”: [\n {\n \”interface\”: \”string\”\n }\n ],\n \”port\”: 0\n },\n \”dhcpSpan\”: {\n \”interfaces\”: [\n {\n \”interface\”: \”string\”\n }\n ]\n },\n \”dns\”: {\n \”timeout\”: 0\n },\n \”http\”: {\n \”interfaces\”: [\n {\n \”interface\”: \”string\”\n }\n ]\n },\n \”netflow\”: {\n \”interfaces\”: [\n {\n \”interface\”: \”string\”\n }\n ],\n \”port\”: 0\n },\n \”nmap\”: [\n {}\n ],\n \”pxgrid\”: [\n {}\n ],\n \”radius\”: [\n {}\n ],\n \”snmpQuery\”: {\n \”eventTimeout\”: 0,\n \”retries\”: 0,\n \”timeout\”: 0\n },\n \”snmpTrap\”: {\n \”interfaces\”: [\n {\n \”interface\”: \”string\”\n }\n ],\n \”linkTrapQuery\”: true,\n \”macTrapQuery\”: true,\n \”port\”: 0\n }\n}\n”
ise_update_response dictionary	A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: “{\n \”success\”: {\n \”message\”: \”string\”\n },\n \”version\”: \”string\”\n}\n”

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)