cisco.ise.node_group module – Resource module for Node Group

Note

This module is part of the cisco.ise collection (version 3.3.0).

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

New in cisco.ise 1.0.0

Synopsis

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

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk >= 2.2.1

  • python >= 3.5

Parameters

Parameter

Comments

description

string

Description of the node group.

forceDelete

boolean

Force deletion even if the node group has nodes assigned.

Choices:

ise_client_cert

path

added in cisco.ise 3.3.0

Absolute path to the client certificate file (.pem/.crt) used for certificate-based (mTLS) authentication.

When provided, ise_username and ise_password are not required.

Requires Cisco ISE 3.3 or later with certificate-based API access enabled.

ise_client_key

path

added in cisco.ise 3.3.0

Absolute path to the client private key file (.key) that pairs with ise_client_cert.

Omit when the private key is bundled together with the certificate in ise_client_cert.

ise_debug

boolean

Flag for Identity Services Engine SDK to enable debugging.

Choices:

ise_hostname

string / required

The Identity Services Engine hostname.

ise_password

string

The Identity Services Engine password to authenticate.

Required unless ise_client_cert is provided for certificate-based authentication.

ise_single_request_timeout

integer

added in cisco.ise 3.0.0

Timeout (in seconds) for RESTful HTTP requests.

Default: :ansible-option-default:`60`

ise_username

string

The Identity Services Engine username to authenticate.

Required unless ise_client_cert is provided for certificate-based authentication.

ise_uses_api_gateway

boolean

added in cisco.ise 1.1.0

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:

ise_uses_csrf_token

boolean

added in cisco.ise 3.0.0

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:

ise_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

ise_version

string

Informs the SDK which version of Identity Services Engine to use.

Default: :ansible-option-default:`"3.5.0"`

ise_wait_on_rate_limit

boolean

Flag for Identity Services Engine SDK to enable automatic rate-limit handling.

Choices:

marCache

dictionary

MAR (Machine Access Restriction) cache settings for the node group.

query-attempts

integer

Number of query attempts.

query-timeout

integer

Query timeout in seconds.

replication-attempts

integer

Number of replication attempts.

replication-timeout

integer

Replication timeout in seconds.

name

string

Name of the node group to create.

nodeGroupName

string

NodeGroupName path parameter. Name of the existing node group (used for update/delete).

state

string

The state of the resource.

Choices:

Notes

Note

  • SDK Method used are node_group.NodeGroup.create_node_group, node_group.NodeGroup.update_node_group, node_group.NodeGroup.delete_node_group, node_group.NodeGroup.get_node_group, node_group.NodeGroup.get_node_groups,

  • Paths used are post /api/v1/deployment/node-group, put /api/v1/deployment/node-group/{nodeGroupName}, delete /api/v1/deployment/node-group/{nodeGroupName}, get /api/v1/deployment/node-group/{nodeGroupName}, get /api/v1/deployment/node-group,

  • 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: Create a node group
  cisco.ise.node_group:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    name: mygroup
    description: My ISE node group

- name: Update a node group description
  cisco.ise.node_group:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    nodeGroupName: mygroup
    description: Updated description

- name: Delete a node group
  cisco.ise.node_group:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    nodeGroupName: mygroup
    forceDelete: false

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

ise_create_response

dictionary

A dictionary with the create response from the Cisco ISE Python SDK

Returned: always, on create

Sample: :ansible-rv-sample-value:`{"success": {"message": "string"}, "version": "string"}`

ise_response

dictionary

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

Returned: always

Sample: :ansible-rv-sample-value:`{"description": "string", "marCache": {"query-attempts": 0, "query-timeout": 0, "replication-attempts": 0, "replication-timeout": 0}, "name": "string"}`

ise_update_response

dictionary

A dictionary with the update response from the Cisco ISE Python SDK

Returned: always, on update

Sample: :ansible-rv-sample-value:`{"success": {"message": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)