Spec-Zone.ru › Ansible

Модуль cisco.ise.ipsec_info – Модуль информации об Ipsec

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.ise.ipsec_info.

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

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

Описание

  • Получить все данные Ipsec.
  • Получить данные Ipsec по идентификатору.
  • Возвращает все узлы с включённым IPsec и подробной информацией о конфигурации.
  • Возвращает подробную информацию о конфигурации IPsec для заданного узла с именем хоста и IP-адресом NAD.

Примечание

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

Требования

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

  • ciscoisesdk >= 2.2.3
  • python >= 3.5

Параметры

Параметр

Комментарии

filter

string

Параметр запроса фильтра. .. Контейнер **Простая фильтрация** должен быть доступен через параметр строки запроса filter. Структура фильтра представляет собой тройку поле-оператор-значение, разделенные точками. Можно отправить более одного фильтра. Логический оператор, общий для ВСЕХ критериев фильтрации, по умолчанию будет AND, и его можно изменить, используя параметр строки запроса *”filterType=or”*.

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

Оператор ‘EQ’ означает ‘Равно’.

Оператор ‘NEQ’ означает ‘Не равно’.

Оператор ‘GT’ означает ‘Больше чем’.

Оператор ‘LT’ означает ‘Меньше чем’.

Оператор ‘STARTSW’ означает ‘Начинается с’.

Оператор ‘NSTARTSW’ означает ‘Не начинается с’.

Оператор ‘ENDSW’ означает ‘Заканчивается на’.

Оператор ‘NENDSW’ означает ‘Не заканчивается на’.

Оператор ‘CONTAINS’ означает ‘Содержит’.

Оператор ‘NCONTAINS’ означает ‘Не содержит’.

filterType

string

Параметр запроса FilterType. Логический оператор, общий для ВСЕХ критериев фильтрации, по умолчанию будет AND, и его можно изменить, используя этот параметр.

hostName

string

Параметр пути HostName. Имя узла развернутого узла.

ise_debug

boolean

Флаг для Identity Services Engine SDK для включения отладки.

Варианты:

  • false ← (default)
  • true

ise_hostname

string / required

Имя узла Identity Services Engine.

ise_password

string / required

Пароль Identity Services Engine для аутентификации.

ise_single_request_timeout

integer

added in cisco.ise 3.0.0

Время ожидания (в секундах) для HTTP-запросов RESTful.

По умолчанию: 60

ise_username

string / required

Имя пользователя Identity Services Engine для аутентификации.

ise_uses_api_gateway

boolean

added in 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 ← (default)

ise_uses_csrf_token

boolean

added in cisco.ise 3.0.0

Флаг, который сообщает SDK, отправляем ли мы токен CSRF в API ERS ISE.

Если он True, SDK предполагает, что проверка CSRF вашего ISE включена.

Если он True, предполагается, что вам нужно, чтобы SDK автоматически управлял токеном CSRF для вас.

Варианты:

  • false ← (default)
  • true

ise_verify

boolean

Флаг для включения или отключения проверки сертификата SSL.

Варианты:

  • false
  • true ← (default)

ise_version

string

Сообщает SDK, какую версию Identity Services Engine использовать.

По умолчанию: "3.1_Patch_1"

ise_wait_on_rate_limit

boolean

Флаг для Identity Services Engine SDK для включения автоматической обработки ограничения скорости.

Варианты:

  • false
  • true ← (default)

nadIp

string

Параметр пути NadIp. IP-адрес NAD.

page

integer

Параметр запроса Page. Номер страницы.

size

integer

Параметр запроса Size. Количество возвращаемых объектов на страницу.

sort

string

Параметр запроса Sort. Тип сортировки - asc или desc.

sortBy

string

Параметр запроса SortBy. Столбец сортировки - Узлы с включенным IPsec сортируются по столбцам. Это применимо к полю - hostName.

Примечания

Примечание

  • Используемые методы SDK: native_ipsec.NativeIpsec.get_ipsec_enabled_nodes_generator, native_ipsec.NativeIpsec.get_ipsec_node,
  • Используемые пути: get /api/v1/ipsec, get /api/v1/ipsec/{hostName}/{nadIp},
  • Поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
  • Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

Примеры

- name: Get all Ipsec Info
  cisco.ise.ipsec_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 0
    size: 0
    filter: string
    filterType: string
    sort: string
    sortBy: string
  register: result

- name: Get Ipsec Info by id
  cisco.ise.ipsec_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    hostName: string
    nadIp: string
  register: result

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

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

Ключ

Описание

ise_response

словарь

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

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

Пример: {"authType": "string", "certId": "string", "configureVti": true, "createTime": "string", "espAhProtocol": "string", "hostName": "string", "id": "string", "iface": "string", "ikeReAuthTime": 0, "ikeVersion": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "localInternalIp": "string", "modeOption": "string", "nadIp": "string", "phaseOneDHGroup": "string", "phaseOneEncryptionAlgo": "string", "phaseOneHashAlgo": "string", "phaseOneLifeTime": 0, "phaseTwoDHGroup": "string", "phaseTwoEncryptionAlgo": "string", "phaseTwoHashAlgo": "string", "phaseTwoLifeTime": 0, "psk": "string", "remotePeerInternalIp": "string", "status": "string", "updateTime": "string"}

ise_responses

список / элементы=словарь

добавлено в cisco.ise 1.1.0

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

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

Пример: "[\n  {\n    \"authType\": \"string\",\n    \"certId\": \"string\",\n    \"configureVti\": true,\n    \"createTime\": \"string\",\n    \"espAhProtocol\": \"string\",\n    \"hostName\": \"string\",\n    \"id\": \"string\",\n    \"iface\": \"string\",\n    \"ikeReAuthTime\": 0,\n    \"ikeVersion\": \"string\",\n    \"link\": {\n      \"href\": \"string\",\n      \"rel\": \"string\",\n      \"type\": \"string\"\n    },\n    \"localInternalIp\": \"string\",\n    \"modeOption\": \"string\",\n    \"nadIp\": \"string\",\n    \"phaseOneDHGroup\": \"string\",\n    \"phaseOneEncryptionAlgo\": \"string\",\n    \"phaseOneHashAlgo\": \"string\",\n    \"phaseOneLifeTime\": 0,\n    \"phaseTwoDHGroup\": \"string\",\n    \"phaseTwoEncryptionAlgo\": \"string\",\n    \"phaseTwoHashAlgo\": \"string\",\n    \"phaseTwoLifeTime\": 0,\n    \"psk\": \"string\",\n    \"remotePeerInternalIp\": \"string\",\n    \"status\": \"string\",\n    \"updateTime\": \"string\"\n  }\n]\n"

Авторы

  • 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/ipsec_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API