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

Примечание

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

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

Для использования в плейбуке укажите: 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-адрес или имя хоста, разрешаемые управляющим хостом Ansible. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_HOST`. псевдонимы: hostname
mask целое число		Маска подсети для подсети. Это число, связанное с нотацией CIDR. Для адресов IPv4 допустимые значения находятся в диапазоне от `0` до `32`. Для адресов IPv6 допустимые значения находятся в диапазоне от `0` до `128`. псевдонимы: subnet_mask
name_alias строка		Псевдоним текущего объекта. Связан с полем nameAlias в ACI.
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` информацию. Если значение не указано в задаче, будет использовано значение переменной среды `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 public shared	Определяет область подсети. Вариант `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`, вместо подключения HTTPS по умолчанию будет использоваться HTTP-соединение. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_USE_SSL`.
username строка	Значение по умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. псевдонимы: user

validate_certs

boolean

Выбооы:

no
да ←

Если 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 строка	ошибка разбора	Необработанный вывод, возвращенный 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

Авторы

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.10/collections/cisco/aci/aci_bd_subnet_module.html