cisco.ise.px_grid_direct module – Resource module for Px Grid Direct
Note
This module is part of the cisco.ise collection (version 2.9.6).
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.
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.2.3
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Px Grid Direct’s additionalProperties. |
|
ConnectorName. |
|
<p>List of feature names</p>. |
|
Px Grid Direct’s dictionaryAttribute. |
|
IncludeInDictionary flag. Choices:
|
|
Px Grid Direct’s jsonAttribute. |
|
Uniqueness to identify. |
|
Root level of json. |
|
Uniqueness to identify. |
|
Version uniqueness to identify. |
|
ConnectorName. |
|
Connector Type list. |
|
Px Grid Direct’s deltasyncSchedule. |
|
Run at interval (hours). |
|
Interval Units. |
|
Start date and Time. |
|
Description. |
|
Enabled flag. Choices:
|
|
Px Grid Direct’s fullsyncSchedule. |
|
Run at interval (hours). |
|
Interval Units. |
|
Start date and Time. |
|
Flag for Identity Services Engine SDK to enable debugging. Choices:
|
|
The Identity Services Engine hostname. |
|
The Identity Services Engine password to authenticate. |
|
Timeout (in seconds) for RESTful HTTP requests. Default: |
|
The Identity Services Engine username to authenticate. |
|
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:
|
|
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:
|
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Identity Services Engine to use. Default: |
|
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices:
|
|
Protocol. |
|
SkipCertificateValidations flag. Choices:
|
|
Px Grid Direct’s url. |
|
Authentication Type list. |
|
BulkUrl. |
|
IncrementalUrl. |
|
Password. |
|
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_modeThe 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:
- dictionaryAttribute: string
includeInDictionary: true
jsonAttribute: string
correlationIdentifier: string
topLevelObject: string
uniqueIdentifier: string
versionIdentifier: string
connectorName: string
connectorType: string
deltasyncSchedule:
interval: 0
intervalUnit: string
startDate: string
description: string
enabled: true
fullsyncSchedule:
interval: 0
intervalUnit: string
startDate: 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:
- dictionaryAttribute: string
includeInDictionary: true
jsonAttribute: string
correlationIdentifier: string
topLevelObject: string
uniqueIdentifier: string
versionIdentifier: string
connectorName: string
connectorType: string
deltasyncSchedule:
interval: 0
intervalUnit: string
startDate: string
description: string
enabled: true
fullsyncSchedule:
interval: 0
intervalUnit: string
startDate: 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 |
|---|---|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: |
|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: |