Модуль cisco.ise.sxp_connections – Модуль ресурсов для подключений SXP

Примечание

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

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

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

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

Новая в cisco.ise 1.0.0

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

Обзор

Управление операциями создания, обновления и удаления ресурсов подключений SXP.
Этот API создает подключение SXP.
Этот API удаляет подключение SXP.
Этот API позволяет клиенту обновлять подключение SXP.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
description строка	Описание SXP подключений.
enabled логическое	Флаг включения. Варианты: `false` `true`
id строка	Идентификатор SXP подключений.
ipAddress строка	IP-адрес SXP подключений.
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 для отправки запросов. Если истинно, используется API шлюз ISE и отправляет запросы по адресу https://{{ise_hostname}}. Если ложно, запросы отправляются по адресу https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Варианты: `false` `true` ← (по умолчанию)
ise_uses_csrf_token логическое добавлен в cisco.ise 3.0.0	Флаг, информирующий SDK о необходимости отправки CSRF токена в ERS API ISE. Если истинно, SDK предполагает, что проверка CSRF ISE включена. Если истинно, предполагается, что 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` ← (по умолчанию)
sxpMode строка	Режим SXP подключений.
sxpNode строка	Узел SXP подключений.
sxpPeer строка	Партнёр SXP подключений.
sxpVersion строка	Версия SXP подключений.
sxpVpn строка	SXP VPN подключений.

Примечания

Примечание

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

Примеры

- name: Update by id
  cisco.ise.sxp_connections:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    enabled: true
    id: string
    ipAddress: string
    sxpMode: string
    sxpNode: string
    sxpPeer: string
    sxpVersion: string
    sxpVpn: string

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

- name: Create
  cisco.ise.sxp_connections:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    enabled: true
    ipAddress: string
    sxpMode: string
    sxpNode: string
    sxpPeer: string
    sxpVersion: string
    sxpVpn: string

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

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

Ключ	Описание
ise_response словарь	Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: `{"description": "string", "enabled": true, "id": "string", "ipAddress": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "sxpMode": "string", "sxpNode": "string", "sxpPeer": "string", "sxpVersion": "string", "sxpVpn": "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"}]}}`

Ключ

Описание

ise_response

словарь

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

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

Пример: {"description": "string", "enabled": true, "id": "string", "ipAddress": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "sxpMode": "string", "sxpNode": "string", "sxpPeer": "string", "sxpVersion": "string", "sxpVpn": "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/sxp_connections_module.html