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

Примечание

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
annotation строка	Определяемая пользователем строка для добавления аннотации к объекту. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменная среды `ACI_ANNOTATION`, будет использоваться значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
ap псевдонимы: app_profile, app_profile_name строка	Имя существующего профиля сети приложений, который будет содержать EPG.
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, привязанного к пользователю APIC AAA, который используется для аутентификации на основе подписи. Если указано имя файла `private_key`, по умолчанию используется имя файла `private_key` без расширения. Если для `private_key` указано содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_CERTIFICATE_NAME`.
description псевдоним: descr строка	Описание подсети.
enable_vip логическое значение	Определяет, следует ли рассматривать подсеть как VIP (виртуальный IP-адрес). Если параметр не задан при создании, APIC использует значение `false` по умолчанию. Допустимые значения: `false` `true`
epg псевдоним: epg_name строка	Имя группы конечных точек.
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 строка	Политика префиксов обнаружения соседей 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 строка	Путь к файлу, в который будут записываться JSON-объекты конфигурации ACI, созданные модулем. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_OUTPUT_PATH`.
password строка	Пароль для аутентификации. Этот параметр несовместим с `private_key`. Если также задан `private_key`, будет использоваться он. Если значение не указано в задаче, вместо него будут использоваться переменные среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_PORT`.
preferred логическое значение	Определяет, является ли подсеть предпочтительной среди всех доступных подсетей. В домене Bridge предпочтительной может быть только одна подсеть для каждого семейства адресов (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_l3out строка	L3Out, содержащий связанный профиль маршрутизации.
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-адрес отправителя IGMP-запросов. Параметр `nd_ra` используется, чтобы рассматривать адрес gateway_ip как префикс объявления маршрутизатора для обнаружения соседей. Параметр `no_gw` используется для отключения функции шлюза по умолчанию для адреса шлюза. Если параметр не задан при создании, APIC использует значение `nd_ra` по умолчанию. Допустимые значения: `"nd_ra_prefix"` `"no_default_gateway"` `"querier_ip"` `"unspecified"`
subnet_name псевдоним: name строка	Имя подсети.
suppress_previous псевдонимы: no_previous, ignore_previous логическое значение	Если `true`, перед отправкой POST-запроса на обновление в APIC не будет отправлен GET-запрос для проверки предыдущего состояния. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — при этом предыдущее возвращаемое значение будет пустым. Предыдущее состояние объекта не будет проверяться, а POST-запрос на обновление будет содержать все свойства. Допустимые значения: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification логическое значение	Если `true`, после отправки POST-запроса на обновление в APIC не будет отправлен проверочный GET-запрос. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — при этом текущее возвращаемое значение будет установлено равным предлагаемому значению. Текущее состояние объекта, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи. Допустимые значения: `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 — это корневой ключ, используемый для доступа к подсети (а не к имени), поэтому при состоянии absent или present необходимо указать gateway.
Объекты tenant, ap и epg должны существовать до использования этого модуля в плейбуке. Для этого можно использовать модуль cisco.aci.aci_tenant, cisco.aci.aci_ap и cisco.aci.aci_epg.

См. также

cisco.aci.aci_epg: Управление объектами групп конечных точек (EPG) (fv:AEPg).
cisco.aci.aci_ap: Управление объектами верхнего уровня «Профиль приложения» (AP) (fv:Ap).
cisco.aci.aci_tenant: Управление арендаторами (fv:Tenant).
Справочник модели управления информацией APIC: Дополнительные сведения о внутреннем классе APIC fv:Subnet.
Руководство по Cisco ACI: Подробные сведения об управлении инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по созданию собственных модулей Cisco ACI для участия в разработке.

Примеры

- name: Create a subnet
  cisco.aci.aci_epg_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: intranet
    epg: web_epg
    gateway: 10.1.1.1
    mask: 24
    state: present
  delegate_to: localhost

- name: Create a subnet with options
  cisco.aci.aci_epg_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: intranet
    epg: web_epg
    subnet_name: sql
    gateway: 10.1.2.1
    mask: 23
    description: SQL Servers
    scope: public
    route_profile_l3out: corp
    route_profile: corp_route_profile
    state: present
  delegate_to: localhost

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

- name: Get all subnets
  cisco.aci.aci_epg_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_epg_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_epg_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: intranet
    epg: web_epg
    gateway: 10.1.1.1
    mask: 24
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete a subnet
  cisco.aci.aci_epg_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: intranet
    epg: web_epg
    gateway: 10.1.1.1
    mask: 24
    state: absent
  delegate_to: localhost

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

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

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

Авторы

Gaspard MICOL (@gmicol)

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

© 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_epg_subnet_module.html