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

Note

This plugin is part of the cisco.ise collection (version 2.1.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.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 >= 1.3.0

• python >= 3.5

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			The cloud provider connected to of the RestIDStore. Options are - Azure, - Okta, - None.
	rootUrl string			Url of the root of the RestIDStore.
	usernameSuffix string			Suffix of the username domain.
id string				Rest Id Store's id.
ise_debug boolean			Choices: no ← yes	Flag for Identity Services Engine SDK to enable debugging.
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			Choices: no yes ←	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).
ise_verify boolean			Choices: no yes ←	Flag to enable or disable SSL certificate verification.
ise_version string			Default: "3.1.1"	Informs the SDK which version of Identity Services Engine to use.
ise_wait_on_rate_limit boolean			Choices: no yes ←	Flag for Identity Services Engine SDK to enable automatic rate-limit handling.
name string				Rest Id Store's name.

Notes

Note

• 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

Rest Id Store reference

Complete reference of the Rest Id Store object model.

Examples

- 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: string
    ersRestIDStoreAttributes:
      headers:
      - key: string
        value: string
      predefined: string
      rootUrl: string
      usernameSuffix: string
    id: string
    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

- 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: string
    ersRestIDStoreAttributes:
      headers:
      - key: string
        value: string
      predefined: string
      rootUrl: string
      usernameSuffix: string
    id: string
    name: string

- 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: 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: string
    ersRestIDStoreAttributes:
      headers:
      - key: string
        value: string
      predefined: string
      rootUrl: string
      usernameSuffix: string
    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: { "id": "string", "name": "string", "description": "string", "ersRestIDStoreAttributes": { "usernameSuffix": "string", "rootUrl": "string", "predefined": "string", "headers": [ { "key": "string", "value": "string" } ] }, "link": { "rel": "string", "href": "string", "type": "string" } }
ise_update_response dictionary added in 1.1.0 of cisco.ise	always	A dictionary or list with the response returned by the Cisco ISE Python SDK Sample: { "UpdatedFieldsList": { "updatedField": [ { "field": "string", "oldValue": "string", "newValue": "string" } ], "field": "string", "oldValue": "string", "newValue": "string" } }

Authors

• Rafael Campos (@racampos)