Coverage for lib/ansible/modules/network/nxos/nxos_config.py : 50%

#!/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/>. 

# 

ANSIBLE_METADATA = {'metadata_version': '1.1', 

'status': ['preview'], 

'supported_by': 'network'} 

DOCUMENTATION = """ 

--- 

module: nxos_config 

extends_documentation_fragment: nxos 

version_added: "2.1" 

author: "Peter Sprygada (@privateip)" 

short_description: Manage Cisco NXOS configuration sections 

description: 

- Cisco NXOS configurations use a simple block indent file syntax 

for segmenting configuration into sections. This module provides 

an implementation for working with NXOS configuration sections in 

a deterministic way. This module works with either CLI or NXAPI 

transports. 

options: 

lines: 

description: 

- The ordered set of commands that should be configured in the 

section. The commands must be the exact same commands as found 

in the device running-config. Be sure to note the configuration 

command syntax as some commands are automatically modified by the 

device config parser. 

required: false 

default: null 

aliases: ['commands'] 

parents: 

description: 

- The ordered set of parents that uniquely identify the section or hierarchy 

the commands should be checked against. If the parents argument 

is omitted, the commands are checked against the set of top 

level or global commands. 

required: false 

default: null 

src: 

description: 

- The I(src) argument provides a path to the configuration file 

to load into the remote system. The path can either be a full 

system path to the configuration file if the value starts with / 

or relative to the root of the implemented role or playbook. 

This argument is mutually exclusive with the I(lines) and 

I(parents) arguments. 

required: false 

default: null 

version_added: "2.2" 

replace_src: 

description: 

- The I(replace_src) argument provides path to the configuration file 

to load into the remote system. This argument is used to replace the 

entire config with a flat-file. This is used with argument I(replace) 

with value I(config). This is mutually exclusive with the I(lines) and 

I(src) arguments. This argument is supported on Nexus 9K device. 

Use I(nxos_file_copy) module to copy the flat file to remote device and 

then use the path with this argument. 

required: false 

default: null 

version_added: "2.5" 

before: 

description: 

- The ordered set of commands to push on to the command stack if 

a change needs to be made. This allows the playbook designer 

the opportunity to perform configuration commands prior to pushing 

any changes without affecting how the set of commands are matched 

against the system. 

required: false 

default: null 

after: 

description: 

- The ordered set of commands to append to the end of the command 

stack if a change needs to be made. Just like with I(before) this 

allows the playbook designer to append a set of commands to be 

executed after the command set. 

required: false 

default: null 

match: 

description: 

- Instructs the module on the way to perform the matching of 

the set of commands against the current device config. If 

match is set to I(line), commands are matched line by line. If 

match is set to I(strict), command lines are matched with respect 

to position. If match is set to I(exact), command lines 

must be an equal match. Finally, if match is set to I(none), the 

module will not attempt to compare the source configuration with 

the running configuration on the remote device. 

required: false 

default: line 

choices: ['line', 'strict', 'exact', 'none'] 

replace: 

description: 

- Instructs the module on the way to perform the configuration 

on the device. If the replace argument is set to I(line) then 

the modified lines are pushed to the device in configuration 

mode. If the replace argument is set to I(block) then the entire 

command block is pushed to the device in configuration mode if any 

line is not correct. I(replace config) is supported only on Nexus 9K device. 

required: false 

default: line 

choices: ['line', 'block', 'config'] 

force: 

description: 

- The force argument instructs the module to not consider the 

current devices running-config. When set to true, this will 

cause the module to push the contents of I(src) into the device 

without first checking if already configured. 

- Note this argument should be considered deprecated. To achieve 

the equivalent, set the C(match=none) which is idempotent. This argument 

will be removed in a future release. 

required: false 

default: false 

type: bool 

backup: 

description: 

- This argument will cause the module to create a full backup of 

the current C(running-config) from the remote device before any 

changes are made. The backup file is written to the C(backup) 

folder in the playbook root directory. If the directory does not 

exist, it is created. 

required: false 

default: false 

type: bool 

version_added: "2.2" 

running_config: 

description: 

- The module, by default, will connect to the remote device and 

retrieve the current running-config to use as a base for comparing 

against the contents of source. There are times when it is not 

desirable to have the task get the current running-config for 

every task in a playbook. The I(running_config) argument allows the 

implementer to pass in the configuration to use as the base 

config for comparison. 

required: false 

default: null 

aliases: ['config'] 

version_added: "2.4" 

defaults: 

description: 

- The I(defaults) argument will influence how the running-config 

is collected from the device. When the value is set to true, 

the command used to collect the running-config is append with 

the all keyword. When the value is set to false, the command 

is issued without the all keyword 

required: false 

default: false 

type: bool 

version_added: "2.2" 

save: 

description: 

- The C(save) argument instructs the module to save the 

running-config to startup-config. This operation is performed 

after any changes are made to the current running config. If 

no changes are made, the configuration is still saved to the 

startup config. This option will always cause the module to 

return changed. 

- This option is deprecated as of Ansible 2.4, use C(save_when) 

required: false 

default: false 

type: bool 

version_added: "2.2" 

save_when: 

description: 

- When changes are made to the device running-configuration, the 

changes are not copied to non-volatile storage by default. Using 

this argument will change that before. If the argument is set to 

I(always), then the running-config will always be copied to the 

startup-config and the I(modified) flag will always be set to 

True. If the argument is set to I(modified), then the running-config 

will only be copied to the startup-config if it has changed since 

the last save to startup-config. If the argument is set to 

I(never), the running-config will never be copied to the 

startup-config 

required: false 

default: never 

choices: ['always', 'never', 'modified'] 

version_added: "2.4" 

diff_against: 

description: 

- When using the C(ansible-playbook --diff) command line argument 

the module can generate diffs against different sources. 

- When this option is configure as I(startup), the module will return 

the diff of the running-config against the startup-config. 

- When this option is configured as I(intended), the module will 

return the diff of the running-config against the configuration 

provided in the C(intended_config) argument. 

- When this option is configured as I(running), the module will 

return the before and after diff of the running-config with respect 

to any changes made to the device configuration. 

required: false 

default: startup 

choices: ['startup', 'intended', 'running'] 

version_added: "2.4" 

diff_ignore_lines: 

description: 

- Use this argument to specify one or more lines that should be 

ignored during the diff. This is used for lines in the configuration 

that are automatically updated by the system. This argument takes 

a list of regular expressions or exact line matches. 

required: false 

version_added: "2.4" 

intended_config: 

description: 

- The C(intended_config) provides the master configuration that 

the node should conform to and is used to check the final 

running-config against. This argument will not modify any settings 

on the remote device and is strictly used to check the compliance 

of the current device's configuration against. When specifying this 

argument, the task should also modify the C(diff_against) value and 

set it to I(intended). 

required: false 

version_added: "2.4" 

""" 

EXAMPLES = """ 

--- 

- name: configure top level configuration and save it 

nxos_config: 

lines: hostname {{ inventory_hostname }} 

save_when: modified 

- name: diff the running-config against a provided config 

nxos_config: 

diff_against: intended 

intended_config: "{{ lookup('file', 'master.cfg') }}" 

- nxos_config: 

lines: 

- 10 permit ip 1.1.1.1/32 any log 

- 20 permit ip 2.2.2.2/32 any log 

- 30 permit ip 3.3.3.3/32 any log 

- 40 permit ip 4.4.4.4/32 any log 

- 50 permit ip 5.5.5.5/32 any log 

parents: ip access-list test 

before: no ip access-list test 

match: exact 

- nxos_config: 

lines: 

- 10 permit ip 1.1.1.1/32 any log 

- 20 permit ip 2.2.2.2/32 any log 

- 30 permit ip 3.3.3.3/32 any log 

- 40 permit ip 4.4.4.4/32 any log 

parents: ip access-list test 

before: no ip access-list test 

replace: block 

- name: replace config with flat file 

nxos_config: 

replace_src: config.txt 

replace: config 

""" 

RETURN = """ 

commands: 

description: The set of commands that will be pushed to the remote device 

returned: always 

type: list 

sample: ['hostname foo', 'vlan 1', 'name default'] 

updates: 

description: The set of commands that will be pushed to the remote device 

returned: always 

type: list 

sample: ['hostname foo', 'vlan 1', 'name default'] 

backup_path: 

description: The full path to the backup file 

returned: when backup is yes 

type: string 

sample: /playbooks/ansible/backup/nxos_config.2016-07-16@22:28:34 

""" 

from ansible.module_utils.basic import AnsibleModule 

from ansible.module_utils.connection import ConnectionError 

from ansible.module_utils.network.common.config import NetworkConfig, dumps 

from ansible.module_utils.network.nxos.nxos import get_config, load_config, run_commands 

from ansible.module_utils.network.nxos.nxos import get_capabilities 

from ansible.module_utils.network.nxos.nxos import nxos_argument_spec 

from ansible.module_utils.network.nxos.nxos import check_args as nxos_check_args 

from ansible.module_utils.network.common.utils import to_list 

def get_running_config(module, config=None): 

contents = module.params['running_config'] 

304 ↛ 310line 304 didn't jump to line 310, because the condition on line 304 was never false if not contents: 

if not module.params['defaults'] and config: 

contents = config 

else: 

flags = ['all'] 

contents = get_config(module, flags=flags) 

return NetworkConfig(indent=2, contents=contents) 

def get_candidate(module): 

candidate = NetworkConfig(indent=2) 

315 ↛ 316line 315 didn't jump to line 316, because the condition on line 315 was never true if module.params['src']: 

if module.params['replace'] != 'config': 

candidate.load(module.params['src']) 

318 ↛ 319line 318 didn't jump to line 319, because the condition on line 318 was never true if module.params['replace'] == 'config': 

candidate.load('config replace {0}'.format(module.params['replace_src'])) 

320 ↛ 323line 320 didn't jump to line 323, because the condition on line 320 was never false elif module.params['lines']: 

parents = module.params['parents'] or list() 

candidate.add(module.params['lines'], parents=parents) 

return candidate 

def execute_show_commands(module, commands, output='text'): 

cmds = [] 

for command in to_list(commands): 

cmd = {'command': command, 

'output': output, 

} 

cmds.append(cmd) 

body = run_commands(module, cmds) 

return body 

def main(): 

""" main entry point for module execution 

""" 

argument_spec = dict( 

src=dict(type='path'), 

replace_src=dict(), 

lines=dict(aliases=['commands'], type='list'), 

parents=dict(type='list'), 

before=dict(type='list'), 

after=dict(type='list'), 

match=dict(default='line', choices=['line', 'strict', 'exact', 'none']), 

replace=dict(default='line', choices=['line', 'block', 'config']), 

running_config=dict(aliases=['config']), 

intended_config=dict(), 

defaults=dict(type='bool', default=False), 

backup=dict(type='bool', default=False), 

save_when=dict(choices=['always', 'never', 'modified'], default='never'), 

diff_against=dict(choices=['running', 'startup', 'intended']), 

diff_ignore_lines=dict(type='list'), 

# save is deprecated as of ans2.4, use save_when instead 

save=dict(default=False, type='bool', removed_in_version='2.4'), 

# force argument deprecated in ans2.2 

force=dict(default=False, type='bool', removed_in_version='2.2') 

) 

argument_spec.update(nxos_argument_spec) 

mutually_exclusive = [('lines', 'src', 'replace_src'), 

('parents', 'src'), 

('save', 'save_when')] 

required_if = [('match', 'strict', ['lines']), 

('match', 'exact', ['lines']), 

('replace', 'block', ['lines']), 

('replace', 'config', ['replace_src']), 

('diff_against', 'intended', ['intended_config'])] 

module = AnsibleModule(argument_spec=argument_spec, 

mutually_exclusive=mutually_exclusive, 

required_if=required_if, 

supports_check_mode=True) 

warnings = list() 

nxos_check_args(module, warnings) 

result = {'changed': False, 'warnings': warnings} 

config = None 

try: 

info = get_capabilities(module) 

api = info.get('network_api', 'nxapi') 

device_info = info.get('device_info', {}) 

os_platform = device_info.get('network_os_platform', '') 

except ConnectionError: 

api = '' 

os_platform = '' 

403 ↛ 404line 403 didn't jump to line 404, because the condition on line 403 was never true if api == 'cliconf' and module.params['replace'] == 'config': 

if '9K' not in os_platform: 

module.fail_json(msg='replace: config is supported only on Nexus 9K series switches') 

407 ↛ 408line 407 didn't jump to line 408, because the condition on line 407 was never true if module.params['replace_src']: 

if module.params['replace'] != 'config': 

module.fail_json(msg='replace: config is required with replace_src') 

if module.params['backup'] or (module._diff and module.params['diff_against'] == 'running'): 

contents = get_config(module) 

config = NetworkConfig(indent=2, contents=contents) 

414 ↛ 417line 414 didn't jump to line 417, because the condition on line 414 was never false if module.params['backup']: 

result['__backup__'] = contents 

417 ↛ 447line 417 didn't jump to line 447, because the condition on line 417 was never false if any((module.params['src'], module.params['lines'], module.params['replace_src'])): 

match = module.params['match'] 

replace = module.params['replace'] 

candidate = get_candidate(module) 

if match != 'none' and replace != 'config': 

config = get_running_config(module, config) 

path = module.params['parents'] 

configobjs = candidate.difference(config, match=match, replace=replace, path=path) 

else: 

configobjs = candidate.items 

if configobjs: 

commands = dumps(configobjs, 'commands').split('\n') 

433 ↛ 434line 433 didn't jump to line 434, because the condition on line 433 was never true if module.params['before']: 

commands[:0] = module.params['before'] 

436 ↛ 437line 436 didn't jump to line 437, because the condition on line 436 was never true if module.params['after']: 

commands.extend(module.params['after']) 

result['commands'] = commands 

result['updates'] = commands 

442 ↛ 445line 442 didn't jump to line 445, because the condition on line 442 was never false if not module.check_mode: 

load_config(module, commands) 

result['changed'] = True 

running_config = None 

startup_config = None 

diff_ignore_lines = module.params['diff_ignore_lines'] 

452 ↛ 453line 452 didn't jump to line 453, because the condition on line 452 was never true if module.params['save']: 

module.params['save_when'] = 'always' 

455 ↛ 456line 455 didn't jump to line 456, because the condition on line 455 was never true if module.params['save_when'] != 'never': 

output = execute_show_commands(module, ['show running-config', 'show startup-config']) 

running_config = NetworkConfig(indent=1, contents=output[0], ignore_lines=diff_ignore_lines) 

startup_config = NetworkConfig(indent=1, contents=output[1], ignore_lines=diff_ignore_lines) 

if running_config.sha1 != startup_config.sha1 or module.params['save_when'] == 'always': 

result['changed'] = True 

if not module.check_mode: 

cmd = {'command': 'copy running-config startup-config', 'output': 'text'} 

run_commands(module, [cmd]) 

else: 

module.warn('Skipping command `copy running-config startup-config` ' 

'due to check_mode. Configuration not copied to ' 

'non-volatile storage') 

471 ↛ 472line 471 didn't jump to line 472, because the condition on line 471 was never true if module._diff: 

if not running_config: 

output = execute_show_commands(module, 'show running-config') 

contents = output[0] 

else: 

contents = running_config.config_text 

# recreate the object in order to process diff_ignore_lines 

running_config = NetworkConfig(indent=1, contents=contents, ignore_lines=diff_ignore_lines) 

if module.params['diff_against'] == 'running': 

if module.check_mode: 

module.warn("unable to perform diff against running-config due to check mode") 

contents = None 

else: 

contents = config.config_text 

elif module.params['diff_against'] == 'startup': 

if not startup_config: 

output = execute_show_commands(module, 'show startup-config') 

contents = output[0] 

else: 

contents = output[0] 

contents = startup_config.config_text 

elif module.params['diff_against'] == 'intended': 

contents = module.params['intended_config'] 

if contents is not None: 

base_config = NetworkConfig(indent=1, contents=contents, ignore_lines=diff_ignore_lines) 

if running_config.sha1 != base_config.sha1: 

if module.params['diff_against'] == 'intended': 

before = running_config 

after = base_config 

elif module.params['diff_against'] in ('startup', 'running'): 

before = base_config 

after = running_config 

result.update({ 

'changed': True, 

'diff': {'before': str(before), 'after': str(after)} 

}) 

module.exit_json(**result) 

518 ↛ exitline 518 didn't exit the module, because the condition on line 518 was never falseif __name__ == '__main__': 

main()