cisco.ise.px_grid_direct_test_connector module – Resource module for Px Grid Direct Test Connector

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.px_grid_direct_test_connector.

New in cisco.ise 1.0.0

Synopsis

  • Manage operation create of the resource Px Grid Direct Test Connector.

  • PxGrid Direct - test the Connector.

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

authType

string

Authentication Type list.

authValues

dictionary

Request to test Connector.

clientId

string

KeyType.

clientSecret

string

KeyType.

flow

string

KeyType.

headerName

string

KeyType.

key

string

KeyType.

keyType

string

KeyType.

paramName

string

KeyType.

password

string

Password.

requestBody

string

KeyType.

scope

string

KeyType.

tokenIssuingUrl

string

KeyType.

userName

string

UserName.

connectorName

string

ConnectorName.

flexibleUrl

dictionary

Px Grid Direct Test Connector’s flexibleUrl.

bulk

dictionary

Px Grid Direct Test Connector’s bulk.

additionalHeaders

list / elements=dictionary

Px Grid Direct Test Connector’s additionalHeaders.

name

string

Px Grid Direct Test Connector’s name.

value

string

Px Grid Direct Test Connector’s value.

apiKeyProperties

dictionary

Api key auth properties.

headerName

string

Header name.

key

string

Key.

keyType

string

Key type.

paramName

string

Param name.

requestBody

string

Request body that will be templated.

authenticationType

string

Authentication Type list.

basicAuthProperties

dictionary

Basic auth properties.

password

string

Password.

requestBody

string

Request body that will be templated.

userName

string

UserName.

method

string

Px Grid Direct Test Connector’s method.

oauthProperties

dictionary

OAuth properties.

clientId

string

Client id for oauth.

clientSecret

string

Client secret for oauth.

flow

string

Oauth flow type.

password

string

Password for the password flow.

scope

string

The scope of the oauth token.

tokenIssuingUrl

string

The url that will issue the bearer token.

userName

string

Username for the password flow.

url

string

The url to fetch.

incremental

dictionary

Px Grid Direct Test Connector’s incremental.

additionalHeaders

list / elements=dictionary

Px Grid Direct Test Connector’s additionalHeaders.

name

string

Px Grid Direct Test Connector’s name.

value

string

Px Grid Direct Test Connector’s value.

apiKeyProperties

dictionary

Api key auth properties.

headerName

string

Header name.

key

string

Key.

keyType

string

Key type.

paramName

string

Param name.

requestBody

string

Request body that will be templated.

authenticationType

string

Authentication Type list.

basicAuthProperties

dictionary

Basic auth properties.

password

string

Password.

requestBody

string

Request body that will be templated.

userName

string

UserName.

method

string

Px Grid Direct Test Connector’s method.

oauthProperties

dictionary

OAuth properties.

clientId

string

Client id for oauth.

clientSecret

string

Client secret for oauth.

flow

string

Oauth flow type.

password

string

Password for the password flow.

scope

string

The scope of the oauth token.

tokenIssuingUrl

string

The url that will issue the bearer token.

userName

string

Username for the password flow.

url

string

The url to fetch.

incrementalUrl

string

IncrementalUrl.

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:

responseParsing

string

Uniqueness to identify.

skipCertificateValidations

boolean

SkipCertificateValidations.

Choices:

uniqueID

string

Uniqueness to identify.

url

string

BulkUrl.

Notes

Note

  • SDK Method used are px_grid_direct.PxGridDirect.test_connector,

  • Paths used are post /api/v1/pxgrid-direct/test-connector,

  • 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.px_grid_direct_test_connector:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    authType: string
    authValues:
      clientId: string
      clientSecret: string
      flow: string
      headerName: string
      key: string
      keyType: string
      paramName: string
      password: string
      requestBody: string
      scope: string
      tokenIssuingUrl: string
      userName: string
    connectorName: string
    flexibleUrl:
      bulk:
        additionalHeaders:
          - name: string
            value: string
        apiKeyProperties:
          headerName: string
          key: string
          keyType: string
          paramName: string
          requestBody: string
        authenticationType: string
        basicAuthProperties:
          password: string
          requestBody: string
          userName: string
        method: string
        oauthProperties:
          clientId: string
          clientSecret: string
          flow: string
          password: string
          scope: string
          tokenIssuingUrl: string
          userName: string
        url: string
      incremental:
        additionalHeaders:
          - name: string
            value: string
        apiKeyProperties:
          headerName: string
          key: string
          keyType: string
          paramName: string
          requestBody: string
        authenticationType: string
        basicAuthProperties:
          password: string
          requestBody: string
          userName: string
        method: string
        oauthProperties:
          clientId: string
          clientSecret: string
          flow: string
          password: string
          scope: string
          tokenIssuingUrl: string
          userName: string
        url: string
    incrementalUrl: string
    responseParsing: string
    skipCertificateValidations: true
    uniqueID: string
    url: 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: :ansible-rv-sample-value:`{"connectorName": "string", "data": "string", "error": "string", "skipCertificateValidations": true, "status": "string", "uniqueID": "string"}`

Authors

  • Rafael Campos (@racampos)