cisco.ise.node_group – Resource module for Node Group

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 ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.ise.

To use it in a playbook, specify: cisco.ise.node_group.

New in version 1.0.0: of cisco.ise

Synopsis

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

• This API creates a node group in the cluster. A node group is a group of PSNs,

• Delete an existing node group in the cluster. Deleting the node group does not delete the nodes, but failover is no longer carried out among the nodes.

Note

This module has a corresponding action plugin.

Requirements

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

• ciscoisesdk >= 1.4.0

• python >= 3.5

Parameters

Parameter	Comments
description string	Node Group’s description.
forceDelete boolean	ForceDelete query parameter. Force delete the group even if the node group contains one or more nodes. Choices: no yes
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.1”
ise_wait_on_rate_limit boolean	Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: no yes ← (default)
marCache dictionary	Node Group’s marCache.
query-attempts integer	The number of times Cisco ISE attempts to perform the cache entry query. (0 - 5).
query-timeout integer	The time, in seconds, after which the cache entry query times out. (1 - 10).
replication-attempts integer	The number of times Cisco ISE attempts to perform MAR cache entry replication. (0 - 5).
replication-timeout integer	The time, in seconds, after which the cache entry replication times out. (1 - 10).
name string	Node Group’s name.
nodeGroupName string	NodeGroupName path parameter. Name of the existing node group.

Notes

Note

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

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

• 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
  cisco.ise.node_group:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    marCache:
      query-attempts: 0
      query-timeout: 0
      replication-attempts: 0
      replication-timeout: 0
    name: string

- name: Update by name
  cisco.ise.node_group:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    marCache:
      query-attempts: 0
      query-timeout: 0
      replication-attempts: 0
      replication-timeout: 0
    name: string
    nodeGroupName: string

- name: Delete by name
  cisco.ise.node_group:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    forceDelete: true
    nodeGroupName: 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 \”description\”: \”string\”,\n \”marCache\”: {\n \”query-attempts\”: 0,\n \”query-timeout\”: 0,\n \”replication-attempts\”: 0,\n \”replication-timeout\”: 0\n },\n \”name\”: \”string\”\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 \”success\”: {\n \”message\”: \”string\”\n },\n \”version\”: \”string\”\n}\n”

Authors

• Rafael Campos (@racampos)