Модуль cisco.aci.aci_epg_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.

Чтобы использовать его в playbook, укажите: cisco.aci.aci_epg_to_contract.

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

Краткое описание

Привязывает EPG к контрактам на Cisco ACI тканях.

Параметры

Параметр	Комментарии
annotation string	Пользовательская строка для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменной среды `ACI_ANNOTATION`, будет использовано значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
ap aliases: app_profile, app_profile_name string	Имя существующего профиля сети приложений, который будет содержать EPG.
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	Определяет тип контракта. Варианты: `"consumer"` `"provider"` `"taboo"` `"interface"` `"intra_epg"`
epg aliases: epg_name string	Имя группы конечных точек.
host aliases: hostname string	IP-адрес или имя хоста APIC, разрешаемые узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_HOST`.
output_level string	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая словари `previous`, `proposed` и `sent` `debug` добавляет отладочный вывод, включая информацию `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
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` при создании, если значение не задано. Варианты: `"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` при создании, если значение не задано. Варианты: `"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 псевдонимы: tenant_name 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, app_profile, EPG, и Contract должны существовать перед использованием данного модуля в вашем плейбуке. Для этого можно использовать модули cisco.aci.aci_tenant, cisco.aci.aci_ap, cisco.aci.aci_epg и cisco.aci.aci_contract.

См. также

cisco.aci.aci_ap: Управление объектами профиля приложения верхнего уровня (AP) (fv:Ap).
cisco.aci.aci_epg: Управление объектами групп конечных точек (EPG) (fv:AEPg).
cisco.aci.aci_contract: Управление ресурсами контрактов (vz:BrCP).
APIC Management Information Model reference: Дополнительная информация о внутренних классах APIC fv:RsCons, fv:RsProv, fv:RsProtBy, fv:RsConsIf и fv:RsIntraEpg.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Add a new contract to EPG binding
  cisco.aci.aci_epg_to_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    ap: anstest
    epg: anstest
    contract: anstest_http
    contract_type: provider
    contract_label: contractlabel
    subject_label: subjlabel
    state: present
  delegate_to: localhost

- name: Remove an existing contract to EPG binding
  cisco.aci.aci_epg_to_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    ap: anstest
    epg: anstest
    contract: anstest_http
    contract_type: provider
    state: absent
  delegate_to: localhost

- name: Query a specific contract to EPG binding
  cisco.aci.aci_epg_to_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    ap: anstest
    epg: anstest
    contract: anstest_http
    contract_type: provider
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all provider contract to EPG bindings
  cisco.aci.aci_epg_to_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    contract_type: provider
    state: query
  delegate_to: localhost
  register: query_result

Возвращаемые значения

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

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

Авторы

Jacob McGill (@jmcgill298)
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_epg_to_contract_module.html