.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-entry .. role:: ansible-option-default .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.node_services_profiler_probe_config -- Resource module for Node Services Profiler Probe Config ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.ise collection `_ (version 2.2.0). 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 :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install cisco.ise`. To use it in a playbook, specify: :code:`cisco.ise.node_services_profiler_probe_config`. .. version_added .. versionadded:: 2.1.0 of cisco.ise .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - 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 :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - ciscoisesdk >= 1.4.0 - python >= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-activeDirectory: .. rst-class:: ansible-option-title **activeDirectory** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The Active Directory probe queries the Active Directory for Windows information. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-activeDirectory/daysBeforeRescan: .. rst-class:: ansible-option-title **daysBeforeRescan** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Node Services Profiler Probe Config's daysBeforeRescan. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-dhcp: .. rst-class:: ansible-option-title **dhcp** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The DHCP probe listens for DHCP packets from IP helpers. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-dhcp/interfaces: .. rst-class:: ansible-option-title **interfaces** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Node Services Profiler Probe Config's interfaces. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-dhcp/interfaces/interface: .. rst-class:: ansible-option-title **interface** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Node Services Profiler Probe Config's interface. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-dhcp/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Node Services Profiler Probe Config's port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-dhcpSpan: .. rst-class:: ansible-option-title **dhcpSpan** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The DHCP SPAN probe collects DHCP packets. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-dhcpSpan/interfaces: .. rst-class:: ansible-option-title **interfaces** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Node Services Profiler Probe Config's interfaces. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-dhcpSpan/interfaces/interface: .. rst-class:: ansible-option-title **interface** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Node Services Profiler Probe Config's interface. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-dns: .. rst-class:: ansible-option-title **dns** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The DNS probe performs a DNS lookup for the FQDN. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-dns/timeout: .. rst-class:: ansible-option-title **timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Node Services Profiler Probe Config's timeout. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-hostname: .. rst-class:: ansible-option-title **hostname** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Hostname path parameter. Hostname of the node. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-http: .. rst-class:: ansible-option-title **http** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The HTTP probe receives and parses HTTP packets. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-http/interfaces: .. rst-class:: ansible-option-title **interfaces** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Node Services Profiler Probe Config's interfaces. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-http/interfaces/interface: .. rst-class:: ansible-option-title **interface** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Node Services Profiler Probe Config's interface. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-ise_debug: .. rst-class:: ansible-option-title **ise_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Identity Services Engine SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` - :ansible-option-choices-entry:`yes` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-ise_hostname: .. rst-class:: ansible-option-title **ise_hostname** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-ise_password: .. rst-class:: ansible-option-title **ise_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-ise_username: .. rst-class:: ansible-option-title **ise_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine username to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-ise_uses_api_gateway: .. rst-class:: ansible-option-title **ise_uses_api_gateway** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` :ansible-option-versionadded:`added in 1.1.0 of cisco.ise` .. raw:: html
- .. raw:: html
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). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-ise_verify: .. rst-class:: ansible-option-title **ise_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-ise_version: .. rst-class:: ansible-option-title **ise_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Identity Services Engine to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1.1"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-ise_wait_on_rate_limit: .. rst-class:: ansible-option-title **ise_wait_on_rate_limit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-netflow: .. rst-class:: ansible-option-title **netflow** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The NetFlow probe collects the NetFlow packets that are sent to it from routers. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-netflow/interfaces: .. rst-class:: ansible-option-title **interfaces** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Node Services Profiler Probe Config's interfaces. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-netflow/interfaces/interface: .. rst-class:: ansible-option-title **interface** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Node Services Profiler Probe Config's interface. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-netflow/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Node Services Profiler Probe Config's port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-nmap: .. rst-class:: ansible-option-title **nmap** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
The NMAP probe scans endpoints for open ports and OS. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-pxgrid: .. rst-class:: ansible-option-title **pxgrid** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
The pxGrid probe fetches attributes of MAC address or IP address as a subscriber from the pxGrid queue. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-radius: .. rst-class:: ansible-option-title **radius** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
The RADIUS probe collects RADIUS session attributes as well as CDP, LLDP, DHCP, HTTP, and MDM attributes from IOS Sensors. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-snmpQuery: .. rst-class:: ansible-option-title **snmpQuery** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The SNMP query probe collects details from network devices such as interface, CDP, LLDP, and ARP. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-snmpQuery/eventTimeout: .. rst-class:: ansible-option-title **eventTimeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Node Services Profiler Probe Config's eventTimeout. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-snmpQuery/retries: .. rst-class:: ansible-option-title **retries** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Node Services Profiler Probe Config's retries. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-snmpQuery/timeout: .. rst-class:: ansible-option-title **timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Node Services Profiler Probe Config's timeout. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-snmpTrap: .. rst-class:: ansible-option-title **snmpTrap** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The SNMP trap probe receives linkup, linkdown, and MAC notification traps from network devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-snmpTrap/interfaces: .. rst-class:: ansible-option-title **interfaces** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Node Services Profiler Probe Config's interfaces. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-snmpTrap/interfaces/interface: .. rst-class:: ansible-option-title **interface** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Node Services Profiler Probe Config's interface. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-snmpTrap/linkTrapQuery: .. rst-class:: ansible-option-title **linkTrapQuery** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
LinkTrapQuery flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-choices-entry:`yes` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-snmpTrap/macTrapQuery: .. rst-class:: ansible-option-title **macTrapQuery** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
MacTrapQuery flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-choices-entry:`yes` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__parameter-snmpTrap/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Node Services Profiler Probe Config's port. .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are node_services.NodeServices.set_profiler_probe_config, - Paths used are put /api/v1/profile/{hostname} - Does not support \ :literal:`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 .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__return-ise_response: .. rst-class:: ansible-option-title **ise_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco ISE Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`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" .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.node_services_profiler_probe_config_module__return-ise_update_response: .. rst-class:: ansible-option-title **ise_update_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco ISE Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` "{\\n \\"success\\": {\\n \\"message\\": \\"string\\"\\n },\\n \\"version\\": \\"string\\"\\n}\\n" .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors