cisco.ise.endpoint_register module – Resource module for Endpoint Register

Note

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

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

New in cisco.ise 1.0.0

Synopsis

  • Manage operation update of the resource Endpoint Register.

  • This API allows the client to register 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.1.1

  • python >= 3.5

Parameters

Parameter

Comments

customAttributes

dictionary

Endpoint Register’s customAttributes.

customAttributes

dictionary

Key value map.

description

string

Endpoint Register’s description.

groupId

string

Endpoint Register’s groupId.

id

string

Endpoint Register’s id.

identityStore

string

Endpoint Register’s identityStore.

identityStoreId

string

Endpoint Register’s identityStoreId.

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

Endpoint Register’s mac.

mdmAttributes

dictionary

Endpoint Register’s mdmAttributes.

mdmComplianceStatus

boolean

MdmComplianceStatus flag.

Choices:

mdmEncrypted

boolean

MdmEncrypted flag.

Choices:

mdmEnrolled

boolean

MdmEnrolled flag.

Choices:

mdmIMEI

string

Endpoint Register’s mdmIMEI.

mdmJailBroken

boolean

MdmJailBroken flag.

Choices:

mdmManufacturer

string

Endpoint Register’s mdmManufacturer.

mdmModel

string

Endpoint Register’s mdmModel.

mdmOS

string

Endpoint Register’s mdmOS.

mdmPhoneNumber

string

Endpoint Register’s mdmPhoneNumber.

mdmPinlock

boolean

MdmPinlock flag.

Choices:

mdmReachable

boolean

MdmReachable flag.

Choices:

mdmSerial

string

Endpoint Register’s mdmSerial.

mdmServerName

string

Endpoint Register’s mdmServerName.

name

string

Endpoint Register’s name.

portalUser

string

Endpoint Register’s portalUser.

profileId

string

Endpoint Register’s profileId.

staticGroupAssignment

boolean

StaticGroupAssignment flag.

Choices:

staticProfileAssignment

boolean

StaticProfileAssignment flag.

Choices:

Notes

Note

  • SDK Method used are endpoint.Endpoint.register_endpoint,

  • Paths used are put /ers/config/endpoint/register,

  • 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 all
  cisco.ise.endpoint_register:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    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

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

Authors

  • Rafael Campos (@racampos)