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

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

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

Обзор

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

Параметры

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