Модуль cisco.ise.endpoint_register — Модуль ресурсов для Endpoint Register
Примечание
Этот модуль входит в коллекцию cisco.ise (версия 2.9.3).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля потребуются дополнительные требования. Подробности см. в разделе Требования.
Для использования в плейбуке укажите: cisco.ise.endpoint_register.
Новое в cisco.ise 1.0.0
Описание
- Управление операциями обновления ресурса Endpoint Register.
- Этот API позволяет клиенту регистрировать конечную точку.
Примечание
Этот модуль имеет соответствующий плагин действий.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
customAttributes словарь | Настраиваемые атрибуты Endpoint Register. |
|
customAttributes словарь |
Карта ключ-значение. |
description строка | Описание Endpoint Register. |
groupId строка | groupId Endpoint Register. |
id строка | id Endpoint Register. |
identityStore строка | identityStore Endpoint Register. |
identityStoreId строка | identityStoreId Endpoint Register. |
ise_debug булево | Флаг для включения отладки Identity Services Engine SDK. Варианты:
|
ise_hostname строка / обязательно | Имя хоста Identity Services Engine. |
ise_password строка / обязательно | Пароль Identity Services Engine для аутентификации. |
ise_single_request_timeout целое число добавлено в cisco.ise 3.0.0 | Таймаут (в секундах) для RESTful HTTP-запросов. По умолчанию: |
ise_username строка / обязательно | Имя пользователя Identity Services Engine для аутентификации. |
ise_uses_api_gateway булево добавлено в cisco.ise 1.1.0 | Флаг, который сообщает SDK, использовать ли шлюз API Identity Services Engine для отправки запросов. Если значение true, используется шлюз API ISE, и запросы отправляются на https://{{ise_hostname}}. Если значение false, запросы отправляются на https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Варианты:
|
ise_uses_csrf_token булево добавлено в cisco.ise 3.0.0 | Флаг, который сообщает SDK, отправлять ли токен CSRF в API ERS ISE. Если значение True, SDK предполагает, что проверка CSRF ISE включена. Если значение True, предполагается, что SDK должен автоматически управлять токеном CSRF. Варианты:
|
ise_verify булево | Флаг для включения или отключения проверки сертификата SSL. Варианты:
|
ise_version строка | Сообщает SDK, какую версию Identity Services Engine использовать. По умолчанию: |
ise_wait_on_rate_limit булево | Флаг для Identity Services Engine SDK для автоматической обработки лимитов скорости. Варианты:
|
mac строка | mac Endpoint Register. |
mdmAttributes словарь | mdmAttributes Endpoint Register. |
|
mdmComplianceStatus булево |
Флаг mdmComplianceStatus. Варианты:
|
|
mdmEncrypted булево |
Флаг mdmEncrypted. Варианты:
|
|
mdmEnrolled boolean |
Флаг mdmEnrolled. Варианты:
|
|
mdmIMEI string |
mdmIMEI устройства Endpoint Register. |
|
mdmJailBroken boolean |
Флаг mdmJailBroken. Варианты:
|
|
mdmManufacturer string |
mdmManufacturer устройства Endpoint Register. |
|
mdmModel string |
mdmModel устройства Endpoint Register. |
|
mdmOS string |
mdmOS устройства Endpoint Register. |
|
mdmPhoneNumber string |
mdmPhoneNumber устройства Endpoint Register. |
|
mdmPinlock boolean |
Флаг mdmPinlock. Варианты:
|
|
mdmReachable boolean |
Флаг mdmReachable. Варианты:
|
|
mdmSerial string |
mdmSerial устройства Endpoint Register. |
|
mdmServerName string |
mdmServerName устройства Endpoint Register. |
name string | Имя устройства Endpoint Register. |
portalUser string | portalUser устройства Endpoint Register. |
profileId string | profileId устройства Endpoint Register. |
staticGroupAssignment boolean | Флаг staticGroupAssignment. Варианты:
|
staticProfileAssignment boolean | Флаг staticProfileAssignment. Варианты:
|
Примечания
Примечание
- Используемые методы SDK: endpoint.Endpoint.register_endpoint,
- Используемые пути: put /ers/config/endpoint/register,
- Не поддерживает
check_mode - Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения
Примеры
- 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
ise_response словарь | Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/ise/endpoint_register_module.html