cisco.ise.endpoint – Resource module for Endpoint

Note

This plugin is part of the cisco.ise collection (version 1.2.1).

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.

To use it in a playbook, specify: cisco.ise.endpoint.

New in version 1.0.0: of cisco.ise

Synopsis

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

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk >= 1.1.0

  • python >= 3.5

Parameters

Parameter Choices/Defaults 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
    Choices:
  • no ←
  • yes
Flag for Identity Services Engine SDK to enable debugging.
ise_hostname
string / required
The Identity Services Engine hostname.
ise_password
string / required
The Identity Services Engine password to authenticate.
ise_username
string / required
The Identity Services Engine username to authenticate.
ise_uses_api_gateway
boolean
added in 1.1.0 of cisco.ise
    Choices:
  • no
  • yes ←
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).
ise_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
ise_version
string
Default:
"3.1.0"
Informs the SDK which version of Identity Services Engine to use.
ise_wait_on_rate_limit
boolean
    Choices:
  • no
  • yes ←
Flag for Identity Services Engine SDK to enable automatic rate-limit handling.
mac
string
Endpoint's mac.
mdmAttributes
dictionary
Endpoint's mdmAttributes.
mdmComplianceStatus
boolean
    Choices:
  • no
  • yes
MdmComplianceStatus flag.
mdmEncrypted
boolean
    Choices:
  • no
  • yes
MdmEncrypted flag.
mdmEnrolled
boolean
    Choices:
  • no
  • yes
MdmEnrolled flag.
mdmIMEI
string
Endpoint's mdmIMEI.
mdmJailBroken
boolean
    Choices:
  • no
  • yes
MdmJailBroken flag.
mdmManufacturer
string
Endpoint's mdmManufacturer.
mdmModel
string
Endpoint's mdmModel.
mdmOS
string
Endpoint's mdmOS.
mdmPhoneNumber
string
Endpoint's mdmPhoneNumber.
mdmPinlock
boolean
    Choices:
  • no
  • yes
MdmPinlock flag.
mdmReachable
boolean
    Choices:
  • no
  • yes
MdmReachable flag.
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
    Choices:
  • no
  • yes
StaticGroupAssignment flag.
staticProfileAssignment
boolean
    Choices:
  • no
  • yes
StaticProfileAssignment flag.

Notes

Note

  • Does not support check_mode

See Also

See also

Endpoint reference

Complete reference of the Endpoint object model.

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 Returned Description
ise_response
dictionary
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "id": "string", "name": "string", "description": "string", "mac": "string", "profileId": "string", "staticProfileAssignment": true, "groupId": "string", "staticGroupAssignment": true, "portalUser": "string", "identityStore": "string", "identityStoreId": "string", "mdmAttributes": { "mdmServerName": "string", "mdmReachable": true, "mdmEnrolled": true, "mdmComplianceStatus": true, "mdmOS": "string", "mdmManufacturer": "string", "mdmModel": "string", "mdmSerial": "string", "mdmEncrypted": true, "mdmPinlock": true, "mdmJailBroken": true, "mdmIMEI": "string", "mdmPhoneNumber": "string" }, "customAttributes": { "customAttributes": {} }, "link": { "rel": "string", "href": "string", "type": "string" } }
ise_update_response
dictionary
added in 1.1.0 of cisco.ise
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "UpdatedFieldsList": { "updatedField": { "field": "string", "oldValue": "string", "newValue": "string" }, "field": "string", "oldValue": "string", "newValue": "string" } }


Authors

  • Rafael Campos (@racampos)