модуль cisco.nxos.nxos_gir — Запуск безопасного отключения или включения коммутатора (GIR).

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: cisco.nxos.nxos_gir.

Добавлено в cisco.nxos 1.0.0

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

Краткое описание

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

Примечание

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

Псевдонимы: gir

Параметры

Параметр	Комментарии
state string	Укажите требуемое состояние ресурса. Варианты: `"present"` ← (по умолчанию) `"absent"`
system_mode_maintenance boolean	Если `system_mode_maintenance=true`, переводит все включённые протоколы в режим обслуживания (с помощью команды isolate). Если `system_mode_maintenance=false`, переводит все включённые протоколы в обычный режим (с помощью команды no isolate). Варианты: `false` `true`
system_mode_maintenance_dont_generate_profile boolean	Если `system_mode_maintenance_dont_generate_profile=true`, предотвращает динамический поиск включённых протоколов и выполняет команды, настроенные в профиле режима обслуживания. Используйте этот параметр, если хотите, чтобы система применяла созданный вами профиль режима обслуживания. Если `system_mode_maintenance_dont_generate_profile=false`, предотвращает динамический поиск включённых протоколов и выполняет команды, настроенные в профиле обычного режима. Используйте этот параметр, если хотите, чтобы система применяла созданный вами профиль обычного режима. Варианты: `false` `true`
system_mode_maintenance_on_reload_reset_reason string	Автоматически загружает коммутатор в режиме обслуживания при возникновении указанного сбоя системы. Обратите внимание, что не все причины сброса применимы ко всем платформам. Кроме того, если для причины сброса задано значение match_any, параметр не является идемпотентным, поскольку включает все причины сброса. Если для причины сброса задано значение match_any, а состояние — absent, все причины сброса отключаются. Варианты: `"hw_error"` `"svc_failure"` `"kern_failure"` `"wdog_timeout"` `"fatal_error"` `"lc_failure"` `"match_any"` `"manual_reload"` `"any_other"` `"maintenance"`
system_mode_maintenance_shutdown boolean	Отключает все протоколы, домены vPC и интерфейсы, кроме интерфейса управления (с помощью команды shutdown). Этот параметр вызывает перебои в работе, в отличие от `system_mode_maintenance` (который использует команду isolate). Варианты: `false` `true`
system_mode_maintenance_timeout string	Оставляет коммутатор в режиме обслуживания на указанное количество минут. Диапазон: 5–65535.

Примечания

Примечание

Тестирование выполнено на NXOSv 7.3.(0)D1(1) в VIRL
Не поддерживается на Cisco MDS
state действует только в сочетании с system_mode_maintenance_timeout или system_mode_maintenance_on_reload_reset_reason.
Использование system_mode_maintenance и system_mode_maintenance_dont_generate_profile приведёт к сбою модуля, однако режим системы всё равно будет активирован.
Сведения об использовании CLI и NX-API см. в :ref:`руководстве по параметрам платформы NXOS <nxos_platform_options>`
Дополнительные сведения об использовании Ansible для управления сетевыми устройствами см. в :ref:`руководстве по сетям Ansible <network_guide>`
Дополнительные сведения об использовании Ansible для управления устройствами Cisco см. на `странице интеграции Cisco <https://www.ansible.com/integrations/networks/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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/nxos/nxos_gir_module.html