Модуль cisco.dnac.reserve_ip_subpool – Модуль ресурсов для резервирования подсети IP-адресов

Примечание

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

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

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

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

Новое в cisco.dnac 3.1.0

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

Описание

Управление операциями создания, обновления и удаления ресурса «Резервирование подсети IP-адресов».
API для резервирования подсети IP-адресов из глобального пула.
API для удаления резервированной подсети IP-адресов.
API для обновления подсети IP-адресов из глобального пула.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (default) `true`
dnac_host string / required	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username aliases: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (default)
dnac_version string	Информирует SDK о том, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
id string	Параметр пути Id. Id резервного пула IP-адресов, который необходимо удалить.
ipv4DhcpServers list / elements=string	IPv4 вход для IP-адреса DHCP-сервера, например «1.1.1.1».
ipv4DnsServers list / elements=string	IPv4 вход для IP-адреса DNS-сервера, например «4.4.4.4».
ipv4GateWay string добавлено в cisco.dnac 4.0.0	Подробные сведения об IP-адресе шлюза, например 175.175.0.1.
ipv4GlobalPool string	IP-адрес глобального пула IPv4 с CIDR, например 175.175.0.0/16.
ipv4Prefix boolean	Если значение IPv4 prefix равно true, поле ввода длины префикса ip4 включено, если оно равно false, включен ввод общего количества хостов ipv4. Варианты: `false` `true`
ipv4PrefixLength integer	Длина префикса ipv4 требуется, когда значение ipv4prefix равно true.
ipv4Subnet string	IP-адрес подсети IPv4, например 175.175.0.0. При создании подпула IPv4 необходимо передать либо ipv4Subnet, либо ipv4TotalHost.
ipv4TotalHost integer	Общее количество хостов IPv4 требуется, когда значение ipv4prefix равно false.
ipv6AddressSpace boolean	Если значение пропущено или равно false, требуются только входные данные ipv4, в противном случае требуются как ipv6, так и ipv4. Варианты: `false` `true`
ipv6DhcpServers list / elements=string	DHCP-сервер в формате IPv6 на входе, например «2001 db8 1234».
ipv6DnsServers list / elements=string	DNS-сервер в формате IPv6 на входе, например «2001 db8 1234».
ipv6GateWay string	Подробные сведения об IP-адресе шлюза, например 2001 db8 85a3 0 100 1.
ipv6GlobalPool string	Глобальный IP-адрес пула IPv6 с CIDR, это требуется, когда значение Ipv6AddressSpace равно true, например 2001 db8 85a3 /64.
ipv6Prefix boolean	Если значение ipv6 prefix равно true, поле ввода длины префикса ip6 включено, если оно равно false, включен ввод общего количества хостов ipv6. Варианты: `false` `true`

ipv6PrefixLength integer	Длина префикса IPv6 требуется, когда значение ipv6prefix равно true.
ipv6Subnet string	Адрес подсети IPv6, например 2001 db8 85a3 0 100. Нужно указать либо ipv6Subnet, либо ipv6TotalHost, если создается подсеть IPv6.
ipv6TotalHost integer	Общее количество хостов IPv6 требуется, когда значение ipv6prefix равно false.
name string	Имя резервируемой подсети IP.
siteId string	Параметр пути siteId. Идентификатор сайта для резервирования подсети IP.
slaacSupport boolean	Поддержка SLAAC. Варианты: `false` `true`
type string	Тип резервируемой подсети IP.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK, чтобы включить проверку тел запросов по схеме JSON. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: network_settings.NetworkSettings.release_reserve_ip_subpool, network_settings.NetworkSettings.reserve_ip_subpool, network_settings.NetworkSettings.update_reserve_ip_subpool,
Используемые пути: post /dna/intent/api/v1/reserve-ip-subpool/{siteId}, delete /dna/intent/api/v1/reserve-ip-subpool/{id}, put /dna/intent/api/v1/reserve-ip-subpool/{siteId},
Не поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco DNA Center по Network Settings ReserveIPSubpool: Полное описание API ReserveIPSubpool.
Документация Cisco DNA Center по Network Settings ReleaseReserveIPSubpool: Полное описание API ReleaseReserveIPSubpool.
Документация Cisco DNA Center по Network Settings UpdateReserveIPSubpool: Полное описание API UpdateReserveIPSubpool.

Примеры

- name: Delete by id
  cisco.dnac.reserve_ip_subpool:
    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}}"
    state: absent
    id: string

- name: Create
  cisco.dnac.reserve_ip_subpool:
    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}}"
    state: present
    ipv4DhcpServers:
    - string
    ipv4DnsServers:
    - string
    ipv4GateWay: string
    ipv4GlobalPool: string
    ipv4Prefix: true
    ipv4PrefixLength: 0
    ipv4Subnet: string
    ipv4TotalHost: 0
    ipv6AddressSpace: true
    ipv6DhcpServers:
    - string
    ipv6DnsServers:
    - string
    ipv6GateWay: string
    ipv6GlobalPool: string
    ipv6Prefix: true
    ipv6PrefixLength: 0
    ipv6Subnet: string
    ipv6TotalHost: 0
    name: string
    siteId: string
    slaacSupport: true
    type: string

- name: Update by id
  cisco.dnac.reserve_ip_subpool:
    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}}"
    state: present
    id: string
    ipv4DhcpServers:
    - string
    ipv4DnsServers:
    - string
    ipv4GateWay: string
    ipv6AddressSpace: true
    ipv6DhcpServers:
    - string
    ipv6DnsServers:
    - string
    ipv6GateWay: string
    ipv6GlobalPool: string
    ipv6Prefix: true
    ipv6PrefixLength: 0
    ipv6Subnet: string
    ipv6TotalHost: 0
    name: string
    siteId: string
    slaacSupport: true

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращенным Cisco DNAC Python SDK Возвращается: всегда Пример: `{"executionId": "string", "executionStatusUrl": "string", "message": "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_module.html