cisco.aci.aci_switch_policy_leaf_profile – Управление профилями политики коммутатора для листов (infra:NodeP)

Примечание

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

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

Чтобы использовать его в книге задач, укажите: cisco.aci.aci_switch_policy_leaf_profile.

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

Описание

Управление профилями политики коммутатора для листов на сетях Cisco ACI.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
annotation строка		Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, используется значение переменной среды `ACI_ANNOTATION`.
certificate_name строка		Имя сертификата X.509, прикреплённого к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлён файл с именем `private_key`, по умолчанию используется имя файла `private_key`, без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, используется значение переменной среды `ACI_CERTIFICATE_NAME`. алиасы: cert_name
description строка		Описание профиля листа. алиасы: descr
host строка / обязательно		IP-адрес или имя хоста APIC, разрешимый управляющим хостом Ansible. Если значение не указано в задаче, используется значение переменной среды `ACI_HOST`. алиасы: hostname
leaf_profile строка		Имя профиля листа. алиасы: leaf_profile_name, name
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 строка		Путь к файлу, который будет использован для вывода 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` для получения списка объекта или нескольких объектов.
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`.

См. также

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

Примеры

- name: creating a Leaf Profile with description
  cisco.aci.aci_switch_policy_leaf_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    leaf_profile: sw_name
    description: sw_description
    state: present
  delegate_to: localhost

- name: Deleting a Leaf Profile
  cisco.aci.aci_switch_policy_leaf_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    leaf_profile: sw_name
    state: absent
  delegate_to: localhost

- name: Query a Leaf Profile
  cisco.aci.aci_switch_policy_leaf_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    leaf_profile: sw_name
    state: query
  delegate_to: localhost
  register: query_result

Возвращаемые значения

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

Ключ	Возвращено	Описание
current список / элементы=строка	успех	Текущая конфигурация с APIC после завершения модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'dn': 'uni/tn-production', 'name': 'производство', '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': 'производство', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed словарь	информация	Сборка конфигурации из параметров, предоставленных пользователем Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда', 'name': 'производство'}}}
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-URL, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Авторы

Bruno Calogero (@brunocalogero)

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