317 lines
9.5 KiB
Python
317 lines
9.5 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/>.
|
|
#
|
|
from __future__ import absolute_import, division, print_function
|
|
|
|
__metaclass__ = type
|
|
|
|
DOCUMENTATION = """
|
|
module: nxos_feature
|
|
extends_documentation_fragment:
|
|
- cisco.nxos.nxos
|
|
short_description: Manage features in NX-OS switches.
|
|
notes:
|
|
- Tested against Cisco MDS NX-OS 9.2(2)
|
|
description:
|
|
- Offers ability to enable and disable features in NX-OS.
|
|
version_added: 1.0.0
|
|
author:
|
|
- Jason Edelman (@jedelman8)
|
|
- Gabriele Gerbino (@GGabriele)
|
|
- Suhas Bharadwaj (@srbharadwaj)
|
|
options:
|
|
feature:
|
|
description:
|
|
- Name of feature.
|
|
required: true
|
|
type: str
|
|
state:
|
|
description:
|
|
- Desired state of the feature.
|
|
required: false
|
|
default: enabled
|
|
choices:
|
|
- enabled
|
|
- disabled
|
|
type: str
|
|
"""
|
|
|
|
EXAMPLES = """
|
|
- name: Ensure lacp is enabled
|
|
cisco.nxos.nxos_feature:
|
|
feature: lacp
|
|
state: enabled
|
|
|
|
- name: Ensure ospf is disabled
|
|
cisco.nxos.nxos_feature:
|
|
feature: ospf
|
|
state: disabled
|
|
|
|
- name: Ensure vpc is enabled
|
|
cisco.nxos.nxos_feature:
|
|
feature: vpc
|
|
state: enabled
|
|
"""
|
|
|
|
RETURN = """
|
|
commands:
|
|
description: The set of commands to be sent to the remote device
|
|
returned: always
|
|
type: list
|
|
sample: ['nv overlay evpn']
|
|
"""
|
|
|
|
import re
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.connection import ConnectionError
|
|
from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.nxos import (
|
|
load_config,
|
|
run_commands,
|
|
get_config,
|
|
)
|
|
from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.nxos import (
|
|
get_capabilities,
|
|
nxos_argument_spec,
|
|
)
|
|
|
|
|
|
def get_available_features(feature, module):
|
|
available_features = {}
|
|
feature_regex = r"(?P<feature>\S+)\s+\d+\s+(?P<state>.*)"
|
|
command = {"command": "show feature", "output": "text"}
|
|
|
|
try:
|
|
body = run_commands(module, [command])[0]
|
|
split_body = body.splitlines()
|
|
except (KeyError, IndexError):
|
|
return {}
|
|
|
|
for line in split_body:
|
|
try:
|
|
match_feature = re.match(feature_regex, line, re.DOTALL)
|
|
feature_group = match_feature.groupdict()
|
|
feature = feature_group["feature"]
|
|
state = feature_group["state"]
|
|
except AttributeError:
|
|
feature = ""
|
|
state = ""
|
|
|
|
if feature and state:
|
|
if "enabled" in state:
|
|
state = "enabled"
|
|
|
|
if feature not in available_features:
|
|
available_features[feature] = state
|
|
else:
|
|
if (
|
|
available_features[feature] == "disabled"
|
|
and state == "enabled"
|
|
):
|
|
available_features[feature] = state
|
|
|
|
# certain configurable features do not
|
|
# show up in the output of "show feature"
|
|
# but appear in running-config when set
|
|
run_cfg = get_config(module, flags=["| include ^feature"])
|
|
for item in re.findall(r"feature\s(.*)", run_cfg):
|
|
if item not in available_features:
|
|
available_features[item] = "enabled"
|
|
|
|
if "fabric forwarding" not in available_features:
|
|
available_features["fabric forwarding"] = "disabled"
|
|
|
|
return available_features
|
|
|
|
|
|
def get_commands(proposed, existing, state, module):
|
|
feature = validate_feature(module, mode="config")
|
|
commands = []
|
|
feature_check = proposed == existing
|
|
if not feature_check:
|
|
if state == "enabled":
|
|
command = "feature {0}".format(feature)
|
|
commands.append(command)
|
|
elif state == "disabled":
|
|
command = "no feature {0}".format(feature)
|
|
commands.append(command)
|
|
return commands
|
|
|
|
|
|
def get_mds_mapping_features():
|
|
feature_to_be_mapped = {
|
|
"show": {
|
|
"fcrxbbcredit": "extended_credit",
|
|
"port-track": "port_track",
|
|
"scp-server": "scpServer",
|
|
"sftp-server": "sftpServer",
|
|
"ssh": "sshServer",
|
|
"tacacs+": "tacacs",
|
|
"telnet": "telnetServer",
|
|
},
|
|
"config": {
|
|
"extended_credit": "fcrxbbcredit",
|
|
"port_track": "port-track",
|
|
"scpServer": "scp-server",
|
|
"sftpServer": "sftp-server",
|
|
"sshServer": "ssh",
|
|
"tacacs": "tacacs+",
|
|
"telnetServer": "telnet",
|
|
},
|
|
}
|
|
return feature_to_be_mapped
|
|
|
|
|
|
def validate_feature(module, mode="show"):
|
|
"""Some features may need to be mapped due to inconsistency
|
|
between how they appear from "show feature" output and
|
|
how they are configured"""
|
|
|
|
feature = module.params["feature"]
|
|
|
|
try:
|
|
info = get_capabilities(module)
|
|
device_info = info.get("device_info", {})
|
|
os_version = device_info.get("network_os_version", "")
|
|
os_platform = device_info.get("network_os_platform", "")
|
|
except ConnectionError:
|
|
os_version = ""
|
|
os_platform = ""
|
|
|
|
if "8.1" in os_version:
|
|
feature_to_be_mapped = {
|
|
"show": {
|
|
"nv overlay": "nve",
|
|
"vn-segment-vlan-based": "vnseg_vlan",
|
|
"hsrp": "hsrp_engine",
|
|
"fabric multicast": "fabric_mcast",
|
|
"scp-server": "scpServer",
|
|
"sftp-server": "sftpServer",
|
|
"sla responder": "sla_responder",
|
|
"sla sender": "sla_sender",
|
|
"ssh": "sshServer",
|
|
"tacacs+": "tacacs",
|
|
"telnet": "telnetServer",
|
|
"ethernet-link-oam": "elo",
|
|
},
|
|
"config": {
|
|
"nve": "nv overlay",
|
|
"vnseg_vlan": "vn-segment-vlan-based",
|
|
"hsrp_engine": "hsrp",
|
|
"fabric_mcast": "fabric multicast",
|
|
"scpServer": "scp-server",
|
|
"sftpServer": "sftp-server",
|
|
"sla_sender": "sla sender",
|
|
"sla_responder": "sla responder",
|
|
"sshServer": "ssh",
|
|
"tacacs": "tacacs+",
|
|
"telnetServer": "telnet",
|
|
"elo": "ethernet-link-oam",
|
|
},
|
|
}
|
|
else:
|
|
feature_to_be_mapped = {
|
|
"show": {
|
|
"nv overlay": "nve",
|
|
"vn-segment-vlan-based": "vnseg_vlan",
|
|
"hsrp": "hsrp_engine",
|
|
"fabric multicast": "fabric_mcast",
|
|
"scp-server": "scpServer",
|
|
"sftp-server": "sftpServer",
|
|
"sla responder": "sla_responder",
|
|
"sla sender": "sla_sender",
|
|
"ssh": "sshServer",
|
|
"tacacs+": "tacacs",
|
|
"telnet": "telnetServer",
|
|
"ethernet-link-oam": "elo",
|
|
"port-security": "eth_port_sec",
|
|
},
|
|
"config": {
|
|
"nve": "nv overlay",
|
|
"vnseg_vlan": "vn-segment-vlan-based",
|
|
"hsrp_engine": "hsrp",
|
|
"fabric_mcast": "fabric multicast",
|
|
"scpServer": "scp-server",
|
|
"sftpServer": "sftp-server",
|
|
"sla_sender": "sla sender",
|
|
"sla_responder": "sla responder",
|
|
"sshServer": "ssh",
|
|
"tacacs": "tacacs+",
|
|
"telnetServer": "telnet",
|
|
"elo": "ethernet-link-oam",
|
|
"eth_port_sec": "port-security",
|
|
},
|
|
}
|
|
|
|
if os_platform.startswith("DS-"):
|
|
feature_to_be_mapped = get_mds_mapping_features()
|
|
|
|
if feature in feature_to_be_mapped[mode]:
|
|
feature = feature_to_be_mapped[mode][feature]
|
|
|
|
return feature
|
|
|
|
|
|
def main():
|
|
argument_spec = dict(
|
|
feature=dict(type="str", required=True),
|
|
state=dict(choices=["enabled", "disabled"], default="enabled"),
|
|
)
|
|
|
|
argument_spec.update(nxos_argument_spec)
|
|
|
|
module = AnsibleModule(
|
|
argument_spec=argument_spec, supports_check_mode=True
|
|
)
|
|
|
|
warnings = list()
|
|
results = dict(changed=False, warnings=warnings)
|
|
|
|
feature = validate_feature(module)
|
|
state = module.params["state"].lower()
|
|
|
|
available_features = get_available_features(feature, module)
|
|
if feature not in available_features:
|
|
module.fail_json(
|
|
msg="Invalid feature name.",
|
|
features_currently_supported=available_features,
|
|
invalid_feature=feature,
|
|
)
|
|
else:
|
|
existstate = available_features[feature]
|
|
|
|
existing = dict(state=existstate)
|
|
proposed = dict(state=state)
|
|
results["changed"] = False
|
|
|
|
cmds = get_commands(proposed, existing, state, module)
|
|
|
|
if cmds:
|
|
# On N35 A8 images, some features return a yes/no prompt
|
|
# on enablement or disablement. Bypass using terminal dont-ask
|
|
cmds.insert(0, "terminal dont-ask")
|
|
if not module.check_mode:
|
|
load_config(module, cmds)
|
|
results["changed"] = True
|
|
|
|
results["commands"] = cmds
|
|
module.exit_json(**results)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|