cisco.ise.restidstore module – Resource module for RESTidstore

Note

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

New in cisco.ise 1.0.0

Synopsis

  • Manage operation create of the resource RESTidstore.

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk >= 2.0.1

  • python >= 3.5

Parameters

Parameter

Comments

description

string

Description.

ersRESTIDStoreAdvanceSettings

dictionary

RESTidstore’s ersRESTIDStoreAdvanceSettings.

deviceQuerySetting

dictionary

DeviceQuerySetting values must be one of NONE,ENTRA_DEVICE_NAME,ENTRA_DEVICE_ID.

identifyDeviceCertificate

dictionary

IdentifyDeviceCertificate values must be one of NONE,SNF,SAN.

regex

string

Regex values must be pattren.

regexType

dictionary

RegexType values must be one of NONE,PREDEFINED,CUSTOM.

sanAttribute

dictionary

SanAttribute values must be one of NONE,URI,EMAIL,DNS.

sanAttributeValue

string

SanAttributeValue values must be empty.

subjectNameFormat

string

SubjectNameFormat values must be empty.

ersRESTIDStoreAttributes

dictionary

RESTidstore’s ersRESTIDStoreAttributes.

headers

list / elements=dictionary

Headers for the RESTIDStore.

predefined

dictionary

The cloud provider connected to of the RESTIDStore. Only Microsoft Entra ID is supported.

rootUrl

string

Url of the root of the RESTIDStore. Can’t Update this field.

usernameSuffix

string

Suffix of the username domain.

ersRESTIDStoreDeviceAttributes

dictionary

RESTidstore’s ersRESTIDStoreDeviceAttributes.

name

string

Name and Type of attribute.

ersRESTIDStoreUserAttributes

dictionary

RESTidstore’s ersRESTIDStoreUserAttributes.

name

string

Name and Type of attribute.

id

string

Id.

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 / required

The Identity Services Engine password to authenticate.

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 / required

The Identity Services Engine username to authenticate.

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.1\_Patch\_1"`

ise_wait_on_rate_limit

boolean

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

Choices:

name

string

Name.

Notes

Note

  • SDK Method used are restidstore.Restidstore.create_restidstore,

  • Paths used are post /restidstore/,

  • 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.restidstore:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: Object that represents the restID store
    ersRestIDStoreAdvanceSettings:
      deviceQuerySetting: ENTRA_DEVICE_NAME
      identifyDeviceCertificate: SAN
      regex: ^(.+)@(\S+)$
      regexType: CUSTOM
      sanAttribute: EMAIL
      sanAttributeValue: username@domain.com
      subjectNameFormat: ''
    ersRestIDStoreAttributes:
      headers:
        - key: tenantID
          value: tenantID_value
        - key: clientID
          value: clientID_value
        - key: clientSecret
          value: clientSecret_value
      rootUrl: rootUrl
      usernameSuffix: '@place.com'
    ersRestIDStoreDeviceAttributes:
      attributes:
        - name: ''
          type: ''
    ersRestIDStoreUserAttributes:
      attributes:
        - name: AttributeName1
          type: String
    id: f75760e7-a4f9-40ef-93bb-88a97e9fb171
    name: RestIdStore1

Return Values

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

Key

Description

ise_response

list / elements=dictionary

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

Returned: always

Sample: :ansible-rv-sample-value:`"[\\n {\\n \\"id\\": \\"string\\",\\n \\"name\\": \\"string\\",\\n \\"description\\": \\"string\\",\\n \\"link\\": {\\n \\"rel\\": \\"string\\",\\n \\"href\\": \\"string\\",\\n \\"type\\": \\"string\\"\\n }\\n }\\n]\\n"`

Authors

  • Rafael Campos (@racampos)