cisco.nxos.nxos_gir – Запуск плавной процедуры удаления или вставки (GIR) коммутатора.

Примечание

Этот плагин является частью коллекции cisco.nxos (версия 1.3.1).

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

Для использования в playbook, укажите: 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. Объект dict, содержащий данные подключения.
	auth_pass строка		Указывает пароль, который необходимо использовать для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, то этот аргумент ничего не делает. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `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 и state равно 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
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. руководство по сети Ansible
Для получения дополнительной информации об использовании 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/nxos/nxos_gir_module.html