Модуль cisco.dnac.reserve_ip_subpool_info — Модуль информации о резервируемом IP-подпуле

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.dnac.reserve_ip_subpool_info.

Добавлен в cisco.dnac 3.1.0

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

Описание

Получить все резервируемые IP-подпулы.
API для получения информации о подпуле.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для Cisco DNA Center SDK, включающий отладку. Варианты: `false` ← (по умолчанию) `true`
dnac_host string / обязательно	Имя хоста Cisco DNA Center.
dnac_password string	Пароль для аутентификации Cisco DNA Center.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username алиасы: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения/отключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version string	Указывает SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
groupName string	Параметр groupName. Имя группы.
headers dictionary	Дополнительные заголовки.
ignoreInheritedGroups string	Параметр ignoreInheritedGroups. Игнорирует подпулы, унаследованные от родительского сайта. Должен быть указан siteId или ignoreInheritedGroups. Они могут быть указаны вместе.
...	...

Примечания

Примечание

Используемые методы SDK: network_settings.NetworkSettings.get_reserve_ip_subpool,
Используемые пути: get /dna/intent/api/v1/reserve-ip-subpool,
Поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

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

Примеры

- name: Get all Reserve Ip Subpool
  cisco.dnac.reserve_ip_subpool_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}}"
    siteId: string
    offset: 0
    limit: 0
    ignoreInheritedGroups: string
    poolUsage: string
    groupName: string
  register: result

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращенным Cisco DNAC Python SDK Возвращается: всегда Пример: {"response": [{"groupName": "string", "groupOwner": "string", "id": "string", "ipPools": [{"clientOptions": {}, "configureExternalDhcp": true, "context": [{"contextKey": "string", "contextValue": "string", "owner": "string"}], "createTime": 0, "dhcpServerIps": [{}], "dnsServerIps": [{}], "gateways": ["string"], "groupUuid": "string", "id": "string", "ipPoolCidr": "string", "ipPoolName": "string", "ipv6": true, "lastUpdateTime": 0, "overlapping": true, "owner": "string", "parentUuid": "string", "shared": true, "totalIpAddressCount": 0, "usedIpAddressCount": 0, "usedPercentage": "string"}], "siteHierarchy": "string", "siteId": "string", "type": "string"}], "version": "string"}

Ключ

Описание

dnac_response

словарь

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

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

Пример: {"response": [{"groupName": "string", "groupOwner": "string", "id": "string", "ipPools": [{"clientOptions": {}, "configureExternalDhcp": true, "context": [{"contextKey": "string", "contextValue": "string", "owner": "string"}], "createTime": 0, "dhcpServerIps": [{}], "dnsServerIps": [{}], "gateways": ["string"], "groupUuid": "string", "id": "string", "ipPoolCidr": "string", "ipPoolName": "string", "ipv6": true, "lastUpdateTime": 0, "overlapping": true, "owner": "string", "parentUuid": "string", "shared": true, "totalIpAddressCount": 0, "usedIpAddressCount": 0, "usedPercentage": "string"}], "siteHierarchy": "string", "siteId": "string", "type": "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/dnac/reserve_ip_subpool_info_module.html