Модуль cisco.aci.aci_l3out_extepg_to_contract – Привязка контрактов к внешним группам конечных точек (EPG) (fv:RsCons, fv:RsProv, fv:RsProtBy, fv:RsConsIf и fv:RsIntraEpg)

Примечание

Этот модуль входит в коллекцию cisco.aci (версия 2.10.1).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

Чтобы использовать его в книге задач, укажите: cisco.aci.aci_l3out_extepg_to_contract.

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

Обзор

Привязка контрактов к внешним группам конечных точек (EPG) на тканях ACI.

Параметры

Параметр	Комментарии
annotation string	Пользовательская строка для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_ANNOTATION`. Если значение не указано в задаче и переменной окружения `ACI_ANNOTATION`, то будет использовано значение по умолчанию. Default: `"orchestrator:ansible"`
certificate_name aliases: cert_name string	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указано имя файла `private_key`, это значение по умолчанию будет базовым именем `private_key`, без расширения. Если для `private_key` было предоставлено содержимое в формате PEM, это значение по умолчанию будет `username`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_CERTIFICATE_NAME`.
contract aliases: contract_name, contract_interface string	Имя контракта или интерфейса контракта.
contract_label string	Метка контракта для сопоставления.
contract_type string / required	Определяет тип контракта. Choices: `"consumer"` `"provider"` `"taboo"` `"interface"` `"intra_epg"`
extepg aliases: extepg_name, external_epg string	Имя внешней группы конечных точек.
host aliases: hostname string	IP-адрес или имя хоста APIC, распознаваемое узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_HOST`.
l3out aliases: l3out_name string	Имя l3out.
output_level string	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая словари `previous`, `proposed` и `sent` `debug` добавляет отладочный вывод, включая информацию `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_OUTPUT_LEVEL`. Choices: `"debug"` `"info"` `"normal"` ← (default)
output_path string	Путь к файлу, который будет использоваться для выгрузки объектов конфигурации ACI JSON, сгенерированных модулем. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_OUTPUT_PATH`.
password string	Пароль, используемый для аутентификации. Этот параметр является взаимоисключающим с `private_key`. Если также предоставлен `private_key`, он будет использован вместо него. Если значение не указано в задаче, вместо него будут использованы значения переменных окружения `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port integer	Номер порта, который будет использоваться для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_PORT`.
priority string	Класс QoS. APIC использует значение по умолчанию `unspecified` при отсутствии значения во время создания. Choices: `"level1"` `"level2"` `"level3"` `"level4"` `"level5"` `"level6"` `"unspecified"`
private_key aliases: cert_key string	Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на используемое значение `certificate_name` по умолчанию. Этот параметр является взаимоисключающим с `password`. Если также предоставлен `password`, он будет игнорироваться. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
provider_match string	Алгоритм сопоставления для предоставленных контрактов. APIC использует значение по умолчанию `at_least_one` при отсутствии значения во время создания. Choices: `"all"` `"at_least_one"` `"at_most_one"` `"none"`

state string	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для отображения объекта или нескольких объектов. Выбираемые значения: `"absent"` `"present"` ← (по умолчанию) `"query"`
subject_label string	Метка объекта для сопоставления.
suppress_previous псевдонимы: no_previous, ignore_previous boolean	Если `true`, GET-запрос для проверки предыдущего состояния не будет отправлен перед обновлением POST в APIC. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение становится пустым. Предыдущее состояние объекта не будет проверяться, и обновление POST будет содержать все свойства. Выбираемые значения: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, проверка GET не будет отправлена после обновления POST в APIC. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к установке текущего возвращаемого значения в предложенное значение. Текущий объект, включая значения по умолчанию, не будет проверяться в одной задаче. Выбираемые значения: `false` `true`
tenant string	Имя существующего тенанта.
timeout integer	Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию 30.
use_proxy boolean	Если `false`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_USE_PROXY`. Значение по умолчанию true. Выбираемые значения: `false` `true`
use_ssl boolean	Если `false`, вместо стандартного HTTPS соединения будет использоваться HTTP-соединение. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_USE_SSL`. Значение по умолчанию true для локального соединения. Выбираемые значения: `false` `true`
username псевдонимы: user string	Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию admin.
validate_certs boolean	Если `false`, сертификаты SSL не будут проверены. Это следует устанавливать в `false` только при работе с сайтами, которыми вы управляете лично, и используете самозаверяющие сертификаты. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию true. Выбираемые значения: `false` `true`

Примечания

Примечание

tenant, l3out, extepg, и Contract должны существовать перед использованием данного модуля в вашем плейбуке. Модули cisco.aci.aci_tenant, cisco.aci.aci_l3out, cisco.aci.aci_l3out_extepg, и cisco.aci.aci_contract могут быть использованы для этого.

См. также

APIC Management Information Model reference: Дополнительная информация об внутренних классах APIC fv:RsCons, fv:RsProv, fv:RsProtBy, B(fv:RsConsIf, и B(fv:RsIntraEpg.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство о том, как написать собственные модули Cisco ACI для внесения вклада.

Примеры

- name: Bind a contract to an external EPG
  cisco.aci.aci_l3out_extepg_to_contract:
    host: apic
    username: admin
    password: SomeSecretePassword
    tenant: Auto-Demo
    l3out: l3out
    extepg: testEpg
    contract: contract1
    contract_type: provider
    state: present
  delegate_to: localhost

- name: Remove existing contract from an external EPG
  cisco.aci.aci_l3out_extepg_to_contract:
    host: apic
    username: admin
    password: SomeSecretePassword
    tenant: Auto-Demo
    l3out: l3out
    extepg: testEpg
    contract: contract1
    contract_type: provider
    state: absent
  delegate_to: localhost

- name: Query a contract bound to an external EPG
  cisco.aci.aci_l3out_extepg_to_contract:
    host: apic
    username: admin
    password: SomeSecretePassword
    tenant: ansible_tenant
    l3out: ansible_l3out
    extepg: ansible_extEpg
    contract: ansible_contract
    contract_type: provider
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all contracts relationships
  cisco.aci.aci_l3out_extepg_to_contract:
    host: apic
    username: admin
    password: SomeSecretePassword
    contract_type: provider
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ	Описание
current список / элементы=строка	Существующая конфигурация с APIC после завершения работы модуля Возвращено: успех Пример: `[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
error словарь	Информация об ошибке, возвращённая APIC Возвращено: неудача Пример: `{"code": "122", "text": "unknown managed object class foo"}`
filter_string строка	Используемая строка фильтра для запроса Возвращено: неудача или отладка Пример: `"?rsp-prop-include=config-only"`
method строка	HTTP-метод, использованный для запроса к APIC Возвращено: неудача или отладка Пример: `"POST"`
previous список / элементы=строка	Исходная конфигурация с APIC до начала работы модуля Возвращено: информация Пример: `[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
proposed словарь	Собранная конфигурация из параметров, предоставленных пользователем Возвращено: информация Пример: `{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}`
raw строка	Необработанный результат, возвращённый APIC REST API (xml или json) Возвращено: ошибка парсинга Пример: `"<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class \"/></imdata>"`
response строка	HTTP-ответ от APIC Возвращено: неудача или отладка Пример: `"OK (30 bytes)"`
sent список / элементы=строка	Фактическая/минимальная конфигурация, отправленная в APIC Возвращено: информация Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status целое число	HTTP-статус от APIC Возвращено: неудача или отладка Пример: `200`
url строка	HTTP-URL, используемый для запроса к APIC Возвращено: неудача или отладка Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Sudhakar Shet Kudtarkar (@kudtarkar1)
Shreyas Srish (@shrsr)
Akini Ross (@akinross)

Ссылки на сборку

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