cisco.ise.node_deployment – Resource module for Node Deployment

Note

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

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_deployment.

New in version 1.0.0: of cisco.ise

Synopsis

  • Manage operations create, update and delete of the resource Node Deployment.

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk >= 1.1.0

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
administration
dictionary
Node Deployment's administration.
isEnabled
boolean
    Choices:
  • no
  • yes
IsEnabled flag.
role
string
Node Deployment's role.
fdqn
string
Node Deployment's fdqn.
generalSettings
dictionary
Node Deployment's generalSettings.
monitoring
dictionary
Node Deployment's monitoring.
enablePXGrid
boolean
    Choices:
  • no
  • yes
EnablePXGrid flag.
isEnabled
boolean
    Choices:
  • no
  • yes
IsEnabled flag.
isMntDedicated
boolean
    Choices:
  • no
  • yes
IsMntDedicated flag.
otherMonitoringNode
string
Node Deployment's otherMonitoringNode.
policyservice
dictionary
Node Deployment's policyservice.
enabled
boolean
    Choices:
  • no
  • yes
Enabled flag.
enableDeviceAdminService
boolean
    Choices:
  • no
  • yes
EnableDeviceAdminService flag.
enableNACService
boolean
    Choices:
  • no
  • yes
EnableNACService flag.
enablePassiveIdentityService
boolean
    Choices:
  • no
  • yes
EnablePassiveIdentityService flag.
enableProfilingService
boolean
    Choices:
  • no
  • yes
EnableProfilingService flag.
sessionService
dictionary
Node Deployment's sessionService.
isEnabled
boolean
    Choices:
  • no
  • yes
IsEnabled flag.
nodegroup
string
Node Deployment's nodegroup.
sxpservice
dictionary
Node Deployment's sxpservice.
isEnabled
boolean
    Choices:
  • no
  • yes
IsEnabled flag.
userInterface
string
Node Deployment's userInterface.
role
string
Node Deployment's role.
hostname
string
Hostname path parameter. Node name of the existing deployed node.
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.0"
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.
password
string
Node Deployment's password.
profileConfiguration
dictionary
Node Deployment's profileConfiguration.
activeDirectory
dictionary
Node Deployment's activeDirectory.
daysBeforeRescan
integer
Node Deployment's daysBeforeRescan.
description
string
Node Deployment's description.
enabled
boolean
    Choices:
  • no
  • yes
Enabled flag.
dhcp
dictionary
Node Deployment's dhcp.
description
string
Node Deployment's description.
enabled
boolean
    Choices:
  • no
  • yes
Enabled flag.
interface
string
Node Deployment's interface.
port
integer
Node Deployment's port.
dhcpSpan
dictionary
Node Deployment's dhcpSpan.
description
string
Node Deployment's description.
enabled
boolean
    Choices:
  • no
  • yes
Enabled flag.
interface
string
Node Deployment's interface.
dns
dictionary
Node Deployment's dns.
description
string
Node Deployment's description.
enabled
boolean
    Choices:
  • no
  • yes
Enabled flag.
http
dictionary
Node Deployment's http.
description
string
Node Deployment's description.
enabled
boolean
    Choices:
  • no
  • yes
Enabled flag.
interface
string
Node Deployment's interface.
netflow
dictionary
Node Deployment's netflow.
description
string
Node Deployment's description.
enabled
boolean
    Choices:
  • no
  • yes
Enabled flag.
interface
string
Node Deployment's interface.
port
integer
Node Deployment's port.
nmap
dictionary
Node Deployment's nmap.
description
string
Node Deployment's description.
enabled
boolean
    Choices:
  • no
  • yes
Enabled flag.
pxgrid
dictionary
Node Deployment's pxgrid.
description
string
Node Deployment's description.
enabled
boolean
    Choices:
  • no
  • yes
Enabled flag.
radius
dictionary
Node Deployment's radius.
description
string
Node Deployment's description.
enabled
boolean
    Choices:
  • no
  • yes
Enabled flag.
snmpQuery
dictionary
Node Deployment's snmpQuery.
description
string
Node Deployment's description.
enabled
boolean
    Choices:
  • no
  • yes
Enabled flag.
eventTimeout
integer
Node Deployment's eventTimeout.
retries
integer
Node Deployment's retries.
timeout
integer
Node Deployment's timeout.
snmpTrap
dictionary
Node Deployment's snmpTrap.
description
string
Node Deployment's description.
interface
string
Node Deployment's interface.
linkTrapQuery
boolean
    Choices:
  • no
  • yes
LinkTrapQuery flag.
macTrapQuery
boolean
    Choices:
  • no
  • yes
MacTrapQuery flag.
port
integer
Node Deployment's port.
userName
string
Node Deployment's userName.

Notes

Note

  • Does not support check_mode

See Also

See also

Node Deployment reference

Complete reference of the Node Deployment object model.

Examples

- name: Create
  cisco.ise.node_deployment:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    administration:
      isEnabled: true
      role: string
    fdqn: string
    generalSettings:
      monitoring:
        enablePXGrid: true
        isEnabled: true
        isMntDedicated: true
        otherMonitoringNode: string
        policyservice:
          enableDeviceAdminService: true
          enableNACService: true
          enablePassiveIdentityService: true
          enableProfilingService: true
          enabled: true
          sessionService:
            isEnabled: true
            nodegroup: string
          sxpservice:
            isEnabled: true
            userInterface: string
        role: string
    password: string
    profileConfiguration:
      activeDirectory:
        daysBeforeRescan: 0
        description: string
        enabled: true
      dhcp:
        description: string
        enabled: true
        interface: string
        port: {}
      dhcpSpan:
        description: string
        enabled: true
        interface: string
      dns:
        description: string
        enabled: true
      http:
        description: string
        enabled: true
        interface: string
      netflow:
        description: string
        enabled: true
        interface: string
        port: {}
      nmap:
        description: string
        enabled: true
      pxgrid:
        description: string
        enabled: true
      radius:
        description: string
        enabled: true
      snmpQuery:
        description: string
        enabled: true
        eventTimeout: 0
        retries: 0
        timeout: 0
      snmpTrap:
        description: string
        interface: string
        linkTrapQuery: true
        macTrapQuery: true
        port: {}
    userName: string

- name: Update by name
  cisco.ise.node_deployment:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    generalSettings:
      monitoring:
        enablePXGrid: true
        isEnabled: true
        isMntDedicated: true
        otherMonitoringNode: string
        policyservice:
          enableDeviceAdminService: true
          enableNACService: true
          enablePassiveIdentityService: true
          enableProfilingService: true
          enabled: true
          sessionService:
            isEnabled: true
            nodegroup: string
          sxpservice:
            isEnabled: true
            userInterface: string
        role: string
    hostname: string
    profileConfiguration:
      activeDirectory:
        daysBeforeRescan: 0
        description: string
        enabled: true
      dhcp:
        description: string
        enabled: true
        interface: string
        port: {}
      dhcpSpan:
        description: string
        enabled: true
        interface: string
      dns:
        description: string
        enabled: true
      http:
        description: string
        enabled: true
        interface: string
      netflow:
        description: string
        enabled: true
        interface: string
        port: {}
      nmap:
        description: string
        enabled: true
      pxgrid:
        description: string
        enabled: true
      radius:
        description: string
        enabled: true
      snmpQuery:
        description: string
        enabled: true
        eventTimeout: 0
        retries: 0
        timeout: 0
      snmpTrap:
        description: string
        interface: string
        linkTrapQuery: true
        macTrapQuery: true
        port: {}

- name: Delete by name
  cisco.ise.node_deployment:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    hostname: string

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:
{ "hostname": "string", "fqdn": "string", "ipAddress": "string", "nodeType": "string", "administration": { "isEnabled": true, "role": "string" }, "generalSettings": { "monitoring": { "isEnabled": true, "role": "string", "otherMonitoringNode": "string", "isMntDedicated": true, "policyservice": { "enabled": true, "sessionService": { "isEnabled": true, "nodegroup": "string" }, "enableProfilingService": true, "enableNACService": true, "sxpservice": { "isEnabled": true, "userInterface": "string" }, "enableDeviceAdminService": true, "enablePassiveIdentityService": true }, "enablePXGrid": true } }, "profilingConfiguration": { "netflow": { "enabled": true, "interface": "string", "port": {}, "description": "string" }, "dhcp": { "enabled": true, "interface": "string", "port": {}, "description": "string" }, "dhcpSpan": { "enabled": true, "interface": "string", "description": "string" }, "http": { "enabled": true, "interface": "string", "description": "string" }, "radius": { "enabled": true, "description": "string" }, "nmap": { "enabled": true, "description": "string" }, "dns": { "enabled": true, "description": "string" }, "snmpQuery": { "enabled": true, "description": "string", "retries": 0, "timeout": 0, "eventTimeout": 0 }, "snmpTrap": { "linkTrapQuery": true, "macTrapQuery": true, "interface": "string", "port": {}, "description": "string" }, "activeDirectory": { "enabled": true, "daysBeforeRescan": 0, "description": "string" }, "pxgrid": { "enabled": true, "description": "string" } } }
ise_update_response
dictionary
added in 1.1.0 of cisco.ise
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "code": 0, "message": "string", "rootCause": "string" }


Authors

  • Rafael Campos (@racampos)