cisco.aci.aci_interface_policy_leaf_breakout_port_group – Управление политикой интерфейса канвой leaf breakout port group (infra:BrkoutPortGrp)

Примечание

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

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

Для использования в книге задач укажите: cisco.aci.aci_interface_policy_leaf_breakout_port_group.

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

Описание

Управление политикой интерфейса канвой leaf breakout port group на Cisco ACI fabric.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
annotation строка		Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_ANNOTATION`.
breakout_map строка		Карта для breakout порта.
breakout_port_group строка		Имя leaf breakout port group для добавления/удаления. псевдонимы: имя
certificate_name строка		Имя X.509 сертификата, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указан файл с именем `private_key`, по умолчанию используется имя файла `private_key`, без расширения. Если предоставлено содержимое в формате PEM для `private_key`, по умолчанию используется значение `username`. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`. псевдонимы: имя_сертификата
description строка		Описание для leaf breakout port group, который будет создан. псевдонимы: описание
host строка / обязательно		IP-адрес или имя хоста APIC, разрешимое хостом Ansible. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_HOST`. псевдонимы: имя_хоста
output_level строка	Варианты: отладка информация нормальный ←	Влияет на вывод этого модуля 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`.
private_key строка		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимоисключающий с `password`. Если `password` также предоставлен, он будет проигнорирован. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_PRIVATE_KEY`. псевдонимы: закрытый_ключ_сертификата
state строка	Варианты: отсутствует есть ← запрос	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов.
timeout целое число	По умолчанию: 30	Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_TIMEOUT`.
use_proxy булево	Варианты: нет да ←	Если `no`, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_USE_PROXY`.
use_ssl булево	Варианты: нет да ←	Если `no`, вместо стандартного HTTPS-соединения будет использовано HTTP-соединение. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_USE_SSL`.
username строка	По умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. псевдонимы: пользователь
validate_certs булево	Варианты: нет да ←	Если `no`, сертификаты SSL не будут проверены. Это следует устанавливать в `no` только при использовании на управляемых сайтах с самоподписанными сертификатами. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_VALIDATE_CERTS`.

См. также

APIC Management Information Model reference: Дополнительная информация о внутренних классах APIC infra:BrkoutPortGrp.
Руководство по Cisco ACI: Подробная информация о том, как управлять инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Create a Leaf Breakout Port Group
  cisco.aci.aci_interface_policy_leaf_breakout_port_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    breakout_port_group: BreakoutPortName
    breakout_map: 10g-4x
    state: present
  delegate_to: localhost

- name: Query all Leaf Breakout Port Groups of type link
  cisco.aci.aci_interface_policy_leaf_breakout_port_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a specific Leaf Breakout Port Group
  cisco.aci.aci_interface_policy_leaf_breakout_port_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    breakout_port_group: BreakoutPortName
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete an Leaf Breakout Port Group
  cisco.aci.aci_interface_policy_leaf_breakout_port_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    breakout_port_group: BreakoutPortName
    state: absent
  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 строка	ошибка парсинга	Необработанный вывод, возвращенный APIC REST API (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-url, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Авторы

Cindy Zhao (@cizhao)

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