Модуль cisco.ise.custom_attributes – Модуль ресурсов для пользовательских атрибутов

Примечание

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

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

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

Для использования в playbook, укажите: cisco.ise.custom_attributes.

Новое в cisco.ise 1.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Управление операциями создания и удаления ресурса «Пользовательские атрибуты».

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
attributeName string	attributeName пользовательских атрибутов.
attributeType string	attributeType пользовательских атрибутов.
ise_debug boolean	Флаг для Identity Services Engine SDK для включения отладки. Варианты: `false` ← (по умолчанию) `true`
ise_hostname string / обязательный	Имя хоста Identity Services Engine.
ise_password string / обязательный	Пароль Identity Services Engine для аутентификации.
ise_single_request_timeout integer добавлено в cisco.ise 3.0.0	Таймаут (в секундах) для HTTP-запросов RESTful. По умолчанию: `60`
ise_username string / обязательный	Имя пользователя Identity Services Engine для аутентификации.
ise_uses_api_gateway boolean добавлено в 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 boolean добавлено в cisco.ise 3.0.0	Флаг, который сообщает SDK, отправляем ли мы токен CSRF в API ERS ISE. Если это True, SDK предполагает, что проверка CSRF вашего ISE включена. Если это True, предполагается, что вам нужно, чтобы SDK автоматически управлял токеном CSRF для вас. Варианты: `false` ← (по умолчанию) `true`
ise_verify boolean	Флаг для включения или отключения проверки SSL-сертификата. Варианты: `false` `true` ← (по умолчанию)
ise_version string	Сообщает SDK, какую версию Identity Services Engine использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate-limit boolean	Флаг для Identity Services Engine SDK для включения автоматической обработки ограничения скорости. Варианты: `false` `true` ← (по умолчанию)
name string	Параметр пути имени. Имя пользовательского атрибута.

Примечания

Примечание

Используемые методы SDK: customattributes.Customattributes.create_custom_attribute, customattributes.Customattributes.delete,
Используемые пути: post /api/v1/endpoint-custom-attribute, delete /api/v1/endpoint-custom-attribute/{name},
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

Примеры

- name: Create
  cisco.ise.custom_attributes:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    attributeName: string
    attributeType: string

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

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

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

Ключ	Описание
ise_response словарь	Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: `{"attributeName": "string", "attributeType": "string"}`

Авторы

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/custom_attributes_module.html