cisco.nxos.nxos_gir 模块 – 触发交换机的优雅移除或插入 (GIR)。

注意

此模块是 cisco.nxos 集合（版本 9.2.1）的一部分。

如果您正在使用 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 秒。

参数 

参数	注释
state 字符串	指定资源的期望状态。选项 `"present"` ← (默认) `"absent"`
system_mode_maintenance 布尔值	当 `system_mode_maintenance=true` 时，它会将所有启用的协议置于维护模式（使用 isolate 命令）。当 `system_mode_maintenance=false` 时，它会将所有启用的协议置于正常模式（使用 no isolate 命令）。选项 `false` `true`
system_mode_maintenance_dont_generate_profile 布尔值	当 `system_mode_maintenance_dont_generate_profile=true` 时，它会阻止动态搜索已启用的协议，并执行在维护模式配置文件中配置的命令。如果要系统使用您创建的维护模式配置文件，请使用此选项。当 `system_mode_maintenance_dont_generate_profile=false` 时，它会阻止动态搜索已启用的协议，并执行在正常模式配置文件中配置的命令。如果要系统使用您创建的正常模式配置文件，请使用此选项。选项 `false` `true`
system_mode_maintenance_on_reload_reset_reason 字符串	在发生指定的系统崩溃时，自动将交换机引导到维护模式。请注意，并非所有重置原因都适用于所有平台。此外，如果重置原因设置为 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 布尔值	关闭所有协议、vPC 域和接口（管理接口除外）（使用 shutdown 命令）。此选项具有破坏性，而 `system_mode_maintenance`（使用 isolate 命令）则不然。选项 `false` `true`
system_mode_maintenance_timeout 字符串	使交换机在维护模式下保持指定的分钟数。范围是 5-65535。

注释 

注意

在 VIRL 上针对 NXOSv 7.3.(0)D1(1) 进行了测试
不支持 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://ansible.org.cn/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 }}'

返回值 

此处记录了常见的返回值 here，以下是此模块特有的字段

键	描述
changed 布尔值	检查设备是否进行了更改返回：总是示例： `true`
final_system_mode 字符串	描述最后一个系统模式返回：详细模式示例： `"normal"`
更新列表 / 元素类型=字符串	发送到设备的命令返回：详细模式示例: `["terminal dont-ask", "system mode maintenance timeout 10"]`

作者

Gabriele Gerbino (@GGabriele)