Модуль cisco.aci.aci_bd_subnet — управление подсетями (fv:Subnet)

Примечание

Этот модуль входит в коллекцию cisco.aci (версия 2.13.0).

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

Для установки используйте: ansible-galaxy collection install cisco.aci.

Чтобы использовать коллекцию в плейбуке, укажите: cisco.aci.aci_bd_subnet.

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

Краткое описание

Управление подсетями в фабриках Cisco ACI.

Параметры

Параметр	Комментарии
annotation строка	Определяемая пользователем строка для добавления аннотации к объекту. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменная среды `ACI_ANNOTATION`, будет использовано значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
bd псевдонимы: bd_name строка	Имя домена широковещания.
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, который используется для аутентификации на основе подписи. Если указано имя файла `private_key`, по умолчанию используется имя файла `private_key` без расширения. Если для `private_key` указано содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`.
description псевдонимы: descr строка	Описание подсети.
enable_vip логическое значение	Определяет, должна ли подсеть рассматриваться как VIP; используется, когда BD расширен на несколько сайтов. Если при создании параметр не задан, APIC устанавливает значение `false` по умолчанию. Возможные значения: `false` `true`
gateway псевдонимы: gateway_ip строка	Адрес шлюза IPv4 или IPv6 для подсети.
host псевдонимы: hostname строка	IP-адрес или имя хоста APIC, доступное для разрешения с управляющего узла Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_HOST`.
ip_data_plane_learning псевдонимы: ip_dataplane_learning строка	Определяет, включено или отключено обучение на плоскости передачи данных IP. Если при создании параметр не задан, APIC устанавливает значение `enabled` по умолчанию. Возможные значения: `"enabled"` `"disabled"`
mask псевдонимы: subnet_mask целое число	Маска подсети. Это число, используемое в нотации CIDR. Для адресов IPv4 допустимы значения от `0` до `32`. Для адресов IPv6 допустимы значения от `0` до `128`.
name_alias строка	Псевдоним текущего объекта. Соответствует полю nameAlias в ACI.
nd_prefix_policy строка	Политика префиксов Neighbor Discovery IPv6, связываемая с подсетью.
output_level строка	Настройка вывода этого модуля ACI. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая `previous`, `proposed` и словари `sent` `debug` добавляет отладочный вывод, включая информацию `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OUTPUT_LEVEL`. Возможные значения: `"debug"` `"info"` `"normal"` ← (по умолчанию)
output_path строка	Путь к файлу, в который будут записаны созданные модулем объекты конфигурации ACI в формате JSON. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OUTPUT_PATH`.
password строка	Пароль для аутентификации. Этот параметр несовместим с `private_key`. Если также указано `private_key`, будет использоваться оно. Если значение не указано в задаче, вместо него будут использованы значения переменных среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PORT`.
preferred логическое значение	Определяет, является ли подсеть предпочтительной по отношению ко всем доступным подсетям. В домене широковещания предпочтительной может быть только одна подсеть для каждого семейства адресов (IPv4/IPv6). Если при создании параметр не задан, APIC устанавливает значение `false` по умолчанию. Возможные значения: `false` `true`
private_key псевдонимы: cert_key строка	Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на используемое значение `certificate_name` по умолчанию. Этот параметр несовместим с `password`. Если также указано `password`, оно будет проигнорировано. Если значение не указано в задаче, вместо него будут использованы значения переменных среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
route_profile строка	Профиль маршрутизации, связываемый с подсетью.
route_profile_l3_out строка	L3 Out, содержащий связанный профиль маршрутизации.
scope список / элементы=строка	Определяет область действия подсети. Параметр `private` разрешает обмен данными только с хостами в той же VRF. Параметр `public` разрешает объявлять подсеть за пределами фабрики ACI и обмениваться данными с хостами в других VRF. Параметр shared ограничивает обмен данными хостами в той же VRF или в общей VRF. Значение представляет собой список параметров: `private` и `public` взаимоисключающие, но оба могут использоваться вместе с `shared`. Если при создании параметр не задан, APIC устанавливает значение `private` по умолчанию. Возможные значения: `"private"` `"public"` `"shared"`
state строка	Для добавления или удаления используйте `present` или `absent`. Для перечисления одного или нескольких объектов используйте `query`. Возможные значения: `"absent"` `"present"` ← (по умолчанию) `"query"`
subnet_control список / элементы=строка	Определяет состояние управления подсетью. Параметр `querier_ip` используется для обработки gateway_ip как исходного IP-адреса querier IGMP. Параметр `nd_ra` используется для обработки адреса gateway_ip как префикса Router Advertisement протокола Neighbor Discovery. Параметр `no_gw` используется для отключения функции шлюза по умолчанию для адреса шлюза. Если при создании параметр не задан, APIC устанавливает значение `nd_ra` по умолчанию. Возможные значения: `"nd_ra"` `"no_gw"` `"querier_ip"` `"unspecified"`
subnet_name псевдонимы: name строка	Имя подсети.
suppress_previous псевдонимы: no_previous, ignore_previous логическое значение	Если `true`, перед POST-обновлением APIC не будет отправлен GET-запрос для проверки предыдущего состояния. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию: `false`. ВНИМАНИЕ — в результате возвращаемое значение previous будет пустым. Предыдущее состояние объекта не будет проверено, а POST-обновление будет содержать все свойства. Возможные значения: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification логическое значение	Если `true`, после POST-обновления APIC не будет отправлен GET-запрос для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию: `false`. ВНИМАНИЕ — в результате возвращаемому значению current будет присвоено предложенное значение. Текущее состояние объекта, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи. Возможные значения: `false` `true`
tenant псевдонимы: tenant_name строка	Имя арендатора.
timeout целое число	Тайм-аут на уровне сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию: 30.
use_proxy логическое значение	Если `false`, прокси использоваться не будет, даже если он задан в переменной среды на целевых узлах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_PROXY`. Значение по умолчанию: true. Возможные значения: `false` `true`
use_ssl логическое значение	Если `false`, вместо HTTPS-подключения, используемого по умолчанию, будет использоваться HTTP-подключение. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_SSL`. При локальном подключении значение по умолчанию — true. Возможные значения: `false` `true`
username псевдонимы: user строка	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будут использованы значения переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию: admin.
validate_certs логическое значение	Если `false`, SSL-сертификаты не будут проверяться. Устанавливайте значение `false` только при использовании на сайтах под вашим личным контролем с самоподписанными сертификатами. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию: true. Возможные значения: `false` `true`

Примечания

Примечание

Параметр gateway — это корневой ключ для доступа к подсети (а не name), поэтому требуется gateway, если состояние равно absent или present.
Параметры tenant и bd должны существовать до использования этого модуля в плейбуке. Для этого можно использовать модуль cisco.aci.aci_tenant и модуль cisco.aci.aci_bd.

См. также

cisco.aci.aci_bd: Управление объектами доменов широковещания (BD) (fv:BD).
cisco.aci.aci_tenant: Управление арендаторами (fv:Tenant).
Справочник модели управления информацией APIC: Дополнительные сведения о внутреннем классе APIC fv:Subnet.
Руководство по Cisco ACI: Подробные сведения об управлении инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по созданию собственных модулей Cisco ACI для внесения вклада в проект.

Примеры

- name: Create a tenant
  cisco.aci.aci_tenant:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    state: present
  delegate_to: localhost

- name: Create a bridge domain
  cisco.aci.aci_bd:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    bd: database
    state: present
  delegate_to: localhost

- name: Create a subnet
  cisco.aci.aci_bd_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    bd: database
    gateway: 10.1.1.1
    mask: 24
    state: present
  delegate_to: localhost

- name: Create a subnet with options
  cisco.aci.aci_bd_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    bd: database
    subnet_name: sql
    gateway: 10.1.2.1
    mask: 23
    description: SQL Servers
    scope: public
    route_profile_l3_out: corp
    route_profile: corp_route_profile
    subnet_control:
      - no_gw
      - querier_ip
    state: present
  delegate_to: localhost

- name: Update a subnets scope to private and shared
  cisco.aci.aci_bd_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    bd: database
    gateway: 10.1.1.1
    mask: 24
    scope: [private, shared]
    state: present
  delegate_to: localhost

- name: Get all subnets
  cisco.aci.aci_bd_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Get all subnets of specific gateway in specified tenant
  cisco.aci.aci_bd_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    gateway: 10.1.1.1
    mask: 24
    state: query
  delegate_to: localhost
  register: query_result

- name: Get specific subnet
  cisco.aci.aci_bd_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    bd: database
    gateway: 10.1.1.1
    mask: 24
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete a subnet
  cisco.aci.aci_bd_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    bd: database
    gateway: 10.1.1.1
    mask: 24
    state: absent
  delegate_to: localhost

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

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

Ключ	Описание
current list / elements=string	Существующая конфигурация из APIC после завершения работы модуля Возвращается: success Пример: `[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
error dictionary	Информация об ошибке, возвращённая APIC Возвращается: failure Пример: `{"code": "122", "text": "unknown managed object class foo"}`
filter_string string	Строка фильтра, использованная в запросе Возвращается: failure or debug Пример: `"?rsp-prop-include=config-only"`
method string	Метод HTTP, использованный для запроса к APIC Возвращается: failure or debug Пример: `"POST"`
previous list / elements=string	Исходная конфигурация из APIC до начала работы модуля Возвращается: info Пример: `[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
proposed dictionary	Собранная конфигурация на основе параметров, заданных пользователем Возвращается: info Пример: `{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}`
raw string	Необработанные данные, возвращённые REST API APIC (xml или json) Возвращается: parse error Пример: `"<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"`
response string	Ответ HTTP от APIC Возвращается: failure or debug Пример: `"OK (30 bytes)"`
sent list / elements=string	Фактическая/минимальная конфигурация, отправленная в APIC Возвращается: info Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status integer	Статус HTTP от APIC Возвращается: failure or debug Пример: `200`
url string	URL HTTP, использованный для запроса к APIC Возвращается: failure or debug Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Jacob McGill (@jmcgill298)
Akini Ross (@akinross)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/aci/aci_bd_subnet_module.html