Модуль cisco.ise.device_administration_network_conditions – Модуль ресурсов для администрирования сетевых условий устройств

Примечание

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

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

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

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

Новая функция в cisco.ise 1.0.0

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

Обзор

Управление операциями создания, обновления и удаления ресурсов «Сетевые условия администрирования устройств».
Администрирование устройств – Создание сетевого условия.
Администрирование устройств – Удаление сетевого условия.
Администрирование устройств – Обновление сетевого условия.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
cliDnisList список / элементы=строка	<p>Это поле должно содержать идентификатор вызывающего абонента (CLI), запятую и идентификатор вызываемого абонента (DNIS).<br> Формат строки - идентификатор вызывающего абонента (CLI), идентификатор вызываемого абонента (DNIS)</p>.
conditionType строка	Это поле определяет содержимое поля условий.
description строка	Описание сетевых условий управления устройствами.
deviceGroupList список / элементы=строка	<p>Это поле должно содержать корень NDG, запятую и NDG (который находится под корнем).<br> Формат строки - имя корня NDG, NDG, порт</p>.
deviceList список / элементы=строка	<p>Это поле должно содержать имя устройства. Имя устройства должно совпадать с именем поля в объекте сетевого устройства. Формат строки - Имя устройства</p>.
id строка	Идентификатор сетевых условий управления устройствами.
ipAddrList список / элементы=строка	<p>Это поле должно содержать IP-адрес или подсеть.<br> IP-адрес может быть в формате IPv4 (n.n.n.n) или IPv6 (n n n n n n n n).<br> IP-подсеть может быть в формате IPv4 (n.n.n.n/m) или IPv6 (n n n n n n n n/m).<br> Формат строки - IP-адрес или подсеть</p>.
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 в 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 логический	Флаг для Identity Services Engine SDK, чтобы включить автоматическую обработку ограничения скорости. Варианты: `false` `true` ← (по умолчанию)
link словарь	Ссылка сетевых условий управления устройствами.
href строка	Ссылка сетевых условий управления устройствами.

END_OF_DOCUMENT_MARKER

rel string	rel модуля «Управление устройствами, условия сети».
type string	Тип модуля «Управление устройствами, условия сети».
macAddrList list / elements=string	<p>Это поле должно содержать MAC-адрес конечной станции, запятую и MAC-адреса назначения.<br> Каждый MAC-адрес должен содержать двенадцать шестнадцатеричных цифр в формате nn nn nn nn nn nn или nn-nn-nn-nn-nn-nn или nnnn.nnnn.nnnn или nnnnnnnnnnnn.<br> Формат строки - MAC конечной станции, MAC назначения </p>.
name string	Имя условия сети.

Примечания

Примечание

Используемые методы SDK: device_administration_network_conditions.DeviceAdministrationNetworkConditions.create_device_admin_network_condition, device_administration_network_conditions.DeviceAdministrationNetworkConditions.delete_device_admin_network_condition_by_id, device_administration_network_conditions.DeviceAdministrationNetworkConditions.update_device_admin_network_condition_by_id,
Используемые пути: post /device-admin/network-condition, delete /device-admin/network-condition/{id}, put /device-admin/network-condition/{id},
Не поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

См. также

Документация Cisco ISE для Управления устройствами - Условия сети: Полное описание API «Управление устройствами — Условия сети».

Примеры

- name: Create
  cisco.ise.device_administration_network_conditions:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    cliDnisList:
    - string
    conditionType: string
    description: string
    deviceGroupList:
    - string
    deviceList:
    - string
    id: string
    ipAddrList:
    - string
    link:
      href: string
      rel: string
      type: string
    macAddrList:
    - string
    name: string

- name: Update by id
  cisco.ise.device_administration_network_conditions:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    cliDnisList:
    - string
    conditionType: string
    description: string
    deviceGroupList:
    - string
    deviceList:
    - string
    id: string
    ipAddrList:
    - string
    link:
      href: string
      rel: string
      type: string
    macAddrList:
    - string
    name: string

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

Возвращаемые значения

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

Ключ	Описание
ise_response словарь	Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: `{"cliDnisList": ["string"], "conditionType": "string", "description": "string", "deviceGroupList": ["string"], "deviceList": ["string"], "id": "string", "ipAddrList": ["string"], "link": {"href": "string", "rel": "string", "type": "string"}, "macAddrList": ["string"], "name": "string"}`
ise_update_response словарь добавлен в cisco.ise 1.1.0	Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: `{"response": {"cliDnisList": ["string"], "conditionType": "string", "description": "string", "deviceGroupList": ["string"], "deviceList": ["string"], "id": "string", "ipAddrList": ["string"], "link": {"href": "string", "rel": "string", "type": "string"}, "macAddrList": ["string"], "name": "string"}, "version": "string"}`

Ключ

Описание

ise_response

словарь

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

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

Пример: {"cliDnisList": ["string"], "conditionType": "string", "description": "string", "deviceGroupList": ["string"], "deviceList": ["string"], "id": "string", "ipAddrList": ["string"], "link": {"href": "string", "rel": "string", "type": "string"}, "macAddrList": ["string"], "name": "string"}

ise_update_response

словарь

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

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

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

Пример: {"response": {"cliDnisList": ["string"], "conditionType": "string", "description": "string", "deviceGroupList": ["string"], "deviceList": ["string"], "id": "string", "ipAddrList": ["string"], "link": {"href": "string", "rel": "string", "type": "string"}, "macAddrList": ["string"], "name": "string"}, "version": "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/device_administration_network_conditions_module.html