cisco.aci.aci_l3out_extepg – Управление объектами профиля внешней сети экземпляра (ExtEpg) (l3extInstP:instP)

Примечание

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

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

Для использования в книге задач укажите: cisco.aci.aci_l3out_extepg.

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

Обзор

Управление объектами профиля внешней сети экземпляра (ExtEpg) (l3extInstP:instP)

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
annotation строка		Пользовательская строка для аннотации объекта. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_ANNOTATION`.
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл с именем `private_key`, это значение по умолчанию будет равно базовому имени `private_key`, без расширения. Если для `private_key` был предоставлен контент в формате PEM, это значение по умолчанию будет равно значению `username`. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`. алиасы: cert_name
description строка		Описание для ExtEpg. алиасы: descr
dscp строка	Варианты: AF11 AF12 AF13 AF21 AF22 AF23 AF31 AF32 AF33 AF41 AF42 AF43 CS0 CS1 CS2 CS3 CS4 CS5 CS6 CS7 EF VA unspecified	Целевое значение Differentiated Service (DSCP). APIC по умолчанию устанавливает `unspecified`, если значение не указано при создании. алиасы: target
extepg строка		Имя создаваемого ExtEpg. алиасы: extepg_name, name
host строка / обязательно		IP-адрес или имя хоста, разрешаемого хостом управления Ansible. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_HOST`. алиасы: hostname
l3out строка		Имя существующего L3Out. алиасы: l3out_name
name_alias строка		Псевдоним для текущего объекта. Это относится к полю nameAlias в ACI.
output_level строка	Варианты: debug info normal ←	Влияние на вывод этого модуля 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_group логическое значение	Варианты: no yes	Указывает, является ли EPG частью Предпочтительной группы и может ли она взаимодействовать без договоров. Это очень удобно для сценариев миграции или когда ACI используется для автоматизации сети, но не для политики. APIC по умолчанию устанавливает `no` при отсутствии значения при создании.
private_key строка		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемые для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимно исключающий с `password`. Если также предоставлено `password`, оно будет проигнорировано. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_PRIVATE_KEY`. алиасы: cert_key
state строка	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов.
tenant строка		Имя существующего арендатора. алиасы: tenant_name
timeout целое число	Значение по умолчанию: 30	Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_TIMEOUT`.
use_proxy логическое значение	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_USE_PROXY`.
use_ssl логическое значение	Варианты: no yes ←	Если `no`, вместо стандартного HTTPS соединения будет использоваться HTTP соединение. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_USE_SSL`.
username строка	Значение по умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не указано в задаче, будут использованы переменные среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. алиасы: user
validate_certs логическое значение	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это должно быть установлено на `no` только при работе с сайтами под собственным управлением с использованием самозаверяющих сертификатов. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_VALIDATE_CERTS`.

Примечания

Примечание

Переменные tenant, domain и vrf должны существовать, прежде чем использовать этот модуль в вашей книге задач. Для этого можно использовать модули cisco.aci.aci_tenant, cisco.aci.aci_domain и cisco.aci.aci_vrf.

См. также

cisco.aci.aci_tenant: Официальная документация по модулю cisco.aci.aci_tenant.
cisco.aci.aci_domain: Официальная документация по модулю cisco.aci.aci_domain.
cisco.aci.aci_vrf: Официальная документация по модулю cisco.aci.aci_vrf.
APIC Management Information Model reference: Дополнительная информация о внутреннем классе APIC l3ext:Out.
Руководство по Cisco ACI: Подробная информация о том, как управлять инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Add a new ExtEpg
  cisco.aci.aci_l3out_extepg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    l3out: prod_l3out
    name: prod_extepg
    description: ExtEpg for Production L3Out
    state: present
  delegate_to: localhost

- name: Delete ExtEpg
  cisco.aci.aci_extepg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    l3out: prod_l3out
    name: prod_extepg
    state: absent
  delegate_to: localhost

- name: Query ExtEpg information
  cisco.aci.aci_l3out_extepg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    l3out: prod_l3out
    name: prod_extepg
    state: query
  delegate_to: localhost
  register: query_result

Значения возврата

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

Ключ	Возвращаемое значение	Описание
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

Авторы

Ростислав Давыденко (@rost-d)

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