.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. Anchors .. _ansible_collections.cisco.ise.endpoint_register_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.endpoint_register -- Resource module for Endpoint Register ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.ise collection `_ (version 2.0.0). 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 :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install cisco.ise`. To use it in a playbook, specify: :code:`cisco.ise.endpoint_register`. .. version_added .. versionadded:: 1.0.0 of cisco.ise .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation update of the resource Endpoint Register. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - ciscoisesdk >= 1.2.0 - python >= 3.5 .. Options Parameters ---------- .. raw:: html

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

.. Attributes .. Notes Notes ----- .. note:: - 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 .. Seealso See Also -------- .. seealso:: `Endpoint Register reference `_ Complete reference of the Endpoint Register object model. .. Examples Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html

Key	Returned	Description
ise_response dictionary	always	A dictionary or list with the response returned by the Cisco ISE Python SDK Sample: {}

.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors