Модуль cisco.aci.aci_l2out – Управление объектами Layer2 Out (L2Out) (l2ext:Out)
Примечание
Этот модуль входит в коллекцию cisco.aci (версия 2.10.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install cisco.aci.
Чтобы использовать её в плейбуке, укажите: cisco.aci.aci_l2out.
Обзор
- Управление конфигурацией Layer2 Out на Cisco ACI фабриках.
Параметры
Параметр | Комментарии |
|---|---|
annotation string | Пользовательская строка для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Если значение не указано в задаче и переменной окружения Default: |
bd string | Имя мостового домена, связанного с L2Out. |
certificate_name aliases: cert_name string | Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был указан файл Если для Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
description string | Описание для L2Out. |
domain string | Имя внешнего домена уровня 2, который связан с L2Out. |
host aliases: hostname string | IP-адрес или имя хоста APIC, разрешаемое узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
l2out aliases: name string | Имя внешнего уровня 2. |
name_alias string | Псевдоним для текущего объекта. Это относится к полю nameAlias в ACI. |
output_level string | Влияет на вывод этого модуля ACI.
Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Варианты:
|
output_path string | Путь к файлу, который будет использоваться для выгрузки объектов конфигурации ACI JSON, сгенерированных модулем. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
owner_key string | Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет ключ для предоставления клиентам права владения своими данными для корреляции сущностей. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
owner_tag string | Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет тег, позволяющий клиентам добавлять собственные данные. Например, для указания того, кто создал этот объект. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
password string | Пароль для аутентификации. Эта опция является взаимоисключающей с Если значение не указано в задаче, вместо него будут использованы значения переменных окружения |
port integer | Порт, который будет использоваться для REST-подключения. Значение по умолчанию зависит от параметра Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
private_key aliases: cert_key string | Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на используемое значение Эта опция является взаимоисключающей с Если значение не указано в задаче, вместо него будут использованы значения переменных окружения |
state string | Используйте Используйте Варианты:
|
suppress_previous aliases: no_previous, ignore_previous boolean | Если Если значение не указано в задаче, будет использовано значение переменной среды Значение по умолчанию — ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение будет пустым. Предыдущее состояние объекта не будет проверяться, и обновление POST будет содержать все свойства. Выбор:
|
suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean | Если Если значение не указано в задаче, будет использовано значение переменной среды Значение по умолчанию — ПРЕДУПРЕЖДЕНИЕ - Это приводит к установке текущего возвращаемого значения в предложенное значение. Текущий объект, включая значения по умолчанию, не будет проверяться в одной задаче. Выбор:
|
tenant string | Имя существующего Тенента. |
timeout integer | Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной среды Значение по умолчанию — 30. |
use_proxy boolean | Если Если значение не указано в задаче, будет использовано значение переменной среды Значение по умолчанию — true. Выбор:
|
use_ssl boolean | Если Если значение не указано в задаче, будет использовано значение переменной среды Значение по умолчанию — true при локальном соединении. Выбор:
|
username aliases: user string | Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных среды Значение по умолчанию — admin. |
validate_certs boolean | Если Это следует устанавливать в Если значение не указано в задаче, будет использовано значение переменной среды Значение по умолчанию — true. Выбор:
|
vlan integer | VLAN, ассоциированный с L2Out. |
Примечания
Примечание
- Тенент
tenantдолжен существовать перед использованием данного модуля в вашем плейбуке. Для этого можно использовать модули cisco.aci.aci_tenant.
См. также
См. также
- Справочник моделирования информации управления APIC
-
Дополнительная информация о внутреннем классе APIC l2ext:Out.
- Руководство по Cisco ACI
-
Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
- Разработка модулей Cisco ACI
-
Подробное руководство по написанию собственных модулей Cisco ACI для участия в проекте.
Примеры
- name: Add a new L2Out
cisco.aci.aci_l2out:
host: apic
username: admin
password: SomeSecretePassword
tenant: Auto-Demo
l2out: l2out
description: via Ansible
bd: bd1
domain: l2Dom
vlan: 3200
state: present
delegate_to: localhost
- name: Remove an L2Out
cisco.aci.aci_l2out:
host: apic
username: admin
password: SomeSecretePassword
tenant: Auto-Demo
l2out: l2out
state: absent
delegate_to: localhost
- name: Query an L2Out
cisco.aci.aci_l2out:
host: apic
username: admin
password: SomeSecretePassword
tenant: Auto-Demo
l2out: l2out
state: query
delegate_to: localhost
register: query_result
- name: Query all L2Outs in a specific tenant
cisco.aci.aci_l2out:
host: apic
username: admin
password: SomeSecretePassword
tenant: Auto-Demo
state: query
delegate_to: localhost
register: query_result
Значения возврата
Общие значения возврата задокументированы здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
current список / элементы=строка | Существующая конфигурация с APIC после завершения модуля Возвращено: успех Пример: |
error словарь | Информация об ошибке, возвращённая APIC Возвращено: неудача Пример: |
filter_string строка | Строка фильтра, использованная для запроса Возвращено: неудача или отладка Пример: |
method строка | HTTP-метод, использованный для запроса к APIC Возвращено: неудача или отладка Пример: |
previous список / элементы=строка | Исходная конфигурация из APIC до начала работы модуля Возвращено: информация Пример: |
proposed словарь | Собраная конфигурация из предоставленных пользователем параметров Возвращено: информация Пример: |
raw строка | Необработанный вывод, возвращённый API APIC REST (xml или json) Возвращено: ошибка разбора Пример: |
response строка | HTTP-ответ от APIC Возвращено: неудача или отладка Пример: |
sent список / элементы=строка | Фактическая/минимальная конфигурация, отправленная в APIC Возвращено: информация Пример: |
status целое число | HTTP-статус от APIC Возвращено: неудача или отладка Пример: |
url строка | HTTP-URL, использованный для запроса к APIC Возвращено: неудача или отладка Пример: |
Ссылки на коллекцию
© 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_l2out_module.html