cisco.ise.endpoints module – Resource module for Endpoints
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.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.3
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Endpoints’s connectedLinks. |
|
Endpoints’s customAttributes. |
|
Endpoints’s description. |
|
Endpoints’s deviceType. |
|
Endpoints’s groupId. |
|
Endpoints’s hardwareRevision. |
|
Endpoints’s id. |
|
Endpoints’s identityStore. |
|
Endpoints’s identityStoreId. |
|
Endpoints’s ipAddress. |
|
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:
|
|
Endpoints’s mac. |
|
Endpoints’s mdmAttributes. |
|
Endpoints’s name. |
|
Endpoints’s portalUser. |
|
Endpoints’s productId. |
|
Endpoints’s profileId. |
|
Endpoints’s protocol. |
|
Endpoints’s serialNumber. |
|
Endpoints’s softwareRevision. |
|
StaticGroupAssignment flag. Choices:
|
|
StaticProfileAssignment flag. Choices:
|
|
Value path parameter. The id or MAC of the endpoint. |
|
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_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.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 |
|---|---|
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: |