Mr.X

#
# 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_pim
extends_documentation_fragment:
- cisco.nxos.nxos
short_description: Manages configuration of a PIM instance.
description:
- Manages configuration of a Protocol Independent Multicast (PIM) instance.
notes:
- Unsupported for Cisco MDS
version_added: 1.0.0
author: Gabriele Gerbino (@GGabriele)
options:
  bfd:
    description:
    - Enables BFD on all PIM interfaces.
    - "Dependency: ''feature bfd''"
    type: str
    choices:
    - enable
    - disable
  ssm_range:
    description:
    - Configure group ranges for Source Specific Multicast (SSM). Valid values are
      multicast addresses or the keyword C(none) or keyword C(default). C(none) removes
      all SSM group ranges. C(default) will set ssm_range to the default multicast
      address. If you set multicast address, please ensure that it is not the same
      as the C(default), otherwise use the C(default) option.
    type: list
    default: []
    elements: str
"""
EXAMPLES = """
- name: Configure ssm_range, enable bfd
  cisco.nxos.nxos_pim:
    bfd: enable
    ssm_range: 224.0.0.0/8

- name: Set to default
  cisco.nxos.nxos_pim:
    ssm_range: default

- name: Remove all ssm group ranges
  cisco.nxos.nxos_pim:
    ssm_range: none
"""

RETURN = """
commands:
    description: commands sent to the device
    returned: always
    type: list
    sample:
      - ip pim bfd
      - ip pim ssm range 224.0.0.0/8
"""


import re

from ansible.module_utils.basic import AnsibleModule
from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.config import (
    CustomNetworkConfig,
)

from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.nxos import (
    get_config,
    load_config,
)


PARAM_TO_COMMAND_KEYMAP = {
    "bfd": "ip pim bfd",
    "ssm_range": "ip pim ssm range",
}


def get_existing(module, args):
    existing = {}
    config = str(get_config(module))

    for arg in args:
        if "ssm_range" in arg:
            # <value> may be 'n.n.n.n/s', 'none', or 'default'
            m = re.search(
                r"ssm range (?P<value>(?:[\s\d.\/]+|none|default))?$",
                config,
                re.M,
            )
            if m:
                # Remove rsvd SSM range
                value = m.group("value").replace("232.0.0.0/8", "")
                existing[arg] = value.split()

        elif "bfd" in arg and "ip pim bfd" in config:
            existing[arg] = "enable"

    return existing


def apply_key_map(key_map, table):
    new_dict = {}
    for key, value in table.items():
        new_key = key_map.get(key)
        if value is not None:
            new_dict[new_key] = value
    return new_dict


def get_commands(module, existing, proposed, candidate):
    commands = list()
    proposed_commands = apply_key_map(PARAM_TO_COMMAND_KEYMAP, proposed)

    for key, value in proposed_commands.items():
        command = ""
        if key == "ip pim ssm range":
            if value == "default":
                # no cmd needs a value but the actual value does not matter
                command = "no ip pim ssm range none"
            elif value == "none":
                command = "ip pim ssm range none"
            elif value:
                command = "ip pim ssm range {0}".format(value)
        elif key == "ip pim bfd":
            no_cmd = "no " if value == "disable" else ""
            command = no_cmd + key

        if command:
            commands.append(command)

    if commands:
        candidate.add(commands, parents=[])


def main():
    argument_spec = dict(
        bfd=dict(required=False, type="str", choices=["enable", "disable"]),
        ssm_range=dict(required=False, type="list", default=[], elements="str"),
    )

    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
    warnings = list()
    result = {"changed": False, "commands": [], "warnings": warnings}

    params = module.params
    args = [k for k in PARAM_TO_COMMAND_KEYMAP.keys() if params[k] is not None]

    # SSM syntax check
    if "ssm_range" in args:
        for item in params["ssm_range"]:
            if re.search("none|default", item):
                break
            if len(item.split(".")) != 4:
                module.fail_json(
                    msg="Valid ssm_range values are multicast addresses "
                    "or the keyword 'none' or the keyword 'default'.",
                )

    existing = get_existing(module, args)
    proposed_args = dict((k, v) for k, v in params.items() if k in args)

    proposed = {}
    for key, value in proposed_args.items():
        if key == "ssm_range":
            if value and value[0] == "default":
                if existing.get(key):
                    proposed[key] = "default"
            else:
                v = sorted(set([str(i) for i in value]))
                ex = sorted(set([str(i) for i in existing.get(key, [])]))
                if v != ex:
                    proposed[key] = " ".join(str(s) for s in v)

        elif key == "bfd":
            if value != existing.get("bfd", "disable"):
                proposed[key] = value

        elif value != existing.get(key):
            proposed[key] = value

    candidate = CustomNetworkConfig(indent=3)
    get_commands(module, existing, proposed, candidate)

    if candidate:
        candidate = candidate.items_text()
        result["commands"] = candidate
        result["changed"] = True
        load_config(module, candidate)

    module.exit_json(**result)


if __name__ == "__main__":
    main()

Name	Type	Size	Permission
__pycache__	Folder		0755
storage	Folder		0755
__init__.py	File	0 B	0644
nxos_aaa_server.py	File	10.19 KB	0644
nxos_aaa_server_host.py	File	10.92 KB	0644
nxos_acl_interfaces.py	File	10.21 KB	0644
nxos_acls.py	File	28.71 KB	0644
nxos_banner.py	File	6.44 KB	0644
nxos_bfd_global.py	File	9.08 KB	0644
nxos_bfd_interfaces.py	File	6.84 KB	0644
nxos_bgp.py	File	25.3 KB	0644
nxos_bgp_address_family.py	File	30.41 KB	0644
nxos_bgp_af.py	File	31.01 KB	0644
nxos_bgp_global.py	File	48.43 KB	0644
nxos_bgp_neighbor.py	File	18.79 KB	0644
nxos_bgp_neighbor_address_family.py	File	33.62 KB	0644
nxos_bgp_neighbor_af.py	File	26.84 KB	0644
nxos_command.py	File	7.41 KB	0644
nxos_config.py	File	22.51 KB	0644
nxos_devicealias.py	File	18.33 KB	0644
nxos_evpn_global.py	File	2.62 KB	0644
nxos_evpn_vni.py	File	9.44 KB	0644
nxos_facts.py	File	8.52 KB	0644
nxos_feature.py	File	9.21 KB	0644
nxos_file_copy.py	File	17.39 KB	0644
nxos_gir.py	File	11.5 KB	0644
nxos_gir_profile_management.py	File	5.84 KB	0644
nxos_hostname.py	File	5.63 KB	0644
nxos_hsrp.py	File	15.02 KB	0644
nxos_hsrp_interfaces.py	File	6.16 KB	0644
nxos_igmp.py	File	4.49 KB	0644
nxos_igmp_interface.py	File	21.88 KB	0644
nxos_igmp_snooping.py	File	9.72 KB	0644
nxos_install_os.py	File	21.07 KB	0644
nxos_interfaces.py	File	13.69 KB	0644
nxos_l2_interfaces.py	File	12.05 KB	0644
nxos_l3_interfaces.py	File	15.12 KB	0644
nxos_lacp.py	File	6.39 KB	0644
nxos_lacp_interfaces.py	File	9.13 KB	0644
nxos_lag_interfaces.py	File	8.66 KB	0644
nxos_lldp_global.py	File	8.68 KB	0644
nxos_lldp_interfaces.py	File	6.21 KB	0644
nxos_logging.py	File	27.52 KB	0644
nxos_logging_global.py	File	21.08 KB	0644
nxos_ntp.py	File	12.98 KB	0644
nxos_ntp_auth.py	File	9.17 KB	0644
nxos_ntp_global.py	File	19.63 KB	0644
nxos_ntp_options.py	File	4.53 KB	0644
nxos_nxapi.py	File	14.01 KB	0644
nxos_ospf_interfaces.py	File	43.32 KB	0644
nxos_ospfv2.py	File	62.64 KB	0644
nxos_ospfv3.py	File	53.01 KB	0644
nxos_overlay_global.py	File	5.64 KB	0644
nxos_pim.py	File	6.15 KB	0644
nxos_pim_interface.py	File	19.74 KB	0644
nxos_pim_rp_address.py	File	7.61 KB	0644
nxos_ping.py	File	7.05 KB	0644
nxos_prefix_lists.py	File	26.39 KB	0644
nxos_reboot.py	File	2.24 KB	0644
nxos_rollback.py	File	3.51 KB	0644
nxos_route_maps.py	File	57.7 KB	0644
nxos_rpm.py	File	12.29 KB	0644
nxos_snapshot.py	File	12.17 KB	0644
nxos_snmp_community.py	File	6.6 KB	0644
nxos_snmp_contact.py	File	3.81 KB	0644
nxos_snmp_host.py	File	15.1 KB	0644
nxos_snmp_location.py	File	3.91 KB	0644
nxos_snmp_server.py	File	50.27 KB	0644
nxos_snmp_traps.py	File	7.97 KB	0644
nxos_snmp_user.py	File	12.34 KB	0644
nxos_static_routes.py	File	20.79 KB	0644
nxos_system.py	File	12.77 KB	0644
nxos_telemetry.py	File	8.98 KB	0644
nxos_udld.py	File	7.09 KB	0644
nxos_udld_interface.py	File	8.51 KB	0644
nxos_user.py	File	15.37 KB	0644
nxos_vlans.py	File	10.6 KB	0644
nxos_vpc.py	File	15.59 KB	0644
nxos_vpc_interface.py	File	9.92 KB	0644
nxos_vrf.py	File	19.78 KB	0644
nxos_vrf_af.py	File	7.71 KB	0644
nxos_vrf_interface.py	File	7.37 KB	0644
nxos_vrrp.py	File	12 KB	0644
nxos_vsan.py	File	10.8 KB	0644
nxos_vtp_domain.py	File	5.73 KB	0644
nxos_vtp_password.py	File	7.8 KB	0644
nxos_vtp_version.py	File	5.54 KB	0644
nxos_vxlan_vtep.py	File	16.86 KB	0644
nxos_vxlan_vtep_vni.py	File	15.7 KB	0644
nxos_zone_zoneset.py	File	33.96 KB	0644

Upload:

Command:

Filemanager

Server Info

System Info