Модуль cisco.aci.aci_node_mgmt_epg – Управление EPG по In-band или Out-of-band каналам (mgmt:OoB и mgmt:InB)

Примечание

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

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

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

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

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

Обзор

EPG узла Cisco ACI Fabric

Параметры

Параметр	Комментарии
annotation строка	Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменная среды `ACI_ANNOTATION` не определена, будет использовано значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
bd строка	Домен моста в режиме инбанд, используемый, когда тип — in_band
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл с именем `private_key`, по умолчанию используется имя файла `private_key`, без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`.
encap строка	Инкапсуляция доступа в режиме инбанд, используемая, когда тип — in_band
epg псевдонимы: name строка	Имя группы конечных точек
host псевдонимы: hostname строка	IP-адрес или имя хоста APIC, разрешаемый хостом управления Ansible. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_HOST`.
output_level строка	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь. `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_OUTPUT_LEVEL`. Доступные значения: `"debug"` `"info"` `"normal"` ← (по умолчанию)

END_OF_DOCUMENT_MARKER

type string / обязательно	тип интерфейса управления Выберите: `"in_band"` `"out_of_band"`
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`

См. также

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

Примеры

- name: Add in band mgmt epg
  cisco.aci.aci_node_mgmt_epg:
    host: "Host IP"
    username: admin
    password: SomeSecretePassword
    epg: default
    type: in_band
    encap: vlan-1
    bd: bd1
    state: present
  delegate_to: localhost

- name: Add out of band mgmt epg
  cisco.aci.aci_node_mgmt_epg:
    host: "Host IP"
    username: admin
    password: SomeSecretePassword
    epg: default
    type: out_of_band
    state: present
  delegate_to: localhost

- name: Query in band mgmt epg
  cisco.aci.aci_node_mgmt_epg:
    host: "Host IP"
    username: admin
    password: SomeSecretePassword
    epg: default
    type: in_band
    encap: vlan-1
    bd: bd1
    state: query
  delegate_to: localhost

- name: Query all in band mgmt epg
  cisco.aci.aci_node_mgmt_epg:
    host: "Host IP"
    username: admin
    password: SomeSecretePassword
    type: in_band
    state: query
  delegate_to: localhost

- name: Query all out of band mgmt epg
  cisco.aci.aci_node_mgmt_epg:
    host: "Host IP"
    username: admin
    password: SomeSecretePassword
    type: out_of_band
    state: query
  delegate_to: localhost

- name: Remove in band mgmt epg
  cisco.aci.aci_node_mgmt_epg:
    host: "Host IP"
    username: admin
    password: SomeSecretePassword
    epg: default
    type: in_band
    state: absent
  delegate_to: localhost

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

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

Ключ	Описание
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 строка	Необработанный вывод, возвращённый API REST APIC (xml или json) Возвращено: ошибка разбора Пример: `"<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class \"/></imdata>"`
response строка	HTTP-ответ от APIC Возвращено: неудача или отладка Пример: `"class_map (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"`

Авторы

Shreyas Srish (@shrsr)

Ссылки на коллекцию

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