297 lines
8.3 KiB
Python
297 lines
8.3 KiB
Python
#!/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/>.
|
|
#
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: nxos_reboot
|
|
version_added: 2.2
|
|
short_description: Reboot a network device.
|
|
description:
|
|
- Reboot a network device
|
|
extends_documentation_fragment: nxos
|
|
author:
|
|
- Jason Edelman (@jedelman8)
|
|
- Gabriele Gerbino (@GGabriele)
|
|
notes:
|
|
- 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
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- nxos_reboot:
|
|
confirm: true
|
|
host: "{{ inventory_hostname }}"
|
|
username: "{{ username }}"
|
|
password: "{{ password }}"
|
|
'''
|
|
|
|
RETURN = '''
|
|
rebooted:
|
|
description: Whether the device was instructed to reboot.
|
|
returned: success
|
|
type: boolean
|
|
sample: true
|
|
'''
|
|
|
|
import json
|
|
import collections
|
|
|
|
# COMMON CODE FOR MIGRATION
|
|
import re
|
|
|
|
from ansible.module_utils.basic import get_exception
|
|
from ansible.module_utils.netcfg import NetworkConfig, ConfigLine
|
|
from ansible.module_utils.shell import ShellError
|
|
|
|
try:
|
|
from ansible.module_utils.nxos import get_module
|
|
except ImportError:
|
|
from ansible.module_utils.nxos import NetworkModule
|
|
|
|
|
|
def to_list(val):
|
|
if isinstance(val, (list, tuple)):
|
|
return list(val)
|
|
elif val is not None:
|
|
return [val]
|
|
else:
|
|
return list()
|
|
|
|
|
|
class CustomNetworkConfig(NetworkConfig):
|
|
|
|
def expand_section(self, configobj, S=None):
|
|
if S is None:
|
|
S = list()
|
|
S.append(configobj)
|
|
for child in configobj.children:
|
|
if child in S:
|
|
continue
|
|
self.expand_section(child, S)
|
|
return S
|
|
|
|
def get_object(self, path):
|
|
for item in self.items:
|
|
if item.text == path[-1]:
|
|
parents = [p.text for p in item.parents]
|
|
if parents == path[:-1]:
|
|
return item
|
|
|
|
def to_block(self, section):
|
|
return '\n'.join([item.raw for item in section])
|
|
|
|
def get_section(self, path):
|
|
try:
|
|
section = self.get_section_objects(path)
|
|
return self.to_block(section)
|
|
except ValueError:
|
|
return list()
|
|
|
|
def get_section_objects(self, path):
|
|
if not isinstance(path, list):
|
|
path = [path]
|
|
obj = self.get_object(path)
|
|
if not obj:
|
|
raise ValueError('path does not exist in config')
|
|
return self.expand_section(obj)
|
|
|
|
|
|
def add(self, lines, parents=None):
|
|
"""Adds one or lines of configuration
|
|
"""
|
|
|
|
ancestors = list()
|
|
offset = 0
|
|
obj = None
|
|
|
|
## global config command
|
|
if not parents:
|
|
for line in to_list(lines):
|
|
item = ConfigLine(line)
|
|
item.raw = line
|
|
if item not in self.items:
|
|
self.items.append(item)
|
|
|
|
else:
|
|
for index, p in enumerate(parents):
|
|
try:
|
|
i = index + 1
|
|
obj = self.get_section_objects(parents[:i])[0]
|
|
ancestors.append(obj)
|
|
|
|
except ValueError:
|
|
# add parent to config
|
|
offset = index * self.indent
|
|
obj = ConfigLine(p)
|
|
obj.raw = p.rjust(len(p) + offset)
|
|
if ancestors:
|
|
obj.parents = list(ancestors)
|
|
ancestors[-1].children.append(obj)
|
|
self.items.append(obj)
|
|
ancestors.append(obj)
|
|
|
|
# add child objects
|
|
for line in to_list(lines):
|
|
# check if child already exists
|
|
for child in ancestors[-1].children:
|
|
if child.text == line:
|
|
break
|
|
else:
|
|
offset = len(parents) * self.indent
|
|
item = ConfigLine(line)
|
|
item.raw = line.rjust(len(line) + offset)
|
|
item.parents = ancestors
|
|
ancestors[-1].children.append(item)
|
|
self.items.append(item)
|
|
|
|
|
|
def get_network_module(**kwargs):
|
|
try:
|
|
return get_module(**kwargs)
|
|
except NameError:
|
|
return NetworkModule(**kwargs)
|
|
|
|
def get_config(module, include_defaults=False):
|
|
config = module.params['config']
|
|
if not config:
|
|
try:
|
|
config = module.get_config()
|
|
except AttributeError:
|
|
defaults = module.params['include_defaults']
|
|
config = module.config.get_config(include_defaults=defaults)
|
|
return CustomNetworkConfig(indent=2, contents=config)
|
|
|
|
def load_config(module, candidate):
|
|
config = get_config(module)
|
|
|
|
commands = candidate.difference(config)
|
|
commands = [str(c).strip() for c in commands]
|
|
|
|
save_config = module.params['save']
|
|
|
|
result = dict(changed=False)
|
|
|
|
if commands:
|
|
if not module.check_mode:
|
|
try:
|
|
module.configure(commands)
|
|
except AttributeError:
|
|
module.config(commands)
|
|
|
|
if save_config:
|
|
try:
|
|
module.config.save_config()
|
|
except AttributeError:
|
|
module.execute(['copy running-config startup-config'])
|
|
|
|
result['changed'] = True
|
|
result['updates'] = commands
|
|
|
|
return result
|
|
# END OF COMMON CODE
|
|
|
|
|
|
|
|
def reboot(module):
|
|
disable_confirmation(module)
|
|
execute_show_command(['reload'], module, command_type='cli_show_ascii')
|
|
|
|
|
|
def execute_show(cmds, module, command_type=None):
|
|
command_type_map = {
|
|
'cli_show': 'json',
|
|
'cli_show_ascii': 'text'
|
|
}
|
|
|
|
try:
|
|
if command_type:
|
|
response = module.execute(cmds, command_type=command_type)
|
|
else:
|
|
response = module.execute(cmds)
|
|
except ShellError:
|
|
clie = get_exception()
|
|
module.fail_json(msg='Error sending {0}'.format(cmds),
|
|
error=str(clie))
|
|
except AttributeError:
|
|
try:
|
|
if command_type:
|
|
command_type = command_type_map.get(command_type)
|
|
module.cli.add_commands(cmds, output=command_type)
|
|
response = module.cli.run_commands()
|
|
else:
|
|
module.cli.add_commands(cmds, output=command_type)
|
|
response = module.cli.run_commands()
|
|
except ShellError:
|
|
clie = get_exception()
|
|
module.fail_json(msg='Error sending {0}'.format(cmds),
|
|
error=str(clie))
|
|
return response
|
|
|
|
|
|
def execute_show_command(command, module, command_type='cli_show'):
|
|
if module.params['transport'] == 'cli':
|
|
body = execute_show(command, module)
|
|
elif module.params['transport'] == 'nxapi':
|
|
body = execute_show(command, module, command_type=command_type)
|
|
|
|
return body
|
|
|
|
|
|
def disable_confirmation(module):
|
|
command = ['terminal dont-ask']
|
|
body = execute_show_command(command, module, command_type='cli_show_ascii')[0]
|
|
|
|
|
|
def main():
|
|
argument_spec = dict(
|
|
confirm=dict(required=True, type='bool'),
|
|
include_defaults=dict(default=False),
|
|
config=dict(),
|
|
save=dict(type='bool', default=False)
|
|
)
|
|
module = get_network_module(argument_spec=argument_spec,
|
|
supports_check_mode=True)
|
|
|
|
confirm = module.params['confirm']
|
|
if not confirm:
|
|
module.fail_json(msg='confirm must be set to true for this '
|
|
'module to work.')
|
|
|
|
changed = False
|
|
rebooted = False
|
|
|
|
reboot(module)
|
|
|
|
changed = True
|
|
rebooted = True
|
|
|
|
results = {}
|
|
results['changed'] = changed
|
|
results['rebooted'] = rebooted
|
|
|
|
module.exit_json(**results)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|