aci_bd_subnet – Управление подсетями (fv:Subnet)

Новая версия с 2.4.

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
bd строка		Имя домена коммутации. псевдонимы: bd_name
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указано имя `private_key` файла, значение по умолчанию равно `private_key` имени файла без расширения. Если для `private_key` был предоставлен контент в формате PEM, значение по умолчанию равно `username` значению. псевдонимы: cert_name
description строка		Описание подсети. псевдонимы: descr
enable_vip логическое значение	Варианты: нет да	Определяет, должна ли подсеть обрабатываться как VIP; используется, когда BD расширен до нескольких сайтов. APIC по умолчанию устанавливает значение `no` при создании, если не указано другое.
gateway строка		Адрес шлюза IPv4 или IPv6 для подсети. псевдонимы: gateway_ip
host строка / обязательно		IP-адрес или имя хоста, разрешаемого управляющим хостом Ansible. псевдонимы: hostname
mask целое число		Маска подсети для подсети. Это число, связанное с CIDR-нотацией. Для адресов IPv4 допустимые значения находятся в диапазоне от `0` до `32`. Для адресов IPv6 допустимые значения находятся в диапазоне от `0` до `128`. псевдонимы: subnet_mask
nd_prefix_policy строка		Политика префикса обнаружения соседей IPv6 для ассоциации с подсетью.
output_level строка	Варианты: отладка информация обычный ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь. `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию.
password строка / обязательно		Пароль для аутентификации. Этот параметр взаимоисключает `private_key`. Если указан также `private_key`, будет использован он.
port целое число		Номер порта, используемого для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`.
preferred логическое значение	Варианты: нет да	Определяет, является ли подсеть предпочтительной по сравнению со всеми доступными подсетями. Только одна подсеть на семейство адресов (IPv4/IPv6) может быть предпочтительной в домене коммутации. APIC по умолчанию устанавливает значение `no` при создании, если не указано другое.
private_key строка / обязательно		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`. Этот параметр взаимоисключает `password`. Если указан также `password`, он будет проигнорирован. псевдонимы: cert_key
route_profile строка		Профиль маршрутизации, который нужно ассоциировать с подсетью.
route_profile_l3_out строка		L3 Out, который содержит связанный профиль маршрутизации.
scope список	Варианты: private public shared	Определяет область подсети. Опция `private` позволяет обмениваться данными только с хостами в той же VRF. Опция `public` позволяет рекламировать подсеть за пределами фэбрики ACI и обмениваться данными с хостами в других VRF. Опция shared ограничивает обмен данными хостами в той же VRF или в shared VRF. Значение является списком вариантов. `private` и `public` взаимоисключающие, но оба могут быть использованы с `shared`. APIC по умолчанию устанавливает значение `private` при создании, если не указано другое.
state строка	Варианты: отсутствует присутствует ← запрос	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов.
subnet_control строка	Варианты: nd_ra no_gw querier_ip не указано	Определяет состояние управления подсетью. Опция `querier_ip` используется для обработки gateway_ip как IP-адреса источника запросов IGMP. Опция `nd_ra` используется для обработки адреса gateway_ip как префикса объявления маршрутизатора обнаружения соседей. Опция `no_gw` используется для удаления функциональности шлюза по умолчанию из адреса шлюза. APIC по умолчанию устанавливает значение `nd_ra` при создании, если не указано другое.
subnet_name строка		Имя подсети. псевдонимы: name
tenant строка		Имя арендатора. псевдонимы: tenant_name
timeout целое число	Значение по умолчанию: 30	Таймаут уровня сокета в секундах.
use_proxy логическое значение	Варианты: нет да ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
use_ssl логическое значение	Варианты: нет да ←	Если `no`, вместо стандартного подключения HTTPS будет использоваться HTTP-подключение.
username строка	Значение по умолчанию: "admin"	Имя пользователя для аутентификации. псевдонимы: user
validate_certs логическое значение	Варианты: нет да ←	Если `no`, сертификаты SSL не будут проверяться. Это значение следует устанавливать только в `no` на сайтах, контролируемых лично, использующих самозаверяемые сертификаты.

Примечания

Примечание

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

См. также

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

Примеры

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

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

- name: Create a subnet
  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
  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
    state: present
  delegate_to: localhost

- name: Update a subnets scope to private and shared
  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
  aci_bd_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Get all subnets of specific gateway in specified tenant
  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
  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
  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 список	успех	Текущая конфигурация из APIC после завершения модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
error словарь	ошибка	Информация об ошибке, возвращённая из APIC Пример: {'code': '122', 'text': 'неизвестный класс управляемого объекта foo'}
filter_string строка	ошибка или отладка	Строка фильтра, используемая для запроса Пример: ?rsp-prop-include=config-only
method строка	ошибка или отладка	HTTP-метод, используемый для запроса к APIC Пример: POST
previous список	информация	Исходная конфигурация из APIC до начала работы модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производство', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed словарь	информация	Собраная конфигурация из параметров, предоставленных пользователем Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда', 'name': 'production'}}}
raw строка	ошибка разбора	Необработанный вывод, возвращённый API REST APIC (xml или json) Пример: <?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="неизвестный класс управляемого объекта foo"/></imdata>
response строка	ошибка или отладка	HTTP-ответ от APIC Пример: OK (30 байт)
sent список	информация	Фактическая/минимальная конфигурация, отправленная в APIC Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда'}}}
status целое число	ошибка или отладка	HTTP-статус от APIC Пример: 200
url строка	ошибка или отладка	HTTP-URL, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается партнёром Ansible. [сертифицировано]

Авторы

Jacob McGill (@jmcgill298)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/aci_bd_subnet_module.html