модуль cisco.aci.aci_tag — Присвоение тегов объектам ACI (tag:Annotation, tag:Inst и tag:Tag)

Примечание

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

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

Чтобы установить коллекцию, используйте: ansible-galaxy collection install cisco.aci.

Чтобы использовать ее в плейбуке, укажите: cisco.aci.aci_tag.

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

Краткое описание

Присвоение тегов объектам в фабрике Cisco ACI.

Параметры

Параметр	Комментарии
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, связанного с пользователем APIC AAA, который используется для аутентификации на основе подписи. Если указан файл `private_key`, по умолчанию используется базовое имя файла `private_key` без расширения. Если для `private_key` указано содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`.
dn строка	Уникальное различающееся имя (DN) из модели объектов ACI.
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"` ← (по умолчанию)
output_path строка	Путь к файлу, в который будут записаны созданные модулем объекты конфигурации ACI в формате JSON. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OUTPUT_PATH`.
password строка	Пароль для аутентификации. Этот параметр несовместим с `private_key`. Если также указан `private_key`, будет использован он. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PORT`.
private_key псевдонимы: cert_key строка	Файл закрытого ключа в формате PEM или содержимое закрытого ключа для аутентификации на основе подписи. Это значение также влияет на используемое значение `certificate_name` по умолчанию. Этот параметр несовместим с `password`. Если также указан `password`, он будет проигнорирован. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
state строка	Для добавления или удаления используйте `present` или `absent`. Для просмотра одного или нескольких объектов используйте `query`. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous псевдонимы: no_previous, ignore_previous логический	Если `true`, перед отправкой POST-запроса для обновления APIC не будет отправлен GET-запрос для проверки предыдущего состояния. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое значение previous будет пустым. Предыдущее состояние объекта не будет проверено, а POST-запрос на обновление будет содержать все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification логический	Если `true`, после отправки POST-запроса для обновления APIC не будет отправлен проверочный GET-запрос. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое значение current будет установлено в предлагаемое значение. Текущее состояние объекта, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи. Варианты: `false` `true`
tag_key строка	Уникальный идентификатор объекта тега.
tag_type строка / обязательный	Тип объекта тега. Варианты: `"annotation"` `"instance"` `"tag"`
tag_value строка	Значение свойства. По умолчанию: `""`
timeout целое число	Тайм-аут на уровне сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию — 30.
use_proxy логический	Если `false`, прокси-сервер использоваться не будет, даже если он задан в переменной среды на целевых узлах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_PROXY`. Значение по умолчанию — true. Варианты: `false` `true`
use_ssl логический	Если `false`, вместо HTTPS-подключения, используемого по умолчанию, будет установлено HTTP-подключение. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_SSL`. Значение по умолчанию — true при локальном подключении. Варианты: `false` `true`
username псевдоним: user строка	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию — admin.
validate_certs логический	Если `false`, сертификаты SSL проверяться не будут. Устанавливайте значение `false` только на сайтах под вашим контролем, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию — true. Варианты: `false` `true`

Примечания

Примечание

Объект ACI должен существовать до использования этого модуля в плейбуке.
ВАЖНО — в связи с устареванием объекта ‘tagInst’ при создании тега с tag_type ‘instance’ автоматически создается тег tag_type ‘annotation’ с пустым значением. При удалении tag_type ‘instance’ объект ‘tagAnnotation’ останется и его нужно будет удалить отдельно.

См. также

Справочник модели управления APIC: Дополнительные сведения о внутренних классах APIC tag:Annotation, tag:Inst и tag:Tag.
Руководство по настройке управления системой Cisco APIC: Дополнительные сведения о присвоении тегов приведены в руководстве по настройке управления системой Cisco APIC.
Руководство по Cisco ACI: Подробные сведения об управлении инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по созданию собственных модулей Cisco ACI для внесения вклада в проект.

Примеры

- name: Add a new annotation tag
  cisco.aci.aci_tag:
    host: apic
    username: admin
    password: SomeSecretPassword
    dn: SomeValidAciDN
    tag_key: foo
    tag_value: bar
    tag_type: annotation
    state: present
  delegate_to: localhost
- name: Delete annotation tag
  cisco.aci.aci_tag:
    host: apic
    username: admin
    password: SomeSecretPassword
    dn: SomeValidAciDN
    tag_key: foo
    tag_type: annotation
    state: absent
  delegate_to: localhost
- name: Query annotation tag
  cisco.aci.aci_tag:
    host: apic
    username: admin
    password: SomeSecretPassword
    dn: SomeValidAciDN
    tag_key: foo
    tag_type: annotation
    state: query
  delegate_to: localhost
- name: Query annotation tags
  cisco.aci.aci_tag:
    host: apic
    username: admin
    password: SomeSecretPassword
    tag_type: annotation
    state: query
  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 строка	Необработанный ответ REST API APIC (xml или json) Возвращается: при ошибке разбора Пример: `"<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"`
response строка	Ответ HTTP от APIC Возвращается: при ошибке или в режиме отладки Пример: `"OK (30 bytes)"`
sent список / элементы=строка	Фактическая/минимальная конфигурация, отправленная в APIC Возвращается: при информационном выводе Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status целое число	Статус HTTP от APIC Возвращается: при ошибке или в режиме отладки Пример: `200`
url строка	URL HTTP, использованный для запроса к APIC Возвращается: при ошибке или в режиме отладки Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Akini Ross (@akinross)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/aci/aci_tag_module.html