Модуль cisco.aci.aci_maintenance_group – Создаёт группу технического обслуживания ACI (maint:MaintGrp)

Примечание

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

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

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

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

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

Описание

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

Параметры

Параметр	Комментарии
annotation строка	Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменная среды `ACI_ANNOTATION`, то будет использовано значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, прикреплённого к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если предоставлено имя файла `private_key`, по умолчанию используется имя файла `private_key`, без расширения. Если для `private_key` предоставлено содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`.
description псевдонимы: descr строка	Описание группы технического обслуживания.
firmware_nodes_type строка	Тип микропрограммы узлов в группе технического обслуживания. APIC по умолчанию устанавливает `switch` при отсутствии значения при создании. Варианты: `"c_apic_patch"` `"catalog"` `"config"` `"controller"` `"controller_patch"` `"plugin"` `"plugin_package"` `"switch"` `"switch_patch"` `"vpod"`
group строка	Имя группы технического обслуживания.
host псевдонимы: hostname строка	IP-адрес или имя хоста APIC, разрешаемый хостом управления Ansible. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_HOST`.
name_alias строка	Псевдоним текущего объекта. Это относится к полю nameAlias в ACI.
output_level строка	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` dict. `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
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`.
policy псевдонимы: maintenancepol строка	Имя политики технического обслуживания.
port целое число	Номер порта, используемый для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_PORT`.
private_key псевдонимы: cert_key строка	Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимоисключает `password`. Если также указан `password`, он будет проигнорирован. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.

state string	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous aliases: no_previous, ignore_previous boolean	Если `true`, GET для проверки предыдущего состояния не будет отправлен перед обновлением POST в APIC. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к пустому возвращаемому значению предыдущего состояния. Предыдущее состояние объекта не будет проверяться, и обновление POST будет содержать все свойства. Варианты: `false` `true`
suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, подтверждающий GET не будет отправлен после обновления POST в APIC. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к установке текущего возвращаемого значения в предложенное значение. Текущий объект, включая значения по умолчанию, не будет проверяем в одной задаче. Варианты: `false` `true`
timeout integer	Таймаут уровня сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_TIMEOUT`. Значение по умолчанию 30.
type_group string	Тип группы технического обслуживания. APIC по умолчанию устанавливает значение `range` при создании, если оно не указано. Варианты: `"all"` `"all_in_pod"` `"range"`
use_proxy boolean	Если `false`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_USE_PROXY`. Значение по умолчанию true. Варианты: `false` `true`
use_ssl boolean	Если `false`, будет использоваться соединение HTTP вместо соединения HTTPS по умолчанию. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_USE_SSL`. Значение по умолчанию true при локальном соединении. Варианты: `false` `true`
username aliases: user string	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию admin.
validate_certs boolean	Если `false`, сертификаты SSL не будут проверены. Это значение должно быть установлено в `false` только при работе с сайтами, контролируемыми лично, с использованием самоподписанных сертификатов. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_VALIDATE_CERTS`. Значение по умолчанию true. Варианты: `false` `true`

Примечания

Примечание

Необходимый policy должен существовать перед использованием данного модуля в вашем плейбуке.
Для этого можно использовать модуль cisco.aci.aci_maintenance_policy.

См. также

cisco.aci.aci_maintenance_policy: Управление политиками технического обслуживания программного обеспечения (maint:MaintP).
APIC Management Information Model reference: Дополнительная информация о внутреннем классе APIC maint:MaintGrp.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для вклада в проект.

Примеры

- name: Create a maintenance group
  cisco.aci.aci_maintenance_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    group: my_maintenance_group
    policy: my_maintenance_policy
    state: present
  delegate_to: localhost

- name: Delete a maintenance group
  cisco.aci.aci_maintenance_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    group: my_maintenance_group
    state: absent
  delegate_to: localhost

- name: Query all maintenance groups
  cisco.aci.aci_maintenance_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a specific maintenance group
  cisco.aci.aci_maintenance_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    group: my_maintenance_group
    state: query
  delegate_to: localhost
  register: query_result

Значения возврата

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

Ключ	Описание
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 строка	Необработанный вывод, возвращённый APIC REST API (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 строка	HTTP-URL, используемый для запроса к APIC Возвращается при: ошибке или отладке Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Steven Gerhart (@sgerhart)
Gaspard Micol (@gmicol)

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

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