cisco.aci.aci_epg_to_contract_master – Управление взаимосвязями группы конечных точек (EPG) с мастером контрактов (fv:RsSecInherited)

Примечание

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

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

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

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

Обзор

Управление взаимосвязями групп конечных точек (EPG) с мастером контрактов на Cisco ACI фабриках.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
annotation строка		Пользовательская строка для аннотации объекта. Если значение не указано в задаче, используется значение переменной среды `ACI_ANNOTATION`
ap строка / обязательно		Имя существующего профиля сетевого приложения, содержащего EPG. псевдонимы: app_profile, app_profile_name
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был указан файл с именем `private_key`, по умолчанию используется имя файла `private_key`, без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username` Если значение не указано в задаче, используется значение переменной среды `ACI_CERTIFICATE_NAME` псевдонимы: cert_name
contract_master_ap строка		Имя профиля приложения, в котором находится EPG мастера контракта.
contract_master_epg строка		Имя группы конечных точек, являющейся мастером контракта.
epg строка / обязательно		Имя группы конечных точек. псевдонимы: epg_name, name
host строка / обязательно		IP-адрес или имя хоста APIC, разрешимые хостом управления Ansible. Если значение не указано в задаче, используется значение переменной среды `ACI_HOST` псевдонимы: hostname
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 строка		Путь к файлу, который будет использоваться для вывода JSON-конфигураций объектов ACI, сгенерированных модулем. Если значение не указано в задаче, используется значение переменной среды `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`
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 и app_profile должны существовать до использования этого модуля в вашем плейбуке. Для этого можно использовать модули cisco.aci.aci_tenant и cisco.aci.aci_ap.

См. также

cisco.aci.aci_epg: Официальная документация по модулю cisco.aci.aci_epg.
Справочник по модели информации управления APIC: Дополнительная информация о внутреннем классе APIC fv:AEPg.
Руководство Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Add contract master
  cisco.aci.aci_epg_to_contract_master:
    host: apic_host
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    ap: apName
    epg: epgName
    contract_master_ap: ap
    contract_master_epg: epg
    state: present
  delegate_to: localhost

- name: Remove contract master
  cisco.aci.aci_epg_to_contract_master:
    host: apic_host
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    ap: apName
    epg: epgName
    contract_master_ap: ap
    contract_master_epg: epg
    state: absent
  delegate_to: localhost

- name: Query contract master
  cisco.aci.aci_epg_to_contract_master:
    host: apic_host
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    ap: apName
    epg: epgName
    contract_master_ap: ap
    contract_master_epg: epg
    state: query
  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-адрес, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Авторы

Cindy Zhao (@cizhao)

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