nxos_gir - Trigger a graceful removal or insertion (GIR) of the switch.
New in version 2.2.
Synopsis
- Trigger a graceful removal or insertion (GIR) of the switch.
Options
parameter | required | default | choices | comments |
---|---|---|---|---|
auth_pass (added in 2.4.4)
| no | none | 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 (added in 2.4.4)
| no |
| 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 | yes | 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 | no | 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 | no | 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). | |
provider | no | Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict. | ||
ssh_keyfile | no | 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. | ||
state | yes | present |
| Specify desired state of the resource. |
system_mode_maintenance | no |
| 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 | no |
| 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 | no |
| Boots the switch into maintenance mode automatically in the event of a specified system crash. | |
system_mode_maintenance_shutdown | no |
| 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 | no | Keeps the switch in maintenance mode for a specified number of minutes. Range is 5-65535. | ||
timeout (added in 2.3)
| no | 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 | yes | cli | 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_ssl | no |
| Configures the transport to use SSL if set to true only when the transport=nxapi , otherwise this value is ignored. | |
username | no | 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 | no |
| 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. |
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 Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
changed | check to see if a change was made on the device | always | boolean | True |
final_system_mode | describe the last system mode | verbose mode | string | normal |
updates | commands sent to the device | verbose mode | list | ['terminal dont-ask', 'system mode maintenance timeout 10'] |
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.
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance Info
For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_gir_module.html