Try SpotterTrigger a graceful removal or insertion (GIR) of the switch.
| "added in version" 2.2 of ansible.builtin"
Authors: Gabriele Gerbino (@GGabriele)
preview | supported by network
pipInstall with pip install ansible==2.9.13
Trigger a graceful removal or insertion (GIR) of the switch.
# 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 }}"
state:
choices:
- present
- absent
default: present
description:
- Specify desired state of the resource.
required: true
provider:
description:
- B(Deprecated)
- 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).'
- 'Starting with Ansible 2.6 we recommend using C(connection: httpapi) for NX-API.'
- This option will be removed in a release after 2022-06-01.
- For more information please see the L(NXOS Platform Options guide, ../network/user_guide/platform_nxos.html).
- HORIZONTALLINE
- A dict object containing connection details.
suboptions:
auth_pass:
description:
- Specifies the password to use if required to enter privileged mode on the remote
device. If I(authorize) is false, then this argument does nothing. If the value
is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS)
will be used instead.
type: str
authorize:
default: false
description:
- 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 C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool
host:
description:
- 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.
type: str
password:
description:
- Specifies the password to use to authenticate the connection to the remote device. This
is a common argument used for either I(cli) or I(nxapi) transports. If the value
is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD)
will be used instead.
type: str
port:
description:
- Specifies the port to use when building the connection to the remote device. This
value applies to either I(cli) or I(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).
type: int
ssh_keyfile:
description:
- Specifies the SSH key to use to authenticate the connection to the remote device. This
argument is only used for the I(cli) transport. If the value is not specified
in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will
be used instead.
type: str
timeout:
description:
- 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).
type: int
transport:
choices:
- cli
- nxapi
default: cli
description:
- 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.
type: str
use_proxy:
default: true
description:
- If C(no), the environment variables C(http_proxy) and C(https_proxy) will be
ignored.
type: bool
use_ssl:
default: false
description:
- Configures the I(transport) to use SSL if set to C(yes) only when the C(transport=nxapi),
otherwise this value is ignored.
type: bool
username:
description:
- 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 C(ANSIBLE_NET_USERNAME) will
be used instead.
type: str
validate_certs:
default: false
description:
- If C(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.
type: bool
type: dict
system_mode_maintenance:
description:
- When C(system_mode_maintenance=true) it puts all enabled protocols in maintenance
mode (using the isolate command). When C(system_mode_maintenance=false) it puts
all enabled protocols in normal mode (using the no isolate command).
type: bool
system_mode_maintenance_timeout:
description:
- Keeps the switch in maintenance mode for a specified number of minutes. Range is
5-65535.
system_mode_maintenance_shutdown:
description:
- Shuts down all protocols, vPC domains, and interfaces except the management interface
(using the shutdown command). This option is disruptive while C(system_mode_maintenance)
(which uses the isolate command) is not.
type: bool
system_mode_maintenance_dont_generate_profile:
description:
- When C(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 C(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.
type: bool
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
description:
- 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.
changed: description: check to see if a change was made on the device returned: always sample: true type: bool final_system_mode: description: describe the last system mode returned: verbose mode sample: normal type: str updates: description: commands sent to the device returned: verbose mode sample: - terminal dont-ask - system mode maintenance timeout 10 type: list