cisco.ise.rest_id_store – Resource module for Rest Id Store

Note

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

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

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

New in version 1.0.0: of cisco.ise

Synopsis

  • Manage operations create, update and delete of the resource Rest Id Store.

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk

Parameters

Parameter Choices/Defaults Comments
description
string
Rest Id Store's description.
ersRestIDStoreAttributes
dictionary
Rest Id Store's ersRestIDStoreAttributes.
headers
list / elements=string
Rest Id Store's headers.
key
string
Rest Id Store's key.
value
string
Rest Id Store's value.
predefined
string
Rest Id Store's predefined.
rootUrl
string
Rest Id Store's rootUrl.
usernameSuffix
string
Rest Id Store's usernameSuffix.
id
string
Id path parameter.
name
string
Rest Id Store's name.

See Also

See also

cisco.ise.plugins.module_utils.definitions.rest_id_store

The official documentation on the cisco.ise.plugins.module_utils.definitions.rest_id_store module.

Rest Id Store reference

Complete reference of the Rest Id Store object model.

Examples

- name: Create
  cisco.ise.rest_id_store:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: '{{description}}'
    ersRestIDStoreAttributes:
      headers:
      - key: clientID
        value: '{{clientID}}'
      - key: clientSecret
        value: '{{clientSecret}}'
      - key: tenantID
        value: '{{tenantID}}'
      predefined: Azure
      rootUrl: http://169.254.6.2:9601/azure
      usernameSuffix: '{{usernameSuffix}}'
    name: '{{name}}'

- name: Update by id
  cisco.ise.rest_id_store:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: my new description
    id: '{{id}}'
    name: ISE_AzureAD_ROPC

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

- name: Update by name
  cisco.ise.rest_id_store:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: my new description
    name: string

- name: Delete by name
  cisco.ise.rest_id_store:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    name: 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:
{ "ERSResponse": { "operation": "string", "messages": [ { "title": "string", "type": "string", "code": "string" } ], "link": { "rel": "string", "href": "string", "type": "string" } } }


Authors

  • Rafael Campos (@racampos)