cisco.nxos.nxos_gir – Trigger a graceful removal or insertion (GIR) of the switch.¶
Note
This plugin is part of the cisco.nxos collection (version 1.4.0).
To install it use: ansible-galaxy collection install cisco.nxos
.
To use it in a playbook, specify: cisco.nxos.nxos_gir
.
New in version 1.0.0: of cisco.nxos
Synopsis¶
Trigger a graceful removal or insertion (GIR) of the switch.
GIR processing may take more than 2 minutes. Timeout settings are automatically extended to 200s when user timeout settings are insufficient.
Note
This module has a corresponding action plugin.
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
provider
dictionary
|
Deprecated
Starting with Ansible 2.5 we recommend using
connection: network_cli .Starting with Ansible 2.6 we recommend using
connection: httpapi for NX-API.This option will be removed in a release after 2022-06-01.
For more information please see the NXOS Platform Options guide.
A dict object containing connection details.
|
||
auth_pass
string
|
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
|
|
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
|
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
|
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
|
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
|
|
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
|
|
If
no , the environment variables http_proxy and https_proxy will be ignored. |
|
use_ssl
boolean
|
|
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
|
|
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
string
|
|
Specify desired state of the resource.
|
|
system_mode_maintenance
boolean
|
|
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
|
|
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
string
|
|
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
|
|
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
string
|
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 withsystem_mode_maintenance_timeout
orsystem_mode_maintenance_on_reload_reset_reason
.Using
system_mode_maintenance
andsystem_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
- 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 }}'
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Gabriele Gerbino (@GGabriele)