533 lines
20 KiB
Python
533 lines
20 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/>.
|
|
#
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|
'status': ['preview'],
|
|
'supported_by': 'network'}
|
|
|
|
|
|
DOCUMENTATION = """
|
|
---
|
|
module: ios_config
|
|
version_added: "2.1"
|
|
author: "Peter Sprygada (@privateip)"
|
|
short_description: Manage Cisco IOS configuration sections
|
|
description:
|
|
- Cisco IOS configurations use a simple block indent file syntax
|
|
for segmenting configuration into sections. This module provides
|
|
an implementation for working with IOS configuration sections in
|
|
a deterministic way.
|
|
extends_documentation_fragment: ios
|
|
notes:
|
|
- Tested against IOS 15.6
|
|
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
|
|
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:
|
|
- Specifies the source path to the file that contains the configuration
|
|
or configuration template to load. The path to the source file can
|
|
either be the full path on the Ansible control host or a relative
|
|
path from the playbook or role root directory. This argument is mutually
|
|
exclusive with I(lines).
|
|
required: false
|
|
default: null
|
|
version_added: "2.2"
|
|
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.
|
|
required: false
|
|
default: line
|
|
choices: ['line', 'block']
|
|
multiline_delimiter:
|
|
description:
|
|
- This argument is used when pushing a multiline configuration
|
|
element to the IOS device. It specifies the character to use
|
|
as the delimiting character. This only applies to the
|
|
configuration action.
|
|
required: false
|
|
default: "@"
|
|
version_added: "2.3"
|
|
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: no
|
|
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:
|
|
- This argument specifies whether or not to collect all defaults
|
|
when getting the remote device running config. When enabled,
|
|
the module will get the current config by issuing the command
|
|
C(show running-config all).
|
|
required: false
|
|
default: no
|
|
type: bool
|
|
version_added: "2.2"
|
|
save:
|
|
description:
|
|
- The C(save) argument instructs the module to save the running-
|
|
config to the startup-config at the conclusion of the module
|
|
running. If check mode is specified, this argument is ignored.
|
|
- 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
|
|
choices: ['running', 'startup', 'intended']
|
|
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
|
|
ios_config:
|
|
lines: hostname {{ inventory_hostname }}
|
|
|
|
- name: configure interface settings
|
|
ios_config:
|
|
lines:
|
|
- description test interface
|
|
- ip address 172.31.1.1 255.255.255.0
|
|
parents: interface Ethernet1
|
|
|
|
- name: load new acl into device
|
|
ios_config:
|
|
lines:
|
|
- 10 permit ip host 1.1.1.1 any log
|
|
- 20 permit ip host 2.2.2.2 any log
|
|
- 30 permit ip host 3.3.3.3 any log
|
|
- 40 permit ip host 4.4.4.4 any log
|
|
- 50 permit ip host 5.5.5.5 any log
|
|
parents: ip access-list extended test
|
|
before: no ip access-list extended test
|
|
match: exact
|
|
|
|
- name: check the running-config against master config
|
|
ios_config:
|
|
diff_against: intended
|
|
intended_config: "{{ lookup('file', 'master.cfg') }}"
|
|
|
|
- name: check the startup-config against the running-config
|
|
ios_config:
|
|
diff_against: startup
|
|
diff_ignore_lines:
|
|
- ntp clock .*
|
|
|
|
- name: save running to startup when modified
|
|
ios_config:
|
|
save_when: modified
|
|
"""
|
|
|
|
RETURN = """
|
|
updates:
|
|
description: The set of commands that will be pushed to the remote device
|
|
returned: always
|
|
type: list
|
|
sample: ['hostname foo', 'router ospf 1', 'router-id 1.1.1.1']
|
|
commands:
|
|
description: The set of commands that will be pushed to the remote device
|
|
returned: always
|
|
type: list
|
|
sample: ['hostname foo', 'router ospf 1', 'router-id 1.1.1.1']
|
|
backup_path:
|
|
description: The full path to the backup file
|
|
returned: when backup is yes
|
|
type: string
|
|
sample: /playbooks/ansible/backup/ios_config.2016-07-16@22:28:34
|
|
"""
|
|
import re
|
|
import time
|
|
|
|
from ansible.module_utils.ios import run_commands, get_config, load_config
|
|
from ansible.module_utils.ios import get_defaults_flag
|
|
from ansible.module_utils.ios import ios_argument_spec
|
|
from ansible.module_utils.ios import check_args as ios_check_args
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.netcli import Conditional
|
|
from ansible.module_utils.netcfg import NetworkConfig, dumps
|
|
from ansible.module_utils.six import iteritems
|
|
|
|
|
|
def check_args(module, warnings):
|
|
ios_check_args(module, warnings)
|
|
if module.params['multiline_delimiter']:
|
|
if len(module.params['multiline_delimiter']) != 1:
|
|
module.fail_json(msg='multiline_delimiter value can only be a '
|
|
'single character')
|
|
|
|
|
|
def extract_banners(config):
|
|
banners = {}
|
|
banner_cmds = re.findall(r'^banner (\w+)', config, re.M)
|
|
for cmd in banner_cmds:
|
|
regex = r'banner %s \^C(.+?)(?=\^C)' % cmd
|
|
match = re.search(regex, config, re.S)
|
|
if match:
|
|
key = 'banner %s' % cmd
|
|
banners[key] = match.group(1).strip()
|
|
|
|
for cmd in banner_cmds:
|
|
regex = r'banner %s \^C(.+?)(?=\^C)' % cmd
|
|
match = re.search(regex, config, re.S)
|
|
if match:
|
|
config = config.replace(str(match.group(1)), '')
|
|
|
|
config = re.sub(r'banner \w+ \^C\^C', '!! banner removed', config)
|
|
return (config, banners)
|
|
|
|
|
|
def diff_banners(want, have):
|
|
candidate = {}
|
|
for key, value in iteritems(want):
|
|
if value != have.get(key):
|
|
candidate[key] = value
|
|
return candidate
|
|
|
|
|
|
def load_banners(module, banners):
|
|
delimiter = module.params['multiline_delimiter']
|
|
for key, value in iteritems(banners):
|
|
key += ' %s' % delimiter
|
|
for cmd in ['config terminal', key, value, delimiter, 'end']:
|
|
obj = {'command': cmd, 'sendonly': True}
|
|
run_commands(module, [cmd])
|
|
time.sleep(0.1)
|
|
run_commands(module, ['\n'])
|
|
|
|
|
|
def get_running_config(module, current_config=None):
|
|
contents = module.params['running_config']
|
|
if not contents:
|
|
if not module.params['defaults'] and current_config:
|
|
contents, banners = extract_banners(current_config.config_text)
|
|
else:
|
|
flags = get_defaults_flag(module) if module.params['defaults'] else []
|
|
contents = get_config(module, flags=flags)
|
|
contents, banners = extract_banners(contents)
|
|
return NetworkConfig(indent=1, contents=contents), banners
|
|
|
|
|
|
def get_candidate(module):
|
|
candidate = NetworkConfig(indent=1)
|
|
banners = {}
|
|
|
|
if module.params['src']:
|
|
src, banners = extract_banners(module.params['src'])
|
|
candidate.load(src)
|
|
|
|
elif module.params['lines']:
|
|
parents = module.params['parents'] or list()
|
|
candidate.add(module.params['lines'], parents=parents)
|
|
|
|
return candidate, banners
|
|
|
|
|
|
def main():
|
|
""" main entry point for module execution
|
|
"""
|
|
argument_spec = dict(
|
|
src=dict(type='path'),
|
|
|
|
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']),
|
|
multiline_delimiter=dict(default='@'),
|
|
|
|
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=['startup', 'intended', 'running']),
|
|
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(ios_argument_spec)
|
|
|
|
mutually_exclusive = [('lines', 'src'),
|
|
('save', 'save_when')]
|
|
|
|
required_if = [('match', 'strict', ['lines']),
|
|
('match', 'exact', ['lines']),
|
|
('replace', 'block', ['lines']),
|
|
('diff_against', 'intended', ['intended_config'])]
|
|
|
|
module = AnsibleModule(argument_spec=argument_spec,
|
|
mutually_exclusive=mutually_exclusive,
|
|
required_if=required_if,
|
|
supports_check_mode=True)
|
|
|
|
result = {'changed': False}
|
|
|
|
warnings = list()
|
|
check_args(module, warnings)
|
|
result['warnings'] = warnings
|
|
|
|
config = None
|
|
|
|
if module.params['backup'] or (module._diff and module.params['diff_against'] == 'running'):
|
|
contents = get_config(module)
|
|
config = NetworkConfig(indent=1, contents=contents)
|
|
if module.params['backup']:
|
|
result['__backup__'] = contents
|
|
|
|
if any((module.params['lines'], module.params['src'])):
|
|
match = module.params['match']
|
|
replace = module.params['replace']
|
|
path = module.params['parents']
|
|
|
|
candidate, want_banners = get_candidate(module)
|
|
|
|
if match != 'none':
|
|
config, have_banners = get_running_config(module, config)
|
|
path = module.params['parents']
|
|
configobjs = candidate.difference(config, path=path, match=match, replace=replace)
|
|
else:
|
|
configobjs = candidate.items
|
|
have_banners = {}
|
|
|
|
banners = diff_banners(want_banners, have_banners)
|
|
|
|
if configobjs or banners:
|
|
commands = dumps(configobjs, 'commands').split('\n')
|
|
|
|
if module.params['before']:
|
|
commands[:0] = module.params['before']
|
|
|
|
if module.params['after']:
|
|
commands.extend(module.params['after'])
|
|
|
|
result['commands'] = commands
|
|
result['updates'] = commands
|
|
result['banners'] = banners
|
|
|
|
# send the configuration commands to the device and merge
|
|
# them with the current running config
|
|
if not module.check_mode:
|
|
if commands:
|
|
load_config(module, commands)
|
|
if banners:
|
|
load_banners(module, banners)
|
|
|
|
result['changed'] = True
|
|
|
|
running_config = None
|
|
startup_config = None
|
|
|
|
diff_ignore_lines = module.params['diff_ignore_lines']
|
|
|
|
if module.params['save_when'] != 'never':
|
|
output = run_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:
|
|
run_commands(module, 'copy running-config startup-config')
|
|
else:
|
|
module.warn('Skipping command `copy running-config startup-config` '
|
|
'due to check_mode. Configuration not copied to '
|
|
'non-volatile storage')
|
|
|
|
if module._diff:
|
|
if not running_config:
|
|
output = run_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 = run_commands(module, 'show startup-config')
|
|
contents = output[0]
|
|
else:
|
|
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:
|
|
result.update({
|
|
'changed': True,
|
|
'diff': {'before': str(base_config), 'after': str(running_config)}
|
|
})
|
|
|
|
module.exit_json(**result)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|