Модуль cisco.ise.sg_mapping – Модуль ресурсов для сопоставления SG

Примечание

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

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

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

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

Новая в cisco.ise 1.0.0

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

Описание

Управление операциями создания, обновления и удаления ресурса SG Mapping.
Этот API создаёт сопоставление IP и SGT.
Этот API удаляет сопоставление IP и SGT.
Этот API позволяет клиенту обновить сопоставление IP и SGT по ID.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
deployTo строка	Обязательный, если не задан mappingGroup или deployType=ALL.
deployType строка	Допустимые значения - ALL, - ND, - NDG.
hostIp строка	Обязательный, если hostName пустой – валидный IP-адрес.
hostName строка	Обязательный, если hostIp пустой.
id строка	Идентификатор сопоставления SG.
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` ← (по умолчанию)
mappingGroup строка	Идентификатор группы сопоставлений. Обязателен, если не заданы sgt, deployTo и deployType.
name строка	Имя сопоставления SG.
sgt строка	Обязательный, если не задан mappingGroup.

Примечания

Примечание

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

См. также

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

Примеры

- name: Update by id
  cisco.ise.sg_mapping:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    deployTo: string
    deployType: string
    hostIp: string
    hostName: string
    id: string
    mappingGroup: string
    name: string
    sgt: string

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

- name: Create
  cisco.ise.sg_mapping:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    deployTo: string
    deployType: string
    hostIp: string
    hostName: string
    mappingGroup: string
    name: string
    sgt: string

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

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

Ключ	Описание
ise_response словарь	Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: `{"deployTo": "string", "deployType": "string", "hostIp": "string", "hostName": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "mappingGroup": "string", "name": "string", "sgt": "string"}`
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/sg_mapping_module.html