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

Примечание

Этот плагин входит в коллекцию cisco.aci (версия 2.0.0).

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

Для использования в playbook укажите: cisco.aci.aci_bd_subnet.

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
annotation строка		Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_ANNOTATION`.
bd строка		Имя Домена моста. псевдонимы: bd_name
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл с именем `private_key`, по умолчанию используется имя файла `private_key` без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_CERTIFICATE_NAME`. псевдонимы: cert_name
description строка		Описание подсети. псевдонимы: descr
enable_vip логическое	Варианты: нет да	Определяет, следует ли обрабатывать подсеть как VIP; используется, когда BD расширен на несколько сайтов. APIC по умолчанию устанавливает `no`, если значение не задано при создании.
gateway строка		Адрес шлюза IPv4 или IPv6 для подсети. псевдонимы: gateway_ip
host строка / обязательно		IP-адрес или имя хоста APIC, разрешимые хостом управления Ansible. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_HOST`. псевдонимы: hostname
mask целое число		Маска подсети для подсети. Это число, связанное с нотацией CIDR. Для адресов IPv4 допустимые значения находятся в диапазоне от `0` до `32`. Для адресов IPv6 допустимые значения находятся в диапазоне от `0` до `128`. псевдонимы: subnet_mask
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`.
output_path строка		Путь к файлу, который будет использоваться для вывода объектов конфигурации ACI JSON, сгенерированных модулем. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_OUTPUT_PATH`.
owner_key строка		Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет ключ для предоставления клиентам права владения своими данными для корреляции сущностей. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_OWNER_KEY`.
owner_tag строка		Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет тег для предоставления клиентам возможности добавлять свои собственные данные. Например, для указания того, кто создал этот объект. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_OWNER_TAG`.
password строка		Пароль для аутентификации. Этот параметр взаимоисключает `private_key`. Если предоставлен и `private_key`, он будет использован вместо него. Если значение не указано в задаче, будет использовано значение переменных окружения `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число		Номер порта, используемый для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_PORT`.
preferred логическое	Варианты: нет да	Определяет, является ли подсеть предпочтительной по отношению ко всем доступным подсетям. Только одна подсеть на семейство адресов (IPv4/IPv6) может быть предпочтительной в домене моста. APIC по умолчанию устанавливает `no`, если значение не задано при создании.
private_key строка		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемый для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимоисключает `password`. Если указан и `password`, он будет проигнорирован. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_PRIVATE_KEY`. псевдонимы: cert_key
route_profile строка		Профиль маршрута для ассоциации с подсетью.
route_profile_l3_out строка		L3 Out, который содержит связанный профиль маршрута.
scope список / элементы=строка	Варианты: частная общественная совместная	Определяет область применения подсети. Вариант `private` позволяет обмениваться данными только с хостами в той же VRF. Вариант `public` позволяет рекламировать подсеть за пределами ткани ACI и обмениваться данными с хостами в других VRF. Вариант shared ограничивает обмен данными хостами в той же VRF или в общей 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	Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_TIMEOUT`.
use_proxy логическое	Варианты: нет да ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_PROXY`.
use_ssl логическое	Варианты: нет да ←	Если `no`, будет использоваться HTTP-соединение вместо стандартного HTTPS-соединения. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_SSL`.
username строка	По умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не указано в задаче, будут использованы значения переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. псевдонимы: user

validate_certs

boolean

Выбоpы:

нет
да ←

Если no, сертификаты SSL не будут проверены.

Это следует устанавливать как no только при работе с сайтами, контролируемыми лично, использующими самозаверяющие сертификаты.

Если значение не указано в задаче, будет использоваться значение переменной среды ACI_VALIDATE_CERTS.

Примечания

Примечание

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

См. также

cisco.aci.aci_bd: Официальная документация по модулю cisco.aci.aci_bd.
cisco.aci.aci_tenant: Официальная документация по модулю cisco.aci.aci_tenant.
APIC Management Information Model reference: Дополнительная информация об внутренней модели класса 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
    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 список / элементы=строка	успех	Текущая конфигурация с 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 строка	ошибка разбора	Необработанный результат, возвращенный APIC REST API (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

Авторы

Jacob McGill (@jmcgill298)

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