cisco.ise.subscriber модуль — Модуль ресурсов для подписчика
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в книге задач укажите: cisco.ise.subscriber.
Добавлен в cisco.ise 2.8.0
Описание
- Управление операциями создания, обновления и удаления ресурса Подписчик.
Примечание
Для этого модуля существует соответствующий плагин действий.
Требования
Ниже приведены требования к хосту, на котором выполняется данный модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
enabled boolean | Подписчик включён или нет. Варианты:
|
friendlyName string | Наименование подписчика. |
identityGroups string | Группа(ы) идентификации. Если нужно несколько, они разделяются запятыми. |
imeis string | IMEI, который необходимо прикрепить к подписчику. |
imsi string | IMSI для подписчика. |
ise_debug boolean | Флаг для включения отладки в Identity Services Engine SDK. Варианты:
|
ise_hostname string / обязательно | Имя хоста Identity Services Engine. |
ise_password string / обязательно | Пароль Identity Services Engine для аутентификации. |
ise_single_request_timeout integer добавлен в cisco.ise 3.0.0 | Таймаут (в секундах) для запросов RESTful HTTP. По умолчанию: |
ise_username string / обязательно | Имя пользователя Identity Services Engine для аутентификации. |
ise_uses_api_gateway boolean добавлен в 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). Варианты:
|
ise_uses_csrf_token boolean добавлен в cisco.ise 3.0.0 | Флаг, указывающий SDK, отправлять ли токен CSRF в ERS API ISE. Если True, SDK предполагает, что проверка CSRF ISE включена. Если True, предполагается, что SDK должен автоматически управлять токеном CSRF. Варианты:
|
ise_verify boolean | Флаг для включения или отключения проверки SSL сертификата. Варианты:
|
ise_version string | Указывает SDK, какую версию Identity Services Engine использовать. По умолчанию: |
ise_wait_on_rate_limit boolean | Флаг для Identity Services Engine SDK для автоматической обработки лимитов запросов. Варианты:
|
ki string | KI. |
opc string | OPC. |
subscriberId string | Параметр пути subscriberId. Уникальный идентификатор объекта подписчика. |
Примечания
Примечание
- Используемые методы SDK: subscriber.Subscriber.create_subscriber, subscriber.Subscriber.delete_subscriber, subscriber.Subscriber.update_subscriber,
- Используемые пути: post /api/v1/fiveg/subscriber, delete /api/v1/fiveg/subscriber/{subscriberId}, put /api/v1/fiveg/subscriber/{subscriberId},
- Не поддерживает
check_mode - Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения
Примеры
- name: Create
cisco.ise.subscriber:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
enabled: true
friendlyName: string
identityGroups: string
imeis: string
imsi: string
ki: string
opc: string
- name: Update by id
cisco.ise.subscriber:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
enabled: true
friendlyName: string
identityGroups: string
imeis: string
ki: string
opc: string
subscriberId: string
- name: Delete by id
cisco.ise.subscriber:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
subscriberId: string
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
ise_response словарь | Словарь или список со значением возврата Python SDK Cisco ISE Возвращается: всегда Пример: |
ise_update_response словарь | Словарь или список со значением возврата Python SDK Cisco ISE Возвращается: всегда Пример: |
Ссылки на сборку
© 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/subscriber_module.html
