Модуль cisco.ise.sgt – Модуль ресурсов для SGt

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.ise.sgt.

Добавлен в cisco.ise 1.0.0

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

Описание

Управление операциями создания, обновления и удаления ресурса SGt.
Этот API создаёт группу безопасности.
Этот API удаляет группу безопасности.
Этот API позволяет клиенту обновить группу безопасности.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
defaultSGACLs список / элементы=словарь	Значения по умолчанию SGACL для SGt.
description строка	Описание SGt.
generationId строка	generationId SGt.
id строка	Идентификатор SGt.
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` ← (по умолчанию)
isReadOnly логический	Флаг isReadOnly. Варианты: `false` `true`
name строка / обязательно	Имя SGt.
propogateToApic логический	Флаг propogateToApic. Варианты: `false` `true`
value целое число / обязательно	Диапазон значений от 2 до 65519 или от -1 до автоматического генерирования.

Примечания

Примечание

Используемые методы SDK: security_groups.SecurityGroups.create_security_group, security_groups.SecurityGroups.delete_security_group_by_id, security_groups.SecurityGroups.update_security_group_by_id,
Используемые пути: post /ers/config/sgt, delete /ers/config/sgt/{id}, put /ers/config/sgt/{id},
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

См. также

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

Примеры

- name: Update by id
  cisco.ise.sgt:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    defaultSGACLs:
    - {}
    description: string
    generationId: string
    id: string
    isReadOnly: true
    name: string
    propogateToApic: true
    value: 0

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

- name: Create
  cisco.ise.sgt:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    defaultSGACLs:
    - {}
    description: string
    generationId: string
    isReadOnly: true
    name: string
    propogateToApic: true
    value: 0

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

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

Ключ	Описание
ise_response словарь	Словарь или список со значением, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: `{"defaultSGACLs": [{}], "description": "string", "generationId": "string", "id": "string", "isReadOnly": true, "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "propogateToApic": true, "value": 0}`
ise_update_response словарь добавлено в cisco.ise 1.1.0	Словарь или список со значением, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: `{"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "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/sgt_module.html