nxos_vlan support 2.1 and 2.2
This commit is contained in:
parent
49414a4c83
commit
7922796e92
1 changed files with 732 additions and 29 deletions
|
@ -28,36 +28,43 @@ extends_documentation_fragment: nxos
|
||||||
options:
|
options:
|
||||||
vlan_id:
|
vlan_id:
|
||||||
description:
|
description:
|
||||||
- Single VLAN ID.
|
- single vlan id
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
vlan_range:
|
vlan_range:
|
||||||
description:
|
description:
|
||||||
- A range of VLANs such as I(2-10) or I(2,5,10-15) etc.
|
- range of VLANs such as 2-10 or 2,5,10-15, etc.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- The name of VLAN.
|
- name of VLAN
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
vlan_state:
|
vlan_state:
|
||||||
description:
|
description:
|
||||||
- Manage the VLAN operational state of the VLAN
|
- Manage the vlan operational state of the VLAN
|
||||||
(equivalent to state {active | suspend} command.
|
(equivalent to state {active | suspend} command
|
||||||
required: false
|
required: false
|
||||||
default: active
|
default: active
|
||||||
choices: ['active','suspend']
|
choices: ['active','suspend']
|
||||||
admin_state:
|
admin_state:
|
||||||
description:
|
description:
|
||||||
- Manage the VLAN admin state of the VLAN equivalent
|
- Manage the vlan admin state of the VLAN equivalent
|
||||||
to shut/no shut in VLAN config mode.
|
to shut/no shut in vlan config mode
|
||||||
required: false
|
required: false
|
||||||
default: up
|
default: up
|
||||||
choices: ['up','down']
|
choices: ['up','down']
|
||||||
|
mapped_vni:
|
||||||
|
description:
|
||||||
|
- The Virtual Network Identifier (VNI) id that is mapped to the
|
||||||
|
VLAN. Valid values are integer and keyword 'default'.
|
||||||
|
required: false
|
||||||
|
default: null
|
||||||
|
version_added: "2.2"
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Manage the state of the resource.
|
- Manage the state of the resource
|
||||||
required: false
|
required: false
|
||||||
default: present
|
default: present
|
||||||
choices: ['present','absent']
|
choices: ['present','absent']
|
||||||
|
@ -65,13 +72,13 @@ options:
|
||||||
'''
|
'''
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
# Ensure a range of VLANs are not present on the switch
|
# Ensure a range of VLANs are not present on the switch
|
||||||
- nxos_vlan: vlan_range="2-10,20,50,55-60,100-150" host={{ inventory_hostname }} username=cisco password=cisco state=absent transport=nxapi
|
- nxos_vlan: vlan_range="2-10,20,50,55-60,100-150" host=68.170.147.165 username=cisco password=cisco state=absent transport=nxapi
|
||||||
|
|
||||||
# Ensure VLAN 50 exists with the name WEB and is in the shutdown state
|
# Ensure VLAN 50 exists with the name WEB and is in the shutdown state
|
||||||
- nxos_vlan: vlan_id=50 host={{ inventory_hostname }} admin_state=down name=WEB transport=nxapi username=cisco password=cisco
|
- nxos_vlan: vlan_id=50 host=68.170.147.165 admin_state=down name=WEB transport=nxapi username=cisco password=cisco
|
||||||
|
|
||||||
# Ensure VLAN is NOT on the device
|
# Ensure VLAN is NOT on the device
|
||||||
- nxos_vlan: vlan_id=50 host={{ inventory_hostname }} state=absent transport=nxapi username=cisco password=cisco
|
- nxos_vlan: vlan_id=50 host=68.170.147.165 state=absent transport=nxapi username=cisco password=cisco
|
||||||
|
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
@ -99,20 +106,20 @@ proposed:
|
||||||
returned: always
|
returned: always
|
||||||
type: dict or null
|
type: dict or null
|
||||||
sample: {"admin_state": "down", "name": "app_vlan",
|
sample: {"admin_state": "down", "name": "app_vlan",
|
||||||
"vlan_state": "suspend"}
|
"vlan_state": "suspend", "mapped_vni": "5000"}
|
||||||
existing:
|
existing:
|
||||||
description: k/v pairs of existing vlan or null when using vlan_range
|
description: k/v pairs of existing vlan or null when using vlan_range
|
||||||
returned: always
|
returned: always
|
||||||
type: dict
|
type: dict
|
||||||
sample: {"admin_state": "down", "name": "app_vlan",
|
sample: {"admin_state": "down", "name": "app_vlan",
|
||||||
"vlan_id": "20", "vlan_state": "suspend"}
|
"vlan_id": "20", "vlan_state": "suspend", "mapped_vni": ""}
|
||||||
end_state:
|
end_state:
|
||||||
description: k/v pairs of the VLAN after executing module or null
|
description: k/v pairs of the VLAN after executing module or null
|
||||||
when using vlan_range
|
when using vlan_range
|
||||||
returned: always
|
returned: always
|
||||||
type: dict or null
|
type: dict or null
|
||||||
sample: {"admin_state": "down", "name": "app_vlan", "vlan_id": "20",
|
sample: {"admin_state": "down", "name": "app_vlan", "vlan_id": "20",
|
||||||
"vlan_state": "suspend"}
|
"vlan_state": "suspend", "mapped_vni": "5000"}
|
||||||
state:
|
state:
|
||||||
description: state as sent in from the playbook
|
description: state as sent in from the playbook
|
||||||
returned: always
|
returned: always
|
||||||
|
@ -122,7 +129,7 @@ updates:
|
||||||
description: command string sent to the device
|
description: command string sent to the device
|
||||||
returned: always
|
returned: always
|
||||||
type: list
|
type: list
|
||||||
sample: ["vlan 20", "vlan 55"]
|
sample: ["vlan 20", "vlan 55", "vn-segment 5000"]
|
||||||
changed:
|
changed:
|
||||||
description: check to see if a change was made on the device
|
description: check to see if a change was made on the device
|
||||||
returned: always
|
returned: always
|
||||||
|
@ -131,6 +138,683 @@ changed:
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
# COMMON CODE FOR MIGRATION
|
||||||
|
|
||||||
|
import re
|
||||||
|
import time
|
||||||
|
import collections
|
||||||
|
import itertools
|
||||||
|
import shlex
|
||||||
|
import json
|
||||||
|
|
||||||
|
from ansible.module_utils.basic import AnsibleModule, env_fallback, get_exception
|
||||||
|
from ansible.module_utils.basic import BOOLEANS_TRUE, BOOLEANS_FALSE
|
||||||
|
from ansible.module_utils.shell import Shell, ShellError, HAS_PARAMIKO
|
||||||
|
from ansible.module_utils.netcfg import parse
|
||||||
|
from ansible.module_utils.urls import fetch_url
|
||||||
|
|
||||||
|
|
||||||
|
DEFAULT_COMMENT_TOKENS = ['#', '!']
|
||||||
|
|
||||||
|
class ConfigLine(object):
|
||||||
|
|
||||||
|
def __init__(self, text):
|
||||||
|
self.text = text
|
||||||
|
self.children = list()
|
||||||
|
self.parents = list()
|
||||||
|
self.raw = None
|
||||||
|
|
||||||
|
@property
|
||||||
|
def line(self):
|
||||||
|
line = ['set']
|
||||||
|
line.extend([p.text for p in self.parents])
|
||||||
|
line.append(self.text)
|
||||||
|
return ' '.join(line)
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
return self.raw
|
||||||
|
|
||||||
|
def __eq__(self, other):
|
||||||
|
if self.text == other.text:
|
||||||
|
return self.parents == other.parents
|
||||||
|
|
||||||
|
def __ne__(self, other):
|
||||||
|
return not self.__eq__(other)
|
||||||
|
|
||||||
|
def ignore_line(text, tokens=None):
|
||||||
|
for item in (tokens or DEFAULT_COMMENT_TOKENS):
|
||||||
|
if text.startswith(item):
|
||||||
|
return True
|
||||||
|
|
||||||
|
def get_next(iterable):
|
||||||
|
item, next_item = itertools.tee(iterable, 2)
|
||||||
|
next_item = itertools.islice(next_item, 1, None)
|
||||||
|
return itertools.izip_longest(item, next_item)
|
||||||
|
|
||||||
|
def parse(lines, indent, comment_tokens=None):
|
||||||
|
toplevel = re.compile(r'\S')
|
||||||
|
childline = re.compile(r'^\s*(.+)$')
|
||||||
|
|
||||||
|
ancestors = list()
|
||||||
|
config = list()
|
||||||
|
|
||||||
|
for line in str(lines).split('\n'):
|
||||||
|
text = str(re.sub(r'([{};])', '', line)).strip()
|
||||||
|
|
||||||
|
cfg = ConfigLine(text)
|
||||||
|
cfg.raw = line
|
||||||
|
|
||||||
|
if not text or ignore_line(text, comment_tokens):
|
||||||
|
continue
|
||||||
|
|
||||||
|
# handle top level commands
|
||||||
|
if toplevel.match(line):
|
||||||
|
ancestors = [cfg]
|
||||||
|
|
||||||
|
# handle sub level commands
|
||||||
|
else:
|
||||||
|
match = childline.match(line)
|
||||||
|
line_indent = match.start(1)
|
||||||
|
level = int(line_indent / indent)
|
||||||
|
parent_level = level - 1
|
||||||
|
|
||||||
|
cfg.parents = ancestors[:level]
|
||||||
|
|
||||||
|
if level > len(ancestors):
|
||||||
|
config.append(cfg)
|
||||||
|
continue
|
||||||
|
|
||||||
|
for i in range(level, len(ancestors)):
|
||||||
|
ancestors.pop()
|
||||||
|
|
||||||
|
ancestors.append(cfg)
|
||||||
|
ancestors[parent_level].children.append(cfg)
|
||||||
|
|
||||||
|
config.append(cfg)
|
||||||
|
|
||||||
|
return config
|
||||||
|
|
||||||
|
|
||||||
|
class CustomNetworkConfig(object):
|
||||||
|
|
||||||
|
def __init__(self, indent=None, contents=None, device_os=None):
|
||||||
|
self.indent = indent or 1
|
||||||
|
self._config = list()
|
||||||
|
self._device_os = device_os
|
||||||
|
|
||||||
|
if contents:
|
||||||
|
self.load(contents)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def items(self):
|
||||||
|
return self._config
|
||||||
|
|
||||||
|
@property
|
||||||
|
def lines(self):
|
||||||
|
lines = list()
|
||||||
|
for item, next_item in get_next(self.items):
|
||||||
|
if next_item is None:
|
||||||
|
lines.append(item.line)
|
||||||
|
elif not next_item.line.startswith(item.line):
|
||||||
|
lines.append(item.line)
|
||||||
|
return lines
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
text = ''
|
||||||
|
for item in self.items:
|
||||||
|
if not item.parents:
|
||||||
|
expand = self.get_section(item.text)
|
||||||
|
text += '%s\n' % self.get_section(item.text)
|
||||||
|
return str(text).strip()
|
||||||
|
|
||||||
|
def load(self, contents):
|
||||||
|
self._config = parse(contents, indent=self.indent)
|
||||||
|
|
||||||
|
def load_from_file(self, filename):
|
||||||
|
self.load(open(filename).read())
|
||||||
|
|
||||||
|
def get(self, path):
|
||||||
|
if isinstance(path, basestring):
|
||||||
|
path = [path]
|
||||||
|
for item in self._config:
|
||||||
|
if item.text == path[-1]:
|
||||||
|
parents = [p.text for p in item.parents]
|
||||||
|
if parents == path[:-1]:
|
||||||
|
return item
|
||||||
|
|
||||||
|
def search(self, regexp, path=None):
|
||||||
|
regex = re.compile(r'^%s' % regexp, re.M)
|
||||||
|
|
||||||
|
if path:
|
||||||
|
parent = self.get(path)
|
||||||
|
if not parent or not parent.children:
|
||||||
|
return
|
||||||
|
children = [c.text for c in parent.children]
|
||||||
|
data = '\n'.join(children)
|
||||||
|
else:
|
||||||
|
data = str(self)
|
||||||
|
|
||||||
|
match = regex.search(data)
|
||||||
|
if match:
|
||||||
|
if match.groups():
|
||||||
|
values = match.groupdict().values()
|
||||||
|
groups = list(set(match.groups()).difference(values))
|
||||||
|
return (groups, match.groupdict())
|
||||||
|
else:
|
||||||
|
return match.group()
|
||||||
|
|
||||||
|
def findall(self, regexp):
|
||||||
|
regexp = r'%s' % regexp
|
||||||
|
return re.findall(regexp, str(self))
|
||||||
|
|
||||||
|
def expand(self, obj, items):
|
||||||
|
block = [item.raw for item in obj.parents]
|
||||||
|
block.append(obj.raw)
|
||||||
|
|
||||||
|
current_level = items
|
||||||
|
for b in block:
|
||||||
|
if b not in current_level:
|
||||||
|
current_level[b] = collections.OrderedDict()
|
||||||
|
current_level = current_level[b]
|
||||||
|
for c in obj.children:
|
||||||
|
if c.raw not in current_level:
|
||||||
|
current_level[c.raw] = collections.OrderedDict()
|
||||||
|
|
||||||
|
def to_lines(self, section):
|
||||||
|
lines = list()
|
||||||
|
for entry in section[1:]:
|
||||||
|
line = ['set']
|
||||||
|
line.extend([p.text for p in entry.parents])
|
||||||
|
line.append(entry.text)
|
||||||
|
lines.append(' '.join(line))
|
||||||
|
return lines
|
||||||
|
|
||||||
|
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)
|
||||||
|
if self._device_os == 'junos':
|
||||||
|
return self.to_lines(section)
|
||||||
|
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 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 flatten(self, data, obj=None):
|
||||||
|
if obj is None:
|
||||||
|
obj = list()
|
||||||
|
for k, v in data.items():
|
||||||
|
obj.append(k)
|
||||||
|
self.flatten(v, obj)
|
||||||
|
return obj
|
||||||
|
|
||||||
|
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 get_children(self, path):
|
||||||
|
obj = self.get_object(path)
|
||||||
|
if obj:
|
||||||
|
return obj.children
|
||||||
|
|
||||||
|
def difference(self, other, path=None, match='line', replace='line'):
|
||||||
|
updates = list()
|
||||||
|
|
||||||
|
config = self.items
|
||||||
|
if path:
|
||||||
|
config = self.get_children(path) or list()
|
||||||
|
|
||||||
|
if match == 'line':
|
||||||
|
for item in config:
|
||||||
|
if item not in other.items:
|
||||||
|
updates.append(item)
|
||||||
|
|
||||||
|
elif match == 'strict':
|
||||||
|
if path:
|
||||||
|
current = other.get_children(path) or list()
|
||||||
|
else:
|
||||||
|
current = other.items
|
||||||
|
|
||||||
|
for index, item in enumerate(config):
|
||||||
|
try:
|
||||||
|
if item != current[index]:
|
||||||
|
updates.append(item)
|
||||||
|
except IndexError:
|
||||||
|
updates.append(item)
|
||||||
|
|
||||||
|
elif match == 'exact':
|
||||||
|
if path:
|
||||||
|
current = other.get_children(path) or list()
|
||||||
|
else:
|
||||||
|
current = other.items
|
||||||
|
|
||||||
|
if len(current) != len(config):
|
||||||
|
updates.extend(config)
|
||||||
|
else:
|
||||||
|
for ours, theirs in itertools.izip(config, current):
|
||||||
|
if ours != theirs:
|
||||||
|
updates.extend(config)
|
||||||
|
break
|
||||||
|
|
||||||
|
if self._device_os == 'junos':
|
||||||
|
return updates
|
||||||
|
|
||||||
|
diffs = collections.OrderedDict()
|
||||||
|
for update in updates:
|
||||||
|
if replace == 'block' and update.parents:
|
||||||
|
update = update.parents[-1]
|
||||||
|
self.expand(update, diffs)
|
||||||
|
|
||||||
|
return self.flatten(diffs)
|
||||||
|
|
||||||
|
def replace(self, replace, text=None, regex=None, parents=None,
|
||||||
|
add_if_missing=False, ignore_whitespace=False):
|
||||||
|
match = None
|
||||||
|
|
||||||
|
parents = parents or list()
|
||||||
|
if text is None and regex is None:
|
||||||
|
raise ValueError('missing required arguments')
|
||||||
|
|
||||||
|
if not regex:
|
||||||
|
regex = ['^%s$' % text]
|
||||||
|
|
||||||
|
patterns = [re.compile(r, re.I) for r in to_list(regex)]
|
||||||
|
|
||||||
|
for item in self.items:
|
||||||
|
for regexp in patterns:
|
||||||
|
if ignore_whitespace is True:
|
||||||
|
string = item.text
|
||||||
|
else:
|
||||||
|
string = item.raw
|
||||||
|
if regexp.search(item.text):
|
||||||
|
if item.text != replace:
|
||||||
|
if parents == [p.text for p in item.parents]:
|
||||||
|
match = item
|
||||||
|
break
|
||||||
|
|
||||||
|
if match:
|
||||||
|
match.text = replace
|
||||||
|
indent = len(match.raw) - len(match.raw.lstrip())
|
||||||
|
match.raw = replace.rjust(len(replace) + indent)
|
||||||
|
|
||||||
|
elif add_if_missing:
|
||||||
|
self.add(replace, parents=parents)
|
||||||
|
|
||||||
|
|
||||||
|
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 argument_spec():
|
||||||
|
return dict(
|
||||||
|
# config options
|
||||||
|
running_config=dict(aliases=['config']),
|
||||||
|
save_config=dict(type='bool', default=False, aliases=['save'])
|
||||||
|
)
|
||||||
|
nxos_argument_spec = argument_spec()
|
||||||
|
|
||||||
|
|
||||||
|
NET_PASSWD_RE = re.compile(r"[\r\n]?password: $", re.I)
|
||||||
|
|
||||||
|
NET_COMMON_ARGS = dict(
|
||||||
|
host=dict(required=True),
|
||||||
|
port=dict(type='int'),
|
||||||
|
username=dict(fallback=(env_fallback, ['ANSIBLE_NET_USERNAME'])),
|
||||||
|
password=dict(no_log=True, fallback=(env_fallback, ['ANSIBLE_NET_PASSWORD'])),
|
||||||
|
ssh_keyfile=dict(fallback=(env_fallback, ['ANSIBLE_NET_SSH_KEYFILE']), type='path'),
|
||||||
|
transport=dict(default='cli', choices=['cli', 'nxapi']),
|
||||||
|
use_ssl=dict(default=False, type='bool'),
|
||||||
|
validate_certs=dict(default=True, type='bool'),
|
||||||
|
provider=dict(type='dict'),
|
||||||
|
timeout=dict(default=10, type='int')
|
||||||
|
)
|
||||||
|
|
||||||
|
NXAPI_COMMAND_TYPES = ['cli_show', 'cli_show_ascii', 'cli_conf', 'bash']
|
||||||
|
|
||||||
|
NXAPI_ENCODINGS = ['json', 'xml']
|
||||||
|
|
||||||
|
CLI_PROMPTS_RE = [
|
||||||
|
re.compile(r'[\r\n]?[a-zA-Z]{1}[a-zA-Z0-9-]*[>|#|%](?:\s*)$'),
|
||||||
|
re.compile(r'[\r\n]?[a-zA-Z]{1}[a-zA-Z0-9-]*\(.+\)#(?:\s*)$')
|
||||||
|
]
|
||||||
|
|
||||||
|
CLI_ERRORS_RE = [
|
||||||
|
re.compile(r"% ?Error"),
|
||||||
|
re.compile(r"^% \w+", re.M),
|
||||||
|
re.compile(r"% ?Bad secret"),
|
||||||
|
re.compile(r"invalid input", re.I),
|
||||||
|
re.compile(r"(?:incomplete|ambiguous) command", re.I),
|
||||||
|
re.compile(r"connection timed out", re.I),
|
||||||
|
re.compile(r"[^\r\n]+ not found", re.I),
|
||||||
|
re.compile(r"'[^']' +returned error code: ?\d+"),
|
||||||
|
re.compile(r"syntax error"),
|
||||||
|
re.compile(r"unknown command")
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def to_list(val):
|
||||||
|
if isinstance(val, (list, tuple)):
|
||||||
|
return list(val)
|
||||||
|
elif val is not None:
|
||||||
|
return [val]
|
||||||
|
else:
|
||||||
|
return list()
|
||||||
|
|
||||||
|
|
||||||
|
class Nxapi(object):
|
||||||
|
|
||||||
|
def __init__(self, module):
|
||||||
|
self.module = module
|
||||||
|
|
||||||
|
# sets the module_utils/urls.py req parameters
|
||||||
|
self.module.params['url_username'] = module.params['username']
|
||||||
|
self.module.params['url_password'] = module.params['password']
|
||||||
|
|
||||||
|
self.url = None
|
||||||
|
self._nxapi_auth = None
|
||||||
|
|
||||||
|
def _get_body(self, commands, command_type, encoding, version='1.0', chunk='0', sid=None):
|
||||||
|
"""Encodes a NXAPI JSON request message
|
||||||
|
"""
|
||||||
|
if isinstance(commands, (list, set, tuple)):
|
||||||
|
commands = ' ;'.join(commands)
|
||||||
|
|
||||||
|
if encoding not in NXAPI_ENCODINGS:
|
||||||
|
msg = 'invalid encoding, received %s, exceped one of %s' % \
|
||||||
|
(encoding, ','.join(NXAPI_ENCODINGS))
|
||||||
|
self.module_fail_json(msg=msg)
|
||||||
|
|
||||||
|
msg = {
|
||||||
|
'version': version,
|
||||||
|
'type': command_type,
|
||||||
|
'chunk': chunk,
|
||||||
|
'sid': sid,
|
||||||
|
'input': commands,
|
||||||
|
'output_format': encoding
|
||||||
|
}
|
||||||
|
return dict(ins_api=msg)
|
||||||
|
|
||||||
|
def connect(self):
|
||||||
|
host = self.module.params['host']
|
||||||
|
port = self.module.params['port']
|
||||||
|
|
||||||
|
if self.module.params['use_ssl']:
|
||||||
|
proto = 'https'
|
||||||
|
if not port:
|
||||||
|
port = 443
|
||||||
|
else:
|
||||||
|
proto = 'http'
|
||||||
|
if not port:
|
||||||
|
port = 80
|
||||||
|
|
||||||
|
self.url = '%s://%s:%s/ins' % (proto, host, port)
|
||||||
|
|
||||||
|
def send(self, commands, command_type='cli_show_ascii', encoding='json'):
|
||||||
|
"""Send commands to the device.
|
||||||
|
"""
|
||||||
|
clist = to_list(commands)
|
||||||
|
|
||||||
|
if command_type not in NXAPI_COMMAND_TYPES:
|
||||||
|
msg = 'invalid command_type, received %s, exceped one of %s' % \
|
||||||
|
(command_type, ','.join(NXAPI_COMMAND_TYPES))
|
||||||
|
self.module_fail_json(msg=msg)
|
||||||
|
|
||||||
|
data = self._get_body(clist, command_type, encoding)
|
||||||
|
data = self.module.jsonify(data)
|
||||||
|
|
||||||
|
headers = {'Content-Type': 'application/json'}
|
||||||
|
if self._nxapi_auth:
|
||||||
|
headers['Cookie'] = self._nxapi_auth
|
||||||
|
|
||||||
|
response, headers = fetch_url(self.module, self.url, data=data,
|
||||||
|
headers=headers, method='POST')
|
||||||
|
|
||||||
|
self._nxapi_auth = headers.get('set-cookie')
|
||||||
|
|
||||||
|
if headers['status'] != 200:
|
||||||
|
self.module.fail_json(**headers)
|
||||||
|
|
||||||
|
response = self.module.from_json(response.read())
|
||||||
|
result = list()
|
||||||
|
|
||||||
|
output = response['ins_api']['outputs']['output']
|
||||||
|
for item in to_list(output):
|
||||||
|
if item['code'] != '200':
|
||||||
|
self.module.fail_json(**item)
|
||||||
|
else:
|
||||||
|
result.append(item['body'])
|
||||||
|
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
class Cli(object):
|
||||||
|
|
||||||
|
def __init__(self, module):
|
||||||
|
self.module = module
|
||||||
|
self.shell = None
|
||||||
|
|
||||||
|
def connect(self, **kwargs):
|
||||||
|
host = self.module.params['host']
|
||||||
|
port = self.module.params['port'] or 22
|
||||||
|
|
||||||
|
username = self.module.params['username']
|
||||||
|
password = self.module.params['password']
|
||||||
|
timeout = self.module.params['timeout']
|
||||||
|
key_filename = self.module.params['ssh_keyfile']
|
||||||
|
|
||||||
|
allow_agent = (key_filename is not None) or (key_filename is None and password is None)
|
||||||
|
|
||||||
|
try:
|
||||||
|
self.shell = Shell(kickstart=False, prompts_re=CLI_PROMPTS_RE,
|
||||||
|
errors_re=CLI_ERRORS_RE)
|
||||||
|
self.shell.open(host, port=port, username=username,
|
||||||
|
password=password, key_filename=key_filename,
|
||||||
|
allow_agent=allow_agent, timeout=timeout)
|
||||||
|
except ShellError:
|
||||||
|
e = get_exception()
|
||||||
|
msg = 'failed to connect to %s:%s - %s' % (host, port, str(e))
|
||||||
|
self.module.fail_json(msg=msg)
|
||||||
|
|
||||||
|
def send(self, commands, encoding='text'):
|
||||||
|
try:
|
||||||
|
return self.shell.send(commands)
|
||||||
|
except ShellError:
|
||||||
|
e = get_exception()
|
||||||
|
self.module.fail_json(msg=e.message, commands=commands)
|
||||||
|
|
||||||
|
|
||||||
|
class NetworkModule(AnsibleModule):
|
||||||
|
|
||||||
|
def __init__(self, *args, **kwargs):
|
||||||
|
super(NetworkModule, self).__init__(*args, **kwargs)
|
||||||
|
self.connection = None
|
||||||
|
self._config = None
|
||||||
|
self._connected = False
|
||||||
|
|
||||||
|
@property
|
||||||
|
def connected(self):
|
||||||
|
return self._connected
|
||||||
|
|
||||||
|
@property
|
||||||
|
def config(self):
|
||||||
|
if not self._config:
|
||||||
|
self._config = self.get_config()
|
||||||
|
return self._config
|
||||||
|
|
||||||
|
def _load_params(self):
|
||||||
|
super(NetworkModule, self)._load_params()
|
||||||
|
provider = self.params.get('provider') or dict()
|
||||||
|
for key, value in provider.items():
|
||||||
|
if key in NET_COMMON_ARGS:
|
||||||
|
if self.params.get(key) is None and value is not None:
|
||||||
|
self.params[key] = value
|
||||||
|
|
||||||
|
def connect(self):
|
||||||
|
cls = globals().get(str(self.params['transport']).capitalize())
|
||||||
|
try:
|
||||||
|
self.connection = cls(self)
|
||||||
|
except TypeError:
|
||||||
|
e = get_exception()
|
||||||
|
self.fail_json(msg=e.message)
|
||||||
|
|
||||||
|
self.connection.connect()
|
||||||
|
|
||||||
|
if self.params['transport'] == 'cli':
|
||||||
|
self.connection.send('terminal length 0')
|
||||||
|
|
||||||
|
self._connected = True
|
||||||
|
|
||||||
|
def configure(self, commands):
|
||||||
|
commands = to_list(commands)
|
||||||
|
if self.params['transport'] == 'cli':
|
||||||
|
return self.configure_cli(commands)
|
||||||
|
else:
|
||||||
|
return self.execute(commands, command_type='cli_conf')
|
||||||
|
|
||||||
|
def configure_cli(self, commands):
|
||||||
|
commands = to_list(commands)
|
||||||
|
commands.insert(0, 'configure')
|
||||||
|
responses = self.execute(commands)
|
||||||
|
responses.pop(0)
|
||||||
|
return responses
|
||||||
|
|
||||||
|
def execute(self, commands, **kwargs):
|
||||||
|
if not self.connected:
|
||||||
|
self.connect()
|
||||||
|
return self.connection.send(commands, **kwargs)
|
||||||
|
|
||||||
|
def disconnect(self):
|
||||||
|
self.connection.close()
|
||||||
|
self._connected = False
|
||||||
|
|
||||||
|
def parse_config(self, cfg):
|
||||||
|
return parse(cfg, indent=2)
|
||||||
|
|
||||||
|
def get_config(self):
|
||||||
|
cmd = 'show running-config'
|
||||||
|
if self.params.get('include_defaults'):
|
||||||
|
cmd += ' all'
|
||||||
|
response = self.execute(cmd)
|
||||||
|
return response[0]
|
||||||
|
|
||||||
|
|
||||||
|
def get_module(**kwargs):
|
||||||
|
"""Return instance of NetworkModule
|
||||||
|
"""
|
||||||
|
argument_spec = NET_COMMON_ARGS.copy()
|
||||||
|
if kwargs.get('argument_spec'):
|
||||||
|
argument_spec.update(kwargs['argument_spec'])
|
||||||
|
kwargs['argument_spec'] = argument_spec
|
||||||
|
|
||||||
|
module = NetworkModule(**kwargs)
|
||||||
|
|
||||||
|
if module.params['transport'] == 'cli' and not HAS_PARAMIKO:
|
||||||
|
module.fail_json(msg='paramiko is required but does not appear to be installed')
|
||||||
|
|
||||||
|
return module
|
||||||
|
|
||||||
|
|
||||||
|
def custom_get_config(module, include_defaults=False):
|
||||||
|
config = module.params['running_config']
|
||||||
|
if not config:
|
||||||
|
cmd = 'show running-config'
|
||||||
|
if module.params['include_defaults']:
|
||||||
|
cmd += ' all'
|
||||||
|
if module.params['transport'] == 'nxapi':
|
||||||
|
config = module.execute([cmd], command_type='cli_show_ascii')[0]
|
||||||
|
else:
|
||||||
|
config = module.execute([cmd])[0]
|
||||||
|
|
||||||
|
return CustomNetworkConfig(indent=2, contents=config)
|
||||||
|
|
||||||
|
def load_config(module, candidate):
|
||||||
|
config = custom_get_config(module)
|
||||||
|
|
||||||
|
commands = candidate.difference(config)
|
||||||
|
commands = [str(c).strip() for c in commands]
|
||||||
|
|
||||||
|
save_config = module.params['save_config']
|
||||||
|
|
||||||
|
result = dict(changed=False)
|
||||||
|
|
||||||
|
if commands:
|
||||||
|
if not module.check_mode:
|
||||||
|
module.configure(commands)
|
||||||
|
if save_config:
|
||||||
|
module.config.save_config()
|
||||||
|
|
||||||
|
result['changed'] = True
|
||||||
|
result['updates'] = commands
|
||||||
|
|
||||||
|
return result
|
||||||
|
# END OF COMMON CODE
|
||||||
|
|
||||||
def vlan_range_to_list(vlans):
|
def vlan_range_to_list(vlans):
|
||||||
result = []
|
result = []
|
||||||
|
@ -196,13 +880,17 @@ def get_vlan_config_commands(vlan, vid):
|
||||||
'name': 'name {0}',
|
'name': 'name {0}',
|
||||||
'vlan_state': 'state {0}',
|
'vlan_state': 'state {0}',
|
||||||
'admin_state': '{0}',
|
'admin_state': '{0}',
|
||||||
'mode': 'mode {0}'
|
'mode': 'mode {0}',
|
||||||
|
'mapped_vni': 'vn-segment {0}'
|
||||||
}
|
}
|
||||||
|
|
||||||
commands = []
|
commands = []
|
||||||
|
|
||||||
for param, value in vlan.iteritems():
|
for param, value in vlan.iteritems():
|
||||||
command = VLAN_ARGS.get(param).format(vlan.get(param))
|
if param == 'mapped_vni' and value == 'default':
|
||||||
|
command = 'no vn-segment'
|
||||||
|
else:
|
||||||
|
command = VLAN_ARGS.get(param).format(vlan.get(param))
|
||||||
if command:
|
if command:
|
||||||
commands.append(command)
|
commands.append(command)
|
||||||
|
|
||||||
|
@ -213,7 +901,6 @@ def get_vlan_config_commands(vlan, vid):
|
||||||
|
|
||||||
|
|
||||||
def get_list_of_vlans(module):
|
def get_list_of_vlans(module):
|
||||||
|
|
||||||
command = 'show vlan'
|
command = 'show vlan'
|
||||||
body = execute_show_command(command, module)
|
body = execute_show_command(command, module)
|
||||||
vlan_list = []
|
vlan_list = []
|
||||||
|
@ -228,6 +915,17 @@ def get_list_of_vlans(module):
|
||||||
return vlan_list
|
return vlan_list
|
||||||
|
|
||||||
|
|
||||||
|
def get_vni(vlanid, module):
|
||||||
|
command = 'show run all | section vlan.{0}'.format(vlanid)
|
||||||
|
body = execute_show_command(command, module, command_type='cli_show_ascii')[0]
|
||||||
|
value = ''
|
||||||
|
if body:
|
||||||
|
REGEX = re.compile(r'(?:vn-segment\s)(?P<value>.*)$', re.M)
|
||||||
|
if 'vn-segment' in body:
|
||||||
|
value = REGEX.search(body).group('value')
|
||||||
|
return value
|
||||||
|
|
||||||
|
|
||||||
def get_vlan(vlanid, module):
|
def get_vlan(vlanid, module):
|
||||||
"""Get instance of VLAN as a dictionary
|
"""Get instance of VLAN as a dictionary
|
||||||
"""
|
"""
|
||||||
|
@ -258,7 +956,7 @@ def get_vlan(vlanid, module):
|
||||||
}
|
}
|
||||||
|
|
||||||
vlan = apply_value_map(value_map, vlan)
|
vlan = apply_value_map(value_map, vlan)
|
||||||
|
vlan['mapped_vni'] = get_vni(vlanid, module)
|
||||||
return vlan
|
return vlan
|
||||||
|
|
||||||
|
|
||||||
|
@ -293,7 +991,9 @@ def get_cli_body_ssh(command, response, module):
|
||||||
if | json returns an XML string, it is a valid command, but that the
|
if | json returns an XML string, it is a valid command, but that the
|
||||||
resource doesn't exist yet.
|
resource doesn't exist yet.
|
||||||
"""
|
"""
|
||||||
if 'xml' in response[0]:
|
if 'show run' in command or response[0] == '\n':
|
||||||
|
body = response
|
||||||
|
elif 'xml' in response[0]:
|
||||||
body = []
|
body = []
|
||||||
else:
|
else:
|
||||||
try:
|
try:
|
||||||
|
@ -318,9 +1018,9 @@ def execute_show(cmds, module, command_type=None):
|
||||||
|
|
||||||
|
|
||||||
def execute_show_command(command, module, command_type='cli_show'):
|
def execute_show_command(command, module, command_type='cli_show'):
|
||||||
|
|
||||||
if module.params['transport'] == 'cli':
|
if module.params['transport'] == 'cli':
|
||||||
command += ' | json'
|
if 'show run' not in command:
|
||||||
|
command += ' | json'
|
||||||
cmds = [command]
|
cmds = [command]
|
||||||
response = execute_show(cmds, module)
|
response = execute_show(cmds, module)
|
||||||
body = get_cli_body_ssh(command, response, module)
|
body = get_cli_body_ssh(command, response, module)
|
||||||
|
@ -337,6 +1037,7 @@ def main():
|
||||||
vlan_range=dict(required=False),
|
vlan_range=dict(required=False),
|
||||||
name=dict(required=False),
|
name=dict(required=False),
|
||||||
vlan_state=dict(choices=['active', 'suspend'], required=False),
|
vlan_state=dict(choices=['active', 'suspend'], required=False),
|
||||||
|
mapped_vni=dict(required=False, type='str'),
|
||||||
state=dict(choices=['present', 'absent'], default='present',
|
state=dict(choices=['present', 'absent'], default='present',
|
||||||
required=False),
|
required=False),
|
||||||
admin_state=dict(choices=['up', 'down'], required=False),
|
admin_state=dict(choices=['up', 'down'], required=False),
|
||||||
|
@ -351,6 +1052,7 @@ def main():
|
||||||
name = module.params['name']
|
name = module.params['name']
|
||||||
vlan_state = module.params['vlan_state']
|
vlan_state = module.params['vlan_state']
|
||||||
admin_state = module.params['admin_state']
|
admin_state = module.params['admin_state']
|
||||||
|
mapped_vni = module.params['mapped_vni']
|
||||||
state = module.params['state']
|
state = module.params['state']
|
||||||
|
|
||||||
changed = False
|
changed = False
|
||||||
|
@ -360,7 +1062,7 @@ def main():
|
||||||
module.fail_json(msg='vlan_id must be a valid VLAN ID')
|
module.fail_json(msg='vlan_id must be a valid VLAN ID')
|
||||||
|
|
||||||
args = dict(name=name, vlan_state=vlan_state,
|
args = dict(name=name, vlan_state=vlan_state,
|
||||||
admin_state=admin_state)
|
admin_state=admin_state, mapped_vni=mapped_vni)
|
||||||
|
|
||||||
proposed = dict((k, v) for k, v in args.iteritems() if v is not None)
|
proposed = dict((k, v) for k, v in args.iteritems() if v is not None)
|
||||||
|
|
||||||
|
@ -390,6 +1092,9 @@ def main():
|
||||||
if existing:
|
if existing:
|
||||||
commands = ['no vlan ' + vlan_id]
|
commands = ['no vlan ' + vlan_id]
|
||||||
elif state == 'present':
|
elif state == 'present':
|
||||||
|
if (existing.get('mapped_vni') == '0' and
|
||||||
|
proposed.get('mapped_vni') == 'default'):
|
||||||
|
proposed.pop('mapped_vni')
|
||||||
delta = dict(set(
|
delta = dict(set(
|
||||||
proposed.iteritems()).difference(existing.iteritems()))
|
proposed.iteritems()).difference(existing.iteritems()))
|
||||||
if delta or not existing:
|
if delta or not existing:
|
||||||
|
@ -399,6 +1104,10 @@ def main():
|
||||||
end_state_vlans_list = existing_vlans_list
|
end_state_vlans_list = existing_vlans_list
|
||||||
|
|
||||||
if commands:
|
if commands:
|
||||||
|
if existing:
|
||||||
|
if (existing.get('mapped_vni') != proposed.get('mapped_vni') and
|
||||||
|
existing.get('mapped_vni') != '0' and proposed.get('mapped_vni') != 'default'):
|
||||||
|
commands.insert(1, 'no vn-segment')
|
||||||
if module.check_mode:
|
if module.check_mode:
|
||||||
module.exit_json(changed=True,
|
module.exit_json(changed=True,
|
||||||
commands=commands)
|
commands=commands)
|
||||||
|
@ -416,17 +1125,11 @@ def main():
|
||||||
results['existing'] = existing
|
results['existing'] = existing
|
||||||
results['end_state'] = end_state
|
results['end_state'] = end_state
|
||||||
results['end_state_vlans_list'] = end_state_vlans_list
|
results['end_state_vlans_list'] = end_state_vlans_list
|
||||||
results['state'] = state
|
|
||||||
results['updates'] = commands
|
results['updates'] = commands
|
||||||
results['changed'] = changed
|
results['changed'] = changed
|
||||||
|
|
||||||
module.exit_json(**results)
|
module.exit_json(**results)
|
||||||
|
|
||||||
from ansible.module_utils.basic import *
|
|
||||||
from ansible.module_utils.urls import *
|
|
||||||
from ansible.module_utils.shell import *
|
|
||||||
from ansible.module_utils.netcfg import *
|
|
||||||
from ansible.module_utils.nxos import *
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
main()
|
main()
|
||||||
|
|
Loading…
Reference in a new issue