.. 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.endpoint_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.endpoint module -- Resource module for Endpoint +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. 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.endpoint`. .. 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 Endpoint. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.ise.endpoint_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.endpoint_module__parameter-customattributes: .. rst-class:: ansible-option-title **customAttributes** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Key value map. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.endpoint_module__parameter-description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.endpoint_module__parameter-groupid: .. rst-class:: ansible-option-title **groupId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Endpoint's groupId. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.endpoint_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.endpoint_module__parameter-identitystore: .. rst-class:: ansible-option-title **identityStore** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
This field is for read only. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.endpoint_module__parameter-identitystoreid: .. rst-class:: ansible-option-title **identityStoreId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
This field is for read only. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.endpoint_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.endpoint_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.endpoint_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.endpoint_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.endpoint_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.endpoint_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.endpoint_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.endpoint_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.endpoint_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.endpoint_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.endpoint_module__parameter-mac: .. rst-class:: ansible-option-title **mac** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Endpoint's mac. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.endpoint_module__parameter-mdmattributes: .. rst-class:: ansible-option-title **mdmAttributes** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
MDM Attributes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.endpoint_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.endpoint_module__parameter-portaluser: .. rst-class:: ansible-option-title **portalUser** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Endpoint's portalUser. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.endpoint_module__parameter-profileid: .. rst-class:: ansible-option-title **profileId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Endpoint's profileId. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.endpoint_module__parameter-staticgroupassignment: .. rst-class:: ansible-option-title **staticGroupAssignment** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
StaticGroupAssignment flag. .. 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.endpoint_module__parameter-staticgroupassignmentdefined: .. rst-class:: ansible-option-title **staticGroupAssignmentDefined** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
StaticGroupAssignmentDefined flag. .. 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.endpoint_module__parameter-staticprofileassignment: .. rst-class:: ansible-option-title **staticProfileAssignment** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
StaticProfileAssignment flag. .. 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.endpoint_module__parameter-staticprofileassignmentdefined: .. rst-class:: ansible-option-title **staticProfileAssignmentDefined** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
StaticProfileAssignmentDefined flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are endpoint.Endpoint.create\_endpoint, - Paths used are post /endpoint/, - 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.endpoint: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present customAttributes: customAttributes: key1: value1 key2: value2 description: description groupId: groupId id: f75760e7-a4f9-40ef-93bb-88a97e9fb171 identityStore: identityStore identityStoreId: identityStoreId mac: 00:01:02:03:04:05 mdmAttributes: mdmComplianceStatus: false mdmEncrypted: false mdmEnrolled: false mdmIMEI: IMEI mdmJailBroken: false mdmManufacturer: Apple Inc. mdmModel: iPad mdmOS: iOS mdmPhoneNumber: Phone Number mdmPinlock: false mdmReachable: true mdmSerial: '10000000001' mdmServerName: MdmServerName name: name portalUser: portalUser profileId: profileId staticGroupAssignment: true staticGroupAssignmentDefined: true staticProfileAssignment: false staticProfileAssignmentDefined: true .. 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.endpoint_module__return-ise_response: .. rst-class:: ansible-option-title **ise_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=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:`"[\\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"` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors