cisco.ise.endpoint – Resource module for Endpoint

Note

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

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

Parameters

Parameter Choices/Defaults Comments
customAttributes
dictionary
Endpoint's customAttributes.
customAttributes
dictionary
Endpoint's customAttributes.
key1
string
Endpoint's key1.
key2
string
Endpoint's key2.
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.
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.

See Also

See also

cisco.ise.plugins.module_utils.definitions.endpoint

The official documentation on the cisco.ise.plugins.module_utils.definitions.endpoint module.

Endpoint reference

Complete reference of the Endpoint object model.

Examples

- name: Create
  cisco.ise.endpoint:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: MyEndpoint
    groupId: aa13bb40-8bff-11e6-996c-525400b48521
    mac: 11:22:33:44:55:66
    name: MyEndpoint
    staticGroupAssignment: true

- 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
    description: a new description
    groupId: 3a1b38d0-8c00-11e6-996c-525400b48521
    id: string

- 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

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)