cisco.ise.endpoint_register – Resource module for Endpoint Register

Note

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

To install it use: ansible-galaxy collection install cisco.ise.

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

New in version 1.0.0: of cisco.ise

Synopsis

  • Manage operation update of the resource Endpoint Register.

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk >= 1.0.0

  • python >= 3.5

Parameters

Parameter Choices/Defaults 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
    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_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
ise_version
string
Default:
"3.0.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 Register's mac.
mdmAttributes
dictionary
Endpoint Register'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 Register's mdmIMEI.
mdmJailBroken
boolean
    Choices:
  • no
  • yes
MdmJailBroken flag.
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
    Choices:
  • no
  • yes
MdmPinlock flag.
mdmReachable
boolean
    Choices:
  • no
  • yes
MdmReachable flag.
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
    Choices:
  • no
  • yes
StaticGroupAssignment flag.
staticProfileAssignment
boolean
    Choices:
  • no
  • yes
StaticProfileAssignment flag.

Notes

Note

  • Does not support check_mode

See Also

See also

Endpoint Register reference

Complete reference of the Endpoint Register object model.

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

Sample:
{}


Authors

  • Rafael Campos (@racampos)