cisco.aci.aci_firmware_group – Этот модуль создаёт группу прошивок

Примечание

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

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

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

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

Обзор

Этот модуль создаёт группу прошивок, чтобы вы могли применять политику прошивки к узлам.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
annotation строка		Пользовательская строка для аннотации объекта. Если значение не указано в задаче, используется значение переменной среды `ACI_ANNOTATION`.
certificate_name строка		Имя сертификата X.509, прикреплённого к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлён файл с именем `private_key`, значение по умолчанию — имя файла `private_key`, без расширения. Если для `private_key` было предоставлено содержимое в формате PEM, значение по умолчанию — значение `username`. Если значение не указано в задаче, используется значение переменной среды `ACI_CERTIFICATE_NAME`. Псевдонимы: cert_name
firmwarepol строка		Это имя политики прошивки, созданной модулем aci_firmware_policy. Важно использовать то же имя, что и для созданной политики с помощью aci_firmware_policy.
group строка		Имя группы прошивок.
host строка / обязательно		IP-адрес или имя хоста APIC, разрешаемый управляющим хостом Ansible. Если значение не указано в задаче, используется значение переменной среды `ACI_HOST`. Псевдонимы: hostname
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`, будет использоваться HTTP-соединение вместо стандартного HTTPS-соединения. Если значение не указано в задаче, используется значение переменной среды `ACI_USE_SSL`.
username строка	По умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не указано в задаче, используется значение переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Псевдонимы: user
validate_certs логическое	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это должно быть установлено в `no` только при использовании на контролируемых сайтах с самоподписанными сертификатами. Если значение не указано в задаче, используется значение переменной среды `ACI_VALIDATE_CERTS`.

См. также

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

Примеры

- name: firmware group
  cisco.aci.aci_firmware_group:
    host: "{{ inventory_hostname }}"
    username: "{{ user }}"
    password: "{{ pass }}"
    validate_certs: no
    group: testingfwgrp1
    firmwarepol: test2FrmPol
    state: present

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

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

Ключ	Возвращаемое значение	Описание
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 строка	ошибка разбора	Необработанный результат, возвращённый 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

Авторы

Steven Gerhart (@sgerhart)

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