cisco.ise.px_grid_direct module – Resource module for Px Grid Direct

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.

New in cisco.ise 1.0.0

Synopsis 

Manage operations create, update and delete of the resource Px Grid Direct.
PxGrid Direct - Configure connectorconfig information.
PxGrid Direct - Delete Configure connectorConfig information based on ConnectorName.
PxGrid Direct - update Configure connectorConfig information based on ConnectorName.

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
additionalProperties dictionary	Px Grid Direct’s additionalProperties.
attributes dictionary	ConnectorName.
attributeMapping list / elements=dictionary	<p>List of feature names</p>.
coaSignificance boolean	CoaSignificance flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
dictionaryAttribute string	Px Grid Direct’s dictionaryAttribute.
includeInDictionary boolean	IncludeInDictionary flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
jsonAttribute string	Px Grid Direct’s jsonAttribute.
correlationIdentifier string	Uniqueness to identify.
topLevelObject string	Root level of json.
uniqueIdentifier string	Uniqueness to identify.
versionIdentifier string	Version uniqueness to identify.
coaType string	Enable coa for connector.
connectorName string	ConnectorName.
connectorType string	Connector Type list.
deltasyncSchedule dictionary	Px Grid Direct’s deltasyncSchedule.
interval integer	Run at interval (hours).
intervalUnit string	Interval Units.
startDate string	Start date and Time.
description string	Description.
enabled boolean	Enabled flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
flexibleUrl dictionary	Px Grid Direct’s flexibleUrl.
bulk dictionary	Px Grid Direct’s bulk.
additionalHeaders list / elements=dictionary	Px Grid Direct’s additionalHeaders.
name string	Px Grid Direct’s name.
value string	Px Grid Direct’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’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’s incremental.
additionalHeaders list / elements=dictionary	Px Grid Direct’s additionalHeaders.
name string	Px Grid Direct’s name.
value string	Px Grid Direct’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’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.
fullsyncSchedule dictionary	Px Grid Direct’s fullsyncSchedule.
interval integer	Run at interval (hours).
intervalUnit string	Interval Units.
startDate string	Start date and Time.
groupArray list / elements=dictionary	<p>List of Group names</p>.
GroupName string	Px Grid Direct’s GroupName.
GroupPermission string	Px Grid Direct’s GroupPermission.
ise_debug boolean	Flag for Identity Services Engine SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
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: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
ise_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
protocol string	Protocol.
skipCertificateValidations boolean	SkipCertificateValidations flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
url dictionary	Px Grid Direct’s url.
authenticationType string	Authentication Type list.
bulkUrl string	BulkUrl.
incrementalUrl string	IncrementalUrl.
password string	Password.
userName string	UserName.

Notes 

Note

SDK Method used are px_grid_direct.PxGridDirect.create_connector_config, px_grid_direct.PxGridDirect.delete_connector_config_by_connector_name, px_grid_direct.PxGridDirect.update_connector_config_by_connector_name,
Paths used are post /api/v1/pxgrid-direct/connector-config, delete /api/v1/pxgrid-direct/connector-config/{connectorName}, put /api/v1/pxgrid-direct/connector-config/{connectorName},
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:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    additionalProperties: {}
    attributes:
      attributeMapping:
        - coaSignificance: true
          dictionaryAttribute: string
          includeInDictionary: true
          jsonAttribute: string
      correlationIdentifier: string
      topLevelObject: string
      uniqueIdentifier: string
      versionIdentifier: string
    coaType: string
    connectorName: string
    connectorType: string
    deltasyncSchedule:
      interval: 0
      intervalUnit: string
      startDate: string
    description: string
    enabled: true
    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
    fullsyncSchedule:
      interval: 0
      intervalUnit: string
      startDate: string
    groupArray:
      - GroupName: string
    GroupPermission: string
    protocol: string
    skipCertificateValidations: true
    url:
      authenticationType: string
      bulkUrl: string
      incrementalUrl: string
      password: string
      userName: string
- name: Update by name
  cisco.ise.px_grid_direct:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    additionalProperties: {}
    attributes:
      attributeMapping:
        - coaSignificance: true
          dictionaryAttribute: string
          includeInDictionary: true
          jsonAttribute: string
      correlationIdentifier: string
      topLevelObject: string
      uniqueIdentifier: string
      versionIdentifier: string
    coaType: string
    connectorName: string
    connectorType: string
    deltasyncSchedule:
      interval: 0
      intervalUnit: string
      startDate: string
    description: string
    enabled: true
    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
    fullsyncSchedule:
      interval: 0
      intervalUnit: string
      startDate: string
    groupArray:
      - GroupName: string
    GroupPermission: string
    protocol: string
    skipCertificateValidations: true
    url:
      authenticationType: string
      bulkUrl: string
      incrementalUrl: string
      password: string
      userName: string
- name: Delete by name
  cisco.ise.px_grid_direct:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    connectorName: 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:`{"connector": {"additionalProperties": {}, "attributes": {"attributeMapping": [{"coaSignificance": true, "dictionaryAttribute": "string", "includeInDictionary": true, "jsonAttribute": "string"}], "correlationIdentifier": "string", "topLevelObject": "string", "uniqueIdentifier": "string", "versionIdentifier": "string"}, "coaType": "string", "connectorName": "string", "connectorType": "string", "deltasyncSchedule": {"interval": 0, "intervalUnit": "string", "startDate": "string"}, "description": "string", "enabled": true, "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"}}, "fullsyncSchedule": {"interval": 0, "intervalUnit": "string", "startDate": "string"}, "groupArray": [{"GroupName": "string", "GroupPermission": "string"}], "protocol": "string", "skipCertificateValidations": true, "url": {"authenticationType": "string", "bulkUrl": "string", "incrementalUrl": "string", "password": "string", "userName": "string"}}}`

ise_update_response

string

added in cisco.ise 1.1.0

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

Returned: always

Sample: :ansible-rv-sample-value:`"\\"'string'\\"\\n"`

Authors

Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)

cisco.ise.px_grid_direct module – Resource module for Px Grid Direct

Synopsis

Requirements

Parameters

Notes

Examples

Return Values

Authors

Collection links

Synopsis 

Requirements 

Parameters 

Notes 

Examples 

Return Values 