cisco.ise.endpoints_task module – Resource module for Endpoints Task

Note

This module is part of the cisco.ise collection (version 2.9.3).

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

New in cisco.ise 1.0.0

Synopsis

• Manage operation create of the resource Endpoints Task.

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
connectedLinks dictionary	Endpoints Task’s connectedLinks.
customAttributes dictionary	Endpoints Task’s customAttributes.
description string	Endpoints Task’s description.
deviceType string	Endpoints Task’s deviceType.
groupId string	Endpoints Task’s groupId.
hardwareRevision string	Endpoints Task’s hardwareRevision.
id string	Endpoints Task’s id.
identityStore string	Endpoints Task’s identityStore.
identityStoreId string	Endpoints Task’s identityStoreId.
ipAddress string	Endpoints Task’s ipAddress.
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)
mac string	Endpoints Task’s mac.
mdmAttributes dictionary	Endpoints Task’s mdmAttributes.
name string	Endpoints Task’s name.
portalUser string	Endpoints Task’s portalUser.
productId string	Endpoints Task’s productId.
profileId string	Endpoints Task’s profileId.
protocol string	Endpoints Task’s protocol.
serialNumber string	Endpoints Task’s serialNumber.
softwareRevision string	Endpoints Task’s softwareRevision.
staticGroupAssignment boolean	StaticGroupAssignment flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
staticProfileAssignment boolean	StaticProfileAssignment flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
vendor string	Endpoints Task’s vendor.

Notes

Note

• SDK Method used are endpoints.Endpoints.create_end_point_task,

• Paths used are post /api/v1/endpointTask,

• 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.endpoints_task:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    connectedLinks: {}
    customAttributes: {}
    description: string
    deviceType: string
    groupId: string
    hardwareRevision: string
    id: string
    identityStore: string
    identityStoreId: string
    ipAddress: string
    mac: string
    mdmAttributes: {}
    name: string
    portalUser: string
    productId: string
    profileId: string
    protocol: string
    serialNumber: string
    softwareRevision: string
    staticGroupAssignment: true
    staticProfileAssignment: true
    vendor: 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:`{"id": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)