cisco.ise.endpoints модуль — Модуль ресурсов для точек доступа

Примечание

Этот модуль является частью коллекции cisco.ise (версия 2.9.3).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить ее, используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Для использования в книге задач укажите: cisco.ise.endpoints.

Новая в cisco.ise 1.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Управление операциями создания, обновления и удаления ресурса Точки доступа.

Примечание

У этого модуля есть соответствующий плагин действия.

Требования

Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
connectedLinks словарь	Подключенные ссылки конечной точки.
customAttributes словарь	Пользовательские атрибуты конечной точки.
description строка	Описание конечной точки.
deviceType строка	Тип устройства конечной точки.
groupId строка	Группа конечной точки.
hardwareRevision строка	Ревизия аппаратного обеспечения конечной точки.
id строка	Идентификатор конечной точки.
identityStore строка	Магазин идентификации конечной точки.
identityStoreId строка	Идентификатор магазина идентификации конечной точки.
ipAddress строка	IP-адрес конечной точки.
ise_debug логическое	Флаг для включения отладки в SDK Identity Services Engine. Варианты: `false` ← (по умолчанию) `true`
ise_hostname строка / обязательно	Имя хоста Identity Services Engine.
ise_password строка / обязательно	Пароль Identity Services Engine для аутентификации.
ise_single_request_timeout целое число добавлен в cisco.ise 3.0.0	Таймаут (в секундах) для RESTful HTTP запросов. По умолчанию: `60`
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). Варианты: `false` `true` ← (по умолчанию)
ise_uses_csrf_token логическое добавлен в cisco.ise 3.0.0	Флаг, указывающий SDK, отправлять ли токен CSRF в API ERS ISE. Если True, SDK предполагает, что проверка CSRF ISE включена. Если True, предполагает, что SDK должен автоматически управлять токеном CSRF. Варианты: `false` ← (по умолчанию) `true`
ise_verify логическое	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
ise_version строка	Указывает SDK, какую версию Identity Services Engine использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate_limit логическое	Флаг для включения автоматической обработки ограничения скорости в SDK Identity Services Engine. Варианты: `false` `true` ← (по умолчанию)
mac строка	MAC-адрес конечной точки.
mdmAttributes словарь	Атрибуты MDM конечной точки.
name строка	Имя конечной точки.

portalUser string	Почтовый адрес пользователя портала устройства.
productId string	Идентификатор продукта устройства.
profileId string	Идентификатор профиля устройства.
protocol string	Протокол устройства.
serialNumber string	Серийный номер устройства.
softwareRevision string	Ревизия программного обеспечения устройства.
staticGroupAssignment boolean	Флаг staticGroupAssignment. Значения: `false` `true`
staticProfileAssignment boolean	Флаг staticProfileAssignment. Значения: `false` `true`
value string	Параметр пути значения. Идентификатор или MAC-адрес устройства.
vendor string	Производитель устройства.

Примечания

Примечание

Используемые методы SDK: endpoints.Endpoints.create_end_point, endpoints.Endpoints.delete_endpoint, endpoints.Endpoints.update_endpoint,
Используемые пути: post /api/v1/endpoint, delete /api/v1/endpoint/{value}, put /api/v1/endpoint/{value},
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений Cisco ISE SDK.
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения.

Примеры

- name: Create
  cisco.ise.endpoints:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    connectedLinks: {}
    customAttributes: {}
    description: string
    deviceType: string
    groupId: string
    hardwareRevision: string
    id: string
    identityStore: string
    identityStoreId: string
    ipAddress: string
    mac: string
    mdmAttributes: {}
    name: string
    portalUser: string
    productId: string
    profileId: string
    protocol: string
    serialNumber: string
    softwareRevision: string
    staticGroupAssignment: true
    staticProfileAssignment: true
    vendor: string

- name: Update by id
  cisco.ise.endpoints:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    connectedLinks: {}
    customAttributes: {}
    description: string
    deviceType: string
    groupId: string
    hardwareRevision: string
    id: string
    identityStore: string
    identityStoreId: string
    ipAddress: string
    mac: string
    mdmAttributes: {}
    name: string
    portalUser: string
    productId: string
    profileId: string
    protocol: string
    serialNumber: string
    softwareRevision: string
    staticGroupAssignment: true
    staticProfileAssignment: true
    value: string
    vendor: string

- name: Delete by id
  cisco.ise.endpoints:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    value: string

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
ise_response dictionary	Словарь или список с ответом, возвращаемым Cisco ISE Python SDK Возвращается: всегда Пример: {"connectedLinks": {}, "customAttributes": {}, "description": "string", "deviceType": "string", "groupId": "string", "hardwareRevision": "string", "id": "string", "identityStore": "string", "identityStoreId": "string", "ipAddress": "string", "mac": "string", "mdmAttributes": {}, "name": "string", "portalUser": "string", "productId": "string", "profileId": "string", "protocol": "string", "serialNumber": "string", "softwareRevision": "string", "staticGroupAssignment": true, "staticProfileAssignment": true, "vendor": "string"}
ise_update_response dictionary добавлен в cisco.ise 1.1.0	Словарь или список с ответом, возвращаемым Cisco ISE Python SDK Возвращается: всегда Пример: {"connectedLinks": {}, "customAttributes": {}, "description": "string", "deviceType": "string", "groupId": "string", "hardwareRevision": "string", "id": "string", "identityStore": "string", "identityStoreId": "string", "ipAddress": "string", "mac": "string", "mdmAttributes": {}, "name": "string", "portalUser": "string", "productId": "string", "profileId": "string", "protocol": "string", "serialNumber": "string", "softwareRevision": "string", "staticGroupAssignment": true, "staticProfileAssignment": true, "vendor": "string"}

Ключ

Описание

ise_response

dictionary

Словарь или список с ответом, возвращаемым Cisco ISE Python SDK

Возвращается: всегда

Пример: {"connectedLinks": {}, "customAttributes": {}, "description": "string", "deviceType": "string", "groupId": "string", "hardwareRevision": "string", "id": "string", "identityStore": "string", "identityStoreId": "string", "ipAddress": "string", "mac": "string", "mdmAttributes": {}, "name": "string", "portalUser": "string", "productId": "string", "profileId": "string", "protocol": "string", "serialNumber": "string", "softwareRevision": "string", "staticGroupAssignment": true, "staticProfileAssignment": true, "vendor": "string"}

ise_update_response

dictionary

добавлен в cisco.ise 1.1.0

Словарь или список с ответом, возвращаемым Cisco ISE Python SDK

Возвращается: всегда

Авторы

Rafael Campos (@racampos)

Ссылки на коллекцию

© 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/endpoints_module.html