aci_maintenance_policy – Управление политиками обслуживания микропрограммного обеспечения
Новое в версии 2.8.
Обзор
- Управление политиками обслуживания, определяющими поведение во время обновления ACI.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| adminst - |
| Будет инициировано немедленное обновление узлов, если adminst установлено в triggered. |
| certificate_name строка | Имя сертификата X.509, прикреплённого к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен private_key файл, значение по умолчанию - private_key имя без расширения.Если для private_key был предоставлен контент в формате PEM, значение по умолчанию - username значение.Псевдонимы: cert_name | |
| graceful логическое |
| Указывает, будет ли система плавно завершать работу узлов во время обновления, что уменьшает потери трафика. APIC по умолчанию устанавливает значение no, если оно не задано при создании. |
| host строка / обязательно | IP-адрес или имя хоста APIC, разрешаемого хостом управления Ansible. Псевдонимы: hostname | |
| ignoreCompat логическое |
| Указывает, нужно ли игнорировать проверки совместимости APIC по умолчанию устанавливает значение no, если оно не задано при создании. |
| name - / обязательно | Имя политики обслуживания. Псевдонимы: maintenance_policy | |
| output_level строка |
| Влияет на вывод данного модуля ACI. normal означает стандартный вывод, включая current словарь.info добавляет информационный вывод, включая previous, proposed и sent словари.debug добавляет отладочный вывод, включая filter_string, method, response, status и url информацию. |
| password строка / обязательно | Пароль для аутентификации. Этот параметр взаимоисключающий с private_key. Если также указан private_key, будет использовано его значение. | |
| port целое число | Номер порта, используемого для подключения REST. Значение по умолчанию зависит от параметра use_ssl. | |
| private_key строка / обязательно | Файл закрытого ключа в формате PEM или сам закрытый ключ, используемый для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию certificate_name, которое используется.Этот параметр взаимоисключающий с password. Если также указан password, он будет проигнорирован.Псевдонимы: cert_key | |
| runmode - |
| Указывает, приостанавливает ли система выполнение при ошибке или продолжает выполнение. |
| scheduler строка / обязательно | Имя планировщика, применяемого к политике. | |
| state - |
| Используйте present или absent для добавления или удаления.Используйте query для отображения объекта или нескольких объектов. |
| timeout целое число | Значение по умолчанию: 30 | Таймаут на уровне сокета в секундах. |
| use_proxy логическое |
| Если no, прокси не будет использоваться, даже если он определён в переменной среды на целевых узлах. |
| use_ssl логическое |
| Если no, будет использовано HTTP-соединение вместо стандартного HTTPS-соединения. |
| username строка | Значение по умолчанию: "admin" | Имя пользователя для аутентификации. Псевдонимы: user |
| validate_certs логическое |
| Если no, сертификаты SSL не будут проверены.Это следует установить в no только при использовании на сайтах под собственным контролем, использующих самозаверенные сертификаты. |
Примечания
Примечание
- Для данного модуля требуется планировщик, который можно было создать с помощью модуля aci_fabric_scheduler или через интерфейс пользователя.
См. также
См. также
- Руководство Cisco ACI
- Подробная информация о том, как управлять инфраструктурой ACI с помощью Ansible.
- Разработка модулей Cisco ACI
- Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.
Примеры
- name: Ensure maintenance policy is present
aci_maintenance_policy:
host: '{{ inventory_hostname }}'
username: '{{ user }}'
password: '{{ pass }}'
validate_certs: no
name: maintenancePol1
scheduler: simpleScheduler
runmode: False
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 строка | ошибка разбора | Необработанный вывод, возвращённый APIC REST API (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 |
Статус
- Данный модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/aci_maintenance_policy_module.html