Модуль cisco.ise.node_group – Модуль ресурсов для группы узлов

Примечание

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

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

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

Для использования его в книге сценариев укажите: cisco.ise.node_group.

Новый в cisco.ise 1.0.0

Описание
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата

Описание

Управление операциями создания, обновления и удаления ресурса «Группа узлов».
Этот API создаёт группу узлов в кластере. Группа узлов — это группа PSNs.
Удаление существующей группы узлов в кластере. Удаление группы узлов не удаляет узлы, но отказ от передачи уже не выполняется между узлами.
Обновление существующей группы узлов.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
описание строка	Описание группы узлов.
forceDelete логическое	Параметр запроса ForceDelete. Принудительно удалить группу, даже если она содержит один или несколько узлов. Варианты: `false` `true`
ise_debug логическое	Флаг для Identity Services Engine SDK, разрешающий отладку. Варианты: `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 в ERS API 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 логическое	Флаг для Identity Services Engine SDK для автоматической обработки лимитов запросов. Варианты: `false` `true` ← (по умолчанию)
marCache словарь	marCache группы узлов.
query-attempts целое число	Количество попыток запроса записи в кэш Cisco ISE. (0 - 5).
query-timeout целое число	Время (в секундах), по истечении которого запрос записи в кэш отменяется. (1 - 10).
replication-attempts целое число	Количество попыток репликации записи в кэш Cisco ISE. (0 - 5).
replication-timeout целое число	Время (в секундах), по истечении которого репликация записи в кэш отменяется. (1 - 10).
имя строка	Имя группы узлов.
nodeGroupName строка	Параметр пути nodeGroupName. Имя существующей группы узлов.

Примечания

Примечание

Используемые методы SDK: node_group.NodeGroup.create_node_group, node_group.NodeGroup.delete_node_group, node_group.NodeGroup.update_node_group,
Используемые пути: post /api/v1/deployment/node-group, delete /api/v1/deployment/node-group/{nodeGroupName}, put /api/v1/deployment/node-group/{nodeGroupName},
Не поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

См. также

Документация Cisco ISE по группе узлов: Полная справка по API группы узлов.

Примеры

- name: Create
  cisco.ise.node_group:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    marCache:
      query-attempts: 0
      query-timeout: 0
      replication-attempts: 0
      replication-timeout: 0
    name: string

- name: Update by name
  cisco.ise.node_group:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    marCache:
      query-attempts: 0
      query-timeout: 0
      replication-attempts: 0
      replication-timeout: 0
    name: string
    nodeGroupName: string

- name: Delete by name
  cisco.ise.node_group:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    forceDelete: true
    nodeGroupName: string

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

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

Ключ	Описание
ise_response словарь	Словарь или список со значением, возвращаемым Cisco ISE Python SDK Возвращается: всегда Пример: `{"description": "string", "marCache": {"query-attempts": 0, "query-timeout": 0, "replication-attempts": 0, "replication-timeout": 0}, "name": "string"}`
ise_update_response словарь добавлено в cisco.ise 1.1.0	Словарь или список со значением, возвращаемым Cisco ISE Python SDK Возвращается: всегда Пример: `{"success": {"message": "string"}, "version": "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/node_group_module.html