nxos_gir – Trigger a graceful removal or insertion (GIR) of the switch — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# nxos_gir – Trigger a graceful removal or insertion (GIR) of the switch

New in version 2.2.

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Trigger a graceful removal or insertion (GIR) of the switch.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
provider dictionary |  | Deprecated Starting with Ansible 2.5 we recommend using `connection: network_cli`. This option is only required if you are using NX-API. For more information please see the NXOS Platform Options guide. A dict object containing connection details.
| auth_pass string added in 2.5.3 |  | Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_AUTH_PASS` will be used instead.
| authorize boolean added in 2.5.3 | Choices: no ← yes | Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_AUTHORIZE` will be used instead.
| host string / required |  | Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
| password string |  | Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead.
| port integer | Default: "0 (use common port)" | Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443).
| ssh_keyfile string |  | Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_SSH_KEYFILE` will be used instead.
| timeout integer added in 2.3 | Default: 10 | Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc).
| transport string / required | Choices: cli ← nxapi | Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi.
| use_proxy boolean added in 2.5 | Choices: no yes ← | If `no`, the environment variables `http_proxy` and `https_proxy` will be ignored.
| use_ssl boolean | Choices: no ← yes | Configures the transport to use SSL if set to `yes` only when the `transport=nxapi`, otherwise this value is ignored.
| username string |  | Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead.
| validate_certs boolean | Choices: no yes ← | If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored.
state - / required | Choices: present ← absent | Specify desired state of the resource.
system_mode_maintenance boolean | Choices: no yes | When `system_mode_maintenance=true` it puts all enabled protocols in maintenance mode (using the isolate command). When `system_mode_maintenance=false` it puts all enabled protocols in normal mode (using the no isolate command).
system_mode_maintenance_dont_generate_profile boolean | Choices: no yes | When `system_mode_maintenance_dont_generate_profile=true` it prevents the dynamic searching of enabled protocols and executes commands configured in a maintenance-mode profile. Use this option if you want the system to use a maintenance-mode profile that you have created. When `system_mode_maintenance_dont_generate_profile=false` it prevents the dynamic searching of enabled protocols and executes commands configured in a normal-mode profile. Use this option if you want the system to use a normal-mode profile that you have created.
system_mode_maintenance_on_reload_reset_reason - | Choices: hw_error svc_failure kern_failure wdog_timeout fatal_error lc_failure match_any manual_reload any_other maintenance | Boots the switch into maintenance mode automatically in the event of a specified system crash. Note that not all reset reasons are applicable for all platforms. Also if reset reason is set to match_any, it is not idempotent as it turns on all reset reasons. If reset reason is match_any and state is absent, it turns off all the reset reasons.
system_mode_maintenance_shutdown boolean | Choices: no yes | Shuts down all protocols, vPC domains, and interfaces except the management interface (using the shutdown command). This option is disruptive while `system_mode_maintenance` (which uses the isolate command) is not.
system_mode_maintenance_timeout - |  | Keeps the switch in maintenance mode for a specified number of minutes. Range is 5-65535.

## Notes

Note

- Tested against NXOSv 7.3.(0)D1(1) on VIRL
- `state` has effect only in combination with `system_mode_maintenance_timeout` or `system_mode_maintenance_on_reload_reset_reason`.
- Using `system_mode_maintenance` and `system_mode_maintenance_dont_generate_profile` would make the module fail, but the system mode will be triggered anyway.
- For information on using CLI and NX-API see the NXOS Platform Options guide
- For more information on using Ansible to manage network devices see the Ansible Network Guide
- For more information on using Ansible to manage Cisco devices see the Cisco integration page.

## Examples

    # Trigger system maintenance mode
    - nxos_gir:
        system_mode_maintenance: true
        host: "{{ inventory_hostname }}"
        username: "{{ un }}"
        password: "{{ pwd }}"
    # Trigger system normal mode
    - nxos_gir:
        system_mode_maintenance: false
        host: "{{ inventory_hostname }}"
        username: "{{ un }}"
        password: "{{ pwd }}"
    # Configure on-reload reset-reason for maintenance mode
    - 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
    - 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
    - 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
    - nxos_gir:
        system_mode_maintenance_timeout: 30
        state: present
        host: "{{ inventory_hostname }}"
        username: "{{ un }}"
        password: "{{ pwd }}"
    # Remove timeout for maintenance mode
    - nxos_gir:
        system_mode_maintenance_timeout: 30
        state: absent
        host: "{{ inventory_hostname }}"
        username: "{{ un }}"
        password: "{{ pwd }}"

## Return Values

Common return values are documented here, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
changed boolean | always | check to see if a change was made on the device Sample: True
final_system_mode string | verbose mode | describe the last system mode Sample: normal
updates list | verbose mode | commands sent to the device Sample: ['terminal dont-ask', 'system mode maintenance timeout 10']

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]

### Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

### Authors

- Gabriele Gerbino (@GGabriele)

Hint

If you notice any issues in this documentation you can edit this document to improve it.