cisco.ise.endpoints module – Resource module for Endpoints

Note

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

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.

New in cisco.ise 1.0.0

Synopsis

  • Manage operations create, update and delete of the resource Endpoints.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • ciscoisesdk >= 2.2.1

  • python >= 3.5

Parameters

Parameter

Comments

dictionary

Endpoints’s connectedLinks.

customAttributes

dictionary

Endpoints’s customAttributes.

description

string

Endpoints’s description.

deviceType

string

Endpoints’s deviceType.

groupId

string

Endpoints’s groupId.

hardwareRevision

string

Endpoints’s hardwareRevision.

id

string

Endpoints’s id.

identityStore

string

Endpoints’s identityStore.

identityStoreId

string

Endpoints’s identityStoreId.

ipAddress

string

Endpoints’s ipAddress.

ise_debug

boolean

Flag for Identity Services Engine SDK to enable debugging.

Choices:

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:

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:

ise_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

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:

mac

string

Endpoints’s mac.

mdmAttributes

dictionary

Endpoints’s mdmAttributes.

name

string

Endpoints’s name.

portalUser

string

Endpoints’s portalUser.

productId

string

Endpoints’s productId.

profileId

string

Endpoints’s profileId.

protocol

string

Endpoints’s protocol.

serialNumber

string

Endpoints’s serialNumber.

softwareRevision

string

Endpoints’s softwareRevision.

staticGroupAssignment

boolean

StaticGroupAssignment flag.

Choices:

staticProfileAssignment

boolean

StaticProfileAssignment flag.

Choices:

value

string

Value path parameter. The id or MAC of the endpoint.

vendor

string

Endpoints’s vendor.

Notes

Note

  • SDK Method used are endpoints.Endpoints.create_end_point, endpoints.Endpoints.delete_endpoint, endpoints.Endpoints.update_endpoint,

  • Paths used are post /api/v1/endpoint, delete /api/v1/endpoint/{value}, put /api/v1/endpoint/{value},

  • 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:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    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

- name: Update by id
  cisco.ise.endpoints:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    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
    value: string
    vendor: string

- name: Delete by id
  cisco.ise.endpoints:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    value: 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:`{"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"}`

ise_update_response

dictionary

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:`{"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"}`

Authors

  • Rafael Campos (@racampos)