Модуль cisco.ise.reservation_info – Модуль информации о резервировании

Примечание

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

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

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

Для использования в playbook, укажите: cisco.ise.reservation_info.

Новая в cisco.ise 1.0.0

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

Обзор

Получение всей информации о резервировании.
Получение информации о резервировании по идентификатору.
Получение всех зарезервированных диапазонов тегов групп безопасности в ISE.
Получение зарезервированного диапазона SGT для конкретного клиента, указанного в URL.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
clientID строка	Параметр пути clientID. Уникальное имя клиента.
ise_debug булево	Флаг для SDK Identity Services Engine для включения отладки. Варианты: `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 в API ISE ERS. Если 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 булево	Флаг для SDK Identity Services Engine для включения автоматической обработки лимита запросов. Варианты: `false` `true` ← (по умолчанию)
page целое число	Параметр запроса страницы. Номер страницы.
size целое число	Параметр запроса размера. Количество объектов на странице.

Примечания

Примечание

Используемые методы SDK: sgt_range_reservation.SgtRangeReservation.get_sgt_reserved_range, sgt_range_reservation.SgtRangeReservation.get_sgt_reserved_ranges_generator,
Используемые пути: get /api/v1/sgt/reservation, get /api/v1/sgt/reservation/{clientID},
Поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

Примеры

- name: Get all Reservation Info
  cisco.ise.reservation_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 0
    size: 0
  register: result

- name: Get Reservation Info by id
  cisco.ise.reservation_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    clientID: string
  register: result

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

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

Ключ	Описание
ise_response словарь	Словарь или список со значением, возвращённым SDK Python Cisco ISE Возвращается: всегда Пример: `{"clientId": "string", "clientName": "string", "endIndex": 0, "startIndex": 0}`
ise_responses список / элементы=словарь добавлен в cisco.ise 1.1.0	Словарь или список со значением, возвращённым SDK Python Cisco ISE Возвращается: всегда Пример: `"[\n {\n \"clientId\": \"string\",\n \"clientName\": \"string\",\n \"endIndex\": 0,\n \"startIndex\": 0\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/reservation_info_module.html