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

Примечание

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

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

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

Для использования в playbook, укажите: 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, а состояние отсутствует, она отключает все причины сброса. Варианты: `"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/nxos/nxos_gir_module.html