cisco.aci.aci_maintenance_policy – Управление политиками обслуживания прошивки
Примечание
Этот плагин является частью коллекции cisco.aci (версия 1.1.1).
Для его установки используйте: ansible-galaxy collection install cisco.aci.
Для использования в книге задач укажите: cisco.aci.aci_maintenance_policy.
Описание
- Управление политиками обслуживания, которые определяют поведение во время обновления ACI.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| adminst строка |
| Будет инициировано немедленное обновление узлов, если adminst установлено в triggered. |
| annotation строка | Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, используется значение переменной окружения ACI_ANNOTATION. | |
| certificate_name строка | Имя сертификата X.509, прикреплённого к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл с именем private_key, по умолчанию используется имя файла private_key, без расширения.Если для private_key был предоставлен контент в формате PEM, по умолчанию используется значение username.Если значение не указано в задаче, используется значение переменной окружения ACI_CERTIFICATE_NAME.Псевдонимы: cert_name | |
| graceful булево |
| Определяет, будет ли система плавно останавливать узлы во время обновления, что уменьшает потери трафика. APIC по умолчанию устанавливает значение no при отсутствии указания во время создания. |
| host строка / обязательно | IP-адрес или имя хоста APIC, разрешаемые управляющим хостом Ansible. Если значение не указано в задаче, используется значение переменной окружения ACI_HOST.Псевдонимы: hostname | |
| ignoreCompat булево |
| Для проверки того, следует ли игнорировать проверки совместимости APIC по умолчанию устанавливает значение no при отсутствии указания во время создания. |
| name строка | Имя политики обслуживания. Псевдонимы: maintenance_policy | |
| name_alias строка | Псевдоним текущего объекта. Он относится к полю nameAlias в ACI. | |
| output_level строка |
| Влияет на вывод данного модуля 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 | |
| runmode строка |
| Определяет, будет ли система приостанавливаться при ошибке или просто продолжит её выполнение. |
| scheduler строка | Имя планировщика, применяемого к политике. | |
| state строка |
| Используйте present или absent для добавления или удаления.Используйте query для перечисления объекта или нескольких объектов. |
| timeout целое число | Значение по умолчанию: 30 | Тайм-аут уровня сокета в секундах. Если значение не указано в задаче, используется значение переменной окружения ACI_TIMEOUT. |
| use_proxy булево |
| Если no, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах.Если значение не указано в задаче, используется значение переменной окружения ACI_USE_PROXY. |
| use_ssl булево |
| Если no, вместо стандартного HTTPS соединения будет использоваться HTTP-соединение.Если значение не указано в задаче, используется значение переменной окружения ACI_USE_SSL. |
| username строка | Значение по умолчанию: "admin" | Имя пользователя для аутентификации. Если значение не указано в задаче, используются значения переменных окружения ACI_USERNAME или ANSIBLE_NET_USERNAME.Псевдонимы: user |
| validate_certs булево |
| Если no, сертификаты SSL не будут проверены.Это следует устанавливать только в no при работе с сайтами, контролируемыми лично, использующими самоподписанные сертификаты.Если значение не указано в задаче, используется значение переменной окружения ACI_VALIDATE_CERTS. |
Примечания
Примечание
- Для этого модуля требуется планировщик, который можно было создать с помощью модуля cisco.aci.aci_fabric_scheduler или через пользовательский интерфейс.
См. также
См. также
- Руководство по Cisco ACI
-
Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
- Разработка модулей Cisco ACI
-
Подробное руководство о том, как написать собственные модули Cisco ACI для участия в проекте.
Примеры
- name: Ensure maintenance policy is present
cisco.aci.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 строка | ошибка разбора | Необработанный результат, возвращённый 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_maintenance_policy_module.html
