cisco.nxos.nxos_reboot module – Reboot a network device.

Note

This module is part of the cisco.nxos collection (version 4.4.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.nxos.

To use it in a playbook, specify: cisco.nxos.nxos_reboot.

New in cisco.nxos 1.0.0

Synopsis

  • Reboot a network device.

Note

This module has a corresponding action plugin.

Parameters

Parameter

Comments

confirm

boolean

Safeguard boolean. Set to true if you’re sure you want to reboot.

Choices:

  • false ← (default)

  • true

Notes

Note

  • Tested against NXOSv 7.3.(0)D1(1) on VIRL

  • Tested against Cisco MDS NX-OS 9.2(1)

  • The module will fail due to timeout issues, but the reboot will be performed anyway.

  • For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`

  • For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`

  • For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.

Examples

- cisco.nxos.nxos_reboot:
    confirm: true

Return Values

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

Key

Description

rebooted

boolean

Whether the device was instructed to reboot.

Returned: success

Sample: true

Authors

  • Jason Edelman (@jedelman8)

  • Gabriele Gerbino (@GGabriele)