You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

cisco.ise.node_deployment module – Resource module for Node Deployment

Note

This module 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
Requirements
Parameters
Notes
See Also
Examples
Return Values

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	Comments
administration dictionary	Node Deployment’s administration.
isEnabled boolean	IsEnabled flag. Choices: no yes
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	EnablePXGrid flag. Choices: no yes
isEnabled boolean	IsEnabled flag. Choices: no yes
isMntDedicated boolean	IsMntDedicated flag. Choices: no yes
otherMonitoringNode string	Node Deployment’s otherMonitoringNode.
policyservice dictionary	Node Deployment’s policyservice.
enabled boolean	Enabled flag. Choices: no yes
enableDeviceAdminService boolean	EnableDeviceAdminService flag. Choices: no yes
enableNACService boolean	EnableNACService flag. Choices: no yes
enablePassiveIdentityService boolean	EnablePassiveIdentityService flag. Choices: no yes
enableProfilingService boolean	EnableProfilingService flag. Choices: no yes
sessionService dictionary	Node Deployment’s sessionService.
isEnabled boolean	IsEnabled flag. Choices: no yes
nodegroup string	Node Deployment’s nodegroup.
sxpservice dictionary	Node Deployment’s sxpservice.
isEnabled boolean	IsEnabled flag. Choices: no yes
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	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_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.0”
ise_wait_on_rate_limit boolean	Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: no yes ← (default)
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	Enabled flag. Choices: no yes
dhcp dictionary	Node Deployment’s dhcp.
description string	Node Deployment’s description.
enabled boolean	Enabled flag. Choices: no yes
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	Enabled flag. Choices: no yes
interface string	Node Deployment’s interface.
dns dictionary	Node Deployment’s dns.
description string	Node Deployment’s description.
enabled boolean	Enabled flag. Choices: no yes
http dictionary	Node Deployment’s http.
description string	Node Deployment’s description.
enabled boolean	Enabled flag. Choices: no yes
interface string	Node Deployment’s interface.
netflow dictionary	Node Deployment’s netflow.
description string	Node Deployment’s description.
enabled boolean	Enabled flag. Choices: no yes
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	Enabled flag. Choices: no yes
pxgrid dictionary	Node Deployment’s pxgrid.
description string	Node Deployment’s description.
enabled boolean	Enabled flag. Choices: no yes
radius dictionary	Node Deployment’s radius.
description string	Node Deployment’s description.
enabled boolean	Enabled flag. Choices: no yes
snmpQuery dictionary	Node Deployment’s snmpQuery.
description string	Node Deployment’s description.
enabled boolean	Enabled flag. Choices: no yes
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	LinkTrapQuery flag. Choices: no yes
macTrapQuery boolean	MacTrapQuery flag. Choices: no yes
port integer	Node Deployment’s port.
userName string	Node Deployment’s userName.

Notes 

Note

Does not support check_mode

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

Description

ise_response

dictionary

A dictionary or list with the response returned by the Cisco ISE Python SDK

Returned: always

Sample: “{\n \”hostname\”: \”string\”,\n \”fqdn\”: \”string\”,\n \”ipAddress\”: \”string\”,\n \”nodeType\”: \”string\”,\n \”administration\”: {\n \”isEnabled\”: true,\n \”role\”: \”string\”\n },\n \”generalSettings\”: {\n \”monitoring\”: {\n \”isEnabled\”: true,\n \”role\”: \”string\”,\n \”otherMonitoringNode\”: \”string\”,\n \”isMntDedicated\”: true,\n \”policyservice\”: {\n \”enabled\”: true,\n \”sessionService\”: {\n \”isEnabled\”: true,\n \”nodegroup\”: \”string\”\n },\n \”enableProfilingService\”: true,\n \”enableNACService\”: true,\n \”sxpservice\”: {\n \”isEnabled\”: true,\n \”userInterface\”: \”string\”\n },\n \”enableDeviceAdminService\”: true,\n \”enablePassiveIdentityService\”: true\n },\n \”enablePXGrid\”: true\n }\n },\n \”profilingConfiguration\”: {\n \”netflow\”: {\n \”enabled\”: true,\n \”interface\”: \”string\”,\n \”port\”: {},\n \”description\”: \”string\”\n },\n \”dhcp\”: {\n \”enabled\”: true,\n \”interface\”: \”string\”,\n \”port\”: {},\n \”description\”: \”string\”\n },\n \”dhcpSpan\”: {\n \”enabled\”: true,\n \”interface\”: \”string\”,\n \”description\”: \”string\”\n },\n \”http\”: {\n \”enabled\”: true,\n \”interface\”: \”string\”,\n \”description\”: \”string\”\n },\n \”radius\”: {\n \”enabled\”: true,\n \”description\”: \”string\”\n },\n \”nmap\”: {\n \”enabled\”: true,\n \”description\”: \”string\”\n },\n \”dns\”: {\n \”enabled\”: true,\n \”description\”: \”string\”\n },\n \”snmpQuery\”: {\n \”enabled\”: true,\n \”description\”: \”string\”,\n \”retries\”: 0,\n \”timeout\”: 0,\n \”eventTimeout\”: 0\n },\n \”snmpTrap\”: {\n \”linkTrapQuery\”: true,\n \”macTrapQuery\”: true,\n \”interface\”: \”string\”,\n \”port\”: {},\n \”description\”: \”string\”\n },\n \”activeDirectory\”: {\n \”enabled\”: true,\n \”daysBeforeRescan\”: 0,\n \”description\”: \”string\”\n },\n \”pxgrid\”: {\n \”enabled\”: true,\n \”description\”: \”string\”\n }\n }\n}\n”

ise_update_response

dictionary

added in 1.1.0 of cisco.ise

A dictionary or list with the response returned by the Cisco ISE Python SDK

Returned: always

Sample: “{\n \”code\”: 0,\n \”message\”: \”string\”,\n \”rootCause\”: \”string\”\n}\n”

Authors

Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)

cisco.ise.node_deployment module – Resource module for Node Deployment

Synopsis

Requirements

Parameters

Notes

See Also

Examples

Return Values

Authors

Collection links

Synopsis 

Requirements 

Parameters 

Notes 

See Also 

Examples 

Return Values 