Модуль cisco.dnac.sda_virtual_network_ip_pool_info – Модуль информации для пула IP-адресов виртуальной сети SDA

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.dnac.sda_virtual_network_ip_pool_info.

Новый в cisco.dnac 3.1.0

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

Обзор

Получить все пулы IP-адресов виртуальной сети SDA.
Получить пул IP-адресов из виртуальной сети SDA.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Выбор: `false` ← (по умолчанию) `true`
dnac_host строка / требуется	Имя хоста Cisco DNA Center.
dnac_password строка	Пароль Cisco DNA Center для аутентификации.
dnac_port целое число	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user строка	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Выбор: `false` `true` ← (по умолчанию)
dnac_version строка	Сообщает SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
headers словарь	Дополнительные заголовки.
ipPoolName строка добавлен в cisco.dnac 4.0.0	Параметр запроса ipPoolName. IpPoolName. Используйте vlanName в качестве значения для этого параметра, если один и тот же пул IP-адресов назначен нескольким виртуальным сетям (например, IpPoolName=vlan1021).
siteNameHierarchy строка добавлен в cisco.dnac 4.0.0	Параметр запроса siteNameHierarchy.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки запрошенных тел по схеме JSON. Выбор: `false` `true` ← (по умолчанию)
virtualNetworkName строка	Параметр запроса virtualNetworkName.

Примечания

Примечание

Используемые методы SDK — sda.Sda.get_ip_pool_from_sda_virtual_network,
Используемые пути — get /dna/intent/api/v1/business/sda/virtualnetwork/ippool,
Поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

Документация Cisco DNA Center для SDA GetIPPoolFromSDAVirtualNetwork: Полное руководство по API GetIPPoolFromSDAVirtualNetwork.

Примеры

- name: Get all Sda Virtual Network Ip Pool
  cisco.dnac.sda_virtual_network_ip_pool_info:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    headers: "{{my_headers | from_json}}"
    siteNameHierarchy: string
    virtualNetworkName: string
    ipPoolName: string
  register: result

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращённым Cisco DNAC Python SDK Возвращается: всегда Пример: `{"authenticationPolicyName": "string", "description": "string", "ipPoolName": "string", "isL2FloodingEnabled": true, "isThisCriticalPool": true, "scalableGroupName": "string", "status": "string", "trafficType": "string", "virtualNetworkName": "string"}`

Ключ

Описание

dnac_response

словарь

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

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

Пример: {"authenticationPolicyName": "string", "description": "string", "ipPoolName": "string", "isL2FloodingEnabled": true, "isThisCriticalPool": true, "scalableGroupName": "string", "status": "string", "trafficType": "string", "virtualNetworkName": "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/dnac/sda_virtual_network_ip_pool_info_module.html