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

Примечание

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

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

Для использования в playbook, укажите: cisco.aci.aci_firmware_policy.

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

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
annotation строка		Определяемая пользователем строка для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_ANNOTATION`.
certificate_name строка		Имя сертификата X.509, прикреплённого к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл `private_key`, это значение по умолчанию равно базовому имени `private_key`, без расширения. Если для `private_key` было предоставлено содержимое в формате PEM, это значение по умолчанию равно значению `username`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_CERTIFICATE_NAME`. псевдонимы: cert_name
host строка / обязательно		IP-адрес или имя хоста APIC, распознаваемое узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_HOST`. псевдонимы: hostname
ignoreCompat булево	Варианты: no yes	Проверить, следует ли игнорировать проверки совместимости
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 строка		Путь к файлу, который будет использоваться для вывода объектов конфигурации 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`. псевдонимы: 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`.
version строка		Версия прошивки, связанная с этой политикой. Это значение очень важно, а также правильное его построение. Синтаксис для этого поля: n9000-xx.x. Если вы посмотрите на репозиторий прошивки с помощью интерфейса пользователя, каждая версия будет иметь столбец «Полная версия», это значение, которое вам нужно использовать. Таким образом, если полная версия равна 13.1(1i), значение для этого поля будет n9000-13.1(1i)

См. также

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

Примеры

- name: firmware policy
  cisco.aci.aci_firmware_policy:
     host: "{{ inventory_hostname }}"
     username: "{{ user }}"
     password: "{{ pass }}"
     validate_certs: no
     name: test2FrmPol
     version: n9000-13.2(1m)
     ignoreCompat: False
     state: present

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

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

Key	Returned	Description
current list / elements=string	success	Существующая конфигурация из APIC после завершения работы модуля Sample: [{'fvTenant': {'attributes': {'descr': 'Production environment', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
error dictionary	failure	Информация об ошибке, возвращаемая APIC Sample: {'code': '122', 'text': 'unknown managed object class foo'}
filter_string string	failure or debug	Строка фильтра, используемая для запроса Sample: ?rsp-prop-include=config-only
method string	failure or debug	HTTP-метод, используемый для запроса к APIC Sample: POST
previous list / elements=string	info	Оригинальная конфигурация из APIC до начала работы модуля Sample: [{'fvTenant': {'attributes': {'descr': 'Production', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed dictionary	info	Собранная конфигурация из параметров, предоставленных пользователем Sample: {'fvTenant': {'attributes': {'descr': 'Production environment', 'name': 'production'}}}
raw string	parse error	Необработанный вывод, возвращаемый APIC REST API (xml или json) Sample: <?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>
response string	failure or debug	HTTP-ответ от APIC Sample: OK (30 bytes)
sent list / elements=string	info	Фактическая/минимальная конфигурация, отправленная в APIC Sample: {'fvTenant': {'attributes': {'descr': 'Production environment'}}}
status integer	failure or debug	HTTP-статус от APIC Sample: 200
url string	failure or debug	HTTP-url, используемый для запроса к APIC Sample: 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_policy_module.html