cisco.nxos.nxos_gir – Вызвать плавное удаление или вставку (GIR) коммутатора.

Примечание

Этот плагин входит в коллекцию cisco.nxos (версия 1.4.0).

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

Для использования в книге задач укажите: cisco.nxos.nxos_gir.

Новое в версии 1.0.0: для cisco.nxos

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

Описание

Вызвать плавное удаление или вставку (GIR) коммутатора.
Обработка GIR может занять более 2 минут. Параметры таймаута автоматически расширяются до 200 секунд, если параметры таймаута пользователя недостаточны.

Примечание

Этот модуль имеет соответствующий плагин действий.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
provider словарь			Устарело Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli`. Начиная с Ansible 2.6 рекомендуется использовать `connection: httpapi` для NX-API. Этот параметр будет удалён в выпуске после 2022-06-01. Дополнительную информацию см. в руководстве NXOS Platform Options. Объект словаря, содержащий сведения о подключении.
	auth_pass строка		Указывает пароль для использования при необходимости входа в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	authorize логический тип	Варианты: нет ← да	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
	host строка		Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
	password строка		Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port целое число		Указывает порт для подключения к удалённому устройству. Это значение применимо к транспорту cli или nxapi. Значение порта по умолчанию соответствует общему порту транспорта, если он не задан в задаче (cli=22, http=80, https=443).
	ssh_keyfile строка		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число		Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при длительных командах (sh mac, sh bgp и т.д.).
	transport строка	Варианты: cli ← nxapi	Настраивает транспортное подключение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy логический тип	Варианты: нет да ←	Если `no`, переменные среды `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl логический тип	Варианты: нет ← да	Настраивает transport для использования SSL, если установлено `yes` только когда `transport=nxapi`, в противном случае это значение игнорируется.
	username строка		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.
	validate_certs логический тип	Варианты: нет ← да	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с самозаверяющими сертификатами. Если аргумент transport не nxapi, это значение игнорируется.
state строка		Варианты: present ← absent	Указывает желаемое состояние ресурса.
system_mode_maintenance логический тип		Варианты: нет да	При значении `system_mode_maintenance=true` помещает все включенные протоколы в режим обслуживания (используя команду isolate). При значении `system_mode_maintenance=false` помещает все включенные протоколы в нормальный режим (используя команду no isolate).
system_mode_maintenance_dont_generate_profile логический тип		Варианты: нет да	При значении `system_mode_maintenance_dont_generate_profile=true` предотвращает динамический поиск включенных протоколов и выполняет команды, настроенные в профиле режима обслуживания. Используйте этот параметр, если хотите, чтобы система использовала профиль режима обслуживания, который вы создали. При значении `system_mode_maintenance_dont_generate_profile=false` предотвращает динамический поиск включенных протоколов и выполняет команды, настроенные в профиле нормального режима. Используйте этот параметр, если хотите, чтобы система использовала профиль нормального режима, который вы создали.
system_mode_maintenance_on_reload_reset_reason строка		Варианты: hw_error svc_failure kern_failure wdog_timeout fatal_error lc_failure match_any manual_reload any_other maintenance	Автоматически запускает коммутатор в режим обслуживания в случае указанной системной ошибки. Обратите внимание, что не все причины перезапуска применимы ко всем платформам. Также, если причина перезапуска установлена в match_any, она не идемпотентна, так как включает все причины перезапуска. Если причина перезапуска match_any, а состояние absent, она отключает все причины перезапуска.
system_mode_maintenance_shutdown логический тип		Варианты: нет да	Отключает все протоколы, домены vPC и интерфейсы, за исключением интерфейса управления (используя команду shutdown). Этот параметр более разрушителен, чем `system_mode_maintenance` (использующий команду isolate).
system_mode_maintenance_timeout строка			Удерживает коммутатор в режиме обслуживания в течение указанного количества минут. Диапазон от 5 до 65535.

Примечания

Примечание

Проверено на NXOSv 7.3.(0)D1(1) на VIRL
state действует только в сочетании с system_mode_maintenance_timeout или system_mode_maintenance_on_reload_reset_reason.
Использование system_mode_maintenance и system_mode_maintenance_dont_generate_profile приведёт к сбою модуля, но режим системы всё равно будет активирован.
Дополнительную информацию по использованию CLI и NX-API см. в руководстве NXOS Platform Options
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

# Trigger system maintenance mode
- cisco.nxos.nxos_gir:
    system_mode_maintenance: true
    host: '{{ inventory_hostname }}'
    username: '{{ un }}'
    password: '{{ pwd }}'
# Trigger system normal mode
- cisco.nxos.nxos_gir:
    system_mode_maintenance: false
    host: '{{ inventory_hostname }}'
    username: '{{ un }}'
    password: '{{ pwd }}'
# Configure on-reload reset-reason for maintenance mode
- cisco.nxos.nxos_gir:
    system_mode_maintenance_on_reload_reset_reason: manual_reload
    state: present
    host: '{{ inventory_hostname }}'
    username: '{{ un }}'
    password: '{{ pwd }}'
# Add on-reload reset-reason for maintenance mode
- cisco.nxos.nxos_gir:
    system_mode_maintenance_on_reload_reset_reason: hw_error
    state: present
    host: '{{ inventory_hostname }}'
    username: '{{ un }}'
    password: '{{ pwd }}'
# Remove on-reload reset-reason for maintenance mode
- cisco.nxos.nxos_gir:
    system_mode_maintenance_on_reload_reset_reason: manual_reload
    state: absent
    host: '{{ inventory_hostname }}'
    username: '{{ un }}'
    password: '{{ pwd }}'
# Set timeout for maintenance mode
- cisco.nxos.nxos_gir:
    system_mode_maintenance_timeout: 30
    state: present
    host: '{{ inventory_hostname }}'
    username: '{{ un }}'
    password: '{{ pwd }}'
# Remove timeout for maintenance mode
- cisco.nxos.nxos_gir:
    system_mode_maintenance_timeout: 30
    state: absent
    host: '{{ inventory_hostname }}'
    username: '{{ un }}'
    password: '{{ pwd }}'

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
changed boolean	всегда	проверка внесения изменений на устройстве Пример: True
final_system_mode string	режим подробных сообщений	описание последнего режима системы Пример: normal
updates list / elements=string	режим подробных сообщений	команды, отправленные на устройство Пример: ['terminal dont-ask', 'system mode maintenance timeout 10']

Авторы

Gabriele Gerbino (@GGabriele)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_gir_module.html