Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_maintenance_policy – Управление политиками технического обслуживания прошивки (maint:MaintP)

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.aci.aci_maintenance_policy.

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

Обзор

  • Управление политиками технического обслуживания, которые определяют поведение во время обновления ACI.

Параметры

Параметр

Комментарии

admin_state

псевдонимы: adminst

строка

Административное состояние исполняемых политик.

Вызовет немедленное обновление узлов, если admin_state установлено в triggered.

APIC по умолчанию устанавливает untriggered при отсутствии значения во время создания.

Варианты:

  • "triggered"
  • "untriggered"

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

строка

Описание политики технического обслуживания.

download_state

строка

Состояние загрузки исполняемых политик.

APIC по умолчанию устанавливает untriggered при отсутствии значения во время создания.

Варианты:

  • "triggered"
  • "untriggered"

graceful

логическое

Указывает, будет ли система плавно выключать узлы во время обновления, что снизит потери трафика.

APIC по умолчанию устанавливает false при отсутствии значения во время создания.

Варианты:

  • false
  • true

host

псевдонимы: hostname

строка

IP-адрес или имя хоста APIC, разрешаемые хостом Ansible.

Если значение не указано в задаче, будет использовано значение переменной среды ACI_HOST.

ignore_compat

псевдонимы: ignoreCompat

логическое

Указывает, нужно ли игнорировать проверки совместимости.

APIC по умолчанию устанавливает false при отсутствии значения во время создания.

Варианты:

  • false
  • true

name

псевдонимы: maintenance_policy

строка

Имя политики технического обслуживания.

name_alias

строка

Псевдоним текущего объекта. Он относится к полю nameAlias в ACI.

notify_condition

строка

Указывает, при каком условии приостановки администратор будет уведомлен по электронной почте/сообщением, как настроено.

Этот механизм уведомления независим от событий/ошибок.

APIC по умолчанию устанавливает notifyOnlyOnFailures при отсутствии значения во время создания.

Варианты:

  • "notify_always_between_sets"
  • "notify_never"
  • "notify_only_on_failures"

output_level

строка

Влияет на вывод этого модуля ACI.

normal означает стандартный вывод, включая словарь current.

info добавляет информативный вывод, включая словари previous, proposed и sent.

debug добавляет отладочный вывод, включая информацию filter_string, method, response, status и url.

Если значение не указано в задаче, будет использовано значение переменной среды ACI_OUTPUT_LEVEL.

Варианты:

  • "debug"
  • "info"
  • "normal" ← (по умолчанию)

output_path

строка

Путь к файлу, который будет использоваться для выгрузки объектов конфигурации ACI JSON, сгенерированных модулем.

Если значение не указано в задаче, будет использовано значение переменной среды ACI_OUTPUT_PATH.

password

строка

Пароль для аутентификации.

Этот параметр взаимоисключает private_key. Если также указано private_key, оно будет использоваться вместо него.

Если значение не указано в задаче, будут использованы переменные среды ACI_PASSWORD или ANSIBLE_NET_PASSWORD.

port

целое число

Номер порта, используемый для подключения REST.

Значение по умолчанию зависит от параметра use_ssl.

Если значение не указано в задаче, будет использовано значение переменной среды ACI_PORT.

private_key

aliases: cert_key

string

Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемого для аутентификации на основе подписи.

Это значение также влияет на используемый по умолчанию certificate_name.

Этот параметр несовместим с password. Если также указан password, он будет проигнорирован.

Если значение не указано в задании, вместо него будет использовано значение переменной среды ACI_PRIVATE_KEY или ANSIBLE_NET_SSH_KEYFILE.

run_mode

aliases: runmode

string

Определяет, останавливает ли система выполнение на ошибке или просто продолжает её обрабатывать.

APIC по умолчанию использует значение pauseOnlyOnFailures при отсутствии явного задания при создании.

Варианты:

  • "pause_always_between_sets"
  • "pause_only_on_failures"
  • "pause_never"
  • "pauseOnlyOnFailures"
  • "pauseNever"

scheduler

string

Имя планировщика, применяемого к политике.

smu_operation

string

Указывает операцию SMU.

Варианты:

  • "smu_install"
  • "smu_uninstall"

smu_operation_flags

string

Указывает флаги операции SMU.

Указывает, нужно ли перезагружать узел немедленно или пропустить автоматическую перезагрузку при установке/удалении SMU.

Варианты:

  • "smu_reload_immediate"
  • "smu_reload_skip"

sr_upgrade

boolean

Обновление SR-прошивки.

Варианты:

  • false
  • true

sr_version

string

Версия SR каталога совместимости.

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.

use_proxy

boolean

Если false, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.

Если значение не указано в задании, вместо него будет использовано значение переменной среды ACI_USE_PROXY.

Значение по умолчанию - true.

Варианты:

  • false
  • true

use_ssl

boolean

Если false, вместо стандартного HTTPS-соединения будет использовано HTTP-соединение.

Если значение не указано в задании, вместо него будет использовано значение переменной среды ACI_USE_SSL.

Значение по умолчанию - true для локального соединения.

Варианты:

  • false
  • true

username

aliases: user

string

Имя пользователя для аутентификации.

Если значение не указано в задании, вместо него будут использованы значения переменных среды ACI_USERNAME или ANSIBLE_NET_USERNAME.

Значение по умолчанию - admin.

END_OF_DOCUMENT_MARKER

validate_certs

boolean

Если false, сертификаты SSL не будут проверены.

Это значение следует установить в false только при использовании на сайтах, контролируемых лично, с использованием самозаверенных сертификатов.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_VALIDATE_CERTS.

Значение по умолчанию — true.

Варианты:

  • false
  • true

version

string

Версия каталога совместимости.

version_check_override

string

Переопределение проверки версии.

Это директива игнорирования проверки версии при следующем инсталляции.

Проверка версии, выполняемая во время окна обслуживания, проверяет, соответствует ли желаемая версия текущей версии.

Если версии не совпадают, установка выполняется. Если версии совпадают, установка не выполняется.

Переопределение проверки версии — это одноразовое переопределение, которое выполняет установку независимо от совпадения версий.

APIC по умолчанию устанавливает значение untriggered при отсутствии значения при создании.

Варианты:

  • "trigger"
  • "trigger_immediate"
  • "triggered"
  • "untriggered"

Примечания

Примечание

  • Для данного модуля требуется планировщик, который может быть создан с помощью модуля cisco.aci.aci_fabric_scheduler или через пользовательский интерфейс.

См. также

См. также

cisco.aci.aci_fabric_scheduler

Этот модуль создает планировщики ACI (trig:SchedP).

APIC Management Information Model reference

Дополнительная информация об внутренней классе APIC maint:MaintP.

Руководство по Cisco ACI

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

Разработка модулей Cisco ACI

Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Create a maintenance policy
  cisco.aci.aci_maintenance_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_maintenance_policy
    scheduler: simpleScheduler
    state: present
  delegate_to: localhost

- name: Delete a maintenance policy
  cisco.aci.aci_maintenance_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_maintenance_policy
    state: absent
  delegate_to: localhost

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

- name: Query a specific maintenance policy
  cisco.aci.aci_maintenance_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_maintenance_policy
    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

строка

Необработанный результат, возвращенный API REST APIC (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_policy_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API