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.5.9).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.ise.node_services_profiler_probe_config
.
New in cisco.ise 2.1.0
Synopsis
Manage operation update of the resource Node Services Profiler Probe Config.
This API updates the profiler probe configuration of a PSN.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
ciscoisesdk >= 2.0.8
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
The Active Directory probe queries the Active Directory for Windows information. |
|
Node Services Profiler Probe Config’s daysBeforeRescan. |
|
The DHCP probe listens for DHCP packets from IP helpers. |
|
Node Services Profiler Probe Config’s interfaces. |
|
Node Services Profiler Probe Config’s interface. |
|
Node Services Profiler Probe Config’s port. |
|
The DHCP SPAN probe collects DHCP packets. |
|
Node Services Profiler Probe Config’s interfaces. |
|
Node Services Profiler Probe Config’s interface. |
|
The DNS probe performs a DNS lookup for the FQDN. |
|
Node Services Profiler Probe Config’s timeout. |
|
Hostname path parameter. Hostname of the node. |
|
The HTTP probe receives and parses HTTP packets. |
|
Node Services Profiler Probe Config’s interfaces. |
|
Node Services Profiler Probe Config’s interface. |
|
Flag for Identity Services Engine SDK to enable debugging. Choices:
|
|
The Identity Services Engine hostname. |
|
The Identity Services Engine password to authenticate. |
|
The Identity Services Engine username to authenticate. |
|
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:
|
|
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:
|
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Identity Services Engine to use. Default: |
|
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices:
|
|
The NetFlow probe collects the NetFlow packets that are sent to it from routers. |
|
Node Services Profiler Probe Config’s interfaces. |
|
Node Services Profiler Probe Config’s interface. |
|
Node Services Profiler Probe Config’s port. |
|
The NMAP probe scans endpoints for open ports and OS. |
|
The pxGrid probe fetches attributes of MAC address or IP address as a subscriber from the pxGrid queue. |
|
The RADIUS probe collects RADIUS session attributes as well as CDP, LLDP, DHCP, HTTP, and MDM attributes from IOS Sensors. |
|
The SNMP query probe collects details from network devices such as interface, CDP, LLDP, and ARP. |
|
Node Services Profiler Probe Config’s eventTimeout. |
|
Node Services Profiler Probe Config’s retries. |
|
Node Services Profiler Probe Config’s timeout. |
|
The SNMP trap probe receives linkup, linkdown, and MAC notification traps from network devices. |
|
Node Services Profiler Probe Config’s interfaces. |
|
Node Services Profiler Probe Config’s interface. |
|
LinkTrapQuery flag. Choices:
|
|
MacTrapQuery flag. Choices:
|
|
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
See Also
See also
- Cisco ISE documentation for Node Services
Complete reference of the Node Services API.
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 |
---|---|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: |
|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: |