cisco.aci.aci_epg – Управление объектами групп конечных точек (EPG) (fv:AEPg)

Примечание

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

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

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

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
annotation строка		Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_ANNOTATION`.
ap строка		Имя существующего профиля сетевого приложения, который будет содержать EPG. псевдонимы: app_profile, app_profile_name
bd строка		Имя домена моста, связанного с EPG. псевдонимы: bd_name, bridge_domain
certificate_name строка		Имя X.509 сертификата, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был указан файл `private_key`, по умолчанию используется имя файла `private_key`, без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`. псевдонимы: cert_name
description строка		Описание EPG. псевдонимы: descr
epg строка		Имя группы конечных точек. псевдонимы: epg_name, name
fwd_control строка	Варианты: none proxy-arp	Управление пересылкой, используемое EPG. APIC по умолчанию использует `none`, если не задано при создании.
host строка / обязательно		IP-адрес или имя хоста APIC, разрешаемое управляющим хостом Ansible. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_HOST`. псевдонимы: hostname
intra_epg_isolation строка	Варианты: enforced unenforced	Изоляция внутри EPG. APIC по умолчанию использует `unenforced`, если не задано при создании.
monitoring_policy строка		Имя политики мониторинга.
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`, если не задано при создании.
priority строка	Варианты: level1 level2 level3 unspecified	Класс QoS. APIC по умолчанию использует `unspecified`, если не задано при создании.
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`, будет использоваться соединение HTTP вместо соединения HTTPS по умолчанию. Если значение не указано в задаче, будет использовано значение переменной среды `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_tenant: Официальная документация по модулю cisco.aci.aci_tenant.
cisco.aci.aci_ap: Официальная документация по модулю cisco.aci.aci_ap.
APIC Management Information Model reference: Дополнительная информация об внутреннем классе APIC fv:AEPg.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Add a new EPG
  cisco.aci.aci_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: intranet
    epg: web_epg
    description: Web Intranet EPG
    bd: prod_bd
    monitoring_policy: default
    preferred_group: yes
    state: present
  delegate_to: localhost

- aci_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: ticketing
    epg: "{{ item.epg }}"
    description: Ticketing EPG
    bd: "{{ item.bd }}"
    priority: unspecified
    intra_epg_isolation: unenforced
    state: present
  delegate_to: localhost
  with_items:
    - epg: web
      bd: web_bd
    - epg: database
      bd: database_bd

- name: Remove an EPG
  cisco.aci.aci_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    validate_certs: no
    tenant: production
    app_profile: intranet
    epg: web_epg
    monitoring_policy: default
    state: absent
  delegate_to: localhost

- name: Query an EPG
  cisco.aci.aci_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: ticketing
    epg: web_epg
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all EPGs
  cisco.aci.aci_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all EPGs with a Specific Name
  cisco.aci.aci_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    validate_certs: no
    epg: web_epg
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all EPGs of an App Profile
  cisco.aci.aci_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    validate_certs: no
    ap: ticketing
    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 строка	ошибка разбора	Необработанный вывод, возвращённый REST API 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

Авторы

Swetha Chunduri (@schunduri)
Shreyas Srish (@shrsr)

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