cisco.ise.endpoint module – Resource module for Endpoint

Note

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

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

New in cisco.ise 1.0.0

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

Manage operations create, update and delete of the resource Endpoint.
This API creates an endpoint.
This API deletes an endpoint.
This API allows the client to update an endpoint.

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
customAttributes dictionary	Endpoint’s customAttributes.
customAttributes dictionary	Key value map.
description string	Endpoint’s description.
groupId string	Endpoint’s groupId.
id string	Endpoint’s id.
identityStore string	Endpoint’s identityStore.
identityStoreId string	Endpoint’s identityStoreId.
ise_debug boolean	Flag for Identity Services Engine SDK to enable debugging. Choices: `false` ← (default) `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: `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: `false` `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: `false` ← (default) `true`
ise_verify boolean	Flag to enable or disable SSL certificate verification. Choices: `false` `true` ← (default)
ise_version string	Informs the SDK which version of Identity Services Engine to use. Default: `"3.1_Patch_1"`
ise_wait_on_rate_limit boolean	Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: `false` `true` ← (default)
mac string	Endpoint’s mac.
mdmAttributes dictionary	Endpoint’s mdmAttributes.
mdmComplianceStatus boolean	MdmComplianceStatus flag. Choices: `false` `true`
mdmEncrypted boolean	MdmEncrypted flag. Choices: `false` `true`
mdmEnrolled boolean	MdmEnrolled flag. Choices: `false` `true`
mdmIMEI string	Endpoint’s mdmIMEI.
mdmJailBroken boolean	MdmJailBroken flag. Choices: `false` `true`
mdmManufacturer string	Endpoint’s mdmManufacturer.
mdmModel string	Endpoint’s mdmModel.
mdmOS string	Endpoint’s mdmOS.
mdmPhoneNumber string	Endpoint’s mdmPhoneNumber.
mdmPinlock boolean	MdmPinlock flag. Choices: `false` `true`
mdmReachable boolean	MdmReachable flag. Choices: `false` `true`
mdmSerial string	Endpoint’s mdmSerial.
mdmServerName string	Endpoint’s mdmServerName.
name string	Endpoint’s name.
portalUser string	Endpoint’s portalUser.
profileId string	Endpoint’s profileId.
staticGroupAssignment boolean	StaticGroupAssignment flag. Choices: `false` `true`
staticProfileAssignment boolean	StaticProfileAssignment flag. Choices: `false` `true`

Notes

Note

SDK Method used are endpoint.Endpoint.create_endpoint, endpoint.Endpoint.delete_endpoint_by_id, endpoint.Endpoint.update_endpoint_by_id,
Paths used are post /ers/config/endpoint, delete /ers/config/endpoint/{id}, put /ers/config/endpoint/{id},
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: Update by id
  cisco.ise.endpoint:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    customAttributes:
      customAttributes: {}
    description: string
    groupId: string
    id: string
    identityStore: string
    identityStoreId: string
    mac: string
    mdmAttributes:
      mdmComplianceStatus: true
      mdmEncrypted: true
      mdmEnrolled: true
      mdmIMEI: string
      mdmJailBroken: true
      mdmManufacturer: string
      mdmModel: string
      mdmOS: string
      mdmPhoneNumber: string
      mdmPinlock: true
      mdmReachable: true
      mdmSerial: string
      mdmServerName: string
    name: string
    portalUser: string
    profileId: string
    staticGroupAssignment: true
    staticProfileAssignment: true

- name: Delete by id
  cisco.ise.endpoint:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    id: string

- 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: {}
    description: string
    groupId: string
    identityStore: string
    identityStoreId: string
    mac: string
    mdmAttributes:
      mdmComplianceStatus: true
      mdmEncrypted: true
      mdmEnrolled: true
      mdmIMEI: string
      mdmJailBroken: true
      mdmManufacturer: string
      mdmModel: string
      mdmOS: string
      mdmPhoneNumber: string
      mdmPinlock: true
      mdmReachable: true
      mdmSerial: string
      mdmServerName: string
    name: string
    portalUser: string
    profileId: string
    staticGroupAssignment: true
    staticProfileAssignment: true

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: {"customAttributes": {"customAttributes": {}}, "description": "string", "groupId": "string", "id": "string", "identityStore": "string", "identityStoreId": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "mac": "string", "mdmAttributes": {"mdmComplianceStatus": true, "mdmEncrypted": true, "mdmEnrolled": true, "mdmIMEI": "string", "mdmJailBroken": true, "mdmManufacturer": "string", "mdmModel": "string", "mdmOS": "string", "mdmPhoneNumber": "string", "mdmPinlock": true, "mdmReachable": true, "mdmSerial": "string", "mdmServerName": "string"}, "name": "string", "portalUser": "string", "profileId": "string", "staticGroupAssignment": true, "staticProfileAssignment": true}
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: `{"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}`

Key

Description

ise_response

dictionary

A dictionary or list with the response returned by the Cisco ISE Python SDK

Returned: always

Sample: {"customAttributes": {"customAttributes": {}}, "description": "string", "groupId": "string", "id": "string", "identityStore": "string", "identityStoreId": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "mac": "string", "mdmAttributes": {"mdmComplianceStatus": true, "mdmEncrypted": true, "mdmEnrolled": true, "mdmIMEI": "string", "mdmJailBroken": true, "mdmManufacturer": "string", "mdmModel": "string", "mdmOS": "string", "mdmPhoneNumber": "string", "mdmPinlock": true, "mdmReachable": true, "mdmSerial": "string", "mdmServerName": "string"}, "name": "string", "portalUser": "string", "profileId": "string", "staticGroupAssignment": true, "staticProfileAssignment": true}

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: {"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}

Authors

Rafael Campos (@racampos)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/ise/endpoint_module.html