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

admin_state

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

строка

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

Немедленно запустит обновление узлов, если для admin_state задано значение triggered.

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

Варианты:

• "triggered"
• "untriggered"

annotation

строка

Задаваемая пользователем строка для аннотирования объекта.

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

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

По умолчанию: "orchestrator:ansible"

certificate_name

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

строка

Имя сертификата X.509, привязанного к пользователю AAA APIC, используемого для аутентификации на основе подписи.

Если указано имя файла 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

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

строка

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

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

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

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

run_mode

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

строка

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

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

Варианты:

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

scheduler

строка

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

smu_operation

строка

Указывает, что обновление является операцией установки исправления Software Maintenance Upgrade (SMU).

Варианты:

• "smu_install"
• "smu_uninstall"

smu_operation_flags

строка

Указывает флаги операции установки исправления Software Maintenance Upgrade (SMU).

Определяет, следует ли немедленно перезагрузить узел или пропустить автоматическую перезагрузку при установке или удалении SMU.

Варианты:

• "smu_reload_immediate"
• "smu_reload_skip"

sr_upgrade

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

логический

Указывает, что обновление является обновлением пакета Silent Roll (SR).

Варианты:

• false
• true

sr_version

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

строка

Целевая версия микропрограммы пакета Silent Roll (SR), который необходимо установить.

state

строка

Используйте present или absent для добавления или удаления.

Используйте query для получения списка одного или нескольких объектов.

Варианты:

• "absent"
• "present" ← (по умолчанию)
• "query"

suppress_previous

псевдонимы: no_previous, ignore_previous

логический

Если true, перед обновлением POST в APIC не будет отправлен GET-запрос для проверки предыдущего состояния.

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

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

ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое предыдущее значение будет пустым.

Предыдущее состояние объекта не будет проверено, а запрос POST на обновление будет содержать все свойства.

Варианты:

• false
• true

suppress_verification

псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

логический

Если true, после обновления POST в APIC не будет отправлен проверочный GET-запрос.

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

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

ПРЕДУПРЕЖДЕНИЕ — в результате текущее возвращаемое значение будет установлено равным предложенному значению.

Текущий объект, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи.

Варианты:

• false
• true

timeout

целое число

Тайм-аут сокета в секундах.

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

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

use_proxy

логический

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

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

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

Варианты:

• false
• true

use_ssl

логический

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

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

При локальном подключении значение по умолчанию — true.

Варианты:

• false
• true

username

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

строка

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

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

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

validate_certs

логический

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

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

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

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

Варианты:

• false
• true

version

строка

Целевая версия микропрограммы для установки.

version_check_override

строка

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

Это указание пропустить проверку версии при следующей установке.

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

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

Переопределение проверки версии применяется один раз и запускает установку независимо от того, совпадают ли версии.

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

Варианты:

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

current

list / elements=string

Текущая конфигурация APIC после завершения работы модуля

Возвращается: success

Пример: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

error

dictionary

Информация об ошибке, возвращенная APIC

Возвращается: failure

Пример: {"code": "122", "text": "unknown managed object class foo"}

filter_string

string

Строка фильтра, использованная в запросе

Возвращается: failure or debug

Пример: "?rsp-prop-include=config-only"

method

string

Метод HTTP, использованный для запроса к APIC

Возвращается: failure or debug

Пример: "POST"

previous

list / elements=string

Исходная конфигурация APIC до запуска модуля

Возвращается: info

Пример: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

dictionary

Сформированная конфигурация на основе параметров, указанных пользователем

Возвращается: info

Пример: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}

raw

string

Необработанный вывод, возвращенный REST API APIC (xml или json)

Возвращается: parse error

Пример: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"

response

string

Ответ HTTP от APIC

Возвращается: failure or debug

Пример: "OK (30 bytes)"

sent

list / elements=string

Фактическая/минимальная конфигурация, отправленная в APIC

Возвращается: info

Пример: {"fvTenant": {"attributes": {"descr": "Production environment"}}}

status

integer

Статус HTTP от APIC

Возвращается: failure or debug

Пример: 200

url

string

URL HTTP, использованный для запроса к APIC

Возвращается: failure or debug

Пример: "https://10.11.12.13/api/mo/uni/tn-production.json"