summaryrefslogtreecommitdiffstats
path: root/ansible_collections/cisco/nxos/plugins/modules/nxos_reboot.py
blob: 51d0d70af012041e644387c897656788165040fd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
#!/usr/bin/python
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
#
from __future__ import absolute_import, division, print_function


__metaclass__ = type


DOCUMENTATION = """
module: nxos_reboot
extends_documentation_fragment:
- cisco.nxos.nxos
short_description: Reboot a network device.
description:
- Reboot a network device.
version_added: 1.0.0
author:
- Jason Edelman (@jedelman8)
- Gabriele Gerbino (@GGabriele)
notes:
- 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.
options:
  confirm:
    description:
    - Safeguard boolean. Set to true if you're sure you want to reboot.
    required: false
    default: false
    type: bool
"""

EXAMPLES = """
- cisco.nxos.nxos_reboot:
    confirm: true
"""

RETURN = """
rebooted:
    description: Whether the device was instructed to reboot.
    returned: success
    type: bool
    sample: true
"""

from ansible.module_utils.basic import AnsibleModule

from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.nxos import load_config


def reboot(module):
    cmds = "terminal dont-ask ; reload"
    opts = {"ignore_timeout": True}
    load_config(module, cmds, False, opts)


def main():
    argument_spec = dict(confirm=dict(default=False, type="bool"))

    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)

    warnings = list()
    results = dict(changed=False, warnings=warnings)

    if module.params["confirm"]:
        if not module.check_mode:
            reboot(module)
        results["changed"] = True

    module.exit_json(**results)


if __name__ == "__main__":
    main()