.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.px_grid_direct_test_connector module -- Resource module for Px Grid Direct Test Connector +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.ise collection `_ (version 3.0.0). To install it, use: :code:`ansible-galaxy collection install cisco.ise`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.ise.px_grid_direct_test_connector`. .. version_added .. rst-class:: ansible-version-added New in cisco.ise 1.0.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation create of the resource Px Grid Direct Test Connector. - PxGrid Direct - test the Connector. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - ciscoisesdk \>= 2.0.1 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-authtype: .. rst-class:: ansible-option-title **authType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Authentication Type list. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-authvalues: .. rst-class:: ansible-option-title **authValues** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Request to test Connector. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-authvalues/clientid: .. rst-class:: ansible-option-title **clientId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
KeyType. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-authvalues/clientsecret: .. rst-class:: ansible-option-title **clientSecret** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
KeyType. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-authvalues/flow: .. rst-class:: ansible-option-title **flow** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
KeyType. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-authvalues/headername: .. rst-class:: ansible-option-title **headerName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
KeyType. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-authvalues/key: .. rst-class:: ansible-option-title **key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
KeyType. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-authvalues/keytype: .. rst-class:: ansible-option-title **keyType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
KeyType. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-authvalues/paramname: .. rst-class:: ansible-option-title **paramName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
KeyType. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-authvalues/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-authvalues/requestbody: .. rst-class:: ansible-option-title **requestBody** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
KeyType. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-authvalues/scope: .. rst-class:: ansible-option-title **scope** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
KeyType. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-authvalues/tokenissuingurl: .. rst-class:: ansible-option-title **tokenIssuingUrl** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
KeyType. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-authvalues/username: .. rst-class:: ansible-option-title **userName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
UserName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-connectorname: .. rst-class:: ansible-option-title **connectorName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ConnectorName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl: .. rst-class:: ansible-option-title **flexibleUrl** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Px Grid Direct Test Connector's flexibleUrl. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk: .. rst-class:: ansible-option-title **bulk** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Px Grid Direct Test Connector's bulk. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/additionalheaders: .. rst-class:: ansible-option-title **additionalHeaders** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Px Grid Direct Test Connector's additionalHeaders. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/additionalheaders/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Px Grid Direct Test Connector's name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/additionalheaders/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Px Grid Direct Test Connector's value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/apikeyproperties: .. rst-class:: ansible-option-title **apiKeyProperties** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Api key auth properties. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/apikeyproperties/headername: .. rst-class:: ansible-option-title **headerName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Header name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/apikeyproperties/key: .. rst-class:: ansible-option-title **key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Key. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/apikeyproperties/keytype: .. rst-class:: ansible-option-title **keyType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Key type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/apikeyproperties/paramname: .. rst-class:: ansible-option-title **paramName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Param name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/apikeyproperties/requestbody: .. rst-class:: ansible-option-title **requestBody** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Request body that will be templated. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/authenticationtype: .. rst-class:: ansible-option-title **authenticationType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Authentication Type list. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/basicauthproperties: .. rst-class:: ansible-option-title **basicAuthProperties** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Basic auth properties. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/basicauthproperties/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/basicauthproperties/requestbody: .. rst-class:: ansible-option-title **requestBody** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Request body that will be templated. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/basicauthproperties/username: .. rst-class:: ansible-option-title **userName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
UserName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/method: .. rst-class:: ansible-option-title **method** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Px Grid Direct Test Connector's method. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/oauthproperties: .. rst-class:: ansible-option-title **oauthProperties** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
OAuth properties. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/oauthproperties/clientid: .. rst-class:: ansible-option-title **clientId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Client id for oauth. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/oauthproperties/clientsecret: .. rst-class:: ansible-option-title **clientSecret** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Client secret for oauth. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/oauthproperties/flow: .. rst-class:: ansible-option-title **flow** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Oauth flow type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/oauthproperties/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Password for the password flow. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/oauthproperties/scope: .. rst-class:: ansible-option-title **scope** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The scope of the oauth token. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/oauthproperties/tokenissuingurl: .. rst-class:: ansible-option-title **tokenIssuingUrl** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The url that will issue the bearer token. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/oauthproperties/username: .. rst-class:: ansible-option-title **userName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Username for the password flow. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/bulk/url: .. rst-class:: ansible-option-title **url** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The url to fetch. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental: .. rst-class:: ansible-option-title **incremental** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Px Grid Direct Test Connector's incremental. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/additionalheaders: .. rst-class:: ansible-option-title **additionalHeaders** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Px Grid Direct Test Connector's additionalHeaders. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/additionalheaders/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Px Grid Direct Test Connector's name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/additionalheaders/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Px Grid Direct Test Connector's value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/apikeyproperties: .. rst-class:: ansible-option-title **apiKeyProperties** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Api key auth properties. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/apikeyproperties/headername: .. rst-class:: ansible-option-title **headerName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Header name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/apikeyproperties/key: .. rst-class:: ansible-option-title **key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Key. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/apikeyproperties/keytype: .. rst-class:: ansible-option-title **keyType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Key type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/apikeyproperties/paramname: .. rst-class:: ansible-option-title **paramName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Param name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/apikeyproperties/requestbody: .. rst-class:: ansible-option-title **requestBody** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Request body that will be templated. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/authenticationtype: .. rst-class:: ansible-option-title **authenticationType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Authentication Type list. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/basicauthproperties: .. rst-class:: ansible-option-title **basicAuthProperties** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Basic auth properties. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/basicauthproperties/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/basicauthproperties/requestbody: .. rst-class:: ansible-option-title **requestBody** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Request body that will be templated. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/basicauthproperties/username: .. rst-class:: ansible-option-title **userName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
UserName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/method: .. rst-class:: ansible-option-title **method** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Px Grid Direct Test Connector's method. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/oauthproperties: .. rst-class:: ansible-option-title **oauthProperties** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
OAuth properties. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/oauthproperties/clientid: .. rst-class:: ansible-option-title **clientId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Client id for oauth. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/oauthproperties/clientsecret: .. rst-class:: ansible-option-title **clientSecret** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Client secret for oauth. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/oauthproperties/flow: .. rst-class:: ansible-option-title **flow** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Oauth flow type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/oauthproperties/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Password for the password flow. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/oauthproperties/scope: .. rst-class:: ansible-option-title **scope** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The scope of the oauth token. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/oauthproperties/tokenissuingurl: .. rst-class:: ansible-option-title **tokenIssuingUrl** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The url that will issue the bearer token. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/oauthproperties/username: .. rst-class:: ansible-option-title **userName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Username for the password flow. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-flexibleurl/incremental/url: .. rst-class:: ansible-option-title **url** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The url to fetch. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-incrementalurl: .. rst-class:: ansible-option-title **incrementalUrl** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IncrementalUrl. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-ise_debug: .. rst-class:: ansible-option-title **ise_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Identity Services Engine SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-ise_hostname: .. rst-class:: ansible-option-title **ise_hostname** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-ise_password: .. rst-class:: ansible-option-title **ise_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-ise_single_request_timeout: .. rst-class:: ansible-option-title **ise_single_request_timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` :ansible-option-versionadded:`added in cisco.ise 3.0.0` .. raw:: html
- .. raw:: html
Timeout (in seconds) for RESTful HTTP requests. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-ise_username: .. rst-class:: ansible-option-title **ise_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine username to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-ise_uses_api_gateway: .. rst-class:: ansible-option-title **ise_uses_api_gateway** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` :ansible-option-versionadded:`added in cisco.ise 1.1.0` .. raw:: html
- .. raw:: html
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). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-ise_uses_csrf_token: .. rst-class:: ansible-option-title **ise_uses_csrf_token** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` :ansible-option-versionadded:`added in cisco.ise 3.0.0` .. raw:: html
- .. raw:: html
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. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-ise_verify: .. rst-class:: ansible-option-title **ise_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-ise_version: .. rst-class:: ansible-option-title **ise_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Identity Services Engine to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1\_Patch\_1"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-ise_wait_on_rate_limit: .. rst-class:: ansible-option-title **ise_wait_on_rate_limit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-responseparsing: .. rst-class:: ansible-option-title **responseParsing** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Uniqueness to identify. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-skipcertificatevalidations: .. rst-class:: ansible-option-title **skipCertificateValidations** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
SkipCertificateValidations. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-uniqueid: .. rst-class:: ansible-option-title **uniqueID** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Uniqueness to identify. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__parameter-url: .. rst-class:: ansible-option-title **url** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
BulkUrl. .. raw:: html
.. Attributes .. Notes 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 \ :literal:`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 .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja --- - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.ise.px_grid_direct_test_connector_module__return-ise_response: .. rst-class:: ansible-option-title **ise_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco ISE Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"connectorName": "string", "data": "string", "error": "string", "skipCertificateValidations": true, "status": "string", "uniqueID": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors