cisco.ise.network_access_dictionary_attribute module – Resource module for Network Access Dictionary Attribute

Note

This module is part of the cisco.ise collection (version 2.5.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.network_access_dictionary_attribute.

New in version 1.0.0: of cisco.ise

Synopsis

• Manage operations create, update and delete of the resource Network Access Dictionary Attribute.

• Create a new Dictionary Attribute for an existing Dictionary.

• Delete a Dictionary Attribute.

• Update a Dictionary Attribute.

Note

This module has a corresponding action plugin.

Requirements

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

• ciscoisesdk >= 2.0.3

• python >= 3.5

Parameters

Parameter	Comments
allowedValues list / elements=dictionary	All of the allowed values for the dictionary attribute.
isDefault boolean	True if this key value is the default between the allowed values of the dictionary attribute. Choices: no yes
key string	Network Access Dictionary Attribute’s key.
value string	Network Access Dictionary Attribute’s value.
dataType string	The data type for the dictionary attribute.
description string	The description of the Dictionary attribute.
dictionaryName string	The name of the dictionary which the dictionary attribute belongs to.
directionType string	The direction for the useage of the dictionary attribute.
id string	Identifier for the dictionary attribute.
internalName string	The internal name of the dictionary attribute.
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_uses_csrf_token boolean added in 3.0.0 of cisco.ise	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: no ← (default) yes
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_Patch_1”
ise_wait_on_rate_limit boolean	Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: no yes ← (default)
name string	The dictionary attribute’s name.

Notes

Note

• SDK Method used are network_access_dictionary_attribute.NetworkAccessDictionaryAttribute.create_network_access_dictionary_attribute, network_access_dictionary_attribute.NetworkAccessDictionaryAttribute.delete_network_access_dictionary_attribute_by_name, network_access_dictionary_attribute.NetworkAccessDictionaryAttribute.update_network_access_dictionary_attribute_by_name,

• Paths used are post /network-access/dictionaries/{dictionaryName}/attribute, delete /network-access/dictionaries/{dictionaryName}/attribute/{name}, put /network-access/dictionaries/{dictionaryName}/attribute/{name},

• 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

See Also

See also

Cisco ISE documentation for Network Access - Dictionary Attribute

Complete reference of the Network Access - Dictionary Attribute API.

Examples

- name: Create
  cisco.ise.network_access_dictionary_attribute:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    allowedValues:
    - isDefault: true
      key: string
      value: string
    dataType: string
    description: string
    dictionaryName: string
    directionType: string
    id: string
    internalName: string
    name: string

- name: Update by name
  cisco.ise.network_access_dictionary_attribute:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    allowedValues:
    - isDefault: true
      key: string
      value: string
    dataType: string
    description: string
    dictionaryName: string
    directionType: string
    id: string
    internalName: string
    name: string

- name: Delete by name
  cisco.ise.network_access_dictionary_attribute:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    dictionaryName: string
    name: 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 \”allowedValues\”: [\n {\n \”isDefault\”: true,\n \”key\”: \”string\”,\n \”value\”: \”string\”\n }\n ],\n \”dataType\”: \”string\”,\n \”description\”: \”string\”,\n \”dictionaryName\”: \”string\”,\n \”directionType\”: \”string\”,\n \”id\”: \”string\”,\n \”internalName\”: \”string\”,\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 \”response\”: {\n \”allowedValues\”: [\n {\n \”isDefault\”: true,\n \”key\”: \”string\”,\n \”value\”: \”string\”\n }\n ],\n \”dataType\”: \”string\”,\n \”description\”: \”string\”,\n \”dictionaryName\”: \”string\”,\n \”directionType\”: \”string\”,\n \”id\”: \”string\”,\n \”internalName\”: \”string\”,\n \”name\”: \”string\”\n },\n \”version\”: \”string\”\n}\n”

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)