Модуль cisco.aci.aci_firmware_group — Управление группами прошивки (firmware:FwGrp)
Примечание
Этот модуль входит в коллекцию cisco.aci (версия 2.10.1).
Вы, возможно, уже установили эту коллекцию, если используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install cisco.aci.
Чтобы использовать её в плейбуке, укажите: cisco.aci.aci_firmware_group.
Обзор
- Этот модуль создает группу прошивки, позволяя применять политику прошивки к узлам.
Параметры
Параметр | Комментарии |
|---|---|
annotation string | Строка, определяемая пользователем, для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной среды Если значение не указано в задаче и переменной среды По умолчанию: |
certificate_name aliases: cert_name string | Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указано имя файла Если для Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
description aliases: descr string | Описание группы прошивки. |
group string | Имя группы прошивки. |
host aliases: hostname string | IP-адрес или имя хоста APIC, разрешаемое узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
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 | Пароль, который нужно использовать для аутентификации. Этот параметр является взаимоисключающим с Если значение не указано в задаче, вместо него будут использованы значения переменных среды |
policy aliases: firmwarepol string | Имя политики прошивки Важно использовать то же имя, что и для политики, созданной с помощью cisco.aci.aci_firmware_policy. |
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 | Если Если значение не указано в задаче, будет использовано значение переменной среды Значение по умолчанию — ПРЕДУПРЕЖДЕНИЕ - Это приведет к тому, что текущее возвращаемое значение будет установлено в предложенное значение. Текущий объект, включая значения по умолчанию, не будет проверяться в одной задаче. Варианты:
|
timeout integer | Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной среды Значение по умолчанию — 30. |
type_group string | Тип группы прошивки. APIC по умолчанию устанавливает значение Варианты:
|
use_proxy boolean | Если Если значение не указано в задаче, будет использовано значение переменной среды Значение по умолчанию — true. Варианты:
|
use_ssl boolean | Если Если значение не указано в задаче, будет использовано значение переменной среды Значение по умолчанию — true при локальном соединении. Варианты:
|
username aliases: user string | Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных среды Значение по умолчанию — admin. |
validate_certs boolean | Если Это следует задавать как Если значение не указано в задаче, будет использовано значение переменной среды Значение по умолчанию — true. Варианты:
|
Примечания
Примечание
- Перед использованием этого модуля в вашем плейбуке должен существовать
policy. - Модуль cisco.aci.aci_firmware_policy может быть использован для этого.
См. также
См. также
- cisco.aci.aci_firmware_policy
-
Управление политиками прошивки (firmware:FwP).
- APIC Management Information Model reference
-
Дополнительная информация об внутренней классе APIC firmware:FwGrp.
- Руководство по Cisco ACI
-
Подробная информация о том, как управлять вашей инфраструктурой Cisco ACI с помощью Ansible.
- Разработка модулей Cisco ACI
-
Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.
Примеры
- name: Create a firmware group
cisco.aci.aci_firmware_group:
host: apic
username: admin
password: SomeSecretPassword
group: fmgroup
policy: fmpolicy1
state: present
delegate_to: localhost
- name: Delete a firmware group
cisco.aci.aci_firmware_group:
host: apic
username: admin
password: SomeSecretPassword
group: fmgroup
state: absent
delegate_to: localhost
- name: Query all firmware groups
cisco.aci.aci_firmware_group:
host: apic
username: admin
password: SomeSecretPassword
state: query
delegate_to: localhost
register: query_result
- name: Query a specific firmware group
cisco.aci.aci_firmware_group:
host: apic
username: admin
password: SomeSecretPassword
group: fmgroup
state: query
delegate_to: localhost
register: query_result
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
current список / элементы=строка | Текущая конфигурация с APIC после завершения работы модуля Возвращается при: успехе Пример: |
error словарь | Информация об ошибке, возвращённая APIC Возвращается при: ошибке Пример: |
filter_string строка | Строка фильтра, используемая для запроса Возвращается при: ошибке или отладке Пример: |
method строка | HTTP-метод, используемый для запроса к APIC Возвращается при: ошибке или отладке Пример: |
previous список / элементы=строка | Исходная конфигурация с APIC до запуска модуля Возвращается при: информации Пример: |
proposed словарь | Собраная конфигурация из параметров, заданных пользователем Возвращается при: информации Пример: |
raw строка | Необработанный вывод, возвращённый API REST APIC (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_firmware_group_module.html