From 330d402e11703bbe34a012120303126d28386567 Mon Sep 17 00:00:00 2001 From: Vinay Mulugund Date: Tue, 27 Feb 2024 23:03:01 +0530 Subject: [PATCH 01/30] [WIP] Add spanning tree resource module --- ....nxos.nxos_spanning_tree_global_module.rst | 0 plugins/cache/__init__.py | 0 plugins/lookup/__init__.py | 0 plugins/module_utils/common/__init__.py | 0 .../argspec/spanning_tree_global/__init__.py | 0 .../spanning_tree_global.py | 79 +++++++ .../config/spanning_tree_global/__init__.py | 0 .../spanning_tree_global.py | 97 ++++++++ .../facts/spanning_tree_global/__init__.py | 0 .../spanning_tree_global.py | 67 ++++++ .../nxos/rm_templates/spanning_tree_global.py | 50 +++++ plugins/modules/nxos_spanning_tree_global.py | 212 ++++++++++++++++++ plugins/plugin_utils/__init__.py | 0 plugins/test/__init__.py | 0 tests/__init__.py | 0 15 files changed, 505 insertions(+) create mode 100644 docs/cisco.nxos.nxos_spanning_tree_global_module.rst create mode 100644 plugins/cache/__init__.py create mode 100644 plugins/lookup/__init__.py create mode 100644 plugins/module_utils/common/__init__.py create mode 100644 plugins/module_utils/network/nxos/argspec/spanning_tree_global/__init__.py create mode 100644 plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py create mode 100644 plugins/module_utils/network/nxos/config/spanning_tree_global/__init__.py create mode 100644 plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py create mode 100644 plugins/module_utils/network/nxos/facts/spanning_tree_global/__init__.py create mode 100644 plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py create mode 100644 plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py create mode 100644 plugins/modules/nxos_spanning_tree_global.py create mode 100644 plugins/plugin_utils/__init__.py create mode 100644 plugins/test/__init__.py create mode 100644 tests/__init__.py diff --git a/docs/cisco.nxos.nxos_spanning_tree_global_module.rst b/docs/cisco.nxos.nxos_spanning_tree_global_module.rst new file mode 100644 index 000000000..e69de29bb diff --git a/plugins/cache/__init__.py b/plugins/cache/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/plugins/lookup/__init__.py b/plugins/lookup/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/plugins/module_utils/common/__init__.py b/plugins/module_utils/common/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/plugins/module_utils/network/nxos/argspec/spanning_tree_global/__init__.py b/plugins/module_utils/network/nxos/argspec/spanning_tree_global/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py new file mode 100644 index 000000000..0ecd94a36 --- /dev/null +++ b/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py @@ -0,0 +1,79 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Red Hat +# GNU General Public License v3.0+ +# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import absolute_import, division, print_function + +__metaclass__ = type + +############################################# +# WARNING # +############################################# +# +# This file is auto generated by the +# ansible.content_builder. +# +# Manually editing this file is not advised. +# +# To update the argspec make the desired changes +# in the documentation in the module file and re-run +# ansible.content_builder commenting out +# the path to external 'docstring' in build.yaml. +# +############################################## + +""" +The arg spec for the nxos_spanning_tree_global module +""" + + +class Spanning_tree_globalArgs(object): # pylint: disable=R0903 + """The arg spec for the nxos_spanning_tree_global module + """ + + argument_spec = { + "config": { + "type": "dict", + "options": { + "bridge_assurance": {"type": "bool"}, + "bridge_domain": {"type": "str"}, + "fcoe": {"type": "bool"}, + "lc_issu": { + "type": "str", + "choices": ["auto", "disruptive", "non-disruptive"], + }, + "loopguard_default": {"type": "bool"}, + "mode": {"type": "str", "choices": ["mst", "rapid-pvst"]}, + "pathcost_method": {"type": "str", "choices": ["long", "short"]}, + "port_type": { + "type": "dict", + "mutually_exclusive": [["edge", "network", "default"]], + "options": { + "edge": { + "type": "str", + "choices": ["bpdufilter", "bpduguard", "default"], + }, + "network": {"type": "bool"}, + "default": {"type": "bool"}, + }, + }, + "vlan": {"type": "str"}, + }, + }, + "running_config": {"type": "str"}, + "state": { + "choices": [ + "merged", + "replaced", + "overridden", + "deleted", + "rendered", + "gathered", + "purged", + "parsed", + ], + "default": "merged", + "type": "str", + }, + } # pylint: disable=C0301 diff --git a/plugins/module_utils/network/nxos/config/spanning_tree_global/__init__.py b/plugins/module_utils/network/nxos/config/spanning_tree_global/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py new file mode 100644 index 000000000..533773294 --- /dev/null +++ b/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py @@ -0,0 +1,97 @@ +# +# -*- coding: utf-8 -*- +# Copyright 2024 Red Hat +# GNU General Public License v3.0+ +# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) +# + +from __future__ import absolute_import, division, print_function + +__metaclass__ = type + +""" +The nxos_spanning_tree_global config file. +It is in this file where the current configuration (as dict) +is compared to the provided configuration (as dict) and the command set +necessary to bring the current configuration to its desired end-state is +created. +""" + +from copy import deepcopy + +from ansible.module_utils.six import iteritems +from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import ( + dict_merge, +) +from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.rm_base.resource_module import ( + ResourceModule, +) +from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.facts.facts import ( + Facts, +) +from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.rm_templates.spanning_tree_global import ( + Spanning_tree_globalTemplate, +) + + +class Spanning_tree_global(ResourceModule): + """ + The nxos_spanning_tree_global config class + """ + + def __init__(self, module): + super(Spanning_tree_global, self).__init__( + empty_fact_val={}, + facts_module=Facts(module), + module=module, + resource="spanning_tree_global", + tmplt=Spanning_tree_globalTemplate(), + ) + self.parsers = [ + ] + + def execute_module(self): + """ Execute the module + + :rtype: A dictionary + :returns: The result from module execution + """ + if self.state not in ["parsed", "gathered"]: + self.generate_commands() + self.run_commands() + return self.result + + def generate_commands(self): + """ Generate configuration commands to send based on + want, have and desired state. + """ + wantd = {entry['name']: entry for entry in self.want} + haved = {entry['name']: entry for entry in self.have} + + # if state is merged, merge want onto have and then compare + if self.state == "merged": + wantd = dict_merge(haved, wantd) + + # if state is deleted, empty out wantd and set haved to wantd + if self.state == "deleted": + haved = { + k: v for k, v in iteritems(haved) if k in wantd or not wantd + } + wantd = {} + + # remove superfluous config for overridden and deleted + if self.state in ["overridden", "deleted"]: + for k, have in iteritems(haved): + if k not in wantd: + self._compare(want={}, have=have) + + for k, want in iteritems(wantd): + self._compare(want=want, have=haved.pop(k, {})) + + def _compare(self, want, have): + """Leverages the base class `compare()` method and + populates the list of commands to be run by comparing + the `want` and `have` data with the `parsers` defined + for the Spanning_tree_global network resource. + """ + self.compare(parsers=self.parsers, want=want, have=have) diff --git a/plugins/module_utils/network/nxos/facts/spanning_tree_global/__init__.py b/plugins/module_utils/network/nxos/facts/spanning_tree_global/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py new file mode 100644 index 000000000..660374104 --- /dev/null +++ b/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py @@ -0,0 +1,67 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Red Hat +# GNU General Public License v3.0+ +# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import absolute_import, division, print_function + +__metaclass__ = type + +""" +The nxos spanning_tree_global fact class +It is in this file the configuration is collected from the device +for a given resource, parsed, and the facts tree is populated +based on the configuration. +""" + +from copy import deepcopy + +from ansible.module_utils.six import iteritems +from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import ( + utils, +) +from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.rm_templates.spanning_tree_global import ( + Spanning_tree_globalTemplate, +) +from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.argspec.spanning_tree_global.spanning_tree_global import ( + Spanning_tree_globalArgs, +) + +class Spanning_tree_globalFacts(object): + """ The nxos spanning_tree_global facts class + """ + + def __init__(self, module, subspec='config', options='options'): + self._module = module + self.argument_spec = Spanning_tree_globalArgs.argument_spec + + def populate_facts(self, connection, ansible_facts, data=None): + """ Populate the facts for Spanning_tree_global network resource + + :param connection: the device connection + :param ansible_facts: Facts dictionary + :param data: previously collected conf + + :rtype: dictionary + :returns: facts + """ + facts = {} + objs = [] + + if not data: + data = connection.get() + + # parse native config using the Spanning_tree_global template + spanning_tree_global_parser = Spanning_tree_globalTemplate(lines=data.splitlines(), module=self._module) + objs = list(spanning_tree_global_parser.parse().values()) + + ansible_facts['ansible_network_resources'].pop('spanning_tree_global', None) + + params = utils.remove_empties( + spanning_tree_global_parser.validate_config(self.argument_spec, {"config": objs}, redact=True) + ) + + facts['spanning_tree_global'] = params['config'] + ansible_facts['ansible_network_resources'].update(facts) + + return ansible_facts diff --git a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py new file mode 100644 index 000000000..3c0b1aeff --- /dev/null +++ b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Red Hat +# GNU General Public License v3.0+ +# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import absolute_import, division, print_function + +__metaclass__ = type + +""" +The Spanning_tree_global parser templates file. This contains +a list of parser definitions and associated functions that +facilitates both facts gathering and native command generation for +the given network resource. +""" + +import re +from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.rm_base.network_template import ( + NetworkTemplate, +) + +class Spanning_tree_globalTemplate(NetworkTemplate): + def __init__(self, lines=None, module=None): + super(Spanning_tree_globalTemplate, self).__init__(lines=lines, tmplt=self, module=module) + + # fmt: off + PARSERS = [ + { + "name": "key_a", + "getval": re.compile( + r""" + ^key_a\s(?P\S+) + $""", re.VERBOSE), + "setval": "", + "result": { + }, + "shared": True + }, + { + "name": "key_b", + "getval": re.compile( + r""" + \s+key_b\s(?P\S+) + $""", re.VERBOSE), + "setval": "", + "result": { + }, + }, + ] + # fmt: on diff --git a/plugins/modules/nxos_spanning_tree_global.py b/plugins/modules/nxos_spanning_tree_global.py new file mode 100644 index 000000000..3215af314 --- /dev/null +++ b/plugins/modules/nxos_spanning_tree_global.py @@ -0,0 +1,212 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# Copyright 2024 Red Hat +# GNU General Public License v3.0+ +# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +""" +The module file for nxos_spanning_tree_global +""" + +from __future__ import absolute_import, division, print_function + +__metaclass__ = type + +DOCUMENTATION = """ +module: nxos_spanning_tree_global +extends_documentation_fragment: +- cisco.nxos.nxos +short_description: + - Resource module to configure spanning tree. +description: + - This module configures and manages the attributes of Spanning-tree on Cisco NXOS. +version_added: 6.0.3 +author: Vinay Mulugund (@roverflow) +notes: + - Tested against NX-OS 9.3.6. + - This module works with connection C(network_cli) and C(httpapi). + See U(https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html) +options: + config: + description: A dict of Spanning-tree options. + type: dict + suboptions: + bridge_assurance: + description: Enable bridge assurance. + type: bool + bridge_domain: + decsription: Bridge-Domain Spanning Trees range. + type: str + fcoe: + description: Enable STP for FCoE VLANs. + type: bool + lc_issu: + description: Configure Linecard ISSU type. + type: str + choices: + - auto + - disruptive + - non-disruptive + loopguard_default: + description: Spanning tree loopguard . + type: bool + mode: + description: Spanning tree mode. + type: str + choices: + - mst + - rapid-pvst + pathcost_method: + description: Spanning tree pathcost options. + type: str + choices: + - long + - short + port_type: + description: Spanning tree port type. + type: dict + mutually_exclusive: [["edge", "network", "default"]] + suboptions: + edge: + description: Enable edge port type. + type: str + choices: + - bpdufilter + - bpduguard + - default + network: + description: Enable network port type. + type: bool + default: + description: Enable default port type. + type: bool + vlan: + description: Spanning tree VLAN range. + type: str + running_config: + description: + - This option is used only with state I(parsed). + - The value of this option should be the output received from the NXOS device by + executing the command B(show running-config | section ^spanning-tree). + - The state I(parsed) reads the configuration from C(running_config) option and + transforms it into Ansible structured data as per the resource module's argspec + and the value is then returned in the I(parsed) key within the result. + type: str + state: + choices: + - merged + - replaced + - overridden + - deleted + - rendered + - gathered + - purged + - parsed + default: merged + description: + - The state the configuration should be left in + - The states I(rendered), I(gathered) and I(parsed) does not perform any change + on the device. + - The state I(rendered) will transform the configuration in C(config) option to + platform specific CLI commands which will be returned in the I(rendered) key + within the result. For state I(rendered) active connection to remote host is + not required. + - The state I(gathered) will fetch the running configuration from device and transform + it into structured data in the format as per the resource module argspec and + the value is returned in the I(gathered) key within the result. + - The state I(parsed) reads the configuration from C(running_config) option and + transforms it into JSON format as per the resource module parameters and the + value is returned in the I(parsed) key within the result. The value of C(running_config) + option should be the same format as the output of command I(show running-config + | include ip route|ipv6 route) executed on device. For state I(parsed) active + connection to remote host is not required. + - The state I(purged) negates virtual/logical interfaces that are specified in task + from running-config. + type: str +""" + +EXAMPLES = """ + +""" + +RETURN = """ +before: + description: The configuration prior to the module execution. + returned: when I(state) is C(merged), C(replaced), C(overridden), C(deleted) or C(purged) + type: dict + sample: > + This output will always be in the same format as the + module argspec. +after: + description: The resulting configuration after module execution. + returned: when changed + type: dict + sample: > + This output will always be in the same format as the + module argspec. +commands: + description: The set of commands pushed to the remote device. + returned: when I(state) is C(merged), C(replaced), C(overridden), C(deleted) or C(purged) + type: list + sample: + - sample command 1 + - sample command 2 + - sample command 3 +rendered: + description: The provided configuration in the task rendered in device-native format (offline). + returned: when I(state) is C(rendered) + type: list + sample: + - sample command 1 + - sample command 2 + - sample command 3 +gathered: + description: Facts about the network resource gathered from the remote device as structured data. + returned: when I(state) is C(gathered) + type: list + sample: > + This output will always be in the same format as the + module argspec. +parsed: + description: The device native config provided in I(running_config) option parsed into structured data as per module argspec. + returned: when I(state) is C(parsed) + type: list + sample: > + This output will always be in the same format as the + module argspec. +""" + +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.argspec.spanning_tree_global.spanning_tree_global import ( + Spanning_tree_globalArgs, +) +from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.config.spanning_tree_global.spanning_tree_global import ( + Spanning_tree_global, +) + + +def main(): + """ + Main entry point for module execution + + :returns: the result form module invocation + """ + module = AnsibleModule( + argument_spec=Spanning_tree_globalArgs.argument_spec, + mutually_exclusive=[["config", "running_config"]], + required_if=[ + ["state", "merged", ["config"]], + ["state", "replaced", ["config"]], + ["state", "overridden", ["config"]], + ["state", "rendered", ["config"]], + ["state", "parsed", ["running_config"]], + ], + supports_check_mode=True, + ) + + result = Spanning_tree_global(module).execute_module() + module.exit_json(**result) + + +if __name__ == "__main__": + main() diff --git a/plugins/plugin_utils/__init__.py b/plugins/plugin_utils/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/plugins/test/__init__.py b/plugins/test/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 000000000..e69de29bb From b2d15da04ec2b13f29ec73af37c0a80e812eb36f Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 27 Feb 2024 17:35:21 +0000 Subject: [PATCH 02/30] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- ...cisco.nxos.nxos_aaa_server_host_module.rst | 343 - docs/cisco.nxos.nxos_aaa_server_module.rst | 248 - .../cisco.nxos.nxos_acl_interfaces_module.rst | 610 -- docs/cisco.nxos.nxos_acls_module.rst | 4086 ------------ docs/cisco.nxos.nxos_banner_module.rst | 187 - docs/cisco.nxos.nxos_bfd_global_module.rst | 326 - .../cisco.nxos.nxos_bfd_interfaces_module.rst | 394 -- docs/cisco.nxos.nxos_bgp_global_module.rst | 5843 ----------------- ...xos_bgp_neighbor_address_family_module.rst | 3575 ---------- docs/cisco.nxos.nxos_bgp_templates_module.rst | 2841 -------- docs/cisco.nxos.nxos_command_module.rst | 258 - docs/cisco.nxos.nxos_config_module.rst | 566 -- docs/cisco.nxos.nxos_devicealias_module.rst | 273 - docs/cisco.nxos.nxos_evpn_global_module.rst | 122 - docs/cisco.nxos.nxos_evpn_vni_module.rst | 212 - docs/cisco.nxos.nxos_facts_module.rst | 553 -- docs/cisco.nxos.nxos_feature_module.rst | 150 - docs/cisco.nxos.nxos_gir_module.rst | 302 - ...xos.nxos_gir_profile_management_module.rst | 235 - docs/cisco.nxos.nxos_hostname_module.rst | 344 - ...cisco.nxos.nxos_hsrp_interfaces_module.rst | 344 - docs/cisco.nxos.nxos_hsrp_module.rst | 305 - docs/cisco.nxos.nxos_igmp_module.rst | 191 - docs/cisco.nxos.nxos_igmp_snooping_module.rst | 225 - docs/cisco.nxos.nxos_install_os_module.rst | 183 - docs/cisco.nxos.nxos_l2_interfaces_module.rst | 648 -- docs/cisco.nxos.nxos_l3_interfaces_module.rst | 884 --- docs/cisco.nxos.nxos_lacp_module.rst | 402 -- ...cisco.nxos.nxos_lldp_interfaces_module.rst | 407 -- docs/cisco.nxos.nxos_logging_module.rst | 458 -- docs/cisco.nxos.nxos_ntp_auth_module.rst | 224 - docs/cisco.nxos.nxos_ntp_global_module.rst | 1411 ---- docs/cisco.nxos.nxos_ntp_module.rst | 314 - docs/cisco.nxos.nxos_ntp_options_module.rst | 192 - docs/cisco.nxos.nxos_nxapi_module.rst | 300 - ...cisco.nxos.nxos_ospf_interfaces_module.rst | 1732 ----- docs/cisco.nxos.nxos_ospfv2_module.rst | 5458 --------------- .../cisco.nxos.nxos_overlay_global_module.rst | 120 - docs/cisco.nxos.nxos_pim_module.rst | 148 - docs/cisco.nxos.nxos_ping_module.rst | 311 - docs/cisco.nxos.nxos_prefix_lists_module.rst | 1049 --- docs/cisco.nxos.nxos_reboot_module.rst | 123 - docs/cisco.nxos.nxos_rollback_module.rst | 159 - docs/cisco.nxos.nxos_route_maps_module.rst | 4368 ------------ docs/cisco.nxos.nxos_rpm_module.rst | 226 - docs/cisco.nxos.nxos_snapshot_module.rst | 363 - .../cisco.nxos.nxos_snmp_community_module.rst | 201 - docs/cisco.nxos.nxos_snmp_host_module.rst | 288 - docs/cisco.nxos.nxos_snmp_location_module.rst | 156 - docs/cisco.nxos.nxos_snmp_server_module.rst | 4474 ------------- docs/cisco.nxos.nxos_snmp_traps_module.rst | 189 - docs/cisco.nxos.nxos_snmp_user_module.rst | 235 - .../cisco.nxos.nxos_udld_interface_module.rst | 250 - docs/cisco.nxos.nxos_udld_module.rst | 256 - docs/cisco.nxos.nxos_user_module.rst | 390 -- docs/cisco.nxos.nxos_vpc_module.rst | 352 - docs/cisco.nxos.nxos_vrf_af_module.rst | 300 - docs/cisco.nxos.nxos_vrf_module.rst | 494 -- docs/cisco.nxos.nxos_vrrp_module.rst | 277 - docs/cisco.nxos.nxos_vsan_module.rst | 225 - docs/cisco.nxos.nxos_vxlan_vtep_module.rst | 332 - docs/cisco.nxos.nxos_zone_zoneset_module.rst | 537 -- 62 files changed, 50969 deletions(-) delete mode 100644 docs/cisco.nxos.nxos_aaa_server_host_module.rst delete mode 100644 docs/cisco.nxos.nxos_aaa_server_module.rst delete mode 100644 docs/cisco.nxos.nxos_acl_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_acls_module.rst delete mode 100644 docs/cisco.nxos.nxos_banner_module.rst delete mode 100644 docs/cisco.nxos.nxos_bfd_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_bfd_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_bgp_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst delete mode 100644 docs/cisco.nxos.nxos_bgp_templates_module.rst delete mode 100644 docs/cisco.nxos.nxos_command_module.rst delete mode 100644 docs/cisco.nxos.nxos_config_module.rst delete mode 100644 docs/cisco.nxos.nxos_devicealias_module.rst delete mode 100644 docs/cisco.nxos.nxos_evpn_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_evpn_vni_module.rst delete mode 100644 docs/cisco.nxos.nxos_facts_module.rst delete mode 100644 docs/cisco.nxos.nxos_feature_module.rst delete mode 100644 docs/cisco.nxos.nxos_gir_module.rst delete mode 100644 docs/cisco.nxos.nxos_gir_profile_management_module.rst delete mode 100644 docs/cisco.nxos.nxos_hostname_module.rst delete mode 100644 docs/cisco.nxos.nxos_hsrp_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_hsrp_module.rst delete mode 100644 docs/cisco.nxos.nxos_igmp_module.rst delete mode 100644 docs/cisco.nxos.nxos_igmp_snooping_module.rst delete mode 100644 docs/cisco.nxos.nxos_install_os_module.rst delete mode 100644 docs/cisco.nxos.nxos_l2_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_l3_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_lacp_module.rst delete mode 100644 docs/cisco.nxos.nxos_lldp_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_logging_module.rst delete mode 100644 docs/cisco.nxos.nxos_ntp_auth_module.rst delete mode 100644 docs/cisco.nxos.nxos_ntp_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_ntp_module.rst delete mode 100644 docs/cisco.nxos.nxos_ntp_options_module.rst delete mode 100644 docs/cisco.nxos.nxos_nxapi_module.rst delete mode 100644 docs/cisco.nxos.nxos_ospf_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_ospfv2_module.rst delete mode 100644 docs/cisco.nxos.nxos_overlay_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_pim_module.rst delete mode 100644 docs/cisco.nxos.nxos_ping_module.rst delete mode 100644 docs/cisco.nxos.nxos_prefix_lists_module.rst delete mode 100644 docs/cisco.nxos.nxos_reboot_module.rst delete mode 100644 docs/cisco.nxos.nxos_rollback_module.rst delete mode 100644 docs/cisco.nxos.nxos_route_maps_module.rst delete mode 100644 docs/cisco.nxos.nxos_rpm_module.rst delete mode 100644 docs/cisco.nxos.nxos_snapshot_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_community_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_host_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_location_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_server_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_traps_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_user_module.rst delete mode 100644 docs/cisco.nxos.nxos_udld_interface_module.rst delete mode 100644 docs/cisco.nxos.nxos_udld_module.rst delete mode 100644 docs/cisco.nxos.nxos_user_module.rst delete mode 100644 docs/cisco.nxos.nxos_vpc_module.rst delete mode 100644 docs/cisco.nxos.nxos_vrf_af_module.rst delete mode 100644 docs/cisco.nxos.nxos_vrf_module.rst delete mode 100644 docs/cisco.nxos.nxos_vrrp_module.rst delete mode 100644 docs/cisco.nxos.nxos_vsan_module.rst delete mode 100644 docs/cisco.nxos.nxos_vxlan_vtep_module.rst delete mode 100644 docs/cisco.nxos.nxos_zone_zoneset_module.rst diff --git a/docs/cisco.nxos.nxos_aaa_server_host_module.rst b/docs/cisco.nxos.nxos_aaa_server_host_module.rst deleted file mode 100644 index 5730e6359..000000000 --- a/docs/cisco.nxos.nxos_aaa_server_host_module.rst +++ /dev/null @@ -1,343 +0,0 @@ -.. _cisco.nxos.nxos_aaa_server_host_module: - - -******************************* -cisco.nxos.nxos_aaa_server_host -******************************* - -**Manages AAA server host-specific configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages AAA server host-specific configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- acct_port - -
- string -
- 		- -
Alternate UDP port for RADIUS accounting or keyword 'default'.
-
-
- address - -
- string - / required -
- 		- -
Address or name of the radius or tacacs host.
-
-
- auth_port - -
- string -
- 		- -
Alternate UDP port for RADIUS authentication or keyword 'default'.
-
-
- encrypt_type - -
- string -
- 		-
    Choices: -
  • 0
    • -
  • 7
    • -
- 		-
The state of encryption applied to the entered key. O for clear text, 7 for encrypted. Type-6 encryption is not supported.
-
-
- host_timeout - -
- string -
- 		- -
Timeout period for specified host, in seconds or keyword 'default. Range is 1-60.
-
-
- key - -
- string -
- 		- -
Shared secret for the specified host or keyword 'default'.
-
-
- server_type - -
- string - / required -
- 		-
    Choices: -
  • radius
    • -
  • tacacs
    • -
- 		-
The server type is either radius or tacacs.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- tacacs_port - -
- string -
- 		- -
Alternate TCP port TACACS Server or keyword 'default'.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - Changes to the host key (shared secret) are not idempotent for type 0. - - If ``state=absent`` removes the whole host configuration. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Radius Server Host Basic settings - - name: Radius Server Host Basic settings - cisco.nxos.nxos_aaa_server_host: - state: present - server_type: radius - address: 1.2.3.4 - acct_port: 2084 - host_timeout: 10 - - # Radius Server Host Key Configuration - - name: Radius Server Host Key Configuration - cisco.nxos.nxos_aaa_server_host: - state: present - server_type: radius - address: 1.2.3.4 - key: hello - encrypt_type: 7 - - # TACACS Server Host Configuration - - name: Tacacs Server Host Configuration - cisco.nxos.nxos_aaa_server_host: - state: present - server_type: tacacs - tacacs_port: 89 - host_timeout: 10 - address: 5.6.7.8 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- end_state - -
- dictionary -
- 		always -
k/v pairs of configuration after module execution
-
-
Sample:
-
{'address': '1.2.3.4', 'auth_port': '2084', 'host_timeout': '10', 'server_type': 'radius'}
-
-
- existing - -
- dictionary -
- 		always -
k/v pairs of existing configuration
-
-
-
- proposed - -
- dictionary -
- 		always -
k/v pairs of parameters passed into module
-
-
Sample:
-
{'address': '1.2.3.4', 'auth_port': '2084', 'host_timeout': '10', 'server_type': 'radius'}
-
-
- updates - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['radius-server host 1.2.3.4 auth-port 2084 timeout 10']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_aaa_server_module.rst b/docs/cisco.nxos.nxos_aaa_server_module.rst deleted file mode 100644 index 1307c9033..000000000 --- a/docs/cisco.nxos.nxos_aaa_server_module.rst +++ /dev/null @@ -1,248 +0,0 @@ -.. _cisco.nxos.nxos_aaa_server_module: - - -************************** -cisco.nxos.nxos_aaa_server -************************** - -**Manages AAA server global configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages AAA server global configuration - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- deadtime - -
- string -
- 		- -
Duration for which a non-reachable AAA server is skipped, in minutes or keyword 'default. Range is 1-1440. Device default is 0.
-
-
- directed_request - -
- string -
- 		-
    Choices: -
  • enabled
    • -
  • disabled
    • -
  • default
    • -
- 		-
Enables direct authentication requests to AAA server or keyword 'default' Device default is disabled.
-
-
- encrypt_type - -
- string -
- 		-
    Choices: -
  • 0
    • -
  • 7
    • -
- 		-
The state of encryption applied to the entered global key. O clear text, 7 encrypted. Type-6 encryption is not supported.
-
-
- global_key - -
- string -
- 		- -
Global AAA shared secret or keyword 'default'.
-
-
- server_timeout - -
- string -
- 		- -
Global AAA server timeout period, in seconds or keyword 'default. Range is 1-60. Device default is 5.
-
-
- server_type - -
- string - / required -
- 		-
    Choices: -
  • radius
    • -
  • tacacs
    • -
- 		-
The server type is either radius or tacacs.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • default
    • -
- 		-
Manage the state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - The server_type parameter is always required. - - If encrypt_type is not supplied, the global AAA server key will be stored as encrypted (type 7). - - Changes to the global AAA server key with encrypt_type=0 are not idempotent. - - state=default will set the supplied parameters to their default values. The parameters that you want to default must also be set to default. If global_key=default, the global key will be removed. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Radius Server Basic settings - - name: Radius Server Basic settings - cisco.nxos.nxos_aaa_server: - server_type: radius - server_timeout: 9 - deadtime: 20 - directed_request: enabled - - # Tacacs Server Basic settings - - name: Tacacs Server Basic settings - cisco.nxos.nxos_aaa_server: - server_type: tacacs - server_timeout: 8 - deadtime: 19 - directed_request: disabled - - # Setting Global Key - - name: AAA Server Global Key - cisco.nxos.nxos_aaa_server: - server_type: radius - global_key: test_key - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['radius-server deadtime 22', 'radius-server timeout 11', 'radius-server directed-request']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_acl_interfaces_module.rst b/docs/cisco.nxos.nxos_acl_interfaces_module.rst deleted file mode 100644 index a2885df02..000000000 --- a/docs/cisco.nxos.nxos_acl_interfaces_module.rst +++ /dev/null @@ -1,610 +0,0 @@ -.. _cisco.nxos.nxos_acl_interfaces_module: - - -****************************** -cisco.nxos.nxos_acl_interfaces -****************************** - -**ACL interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Add and remove Access Control Lists on interfaces in NX-OS platform - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of interfaces to be configured with ACLs
-
-
- access_groups - -
- list - / elements=dictionary -
- 		- -
List of address family indicators with ACLs to be configured on the interface
-
-
- acls - -
- list - / elements=dictionary -
- 		- -
List of Access Control Lists for the interface
-
-
- direction - -
- string - / required -
- 		-
    Choices: -
  • in
    • -
  • out
    • -
- 		-
Direction to be applied for the ACL
-
-
- name - -
- string - / required -
- 		- -
Name of the ACL to be added/removed
-
-
- port - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use ACL as port policy.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
Address Family Indicator of the ACLs to be configured
-
-
- name - -
- string - / required -
- 		- -
Name of the interface
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • deleted
    • -
  • gathered
    • -
  • merged ←
    • -
  • overridden
    • -
  • rendered
    • -
  • replaced
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------ - # - - - name: Merge ACL interfaces configuration - cisco.nxos.nxos_acl_interfaces: - config: - - name: Ethernet1/2 - access_groups: - - afi: ipv6 - acls: - - name: ACL1v6 - direction: in - - - name: Eth1/5 - access_groups: - - afi: ipv4 - acls: - - name: PortACL - direction: in - port: true - - - name: ACL1v4 - direction: out - - - afi: ipv6 - acls: - - name: ACL1v6 - direction: in - state: merged - - # After state: - # ------------ - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ip port access-group PortACL in - # ip access-group ACL1v4 out - # ipv6 traffic-filter ACL1v6 in - - # Using replaced - - # Before state: - # ------------ - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ip port access-group PortACL in - # ip access-group ACL1v4 out - # ipv6 traffic-filter ACL1v6 in - - - name: Replace interface configuration with given configuration - cisco.nxos.nxos_acl_interfaces: - config: - - name: Eth1/5 - access_groups: - - afi: ipv4 - acls: - - name: NewACLv4 - direction: out - - - name: Ethernet1/3 - access_groups: - - afi: ipv6 - acls: - - name: NewACLv6 - direction: in - port: true - state: replaced - - # After state: - # ------------ - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/3 - # ipv6 port traffic-filter NewACLv6 in - # interface Ethernet1/5 - # ip access-group NewACLv4 out - - # Using overridden - - # Before state: - # ------------ - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ip port access-group PortACL in - # ip access-group ACL1v4 out - # ipv6 traffic-filter ACL1v6 in - - - name: Override interface configuration with given configuration - cisco.nxos.nxos_acl_interfaces: - config: - - name: Ethernet1/3 - access_groups: - - afi: ipv4 - acls: - - name: ACL1v4 - direction: out - - - name: PortACL - port: true - direction: in - - afi: ipv6 - acls: - - name: NewACLv6 - direction: in - port: true - state: overridden - - # After state: - # ------------ - # interface Ethernet1/3 - # ip access-group ACL1v4 out - # ip port access-group PortACL in - # ipv6 port traffic-filter NewACLv6 in - - # Using deleted to remove ACL config from specified interfaces - - # Before state: - # ------------- - # interface Ethernet1/1 - # ip access-group ACL2v4 in - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ip port access-group PortACL in - # ip access-group ACL1v4 out - # ipv6 traffic-filter ACL1v6 in - - - name: Delete ACL configuration on interfaces - cisco.nxos.nxos_acl_interfaces: - config: - - name: Ethernet1/5 - - name: Ethernet1/2 - state: deleted - - # After state: - # ------------- - # interface Ethernet1/1 - # ip access-group ACL2v4 in - # interface Ethernet1/2 - # interface Ethernet1/5 - - # Using deleted to remove ACL config from all interfaces - - # Before state: - # ------------- - # interface Ethernet1/1 - # ip access-group ACL2v4 in - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ip port access-group PortACL in - # ip access-group ACL1v4 out - # ipv6 traffic-filter ACL1v6 in - - - name: Delete ACL configuration from all interfaces - cisco.nxos.nxos_acl_interfaces: - state: deleted - - # After state: - # ------------- - # interface Ethernet1/1 - # interface Ethernet1/2 - # interface Ethernet1/5 - - # Using parsed - - - name: Parse given configuration into structured format - cisco.nxos.nxos_acl_interfaces: - running_config: | - interface Ethernet1/2 - ipv6 traffic-filter ACL1v6 in - interface Ethernet1/5 - ipv6 traffic-filter ACL1v6 in - ip access-group ACL1v4 out - ip port access-group PortACL in - state: parsed - - # returns - # parsed: - # - name: Ethernet1/2 - # access_groups: - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # direction: in - # - name: Ethernet1/5 - # access_groups: - # - afi: ipv4 - # acls: - # - name: PortACL - # direction: in - # port: True - # - name: ACL1v4 - # direction: out - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # direction: in - - - # Using gathered: - - # Before state: - # ------------ - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ipv6 traffic-filter ACL1v6 in - # ip access-group ACL1v4 out - # ip port access-group PortACL in - - - name: Gather existing configuration from device - cisco.nxos.nxos_acl_interfaces: - config: - state: gathered - - # returns - # gathered: - # - name: Ethernet1/2 - # access_groups: - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # direction: in - # - name: Ethernet1/5 - # access_groups: - # - afi: ipv4 - # acls: - # - name: PortACL - # direction: in - # port: True - # - name: ACL1v4 - # direction: out - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # direction: in - - - # Using rendered - - - name: Render required configuration to be pushed to the device - cisco.nxos.nxos_acl_interfaces: - config: - - name: Ethernet1/2 - access_groups: - - afi: ipv6 - acls: - - name: ACL1v6 - direction: in - - name: Ethernet1/5 - access_groups: - - afi: ipv4 - acls: - - name: PortACL - direction: in - port: true - - name: ACL1v4 - direction: out - - afi: ipv6 - acls: - - name: ACL1v6 - direction: in - state: rendered - - - # returns - # rendered: - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ipv6 traffic-filter ACL1v6 in - # ip access-group ACL1v4 out - # ip port access-group PortACL in - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/2', 'ipv6 traffic-filter ACL1v6 out', 'ip port access-group PortACL in']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_acls_module.rst b/docs/cisco.nxos.nxos_acls_module.rst deleted file mode 100644 index 1b806511d..000000000 --- a/docs/cisco.nxos.nxos_acls_module.rst +++ /dev/null @@ -1,4086 +0,0 @@ -.. _cisco.nxos.nxos_acls_module: - - -******************** -cisco.nxos.nxos_acls -******************** - -**ACLs resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manage named IP ACLs on the Cisco NX-OS platform - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A dictionary of ACL options.
-
-
- acls - -
- list - / elements=dictionary -
- 		- -
A list of the ACLs.
-
-
- aces - -
- list - / elements=dictionary -
- 		- -
The entries within the ACL.
-
-
- destination - -
- dictionary -
- 		- -
Specify the packet destination.
-
-
- address - -
- string -
- 		- -
Destination network address.
-
-
- any - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Any destination address.
-
-
- host - -
- string -
- 		- -
Host IP address.
-
-
- port_protocol - -
- dictionary -
- 		- -
Specify the destination port or protocol (only for TCP and UDP).
-
-
- eq - -
- string -
- 		- -
Match only packets on a given port number.
-
-
- gt - -
- string -
- 		- -
Match only packets with a greater port number.
-
-
- lt - -
- string -
- 		- -
Match only packets with a lower port number.
-
-
- neq - -
- string -
- 		- -
Match only packets not on a given port number.
-
-
- range - -
- dictionary -
- 		- -
Match only packets in the range of port numbers.
-
-
- end - -
- string -
- 		- -
Specify the end of the port range.
-
-
- start - -
- string -
- 		- -
Specify the start of the port range.
-
-
- prefix - -
- string -
- 		- -
Destination network prefix. Only for prefixes of value less than 31 for ipv4 and 127 for ipv6. Prefixes of 32 (ipv4) and 128 (ipv6) should be given in the 'host' key.
-
-
- wildcard_bits - -
- string -
- 		- -
Destination wildcard bits.
-
-
- dscp - -
- string -
- 		- -
Match packets with given DSCP value.
-
-
- fragments - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Check non-initial fragments.
-
-
- grant - -
- string -
- 		-
    Choices: -
  • permit
    • -
  • deny
    • -
- 		-
Action to be applied on the rule.
-
-
- log - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Log matches against this entry.
-
-
- precedence - -
- string -
- 		- -
Match packets with given precedence value.
-
-
- protocol - -
- string -
- 		- -
Specify the protocol.
-
-
- protocol_options - -
- dictionary -
- 		- -
All possible suboptions for the protocol chosen.
-
-
- icmp - -
- dictionary -
- 		- -
ICMP protocol options.
-
-
- administratively_prohibited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively prohibited
-
-
- alternate_address - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Alternate address
-
-
- conversion_error - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Datagram conversion
-
-
- dod_host_prohibited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host prohibited
-
-
- dod_net_prohibited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Net prohibited
-
-
- echo - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo (ping)
-
-
- echo_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo reply
-
-
- echo_request - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo request (ping)
-
-
- general_parameter_problem - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter problem
-
-
- host_isolated - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host isolated
-
-
- host_precedence_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host unreachable for precedence
-
-
- host_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host redirect
-
-
- host_tos_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host redirect for TOS
-
-
- host_tos_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host unreachable for TOS
-
-
- host_unknown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host unknown
-
-
- host_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host unreachable
-
-
- information_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Information replies
-
-
- information_request - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Information requests
-
-
- mask_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Mask replies
-
-
- mask_request - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Mask requests
-
-
- message_code - -
- integer -
- 		- -
ICMP message code
-
-
- message_type - -
- integer -
- 		- -
ICMP message type
-
-
- mobile_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Mobile host redirect
-
-
- net_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Network redirect
-
-
- net_tos_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Net redirect for TOS
-
-
- net_tos_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Network unreachable for TOS
-
-
- net_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Net unreachable
-
-
- network_unknown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Network unknown
-
-
- no_room_for_option - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter required but no room
-
-
- option_missing - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter required but not present
-
-
- packet_too_big - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Fragmentation needed and DF set
-
-
- parameter_problem - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All parameter problems
-
-
- port_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Port unreachable
-
-
- precedence_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Precedence cutoff
-
-
- protocol_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Protocol unreachable
-
-
- reassembly_timeout - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Reassembly timeout
-
-
- redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All redirects
-
-
- router_advertisement - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router discovery advertisements
-
-
- router_solicitation - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router discovery solicitations
-
-
- source_quench - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Source quenches
-
-
- source_route_failed - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Source route failed
-
-
- time_exceeded - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All time exceeded.
-
-
- timestamp_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Timestamp replies
-
-
- timestamp_request - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Timestamp requests
-
-
- traceroute - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Traceroute
-
-
- ttl_exceeded - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
TTL exceeded
-
-
- unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All unreachables
-
-
- icmpv6 - -
- dictionary -
- 		- -
ICMPv6 protocol options.
-
-
- beyond_scope - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Destination beyond scope.
-
-
- destination_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Destination address is unreachable.
-
-
- echo_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo reply.
-
-
- echo_request - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo request (ping).
-
-
- fragments - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Check non-initial fragments.
-
-
- header - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter header problem.
-
-
- hop_limit - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Hop limit exceeded in transit.
-
-
- mld_query - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Multicast Listener Discovery Query.
-
-
- mld_reduction - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Multicast Listener Discovery Reduction.
-
-
- mld_report - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Multicast Listener Discovery Report.
-
-
- mldv2 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Multicast Listener Discovery Protocol.
-
-
- nd_na - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Neighbor discovery neighbor advertisements.
-
-
- nd_ns - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Neighbor discovery neighbor solicitations.
-
-
- next_header - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter next header problems.
-
-
- no_admin - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administration prohibited destination.
-
-
- no_route - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
No route to destination.
-
-
- packet_too_big - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Packet too big.
-
-
- parameter_option - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter option problems.
-
-
- parameter_problem - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All parameter problems.
-
-
- port_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Port unreachable.
-
-
- reassembly_timeout - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Reassembly timeout.
-
-
- renum_command - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router renumbering command.
-
-
- renum_result - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router renumbering result.
-
-
- renum_seq_number - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router renumbering sequence number reset.
-
-
- router_advertisement - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Neighbor discovery router advertisements.
-
-
- router_renumbering - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All router renumbering.
-
-
- router_solicitation - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Neighbor discovery router solicitations.
-
-
- telemetry_path - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IPT enabled.
-
-
- telemetry_queue - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flow of interest for BDC/HDC.
-
-
- time_exceeded - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All time exceeded.
-
-
- unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All unreachable.
-
-
- igmp - -
- dictionary -
- 		- -
IGMP protocol options.
-
-
- dvmrp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Distance Vector Multicast Routing Protocol
-
-
- host_query - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host Query
-
-
- host_report - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host Report
-
-
- tcp - -
- dictionary -
- 		- -
TCP flags.
-
-
- ack - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the ACK bit
-
-
- established - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match established connections
-
-
- fin - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the FIN bit
-
-
- psh - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the PSH bit
-
-
- rst - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the RST bit
-
-
- syn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the SYN bit
-
-
- urg - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the URG bit
-
-
- remark - -
- string -
- 		- -
Access list entry comment.
-
-
- sequence - -
- integer -
- 		- -
Sequence number.
-
-
- source - -
- dictionary -
- 		- -
Specify the packet source.
-
-
- address - -
- string -
- 		- -
Source network address.
-
-
- any - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Any source address.
-
-
- host - -
- string -
- 		- -
Host IP address.
-
-
- port_protocol - -
- dictionary -
- 		- -
Specify the destination port or protocol (only for TCP and UDP).
-
-
- eq - -
- string -
- 		- -
Match only packets on a given port number.
-
-
- gt - -
- string -
- 		- -
Match only packets with a greater port number.
-
-
- lt - -
- string -
- 		- -
Match only packets with a lower port number.
-
-
- neq - -
- string -
- 		- -
Match only packets not on a given port number.
-
-
- range - -
- dictionary -
- 		- -
Match only packets in the range of port numbers.
-
-
- end - -
- string -
- 		- -
Specify the end of the port range.
-
-
- start - -
- string -
- 		- -
Specify the start of the port range.
-
-
- prefix - -
- string -
- 		- -
Source network prefix. Only for prefixes of mask value less than 31 for ipv4 and 127 for ipv6. Prefixes of mask 32 (ipv4) and 128 (ipv6) should be given in the 'host' key.
-
-
- wildcard_bits - -
- string -
- 		- -
Source wildcard bits.
-
-
- name - -
- string - / required -
- 		- -
Name of the ACL.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
The Address Family Indicator (AFI) for the ACL.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section 'ip(v6* access-list).
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • deleted
    • -
  • gathered
    • -
  • merged ←
    • -
  • overridden
    • -
  • rendered
    • -
  • replaced
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - As NX-OS allows configuring a rule again with different sequence numbers, the user is expected to provide sequence numbers for the access control entries to preserve idempotency. If no sequence number is given, the rule will be added as a new rule by the device. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - - - name: Merge provided ACLs configuration with device configuration - cisco.nxos.nxos_acls: - state: merged - config: - - afi: ipv4 - acls: - - name: ACL1v4 - aces: - - grant: deny - destination: - address: 192.0.2.64 - wildcard_bits: 0.0.0.255 - source: - any: true - port_protocol: - lt: 55 - protocol: tcp - protocol_options: - tcp: - ack: true - fin: true - sequence: 50 - - - afi: ipv6 - acls: - - name: ACL1v6 - aces: - - grant: permit - sequence: 10 - source: - any: true - destination: - prefix: 2001:db8:12::/32 - protocol: sctp - - # Task Output - # ----------- - # before: [] - # - # commands: - # - ip access-list ACL1v4 - # - 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin - # - ipv6 access-list ACL1v6 - # - 10 permit sctp any 2001:db8:12::/32 - # - # after: - # - acls: - # - aces: - # - destination: - # prefix: 2001:db8:12::/32 - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # name: ACL1v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # address: 192.0.2.64 - # wildcard_bits: 0.0.0.255 - # grant: deny - # protocol: tcp - # protocol_options: - # tcp: - # ack: true - # fin: true - # sequence: 50 - # source: - # any: true - # port_protocol: - # lt: '55' - # name: ACL1v4 - # afi: ipv4 - - - # After state: - # ------------ - # - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - - # Using replaced - - # Before state: - # ---------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 10 permit ip any any - # 20 deny udp any any - # ip access-list ACL2v4 - # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ipv6 access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - - name: Replace existing ACL configuration with provided configuration - cisco.nxos.nxos_acls: - config: - - afi: ipv4 - - afi: ipv6 - acls: - - name: ACL1v6 - aces: - - sequence: 20 - grant: permit - source: - any: true - destination: - any: true - protocol: pim - - - remark: Replaced ACE - - name: ACL2v6 - state: replaced - - # Task Output - # ----------- - # before: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ip - # sequence: 10 - # source: - # any: true - # - destination: - # any: true - # grant: deny - # protocol: udp - # sequence: 20 - # source: - # any: true - # name: ACL1v4 - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ahp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.0.255 - # name: ACL2v4 - # afi: ipv4 - # - # commands: - # - no ip access-list ACL1v4 - # - no ip access-list ACL2v4 - # - ipv6 access-list ACL1v6 - # - no 10 permit sctp any any - # - no 20 remark IPv6 ACL - # - remark Replaced ACE - # - 20 permit pim any any - # - ipv6 access-list ACL2v6 - # - no 10 deny ipv6 any 2001:db8:3000::/36 - # - no 20 permit tcp host 2001:db8:2000:2::2 host 2001:db8:2000:ab::2 - # - # after: - # - acls: - # - aces: - # - remark: Replaced ACE - # sequence: 10 - # - destination: - # any: true - # grant: permit - # protocol: pim - # sequence: 20 - # source: - # any: true - # name: ACL1v6 - # - name: ACL2v6 - # afi: ipv6 - - # After state: - # --------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ipv6 access-list ACL1v6 - # 10 remark Replaced ACE - # 20 permit pim any any - # ipv6 access-list ACL2v6 - - # Using overridden - - # Before state: - # ---------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 10 permit ip any any - # 20 deny udp any any - # ip access-list ACL2v4 - # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ipv6 access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - - name: Override existing configuration with provided configuration - cisco.nxos.nxos_acls: - config: - - afi: ipv4 - acls: - - name: NewACL - aces: - - grant: deny - source: - address: 192.0.2.0 - wildcard_bits: 0.0.255.255 - destination: - any: true - protocol: eigrp - - remark: Example for overridden state - state: overridden - - # Task Output - # ----------- - # - # before: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ip - # sequence: 10 - # source: - # any: true - # - destination: - # any: true - # grant: deny - # protocol: udp - # sequence: 20 - # source: - # any: true - # name: ACL1v4 - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ahp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.0.255 - # name: ACL2v4 - # afi: ipv4 - # - # commands: - # - no ipv6 access-list ACL1v6 - # - no ipv6 access-list ACL2v6 - # - no ip access-list ACL1v4 - # - no ip access-list ACL2v4 - # - ip access-list NewACL - # - deny eigrp 192.0.2.0 0.0.255.255 any - # - remark Example for overridden state - # - # after: - # - acls: - # - aces: - # - destination: - # any: true - # grant: deny - # protocol: eigrp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.255.255 - # - remark: Example for overridden state - # sequence: 20 - # name: NewACL - # afi: ipv4 - - # After state: - # ------------ - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list NewACL - # 10 deny eigrp 192.0.2.0 0.0.255.255 any - # 20 remark Example for overridden state - - # Using deleted - delete all - # - # Before state: - # ------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 10 permit ip any any - # 20 deny udp any any - # ip access-list ACL2v4 - # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ip access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ip access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - - name: Delete all ACLs - cisco.nxos.nxos_acls: - state: deleted - - # Task Output - # ----------- - # - # before: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ip - # sequence: 10 - # source: - # any: true - # - destination: - # any: true - # grant: deny - # protocol: udp - # sequence: 20 - # source: - # any: true - # name: ACL1v4 - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ahp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.0.255 - # name: ACL2v4 - # afi: ipv4 - # - # commands: - # - no ip access-list ACL1v4 - # - no ip access-list ACL2v4 - # - no ipv6 access-list ACL1v6 - # - no ipv6 access-list ACL2v6 - # - # after: [] - - - # After state: - # ----------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # - - # Using deleted - delete AFI - - # Before state: - # ------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 10 permit ip any any - # 20 deny udp any any - # ip access-list ACL2v4 - # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ip access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ip access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - - name: Delete all ACLs in given AFI - cisco.nxos.nxos_acls: - config: - - afi: ipv4 - state: deleted - - # Task Output - # ----------- - # - # before: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ip - # sequence: 10 - # source: - # any: true - # - destination: - # any: true - # grant: deny - # protocol: udp - # sequence: 20 - # source: - # any: true - # name: ACL1v4 - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ahp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.0.255 - # name: ACL2v4 - # afi: ipv4 - # - # commands: - # - no ip access-list ACL1v4 - # - no ip access-list ACL2v4 - # - # after: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - - # After state: - # ------------ - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ip access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - # Using deleted - delete ACLs - - # Before state: - # ------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 10 permit ip any any - # 20 deny udp any any - # ip access-list ACL2v4 - # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ipv6 access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - - name: Delete specific ACLs - cisco.nxos.nxos_acls: - state: deleted - config: - - afi: ipv4 - acls: - - name: ACL1v4 - - name: ACL2v4 - - afi: ipv6 - acls: - - name: ACL1v6 - - # Task Output - # ----------- - # - # before: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ip - # sequence: 10 - # source: - # any: true - # - destination: - # any: true - # grant: deny - # protocol: udp - # sequence: 20 - # source: - # any: true - # name: ACL1v4 - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ahp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.0.255 - # name: ACL2v4 - # afi: ipv4 - # - # commands: - # - no ip access-list ACL1v4 - # - no ip access-list ACL2v4 - # - no ipv6 access-list ACL1v6 - # - # after: - # - acls: - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - - # After state: - # ------------ - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ipv6 access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - # Using parsed - - - name: Parse given config to structured data - cisco.nxos.nxos_acls: - running_config: | - ip access-list ACL1v4 - 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin - ipv6 access-list ACL1v6 - 10 permit sctp any any - state: parsed - - # Task Output - # ------------ - # - # parsed: - # - afi: ipv4 - # acls: - # - name: ACL1v4 - # aces: - # - grant: deny - # destination: - # address: 192.0.2.64 - # wildcard_bits: 0.0.0.255 - # source: - # any: true - # port_protocol: - # lt: 55 - # protocol: tcp - # protocol_options: - # tcp: - # ack: true - # fin: true - # sequence: 50 - # - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # aces: - # - grant: permit - # sequence: 10 - # source: - # any: true - # destination: - # prefix: 2001:db8:12::/32 - # protocol: sctp - - - # Using gathered: - - # Before state: - # ------------ - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - - - name: Gather existing configuration - cisco.nxos.nxos_acls: - state: gathered - - # Task Output - # ----------- - # - # gathered: - # - afi: ipv4 - # acls: - # - name: ACL1v4 - # aces: - # - grant: deny - # destination: - # address: 192.0.2.64 - # wildcard_bits: 0.0.0.255 - # source: - # any: true - # port_protocol: - # lt: 55 - # protocol: tcp - # protocol_options: - # tcp: - # ack: true - # fin: true - # sequence: 50 - - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # aces: - # - grant: permit - # sequence: 10 - # source: - # any: true - # destination: - # prefix: 2001:db8:12::/32 - # protocol: sctp - - - # Using rendered - - - name: Render required configuration to be pushed to the device - cisco.nxos.nxos_acls: - config: - - afi: ipv4 - acls: - - name: ACL1v4 - aces: - - grant: deny - destination: - address: 192.0.2.64 - wildcard_bits: 0.0.0.255 - source: - any: true - port_protocol: - lt: 55 - protocol: tcp - protocol_options: - tcp: - ack: true - fin: true - sequence: 50 - - afi: ipv6 - acls: - - name: ACL1v6 - aces: - - grant: permit - sequence: 10 - source: - any: true - destination: - prefix: '2001:db8:12::/32' - protocol: sctp - state: rendered - - - # Task Output - # ----------- - # - # rendered: - # ip access-list ACL1v4 - # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['ip access-list ACL1v4', '10 permit ip any any precedence critical log', '20 deny tcp any lt smtp host 192.0.2.64 ack fin']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['ip access-list ACL1v4', '10 permit ip any any precedence critical log', '20 deny tcp any lt smtp host 192.0.2.64 ack fin']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_banner_module.rst b/docs/cisco.nxos.nxos_banner_module.rst deleted file mode 100644 index 7502173b7..000000000 --- a/docs/cisco.nxos.nxos_banner_module.rst +++ /dev/null @@ -1,187 +0,0 @@ -.. _cisco.nxos.nxos_banner_module: - - -********************** -cisco.nxos.nxos_banner -********************** - -**Manage multiline banners on Cisco NXOS devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This will configure both exec and motd banners on remote devices running Cisco NXOS. It allows playbooks to add or remove banner text from the active running configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- banner - -
- string - / required -
- 		-
    Choices: -
  • exec
    • -
  • motd
    • -
- 		-
Specifies which banner that should be configured on the remote device.
-
-
- multiline_delimiter - -
- string -
- 		- Default:
"@"
- 		-
Specify the delimiting character than will be used for configuration.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Specifies whether or not the configuration is present in the current devices active running configuration.
-
-
- text - -
- string -
- 		- -
The banner text that should be present in the remote device running configuration. This argument accepts a multiline string, with no empty lines. Requires state=present.
-
-
- - -Notes ------ - -.. note:: - - Since responses from the device are always read with surrounding whitespaces stripped, tasks that configure banners with preceeding or trailing whitespaces will not be idempotent. - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: configure the exec banner - cisco.nxos.nxos_banner: - banner: exec - text: | - this is my exec banner - that contains a multiline - string - state: present - - name: remove the motd banner - cisco.nxos.nxos_banner: - banner: motd - state: absent - - name: Configure banner from file - cisco.nxos.nxos_banner: - banner: motd - text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}" - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['banner exec', 'this is my exec banner', 'that contains a multiline', 'string']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_bfd_global_module.rst b/docs/cisco.nxos.nxos_bfd_global_module.rst deleted file mode 100644 index 8cd86ec48..000000000 --- a/docs/cisco.nxos.nxos_bfd_global_module.rst +++ /dev/null @@ -1,326 +0,0 @@ -.. _cisco.nxos.nxos_bfd_global_module: - - -************************** -cisco.nxos.nxos_bfd_global -************************** - -**Bidirectional Forwarding Detection (BFD) global-level configuration** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages Bidirectional Forwarding Detection (BFD) global-level configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- echo_interface - -
- string -
- 		- -
Loopback interface used for echo frames.
-
Valid values are loopback interface name or 'deleted'.
-
Not supported on N5K/N6K
-
-
- echo_rx_interval - -
- integer -
- 		- -
BFD Echo receive interval in milliseconds.
-
-
- fabricpath_interval - -
- dictionary -
- 		- -
BFD fabricpath interval timer values.
-
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
-
-
- fabricpath_slow_timer - -
- integer -
- 		- -
BFD fabricpath slow rate timer in milliseconds.
-
-
- fabricpath_vlan - -
- integer -
- 		- -
BFD fabricpath control vlan.
-
-
- interval - -
- dictionary -
- 		- -
BFD interval timer values.
-
Value must be a dict defining values for keys (tx, min_rx, and multiplier)
-
-
- ipv4_echo_rx_interval - -
- integer -
- 		- -
BFD IPv4 session echo receive interval in milliseconds.
-
-
- ipv4_interval - -
- dictionary -
- 		- -
BFD IPv4 interval timer values.
-
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
-
-
- ipv4_slow_timer - -
- integer -
- 		- -
BFD IPv4 slow rate timer in milliseconds.
-
-
- ipv6_echo_rx_interval - -
- integer -
- 		- -
BFD IPv6 session echo receive interval in milliseconds.
-
-
- ipv6_interval - -
- dictionary -
- 		- -
BFD IPv6 interval timer values.
-
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
-
-
- ipv6_slow_timer - -
- integer -
- 		- -
BFD IPv6 slow rate timer in milliseconds.
-
-
- slow_timer - -
- integer -
- 		- -
BFD slow rate timer in milliseconds.
-
-
- startup_timer - -
- integer -
- 		- -
BFD delayed startup timer in seconds.
-
Not supported on N5K/N6K/N7K
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 9.2(2) - - Unsupported for Cisco MDS - - BFD global will automatically enable 'feature bfd' if it is disabled. - - BFD global does not have a 'state' parameter. All of the BFD commands are unique and are defined if 'feature bfd' is enabled. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_bfd_global: - echo_interface: Ethernet1/2 - echo_rx_interval: 50 - interval: - tx: 50 - min_rx: 50 - multiplier: 4 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- cmds - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['bfd echo-interface loopback1', 'bfd slow-timer 2000']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_bfd_interfaces_module.rst b/docs/cisco.nxos.nxos_bfd_interfaces_module.rst deleted file mode 100644 index 975de891c..000000000 --- a/docs/cisco.nxos.nxos_bfd_interfaces_module.rst +++ /dev/null @@ -1,394 +0,0 @@ -.. _cisco.nxos.nxos_bfd_interfaces_module: - - -****************************** -cisco.nxos.nxos_bfd_interfaces -****************************** - -**BFD interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages attributes of Bidirectional Forwarding Detection (BFD) on the interface. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
The provided configuration
-
-
- bfd - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Enable/Disable Bidirectional Forwarding Detection (BFD) on the interface.
-
-
- echo - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Enable/Disable BFD Echo functionality on the interface.
-
-
- name - -
- string -
- 		- -
The name of the interface.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface|^feature bfd'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state of the configuration after module completion
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 7.0(3)I5(1). - - Unsupported for Cisco MDS - - Feature bfd should be enabled for this module. - - - -Examples --------- - -.. code-block:: yaml - - # Using deleted - - - name: Configure interfaces - cisco.nxos.nxos_bfd_interfaces: - state: deleted - - - # Using merged - - - name: Configure interfaces - cisco.nxos.nxos_bfd_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - echo: enable - - name: Ethernet1/2 - bfd: disable - echo: disable - state: merged - - - # Using overridden - - - name: Configure interfaces - cisco.nxos.nxos_bfd_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - echo: enable - - name: Ethernet1/2 - bfd: disable - echo: disable - state: overridden - - - # Using replaced - - - name: Configure interfaces - cisco.nxos.nxos_bfd_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - echo: enable - - name: Ethernet1/2 - bfd: disable - echo: disable - state: replaced - - # Using rendered - - - name: Use rendered state to convert task input to device specific commands - cisco.nxos.nxos_bfd_interfaces: - config: - - name: Ethernet1/800 - bfd: enable - echo: enable - - name: Ethernet1/801 - bfd: disable - echo: disable - state: rendered - - # Task Output (redacted) - # ----------------------- - - # rendered: - # - "interface Ethernet1/800" - # - "bfd" - # - "bfd echo" - # - "interface Ethernet1/801" - # - "no bfd" - # - "no bfd echo" - - # Using parsed - - # parsed.cfg - # ------------ - - # feature bfd - # interface Ethernet1/800 - # no switchport - # no bfd - # no bfd echo - # interface Ethernet1/801 - # no switchport - # no bfd - # interface Ethernet1/802 - # no switchport - # no bfd echo - # interface mgmt0 - # ip address dhcp - # vrf member management - - - name: Use parsed state to convert externally supplied config to structured format - cisco.nxos.nxos_bfd_interfaces: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - - # parsed: - # - bfd: disable - # echo: disable - # name: Ethernet1/800 - # - bfd: disable - # echo: enable - # name: Ethernet1/801 - # - bfd: enable - # echo: disable - # name: Ethernet1/802 - # - bfd: enable - # echo: enable - # name: mgmt0 - - # Using gathered - - # Existing device config state - # ------------------------------- - - # feature bfd - # interface Ethernet1/1 - # no switchport - # no bfd - # interface Ethernet1/2 - # no switchport - # no bfd echo - # interface mgmt0 - # ip address dhcp - # vrf member management - - - name: Gather bfd_interfaces facts from the device using nxos_bfd_interfaces - cisco.nxos.nxos_bfd_interfaces: - state: gathered - - # Task output (redacted) - # ----------------------- - # gathered: - # - name: Ethernet1/1 - # bfd: disable - # echo: enable - # - name: Ethernet1/3 - # echo: disable - # bfd: enable - # - name: mgmt0 - # bfd: enable - # echo: enable - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/1', 'no bfd', 'no bfd echo']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_bgp_global_module.rst b/docs/cisco.nxos.nxos_bgp_global_module.rst deleted file mode 100644 index 19ee2709e..000000000 --- a/docs/cisco.nxos.nxos_bgp_global_module.rst +++ /dev/null @@ -1,5843 +0,0 @@ -.. _cisco.nxos.nxos_bgp_global_module: - - -************************** -cisco.nxos.nxos_bgp_global -************************** - -**BGP Global resource module.** - - -Version added: 1.4.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages global BGP configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A list of BGP process configuration.
-
-
- affinity_group - -
- dictionary -
- 		- -
Configure an affinity group.
-
-
- group_id - -
- integer -
- 		- -
Affinity Group ID.
-
-
- as_number - -
- string -
- 		- -
Autonomous System Number of the router.
-
-
- bestpath - -
- dictionary -
- 		- -
Define the default bestpath selection algorithm.
-
-
- always_compare_med - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare MED on paths from different AS.
-
-
- as_path - -
- dictionary -
- 		- -
AS-Path.
-
-
- ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore AS-Path during bestpath selection.
-
-
- multipath_relax - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Relax AS-Path restriction when choosing multipaths.
-
-
- compare_neighborid - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
When more paths are available than max path config, use neighborid as tie-breaker.
-
-
- compare_routerid - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare router-id for identical EBGP paths.
-
-
- cost_community_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore cost communities in bestpath selection.
-
-
- igp_metric_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore IGP metric for next-hop during bestpath selection.
-
-
- med - -
- dictionary -
- 		- -
MED
-
-
- confed - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare MED only from paths originated from within a confederation.
-
-
- missing_as_worst - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Treat missing MED as highest MED.
-
-
- non_deterministic - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Not always pick the best-MED path among paths from same AS.
-
-
- cluster_id - -
- string -
- 		- -
Configure Route Reflector Cluster-ID.
-
-
- confederation - -
- dictionary -
- 		- -
AS confederation parameters.
-
-
- identifier - -
- string -
- 		- -
Set routing domain confederation AS.
-
-
- peers - -
- list - / elements=string -
- 		- -
Peer ASs in BGP confederation.
-
-
- disable_policy_batching - -
- dictionary -
- 		- -
Disable batching evaluation of outbound policy for a peer.
-
-
- ipv4 - -
- dictionary -
- 		- -
IPv4 address-family settings.
-
-
- prefix_list - -
- string -
- 		- -
Name of prefix-list to apply.
-
-
- ipv6 - -
- dictionary -
- 		- -
IPv6 address-family settings.
-
-
- prefix_list - -
- string -
- 		- -
Name of prefix-list to apply.
-
-
- nexthop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Batching based on nexthop.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set policy batching.
-
-
- dynamic_med_interval - -
- integer -
- 		- -
Sets the interval for dampening of med changes.
-
-
- enforce_first_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enforce neighbor AS is the first AS in AS-PATH attribute (EBGP).
-
-
- enhanced_error - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable BGP Enhanced error handling.
-
-
- fabric_soo - -
- string -
- 		- -
Fabric site of origin.
-
-
- fast_external_fallover - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Immediately reset the session if the link to a directly connected BGP peer goes down.
-
-
- flush_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flush routes in RIB upon controlled restart.
-
-
- graceful_restart - -
- dictionary -
- 		- -
Configure Graceful Restart functionality.
-
-
- helper - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure Graceful Restart Helper mode functionality.
-
-
- restart_time - -
- integer -
- 		- -
Maximum time for restart advertised to peers.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable graceful-restart.
-
-
- stalepath_time - -
- integer -
- 		- -
Maximum time to keep a restarting peer's stale routes.
-
-
- graceful_shutdown - -
- dictionary -
- 		- -
Graceful-shutdown for BGP protocol.
-
-
- activate - -
- dictionary -
- 		- -
Send graceful-shutdown community on all routes.
-
-
- route_map - -
- string -
- 		- -
Apply route-map to modify attributes for outbound.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Activiate graceful-shutdown.
-
-
- aware - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Lower preference of routes carrying graceful-shutdown community.
-
-
- isolate - -
- dictionary -
- 		- -
Isolate this router from BGP perspective.
-
-
- include_local - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Withdraw both local and remote BGP routes.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Withdraw remote BGP routes to isolate this router.
-
-
- log_neighbor_changes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Log a message for neighbor up/down event.
-
-
- maxas_limit - -
- integer -
- 		- -
Allow AS-PATH attribute from EBGP neighbor imposing a limit on number of ASes.
-
-
- neighbor_down - -
- dictionary -
- 		- -
Handle BGP neighbor down event, due to various reasons.
-
-
- fib_accelerate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor.
-
-
- neighbors - -
- list - / elements=dictionary -
- 		- -
Configure BGP neighbors.
-
-
- bfd - -
- dictionary -
- 		- -
Bidirectional Fast Detection for the neighbor.
-
-
- multihop - -
- dictionary -
- 		- -
Multihop session.
-
-
- interval - -
- dictionary -
- 		- -
Configure BFD session interval parameters.
-
-
- min_rx_interval - -
- integer -
- 		- -
Minimum RX interval.
-
-
- multiplier - -
- integer -
- 		- -
Detect Multiplier.
-
-
- tx_interval - -
- integer -
- 		- -
TX interval in milliseconds.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD multihop.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD for this neighbor.
-
-
- singlehop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Single-hop session.
-
-
- bmp_activate_server - -
- integer -
- 		- -
Specify server ID for activating BMP monitoring for the peer.
-
-
- capability - -
- dictionary -
- 		- -
Capability.
-
-
- suppress_4_byte_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress 4-byte AS Capability.
-
-
- description - -
- string -
- 		- -
Neighbor specific descripion.
-
-
- disable_connected_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable check for directly connected peer.
-
-
- dont_capability_negotiate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't negotiate capability with this neighbor.
-
-
- dscp - -
- string -
- 		- -
Set dscp value for tcp transport.
-
-
- dynamic_capability - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Dynamic Capability
-
-
- ebgp_multihop - -
- integer -
- 		- -
Specify multihop TTL for remote peer.
-
-
- graceful_shutdown - -
- dictionary -
- 		- -
Graceful-shutdown for this neighbor.
-
-
- activate - -
- dictionary -
- 		- -
Send graceful-shutdown community.
-
-
- route_map - -
- string -
- 		- -
Apply route-map to modify attributes for outbound.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set activate.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a template.
-
-
- peer - -
- string -
- 		- -
Peer template to inherit.
-
-
- peer_session - -
- string -
- 		- -
Peer-session template to inherit.
-
-
- local_as - -
- string -
- 		- -
Specify the local-as number for the eBGP neighbor.
-
-
- log_neighbor_changes - -
- dictionary -
- 		- -
Log message for neighbor up/down event.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable logging of neighbor up/down event.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set log-neighbor-changes.
-
-
- low_memory - -
- dictionary -
- 		- -
Behaviour in low memory situations.
-
-
- exempt - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not shutdown this peer when under memory pressure.
-
-
- neighbor_address - -
- string - / required -
- 		- -
IP address/Prefix of the neighbor or interface.
-
-
- neighbor_affinity_group - -
- dictionary -
- 		- -
Configure an affinity group.
-
-
- group_id - -
- integer -
- 		- -
Affinity Group ID.
-
-
- password - -
- dictionary -
- 		- -
Configure a password for neighbor.
-
-
- encryption - -
- integer -
- 		- -
0 specifies an UNENCRYPTED neighbor password.
-
3 specifies an 3DES ENCRYPTED neighbor password will follow.
-
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
-
-
- key - -
- string -
- 		- -
Authentication password.
-
-
- path_attribute - -
- list - / elements=dictionary -
- 		- -
BGP path attribute optional filtering.
-
-
- action - -
- string -
- 		-
    Choices: -
  • discard
    • -
  • treat-as-withdraw
    • -
- 		-
Action.
-
-
- range - -
- dictionary -
- 		- -
Path attribute range.
-
-
- end - -
- integer -
- 		- -
Path attribute range end value.
-
-
- start - -
- integer -
- 		- -
Path attribute range start value.
-
-
- type - -
- integer -
- 		- -
Path attribute type
-
-
- peer_type - -
- string -
- 		-
    Choices: -
  • fabric-border-leaf
    • -
  • fabric-external
    • -
- 		-
Neighbor facing
-
-
- remote_as - -
- string -
- 		- -
Specify Autonomous System Number of the neighbor.
-
-
- remote_as_route_map - -
- string -
- 		- -
Route-map to match prefix peer AS number.
-
-
- remove_private_as - -
- dictionary -
- 		- -
Remove private AS number from outbound updates.
-
-
- all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All.
-
-
- replace_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Replace.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove private AS.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively shutdown this neighbor.
-
-
- timers - -
- dictionary -
- 		- -
Configure keepalive and hold timers.
-
-
- holdtime - -
- integer -
- 		- -
Holdtime (seconds).
-
-
- keepalive - -
- integer -
- 		- -
Keepalive interval (seconds).
-
-
- transport - -
- dictionary -
- 		- -
BGP transport connection.
-
-
- connection_mode - -
- dictionary -
- 		- -
Specify type of connection.
-
-
- passive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow passive connection setup only.
-
-
- ttl_security - -
- dictionary -
- 		- -
Enable TTL Security Mechanism.
-
-
- hops - -
- integer -
- 		- -
Specify hop count for remote peer.
-
-
- update_source - -
- string -
- 		- -
Specify source of BGP session and updates.
-
-
- nexthop - -
- dictionary -
- 		- -
Nexthop resolution options.
-
-
- suppress_default_resolution - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Prohibit use of default route for nexthop address resolution.
-
-
- rd - -
- dictionary -
- 		- -
Secondary Route Distinguisher for vxlan multisite border gateway.
-
-
- dual - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Generate Secondary RD for all VRFs and L2VNIs.
-
-
- id - -
- integer -
- 		- -
Specify 2 byte value for ID.
-
-
- reconnect_interval - -
- integer -
- 		- -
Configure connection reconnect interval.
-
-
- router_id - -
- string -
- 		- -
Specify the IP address to use as router-id.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively shutdown BGP protocol.
-
-
- suppress_fib_pending - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise only routes that are programmed in hardware to peers.
-
-
- timers - -
- dictionary -
- 		- -
Configure bgp related timers.
-
-
- bestpath_limit - -
- dictionary -
- 		- -
Configure timeout for first bestpath after restart.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure update-delay-always option.
-
-
- timeout - -
- integer -
- 		- -
Bestpath timeout (seconds).
-
-
- bgp - -
- dictionary -
- 		- -
Configure different bgp keepalive and holdtimes.
-
-
- holdtime - -
- integer -
- 		- -
Holdtime (seconds).
-
-
- keepalive - -
- integer -
- 		- -
Keepalive interval (seconds).
-
-
- prefix_peer_timeout - -
- integer -
- 		- -
Prefix Peer timeout (seconds).
-
-
- prefix_peer_wait - -
- integer -
- 		- -
Configure wait timer for a prefix peer.
-
-
- vrfs - -
- list - / elements=dictionary -
- 		- -
Virtual Router Context configurations.
-
-
- allocate_index - -
- integer -
- 		- -
Configure allocate-index.
-
-
- bestpath - -
- dictionary -
- 		- -
Define the default bestpath selection algorithm.
-
-
- always_compare_med - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare MED on paths from different AS.
-
-
- as_path - -
- dictionary -
- 		- -
AS-Path.
-
-
- ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore AS-Path during bestpath selection.
-
-
- multipath_relax - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Relax AS-Path restriction when choosing multipaths.
-
-
- compare_neighborid - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
When more paths are available than max path config, use neighborid as tie-breaker.
-
-
- compare_routerid - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare router-id for identical EBGP paths.
-
-
- cost_community_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore cost communities in bestpath selection.
-
-
- igp_metric_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore IGP metric for next-hop during bestpath selection.
-
-
- med - -
- dictionary -
- 		- -
MED
-
-
- confed - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare MED only from paths originated from within a confederation.
-
-
- missing_as_worst - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Treat missing MED as highest MED.
-
-
- non_deterministic - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Not always pick the best-MED path among paths from same AS.
-
-
- cluster_id - -
- string -
- 		- -
Configure Route Reflector Cluster-ID.
-
-
- confederation - -
- dictionary -
- 		- -
AS confederation parameters.
-
-
- identifier - -
- string -
- 		- -
Set routing domain confederation AS.
-
-
- peers - -
- list - / elements=string -
- 		- -
Peer ASs in BGP confederation.
-
-
- graceful_restart - -
- dictionary -
- 		- -
Configure Graceful Restart functionality.
-
-
- helper - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure Graceful Restart Helper mode functionality.
-
-
- restart_time - -
- integer -
- 		- -
Maximum time for restart advertised to peers.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable graceful-restart.
-
-
- stalepath_time - -
- integer -
- 		- -
Maximum time to keep a restarting peer's stale routes.
-
-
- local_as - -
- string -
- 		- -
Specify the local-as for this vrf.
-
-
- log_neighbor_changes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Log a message for neighbor up/down event.
-
-
- maxas_limit - -
- integer -
- 		- -
Allow AS-PATH attribute from EBGP neighbor imposing a limit on number of ASes.
-
-
- neighbor_down - -
- dictionary -
- 		- -
Handle BGP neighbor down event, due to various reasons.
-
-
- fib_accelerate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor.
-
-
- neighbors - -
- list - / elements=dictionary -
- 		- -
Configure BGP neighbors.
-
-
- bfd - -
- dictionary -
- 		- -
Bidirectional Fast Detection for the neighbor.
-
-
- multihop - -
- dictionary -
- 		- -
Multihop session.
-
-
- interval - -
- dictionary -
- 		- -
Configure BFD session interval parameters.
-
-
- min_rx_interval - -
- integer -
- 		- -
Minimum RX interval.
-
-
- multiplier - -
- integer -
- 		- -
Detect Multiplier.
-
-
- tx_interval - -
- integer -
- 		- -
TX interval in milliseconds.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD multihop.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD for this neighbor.
-
-
- singlehop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Single-hop session.
-
-
- bmp_activate_server - -
- integer -
- 		- -
Specify server ID for activating BMP monitoring for the peer.
-
-
- capability - -
- dictionary -
- 		- -
Capability.
-
-
- suppress_4_byte_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress 4-byte AS Capability.
-
-
- description - -
- string -
- 		- -
Neighbor specific descripion.
-
-
- disable_connected_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable check for directly connected peer.
-
-
- dont_capability_negotiate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't negotiate capability with this neighbor.
-
-
- dscp - -
- string -
- 		- -
Set dscp value for tcp transport.
-
-
- dynamic_capability - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Dynamic Capability
-
-
- ebgp_multihop - -
- integer -
- 		- -
Specify multihop TTL for remote peer.
-
-
- graceful_shutdown - -
- dictionary -
- 		- -
Graceful-shutdown for this neighbor.
-
-
- activate - -
- dictionary -
- 		- -
Send graceful-shutdown community.
-
-
- route_map - -
- string -
- 		- -
Apply route-map to modify attributes for outbound.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set activate.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a template.
-
-
- peer - -
- string -
- 		- -
Peer template to inherit.
-
-
- peer_session - -
- string -
- 		- -
Peer-session template to inherit.
-
-
- local_as - -
- string -
- 		- -
Specify the local-as number for the eBGP neighbor.
-
-
- log_neighbor_changes - -
- dictionary -
- 		- -
Log message for neighbor up/down event.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable logging of neighbor up/down event.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set log-neighbor-changes.
-
-
- low_memory - -
- dictionary -
- 		- -
Behaviour in low memory situations.
-
-
- exempt - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not shutdown this peer when under memory pressure.
-
-
- neighbor_address - -
- string - / required -
- 		- -
IP address/Prefix of the neighbor or interface.
-
-
- neighbor_affinity_group - -
- dictionary -
- 		- -
Configure an affinity group.
-
-
- group_id - -
- integer -
- 		- -
Affinity Group ID.
-
-
- password - -
- dictionary -
- 		- -
Configure a password for neighbor.
-
-
- encryption - -
- integer -
- 		- -
0 specifies an UNENCRYPTED neighbor password.
-
3 specifies an 3DES ENCRYPTED neighbor password will follow.
-
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
-
-
- key - -
- string -
- 		- -
Authentication password.
-
-
- path_attribute - -
- list - / elements=dictionary -
- 		- -
BGP path attribute optional filtering.
-
-
- action - -
- string -
- 		-
    Choices: -
  • discard
    • -
  • treat-as-withdraw
    • -
- 		-
Action.
-
-
- range - -
- dictionary -
- 		- -
Path attribute range.
-
-
- end - -
- integer -
- 		- -
Path attribute range end value.
-
-
- start - -
- integer -
- 		- -
Path attribute range start value.
-
-
- type - -
- integer -
- 		- -
Path attribute type
-
-
- peer_type - -
- string -
- 		-
    Choices: -
  • fabric-border-leaf
    • -
  • fabric-external
    • -
- 		-
Neighbor facing
-
-
- remote_as - -
- string -
- 		- -
Specify Autonomous System Number of the neighbor.
-
-
- remote_as_route_map - -
- string -
- 		- -
Route-map to match prefix peer AS number.
-
-
- remove_private_as - -
- dictionary -
- 		- -
Remove private AS number from outbound updates.
-
-
- all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All.
-
-
- replace_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Replace.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove private AS.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively shutdown this neighbor.
-
-
- timers - -
- dictionary -
- 		- -
Configure keepalive and hold timers.
-
-
- holdtime - -
- integer -
- 		- -
Holdtime (seconds).
-
-
- keepalive - -
- integer -
- 		- -
Keepalive interval (seconds).
-
-
- transport - -
- dictionary -
- 		- -
BGP transport connection.
-
-
- connection_mode - -
- dictionary -
- 		- -
Specify type of connection.
-
-
- passive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow passive connection setup only.
-
-
- ttl_security - -
- dictionary -
- 		- -
Enable TTL Security Mechanism.
-
-
- hops - -
- integer -
- 		- -
Specify hop count for remote peer.
-
-
- update_source - -
- string -
- 		- -
Specify source of BGP session and updates.
-
-
- reconnect_interval - -
- integer -
- 		- -
Configure connection reconnect interval.
-
-
- router_id - -
- string -
- 		- -
Specify the IP address to use as router-id.
-
-
- timers - -
- dictionary -
- 		- -
Configure bgp related timers.
-
-
- bestpath_limit - -
- dictionary -
- 		- -
Configure timeout for first bestpath after restart.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure update-delay-always option.
-
-
- timeout - -
- integer -
- 		- -
Bestpath timeout (seconds).
-
-
- bgp - -
- dictionary -
- 		- -
Configure different bgp keepalive and holdtimes.
-
-
- holdtime - -
- integer -
- 		- -
Holdtime (seconds).
-
-
- keepalive - -
- integer -
- 		- -
Keepalive interval (seconds).
-
-
- prefix_peer_timeout - -
- integer -
- 		- -
Prefix Peer timeout (seconds).
-
-
- prefix_peer_wait - -
- integer -
- 		- -
Configure wait timer for a prefix peer.
-
-
- vrf - -
- string -
- 		- -
VRF name.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^router bgp'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • purged
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
State purged removes all the BGP configurations from the target device. Use caution with this state.
-
State deleted only removes BGP attributes that this modules manages and does not negate the BGP process completely. Thereby, preserving address-family related configurations under BGP context.
-
Running states deleted and replaced will result in an error if there are address-family configuration lines present under a neighbor, or a vrf context that is to be removed. Please use the cisco.nxos.nxos_bgp_af or cisco.nxos.nxos_bgp_neighbor_af modules for prior cleanup.
-
States merged and replaced will result in a failure if BGP is already configured with a different ASN than what is provided in the task. In such cases, please use state purged to remove the existing BGP process and proceed further.
-
States replaced and overridden have the same behaviour for this module.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - Unsupported for Cisco MDS - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # Nexus9000v# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_bgp_global: - config: - as_number: 65563 - router_id: 192.168.1.1 - bestpath: - as_path: - multipath_relax: true - compare_neighborid: true - cost_community_ignore: true - confederation: - identifier: 42 - peers: - - 65020 - - 65030 - - 65040 - log_neighbor_changes: true - maxas_limit: 20 - neighbors: - - neighbor_address: 192.168.1.100 - neighbor_affinity_group: - group_id: 160 - bmp_activate_server: 1 - remote_as: 65563 - description: NBR-1 - low_memory: - exempt: true - - neighbor_address: 192.168.1.101 - remote_as: 65563 - password: - encryption: 7 - key: 12090404011C03162E - neighbor_down: - fib_accelerate: true - vrfs: - - vrf: site-1 - allocate_index: 5000 - local_as: 200 - log_neighbor_changes: true - neighbors: - - neighbor_address: 198.51.100.1 - description: site-1-nbr-1 - password: - encryption: 3 - key: 13D4D3549493D2877B1DC116EE27A6BE - remote_as: 65562 - - neighbor_address: 198.51.100.2 - remote_as: 65562 - description: site-1-nbr-2 - - vrf: site-2 - local_as: 300 - log_neighbor_changes: true - neighbors: - - neighbor_address: 203.0.113.2 - description: site-2-nbr-1 - password: - encryption: 3 - key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - remote_as: 65568 - neighbor_down: - fib_accelerate: true - - # Task output: - # ------------ - # before: {} - # - # commands: - # - router bgp 65563 - # - bestpath as-path multipath-relax - # - bestpath compare-neighborid - # - bestpath cost-community ignore - # - confederation identifier 42 - # - log-neighbor-changes - # - maxas-limit 20 - # - neighbor-down fib-accelerate - # - router-id 192.168.1.1 - # - confederation peers 65020 65030 65040 - # - neighbor 192.168.1.100 - # - remote-as 65563 - # - affinity-group 160 - # - bmp-activate-server 1 - # - description NBR-1 - # - low-memory exempt - # - neighbor 192.168.1.101 - # - remote-as 65563 - # - password 7 12090404011C03162E - # - vrf site-1 - # - allocate-index 5000 - # - local-as 200 - # - log-neighbor-changes - # - neighbor 198.51.100.1 - # - remote-as 65562 - # - description site-1-nbr-1 - # - password 3 13D4D3549493D2877B1DC116EE27A6BE - # - neighbor 198.51.100.2 - # - remote-as 65562 - # - description site-1-nbr-2 - # - vrf site-2 - # - local-as 300 - # - log-neighbor-changes - # - neighbor-down fib-accelerate - # - neighbor 203.0.113.2 - # - remote-as 65568 - # - description site-2-nbr-1 - # - password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - # - # after: - # as_number: '65563' - # bestpath: - # as_path: - # multipath_relax: true - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65040' - # log_neighbor_changes: true - # maxas_limit: 20 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # - neighbor_address: 192.168.1.101 - # password: - # encryption: 7 - # key: 12090404011C03162E - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - allocate_index: 5000 - # local_as: '200' - # log_neighbor_changes: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 198.51.100.1 - # password: - # encryption: 3 - # key: 13D4D3549493D2877B1DC116EE27A6BE - # remote_as: '65562' - # - description: site-1-nbr-2 - # neighbor_address: 198.51.100.2 - # remote_as: '65562' - # vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - description: site-2-nbr-1 - # neighbor_address: 203.0.113.2 - # password: - # encryption: 3 - # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - # remote_as: '65568' - # vrf: site-2 - - - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65040 - # bestpath as-path multipath-relax - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 20 - # log-neighbor-changes - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # neighbor 192.168.1.101 - # remote-as 65563 - # password 7 12090404011C03162E - # vrf site-1 - # local-as 200 - # log-neighbor-changes - # allocate-index 5000 - # neighbor 198.51.100.1 - # remote-as 65562 - # description site-1-nbr-1 - # password 3 13D4D3549493D2877B1DC116EE27A6BE - # neighbor 198.51.100.2 - # remote-as 65562 - # description site-1-nbr-2 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # remote-as 65568 - # description site-2-nbr-1 - # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - # Using replaced - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65040 - # bestpath as-path multipath-relax - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 20 - # log-neighbor-changes - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # neighbor 192.168.1.101 - # remote-as 65563 - # password 7 12090404011C03162E - # vrf site-1 - # local-as 200 - # log-neighbor-changes - # allocate-index 5000 - # neighbor 198.51.100.1 - # remote-as 65562 - # description site-1-nbr-1 - # password 3 13D4D3549493D2877B1DC116EE27A6BE - # neighbor 198.51.100.2 - # remote-as 65562 - # description site-1-nbr-2 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # remote-as 65568 - # description site-2-nbr-1 - # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - - name: Replace BGP configuration with provided configuration - cisco.nxos.nxos_bgp_global: - config: - as_number: 65563 - router_id: 192.168.1.1 - bestpath: - compare_neighborid: true - cost_community_ignore: true - confederation: - identifier: 42 - peers: - - 65020 - - 65030 - - 65050 - maxas_limit: 40 - neighbors: - - neighbor_address: 192.168.1.100 - neighbor_affinity_group: - group_id: 160 - bmp_activate_server: 1 - remote_as: 65563 - description: NBR-1 - low_memory: - exempt: true - neighbor_down: - fib_accelerate: true - vrfs: - - vrf: site-2 - local_as: 300 - log_neighbor_changes: true - neighbors: - - neighbor_address: 203.0.113.2 - password: - encryption: 7 - key: 12090404011C03162E - neighbor_down: - fib_accelerate: true - state: replaced - - # Task output: - # ------------ - # before: - # as_number: '65563' - # bestpath: - # as_path: - # multipath_relax: true - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65040' - # log_neighbor_changes: true - # maxas_limit: 20 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # - neighbor_address: 192.168.1.101 - # password: - # encryption: 7 - # key: 12090404011C03162E - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - allocate_index: 5000 - # local_as: '200' - # log_neighbor_changes: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 198.51.100.1 - # password: - # encryption: 3 - # key: 13D4D3549493D2877B1DC116EE27A6BE - # remote_as: '65562' - # - description: site-1-nbr-2 - # neighbor_address: 198.51.100.2 - # remote_as: '65562' - # vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - description: site-2-nbr-1 - # neighbor_address: 203.0.113.2 - # password: - # encryption: 3 - # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - # remote_as: '65568' - # vrf: site-2 - # - # commands: - # - router bgp 65563 - # - no bestpath as-path multipath-relax - # - no log-neighbor-changes - # - maxas-limit 40 - # - no confederation peers 65020 65030 65040 - # - confederation peers 65020 65030 65050 - # - no neighbor 192.168.1.101 - # - vrf site-2 - # - neighbor 203.0.113.2 - # - no remote-as 65568 - # - no description site-2-nbr-1 - # - password 7 12090404011C03162E - # - no vrf site-1 - - # after: - # as_number: '65563' - # bestpath: - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65050' - # maxas_limit: 40 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - neighbor_address: 203.0.113.2 - # password: - # encryption: 7 - # key: 12090404011C03162E - # vrf: site-2 - # - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65050 - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 40 - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # password 7 12090404011C03162E - - # Using deleted - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65040 - # bestpath as-path multipath-relax - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 20 - # log-neighbor-changes - # address-family ipv4 unicast - # default-metric 400 - # suppress-inactive - # default-information originate - # address-family ipv6 multicast - # wait-igp-convergence - # redistribute eigrp eigrp-1 route-map site-1-rmap - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # neighbor 192.168.1.101 - # remote-as 65563 - # password 7 12090404011C03162E - # vrf site-1 - # local-as 200 - # log-neighbor-changes - # allocate-index 5000 - # address-family ipv4 multicast - # maximum-paths 40 - # dampen-igp-metric 1200 - # neighbor 198.51.100.1 - # remote-as 65562 - # description site-1-nbr-1 - # password 3 13D4D3549493D2877B1DC116EE27A6BE - # neighbor 198.51.100.2 - # remote-as 65562 - # description site-1-nbr-2 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # remote-as 65568 - # description site-1-nbr-1 - # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - - name: Delete BGP configurations handled by this module - cisco.nxos.nxos_bgp_global: - state: deleted - - # Task output: - # ------------ - - # before: - # as_number: '65563' - # bestpath: - # as_path: - # multipath_relax: true - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65040' - # log_neighbor_changes: true - # maxas_limit: 20 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # - neighbor_address: 192.168.1.101 - # password: - # encryption: 7 - # key: 12090404011C03162E - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - allocate_index: 5000 - # local_as: '200' - # log_neighbor_changes: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 198.51.100.1 - # password: - # encryption: 3 - # key: 13D4D3549493D2877B1DC116EE27A6BE - # remote_as: '65562' - # - description: site-1-nbr-2 - # neighbor_address: 198.51.100.2 - # remote_as: '65562' - # vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 203.0.113.2 - # password: - # encryption: 3 - # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - # remote_as: '65568' - # vrf: site-2 - # - # commands: - # - router bgp 65563 - # - no bestpath as-path multipath-relax - # - no bestpath compare-neighborid - # - no bestpath cost-community ignore - # - no confederation identifier 42 - # - no log-neighbor-changes - # - no maxas-limit 20 - # - no neighbor-down fib-accelerate - # - no router-id 192.168.1.1 - # - no confederation peers 65020 65030 65040 - # - no neighbor 192.168.1.100 - # - no neighbor 192.168.1.101 - # - no vrf site-1 - # - no vrf site-2 - # - # after: - # as_number: '65563' - # - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # address-family ipv4 unicast - # default-metric 400 - # suppress-inactive - # default-information originate - # address-family ipv6 multicast - # wait-igp-convergence - # redistribute eigrp eigrp-1 route-map site-1-rmap - # - - # Using purged - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65040 - # bestpath as-path multipath-relax - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 20 - # log-neighbor-changes - # address-family ipv4 unicast - # default-metric 400 - # suppress-inactive - # default-information originate - # address-family ipv6 multicast - # wait-igp-convergence - # redistribute eigrp eigrp-1 route-map site-1-rmap - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # neighbor 192.168.1.101 - # remote-as 65563 - # password 7 12090404011C03162E - # vrf site-1 - # local-as 200 - # log-neighbor-changes - # allocate-index 5000 - # address-family ipv4 multicast - # maximum-paths 40 - # dampen-igp-metric 1200 - # neighbor 198.51.100.1 - # remote-as 65562 - # description site-1-nbr-1 - # password 3 13D4D3549493D2877B1DC116EE27A6BE - # neighbor 198.51.100.2 - # remote-as 65562 - # description site-1-nbr-2 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # remote-as 65568 - # description site-1-nbr-1 - # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - - name: Purge all BGP configurations from the device - cisco.nxos.nxos_bgp_global: - state: purged - - # Task output: - # ------------ - - # before: - # as_number: '65563' - # bestpath: - # as_path: - # multipath_relax: true - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65040' - # log_neighbor_changes: true - # maxas_limit: 20 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # - neighbor_address: 192.168.1.101 - # password: - # encryption: 7 - # key: 12090404011C03162E - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - allocate_index: 5000 - # local_as: '200' - # log_neighbor_changes: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 198.51.100.1 - # password: - # encryption: 3 - # key: 13D4D3549493D2877B1DC116EE27A6BE - # remote_as: '65562' - # - description: site-1-nbr-2 - # neighbor_address: 198.51.100.2 - # remote_as: '65562' - # vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 203.0.113.2 - # password: - # encryption: 3 - # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - # remote_as: '65568' - # vrf: site-2 - # - # commands: - # - no router bgp 65563 - # - # after: {} - # - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # Nexus9000v# - - # Using rendered - - - name: Render platform specific configuration lines (without connecting to the device) - cisco.nxos.nxos_bgp_global: - config: - as_number: 65563 - router_id: 192.168.1.1 - bestpath: - as_path: - multipath_relax: true - compare_neighborid: true - cost_community_ignore: true - confederation: - identifier: 42 - peers: - - 65020 - - 65030 - - 65040 - log_neighbor_changes: true - maxas_limit: 20 - neighbors: - - neighbor_address: 192.168.1.100 - neighbor_affinity_group: - group_id: 160 - bmp_activate_server: 1 - remote_as: 65563 - description: NBR-1 - low_memory: - exempt: true - - neighbor_address: 192.168.1.101 - remote_as: 65563 - password: - encryption: 7 - key: 12090404011C03162E - neighbor_down: - fib_accelerate: true - vrfs: - - vrf: site-1 - allocate_index: 5000 - local_as: 200 - log_neighbor_changes: true - neighbors: - - neighbor_address: 198.51.100.1 - description: site-1-nbr-1 - password: - encryption: 3 - key: 13D4D3549493D2877B1DC116EE27A6BE - remote_as: 65562 - - neighbor_address: 198.51.100.2 - remote_as: 65562 - description: site-1-nbr-2 - - vrf: site-2 - local_as: 300 - log_neighbor_changes: true - neighbors: - - neighbor_address: 203.0.113.2 - description: site-1-nbr-1 - password: - encryption: 3 - key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - remote_as: 65568 - neighbor_down: - fib_accelerate: true - - # Task output: - # ------------ - # rendered: - # - router bgp 65563 - # - bestpath as-path multipath-relax - # - bestpath compare-neighborid - # - bestpath cost-community ignore - # - confederation identifier 42 - # - log-neighbor-changes - # - maxas-limit 20 - # - neighbor-down fib-accelerate - # - router-id 192.168.1.1 - # - confederation peers 65020 65030 65040 - # - neighbor 192.168.1.100 - # - remote-as 65563 - # - affinity-group 160 - # - bmp-activate-server 1 - # - description NBR-1 - # - low-memory exempt - # - neighbor 192.168.1.101 - # - remote-as 65563 - # - password 7 12090404011C03162E - # - vrf site-1 - # - allocate-index 5000 - # - local-as 200 - # - log-neighbor-changes - # - neighbor 198.51.100.1 - # - remote-as 65562 - # - description site-1-nbr-1 - # - password 3 13D4D3549493D2877B1DC116EE27A6BE - # - neighbor 198.51.100.2 - # - remote-as 65562 - # - description site-1-nbr-2 - # - vrf site-2 - # - local-as 300 - # - log-neighbor-changes - # - neighbor-down fib-accelerate - # - neighbor 203.0.113.2 - # - remote-as 65568 - # - description site-1-nbr-1 - # - password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - # Using parsed - - # parsed.cfg - # ------------ - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65040 - # bestpath as-path multipath-relax - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 20 - # log-neighbor-changes - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # neighbor 192.168.1.101 - # remote-as 65563 - # password 7 12090404011C03162E - # vrf site-1 - # local-as 200 - # log-neighbor-changes - # allocate-index 5000 - # neighbor 198.51.100.1 - # remote-as 65562 - # description site-1-nbr-1 - # password 3 13D4D3549493D2877B1DC116EE27A6BE - # neighbor 198.51.100.2 - # remote-as 65562 - # description site-1-nbr-2 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # remote-as 65568 - # description site-1-nbr-1 - # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - - name: Parse externally provided BGP config - cisco.nxos.nxos_bgp_global: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output: - # ------------ - # parsed: - # as_number: '65563' - # bestpath: - # as_path: - # multipath_relax: true - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65040' - # log_neighbor_changes: true - # maxas_limit: 20 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # - neighbor_address: 192.168.1.101 - # password: - # encryption: 7 - # key: 12090404011C03162E - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - allocate_index: 5000 - # local_as: '200' - # log_neighbor_changes: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 198.51.100.1 - # password: - # encryption: 3 - # key: 13D4D3549493D2877B1DC116EE27A6BE - # remote_as: '65562' - # - description: site-1-nbr-2 - # neighbor_address: 198.51.100.2 - # remote_as: '65562' - # vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 203.0.113.2 - # password: - # encryption: 3 - # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - # remote_as: '65568' - # vrf: site-2 - - # Using gathered - - # existing config - # - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65050 - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 40 - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # vrf site-1 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # password 7 12090404011C03162E - - - name: Gather BGP facts using gathered - cisco.nxos.nxos_bgp_global: - state: gathered - - # Task output: - # ------------ - # gathered: - # as_number: '65563' - # bestpath: - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65050' - # maxas_limit: 40 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - neighbor_address: 203.0.113.2 - # password: - # encryption: 7 - # key: 12090404011C03162E - # vrf: site-2 - - # Remove a neighbor having AF configurations with state replaced (will fail) - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # log-neighbor-changes - # maxas-limit 20 - # router-id 198.51.100.2 - # neighbor 203.0.113.2 - # address-family ipv4 unicast - # next-hop-self - # remote-as 65538 - # affinity-group 160 - # description NBR-1 - # low-memory exempt - # neighbor 192.0.2.1 - # remote-as 65537 - # password 7 12090404011C03162E - - - name: Remove a neighbor having AF configurations (should fail) - cisco.nxos.nxos_bgp_global: - config: - as_number: 65536 - router_id: 198.51.100.2 - maxas_limit: 20 - log_neighbor_changes: true - neighbors: - - neighbor_address: 192.0.2.1 - remote_as: 65537 - password: - encryption: 7 - key: 12090404011C03162E - state: replaced - - # Task output: - # ------------ - # fatal: [Nexus9000v]: FAILED! => changed=false - # msg: Neighbor 203.0.113.2 has address-family configurations. - # Please use the nxos_bgp_neighbor_af module to remove those first. - - # Remove a VRF having AF configurations with state replaced (will fail) - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # log-neighbor-changes - # maxas-limit 20 - # router-id 198.51.100.2 - # neighbor 192.0.2.1 - # remote-as 65537 - # password 7 12090404011C03162E - # vrf site-1 - # address-family ipv4 unicast - # default-information originate - # neighbor 203.0.113.2 - # remote-as 65538 - # affinity-group 160 - # description NBR-1 - # low-memory exempt - # vrf site-2 - # neighbor-down fib-accelerate - - - name: Remove a VRF having AF configurations (should fail) - cisco.nxos.nxos_bgp_global: - config: - as_number: 65536 - router_id: 198.51.100.2 - maxas_limit: 20 - log_neighbor_changes: true - neighbors: - - neighbor_address: 192.0.2.1 - remote_as: 65537 - password: - encryption: 7 - key: 12090404011C03162E - vrfs: - - vrf: site-2 - neighbor_down: - fib_accelerate: true - state: replaced - - # Task output: - # ------------ - # fatal: [Nexus9000v]: FAILED! => changed=false - # msg: VRF site-1 has address-family configurations. - # Please use the nxos_bgp_af module to remove those first. - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['router bgp 65563', 'maxas-limit 20', 'router-id 192.168.1.1', 'confederation peers 65020 65030 65040', 'neighbor 192.168.1.100', 'remote-as 65563', 'affinity-group 160', 'bmp-activate-server 1', 'description NBR-1', 'low-memory exempt', 'vrf site-1', 'log-neighbor-changes', 'neighbor 198.51.100.1', 'remote-as 65562', 'description site-1-nbr-1', 'password 3 13D4D3549493D2877B1DC116EE27A6BE']
-
-
- gathered - -
- dictionary -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- dictionary -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['router bgp 65563', 'maxas-limit 20', 'router-id 192.168.1.1']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst b/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst deleted file mode 100644 index 8668a0b9f..000000000 --- a/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst +++ /dev/null @@ -1,3575 +0,0 @@ -.. _cisco.nxos.nxos_bgp_neighbor_address_family_module: - - -******************************************* -cisco.nxos.nxos_bgp_neighbor_address_family -******************************************* - -**BGP Neighbor Address Family resource module.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages BGP Neighbor Address Family configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
BGP Neighbor AF configuration.
-
-
- as_number - -
- string -
- 		- -
Autonomous System Number of the router.
-
-
- neighbors - -
- list - / elements=dictionary -
- 		- -
A list of BGP Neighbor AF configuration.
-
-
- address_family - -
- list - / elements=dictionary -
- 		- -
BGP Neighbor Address Family related configurations.
-
-
- advertise_map - -
- dictionary -
- 		- -
Specify route-map for conditional advertisement.
-
-
- exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition exists.
-
-
- non_exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition does not exist.
-
-
- route_map - -
- string - / required -
- 		- -
Route-map name.
-
-
- advertisement_interval - -
- integer -
- 		- -
Minimum interval between sending BGP routing updates.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
  • link-state
    • -
  • vpnv4
    • -
  • vpnv6
    • -
  • l2vpn
    • -
- 		-
Address Family indicator.
-
-
- allowas_in - -
- dictionary -
- 		- -
Accept as-path with my AS present in it.
-
-
- max_occurences - -
- integer -
- 		- -
Number of occurrences of AS number, default is 3.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Activate allowas-in property.
-
-
- as_override - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Override matching AS-number while sending update.
-
-
- capability - -
- dictionary -
- 		- -
Advertise capability to the peer.
-
-
- additional_paths - -
- dictionary -
- 		- -
Additional paths capability.
-
-
- receive - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Receive capability.
-
-
- send - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Send capability.
-
-
- default_originate - -
- dictionary -
- 		- -
Originate a default toward this peer.
-
-
- route_map - -
- string -
- 		- -
Route-map to specify criteria for originating default.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set default-originate attribute.
-
-
- disable_peer_as_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable checking of peer AS-number while advertising.
-
-
- filter_list - -
- dictionary -
- 		- -
Name of filter-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a template.
-
-
- sequence - -
- integer -
- 		- -
Sequence number.
-
-
- template - -
- string -
- 		- -
Template name.
-
-
- maximum_prefix - -
- dictionary -
- 		- -
Maximum number of prefixes from this neighbor.
-
-
- generate_warning_threshold - -
- integer -
- 		- -
Threshold percentage at which to generate a warning.
-
-
- max_prefix_limit - -
- integer -
- 		- -
Maximum prefix limit.
-
-
- restart_interval - -
- integer -
- 		- -
Restart bgp connection after limit is exceeded.
-
-
- warning_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Only give a warning message when limit is exceeded.
-
-
- next_hop_self - -
- dictionary -
- 		- -
Set our address as nexthop (non-reflected).
-
-
- all_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set our address as nexthop for all routes.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set next-hop-self attribute.
-
-
- next_hop_third_party - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compute a third-party nexthop if possible.
-
-
- prefix_list - -
- dictionary -
- 		- -
Apply prefix-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- rewrite_evpn_rt_asn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Auto generate RTs for EBGP neighbor.
-
-
- rewrite_rt_asn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Auto generate RTs for EBGP neighbor.
-
-
- route_map - -
- dictionary -
- 		- -
Apply route-map to neighbor.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- route_reflector_client - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure a neighbor as Route reflector client.
-
-
- safi - -
- string -
- 		-
    Choices: -
  • unicast
    • -
  • multicast
    • -
  • mvpn
    • -
  • evpn
    • -
- 		-
Sub Address Family indicator.
-
-
- send_community - -
- dictionary -
- 		- -
Send Community attribute to this neighbor.
-
-
- both - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Standard and Extended Community attributes.
-
-
- extended - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Extended Community attribute.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set send-community attribute.
-
-
- standard - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Standard Community attribute.
-
-
- soft_reconfiguration_inbound - -
- dictionary -
- 		- -
Soft reconfiguration.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always perform inbound soft reconfiguration.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set soft-reconfiguration inbound attribute.
-
-
- soo - -
- string -
- 		- -
Specify Site-of-origin extcommunity.
-
-
- suppress_inactive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise only active routes to peer.
-
-
- unsuppress_map - -
- string -
- 		- -
Route-map to selectively unsuppress suppressed routes.
-
-
- weight - -
- integer -
- 		- -
Set default weight for routes from this neighbor.
-
-
- neighbor_address - -
- string - / required -
- 		- -
IP/IPv6 address of the neighbor.
-
-
- vrfs - -
- list - / elements=dictionary -
- 		- -
Virtual Router Context.
-
-
- neighbors - -
- list - / elements=dictionary -
- 		- -
A list of BGP Neighbor AF configuration.
-
-
- address_family - -
- list - / elements=dictionary -
- 		- -
BGP Neighbor Address Family related configurations.
-
-
- advertise_map - -
- dictionary -
- 		- -
Specify route-map for conditional advertisement.
-
-
- exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition exists.
-
-
- non_exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition does not exist.
-
-
- route_map - -
- string - / required -
- 		- -
Route-map name.
-
-
- advertisement_interval - -
- integer -
- 		- -
Minimum interval between sending BGP routing updates.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
  • link-state
    • -
  • vpnv4
    • -
  • vpnv6
    • -
  • l2vpn
    • -
- 		-
Address Family indicator.
-
-
- allowas_in - -
- dictionary -
- 		- -
Accept as-path with my AS present in it.
-
-
- max_occurences - -
- integer -
- 		- -
Number of occurrences of AS number, default is 3.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Activate allowas-in property.
-
-
- as_override - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Override matching AS-number while sending update.
-
-
- capability - -
- dictionary -
- 		- -
Advertise capability to the peer.
-
-
- additional_paths - -
- dictionary -
- 		- -
Additional paths capability.
-
-
- receive - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Receive capability.
-
-
- send - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Send capability.
-
-
- default_originate - -
- dictionary -
- 		- -
Originate a default toward this peer.
-
-
- route_map - -
- string -
- 		- -
Route-map to specify criteria for originating default.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set default-originate attribute.
-
-
- disable_peer_as_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable checking of peer AS-number while advertising.
-
-
- filter_list - -
- dictionary -
- 		- -
Name of filter-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a template.
-
-
- sequence - -
- integer -
- 		- -
Sequence number.
-
-
- template - -
- string -
- 		- -
Template name.
-
-
- maximum_prefix - -
- dictionary -
- 		- -
Maximum number of prefixes from this neighbor.
-
-
- generate_warning_threshold - -
- integer -
- 		- -
Threshold percentage at which to generate a warning.
-
-
- max_prefix_limit - -
- integer -
- 		- -
Maximum prefix limit.
-
-
- restart_interval - -
- integer -
- 		- -
Restart bgp connection after limit is exceeded.
-
-
- warning_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Only give a warning message when limit is exceeded.
-
-
- next_hop_self - -
- dictionary -
- 		- -
Set our address as nexthop (non-reflected).
-
-
- all_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set our address as nexthop for all routes.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set next-hop-self attribute.
-
-
- next_hop_third_party - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compute a third-party nexthop if possible.
-
-
- prefix_list - -
- dictionary -
- 		- -
Apply prefix-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- rewrite_evpn_rt_asn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Auto generate RTs for EBGP neighbor.
-
-
- rewrite_rt_asn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Auto generate RTs for EBGP neighbor.
-
-
- route_map - -
- dictionary -
- 		- -
Apply route-map to neighbor.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- route_reflector_client - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure a neighbor as Route reflector client.
-
-
- safi - -
- string -
- 		-
    Choices: -
  • unicast
    • -
  • multicast
    • -
  • mvpn
    • -
  • evpn
    • -
- 		-
Sub Address Family indicator.
-
-
- send_community - -
- dictionary -
- 		- -
Send Community attribute to this neighbor.
-
-
- both - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Standard and Extended Community attributes.
-
-
- extended - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Extended Community attribute.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set send-community attribute.
-
-
- standard - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Standard Community attribute.
-
-
- soft_reconfiguration_inbound - -
- dictionary -
- 		- -
Soft reconfiguration.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always perform inbound soft reconfiguration.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set soft-reconfiguration inbound attribute.
-
-
- soo - -
- string -
- 		- -
Specify Site-of-origin extcommunity.
-
-
- suppress_inactive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise only active routes to peer.
-
-
- unsuppress_map - -
- string -
- 		- -
Route-map to selectively unsuppress suppressed routes.
-
-
- weight - -
- integer -
- 		- -
Set default weight for routes from this neighbor.
-
-
- neighbor_address - -
- string - / required -
- 		- -
IP/IPv6 address of the neighbor.
-
-
- vrf - -
- string -
- 		- -
VRF name.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^router bgp'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
State deleted only removes BGP attributes that this modules manages and does not negate the BGP process completely.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - Unsupported for Cisco MDS - - For managing BGP address family configurations please use the :ref:`cisco.nxos.nxos_bgp_address_family ` module. - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # Nexus9000v# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_bgp_neighbor_address_family: &id001 - config: - as_number: 65536 - neighbors: - - neighbor_address: 192.0.2.32 - address_family: - - afi: ipv4 - safi: unicast - maximum_prefix: - max_prefix_limit: 20 - generate_warning_threshold: 75 - weight: 100 - prefix_list: - inbound: rmap1 - outbound: rmap2 - - afi: ipv6 - safi: unicast - - neighbor_address: 192.0.2.33 - address_family: - - afi: ipv4 - safi: multicast - inherit: - template: BasePolicy - sequence: 200 - vrfs: - - vrf: site-1 - neighbors: - - neighbor_address: 203.0.113.1 - address_family: - - afi: ipv4 - safi: unicast - suppress_inactive: true - next_hop_self: - set: true - - neighbor_address: 203.0.113.2 - address_family: - - afi: ipv6 - safi: unicast - - afi: ipv4 - safi: multicast - send_community: - set: true - - # Task output: - # ------------ - # before: {} - # - # commands: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - address-family ipv4 unicast - # - maximum-prefix 20 75 - # - weight 100 - # - prefix-list rmap1 in - # - prefix-list rmap2 out - # - address-family ipv6 unicast - # - neighbor 192.0.2.33 - # - address-family ipv4 multicast - # - inherit peer-policy BasePolicy 200 - # - vrf site-1 - # - neighbor 203.0.113.1 - # - address-family ipv4 unicast - # - suppress-inactive - # - next-hop-self - # - neighbor 203.0.113.2 - # - address-family ipv6 unicast - # - address-family ipv4 multicast - # - send-community - # - # after: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - # Using replaced - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - - name: Replace specified neighbor AFs with given configuration - cisco.nxos.nxos_bgp_neighbor_address_family: &replaced - config: - as_number: 65536 - neighbors: - - neighbor_address: 192.0.2.32 - address_family: - - afi: ipv4 - safi: unicast - weight: 110 - - afi: ipv6 - safi: unicast - - neighbor_address: 192.0.2.33 - address_family: - - afi: ipv4 - safi: multicast - inherit: - template: BasePolicy - sequence: 200 - vrfs: - - vrf: site-1 - neighbors: - - neighbor_address: 203.0.113.1 - address_family: - - afi: ipv4 - safi: unicast - - neighbor_address: 203.0.113.2 - address_family: - - afi: ipv6 - safi: unicast - - afi: ipv4 - safi: multicast - send_community: - set: true - state: replaced - - # Task output: - # ------------ - # before: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - # - # commands: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - address-family ipv4 unicast - # - no maximum-prefix 20 75 - # - weight 110 - # - no prefix-list rmap1 in - # - no prefix-list rmap2 out - # - vrf site-1 - # - neighbor 203.0.113.1 - # - address-family ipv4 unicast - # - no suppress-inactive - # - no next-hop-self - # - # after: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # weight: 110 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # weight 110 - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - # Using overridden - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - - name: Override all BGP AF configuration with provided configuration - cisco.nxos.nxos_bgp_neighbor_address_family: - config: - as_number: 65536 - neighbors: - - neighbor_address: 192.0.2.32 - address_family: - - afi: ipv4 - safi: unicast - vrfs: - - vrf: site-1 - neighbors: - - neighbor_address: 203.0.113.1 - address_family: - - afi: ipv4 - safi: unicast - suppress_inactive: true - next_hop_self: - set: true - state: overridden - - # Task output: - # ------------ - # before: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - # - # commands: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - address-family ipv4 unicast - # - no maximum-prefix 20 75 - # - no weight 100 - # - no prefix-list rmap1 in - # - no prefix-list rmap2 out - # - no address-family ipv6 unicast - # - neighbor 192.0.2.33 - # - no address-family ipv4 multicast - # - vrf site-1 - # - neighbor 203.0.113.2 - # - no address-family ipv4 multicast - # - no address-family ipv6 unicast - # - # after: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - - # Using deleted to remove specified neighbor AFs - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - - name: Delete BGP configs handled by this module - cisco.nxos.nxos_bgp_neighbor_address_family: - config: - as_number: 65536 - neighbors: - - neighbor_address: 192.0.2.32 - address_family: - - afi: ipv4 - safi: unicast - vrfs: - - vrf: site-1 - neighbors: - - neighbor_address: 203.0.113.2 - address_family: - - afi: ipv6 - safi: unicast - state: deleted - - # Task output: - # ------------ - # before: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - # - # commands: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - no address-family ipv4 unicast - # - vrf site-1 - # - neighbor 203.0.113.2 - # - no address-family ipv6 unicast - # - # after: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # - - # Using deleted to remove all neighbor AFs - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - - name: Delete all BGP neighbor AF configs handled by this module - cisco.nxos.nxos_bgp_neighbor_address_family: - state: deleted - - # Task output: - # ------------ - # before: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - # - # commands: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - no address-family ipv4 unicast - # - no address-family ipv6 unicast - # - neighbor 192.0.2.33 - # - no address-family ipv4 multicast - # - vrf site-1 - # - neighbor 203.0.113.1 - # - no address-family ipv4 unicast - # - neighbor 203.0.113.2 - # - no address-family ipv6 unicast - # - no address-family ipv4 multicast - # - # after: - # as_number: "65536" - # - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # neighbor 192.0.2.33 - # vrf site-1 - # neighbor 203.0.113.1 - # neighbor 203.0.113.2 - # - - # Using rendered - - - name: Render platform specific configuration lines with state rendered (without connecting to the device) - cisco.nxos.nxos_bgp_neighbor_address_family: - config: - as_number: 65536 - neighbors: - - neighbor_address: 192.0.2.32 - address_family: - - afi: ipv4 - safi: unicast - maximum_prefix: - max_prefix_limit: 20 - generate_warning_threshold: 75 - weight: 100 - prefix_list: - inbound: rmap1 - outbound: rmap2 - - afi: ipv6 - safi: unicast - - neighbor_address: 192.0.2.33 - address_family: - - afi: ipv4 - safi: multicast - inherit: - template: BasePolicy - sequence: 200 - vrfs: - - vrf: site-1 - neighbors: - - neighbor_address: 203.0.113.1 - address_family: - - afi: ipv4 - safi: unicast - suppress_inactive: true - next_hop_self: - set: true - - neighbor_address: 203.0.113.2 - address_family: - - afi: ipv6 - safi: unicast - - afi: ipv4 - safi: multicast - send_community: - set: true - state: rendered - - # Task output: - # ------------ - # rendered: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - address-family ipv4 unicast - # - maximum-prefix 20 75 - # - weight 100 - # - prefix-list rmap1 in - # - prefix-list rmap2 out - # - address-family ipv6 unicast - # - neighbor 192.0.2.33 - # - address-family ipv4 multicast - # - inherit peer-policy BasePolicy 200 - # - vrf site-1 - # - neighbor 203.0.113.1 - # - address-family ipv4 unicast - # - suppress-inactive - # - next-hop-self - # - neighbor 203.0.113.2 - # - address-family ipv6 unicast - # - address-family ipv4 multicast - # - send-community - - # Using parsed - - # parsed.cfg - # ------------ - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - - - name: Parse externally provided BGP neighbor AF config - register: result - cisco.nxos.nxos_bgp_neighbor_address_family: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output: - # ------------ - # parsed: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['router bgp 65536', 'neighbor 192.0.2.32', 'address-family ipv4 unicast']
-
-
- gathered - -
- dictionary -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- dictionary -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['router bgp 65536', 'neighbor 192.0.2.32', 'address-family ipv4 unicast']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_bgp_templates_module.rst b/docs/cisco.nxos.nxos_bgp_templates_module.rst deleted file mode 100644 index 9287d7a60..000000000 --- a/docs/cisco.nxos.nxos_bgp_templates_module.rst +++ /dev/null @@ -1,2841 +0,0 @@ -.. _cisco.nxos.nxos_bgp_templates_module: - - -***************************** -cisco.nxos.nxos_bgp_templates -***************************** - -**BGP Templates resource module.** - - -Version added: 4.2.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages BGP templates on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A list of BGP templates.
-
-
- as_number - -
- string -
- 		- -
Autonomous System Number of the router.
-
-
- neighbor - -
- list - / elements=dictionary -
- 		- -
Configure BGP peer templates.
-
-
- address_family - -
- list - / elements=dictionary -
- 		- -
Configure an address-family for peer.
-
-
- advertise_map - -
- dictionary -
- 		- -
Specify route-map for conditional advertisement.
-
-
- exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition exists.
-
-
- non_exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition does not exist.
-
-
- route_map - -
- string - / required -
- 		- -
Route-map name.
-
-
- advertisement_interval - -
- integer -
- 		- -
Minimum interval between sending BGP routing updates.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
  • link-state
    • -
  • l2vpn
    • -
- 		-
Address Family indicator.
-
-
- allowas_in - -
- dictionary -
- 		- -
Accept as-path with my AS present in it.
-
-
- max_occurences - -
- integer -
- 		- -
Number of occurrences of AS number, default is 3.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Activate allowas-in property.
-
-
- as_override - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Override matching AS-number while sending update.
-
-
- capability - -
- dictionary -
- 		- -
Advertise capability to the peer.
-
-
- additional_paths - -
- dictionary -
- 		- -
Additional paths capability.
-
-
- receive - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Receive capability.
-
-
- send - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Send capability.
-
-
- default_originate - -
- dictionary -
- 		- -
Originate a default toward this peer.
-
-
- route_map - -
- string -
- 		- -
Route-map to specify criteria for originating default.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set default-originate attribute.
-
-
- disable_peer_as_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable checking of peer AS-number while advertising.
-
-
- filter_list - -
- dictionary -
- 		- -
Name of filter-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a peer-policy template.
-
-
- peer_policy - -
- string -
- 		- -
Peer-policy template to inherit.
-
-
- maximum_prefix - -
- dictionary -
- 		- -
Maximum number of prefixes from this neighbor.
-
-
- generate_warning_threshold - -
- integer -
- 		- -
Threshold percentage at which to generate a warning.
-
-
- max_prefix_limit - -
- integer -
- 		- -
Maximum prefix limit.
-
-
- restart_interval - -
- integer -
- 		- -
Restart bgp connection after limit is exceeded.
-
-
- warning_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Only give a warning message when limit is exceeded.
-
-
- next_hop_self - -
- dictionary -
- 		- -
Set our address as nexthop (non-reflected).
-
-
- all_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set our address as nexthop for all routes.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set next-hop-self attribute.
-
-
- next_hop_third_party - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compute a third-party nexthop if possible.
-
-
- prefix_list - -
- dictionary -
- 		- -
Apply prefix-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- route_map - -
- dictionary -
- 		- -
Apply route-map to neighbor.
-
-
- inbound - -
- string -
- 		- -
Name of policy to apply to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Name of policy to apply to outgoing routes.
-
-
- route_reflector_client - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure a neighbor as Route reflector client.
-
-
- safi - -
- string -
- 		-
    Choices: -
  • unicast
    • -
  • multicast
    • -
  • mvpn
    • -
  • evpn
    • -
- 		-
Sub Address Family indicator.
-
-
- send_community - -
- string -
- 		-
    Choices: -
  • standard
    • -
  • extended
    • -
  • both
    • -
- 		-
Send Community attribute to this neighbor.
-
-
- soft_reconfiguration_inbound - -
- dictionary -
- 		- -
Soft reconfiguration.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always perform inbound soft reconfiguration.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set soft-reconfiguration inbound attribute.
-
-
- soo - -
- string -
- 		- -
Specify Site-of-origin extcommunity.
-
-
- suppress_inactive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise only active routes to peer.
-
-
- unsuppress_map - -
- string -
- 		- -
Route-map to selectively unsuppress suppressed routes.
-
-
- weight - -
- integer -
- 		- -
Set default weight for routes from this neighbor.
-
-
- bfd - -
- dictionary -
- 		- -
Bidirectional Fast Detection for the neighbor.
-
-
- multihop - -
- dictionary -
- 		- -
Multihop session.
-
-
- interval - -
- dictionary -
- 		- -
Configure BFD session interval parameters.
-
-
- min_rx_interval - -
- integer - / required -
- 		- -
Minimum RX interval.
-
-
- multiplier - -
- integer - / required -
- 		- -
Detect Multiplier.
-
-
- tx_interval - -
- integer - / required -
- 		- -
TX interval in milliseconds.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD multihop.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD for this neighbor.
-
-
- singlehop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Single-hop session.
-
-
- bmp_activate_server - -
- integer -
- 		- -
Specify server ID for activating BMP monitoring for the peer.
-
-
- capability - -
- dictionary -
- 		- -
Capability.
-
-
- suppress_4_byte_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress 4-byte AS Capability.
-
-
- description - -
- string -
- 		- -
Neighbor specific descripion.
-
-
- disable_connected_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable check for directly connected peer.
-
-
- dont_capability_negotiate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't negotiate capability with this neighbor.
-
-
- dscp - -
- string -
- 		- -
Set dscp value for tcp transport.
-
-
- dynamic_capability - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Dynamic Capability
-
-
- ebgp_multihop - -
- integer -
- 		- -
Specify multihop TTL for remote peer.
-
-
- graceful_shutdown - -
- dictionary -
- 		- -
Graceful-shutdown for this neighbor.
-
-
- activate - -
- dictionary -
- 		- -
Send graceful-shutdown community.
-
-
- route_map - -
- string -
- 		- -
Apply route-map to modify attributes for outbound.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set activate.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a template.
-
-
- peer_session - -
- string -
- 		- -
Peer-session template to inherit.
-
-
- local_as - -
- string -
- 		- -
Specify the local-as number for the eBGP neighbor.
-
-
- log_neighbor_changes - -
- dictionary -
- 		- -
Log message for neighbor up/down event.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable logging of neighbor up/down event.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set log-neighbor-changes.
-
-
- low_memory - -
- dictionary -
- 		- -
Behaviour in low memory situations.
-
-
- exempt - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not shutdown this peer when under memory pressure.
-
-
- name - -
- string -
- 		- -
Name of the BGP peer template.
-
-
- password - -
- dictionary -
- 		- -
Configure a password for neighbor.
-
-
- encryption - -
- integer -
- 		- -
0 specifies an UNENCRYPTED neighbor password.
-
3 specifies an 3DES ENCRYPTED neighbor password will follow.
-
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
-
-
- key - -
- string -
- 		- -
Authentication password.
-
-
- path_attribute - -
- list - / elements=dictionary -
- 		- -
BGP path attribute optional filtering.
-
-
- action - -
- string -
- 		-
    Choices: -
  • discard
    • -
  • treat-as-withdraw
    • -
- 		-
Action.
-
-
- range - -
- dictionary -
- 		- -
Path attribute range.
-
-
- end - -
- integer -
- 		- -
Path attribute range end value.
-
-
- start - -
- integer -
- 		- -
Path attribute range start value.
-
-
- type - -
- integer -
- 		- -
Path attribute type
-
-
- remote_as - -
- string -
- 		- -
Specify Autonomous System Number of the neighbor.
-
-
- remove_private_as - -
- dictionary -
- 		- -
Remove private AS number from outbound updates.
-
-
- all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All.
-
-
- replace_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Replace.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove private AS.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively shutdown this neighbor.
-
-
- timers - -
- dictionary -
- 		- -
Configure keepalive and hold timers.
-
-
- holdtime - -
- integer -
- 		- -
Holdtime (seconds).
-
-
- keepalive - -
- integer -
- 		- -
Keepalive interval (seconds).
-
-
- transport - -
- dictionary -
- 		- -
BGP transport connection.
-
-
- connection_mode - -
- dictionary -
- 		- -
Specify type of connection.
-
-
- passive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow passive connection setup only.
-
-
- ttl_security - -
- dictionary -
- 		- -
Enable TTL Security Mechanism.
-
-
- hops - -
- integer -
- 		- -
Specify hop count for remote peer.
-
-
- update_source - -
- string -
- 		- -
Specify source of BGP session and updates.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config bgp | section 'template'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - Unsupported for Cisco MDS - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # -------------- - # - # nxos9k# show running-config | section "^router bgp" - # nxos9k# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_bgp_templates: - config: - as_number: 65536 - neighbor: - - name: neighbor_tmplt_1 - address_family: - - afi: ipv4 - safi: unicast - advertise_map: - route_map: rmap1 - non_exist_map: nemap1 - advertisement_interval: 60 - disable_peer_as_check: true - bmp_activate_server: 2 - capability: - suppress_4_byte_as: true - description: Test_BGP_PEER_TEMPLATE_1 - local_as: 65536 - remote_as: 65001 - - - name: neighbor_tmplt_2 - description: Test_BGP_PEER_TEMPLATE_2 - address_family: - - afi: ipv4 - safi: multicast - advertise_map: - route_map: rmap1 - exist_map: emap1 - as_override: true - filter_list: - inbound: flist1 - outbound: flist2 - inherit: - peer_session: psession1 - timers: - holdtime: 100 - keepalive: 45 - # Task Output: - # ------------ - # before: {} - # - # commands: - # - router bgp 65536 - # - template peer neighbor_tmplt_1 - # - bmp-activate-server 2 - # - capability suppress 4-byte-as - # - description Test_BGP_PEER_TEMPLATE_1 - # - local-as 65536 - # - remote-as 65001 - # - address-family ipv4 unicast - # - advertise-map rmap1 non-exist-map nemap1 - # - advertisement-interval 60 - # - disable-peer-as-check - # - template peer neighbor_tmplt_2 - # - description Test_BGP_PEER_TEMPLATE_2 - # - inherit peer-session psession1 - # - timers 45 100 - # - address-family ipv4 multicast - # - advertise-map rmap1 exist-map emap1 - # - as-override - # - filter-list flist1 in - # - filter-list flist2 out - # - # after: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # bmp_activate_server: 2 - # capability: - # suppress_4_byte_as: true - # description: Test_BGP_PEER_TEMPLATE_1 - # local_as: "65536" - # remote_as: "65001" - # - # - name: neighbor_tmplt_2 - # description: Test_BGP_PEER_TEMPLATE_2 - # address_family: - # - afi: ipv4 - # safi: multicast - # advertise_map: - # exist_map: emap1 - # route_map: rmap1 - # as_override: true - # filter_list: - # inbound: flist1 - # outbound: flist2 - # inherit: - # peer_session: psession1 - # timers: - # holdtime: 100 - # keepalive: 45 - - # After state: - # -------------- - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # capability suppress 4-byte-as - # bmp-activate-server 2 - # description Test_BGP_PEER_TEMPLATE_1 - # local-as 65536 - # remote-as 65001 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - # template peer neighbor_tmplt_2 - # description Test_BGP_PEER_TEMPLATE_2 - # inherit peer-session psession1 - # timers 45 100 - # address-family ipv4 multicast - # advertise-map rmap1 exist-map emap1 - # as-override - # filter-list flist1 in - # filter-list flist2 out - - # Using replaced - - # Before state: - # ------------- - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # capability suppress 4-byte-as - # description Test_BGP_PEER_TEMPLATE_1 - # bmp-activate-server 2 - # local-as 65536 - # remote-as 65001 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - # template peer neighbor_tmplt_2 - # description Test_BGP_PEER_TEMPLATE_2 - # inherit peer-session psession1 - # timers 45 100 - # address-family ipv4 multicast - # advertise-map rmap1 exist-map emap1 - # as-override - # filter-list flist1 in - # filter-list flist2 out - - - name: Replace BGP templates configuration with provided configuration - cisco.nxos.nxos_bgp_templates: - config: - as_number: 65536 - neighbor: - - name: neighbor_tmplt_1 - address_family: - - afi: ipv4 - safi: unicast - advertise_map: - route_map: rmap1 - non_exist_map: nemap1 - advertisement_interval: 60 - disable_peer_as_check: true - inherit: - peer_session: psession1 - description: Test_BGP_PEER_TEMPLATE_1 - local_as: 65537 - state: replaced - - # Task output: - # ------------ - # - # before: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # bmp_activate_server: 2 - # capability: - # suppress_4_byte_as: true - # description: Test_BGP_PEER_TEMPLATE_1 - # local_as: "65536" - # remote_as: "65001" - # - # - name: neighbor_tmplt_2 - # description: Test_BGP_PEER_TEMPLATE_2 - # address_family: - # - afi: ipv4 - # safi: multicast - # advertise_map: - # exist_map: emap1 - # route_map: rmap1 - # as_override: true - # filter_list: - # inbound: flist1 - # outbound: flist2 - # inherit: - # peer_session: psession1 - # timers: - # holdtime: 100 - # keepalive: 45 - # - # commands: - # - router bgp 65536 - # - template peer neighbor_tmplt_1 - # - no bmp-activate-server 2 - # - no capability suppress 4-byte-as - # - inherit peer-session psession1 - # - local-as 65537 - # - no remote-as 65001 - # - # after: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # description: Test_BGP_PEER_TEMPLATE_1 - # inherit: - # peer_session: psession1 - # local_as: "65537" - # - # - name: neighbor_tmplt_2 - # description: Test_BGP_PEER_TEMPLATE_2 - # address_family: - # - afi: ipv4 - # safi: multicast - # advertise_map: - # exist_map: emap1 - # route_map: rmap1 - # as_override: true - # filter_list: - # inbound: flist1 - # outbound: flist2 - # inherit: - # peer_session: psession1 - # timers: - # holdtime: 100 - # keepalive: 45 - - # After state: - # ------------ - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # inherit peer-session psession1 - # description Test_BGP_PEER_TEMPLATE_1 - # local-as 65537 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - # template peer neighbor_tmplt_2 - # description Test_BGP_PEER_TEMPLATE_2 - # inherit peer-session psession1 - # bmp-activate-server 2 - # timers 45 100 - # address-family ipv4 multicast - # advertise-map rmap1 exist-map emap1 - # as-override - # filter-list flist1 in - # filter-list flist2 out - - # Using overridden - # - # Before state: - # ------------- - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # capability suppress 4-byte-as - # description Test_BGP_PEER_TEMPLATE_1 - # bmp-activate-server 2 - # local-as 65536 - # remote-as 65001 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - # template peer neighbor_tmplt_2 - # description Test_BGP_PEER_TEMPLATE_2 - # inherit peer-session psession1 - # timers 45 100 - # address-family ipv4 multicast - # advertise-map rmap1 exist-map emap1 - # as-override - # filter-list flist1 in - # filter-list flist2 out - - - name: Override BGP templates configuration with provided configuration - cisco.nxos.nxos_bgp_templates: - config: - as_number: 65536 - neighbor: - - name: neighbor_tmplt_1 - address_family: - - afi: ipv4 - safi: unicast - advertise_map: - route_map: rmap1 - non_exist_map: nemap1 - advertisement_interval: 60 - disable_peer_as_check: true - inherit: - peer_session: psession1 - description: Test_BGP_PEER_TEMPLATE_1 - local_as: 65537 - state: overridden - - # Task output: - # ------------ - # - # before: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # bmp_activate_server: 2 - # capability: - # suppress_4_byte_as: true - # description: Test_BGP_PEER_TEMPLATE_1 - # local_as: "65536" - # remote_as: "65001" - # - # - name: neighbor_tmplt_2 - # description: Test_BGP_PEER_TEMPLATE_2 - # address_family: - # - afi: ipv4 - # safi: multicast - # advertise_map: - # exist_map: emap1 - # route_map: rmap1 - # as_override: true - # filter_list: - # inbound: flist1 - # outbound: flist2 - # inherit: - # peer_session: psession1 - # timers: - # holdtime: 100 - # keepalive: 45 - # - # commands: - # - router bgp 65536 - # - template peer neighbor_tmplt_1 - # - no bmp-activate-server 2 - # - no capability suppress 4-byte-as - # - inherit peer-session psession1 - # - local-as 65537 - # - no remote-as 65001 - # - no template peer neighbor_tmplt_2 - # - # after: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # description: Test_BGP_PEER_TEMPLATE_1 - # inherit: - # peer_session: psession1 - # local_as: "65537" - - # After state: - # ------------ - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # inherit peer-session psession1 - # description Test_BGP_PEER_TEMPLATE_1 - # local-as 65537 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - - # Using deleted - - # Before state: - # -------------- - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # capability suppress 4-byte-as - # description Test_BGP_PEER_TEMPLATE_1 - # bmp-activate-server 2 - # local-as 65536 - # remote-as 65001 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - # template peer neighbor_tmplt_2 - # description Test_BGP_PEER_TEMPLATE_2 - # inherit peer-session psession1 - # timers 45 100 - # address-family ipv4 multicast - # advertise-map rmap1 exist-map emap1 - # as-override - # filter-list flist1 in - # filter-list flist2 out - - - name: Delete BGP configs handled by this module - cisco.nxos.nxos_bgp_templates: - state: deleted - - # Task output: - # ------------ - # - # before: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # bmp_activate_server: 2 - # capability: - # suppress_4_byte_as: true - # description: Test_BGP_PEER_TEMPLATE_1 - # local_as: "65536" - # remote_as: "65001" - # - # - name: neighbor_tmplt_2 - # description: Test_BGP_PEER_TEMPLATE_2 - # address_family: - # - afi: ipv4 - # safi: multicast - # advertise_map: - # exist_map: emap1 - # route_map: rmap1 - # as_override: true - # filter_list: - # inbound: flist1 - # outbound: flist2 - # inherit: - # peer_session: psession1 - # timers: - # holdtime: 100 - # keepalive: 45 - # - # commands: - # - router bgp 65536 - # - no template peer neighbor_tmplt_1 - # - no template peer neighbor_tmplt_2 - # - # after: {} - - # After state: - # ------------- - # nxos9k# show running-config | section "^router bgp" - # nxos9k# - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['router bgp 65536', 'template peer neighbor_tmplt_1', 'no bmp-activate-server 2', 'no capability suppress 4-byte-as', 'inherit peer-session psession1', 'local-as 65537', 'no remote-as 65001', 'no template peer neighbor_tmplt_2']
-
-
- gathered - -
- dictionary -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- dictionary -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['router bgp 65536', 'template peer neighbor_tmplt_1', 'bmp-activate-server 2', 'no capability suppress 4-byte-as', 'no template peer neighbor_tmplt_2']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_command_module.rst b/docs/cisco.nxos.nxos_command_module.rst deleted file mode 100644 index 4308a6582..000000000 --- a/docs/cisco.nxos.nxos_command_module.rst +++ /dev/null @@ -1,258 +0,0 @@ -.. _cisco.nxos.nxos_command_module: - - -*********************** -cisco.nxos.nxos_command -*********************** - -**Run arbitrary command on Cisco NXOS devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Sends an arbitrary command to an NXOS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- commands - -
- list - / elements=raw - / required -
- 		- -
The commands to send to the remote NXOS device. The resulting output from the command is returned. If the wait_for argument is provided, the module is not returned until the condition is satisfied or the number of retires as expired.
-
The commands argument also accepts an alternative form that allows for complex values that specify the command to run and the output format to return. This can be done on a command by command basis. The complex argument supports the keywords command and output where command is the command to run and output is one of 'text' or 'json'.
-
If a command sent to the device requires answering a prompt, it is possible to pass a dict containing command, answer and prompt. Common answers are 'y' or "\r" (carriage return, must be double quotes). See examples.
-
-
- interval - -
- integer -
- 		- Default:
1
- 		-
Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditional, the interval indicates how to long to wait before trying the command again.
-
-
- match - -
- string -
- 		-
    Choices: -
  • any
    • -
  • all ←
    • -
- 		-
The match argument is used in conjunction with the wait_for argument to specify the match policy. Valid values are all or any. If the value is set to all then all conditionals in the wait_for must be satisfied. If the value is set to any then only one of the values must be satisfied.
-
-
- retries - -
- integer -
- 		- Default:
9
- 		-
Specifies the number of retries a command should by tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait_for conditionals.
-
The commands are run once when retries is set to 0.
-
-
- wait_for - -
- list - / elements=string -
- 		- -
Specifies what to evaluate from the output of the command and what conditionals to apply. This argument will cause the task to wait for a particular conditional to be true before moving forward. If the conditional is not true by the configured retries, the task fails. See examples.
-

aliases: waitfor
-
-
- - -Notes ------ - -.. note:: - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: run show version on remote devices - cisco.nxos.nxos_command: - commands: show version - - - name: run show version and check to see if output contains Cisco - cisco.nxos.nxos_command: - commands: show version - wait_for: result[0] contains Cisco - - - name: run multiple commands on remote nodes - cisco.nxos.nxos_command: - commands: - - show version - - show interfaces - - - name: run multiple commands and evaluate the output - cisco.nxos.nxos_command: - commands: - - show version - - show interfaces - wait_for: - - result[0] contains Cisco - - result[1] contains loopback0 - - - name: run commands and specify the output format - cisco.nxos.nxos_command: - commands: - - command: show version - output: json - - - name: run commands that require answering a prompt - cisco.nxos.nxos_command: - commands: - - configure terminal - - command: no feature npv - prompt: Do you want to continue - answer: y - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- failed_conditions - -
- list -
- 		failed -
The list of conditionals that have failed
-
-
Sample:
-
['...', '...']
-
-
- stdout - -
- list -
- 		always apart from low level errors (such as action plugin) -
The set of responses from the commands
-
-
Sample:
-
['...', '...']
-
-
- stdout_lines - -
- list -
- 		always apart from low level errors (such as action plugin) -
The value of stdout split into a list
-
-
Sample:
-
[['...', '...'], ['...'], ['...']]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_config_module.rst b/docs/cisco.nxos.nxos_config_module.rst deleted file mode 100644 index 3ead5ab50..000000000 --- a/docs/cisco.nxos.nxos_config_module.rst +++ /dev/null @@ -1,566 +0,0 @@ -.. _cisco.nxos.nxos_config_module: - - -********************** -cisco.nxos.nxos_config -********************** - -**Manage Cisco NXOS configuration sections** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- 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. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- after - -
- list - / elements=string -
- 		- -
The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with before this allows the playbook designer to append a set of commands to be executed after the command set.
-
-
- backup - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
This argument will cause the module to create a full backup of the current running-config from the remote device before any changes are made. If the backup_options value is not given, the backup file is written to the backup folder in the playbook root directory or role root directory, if playbook is part of an ansible role. If the directory does not exist, it is created.
-
-
- backup_options - -
- dictionary -
- 		- -
This is a dict object containing configurable options related to backup file path. The value of this option is read only when backup is set to True, if backup is set to false this option will be silently ignored.
-
-
- dir_path - -
- path -
- 		- -
This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be created and the filename is either the value of filename or default filename as described in filename options description. If the path value is not given in that case a backup directory will be created in the current working directory and backup configuration will be copied in filename within backup directory.
-
-
- filename - -
- string -
- 		- -
The filename to be used to store the backup configuration. If the filename is not given it will be generated based on the hostname, current time and date in format defined by <hostname>_config.<current-date>@<current-time>
-
-
- before - -
- list - / elements=string -
- 		- -
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.
-
-
- defaults - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
The 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
-
-
- diff_against - -
- string -
- 		-
    Choices: -
  • startup
    • -
  • intended
    • -
  • running
    • -
- 		-
When using the ansible-playbook --diff command line argument the module can generate diffs against different sources.
-
When this option is configure as startup, the module will return the diff of the running-config against the startup-config.
-
When this option is configured as intended, the module will return the diff of the running-config against the configuration provided in the intended_config argument.
-
When this option is configured as running, the module will return the before and after diff of the running-config with respect to any changes made to the device configuration.
-
-
- diff_ignore_lines - -
- list - / elements=string -
- 		- -
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.
-
-
- intended_config - -
- string -
- 		- -
The 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 diff_against value and set it to intended. The configuration lines for this value should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure correct diff.
-
-
- lines - -
- list - / elements=string -
- 		- -
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 to ensure idempotency and correct diff. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser.
-

aliases: commands
-
-
- match - -
- string -
- 		-
    Choices: -
  • line ←
    • -
  • strict
    • -
  • exact
    • -
  • none
    • -
- 		-
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 line, commands are matched line by line. If match is set to strict, command lines are matched with respect to position. If match is set to exact, command lines must be an equal match. Finally, if match is set to none, the module will not attempt to compare the source configuration with the running configuration on the remote device.
-
-
- parents - -
- list - / elements=string -
- 		- -
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.
-
-
- replace - -
- string -
- 		-
    Choices: -
  • line ←
    • -
  • block
    • -
  • config
    • -
- 		-
Instructs the module on the way to perform the configuration on the device. If the replace argument is set to line then the modified lines are pushed to the device in configuration mode. If the replace argument is set to block then the entire command block is pushed to the device in configuration mode if any line is not correct. replace config will only work for NX-OS versions that support `config replace`.
-
-
- replace_src - -
- string -
- 		- -
The 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 replace with value config. This is mutually exclusive with the lines and src arguments. This argument will only work for NX-OS versions that support `config replace`. Use nxos_file_copy module to copy the flat file to remote device and then use the path with this argument. The configuration lines in the file should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure idempotency and correct diff.
-
-
- running_config - -
- string -
- 		- -
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 running_config argument allows the implementer to pass in the configuration to use as the base config for comparison. The configuration lines for this option should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure idempotency and correct diff.
-

aliases: config
-
-
- save_when - -
- string -
- 		-
    Choices: -
  • always
    • -
  • never ←
    • -
  • modified
    • -
  • changed
    • -
- 		-
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 always, then the running-config will always be copied to the startup-config and the modified flag will always be set to True. If the argument is set to 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 never, the running-config will never be copied to the startup-config. If the argument is set to changed, then the running-config will only be copied to the startup-config if the task has made a change. changed was added in Ansible 2.6.
-
-
- src - -
- path -
- 		- -
The 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 lines and parents arguments. The configuration lines in the source file should be similar to how it will appear if present in the running-configuration of the device including indentation to ensure idempotency and correct diff.
-
-
- - -Notes ------ - -.. note:: - - Unsupported for Cisco MDS - - Abbreviated commands are NOT idempotent, see https://docs.ansible.com/ansible/latest/network/user_guide/faq.html#why-do-the-config-modules-always-return-changed-true-with-abbreviated-commands. - - To ensure idempotency and correct diff the configuration lines in the relevant module options should be similar to how they appear if present in the running configuration on device including the indentation. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: configure top level configuration and save it - cisco.nxos.nxos_config: - lines: hostname {{ inventory_hostname }} - save_when: modified - - - name: diff the running-config against a provided config - cisco.nxos.nxos_config: - diff_against: intended - intended_config: "{{ lookup('file', 'master.cfg') }}" - - - cisco.nxos.nxos_config: - lines: - - 10 permit ip 192.0.2.1/32 any log - - 20 permit ip 192.0.2.2/32 any log - - 30 permit ip 192.0.2.3/32 any log - - 40 permit ip 192.0.2.4/32 any log - - 50 permit ip 192.0.2.5/32 any log - parents: ip access-list test - before: no ip access-list test - match: exact - - - cisco.nxos.nxos_config: - lines: - - 10 permit ip 192.0.2.1/32 any log - - 20 permit ip 192.0.2.2/32 any log - - 30 permit ip 192.0.2.3/32 any log - - 40 permit ip 192.0.2.4/32 any log - parents: ip access-list test - before: no ip access-list test - replace: block - - - name: replace config with flat file - cisco.nxos.nxos_config: - replace_src: config.txt - replace: config - - - name: for idempotency, use full-form commands - cisco.nxos.nxos_config: - lines: - # - shut - - shutdown - # parents: int eth1/1 - parents: interface Ethernet1/1 - - - name: configurable backup path - cisco.nxos.nxos_config: - backup: true - backup_options: - filename: backup.cfg - dir_path: /home/user - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- backup_path - -
- string -
- 		when backup is yes -
The full path to the backup file
-
-
Sample:
-
/playbooks/ansible/backup/nxos_config.2016-07-16@22:28:34
-
-
- commands - -
- list -
- 		always -
The set of commands that will be pushed to the remote device
-
-
Sample:
-
['hostname foo', 'vlan 1', 'name default']
-
-
- date - -
- string -
- 		when backup is yes -
The date extracted from the backup file name
-
-
Sample:
-
2016-07-16
-
-
- filename - -
- string -
- 		when backup is yes and filename is not specified in backup options -
The name of the backup file
-
-
Sample:
-
nxos_config.2016-07-16@22:28:34
-
-
- shortname - -
- string -
- 		when backup is yes and filename is not specified in backup options -
The full path to the backup file excluding the timestamp
-
-
Sample:
-
/playbooks/ansible/backup/nxos_config
-
-
- time - -
- string -
- 		when backup is yes -
The time extracted from the backup file name
-
-
Sample:
-
22:28:34
-
-
- updates - -
- list -
- 		always -
The set of commands that will be pushed to the remote device
-
-
Sample:
-
['hostname foo', 'vlan 1', 'name default']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_devicealias_module.rst b/docs/cisco.nxos.nxos_devicealias_module.rst deleted file mode 100644 index 081c8759f..000000000 --- a/docs/cisco.nxos.nxos_devicealias_module.rst +++ /dev/null @@ -1,273 +0,0 @@ -.. _cisco.nxos.nxos_devicealias_module: - - -*************************** -cisco.nxos.nxos_devicealias -*************************** - -**Configuration of device alias for Cisco NXOS MDS Switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configuration of device alias for Cisco MDS NXOS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- da - -
- list - / elements=dictionary -
- 		- -
List of device-alias to be added or removed
-
-
- name - -
- string - / required -
- 		- -
Name of the device-alias to be added or removed
-
-
- pwwn - -
- string -
- 		- -
pwwn to which the name needs to be associated with
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Removes the device-alias if set to True
-
-
- distribute - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable device-alias distribution
-
-
- mode - -
- string -
- 		-
    Choices: -
  • basic
    • -
  • enhanced
    • -
- 		-
Mode of devices-alias, basic or enhanced
-
-
- rename - -
- list - / elements=dictionary -
- 		- -
List of device-alias to be renamed
-
-
- new_name - -
- string - / required -
- 		- -
New name of the device-alias
-
-
- old_name - -
- string - / required -
- 		- -
Old name of the device-alias that needs to be renamed
-
-
- - -Notes ------ - -.. note:: - - Tested against Cisco MDS NX-OS 8.4(1) - - - -Examples --------- - -.. code-block:: yaml - - - name: Test that device alias module works - cisco.nxos.nxos_devicealias: - da: - - name: test1_add - pwwn: 56:2:22:11:22:88:11:67 - - name: test2_add - pwwn: 65:22:22:11:22:22:11:d - - name: dev1 - remove: true - - name: dev2 - remove: true - distribute: true - mode: enhanced - rename: - - new_name: bcd - old_name: abc - - new_name: bcd1 - old_name: abc1 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['terminal dont-ask', 'device-alias database', 'device-alias name somename pwwn 10:00:00:00:89:a1:01:03', 'device-alias name somename1 pwwn 10:00:00:00:89:a1:02:03', 'device-alias commit', 'no terminal dont-ask']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) diff --git a/docs/cisco.nxos.nxos_evpn_global_module.rst b/docs/cisco.nxos.nxos_evpn_global_module.rst deleted file mode 100644 index d1b2a8241..000000000 --- a/docs/cisco.nxos.nxos_evpn_global_module.rst +++ /dev/null @@ -1,122 +0,0 @@ -.. _cisco.nxos.nxos_evpn_global_module: - - -*************************** -cisco.nxos.nxos_evpn_global -*************************** - -**Handles the EVPN control plane for VXLAN.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Handles the EVPN control plane for VXLAN. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- nv_overlay_evpn - -
- boolean - / required -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
EVPN control plane.
-
-
- - -Notes ------ - -.. note:: - - This module is not supported on Nexus 3000 series of switches. - - Unsupported for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_evpn_global: - nv_overlay_evpn: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The set of commands to be sent to the remote device
-
-
Sample:
-
['nv overlay evpn']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_evpn_vni_module.rst b/docs/cisco.nxos.nxos_evpn_vni_module.rst deleted file mode 100644 index 530a9ff18..000000000 --- a/docs/cisco.nxos.nxos_evpn_vni_module.rst +++ /dev/null @@ -1,212 +0,0 @@ -.. _cisco.nxos.nxos_evpn_vni_module: - - -************************ -cisco.nxos.nxos_evpn_vni -************************ - -**Manages Cisco EVPN VXLAN Network Identifier (VNI).** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages Cisco Ethernet Virtual Private Network (EVPN) VXLAN Network Identifier (VNI) configurations of a Nexus device. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- route_distinguisher - -
- string -
- 		- -
The VPN Route Distinguisher (RD). The RD is combined with the IPv4 or IPv6 prefix learned by the PE router to create a globally unique address.
-
-
- route_target_both - -
- list - / elements=string -
- 		- -
Enables/Disables route-target settings for both import and export target communities using a single property.
-
-
- route_target_export - -
- list - / elements=string -
- 		- -
Sets the route-target 'export' extended communities.
-
-
- route_target_import - -
- list - / elements=string -
- 		- -
Sets the route-target 'import' extended communities.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Determines whether the config should be present or not on the device.
-
-
- vni - -
- string - / required -
- 		- -
The EVPN VXLAN Network Identifier.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - default, where supported, restores params default value. - - RD override is not permitted. You should set it to the default values first and then reconfigure it. - - ``route_target_both``, ``route_target_import`` and ``route_target_export valid`` values are a list of extended communities, (i.e. ['1.2.3.4:5', '33:55']) or the keywords 'auto' or 'default'. - - The ``route_target_both`` property is discouraged due to the inconsistent behavior of the property across Nexus platforms and image versions. For this reason it is recommended to use explicit ``route_target_export`` and ``route_target_import`` properties instead of ``route_target_both``. - - RD valid values are a string in one of the route-distinguisher formats, the keyword 'auto', or the keyword 'default'. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: vni configuration - cisco.nxos.nxos_evpn_vni: - vni: 6000 - route_distinguisher: 60:10 - route_target_import: - - "5000:10" - - "4100:100" - route_target_export: auto - route_target_both: default - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['evpn', 'vni 6000 l2', 'route-target import 5001:10']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_facts_module.rst b/docs/cisco.nxos.nxos_facts_module.rst deleted file mode 100644 index 3ce96abea..000000000 --- a/docs/cisco.nxos.nxos_facts_module.rst +++ /dev/null @@ -1,553 +0,0 @@ -.. _cisco.nxos.nxos_facts_module: - - -********************* -cisco.nxos.nxos_facts -********************* - -**Gets facts about NX-OS switches** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Collects facts from Cisco Nexus devices running the NX-OS operating system. Fact collection is supported over both ``network_cli`` and ``httpapi``. This module prepends all of the base network fact keys with ``ansible_net_``. The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- available_network_resources - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
When set to true a list of network resources for which resource modules are available will be provided.
-
-
- gather_network_resources - -
- list - / elements=string -
- 		- -
When supplied, this argument will gather configuration facts only for the given subset. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
-
Valid subsets are all, bfd_interfaces, lag_interfaces, telemetry, vlans, lacp, lacp_interfaces, interfaces, l3_interfaces, l2_interfaces, lldp_global, acls, acl_interfaces, ospfv2, ospfv3, ospf_interfaces, bgp_global, bgp_address_family, route_maps, prefix_lists, logging_global, ntp_global, snmp_server, hostname.
-
-
- gather_subset - -
- list - / elements=string -
- 		- Default:
"min"
- 		-
When supplied, this argument will gather operational facts only for the given subset. Possible values for this argument include all, hardware, config, legacy, interfaces, and min. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Gather all legacy facts - cisco.nxos.nxos_facts: - gather_subset: all - - name: Gather only the config and default facts - cisco.nxos.nxos_facts: - gather_subset: - - config - - name: Do not gather hardware facts - cisco.nxos.nxos_facts: - gather_subset: - - '!hardware' - - name: Gather legacy and resource facts - cisco.nxos.nxos_facts: - gather_subset: all - gather_network_resources: all - - name: Gather only the interfaces resource facts and no legacy facts - cisco.nxos.nxos_facts: - gather_subset: - - '!all' - - '!min' - gather_network_resources: - - interfaces - - name: Gather interfaces resource and minimal legacy facts - cisco.nxos.nxos_facts: - gather_subset: min - gather_network_resources: interfaces - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- ansible_net_all_ipv4_addresses - -
- list -
- 		when interfaces is configured -
All IPv4 addresses configured on the device
-
-
-
- ansible_net_all_ipv6_addresses - -
- list -
- 		when interfaces is configured -
All IPv6 addresses configured on the device
-
-
-
- ansible_net_api - -
- string -
- 		always -
The name of the transport
-
-
-
- ansible_net_config - -
- string -
- 		when config is configured -
The current active config from the device
-
-
-
- ansible_net_filesystems - -
- list -
- 		when hardware is configured -
All file system names available on the device
-
-
-
- ansible_net_gather_network_resources - -
- list -
- 		when the resource is configured -
The list of fact for network resource subsets collected from the device
-
-
-
- ansible_net_gather_subset - -
- list -
- 		always -
The list of fact subsets collected from the device
-
-
-
- ansible_net_hostname - -
- string -
- 		always -
The configured hostname of the device
-
-
-
- ansible_net_image - -
- string -
- 		always -
The image file the device is running
-
-
-
- ansible_net_interfaces - -
- dictionary -
- 		when interfaces is configured -
A hash of all interfaces running on the system
-
-
-
- ansible_net_license_hostid - -
- string -
- 		always -
The License host id of the device
-
-
-
- ansible_net_memfree_mb - -
- integer -
- 		when hardware is configured -
The available free memory on the remote device in Mb
-
-
-
- ansible_net_memtotal_mb - -
- integer -
- 		when hardware is configured -
The total memory on the remote device in Mb
-
-
-
- ansible_net_model - -
- string -
- 		always -
The model name returned from the device
-
-
-
- ansible_net_neighbors - -
- dictionary -
- 		when interfaces is configured -
The list of LLDP and CDP neighbors from the device. If both, CDP and LLDP neighbor data is present on one port, CDP is preferred.
-
-
-
- ansible_net_python_version - -
- string -
- 		always -
The Python version Ansible controller is using
-
-
-
- ansible_net_serialnum - -
- string -
- 		always -
The serial number of the remote device
-
-
-
- ansible_net_version - -
- string -
- 		always -
The operating system version running on the remote device
-
-
-
- fan_info - -
- dictionary -
- 		when legacy is configured -
A hash of facts about fans in the remote device
-
-
-
- hostname - -
- dictionary -
- 		when legacy is configured -
The configured hostname of the remote device
-
-
-
- interfaces_list - -
- dictionary -
- 		when legacy is configured -
The list of interface names on the remote device
-
-
-
- kickstart - -
- string -
- 		when legacy is configured -
The software version used to boot the system
-
-
-
- module - -
- dictionary -
- 		when legacy is configured -
A hash of facts about the modules in a remote device
-
-
-
- platform - -
- string -
- 		when legacy is configured -
The hardware platform reported by the remote device
-
-
-
- power_supply_info - -
- string -
- 		when legacy is configured -
A hash of facts about the power supplies in the remote device
-
-
-
- vlan_list - -
- list -
- 		when legacy is configured -
The list of VLAN IDs configured on the remote device
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_feature_module.rst b/docs/cisco.nxos.nxos_feature_module.rst deleted file mode 100644 index ee2539180..000000000 --- a/docs/cisco.nxos.nxos_feature_module.rst +++ /dev/null @@ -1,150 +0,0 @@ -.. _cisco.nxos.nxos_feature_module: - - -*********************** -cisco.nxos.nxos_feature -*********************** - -**Manage features in NX-OS switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Offers ability to enable and disable features in NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- feature - -
- string - / required -
- 		- -
Name of feature.
-
-
- state - -
- string -
- 		-
    Choices: -
  • enabled ←
    • -
  • disabled
    • -
- 		-
Desired state of the feature.
-
-
- - -Notes ------ - -.. note:: - - Tested against Cisco MDS NX-OS 9.2(2) - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - 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 Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The set of commands to be sent to the remote device
-
-
Sample:
-
['nv overlay evpn']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) -- Suhas Bharadwaj (@srbharadwaj) diff --git a/docs/cisco.nxos.nxos_gir_module.rst b/docs/cisco.nxos.nxos_gir_module.rst deleted file mode 100644 index 61c809ea0..000000000 --- a/docs/cisco.nxos.nxos_gir_module.rst +++ /dev/null @@ -1,302 +0,0 @@ -.. _cisco.nxos.nxos_gir_module: - - -******************* -cisco.nxos.nxos_gir -******************* - -**Trigger a graceful removal or insertion (GIR) of the switch.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Trigger a graceful removal or insertion (GIR) of the switch. -- GIR processing may take more than 2 minutes. Timeout settings are automatically extended to 200s when user timeout settings are insufficient. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Specify desired state of the resource.
-
-
- system_mode_maintenance - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
When system_mode_maintenance=true it puts all enabled protocols in maintenance mode (using the isolate command). When system_mode_maintenance=false it puts all enabled protocols in normal mode (using the no isolate command).
-
-
- system_mode_maintenance_dont_generate_profile - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
When system_mode_maintenance_dont_generate_profile=true it prevents the dynamic searching of enabled protocols and executes commands configured in a maintenance-mode profile. Use this option if you want the system to use a maintenance-mode profile that you have created. When system_mode_maintenance_dont_generate_profile=false it prevents the dynamic searching of enabled protocols and executes commands configured in a normal-mode profile. Use this option if you want the system to use a normal-mode profile that you have created.
-
-
- system_mode_maintenance_on_reload_reset_reason - -
- string -
- 		-
    Choices: -
  • hw_error
    • -
  • svc_failure
    • -
  • kern_failure
    • -
  • wdog_timeout
    • -
  • fatal_error
    • -
  • lc_failure
    • -
  • match_any
    • -
  • manual_reload
    • -
  • any_other
    • -
  • maintenance
    • -
- 		-
Boots the switch into maintenance mode automatically in the event of a specified system crash. Note that not all reset reasons are applicable for all platforms. Also if reset reason is set to match_any, it is not idempotent as it turns on all reset reasons. If reset reason is match_any and state is absent, it turns off all the reset reasons.
-
-
- system_mode_maintenance_shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Shuts down all protocols, vPC domains, and interfaces except the management interface (using the shutdown command). This option is disruptive while system_mode_maintenance (which uses the isolate command) is not.
-
-
- system_mode_maintenance_timeout - -
- string -
- 		- -
Keeps the switch in maintenance mode for a specified number of minutes. Range is 5-65535.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - ``state`` has effect only in combination with ``system_mode_maintenance_timeout`` or ``system_mode_maintenance_on_reload_reset_reason``. - - Using ``system_mode_maintenance`` and ``system_mode_maintenance_dont_generate_profile`` would make the module fail, but the system mode will be triggered anyway. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Trigger system maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance: true - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Trigger system normal mode - - cisco.nxos.nxos_gir: - system_mode_maintenance: false - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Configure on-reload reset-reason for maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance_on_reload_reset_reason: manual_reload - state: present - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Add on-reload reset-reason for maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance_on_reload_reset_reason: hw_error - state: present - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Remove on-reload reset-reason for maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance_on_reload_reset_reason: manual_reload - state: absent - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Set timeout for maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance_timeout: 30 - state: present - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Remove timeout for maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance_timeout: 30 - state: absent - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- final_system_mode - -
- string -
- 		verbose mode -
describe the last system mode
-
-
Sample:
-
normal
-
-
- updates - -
- list -
- 		verbose mode -
commands sent to the device
-
-
Sample:
-
['terminal dont-ask', 'system mode maintenance timeout 10']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_gir_profile_management_module.rst b/docs/cisco.nxos.nxos_gir_profile_management_module.rst deleted file mode 100644 index 95d85ae9b..000000000 --- a/docs/cisco.nxos.nxos_gir_profile_management_module.rst +++ /dev/null @@ -1,235 +0,0 @@ -.. _cisco.nxos.nxos_gir_profile_management_module: - - -************************************** -cisco.nxos.nxos_gir_profile_management -************************************** - -**Create a maintenance-mode or normal-mode profile for GIR.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manage a maintenance-mode or normal-mode profile with configuration commands that can be applied during graceful removal or graceful insertion. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- commands - -
- list - / elements=string -
- 		- -
List of commands to be included into the profile.
-
-
- mode - -
- string - / required -
- 		-
    Choices: -
  • maintenance
    • -
  • normal
    • -
- 		-
Configure the profile as Maintenance or Normal mode.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Specify desired state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - ``state=absent`` removes the whole profile. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Create a maintenance-mode profile - - cisco.nxos.nxos_gir_profile_management: - mode: maintenance - commands: - - router eigrp 11 - - isolate - - # Remove the maintenance-mode profile - - cisco.nxos.nxos_gir_profile_management: - mode: maintenance - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- end_state - -
- list -
- 		verbose mode -
list of profile entries after module execution.
-
-
Sample:
-
['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete', 'router eigrp 11', 'isolate']
-
-
- existing - -
- list -
- 		verbose mode -
list of existing profile commands.
-
-
Sample:
-
['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete']
-
-
- proposed - -
- list -
- 		verbose mode -
list of commands passed into module.
-
-
Sample:
-
['router eigrp 11', 'isolate']
-
-
- updates - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['configure maintenance profile maintenance-mode', 'router eigrp 11', 'isolate']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_hostname_module.rst b/docs/cisco.nxos.nxos_hostname_module.rst deleted file mode 100644 index c8a9ee45d..000000000 --- a/docs/cisco.nxos.nxos_hostname_module.rst +++ /dev/null @@ -1,344 +0,0 @@ -.. _cisco.nxos.nxos_hostname_module: - - -************************ -cisco.nxos.nxos_hostname -************************ - -**Hostname resource module.** - - -Version added: 2.9.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages hostname configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A dictionary of hostname configuration.
-
-
- hostname - -
- string -
- 		- -
Hostname of the device.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section hostname.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
The states merged, replaced and overridden have identical behaviour for this module.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged (replaced, overridden has the same behaviour) - - # Before state: - # ------------- - # nxos-9k-rdo# show running-config | section ^hostname - # nxos-9k-rdo# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_hostname: - config: - hostname: NXOSv-9k - - # Task output - # ------------- - # before: {} - # - # commands: - # - hostname NXOSv-9k - # - # after: - # hostname: NXOSv-9k - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section ^hostname - # hostname NXOSv-9k - # - - # Using deleted - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section ^hostname - # hostname NXOSv-9k - - - name: Delete hostname from running-config - cisco.nxos.nxos_hostname: - state: deleted - - # Task output - # ------------- - # before: - # hostname: NXOSv-9k - # - # commands: - # - no hostname NXOSv-9k - # - # after: {} - - # Using gathered - - - name: Gather hostname facts using gathered - cisco.nxos.nxos_hostname: - state: gathered - - # Task output (redacted) - # ----------------------- - # gathered: - # hostname: NXOSv-9k - - # Using rendered - - - name: Render platform specific configuration lines (without connecting to the device) - cisco.nxos.nxos_hostname: - config: - hostname: NXOSv-9k - - # Task Output (redacted) - # ----------------------- - # rendered: - # - hostname NXOSv-9k - - # Using parsed - - # parsed.cfg - # ------------ - # hostname NXOSv-9k - - - name: Parse externally provided hostname config - cisco.nxos.nxos_hostname: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # hostname: NXOSv-9k - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['hostname switch01']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['hostname switch01']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst b/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst deleted file mode 100644 index 163612413..000000000 --- a/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst +++ /dev/null @@ -1,344 +0,0 @@ -.. _cisco.nxos.nxos_hsrp_interfaces_module: - - -******************************* -cisco.nxos.nxos_hsrp_interfaces -******************************* - -**HSRP interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages Hot Standby Router Protocol (HSRP) interface attributes. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
The provided configuration
-
-
- bfd - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Enable/Disable HSRP Bidirectional Forwarding Detection (BFD) on the interface.
-
-
- name - -
- string -
- 		- -
The name of the interface.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 7.0(3)I5(1). - - Feature bfd should be enabled for this module. - - Unsupported for Cisco MDS - - - -Examples --------- - -.. code-block:: yaml - - # Using deleted - - - name: Configure hsrp attributes on interfaces - cisco.nxos.nxos_hsrp_interfaces: - config: - - name: Ethernet1/1 - - name: Ethernet1/2 - operation: deleted - - - # Using merged - - - name: Configure hsrp attributes on interfaces - cisco.nxos.nxos_hsrp_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - - name: Ethernet1/2 - bfd: disable - operation: merged - - - # Using overridden - - - name: Configure hsrp attributes on interfaces - cisco.nxos.nxos_hsrp_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - - name: Ethernet1/2 - bfd: disable - operation: overridden - - - # Using replaced - - - name: Configure hsrp attributes on interfaces - cisco.nxos.nxos_hsrp_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - - name: Ethernet1/2 - bfd: disable - operation: replaced - - # Using rendered - - - name: Use rendered state to convert task input to device specific commands - cisco.nxos.nxos_hsrp_interfaces: - config: - - name: Ethernet1/800 - bfd: enable - - name: Ethernet1/801 - bfd: enable - state: rendered - - # Task Output (redacted) - # ----------------------- - - # rendered: - # - "interface Ethernet1/800" - # - "hsrp bfd" - # - "interface Ethernet1/801" - # - "hsrp bfd" - - # Using parsed - - # parsed.cfg - # ------------ - # interface Ethernet1/800 - # no switchport - # hsrp bfd - # interface Ethernet1/801 - # no switchport - # hsrp bfd - - - name: Use parsed state to convert externally supplied config to structured format - cisco.nxos.nxos_hsrp_interfaces: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - - # parsed: - # - name: Ethernet1/800 - # bfd: enable - # - name: Ethernet1/801 - # bfd: enable - - # Using gathered - - # Existing device config state - # ------------------------------- - - # interface Ethernet1/1 - # no switchport - # hsrp bfd - # interface Ethernet1/2 - # no switchport - # hsrp bfd - # interface Ethernet1/3 - # no switchport - - - name: Gather hsrp_interfaces facts from the device using nxos_hsrp_interfaces - cisco.nxos.nxos_hsrp_interfaces: - state: gathered - - # Task output (redacted) - # ----------------------- - - # gathered: - # - name: Ethernet1/1 - # bfd: enable - # - name: Ethernet1/2 - # bfd: enable - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/1', 'hsrp bfd']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_hsrp_module.rst b/docs/cisco.nxos.nxos_hsrp_module.rst deleted file mode 100644 index 0a55a4423..000000000 --- a/docs/cisco.nxos.nxos_hsrp_module.rst +++ /dev/null @@ -1,305 +0,0 @@ -.. _cisco.nxos.nxos_hsrp_module: - - -******************** -cisco.nxos.nxos_hsrp -******************** - -**Manages HSRP configuration on NX-OS switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages HSRP configuration on NX-OS switches. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- auth_string - -
- string -
- 		- -
Authentication string. If this needs to be hidden(for md5 type), the string should be 7 followed by the key string. Otherwise, it can be 0 followed by key string or just key string (for backward compatibility). For text type, this should be just be a key string. if this is 'default', authentication is removed.
-
-
- auth_type - -
- string -
- 		-
    Choices: -
  • text
    • -
  • md5
    • -
- 		-
Authentication type.
-
-
- group - -
- string - / required -
- 		- -
HSRP group number.
-
-
- interface - -
- string - / required -
- 		- -
Full name of interface that is being managed for HSRP.
-
-
- preempt - -
- string -
- 		-
    Choices: -
  • enabled
    • -
  • disabled
    • -
- 		-
Enable/Disable preempt.
-
-
- priority - -
- string -
- 		- -
HSRP priority or keyword 'default'.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Specify desired state of the resource.
-
-
- version - -
- string -
- 		-
    Choices: -
  • 1 ←
    • -
  • 2
    • -
- 		-
HSRP version.
-
-
- vip - -
- string -
- 		- -
HSRP virtual IP address or keyword 'default'
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - HSRP feature needs to be enabled first on the system. - - SVIs must exist before using this module. - - Interface must be a L3 port before using this module. - - HSRP cannot be configured on loopback interfaces. - - MD5 authentication is only possible with HSRPv2 while it is ignored if HSRPv1 is used instead, while it will not raise any error. Here we allow MD5 authentication only with HSRPv2 in order to enforce better practice. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Ensure HSRP is configured with following params on a SVI - cisco.nxos.nxos_hsrp: - group: 10 - vip: 10.1.1.1 - priority: 150 - interface: vlan10 - preempt: enabled - - - name: Ensure HSRP is configured with following params on a SVI with clear text authentication - cisco.nxos.nxos_hsrp: - group: 10 - vip: 10.1.1.1 - priority: 150 - interface: vlan10 - preempt: enabled - auth_type: text - auth_string: CISCO - - - name: Ensure HSRP is configured with md5 authentication and clear authentication - string - cisco.nxos.nxos_hsrp: - group: 10 - vip: 10.1.1.1 - priority: 150 - interface: vlan10 - preempt: enabled - auth_type: md5 - auth_string: 0 1234 - - - name: Ensure HSRP is configured with md5 authentication and hidden authentication - string - cisco.nxos.nxos_hsrp: - group: 10 - vip: 10.1.1.1 - priority: 150 - interface: vlan10 - preempt: enabled - auth_type: md5 - auth_string: 7 1234 - - - name: Remove HSRP config for given interface, group, and VIP - cisco.nxos.nxos_hsrp: - group: 10 - interface: vlan10 - vip: 10.1.1.1 - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['interface vlan10', 'hsrp version 2', 'hsrp 30', 'ip 10.30.1.1']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_igmp_module.rst b/docs/cisco.nxos.nxos_igmp_module.rst deleted file mode 100644 index dbb46206f..000000000 --- a/docs/cisco.nxos.nxos_igmp_module.rst +++ /dev/null @@ -1,191 +0,0 @@ -.. _cisco.nxos.nxos_igmp_module: - - -******************** -cisco.nxos.nxos_igmp -******************** - -**Manages IGMP global configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages IGMP global configuration configuration settings. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- enforce_rtr_alert - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables or disables the enforce router alert option check for IGMPv2 and IGMPv3 packets.
-
-
- flush_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Removes routes when the IGMP process is restarted. By default, routes are not flushed.
-
-
- restart - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Restarts the igmp process (using an exec config command).
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • default
    • -
- 		-
Manages desired state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - When ``state=default``, all supported params will be reset to a default state. - - If restart is set to true with other params set, the restart will happen last, i.e. after the configuration takes place. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Default igmp global params (all params except restart) - cisco.nxos.nxos_igmp: - state: default - - - name: Ensure the following igmp global config exists on the device - cisco.nxos.nxos_igmp: - flush_routes: true - enforce_rtr_alert: true - - - name: Restart the igmp process - cisco.nxos.nxos_igmp: - restart: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- updates - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['ip igmp flush-routes']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_igmp_snooping_module.rst b/docs/cisco.nxos.nxos_igmp_snooping_module.rst deleted file mode 100644 index 31af97509..000000000 --- a/docs/cisco.nxos.nxos_igmp_snooping_module.rst +++ /dev/null @@ -1,225 +0,0 @@ -.. _cisco.nxos.nxos_igmp_snooping_module: - - -***************************** -cisco.nxos.nxos_igmp_snooping -***************************** - -**Manages IGMP snooping global configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages IGMP snooping global configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- group_timeout - -
- string -
- 		- -
Group membership timeout value for all VLANs on the device. Accepted values are integer in range 1-10080, never and default.
-
-
- link_local_grp_supp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Global link-local groups suppression.
-
-
- report_supp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Global IGMPv1/IGMPv2 Report Suppression.
-
-
- snooping - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/disables IGMP snooping on the switch.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • default
    • -
- 		-
Manage the state of the resource.
-
-
- v3_report_supp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Global IGMPv3 Report Suppression and Proxy Reporting.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - When ``state=default``, params will be reset to a default state. - - ``group_timeout`` also accepts *never* as an input. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure igmp snooping params supported in this module are in there default state - - cisco.nxos.nxos_igmp_snooping: - state: default - - # ensure following igmp snooping params are in the desired state - - cisco.nxos.nxos_igmp_snooping: - group_timeout: never - snooping: true - link_local_grp_supp: false - optimize_mcast_flood: false - report_supp: true - v3_report_supp: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['ip igmp snooping link-local-groups-suppression', 'ip igmp snooping group-timeout 50', 'no ip igmp snooping report-suppression', 'no ip igmp snooping v3-report-suppression', 'no ip igmp snooping']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_install_os_module.rst b/docs/cisco.nxos.nxos_install_os_module.rst deleted file mode 100644 index ddd630d01..000000000 --- a/docs/cisco.nxos.nxos_install_os_module.rst +++ /dev/null @@ -1,183 +0,0 @@ -.. _cisco.nxos.nxos_install_os_module: - - -************************** -cisco.nxos.nxos_install_os -************************** - -**Set boot options like boot, kickstart image and issu.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Install an operating system by setting the boot options like boot image and kickstart image and optionally select to install using ISSU (In Server Software Upgrade). - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- issu - -
- string -
- 		-
    Choices: -
  • required
    • -
  • desired
    • -
  • yes
    • -
  • no ←
    • -
- 		-
Upgrade using In Service Software Upgrade (ISSU). (Supported on N5k, N7k, N9k platforms)
-
Selecting 'required' or 'yes' means that upgrades will only proceed if the switch is capable of ISSU.
-
Selecting 'desired' means that upgrades will use ISSU if possible but will fall back to disruptive upgrade if needed.
-
Selecting 'no' means do not use ISSU. Forced disruptive.
-
-
- kickstart_image_file - -
- string -
- 		- -
Name of the kickstart image file on flash. (Not required on all Nexus platforms)
-
-
- system_image_file - -
- string - / required -
- 		- -
Name of the system (or combined) image file on flash.
-
-
- - -Notes ------ - -.. note:: - - Tested against the following platforms and images - N9k 7.0(3)I4(6), 7.0(3)I5(3), 7.0(3)I6(1), 7.0(3)I7(1), 7.0(3)F2(2), 7.0(3)F3(2) - N3k 6.0(2)A8(6), 6.0(2)A8(8), 7.0(3)I6(1), 7.0(3)I7(1) - N7k 7.3(0)D1(1), 8.0(1), 8.1(1), 8.2(1) - - Tested against Cisco MDS NX-OS 9.2(1) - - This module requires both the ANSIBLE_PERSISTENT_CONNECT_TIMEOUT and ANSIBLE_PERSISTENT_COMMAND_TIMEOUT timers to be set to 600 seconds or higher. The module will exit if the timers are not set properly. - - When using connection local, ANSIBLE_PERSISTENT_CONNECT_TIMEOUT and ANSIBLE_PERSISTENT_COMMAND_TIMEOUT can only be set using ENV variables or the ansible.cfg file. - - Do not include full file paths, just the name of the file(s) stored on the top level flash directory. - - This module attempts to install the software immediately, which may trigger a reboot. - - In check mode, the module will indicate if an upgrade is needed and whether or not the upgrade is disruptive or non-disruptive(ISSU). - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Install OS on N9k - check_mode: false - cisco.nxos.nxos_install_os: - system_image_file: nxos.7.0.3.I6.1.bin - issu: desired - - - name: Wait for device to come back up with new image - wait_for: - port: 22 - state: started - timeout: 500 - delay: 60 - host: '{{ inventory_hostname }}' - - - name: Check installed OS for newly installed version - nxos_command: - commands: [show version | json] - register: output - - - assert: - that: - - output['stdout'][0]['kickstart_ver_str'] == '7.0(3)I6(1)' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- install_state - -
- dictionary -
- 		always -
Boot and install information.
-
-
Sample:
-
{'install_state': ['Compatibility check is done:', 'Module bootable Impact Install-type Reason', '------ -------- -------------- ------------ ------', ' 1 yes non-disruptive reset ', 'Images will be upgraded according to following table:', 'Module Image Running-Version(pri:alt) New-Version Upg-Required', '------ ---------- ---------------------------------------- -------------------- ------------', ' 1 nxos 7.0(3)I6(1) 7.0(3)I7(1) yes', ' 1 bios v4.4.0(07/12/2017) v4.4.0(07/12/2017) no']}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbibo (@GGabriele) diff --git a/docs/cisco.nxos.nxos_l2_interfaces_module.rst b/docs/cisco.nxos.nxos_l2_interfaces_module.rst deleted file mode 100644 index bfad0cf31..000000000 --- a/docs/cisco.nxos.nxos_l2_interfaces_module.rst +++ /dev/null @@ -1,648 +0,0 @@ -.. _cisco.nxos.nxos_l2_interfaces_module: - - -***************************** -cisco.nxos.nxos_l2_interfaces -***************************** - -**L2 interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages Layer-2 interfaces attributes of NX-OS Interfaces. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A dictionary of Layer-2 interface options
-
-
- access - -
- dictionary -
- 		- -
Switchport mode access command to configure the interface as a Layer-2 access.
-
-
- vlan - -
- integer -
- 		- -
Configure given VLAN in access port. It's used as the access VLAN ID.
-
-
- mode - -
- string -
- 		-
    Choices: -
  • dot1q-tunnel
    • -
  • access
    • -
  • trunk
    • -
  • fex-fabric
    • -
  • fabricpath
    • -
- 		-
Mode in which interface needs to be configured.
-
Access mode is not shown in interface facts, so idempotency will not be maintained for switchport mode access and every time the output will come as changed=True.
-
-
- name - -
- string - / required -
- 		- -
Full name of interface, i.e. Ethernet1/1.
-
-
- trunk - -
- dictionary -
- 		- -
Switchport mode trunk command to configure the interface as a Layer-2 trunk.
-
-
- allowed_vlans - -
- string -
- 		- -
List of allowed VLANs in a given trunk port. These are the only VLANs that will be configured on the trunk.
-
-
- native_vlan - -
- integer -
- 		- -
Native VLAN to be configured in trunk port. It is used as the trunk native VLAN ID.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section ^interface.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state of the configuration after module completion.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOS 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # interface Ethernet1/2 - # switchport trunk native vlan 20 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - - name: Merge provided configuration with device configuration - cisco.nxos.nxos_l2_interfaces: - config: - - name: Ethernet1/1 - trunk: - native_vlan: 10 - allowed_vlans: 2,4,15 - - name: Ethernet1/2 - access: - vlan: 30 - state: merged - - # Task Output - # ----------- - # - # before: - # - name: Loopback999 - # - name: Ethernet1/2 - # - name: mgmt0 - # - name: Ethernet1/1 - # commands: - # - interface Ethernet1/1 - # - switchport trunk allowed vlan 2,4,15 - # - switchport trunk native vlan 10 - # - interface Ethernet1/2 - # - switchport access vlan 30 - # after: - # - name: Ethernet1/1 - # trunk: - # allowed_vlans: 2,4,15 - # native_vlan: 10 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - # - name: Loopback999 - - # After state: - # ------------ - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # switchport trunk native vlan 10 - # switchport trunk allowed vlans 2,4,15 - # interface Ethernet1/2 - # switchport access vlan 30 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - # Using replaced - - # Before state: - # ------------- - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # switchport trunk native vlan 10 - # switchport trunk allowed vlans 2,4,15 - # interface Ethernet1/2 - # switchport access vlan 30 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - - name: Replace device configuration of specified L2 interfaces with provided configuration. - cisco.nxos.nxos_l2_interfaces: - config: - - name: Ethernet1/1 - trunk: - native_vlan: 20 - allowed_vlans: 5-10, 15 - state: replaced - - # Task Output - # ----------- - # - # before: - # - name: Ethernet1/1 - # trunk: - # allowed_vlans: 2,4,15 - # native_vlan: 10 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - # commands: - # - interface Ethernet1/1 - # - no switchport trunk native vlan - # - switchport trunk allowed vlan 5-10,15 - # - switchport trunk native vlan 20 - # after: - # - name: Ethernet1/1 - # trunk: - # allowed_vlans: 5-10,15 - # native_vlan: 20 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - - # After state: - # ------------ - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # switchport trunk native vlan 20 - # switchport trunk allowed vlan 5-10,15 - # interface Ethernet1/2 - # switchport trunk native vlan 20 - # switchport mode trunk - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - # Using overridden - - # Before state: - # ------------- - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # switchport trunk native vlan 20 - # switchport trunk allowed vlan 5-10,15 - # interface Ethernet1/2 - # switchport trunk native vlan 20 - # switchport mode trunk - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - - name: Override device configuration with provided configuration. - cisco.nxos.nxos_l2_interfaces: - config: - - name: Ethernet1/2 - access: - vlan: 30 - state: overridden - - # Task Output - # ----------- - # - # before: - # - name: Ethernet1/1 - # trunk: - # allowed_vlans: 5,6,7,8,9,10,15 - # native_vlan: 20 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - # commands: - # - interface Ethernet1/1 - # - no switchport trunk allowed vlan - # - no switchport trunk native vlan - # after: - # - name: Ethernet1/1 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - - # After state: - # ------------ - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # interface Ethernet1/2 - # switchport access vlan 30 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - - # Using deleted - - # Before state: - # ------------- - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # switchport trunk native vlan 10 - # switchport trunk allowed vlan 2,4,15 - # interface Ethernet1/2 - # switchport access vlan 30 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - - name: Delete L2 attributes of given interfaces (Note This won't delete the interface - itself). - cisco.nxos.nxos_l2_interfaces: - config: - - name: Ethernet1/1 - - name: Ethernet1/2 - state: deleted - - # Task Output - # ----------- - # - # before: - # - name: Ethernet1/1 - # trunk: - # allowed_vlans: 2,4,15 - # native_vlan: 10 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - # commands: - # - interface Ethernet1/1 - # - no switchport trunk allowed vlan - # - no switchport trunk native vlan - # - interface Ethernet1/2 - # - no switchport access vlan - # after: - # - name: Ethernet1/1 - # - name: Ethernet1/2 - # - name: mgmt0 - - # After state: - # ------------ - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # interface Ethernet1/2 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - # Using rendered - - - name: Render platform specific configuration lines (without connecting to the device) - cisco.nxos.nxos_l2_interfaces: - config: - - name: Ethernet1/1 - trunk: - native_vlan: 10 - allowed_vlans: 2,4,15 - - name: Ethernet1/2 - access: - vlan: 30 - - name: Ethernet1/3 - trunk: - native_vlan: 20 - allowed_vlans: 5-10, 15 - state: rendered - - # Task Output - # ----------- - # - # rendered: - # - interface Ethernet1/1 - # - switchport trunk allowed vlan 2,4,15 - # - switchport trunk native vlan 10 - # - interface Ethernet1/2 - # - switchport access vlan 30 - # - interface Ethernet1/3 - # - switchport trunk allowed vlan 5-10,15 - # - switchport trunk native vlan 20 - - # Using parsed - - # parsed.cfg - # ------------ - # - # interface Ethernet1/800 - # switchport access vlan 18 - # switchport trunk allowed vlan 210 - # interface Ethernet1/801 - # switchport trunk allowed vlan 2,4,15 - - - name: Use parsed state to convert externally supplied config to structured format - cisco.nxos.nxos_l2_interfaces: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output - # ----------- - # - # parsed: - # - name: Ethernet1/800 - # access: - # vlan: 18 - # trunk: - # allowed_vlans: "210" - # - name: Ethernet1/801 - # trunk: - # allowed_vlans: "2,4,15" - - # Using gathered - - # Before state: - # ------------- - # - # switch# sh running-config | section ^interface - # interface Ethernet1/1 - # switchport access vlan 6 - # switchport trunk allowed vlan 200 - # interface Ethernet1/2 - # switchport trunk native vlan 10 - - - name: Gather l2_interfaces facts from the device using nxos_l2_interfaces - cisco.nxos.nxos_l2_interfaces: - state: gathered - - # Task output - # ----------- - # - # gathered: - # - name: "Ethernet1/1" - # access: - # vlan: 6 - # trunk: - # allowed_vlans: "200" - # - name: "Ethernet1/2" - # trunk: - # native_vlan: 10 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/1', 'switchport trunk allowed vlan 2,4,15', 'switchport trunk native vlan 10', 'interface Ethernet1/2', 'switchport access vlan 30', 'interface Ethernet1/3', 'switchport trunk allowed vlan 5,6,7,8,9,10,15', 'switchport trunk native vlan 20']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_l3_interfaces_module.rst b/docs/cisco.nxos.nxos_l3_interfaces_module.rst deleted file mode 100644 index 28a56bdf8..000000000 --- a/docs/cisco.nxos.nxos_l3_interfaces_module.rst +++ /dev/null @@ -1,884 +0,0 @@ -.. _cisco.nxos.nxos_l3_interfaces_module: - - -***************************** -cisco.nxos.nxos_l3_interfaces -***************************** - -**L3 interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages Layer-3 interfaces attributes of NX-OS Interfaces. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A dictionary of Layer-3 interface options
-
-
- dot1q - -
- integer -
- 		- -
Configures IEEE 802.1Q VLAN encapsulation on a subinterface.
-
-
- evpn_multisite_tracking - -
- string -
-
added in 1.1.0
- 		-
    Choices: -
  • fabric-tracking
    • -
  • dci-tracking
    • -
- 		-
VxLAN evpn multisite Interface tracking. Supported only on selected model.
-
-
- ipv4 - -
- list - / elements=dictionary -
- 		- -
IPv4 address and attributes of the L3 interface.
-
-
- address - -
- string -
- 		- -
IPV4 address of the L3 interface.
-
-
- secondary - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
A boolean attribute to manage addition of secondary IP address.
-
-
- tag - -
- integer -
- 		- -
URIB route tag value for local/direct routes.
-
-
- ipv6 - -
- list - / elements=dictionary -
- 		- -
IPv6 address and attributes of the L3 interface.
-
-
- address - -
- string -
- 		- -
IPV6 address of the L3 interface.
-
-
- tag - -
- integer -
- 		- -
URIB route tag value for local/direct routes.
-
-
- ipv6_redirects - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/disables ipv6 redirects.
-
-
- name - -
- string - / required -
- 		- -
Full name of L3 interface, i.e. Ethernet1/1.
-
-
- redirects - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/disables ipv4 redirects.
-
-
- unreachables - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/disables ip redirects.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state of the configuration after module completion.
-
The state overridden would override the IP address configuration of all interfaces on the device with the provided configuration in the task. Use caution with this state as you may loose access to the device.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOS 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no shutdown - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - - name: Merge provided configuration with device configuration. - cisco.nxos.nxos_l3_interfaces: - config: - - name: Ethernet1/6 - ipv4: - - address: 192.168.1.1/24 - tag: 5 - - address: 10.1.1.1/24 - secondary: true - tag: 10 - ipv6: - - address: fd5d:12c9:2201:2::1/64 - tag: 6 - - name: Ethernet1/7.42 - redirects: false - unreachables: false - state: merged - - # Task Output - # ----------- - # - # before: - # - name: Ethernet1/6 - # - name: Ethernet1/7 - # - ipv4: - # - address: dhcp - # name: mgmt0 - # commands: - # - interface Ethernet1/6 - # - ip address 192.168.1.1/24 tag 5 - # - ip address 10.1.1.1/24 secondary tag 10 - # - ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - # - interface Ethernet1/7 - # - no ip redirects - # after: - # - ipv4: - # - address: 192.168.1.1/24 - # tag: 5 - # - address: 10.1.1.1/24 - # secondary: true - # tag: 10 - # ipv6: - # - address: fd5d:12c9:2201:2::1/64 - # tag: 6 - # name: Ethernet1/6 - # redirects: false - # - name: Ethernet1/7 - # redirects: false - # - ipv4: - # - address: dhcp - # name: mgmt0 - - # After state: - # ------------ - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no ip redirects - # ip address 192.168.1.1/24 tag 5 - # ip address 10.1.1.1/24 secondary tag 10 - # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no ip redirects - # no shutdown - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - - # Using replaced - - # Before state: - # ------------- - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no ip redirects - # ip address 192.168.1.1/24 tag 5 - # ip address 10.1.1.1/24 secondary tag 10 - # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no ip redirects - # no shutdown - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - - name: Replace device configuration of specified L3 interfaces with provided configuration. - cisco.nxos.nxos_l3_interfaces: - config: - - name: Ethernet1/6 - ipv4: - - address: 192.168.22.3/24 - state: replaced - - # Task Output - # ----------- - # - # before: - # - ipv4: - # - address: 192.168.1.1/24 - # tag: 5 - # - address: 10.1.1.1/24 - # secondary: true - # tag: 10 - # ipv6: - # - address: fd5d:12c9:2201:2::1/64 - # tag: 6 - # name: Ethernet1/6 - # redirects: false - # - name: Ethernet1/7 - # redirects: false - # - ipv4: - # - address: dhcp - # name: mgmt0 - # commands: - # - interface Ethernet1/6 - # - ip address 192.168.22.3/24 - # - no ipv6 address fd5d:12c9:2201:2::1/64 - # - ip redirects - # after: - # - ipv4: - # - address: 192.168.22.3/24 - # - address: 10.1.1.1/24 - # secondary: true - # tag: 10 - # name: Ethernet1/6 - # redirects: false - # - name: Ethernet1/7 - # redirects: false - # - ipv4: - # - address: dhcp - # name: mgmt0 - - # After state: - # ------------ - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no ip redirects - # ip address 192.168.22.3/24 - # ip address 10.1.1.1/24 secondary tag 10 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no ip redirects - # no shutdown - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - # Using overridden - - # Before state: - # ------------- - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no ip redirects - # ip address 192.168.1.1/24 tag 5 - # ip address 10.1.1.1/24 secondary tag 10 - # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no ip redirects - # no shutdown - # interface Ethernet1/7.42 - # no ip redirects - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - - name: Override device configuration with provided configuration. - cisco.nxos.nxos_l3_interfaces: - config: - - ipv4: - - address: dhcp - name: mgmt0 - - name: Ethernet1/6 - ipv4: - - address: 192.168.22.3/24 - state: overridden - - # Task Output - # ----------- - # - # before: - # - ipv4: - # - address: 192.168.1.1/24 - # tag: 5 - # - address: 10.1.1.1/24 - # secondary: true - # tag: 10 - # ipv6: - # - address: fd5d:12c9:2201:2::1/64 - # tag: 6 - # name: Ethernet1/6 - # redirects: false - # - name: Ethernet1/7 - # redirects: false - # - name: Ethernet1/7.42 - # redirects: false - # - ipv4: - # - address: dhcp - # name: mgmt0 - # commands: - # - interface Ethernet1/6 - # - no ipv6 address fd5d:12c9:2201:2::1/64 - # - no ip address 10.1.1.1/24 secondary - # - ip address 192.168.22.3/24 - # - ip redirects - # - interface Ethernet1/7 - # - ip redirects - # - interface Ethernet1/7.42 - # - ip redirects - # after: - # - ipv4: - # - address: 192.168.22.3/24 - # name: Ethernet1/6 - # - name: Ethernet1/7 - # - name: Ethernet1/7.42 - # - ipv4: - # - address: dhcp - # name: mgmt0 - - # After state: - # ------------ - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # ip address 192.168.22.3/24 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no shutdown - # interface Ethernet1/7.42 - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - # Using deleted - - # Before state: - # ------------- - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # ip address 192.168.22.3/24 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no shutdown - # interface Ethernet1/7.42 - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - - name: Delete L3 attributes of given interfaces (This won't delete the interface - itself). - cisco.nxos.nxos_l3_interfaces: - config: - - name: Ethernet1/6 - - name: Ethernet1/2 - state: deleted - - # Task Output - # ----------- - # - # before: - # - name: Ethernet1/2 - # - ipv4: - # - address: 192.168.22.3/24 - # name: Ethernet1/6 - # - name: Ethernet1/7 - # - name: Ethernet1/7.42 - # - ipv4: - # - address: dhcp - # name: mgmt0 - # commands: - # - interface Ethernet1/6 - # - no ip address - # after: - # - name: Ethernet1/2 - # - name: Ethernet1/7 - # - name: Ethernet1/7.42 - # - ipv4: - # - address: dhcp - # name: mgmt0 - - # After state: - # ------------ - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no shutdown - # interface Ethernet1/7.42 - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - # Using rendered - - - name: Use rendered state to convert task input to device specific commands - cisco.nxos.nxos_l3_interfaces: - config: - - name: Ethernet1/800 - ipv4: - - address: 192.168.1.100/24 - tag: 5 - - address: 10.1.1.1/24 - secondary: true - tag: 10 - - name: Ethernet1/800 - ipv6: - - address: fd5d:12c9:2201:2::1/64 - tag: 6 - state: rendered - - # Task Output - # ----------- - # - # rendered: - # - interface Ethernet1/800 - # - ip address 192.168.1.100/24 tag 5 - # - ip address 10.1.1.1/24 secondary tag 10 - # - interface Ethernet1/800 - # - ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - - # Using parsed - - # parsed.cfg - # ---------- - # - # interface Ethernet1/800 - # ip address 192.168.1.100/24 tag 5 - # ip address 10.1.1.1/24 secondary tag 10 - # no ip redirects - # interface Ethernet1/801 - # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - # ip unreachables - # interface mgmt0 - # ip address dhcp - # vrf member management - - - name: Use parsed state to convert externally supplied config to structured format - cisco.nxos.nxos_l3_interfaces: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output - # ----------- - # - # parsed: - # - name: Ethernet1/800 - # ipv4: - # - address: 192.168.1.100/24 - # tag: 5 - # - address: 10.1.1.1/24 - # secondary: True - # tag: 10 - # redirects: False - # - name: Ethernet1/801 - # ipv6: - # - address: fd5d:12c9:2201:2::1/64 - # tag: 6 - # unreachables: True - - # Using gathered - - # Before state: - # ------------- - # - # interface Ethernet1/1 - # ip address 192.0.2.100/24 - # interface Ethernet1/2 - # no ip redirects - # ip address 203.0.113.10/24 - # ip unreachables - # ipv6 address 2001:db8::1/32 - - - name: Gather l3_interfaces facts from the device using nxos_l3_interfaces - cisco.nxos.nxos_l3_interfaces: - state: gathered - - # Task output - # ----------- - # - # gathered: - # - name: Ethernet1/1 - # ipv4: - # - address: 192.0.2.100/24 - # - name: Ethernet1/2 - # ipv4: - # - address: 203.0.113.10/24 - # ipv6: - # - address: 2001:db8::1/32 - # redirects: False - # unreachables: True - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/2', 'ip address 192.168.0.1/2']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_lacp_module.rst b/docs/cisco.nxos.nxos_lacp_module.rst deleted file mode 100644 index b0410c783..000000000 --- a/docs/cisco.nxos.nxos_lacp_module.rst +++ /dev/null @@ -1,402 +0,0 @@ -.. _cisco.nxos.nxos_lacp_module: - - -******************** -cisco.nxos.nxos_lacp -******************** - -**LACP resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages Global Link Aggregation Control Protocol (LACP) on NX-OS devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
LACP global options.
-
-
- system - -
- dictionary -
- 		- -
LACP system options
-
-
- mac - -
- dictionary -
- 		- -
MAC address to be used for the LACP Protocol exchanges
-
-
- address - -
- string -
- 		- -
MAC-address (FORMAT :xxxx.xxxx.xxxx).
-
-
- role - -
- string -
- 		-
    Choices: -
  • primary
    • -
  • secondary
    • -
- 		-
The role for the Switch.
-
-
- priority - -
- integer -
- 		- -
The system priority to use in LACP negotiations.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | include lacp.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state of the configuration after module completion.
-
States replaced and overridden have the same behaviour for this module.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOS 7.3.(0)D1(1) on VIRL. - - Unsupported for Cisco MDS - - Feature lacp should be enabled for this module. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # - - - name: Merge provided configuration with device configuration. - cisco.nxos.nxos_lacp: - config: - system: - priority: 10 - mac: - address: 00c1.4c00.bd15 - state: merged - - # After state: - # ------------ - # - # lacp system-priority 10 - # lacp system-mac 00c1.4c00.bd15 - - - # Using replaced - - # Before state: - # ------------- - # - # lacp system-priority 10 - - - name: Replace device global lacp configuration with the given configuration. - cisco.nxos.nxos_lacp: - config: - system: - mac: - address: 00c1.4c00.bd15 - state: replaced - - # After state: - # ------------ - # - # lacp system-mac 00c1.4c00.bd15 - - - # Using deleted - - # Before state: - # ------------- - # - # lacp system-priority 10 - - - name: Delete global LACP configurations. - cisco.nxos.nxos_lacp: - state: deleted - - # After state: - # ------------ - # - - # Using rendered - - - name: Render platform specific configuration lines (without connecting to the device) - cisco.nxos.nxos_lacp: - config: - system: - priority: 10 - mac: - address: 00c1.4c00.bd15 - role: secondary - state: rendered - - # Task Output (redacted) - # ----------------------- - - # rendered: - # - "lacp system-priority 10" - # - "lacp system-mac 00c1.4c00.bd15 role secondary" - - # Using parsed - - # parsed.cfg - # ------------ - # lacp system-priority 10 - # lacp system-mac 00c1.4c00.bd15 role secondary - - - name: Use parsed state to convert externally supplied config to structured format - cisco.nxos.nxos_lacp: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # system: - # priority: 10 - # mac: - # address: 00c1.4c00.bd15 - # role: secondary - - # Using gathered - - # Existing device config state - # ------------------------------- - # Nexus9000v# show running-config | include lacp - # lacp system-priority 11 - # lacp system-mac 00c1.4c00.bd15 role primary - - - name: Gather lacp facts from the device using nxos_lacp - cisco.nxos.nxos_lacp: - state: gathered - - # Task output (redacted) - # ----------------------- - # gathered: - # system: - # priority: 11 - # mac: - # address: 00c1.4c00.bd15 - # role: primary - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['lacp system-priority 15', 'lacp system-mac 00c1.4c00.bd15 role primary']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_lldp_interfaces_module.rst b/docs/cisco.nxos.nxos_lldp_interfaces_module.rst deleted file mode 100644 index d634e9aa4..000000000 --- a/docs/cisco.nxos.nxos_lldp_interfaces_module.rst +++ /dev/null @@ -1,407 +0,0 @@ -.. _cisco.nxos.nxos_lldp_interfaces_module: - - -******************************* -cisco.nxos.nxos_lldp_interfaces -******************************* - -**LLDP interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages interfaces' configuration for Link Layer Discovery Protocol (LLDP) on NX-OS platforms. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of link layer discovery configurations for interfaces.
-
-
- name - -
- string - / required -
- 		- -
Name of the interface
-
-
- receive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Used to enable or disable the reception of LLDP packets on that interface. By default, this is enabled after LLDP is enabled globally.
-
-
- tlv_set - -
- dictionary -
- 		- -
Used to configure TLV parameters on the interface
-
-
- management_address - -
- string -
- 		- -
Used to mention the IPv4 or IPv6 management address for the interface
-
-
- vlan - -
- integer -
- 		- -
Used to mention the VLAN for the interface
-
-
- transmit - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Used to enable or disable the transmission of LLDP packets on that interface. By default, this is enabled after LLDP is enabled globally.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section ^interface.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOS 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - The LLDP feature needs to be enabled before using this module - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # - - - name: Merge provided configuration with device configuration - cisco.nxos.nxos_lldp_interfaces: - config: - - name: Ethernet1/4 - receive: false - transmit: true - tlv_set: - management_address: 192.168.122.64 - vlan: 12 - state: merged - - # After state: - # ------------- - # - # interface Ethernet1/4 - # no lldp receive - # lldp tlv-set management-address 192.168.122.64 - # lldp tlv-set vlan 12 - - - # Using replaced - - # Before state: - # ------------ - # - # interface Ethernet1/4 - # no lldp receive - # lldp tlv-set management-address 192.168.122.64 - # interface Ethernet1/5 - # no lldp transmit - # lldp tlv-set vlan 10 - - - name: Replace LLDP configuration on interfaces with given configuration - cisco.nxos.nxos_lldp_interfaces: - config: - - name: Ethernet1/4 - transmit: false - tlv_set: - vlan: 2 - state: replaced - - - # After state: - # ----------- - # - # interface Ethernet1/4 - # no lldp transmit - # lldp tlv_set vlan 2 - # interface Ethernet1/5 - # no lldp transmit - # lldp tlv-set vlan 10 - - - # Using overridden - - # Before state: - # ------------ - # - # interface Ethernet1/4 - # no lldp receive - # lldp tlv-set management-address 192.168.122.64 - # interface Ethernet1/5 - # no lldp transmit - # lldp tlv-set vlan 10 - - - name: Override LLDP configuration on all interfaces with given configuration - cisco.nxos.nxos_lldp_interfaces: - config: - - name: Ethernet1/7 - receive: false - tlv_set: - vlan: 12 - state: overridden - - - # After state: - # ----------- - # - # interface Ethernet1/7 - # no lldp receive - # lldp tlv_set vlan 12 - - - # Using deleted - - # Before state: - # ------------ - # - # interface Ethernet1/4 - # lldp tlv-set management vlan 24 - # no lldp transmit - # interface mgmt0 - # no lldp receive - - - name: Delete LLDP interfaces configuration - cisco.nxos.nxos_lldp_interfaces: - state: deleted - - # After state: - # ------------ - # - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/2', 'lldp receive', 'lldp tlv-set vlan 12']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_logging_module.rst b/docs/cisco.nxos.nxos_logging_module.rst deleted file mode 100644 index 9dafd8e33..000000000 --- a/docs/cisco.nxos.nxos_logging_module.rst +++ /dev/null @@ -1,458 +0,0 @@ -.. _cisco.nxos.nxos_logging_module: - - -*********************** -cisco.nxos.nxos_logging -*********************** - -**Manage logging on network devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2023-08-01 -:Why: Updated module released with more functionality. -:Alternative: nxos_logging_global - - - -Synopsis --------- -- This module provides declarative management of logging on Cisco NX-OS devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
List of logging definitions.
-
-
- dest - -
- string -
- 		-
    Choices: -
  • console
    • -
  • logfile
    • -
  • module
    • -
  • monitor
    • -
  • server
    • -
- 		-
Destination of the logs.
-
-
- dest_level - -
- integer -
- 		- -
Set logging severity levels.
-

aliases: level
-
-
- event - -
- string -
- 		-
    Choices: -
  • link-enable
    • -
  • link-default
    • -
  • trunk-enable
    • -
  • trunk-default
    • -
- 		-
Link/trunk enable/default interface configuration logging
-
-
- facility - -
- string -
- 		- -
Facility name for logging.
-
-
- facility_level - -
- integer -
- 		- -
Set logging severity levels for facility based log messages.
-
-
- facility_link_status - -
- string -
- 		-
    Choices: -
  • link-down-notif
    • -
  • link-down-error
    • -
  • link-up-notif
    • -
  • link-up-error
    • -
- 		-
Set logging facility ethpm link status. Not idempotent with version 6.0 images.
-
-
- file_size - -
- integer -
- 		- -
Set logfile size
-
-
- interface - -
- string -
- 		- -
Interface to be used while configuring source-interface for logging (e.g., 'Ethernet1/2', 'mgmt0')
-
-
- interface_message - -
- string -
- 		-
    Choices: -
  • add-interface-description
    • -
- 		-
Add interface description to interface syslogs. Does not work with version 6.0 images using nxapi as a transport.
-
-
- name - -
- string -
- 		- -
If value of dest is logfile it indicates file-name.
-
-
- purge - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Remove any switch logging configuration that does not match what has been configured Not supported for ansible_connection local. All nxos_logging tasks must use the same ansible_connection type.
-
-
- remote_server - -
- string -
- 		- -
Hostname or IP Address for remote logging (when dest is 'server').
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
State of the logging configuration.
-
-
- timestamp - -
- string -
- 		-
    Choices: -
  • microseconds
    • -
  • milliseconds
    • -
  • seconds
    • -
- 		-
Set logging timestamp format
-
-
- use_vrf - -
- string -
- 		- -
VRF to be used while configuring remote logging (when dest is 'server').
-
-
- - -Notes ------ - -.. note:: - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: configure console logging with level - cisco.nxos.nxos_logging: - dest: console - level: 2 - state: present - - name: remove console logging configuration - cisco.nxos.nxos_logging: - dest: console - level: 2 - state: absent - - name: configure file logging with level - cisco.nxos.nxos_logging: - dest: logfile - name: testfile - dest_level: 3 - state: present - - name: Configure logging logfile with size - cisco.nxos.nxos_logging: - dest: logfile - name: testfile - dest_level: 3 - file_size: 16384 - - name: configure facility level logging - cisco.nxos.nxos_logging: - facility: daemon - facility_level: 0 - state: present - - name: remove facility level logging - cisco.nxos.nxos_logging: - facility: daemon - facility_level: 0 - state: absent - - name: Configure Remote Logging - cisco.nxos.nxos_logging: - dest: server - remote_server: test-syslogserver.com - facility: auth - facility_level: 1 - use_vrf: management - state: present - - name: Configure Source Interface for Logging - cisco.nxos.nxos_logging: - interface: mgmt0 - state: present - - name: Purge nxos_logging configuration not managed by this playbook - cisco.nxos.nxos_logging: - purge: true - - name: Configure logging timestamp - cisco.nxos.nxos_logging: - timestamp: milliseconds - state: present - - name: Configure logging facility ethpm link status - cisco.nxos.nxos_logging: - facility: ethpm - facility_link_status: link-up-notif - state: present - - name: Configure logging message ethernet description - cisco.nxos.nxos_logging: - interface_message: add-interface-description - state: present - - name: Configure logging event link enable - cisco.nxos.nxos_logging: - event: link-enable - state: present - - name: Configure logging using aggregate - cisco.nxos.nxos_logging: - aggregate: - - {dest: console, dest_level: 2} - - {dest: logfile, dest_level: 2, name: testfile} - - {facility: daemon, facility_level: 0} - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['logging console 2', 'logging logfile testfile 3', 'logging level daemon 0']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2023-08-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_ntp_auth_module.rst b/docs/cisco.nxos.nxos_ntp_auth_module.rst deleted file mode 100644 index c825cd017..000000000 --- a/docs/cisco.nxos.nxos_ntp_auth_module.rst +++ /dev/null @@ -1,224 +0,0 @@ -.. _cisco.nxos.nxos_ntp_auth_module: - - -************************ -cisco.nxos.nxos_ntp_auth -************************ - -**Manages NTP authentication.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated module released with more functionality. -:Alternative: nxos_ntp_global - - - -Synopsis --------- -- Manages NTP authentication. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- auth_type - -
- string -
- 		-
    Choices: -
  • text ←
    • -
  • encrypt
    • -
- 		-
Whether the given md5string is in cleartext or has been encrypted. If in cleartext, the device will encrypt it before storing it.
-
-
- authentication - -
- string -
- 		-
    Choices: -
  • on
    • -
  • off
    • -
- 		-
Turns NTP authentication on or off.
-
-
- key_id - -
- string -
- 		- -
Authentication key identifier (numeric).
-
-
- md5string - -
- string -
- 		- -
MD5 String.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- trusted_key - -
- string -
- 		-
    Choices: -
  • false ←
    • -
  • true
    • -
- 		-
Whether the given key is required to be supplied by a time source for the device to synchronize to the time source.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - If ``state=absent``, the module will remove the given key configuration if it exists. - - If ``state=absent`` and ``authentication=on``, authentication will be turned off. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Basic NTP authentication configuration - - cisco.nxos.nxos_ntp_auth: - key_id: 32 - md5string: hello - auth_type: text - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['ntp authentication-key 32 md5 helloWorld 0', 'ntp trusted-key 32']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_ntp_global_module.rst b/docs/cisco.nxos.nxos_ntp_global_module.rst deleted file mode 100644 index b77fc9440..000000000 --- a/docs/cisco.nxos.nxos_ntp_global_module.rst +++ /dev/null @@ -1,1411 +0,0 @@ -.. _cisco.nxos.nxos_ntp_global_module: - - -************************** -cisco.nxos.nxos_ntp_global -************************** - -**NTP Global resource module.** - - -Version added: 2.6.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages ntp configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A dict of ntp configuration.
-
-
- access_group - -
- dictionary -
- 		- -
NTP access-group.
-
This option is unsupported on MDS switches.
-
-
- match_all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Scan ACLs present in all ntp access groups.
-
-
- peer - -
- list - / elements=dictionary -
- 		- -
Access-group peer.
-
-
- access_list - -
- string -
- 		- -
Name of access list.
-
-
- query_only - -
- list - / elements=dictionary -
- 		- -
Access-group query-only.
-
-
- access_list - -
- string -
- 		- -
Name of access list.
-
-
- serve - -
- list - / elements=dictionary -
- 		- -
Access-group serve.
-
-
- access_list - -
- string -
- 		- -
Name of access list.
-
-
- serve_only - -
- list - / elements=dictionary -
- 		- -
Access-group serve-only.
-
-
- access_list - -
- string -
- 		- -
Name of access list.
-
-
- allow - -
- dictionary -
- 		- -
Enable/Disable the packets.
-
-
- control - -
- dictionary -
- 		- -
Control mode packets.
-
-
- rate_limit - -
- integer -
- 		- -
Rate-limit delay.
-
-
- private - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable Private mode packets.
-
-
- authenticate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable authentication.
-
-
- authentication_keys - -
- list - / elements=dictionary -
- 		- -
NTP authentication key.
-
-
- encryption - -
- integer -
- 		- -
0 for Clear text
-
7 for Encrypted
-
-
- id - -
- integer -
- 		- -
Authentication key number (range 1-65535).
-
-
- key - -
- string -
- 		- -
Authentication key.
-
-
- logging - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable logging of NTPD Events.
-
-
- master - -
- dictionary -
- 		- -
Act as NTP master clock.
-
This option is unsupported on MDS switches.
-
-
- stratum - -
- integer -
- 		- -
Stratum number.
-
-
- passive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
NTP passive command.
-
This option is unsupported on MDS switches.
-
-
- peers - -
- list - / elements=dictionary -
- 		- -
NTP Peers.
-
-
- key_id - -
- integer -
- 		- -
Keyid to be used while communicating to this server.
-
-
- maxpoll - -
- integer -
- 		- -
Maximum interval to poll a peer.
-
Poll interval in secs to a power of 2.
-
-
- minpoll - -
- integer -
- 		- -
Minimum interval to poll a peer.
-
Poll interval in secs to a power of 2.
-
-
- peer - -
- string -
- 		- -
Hostname/IP address of the NTP Peer.
-
-
- prefer - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Preferred Server.
-
-
- vrf - -
- string -
- 		- -
Display per-VRF information.
-
This option is unsupported on MDS switches.
-

aliases: use_vrf
-
-
- servers - -
- list - / elements=dictionary -
- 		- -
NTP servers.
-
-
- key_id - -
- integer -
- 		- -
Keyid to be used while communicating to this server.
-
-
- maxpoll - -
- integer -
- 		- -
Maximum interval to poll a peer.
-
Poll interval in secs to a power of 2.
-
-
- minpoll - -
- integer -
- 		- -
Minimum interval to poll a peer.
-
Poll interval in secs to a power of 2.
-
-
- prefer - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Preferred Server.
-
-
- server - -
- string -
- 		- -
Hostname/IP address of the NTP Peer.
-
-
- vrf - -
- string -
- 		- -
Display per-VRF information.
-
This option is not applicable for MDS switches.
-

aliases: use_vrf
-
-
- source - -
- string -
- 		- -
Source of NTP packets.
-
This option is unsupported on MDS switches.
-
-
- source_interface - -
- string -
- 		- -
Source interface sending NTP packets.
-
-
- trusted_keys - -
- list - / elements=dictionary -
- 		- -
NTP trusted-key number.
-
-
- key_id - -
- integer -
- 		- -
Trusted-Key number.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config ntp.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
The states replaced and overridden have identical behaviour for this module.
-
Please refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6 on Cisco Nexus Switches. - - This module works with connection ``network_cli`` and ``httpapi``. - - Tested against Cisco MDS NX-OS 9.2(2) with connection ``network_cli``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k-rdo# show running-config ntp - # nxos-9k-rdo# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_ntp_global: &id001 - config: - access_group: - peer: - - access_list: PeerAcl1 - serve: - - access_list: ServeAcl1 - authenticate: true - authentication_keys: - - id: 1001 - key: vagwwtKfkv - encryption: 7 - - id: 1002 - key: vagwwtKfkvgthz - encryption: 7 - logging: true - master: - stratum: 2 - peers: - - peer: 192.0.2.1 - key_id: 1 - maxpoll: 15 - minpoll: 5 - vrf: default - - peer: 192.0.2.2 - key_id: 2 - prefer: true - vrf: siteA - servers: - - server: 198.51.100.1 - key_id: 2 - vrf: default - - server: 203.0.113.1 - key_id: 1 - vrf: siteB - - # Task output - # ------------- - # before: {} - # - # commands: - # - "ntp authenticate" - # - "ntp logging" - # - "ntp master 2" - # - "ntp authentication-keys 1001 md5 vagwwtKfkv 7" - # - "ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" - # - "ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" - # - "ntp peer 192.0.2.2 prefer use-vrf siteA key 2" - # - "ntp server 198.51.100.1 use-vrf default key 2" - # - "ntp server 203.0.113.1 use-vrf siteB key 1" - # - "ntp access-group peer PeerAcl1" - # - "ntp access-group serve ServeAcl1" - # - # after: - # access_group: - # peer: - # - access_list: PeerAcl1 - # serve: - # - access_list: ServeAcl1 - # authenticate: true - # authentication_keys: - # - id: 1001 - # key: vagwwtKfkv - # encryption: 7 - # - id: 1002 - # key: vagwwtKfkvgthz - # encryption: 7 - # logging: true - # master: - # stratum: 2 - # peers: - # - peer: 192.0.2.1 - # key_id: 1 - # maxpoll: 15 - # minpoll: 5 - # vrf: default - # - peer: 192.0.2.2 - # key_id: 2 - # prefer: true - # vrf: siteA - # servers: - # - server: 198.51.100.1 - # key_id: 2 - # vrf: default - # - server: 203.0.113.1 - # key_id: 1 - # vrf: siteB - - # After state: - # ------------ - # nxos-9k-rdo# show running-config ntp - # ntp authenticate - # ntp logging - # ntp master 2 - # ntp authentication-keys 1001 md5 vagwwtKfkv 7 - # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 - # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 - # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 - # ntp server 198.51.100.1 use-vrf default key 2 - # ntp server 203.0.113.1 use-vrf siteB key 1 - # ntp access-group peer PeerAcl1 - # ntp access-group serve ServeAcl1 - - # Using replaced - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config ntp - # ntp authenticate - # ntp logging - # ntp master 2 - # ntp authentication-keys 1001 md5 vagwwtKfkv 7 - # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 - # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 - # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 - # ntp server 198.51.100.1 use-vrf default key 2 - # ntp server 203.0.113.1 use-vrf siteB key 1 - # ntp access-group peer PeerAcl1 - # ntp access-group serve ServeAcl1 - - - name: Replace logging global configurations of listed logging global with provided configurations - cisco.nxos.nxos_ntp_global: - config: - access_group: - peer: - - access_list: PeerAcl2 - serve: - - access_list: ServeAcl2 - logging: true - master: - stratum: 2 - peers: - - peer: 192.0.2.1 - key_id: 1 - maxpoll: 15 - minpoll: 5 - vrf: default - - peer: 192.0.2.5 - key_id: 2 - prefer: true - vrf: siteA - servers: - - server: 198.51.100.1 - key_id: 2 - vrf: default - state: replaced - - # Task output - # ------------- - # before: - # access_group: - # peer: - # - access_list: PeerAcl1 - # serve: - # - access_list: ServeAcl1 - # authenticate: true - # authentication_keys: - # - id: 1001 - # key: vagwwtKfkv - # encryption: 7 - # - id: 1002 - # key: vagwwtKfkvgthz - # encryption: 7 - # logging: true - # master: - # stratum: 2 - # peers: - # - peer: 192.0.2.1 - # key_id: 1 - # maxpoll: 15 - # minpoll: 5 - # vrf: default - # - peer: 192.0.2.2 - # key_id: 2 - # prefer: true - # vrf: siteA - # servers: - # - server: 198.51.100.1 - # key_id: 2 - # vrf: default - # - server: 203.0.113.1 - # key_id: 1 - # vrf: siteB - # - # commands: - # - "no ntp authenticate" - # - "no ntp authentication-keys 1001 md5 vagwwtKfkv 7" - # - "no ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" - # - "ntp peer 192.0.2.5 prefer use-vrf siteA key 2" - # - "no ntp peer 192.0.2.2 prefer use-vrf siteA key 2" - # - "no ntp server 203.0.113.1 use-vrf siteB key 1" - # - "ntp access-group peer PeerAcl2" - # - "no ntp access-group peer PeerAcl1" - # - "ntp access-group serve ServeAcl2" - # - "no ntp access-group serve ServeAcl1" - # - # after: - # access_group: - # peer: - # - access_list: PeerAcl2 - # serve: - # - access_list: ServeAcl2 - # logging: true - # master: - # stratum: 2 - # peers: - # - peer: 192.0.2.1 - # key_id: 1 - # maxpoll: 15 - # minpoll: 5 - # vrf: default - # - peer: 192.0.2.5 - # key_id: 2 - # prefer: true - # vrf: siteA - # servers: - # - server: 198.51.100.1 - # key_id: 2 - # vrf: default - - # After state: - # ------------ - # nxos-9k-rdo# show running-config ntp - # ntp logging - # ntp master 2 - # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 - # ntp peer 192.0.2.5 prefer use-vrf siteA key 2 - # ntp server 198.51.100.1 use-vrf default key 2 - # ntp access-group peer PeerAcl2 - # ntp access-group serve ServeAcl2 - - # Using deleted to delete all logging configurations - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config ntp - - - name: Delete all logging configuration - cisco.nxos.nxos_ntp_global: - state: deleted - - # Task output - # ------------- - # before: - # access_group: - # peer: - # - access_list: PeerAcl1 - # serve: - # - access_list: ServeAcl1 - # authenticate: true - # authentication_keys: - # - id: 1001 - # key: vagwwtKfkv - # encryption: 7 - # - id: 1002 - # key: vagwwtKfkvgthz - # encryption: 7 - # logging: true - # master: - # stratum: 2 - # peers: - # - peer: 192.0.2.1 - # key_id: 1 - # maxpoll: 15 - # minpoll: 5 - # vrf: default - # - peer: 192.0.2.2 - # key_id: 2 - # prefer: true - # vrf: siteA - # servers: - # - server: 198.51.100.1 - # key_id: 2 - # vrf: default - # - server: 203.0.113.1 - # key_id: 1 - # vrf: siteB - # - # commands: - # - "no ntp authenticate" - # - "no ntp logging" - # - "no ntp master 2" - # - "no ntp authentication-keys 1001 md5 vagwwtKfkv 7" - # - "no ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" - # - "no ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" - # - "no ntp peer 192.0.2.2 prefer use-vrf siteA key 2" - # - "no ntp server 198.51.100.1 use-vrf default key 2" - # - "no ntp server 203.0.113.1 use-vrf siteB key 1" - # - "no ntp access-group peer PeerAcl1" - # - "no ntp access-group serve ServeAcl1" - # - # after: {} - - # After state: - # ------------ - # nxos-9k-rdo# show running-config ntp - # nxos-9k-rdo# - - # Using rendered - - - name: Render platform specific configuration lines with state rendered (without connecting to the device) - cisco.nxos.nxos_ntp_global: - config: - access_group: - peer: - - access_list: PeerAcl1 - serve: - - access_list: ServeAcl1 - authenticate: true - authentication_keys: - - id: 1001 - key: vagwwtKfkv - encryption: 7 - - id: 1002 - key: vagwwtKfkvgthz - encryption: 7 - logging: true - master: - stratum: 2 - peers: - - peer: 192.0.2.1 - key_id: 1 - maxpoll: 15 - minpoll: 5 - vrf: default - - peer: 192.0.2.2 - key_id: 2 - prefer: true - vrf: siteA - servers: - - server: 198.51.100.1 - key_id: 2 - vrf: default - - server: 203.0.113.1 - key_id: 1 - vrf: siteB - state: rendered - - # Task Output (redacted) - # ----------------------- - # rendered: - # - "ntp authenticate" - # - "ntp logging" - # - "ntp master 2" - # - "ntp authentication-keys 1001 md5 vagwwtKfkv 7" - # - "ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" - # - "ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" - # - "ntp peer 192.0.2.2 prefer use-vrf siteA key 2" - # - "ntp server 198.51.100.1 use-vrf default key 2" - # - "ntp server 203.0.113.1 use-vrf siteB key 1" - # - "ntp access-group peer PeerAcl1" - # - "ntp access-group serve ServeAcl1" - - # Using parsed - - # parsed.cfg - # ------------ - # ntp authenticate - # ntp logging - # ntp master 2 - # ntp authentication-keys 1001 md5 vagwwtKfkv 7 - # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 - # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 - # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 - # ntp server 198.51.100.1 use-vrf default key 2 - # ntp server 203.0.113.1 use-vrf siteB key 1 - # ntp access-group peer PeerAcl1 - # ntp access-group serve ServeAcl1 - - - name: Parse externally provided ntp configuration - cisco.nxos.nxos_ntp_global: - running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # access_group: - # peer: - # - access_list: PeerAcl1 - # serve: - # - access_list: ServeAcl1 - # authenticate: true - # authentication_keys: - # - id: 1001 - # key: vagwwtKfkv - # encryption: 7 - # - id: 1002 - # key: vagwwtKfkvgthz - # encryption: 7 - # logging: true - # master: - # stratum: 2 - # peers: - # - peer: 192.0.2.1 - # key_id: 1 - # maxpoll: 15 - # minpoll: 5 - # vrf: default - # - peer: 192.0.2.2 - # key_id: 2 - # prefer: true - # vrf: siteA - # servers: - # - server: 198.51.100.1 - # key_id: 2 - # vrf: default - # - server: 203.0.113.1 - # key_id: 1 - # vrf: siteB - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['ntp master stratum 2', 'ntp peer 198.51.100.1 use-vrf test maxpoll 7', 'ntp authentication-key 10 md5 wawyhanx2 7', 'ntp access-group peer PeerAcl1', 'ntp access-group peer PeerAcl2', 'ntp access-group query-only QueryAcl1']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['ntp master stratum 2', 'ntp peer 198.51.100.1 use-vrf test maxpoll 7', 'ntp authentication-key 10 md5 wawyhanx2 7', 'ntp access-group peer PeerAcl1', 'ntp access-group peer PeerAcl2', 'ntp access-group query-only QueryAcl1']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_ntp_module.rst b/docs/cisco.nxos.nxos_ntp_module.rst deleted file mode 100644 index 3fa835a96..000000000 --- a/docs/cisco.nxos.nxos_ntp_module.rst +++ /dev/null @@ -1,314 +0,0 @@ -.. _cisco.nxos.nxos_ntp_module: - - -******************* -cisco.nxos.nxos_ntp -******************* - -**Manages core NTP configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated module released with more functionality. -:Alternative: nxos_ntp_global - - - -Synopsis --------- -- Manages core NTP configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- key_id - -
- string -
- 		- -
Authentication key identifier to use with given NTP server or peer or keyword 'default'.
-
-
- peer - -
- string -
- 		- -
Network address of NTP peer.
-
-
- prefer - -
- string -
- 		-
    Choices: -
  • enabled
    • -
  • disabled
    • -
- 		-
Makes given NTP server or peer the preferred NTP server or peer for the device.
-
-
- server - -
- string -
- 		- -
Network address of NTP server.
-
-
- source_addr - -
- string -
- 		- -
Local source address from which NTP messages are sent or keyword 'default'.
-
-
- source_int - -
- string -
- 		- -
Local source interface from which NTP messages are sent. Must be fully qualified interface name or keyword 'default'
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- vrf_name - -
- string -
- 		- -
Makes the device communicate with the given NTP server or peer over a specific VRF or keyword 'default'.
-
-
- - -Notes ------ - -.. note:: - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Set NTP Server with parameters - - cisco.nxos.nxos_ntp: - server: 1.2.3.4 - key_id: 32 - prefer: enabled - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- end_state - -
- dictionary -
- 		always -
k/v pairs of ntp info after module execution
-
-
Sample:
-
{'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'server', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'source'}
-
-
- existing - -
- dictionary -
- 		always -
k/v pairs of existing ntp server/peer
-
-
Sample:
-
{'address': '192.0.2.2', 'key_id': '32', 'peer_type': 'server', 'prefer': 'enabled', 'source': 'ethernet2/1', 'source_type': 'source-interface'}
-
-
- proposed - -
- dictionary -
- 		always -
k/v pairs of parameters passed into module
-
-
Sample:
-
{'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'server', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'source'}
-
-
- updates - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['ntp server 192.0.2.2 prefer key 48', 'no ntp source-interface ethernet2/1', 'ntp source 192.0.2.3']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_ntp_options_module.rst b/docs/cisco.nxos.nxos_ntp_options_module.rst deleted file mode 100644 index e99825641..000000000 --- a/docs/cisco.nxos.nxos_ntp_options_module.rst +++ /dev/null @@ -1,192 +0,0 @@ -.. _cisco.nxos.nxos_ntp_options_module: - - -*************************** -cisco.nxos.nxos_ntp_options -*************************** - -**Manages NTP options.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated module released with more functionality. -:Alternative: nxos_ntp_global - - - -Synopsis --------- -- Manages NTP options, e.g. authoritative server and logging. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- logging - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Sets whether NTP logging is enabled on the device.
-
-
- master - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Sets whether the device is an authoritative NTP server.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- stratum - -
- string -
- 		- -
If master=true, an optional stratum can be supplied (1-15). The device default is 8.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - When ``state=absent``, master and logging will be set to False and stratum will be removed as well - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Basic NTP options configuration - - cisco.nxos.nxos_ntp_options: - master: true - stratum: 12 - logging: false - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- updates - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['no ntp logging', 'ntp master 12']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_nxapi_module.rst b/docs/cisco.nxos.nxos_nxapi_module.rst deleted file mode 100644 index 182fe1516..000000000 --- a/docs/cisco.nxos.nxos_nxapi_module.rst +++ /dev/null @@ -1,300 +0,0 @@ -.. _cisco.nxos.nxos_nxapi_module: - - -********************* -cisco.nxos.nxos_nxapi -********************* - -**Manage NXAPI configuration on an NXOS device.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configures the NXAPI feature on devices running Cisco NXOS. The NXAPI feature is absent from the configuration by default. Since this module manages the NXAPI feature it only supports the use of the ``Cli`` transport. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- http - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Controls the operating state of the HTTP protocol as one of the underlying transports for NXAPI. By default, NXAPI will enable the HTTP transport when the feature is first configured. To disable the use of the HTTP transport, set the value of this argument to False.
-

aliases: enable_http
-
-
- http_port - -
- integer -
- 		- Default:
80
- 		-
Configure the port with which the HTTP server will listen on for requests. By default, NXAPI will bind the HTTP service to the standard HTTP port 80. This argument accepts valid port values in the range of 1 to 65535.
-
-
- https - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Controls the operating state of the HTTPS protocol as one of the underlying transports for NXAPI. By default, NXAPI will disable the HTTPS transport when the feature is first configured. To enable the use of the HTTPS transport, set the value of this argument to True.
-

aliases: enable_https
-
-
- https_port - -
- integer -
- 		- Default:
443
- 		-
Configure the port with which the HTTPS server will listen on for requests. By default, NXAPI will bind the HTTPS service to the standard HTTPS port 443. This argument accepts valid port values in the range of 1 to 65535.
-
-
- sandbox - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
The NXAPI feature provides a web base UI for developers for entering commands. This feature is initially disabled when the NXAPI feature is configured for the first time. When the sandbox argument is set to True, the developer sandbox URL will accept requests and when the value is set to False, the sandbox URL is unavailable. This is supported on NX-OS 7K series.
-

aliases: enable_sandbox
-
-
- ssl_strong_ciphers - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Controls the use of whether strong or weak ciphers are configured. By default, this feature is disabled and weak ciphers are configured. To enable the use of strong ciphers, set the value of this argument to True.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
The state argument controls whether or not the NXAPI feature is configured on the remote device. When the value is present the NXAPI feature configuration is present in the device running-config. When the values is absent the feature configuration is removed from the running-config.
-
-
- tlsv1_0 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Controls the use of the Transport Layer Security version 1.0 is configured. By default, this feature is enabled. To disable the use of TLSV1.0, set the value of this argument to True.
-
-
- tlsv1_1 - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Controls the use of the Transport Layer Security version 1.1 is configured. By default, this feature is disabled. To enable the use of TLSV1.1, set the value of this argument to True.
-
-
- tlsv1_2 - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Controls the use of the Transport Layer Security version 1.2 is configured. By default, this feature is disabled. To enable the use of TLSV1.2, set the value of this argument to True.
-
-
- - -Notes ------ - -.. note:: - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Enable NXAPI access with default configuration - cisco.nxos.nxos_nxapi: - state: present - - - name: Enable NXAPI with no HTTP, HTTPS at port 9443 and sandbox disabled - cisco.nxos.nxos_nxapi: - enable_http: false - https_port: 9443 - https: true - enable_sandbox: false - - - name: remove NXAPI configuration - cisco.nxos.nxos_nxapi: - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- updates - -
- list -
- 		always -
Returns the list of commands that need to be pushed into the remote device to satisfy the arguments
-
-
Sample:
-
['no feature nxapi']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_ospf_interfaces_module.rst b/docs/cisco.nxos.nxos_ospf_interfaces_module.rst deleted file mode 100644 index ff69b6e71..000000000 --- a/docs/cisco.nxos.nxos_ospf_interfaces_module.rst +++ /dev/null @@ -1,1732 +0,0 @@ -.. _cisco.nxos.nxos_ospf_interfaces_module: - - -******************************* -cisco.nxos.nxos_ospf_interfaces -******************************* - -**OSPF Interfaces Resource Module.** - - -Version added: 1.3.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages OSPF(v2/v3) configuration of interfaces on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of OSPF configuration for interfaces.
-
-
- address_family - -
- list - / elements=dictionary -
- 		- -
OSPF settings on the interfaces in address-family context.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
Address Family Identifier (AFI) for OSPF settings on the interfaces.
-
-
- authentication - -
- dictionary -
- 		- -
Authentication settings on the interface.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/disable authentication on the interface.
-
-
- key_chain - -
- string -
- 		- -
Authentication password key-chain.
-
-
- message_digest - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use message-digest authentication.
-
-
- null_auth - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use null(disable) authentication.
-
-
- authentication_key - -
- dictionary -
- 		- -
Configure the authentication key for the interface.
-
-
- encryption - -
- integer -
- 		- -
0 Specifies an UNENCRYPTED authentication key will follow.
-
3 Specifies an 3DES ENCRYPTED authentication key will follow.
-
7 Specifies a Cisco type 7 ENCRYPTED authentication key will follow.
-
-
- key - -
- string - / required -
- 		- -
Authentication key.
-
Valid values are Cisco type 7 ENCRYPTED password, 3DES ENCRYPTED password and UNENCRYPTED (cleartext) password based on the value of encryption key.
-
-
- cost - -
- integer -
- 		- -
Cost associated with interface.
-
-
- dead_interval - -
- integer -
- 		- -
Dead interval value (in seconds).
-
-
- default_passive_interface - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set passive-interface attribute on this interface to default.
-
This option is mutually exclusive with passive_interface.
-
-
- hello_interval - -
- integer -
- 		- -
Hello interval value (in seconds).
-
-
- instance - -
- integer -
- 		- -
Instance identifier.
-
-
- message_digest_key - -
- dictionary -
- 		- -
Message digest authentication password (key) settings.
-
-
- encryption - -
- integer -
- 		- -
0 Specifies an UNENCRYPTED ospf password (key) will follow.
-
3 Specifies an 3DES ENCRYPTED ospf password (key) will follow.
-
7 Specifies a Cisco type 7 ENCRYPTED the ospf password (key) will follow.
-
-
- key - -
- string - / required -
- 		- -
Authentication key.
-
Valid values are Cisco type 7 ENCRYPTED password, 3DES ENCRYPTED password and UNENCRYPTED (cleartext) password based on the value of encryption key.
-
-
- key_id - -
- integer - / required -
- 		- -
Key ID.
-
-
- mtu_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/disable OSPF MTU mismatch detection.
-
-
- multi_areas - -
- list - / elements=string -
- 		- -
Multi-Areas associated with interface (not tied to OSPF process).
-
Valid values are Area Ids as an integer or IP address.
-
-
- network - -
- string -
- 		-
    Choices: -
  • broadcast
    • -
  • point-to-point
    • -
- 		-
Network type.
-
-
- passive_interface - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress routing updates on the interface.
-
This option is mutually exclusive with default_passive_interface.
-
-
- priority - -
- integer -
- 		- -
Router priority.
-
-
- processes - -
- list - / elements=dictionary -
- 		- -
Interfaces configuration for an OSPF process.
-
-
- area - -
- dictionary -
- 		- -
Area associated with interface.
-
-
- area_id - -
- string - / required -
- 		- -
Area ID in IP address format.
-
-
- secondaries - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not include secondary IPv4/IPv6 addresses.
-
-
- multi_areas - -
- list - / elements=string -
- 		- -
Multi-Areas associated with interface.
-
Valid values are Area Ids as an integer or IP address.
-
-
- process_id - -
- string - / required -
- 		- -
OSPF process tag.
-
-
- retransmit_interval - -
- integer -
- 		- -
Packet retransmission interval.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Shutdown OSPF on this interface.
-
-
- transmit_delay - -
- integer -
- 		- -
Packet transmission delay.
-
-
- name - -
- string - / required -
- 		- -
Name/Identifier of the interface.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section "^interface".
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • parsed
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
-
- - -Notes ------ - -.. note:: - - Unsupported for Cisco MDS - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # interface Ethernet1/2 - # no switchport - # interface Ethernet1/3 - # no switchport - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_ospf_interfaces: - config: - - name: Ethernet1/1 - address_family: - - afi: ipv4 - processes: - - process_id: '100' - area: - area_id: 1.1.1.1 - secondaries: false - multi_areas: - - 11.11.11.11 - - afi: ipv6 - processes: - - process_id: '200' - area: - area_id: 2.2.2.2 - multi_areas: - - 21.0.0.0 - - process_id: '300' - multi_areas: - - 50.50.50.50 - multi_areas: - - 16.10.10.10 - - name: Ethernet1/2 - address_family: - - afi: ipv4 - authentication: - enable: true - key_chain: test-1 - message_digest_key: - key_id: 10 - encryption: 3 - key: abc01d272be25d29 - cost: 100 - - afi: ipv6 - network: broadcast - shutdown: true - - name: Ethernet1/3 - address_family: - - afi: ipv4 - authentication_key: - encryption: 7 - key: 12090404011C03162E - state: merged - - # Task output: - # ------------ - # before: - # - name: Ethernet1/1 - # - name: Ethernet1/2 - # - name: Ethernet1/3 - # - # commands: - # - interface Ethernet1/1 - # - ip router ospf multi-area 11.11.11.11 - # - ip router ospf 100 area 1.1.1.1 secondaries none - # - ipv6 router ospfv3 multi-area 16.10.10.10 - # - ipv6 router ospfv3 200 area 2.2.2.2 - # - ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - interface Ethernet1/2 - # - ip ospf authentication key-chain test-1 - # - ip ospf authentication - # - ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # - ip ospf cost 100 - # - ospfv3 network broadcast - # - ospfv3 shutdown - # - interface Ethernet1/3 - # - ip ospf authentication-key 7 12090404011C03162E - # - # after: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.11 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # - afi: ipv6 - # multi_areas: - # - 16.10.10.10 - # processes: - # - area: - # area_id: 2.2.2.2 - # multi_areas: - # - 21.0.0.0 - # process_id: '200' - # - multi_areas: - # - 50.50.50.50 - # process_id: '300' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - - # After state: - # ------------ - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - - # Using replaced - - # Before state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - - name: Replace OSPF configurations of listed interfaces with provided configurations - cisco.nxos.nxos_ospf_interfaces: - config: - - name: Ethernet1/1 - address_family: - - afi: ipv4 - processes: - - process_id: "100" - area: - area_id: 1.1.1.1 - secondaries: false - multi_areas: - - 11.11.11.12 - - name: Ethernet1/3 - state: replaced - - # Task output: - # ------------ - # before: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.11 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # - afi: ipv6 - # multi_areas: - # - 16.10.10.10 - # processes: - # - area: - # area_id: 2.2.2.2 - # multi_areas: - # - 21.0.0.0 - # process_id: '200' - # - multi_areas: - # - 50.50.50.50 - # process_id: '300' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - # - # commands: - # - interface Ethernet1/1 - # - ip router ospf multi-area 11.11.11.12 - # - no ip router ospf multi-area 11.11.11.11 - # - no ipv6 router ospfv3 multi-area 16.10.10.10 - # - no ipv6 router ospfv3 200 area 2.2.2.2 - # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - interface Ethernet1/3 - # - no ip ospf authentication-key 7 12090404011C03162E - # - # after: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.12 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - name: Ethernet1/3 - # - # After state: - # ------------ - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.12 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - - - # Using overridden - - # Before state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - - name: Override all OSPF interfaces configuration with provided configuration - cisco.nxos.nxos_ospf_interfaces: - config: - - name: Ethernet1/1 - address_family: - - afi: ipv4 - processes: - - process_id: "100" - area: - area_id: 1.1.1.1 - secondaries: false - multi_areas: - - 11.11.11.12 - state: overridden - - # Task output: - # ------------ - # before: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.11 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # - afi: ipv6 - # multi_areas: - # - 16.10.10.10 - # processes: - # - area: - # area_id: 2.2.2.2 - # multi_areas: - # - 21.0.0.0 - # process_id: '200' - # - multi_areas: - # - 50.50.50.50 - # process_id: '300' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - # - # commands: - # - interface Ethernet1/2 - # - no ip ospf authentication key-chain test-1 - # - no ip ospf authentication - # - no ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # - no ip ospf cost 100 - # - no ospfv3 network broadcast - # - no ospfv3 shutdown - # - interface Ethernet1/3 - # - no ip ospf authentication-key 7 12090404011C03162E - # - interface Ethernet1/1 - # - ip router ospf multi-area 11.11.11.12 - # - no ip router ospf multi-area 11.11.11.11 - # - no ipv6 router ospfv3 multi-area 16.10.10.10 - # - no ipv6 router ospfv3 200 area 2.2.2.2 - # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - # after: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.12 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # name: Ethernet1/1 - # - name: Ethernet1/2 - # - name: Ethernet1/3 - - # After state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.12 - # interface Ethernet1/2 - # no switchport - # interface Ethernet1/3 - # no switchport - - # Using deleted to delete OSPF config of a single interface - - # Before state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - - name: Delete OSPF config from a single interface - cisco.nxos.nxos_ospf_interfaces: - config: - - name: Ethernet1/1 - state: deleted - - # Task output: - # ------------ - # before: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.11 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # - afi: ipv6 - # multi_areas: - # - 16.10.10.10 - # processes: - # - area: - # area_id: 2.2.2.2 - # multi_areas: - # - 21.0.0.0 - # process_id: '200' - # - multi_areas: - # - 50.50.50.50 - # process_id: '300' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - # - # commands: - # - interface Ethernet1/1 - # - no ip router ospf multi-area 11.11.11.11 - # - no ip router ospf 100 area 1.1.1.1 secondaries none - # - no ipv6 router ospfv3 multi-area 16.10.10.10 - # - no ipv6 router ospfv3 200 area 2.2.2.2 - # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - # after: - # - name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - - - # After state: - # ------------ - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - # Using deleted to delete OSPF config from all interfaces - - # Before state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - - name: Delete OSPF config from all interfaces - cisco.nxos.nxos_ospf_interfaces: - state: deleted - - # Task output: - # ------------ - # before: - # - name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - # - # commands: - # - interface Ethernet1/1 - # - no ip router ospf multi-area 11.11.11.11 - # - no ip router ospf 100 area 1.1.1.1 secondaries none - # - no ipv6 router ospfv3 multi-area 16.10.10.10 - # - no ipv6 router ospfv3 200 area 2.2.2.2 - # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - interface Ethernet1/2 - # - no ip ospf authentication key-chain test-1 - # - no ip ospf authentication - # - no ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # - no ip ospf cost 100 - # - no ospfv3 network broadcast - # - no ospfv3 shutdown - # - interface Ethernet1/3 - # - no ip ospf authentication-key 7 12090404011C03162E - # - # after: - # - name: Ethernet1/1 - # - name: Ethernet1/2 - # - name: Ethernet1/3 - - # After state: - # ------------ - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # interface Ethernet1/2 - # no switchport - # interface Ethernet1/3 - # no switchport - - # Using rendered - - - name: >- - Render platform specific configuration lines with state rendered (without - connecting to the device) - cisco.nxos.nxos_ospf_interfaces: - config: - - name: Ethernet1/1 - address_family: - - afi: ipv4 - processes: - - process_id: '100' - area: - area_id: 1.1.1.1 - secondaries: false - multi_areas: - - 11.11.11.11 - - afi: ipv6 - processes: - - process_id: '200' - area: - area_id: 2.2.2.2 - multi_areas: - - 21.0.0.0 - - process_id: '300' - multi_areas: - - 50.50.50.50 - multi_areas: - - 16.10.10.10 - - name: Ethernet1/2 - address_family: - - afi: ipv4 - authentication: - enable: true - key_chain: test-1 - message_digest_key: - key_id: 10 - encryption: 3 - key: abc01d272be25d29 - cost: 100 - - afi: ipv6 - network: broadcast - shutdown: true - - name: Ethernet1/3 - address_family: - - afi: ipv4 - authentication_key: - encryption: 7 - key: 12090404011C03162E - state: rendered - - - # Task Output: - # ------------ - # rendered: - # - interface Ethernet1/1 - # - ip router ospf multi-area 11.11.11.11 - # - ip router ospf 100 area 1.1.1.1 secondaries none - # - ipv6 router ospfv3 multi-area 16.10.10.10 - # - ipv6 router ospfv3 200 area 2.2.2.2 - # - ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - interface Ethernet1/2 - # - ip ospf authentication key-chain test-1 - # - ip ospf authentication - # - ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # - ip ospf cost 100 - # - ospfv3 network broadcast - # - ospfv3 shutdown - # - interface Ethernet1/3 - # - ip ospf authentication-key 7 12090404011C03162E - - # Using parsed - - # parsed.cfg - # ------------ - # interface Ethernet1/1 - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # interface Ethernet1/2 - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # ip ospf authentication-key 7 12090404011C03162E - - - name: arse externally provided OSPF interfaces config - cisco.nxos.nxos_ospf_interfaces: - running_config: "{{ lookup('file', 'ospf_interfaces.cfg') }}" - state: parsed - - # Task output: - # ------------ - # parsed: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.11 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # - afi: ipv6 - # multi_areas: - # - 16.10.10.10 - # processes: - # - area: - # area_id: 2.2.2.2 - # multi_areas: - # - 21.0.0.0 - # process_id: '200' - # - multi_areas: - # - 50.50.50.50 - # process_id: '300' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - - # Using gathered - - # On-box config - - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.12 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - - # Task output: - # ------------ - # gathered: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.12 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - name: Ethernet1/3 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/1', 'ip router ospf multi-area 11.11.11.11', 'ip router ospf 100 area 1.1.1.1 secondaries none', 'no ipv6 router ospfv3 multi-area 16.10.10.10', 'ipv6 router ospfv3 200 area 2.2.2.2', 'ipv6 router ospfv3 200 multi-area 21.0.0.0', 'ipv6 router ospfv3 300 multi-area 50.50.50.50', 'interface Ethernet1/2', 'no ip ospf authentication key-chain test-1', 'ip ospf authentication']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['interface Ethernet1/1', 'ip router ospf multi-area 11.11.11.11', 'ip router ospf 100 area 1.1.1.1 secondaries none']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_ospfv2_module.rst b/docs/cisco.nxos.nxos_ospfv2_module.rst deleted file mode 100644 index 2115d34f2..000000000 --- a/docs/cisco.nxos.nxos_ospfv2_module.rst +++ /dev/null @@ -1,5458 +0,0 @@ -.. _cisco.nxos.nxos_ospfv2_module: - - -********************** -cisco.nxos.nxos_ospfv2 -********************** - -**OSPFv2 resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages OSPFv2 configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A list of OSPF process configuration.
-
-
- processes - -
- list - / elements=dictionary -
- 		- -
A list of OSPF instances' configurations.
-
-
- areas - -
- list - / elements=dictionary -
- 		- -
Configure properties of OSPF Areas.
-
-
- area_id - -
- string - / required -
- 		- -
The Area ID in IP Address format.
-
-
- authentication - -
- dictionary -
- 		- -
Authentication settings for the Area.
-
-
- message_digest - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use message-digest authentication.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set authentication for the area.
-
-
- default_cost - -
- integer -
- 		- -
Specify the default cost for default summary LSA.
-
-
- filter_list - -
- list - / elements=dictionary -
- 		- -
Filter prefixes between OSPF areas.
-
-
- direction - -
- string - / required -
- 		-
    Choices: -
  • in
    • -
  • out
    • -
- 		-
The direction to apply the route map.
-
-
- route_map - -
- string - / required -
- 		- -
The Route-map name.
-
-
- nssa - -
- dictionary -
- 		- -
NSSA settings for the area.
-
-
- default_information_originate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Originate Type-7 default LSA into NSSA area.
-
-
- no_redistribution - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send redistributed LSAs into NSSA area.
-
-
- no_summary - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send summary LSAs into NSSA area.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure area as NSSA.
-
-
- translate - -
- dictionary -
- 		- -
Translate LSA.
-
-
- type7 - -
- dictionary -
- 		- -
Translate from Type 7 to Type 5.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always translate LSAs
-
-
- never - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Never translate LSAs
-
-
- supress_fa - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress forwarding address in translated LSAs.
-
-
- ranges - -
- list - / elements=dictionary -
- 		- -
Configure an address range for the area.
-
-
- cost - -
- integer -
- 		- -
Cost to use for the range.
-
-
- not_advertise - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress advertising the specified range.
-
-
- prefix - -
- string - / required -
- 		- -
IP in Prefix format (x.x.x.x/len)
-
-
- stub - -
- dictionary -
- 		- -
Settings for configuring the area as a stub.
-
-
- no_summary - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Prevent ABR from sending summary LSAs into stub area.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure the area as a stub.
-
-
- auto_cost - -
- dictionary -
- 		- -
Calculate OSPF cost according to bandwidth.
-
-
- reference_bandwidth - -
- integer - / required -
- 		- -
Reference bandwidth used to assign OSPF cost.
-
-
- unit - -
- string - / required -
- 		-
    Choices: -
  • Gbps
    • -
  • Mbps
    • -
- 		-
Specify in which unit the reference bandwidth is specified.
-
-
- bfd - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable BFD on all OSPF interfaces.
-
-
- default_information - -
- dictionary -
- 		- -
Control distribution of default routes.
-
-
- originate - -
- dictionary -
- 		- -
Distribute a default route.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always advertise a default route.
-
-
- route_map - -
- string -
- 		- -
Policy to control distribution of default routes
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable distribution of default route.
-
-
- default_metric - -
- integer -
- 		- -
Specify default metric for redistributed routes.
-
-
- distance - -
- integer -
- 		- -
Configure the OSPF administrative distance.
-
-
- flush_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flush routes on a non-graceful controlled restart.
-
-
- graceful_restart - -
- dictionary -
- 		- -
Configure graceful restart.
-
-
- grace_period - -
- integer -
- 		- -
Configure maximum interval to restart gracefully.
-
-
- helper_disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable helper mode.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable graceful-restart.
-
-
- isolate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Isolate this router from OSPF perspective.
-
-
- log_adjacency_changes - -
- dictionary -
- 		- -
Log changes in adjacency state.
-
-
- detail - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Notify all state changes.
-
-
- log - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/disable logging changes in adjacency state.
-
-
- max_lsa - -
- dictionary -
- 		- -
Feature to limit the number of non-self-originated LSAs.
-
-
- ignore_count - -
- integer -
- 		- -
Set count on how many times adjacencies can be suppressed.
-
-
- ignore_time - -
- integer -
- 		- -
Set time during which all adjacencies are suppressed.
-
-
- max_non_self_generated_lsa - -
- integer - / required -
- 		- -
Set the maximum number of non self-generated LSAs.
-
-
- reset_time - -
- integer -
- 		- -
Set number of minutes after which ignore-count is reset to zero.
-
-
- threshold - -
- integer -
- 		- -
Threshold value (%) at which to generate a warning message.
-
-
- warning_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Log a warning message when limit is exceeded.
-
-
- max_metric - -
- dictionary -
- 		- -
Maximize the cost metric.
-
-
- router_lsa - -
- dictionary -
- 		- -
Router LSA configuration.
-
-
- external_lsa - -
- dictionary -
- 		- -
External LSA configuration.
-
-
- max_metric_value - -
- integer -
- 		- -
Set max metric value for external LSAs.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set external-lsa attribute.
-
-
- include_stub - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise Max metric for Stub links as well.
-
-
- on_startup - -
- dictionary -
- 		- -
Effective only at startup.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set on-startup attribute.
-
-
- wait_for_bgp_asn - -
- integer -
- 		- -
ASN of BGP to wait for.
-
-
- wait_period - -
- integer -
- 		- -
Wait period in seconds after startup.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set router-lsa attribute.
-
-
- summary_lsa - -
- dictionary -
- 		- -
Summary LSAs configuration.
-
-
- max_metric_value - -
- integer -
- 		- -
Max metric value for summary LSAs.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set summary-lsa attribute.
-
-
- maximum_paths - -
- integer -
- 		- -
Maximum paths per destination.
-
-
- mpls - -
- dictionary -
- 		- -
OSPF MPLS configuration settings.
-
-
- traffic_eng - -
- dictionary -
- 		- -
OSPF MPLS Traffic Engineering commands.
-
-
- areas - -
- list - / elements=dictionary -
- 		- -
List of Area IDs.
-
-
- area_id - -
- string -
- 		- -
Area Id in ip address format.
-
-
- multicast_intact - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
MPLS TE multicast support.
-
-
- router_id - -
- string -
- 		- -
Router ID associated with TE.
-
-
- name_lookup - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Display OSPF router ids as DNS names.
-
-
- passive_interface - -
- dictionary -
- 		- -
Suppress routing updates on the interface.
-
-
- default - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Interfaces passive by default.
-
-
- process_id - -
- string - / required -
- 		- -
The OSPF process tag.
-
-
- redistribute - -
- list - / elements=dictionary -
- 		- -
Redistribute information from another routing protocol.
-
-
- id - -
- string -
- 		- -
The identifier for the protocol specified.
-
-
- protocol - -
- string - / required -
- 		-
    Choices: -
  • bgp
    • -
  • direct
    • -
  • eigrp
    • -
  • isis
    • -
  • lisp
    • -
  • ospf
    • -
  • rip
    • -
  • static
    • -
- 		-
The name of the protocol.
-
-
- route_map - -
- string - / required -
- 		- -
The route map policy to constrain redistribution.
-
-
- rfc1583compatibility - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure 1583 compatibility for external path preferences.
-
-
- router_id - -
- string -
- 		- -
Set OSPF process router-id.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Shutdown the OSPF protocol instance.
-
-
- summary_address - -
- list - / elements=dictionary -
- 		- -
Configure route summarization for redistribution.
-
-
- not_advertise - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress advertising the specified summary.
-
-
- prefix - -
- string - / required -
- 		- -
IP prefix in format x.x.x.x/ml.
-
-
- tag - -
- integer -
- 		- -
A 32-bit tag value.
-
-
- table_map - -
- dictionary -
- 		- -
Policy for filtering/modifying OSPF routes before sending them to RIB.
-
-
- filter - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Block the OSPF routes from being sent to RIB.
-
-
- name - -
- string - / required -
- 		- -
The Route Map name.
-
-
- timers - -
- dictionary -
- 		- -
Configure timer related constants.
-
-
- lsa_arrival - -
- integer -
- 		- -
Mimimum interval between arrival of a LSA.
-
-
- lsa_group_pacing - -
- integer -
- 		- -
LSA group refresh/maxage interval.
-
-
- throttle - -
- dictionary -
- 		- -
Configure throttle related constants.
-
-
- lsa - -
- dictionary -
- 		- -
Set rate-limiting for LSA generation.
-
-
- hold_interval - -
- integer -
- 		- -
The hold interval.
-
-
- max_interval - -
- integer -
- 		- -
The max interval.
-
-
- start_interval - -
- integer -
- 		- -
The start interval.
-
-
- spf - -
- dictionary -
- 		- -
Set OSPF SPF timers.
-
-
- initial_spf_delay - -
- integer -
- 		- -
Initial SPF schedule delay in milliseconds.
-
-
- max_wait_time - -
- integer -
- 		- -
Maximum wait time between SPF calculations.
-
-
- min_hold_time - -
- integer -
- 		- -
Minimum hold time between SPF calculations.
-
-
- vrfs - -
- list - / elements=dictionary -
- 		- -
Configure VRF specific OSPF settings.
-
-
- areas - -
- list - / elements=dictionary -
- 		- -
Configure properties of OSPF Areas.
-
-
- area_id - -
- string - / required -
- 		- -
The Area ID in IP Address format.
-
-
- authentication - -
- dictionary -
- 		- -
Authentication settings for the Area.
-
-
- message_digest - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use message-digest authentication.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set authentication for the area.
-
-
- default_cost - -
- integer -
- 		- -
Specify the default cost for default summary LSA.
-
-
- filter_list - -
- list - / elements=dictionary -
- 		- -
Filter prefixes between OSPF areas.
-
-
- direction - -
- string - / required -
- 		-
    Choices: -
  • in
    • -
  • out
    • -
- 		-
The direction to apply the route map.
-
-
- route_map - -
- string - / required -
- 		- -
The Route-map name.
-
-
- nssa - -
- dictionary -
- 		- -
NSSA settings for the area.
-
-
- default_information_originate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Originate Type-7 default LSA into NSSA area.
-
-
- no_redistribution - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send redistributed LSAs into NSSA area.
-
-
- no_summary - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send summary LSAs into NSSA area.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure area as NSSA.
-
-
- translate - -
- dictionary -
- 		- -
Translate LSA.
-
-
- type7 - -
- dictionary -
- 		- -
Translate from Type 7 to Type 5.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always translate LSAs
-
-
- never - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Never translate LSAs
-
-
- supress_fa - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress forwarding address in translated LSAs.
-
-
- ranges - -
- list - / elements=dictionary -
- 		- -
Configure an address range for the area.
-
-
- cost - -
- integer -
- 		- -
Cost to use for the range.
-
-
- not_advertise - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress advertising the specified range.
-
-
- prefix - -
- string - / required -
- 		- -
IP in Prefix format (x.x.x.x/len)
-
-
- stub - -
- dictionary -
- 		- -
Settings for configuring the area as a stub.
-
-
- no_summary - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Prevent ABR from sending summary LSAs into stub area.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure the area as a stub.
-
-
- auto_cost - -
- dictionary -
- 		- -
Calculate OSPF cost according to bandwidth.
-
-
- reference_bandwidth - -
- integer - / required -
- 		- -
Reference bandwidth used to assign OSPF cost.
-
-
- unit - -
- string - / required -
- 		-
    Choices: -
  • Gbps
    • -
  • Mbps
    • -
- 		-
Specify in which unit the reference bandwidth is specified.
-
-
- bfd - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable BFD on all OSPF interfaces.
-
-
- capability - -
- dictionary -
- 		- -
OSPF capability settings.
-
-
- vrf_lite - -
- dictionary -
- 		- -
Enable VRF-lite capability settings.
-
-
- evpn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ethernet VPN.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable VRF-lite support.
-
-
- default_information - -
- dictionary -
- 		- -
Control distribution of default routes.
-
-
- originate - -
- dictionary -
- 		- -
Distribute a default route.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always advertise a default route.
-
-
- route_map - -
- string -
- 		- -
Policy to control distribution of default routes
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable distribution of default route.
-
-
- default_metric - -
- integer -
- 		- -
Specify default metric for redistributed routes.
-
-
- distance - -
- integer -
- 		- -
Configure the OSPF administrative distance.
-
-
- down_bit_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure a PE router to ignore the DN bit for network summary, external and NSSA external LSA.
-
-
- graceful_restart - -
- dictionary -
- 		- -
Configure graceful restart.
-
-
- grace_period - -
- integer -
- 		- -
Configure maximum interval to restart gracefully.
-
-
- helper_disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable helper mode.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable graceful-restart.
-
-
- log_adjacency_changes - -
- dictionary -
- 		- -
Log changes in adjacency state.
-
-
- detail - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Notify all state changes.
-
-
- log - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/disable logging changes in adjacency state.
-
-
- max_lsa - -
- dictionary -
- 		- -
Feature to limit the number of non-self-originated LSAs.
-
-
- ignore_count - -
- integer -
- 		- -
Set count on how many times adjacencies can be suppressed.
-
-
- ignore_time - -
- integer -
- 		- -
Set time during which all adjacencies are suppressed.
-
-
- max_non_self_generated_lsa - -
- integer - / required -
- 		- -
Set the maximum number of non self-generated LSAs.
-
-
- reset_time - -
- integer -
- 		- -
Set number of minutes after which ignore-count is reset to zero.
-
-
- threshold - -
- integer -
- 		- -
Threshold value (%) at which to generate a warning message.
-
-
- warning_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Log a warning message when limit is exceeded.
-
-
- max_metric - -
- dictionary -
- 		- -
Maximize the cost metric.
-
-
- router_lsa - -
- dictionary -
- 		- -
Router LSA configuration.
-
-
- external_lsa - -
- dictionary -
- 		- -
External LSA configuration.
-
-
- max_metric_value - -
- integer -
- 		- -
Set max metric value for external LSAs.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set external-lsa attribute.
-
-
- include_stub - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise Max metric for Stub links as well.
-
-
- on_startup - -
- dictionary -
- 		- -
Effective only at startup.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set on-startup attribute.
-
-
- wait_for_bgp_asn - -
- integer -
- 		- -
ASN of BGP to wait for.
-
-
- wait_period - -
- integer -
- 		- -
Wait period in seconds after startup.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set router-lsa attribute.
-
-
- summary_lsa - -
- dictionary -
- 		- -
Summary LSAs configuration.
-
-
- max_metric_value - -
- integer -
- 		- -
Max metric value for summary LSAs.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set summary-lsa attribute.
-
-
- maximum_paths - -
- integer -
- 		- -
Maximum paths per destination.
-
-
- name_lookup - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Display OSPF router ids as DNS names.
-
-
- passive_interface - -
- dictionary -
- 		- -
Suppress routing updates on the interface.
-
-
- default - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Interfaces passive by default.
-
-
- redistribute - -
- list - / elements=dictionary -
- 		- -
Redistribute information from another routing protocol.
-
-
- id - -
- string -
- 		- -
The identifier for the protocol specified.
-
-
- protocol - -
- string - / required -
- 		-
    Choices: -
  • bgp
    • -
  • direct
    • -
  • eigrp
    • -
  • isis
    • -
  • lisp
    • -
  • ospf
    • -
  • rip
    • -
  • static
    • -
- 		-
The name of the protocol.
-
-
- route_map - -
- string - / required -
- 		- -
The route map policy to constrain redistribution.
-
-
- rfc1583compatibility - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure 1583 compatibility for external path preferences.
-
-
- router_id - -
- string -
- 		- -
Set OSPF process router-id.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Shutdown the OSPF protocol instance.
-
-
- summary_address - -
- list - / elements=dictionary -
- 		- -
Configure route summarization for redistribution.
-
-
- not_advertise - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress advertising the specified summary.
-
-
- prefix - -
- string - / required -
- 		- -
IP prefix in format x.x.x.x/ml.
-
-
- tag - -
- integer -
- 		- -
A 32-bit tag value.
-
-
- table_map - -
- dictionary -
- 		- -
Policy for filtering/modifying OSPF routes before sending them to RIB.
-
-
- filter - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Block the OSPF routes from being sent to RIB.
-
-
- name - -
- string - / required -
- 		- -
The Route Map name.
-
-
- timers - -
- dictionary -
- 		- -
Configure timer related constants.
-
-
- lsa_arrival - -
- integer -
- 		- -
Mimimum interval between arrival of a LSA.
-
-
- lsa_group_pacing - -
- integer -
- 		- -
LSA group refresh/maxage interval.
-
-
- throttle - -
- dictionary -
- 		- -
Configure throttle related constants.
-
-
- lsa - -
- dictionary -
- 		- -
Set rate-limiting for LSA generation.
-
-
- hold_interval - -
- integer -
- 		- -
The hold interval.
-
-
- max_interval - -
- integer -
- 		- -
The max interval.
-
-
- start_interval - -
- integer -
- 		- -
The start interval.
-
-
- spf - -
- dictionary -
- 		- -
Set OSPF SPF timers.
-
-
- initial_spf_delay - -
- integer -
- 		- -
Initial SPF schedule delay in milliseconds.
-
-
- max_wait_time - -
- integer -
- 		- -
Maximum wait time between SPF calculations.
-
-
- min_hold_time - -
- integer -
- 		- -
Minimum hold time between SPF calculations.
-
-
- vrf - -
- string - / required -
- 		- -
Name/Identifier of the VRF.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section "^router ospf .*".
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • parsed
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 7.0(3)I5(1). - - Unsupported for Cisco MDS - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # nxos-9k-rdo# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_ospfv2: - config: - processes: - - process_id: 100 - router_id: 203.0.113.20 - - process_id: 102 - router_id: 198.51.100.1 - areas: - - area_id: 0.0.0.100 - filter_list: - - route_map: rmap_1 - direction: in - - route_map: rmap_2 - direction: out - ranges: - - prefix: 198.51.100.64/27 - not_advertise: true - - prefix: 198.51.100.96/27 - cost: 120 - - area_id: 0.0.0.101 - authentication: - message_digest: true - redistribute: - - protocol: eigrp - id: 120 - route_map: rmap_1 - - protocol: direct - route_map: ospf102-direct-connect - vrfs: - - vrf: zone1 - router_id: 198.51.100.129 - redistribute: - - protocol: static - route_map: zone1-static-connect - summary_address: - - prefix: 198.51.100.128/27 - tag: 121 - - prefix: 198.51.100.160/27 - areas: - - area_id: 0.0.0.102 - nssa: - default_information_originate: true - no_summary: true - - area_id: 0.0.0.103 - nssa: - no_summary: true - translate: - type7: - always: true - - vrf: zone2 - auto_cost: - reference_bandwidth: 45 - unit: Gbps - state: merged - - # Task output: - # ------------ - # before: {} - # - # commands: - # - router ospf 102 - # - router-id 198.51.100.1 - # - redistribute eigrp 120 route-map rmap_1 - # - redistribute direct route-map ospf102-direct-connect - # - area 0.0.0.100 filter-list route-map rmap_1 in - # - area 0.0.0.100 filter-list route-map rmap_2 out - # - area 0.0.0.100 range 198.51.100.64/27 not-advertise - # - area 0.0.0.100 range 198.51.100.96/27 cost 120 - # - area 0.0.0.101 authentication message-digest - # - vrf zone1 - # - router-id 198.51.100.129 - # - summary-address 198.51.100.128/27 tag 121 - # - summary-address 198.51.100.160/27 - # - redistribute static route-map zone1-static-connect - # - area 0.0.0.102 nssa no-summary default-information-originate - # - area 0.0.0.103 nssa no-summary - # - area 0.0.0.103 nssa translate type7 always - # - vrf zone2 - # - auto-cost reference-bandwidth 45 Gbps - # - router ospf 100 - # - router-id 203.0.113.20 - # - # after: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.100 - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # - cost: 120 - # prefix: 198.51.100.96/27 - # - area_id: 0.0.0.101 - # authentication: - # message_digest: true - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # - area_id: 0.0.0.103 - # nssa: - # no_summary: true - # translate: - # type7: - # always: true - # redistribute: - # - protocol: static - # route_map: zone1-static-connect - # router_id: 198.51.100.129 - # vrf: zone1 - # - auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # vrf: zone2 - # - - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # area 0.0.0.100 range 198.51.100.96/27 cost 120 - # area 0.0.0.101 authentication message-digest - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # area 0.0.0.103 nssa no-summary - # area 0.0.0.103 nssa translate type7 always - # redistribute static route-map zone1-static-connect - # summary-address 198.51.100.128/27 tag 121 - # summary-address 198.51.100.160/27 - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - - # Using replaced - - # Before state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # area 0.0.0.100 range 198.51.100.96/27 cost 120 - # area 0.0.0.101 authentication message-digest - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # area 0.0.0.103 nssa no-summary - # area 0.0.0.103 nssa translate type7 always - # redistribute static route-map zone1-static-connect - # summary-address 198.51.100.128/27 tag 121 - # summary-address 198.51.100.160/27 - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - - - name: >- - Replace device configurations of listed OSPF processes with provided - configurations - cisco.nxos.nxos_ospfv2: - config: - processes: - - process_id: 102 - router_id: 198.51.100.1 - areas: - - area_id: 0.0.0.100 - filter_list: - - route_map: rmap_8 - direction: in - ranges: - - prefix: 198.51.100.64/27 - not_advertise: true - - area_id: 0.0.0.101 - stub: - no_summary: true - redistribute: - - protocol: eigrp - id: 130 - route_map: rmap_1 - - protocol: direct - route_map: ospf102-direct-connect - vrfs: - - vrf: zone1 - router_id: 198.51.100.129 - redistribute: - - protocol: bgp - id: 65563 - route_map: zone1-bgp-connect - areas: - - area_id: 0.0.0.102 - nssa: - default_information_originate: true - no_summary: true - state: replaced - - - # Task output: - # ------------ - # before: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.100 - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # - cost: 120 - # prefix: 198.51.100.96/27 - # - area_id: 0.0.0.101 - # authentication: - # message_digest: true - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # - area_id: 0.0.0.103 - # nssa: - # no_summary: true - # translate: - # type7: - # always: true - # redistribute: - # - protocol: static - # route_map: zone1-static-connect - # router_id: 198.51.100.129 - # vrf: zone1 - # - auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # vrf: zone2 - # - # commands: - # - router ospf 102 - # - redistribute eigrp 130 route-map rmap_1 - # - no redistribute eigrp 120 route-map rmap_1 - # - area 0.0.0.100 filter-list route-map rmap_8 in - # - no area 0.0.0.100 filter-list route-map rmap_2 out - # - no area 0.0.0.100 range 198.51.100.96/27 - # - no area 0.0.0.101 authentication - # - area 0.0.0.101 stub no-summary - # - vrf zone1 - # - no summary-address 198.51.100.128/27 tag 121 - # - no summary-address 198.51.100.160/27 - # - redistribute bgp 65563 route-map zone1-bgp-connect - # - no redistribute static route-map zone1-static-connect - # - no area 0.0.0.103 nssa - # - no area 0.0.0.103 nssa translate type7 always - # - no vrf zone2 - # - # after: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.101 - # stub: - # no_summary: true - # - area_id: 0.0.0.100 - # filter_list: - # - direction: in - # route_map: rmap_8 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "130" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # redistribute: - # - id: "65563" - # protocol: bgp - # route_map: zone1-bgp-connect - # router_id: 198.51.100.129 - # vrf: zone1 - - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # area 0.0.0.101 stub no-summary - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 130 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_8 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # redistribute bgp 65563 route-map zone1-bgp-connect - - # Using overridden - - # Before state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # area 0.0.0.100 range 198.51.100.96/27 cost 120 - # area 0.0.0.101 authentication message-digest - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # area 0.0.0.103 nssa no-summary - # area 0.0.0.103 nssa translate type7 always - # redistribute static route-map zone1-static-connect - # summary-address 198.51.100.128/27 tag 121 - # summary-address 198.51.100.160/27 - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - - - name: Override all OSPF configuration with provided configuration - cisco.nxos.nxos_ospfv2: - config: - processes: - - process_id: 104 - router_id: 203.0.113.20 - - process_id: 102 - router_id: 198.51.100.1 - shutdown: true - state: overridden - - # Task output: - # ------------ - # before: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.100 - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # - cost: 120 - # prefix: 198.51.100.96/27 - # - area_id: 0.0.0.101 - # authentication: - # message_digest: true - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # - area_id: 0.0.0.103 - # nssa: - # no_summary: true - # translate: - # type7: - # always: true - # redistribute: - # - protocol: static - # route_map: zone1-static-connect - # router_id: 198.51.100.129 - # vrf: zone1 - # - auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # vrf: zone2 - # - # commands: - # - no router ospf 100 - # - router ospf 104 - # - router-id 203.0.113.20 - # - router ospf 102 - # - shutdown - # - no redistribute direct route-map ospf102-direct-connect - # - no redistribute eigrp 120 route-map rmap_1 - # - no area 0.0.0.100 filter-list route-map rmap_2 out - # - no area 0.0.0.100 filter-list route-map rmap_1 in - # - no area 0.0.0.100 range 198.51.100.64/27 - # - no area 0.0.0.100 range 198.51.100.96/27 - # - no area 0.0.0.101 authentication - # - no vrf zone1 - # - no vrf zone2 - # - # after: - # processes: - # - process_id: "102" - # router_id: 198.51.100.1 - # shutdown: true - # - process_id: "104" - # router_id: 203.0.113.20 - - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 102 - # router-id 198.51.100.1 - # shutdown - # router ospf 104 - # router-id 203.0.113.20 - - # Using deleted to delete a single OSPF process - - # Before state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # area 0.0.0.100 range 198.51.100.96/27 cost 120 - # area 0.0.0.101 authentication message-digest - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # area 0.0.0.103 nssa no-summary - # area 0.0.0.103 nssa translate type7 always - # redistribute static route-map zone1-static-connect - # summary-address 198.51.100.128/27 tag 121 - # summary-address 198.51.100.160/27 - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - - - name: Delete a single OSPF process - cisco.nxos.nxos_ospfv2: - config: - processes: - - process_id: 102 - state: deleted - - # Task output: - # ------------ - # before: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.100 - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # - cost: 120 - # prefix: 198.51.100.96/27 - # - area_id: 0.0.0.101 - # authentication: - # message_digest: true - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # - area_id: 0.0.0.103 - # nssa: - # no_summary: true - # translate: - # type7: - # always: true - # redistribute: - # - protocol: static - # route_map: zone1-static-connect - # router_id: 198.51.100.129 - # vrf: zone1 - # - auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # vrf: zone2 - # - # commands: - # - no router ospf 102 - # - # after: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - - # Using deleted all OSPF processes from the device - - # Before state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # area 0.0.0.100 range 198.51.100.96/27 cost 120 - # area 0.0.0.101 authentication message-digest - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # area 0.0.0.103 nssa no-summary - # area 0.0.0.103 nssa translate type7 always - # redistribute static route-map zone1-static-connect - # summary-address 198.51.100.128/27 tag 121 - # summary-address 198.51.100.160/27 - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - - - name: Delete all OSPF processes from the device - cisco.nxos.nxos_ospfv2: - state: deleted - - # Task output: - # ------------ - # before: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.100 - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # - cost: 120 - # prefix: 198.51.100.96/27 - # - area_id: 0.0.0.101 - # authentication: - # message_digest: true - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # - area_id: 0.0.0.103 - # nssa: - # no_summary: true - # translate: - # type7: - # always: true - # redistribute: - # - protocol: static - # route_map: zone1-static-connect - # router_id: 198.51.100.129 - # vrf: zone1 - # - auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # vrf: zone2 - # - # commands: - # - no router ospf 100 - # - no router ospf 102 - # - # after: {} - - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # nxos-9k-rdo# - - # Using rendered - - - name: >- - Render platform specific configuration lines (without connecting to the - device) - cisco.nxos.nxos_ospfv2: - config: - processes: - - process_id: 100 - router_id: 203.0.113.20 - - process_id: 102 - router_id: 198.51.100.1 - areas: - - area_id: 0.0.0.100 - filter_list: - - route_map: rmap_1 - direction: in - - route_map: rmap_2 - direction: out - ranges: - - prefix: 198.51.100.64/27 - not_advertise: true - - prefix: 198.51.100.96/27 - cost: 120 - - area_id: 0.0.0.101 - authentication: - message_digest: true - redistribute: - - protocol: eigrp - id: 120 - route_map: rmap_1 - - protocol: direct - route_map: ospf102-direct-connect - vrfs: - - vrf: zone1 - router_id: 198.51.100.129 - redistribute: - - protocol: static - route_map: zone1-static-connect - summary_address: - - prefix: 198.51.100.128/27 - tag: 121 - - prefix: 198.51.100.160/27 - areas: - - area_id: 0.0.0.102 - nssa: - default_information_originate: true - no_summary: true - - area_id: 0.0.0.103 - nssa: - no_summary: true - translate: - type7: - always: true - - vrf: zone2 - auto_cost: - reference_bandwidth: 45 - unit: Gbps - state: rendered - - - # Task output: - # ------------ - # rendered: - # - router ospf 100 - # - router-id 203.0.113.20 - # - router ospf 102 - # - router-id 198.51.100.1 - # - redistribute eigrp 120 route-map rmap_1 - # - redistribute direct route-map ospf102-direct-connect - # - area 0.0.0.100 filter-list route-map rmap_1 in - # - area 0.0.0.100 filter-list route-map rmap_2 out - # - area 0.0.0.100 range 198.51.100.64/27 not-advertise - # - area 0.0.0.100 range 198.51.100.96/27 cost 120 - # - area 0.0.0.101 authentication message-digest - # - vrf zone1 - # - router-id 198.51.100.129 - # - summary-address 198.51.100.128/27 tag 121 - # - summary-address 198.51.100.160/27 - # - redistribute static route-map zone1-static-connect - # - area 0.0.0.102 nssa no-summary default-information-originate - # - area 0.0.0.103 nssa no-summary - # - area 0.0.0.103 nssa translate type7 always - # - vrf zone2 - # - auto-cost reference-bandwidth 45 Gbps - - # Using parsed - - # parsed.cfg - # ------------ - # router ospf 100 - # router-id 192.0.100.1 - # area 0.0.0.101 nssa no-summary no-redistribution - # area 0.0.0.102 stub no-summary - # redistribute direct route-map ospf-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 192.0.2.0/24 not-advertise - # area 0.0.0.100 range 192.0.3.0/24 cost 120 - # area 0.0.0.100 authentication message-digest - # vrf zone1 - # router-id 192.0.100.2 - # area 0.0.100.1 nssa no-summary no-redistribution - # redistribute static route-map zone1-direct-connect - # summary-address 10.0.0.0/24 tag 120 - # summary-address 11.0.0.0/24 not-advertise - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - # down-bit-ignore - # capability vrf-lite evpn - # shutdown - # router ospf 102 - # router-id 198.54.100.1 - # shutdown - # vrf zone2 - # summary-address 192.0.8.0/24 tag 120 - # vrf zone4 - # shutdown - - - name: Parse externally provided OSPFv2 config - cisco.nxos.nxos_ospfv2: - running_config: "{{ lookup('file', 'ospfv2.cfg') }}" - state: parsed - - # Task output: - # ------------ - # parsed: - # processes: - # - process_id: "100" - # areas: - # - area_id: 0.0.0.101 - # nssa: - # no_redistribution: true - # no_summary: true - # - area_id: 0.0.0.102 - # stub: - # no_summary: true - # - area_id: 0.0.0.100 - # authentication: - # message_digest: true - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 192.0.2.0/24 - # - cost: 120 - # prefix: 192.0.3.0/24 - # redistribute: - # - protocol: direct - # route_map: ospf-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 192.0.100.1 - # vrfs: - # - vrf: zone1 - # areas: - # - area_id: 0.0.100.1 - # nssa: - # no_redistribution: true - # no_summary: true - # redistribute: - # - protocol: static - # route_map: zone1-direct-connect - # router_id: 192.0.100.2 - # summary_address: - # - prefix: 10.0.0.0/24 - # tag: 120 - # - not_advertise: true - # prefix: 11.0.0.0/24 - # - vrf: zone2 - # auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # capability: - # vrf_lite: - # evpn: true - # down_bit_ignore: true - # shutdown: true - # - process_id: "102" - # router_id: 198.54.100.1 - # shutdown: true - # vrfs: - # - vrf: zone2 - # summary_address: - # - prefix: 192.0.8.0/24 - # tag: 120 - # - vrf: zone4 - # shutdown: true - - # Using gathered - - - name: Gather OSPFv2 facts using gathered - cisco.nxos.nxos_ospfv2: - state: gathered - - # Task output: - # ------------ - # gathered: - # processes: - # - process_id: "102" - # areas: - # - area_id: 0.0.0.101 - # stub: - # no_summary: true - # - area_id: 0.0.0.100 - # filter_list: - # - direction: in - # route_map: rmap_8 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "130" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - vrf: zone1 - # areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # redistribute: - # - id: "65563" - # protocol: bgp - # route_map: zone1-bgp-connect - # router_id: 198.51.100.129 - # - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['router ospf 102', 'router-id 198.54.100.1', 'router ospf 100', 'router-id 192.0.100.1', 'redistribute eigrp 120 route-map rmap_1', 'redistribute direct route-map ospf-direct-connect', 'area 0.0.0.100 filter-list route-map rmap_1 in', 'area 0.0.0.100 filter-list route-map rmap_2 out', 'area 0.0.0.100 range 192.0.2.0/24 not-advertise', 'area 0.0.0.100 range 192.0.3.0/24 cost 120', 'vrf zone1', 'router-id 192.0.100.2', 'summary-address 10.0.0.0/24 tag 121', 'summary-address 11.0.0.0/24', 'redistribute static route-map zone1-direct-connect', 'vrf zone2', 'auto-cost reference-bandwidth 45 Gbps', 'capability vrf-lite evpn']
-
-
- gathered - -
- dictionary -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- dictionary -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['router ospf 102', 'router-id 198.54.100.1', 'router ospf 100']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_overlay_global_module.rst b/docs/cisco.nxos.nxos_overlay_global_module.rst deleted file mode 100644 index 1a1b8d975..000000000 --- a/docs/cisco.nxos.nxos_overlay_global_module.rst +++ /dev/null @@ -1,120 +0,0 @@ -.. _cisco.nxos.nxos_overlay_global_module: - - -****************************** -cisco.nxos.nxos_overlay_global -****************************** - -**Configures anycast gateway MAC of the switch.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configures anycast gateway MAC of the switch. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- anycast_gateway_mac - -
- string - / required -
- 		- -
Anycast gateway mac of the switch.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Default restores params default value - - Supported MAC address format are "E.E.E", "EE-EE-EE-EE-EE-EE", "EE:EE:EE:EE:EE:EE" and "EEEE.EEEE.EEEE" - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_overlay_global: - anycast_gateway_mac: b.b.b - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['fabric forwarding anycast-gateway-mac 000B.000B.000B']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_pim_module.rst b/docs/cisco.nxos.nxos_pim_module.rst deleted file mode 100644 index e19eee567..000000000 --- a/docs/cisco.nxos.nxos_pim_module.rst +++ /dev/null @@ -1,148 +0,0 @@ -.. _cisco.nxos.nxos_pim_module: - - -******************* -cisco.nxos.nxos_pim -******************* - -**Manages configuration of a PIM instance.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages configuration of a Protocol Independent Multicast (PIM) instance. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- bfd - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Enables BFD on all PIM interfaces.
-
Dependency: ''feature bfd''
-
-
- ssm_range - -
- list - / elements=string -
- 		- Default:
[]
- 		-
Configure group ranges for Source Specific Multicast (SSM). Valid values are multicast addresses or the keyword none or keyword default. none removes all SSM group ranges. 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 default, otherwise use the default option.
-
-
- - -Notes ------ - -.. note:: - - Unsupported for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - 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 Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['ip pim bfd', 'ip pim ssm range 224.0.0.0/8']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_ping_module.rst b/docs/cisco.nxos.nxos_ping_module.rst deleted file mode 100644 index d0d805868..000000000 --- a/docs/cisco.nxos.nxos_ping_module.rst +++ /dev/null @@ -1,311 +0,0 @@ -.. _cisco.nxos.nxos_ping_module: - - -******************** -cisco.nxos.nxos_ping -******************** - -**Tests reachability using ping from Nexus switch.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Tests reachability using ping from switch to a remote destination. -- For a general purpose network module, see the :ref:`ansible.netcommon.net_ping ` module. -- For Windows targets, use the :ref:`ansible.windows.win_ping ` module instead. -- For targets running Python, use the :ref:`ansible.builtin.ping ` module instead. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- count - -
- integer -
- 		- Default:
5
- 		-
Number of packets to send.
-
-
- dest - -
- string - / required -
- 		- -
IP address or hostname (resolvable by switch) of remote node.
-
-
- df_bit - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Set the DF bit.
-
-
- size - -
- integer -
- 		- -
Size of packets to send.
-
-
- source - -
- string -
- 		- -
Source IP Address or hostname (resolvable by switch)
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Determines if the expected result is success or fail.
-
-
- vrf - -
- string -
- 		- -
Outgoing VRF.
-
-
- - -Notes ------ - -.. note:: - - Unsupported for Cisco MDS - - For a general purpose network module, see the :ref:`ansible.netcommon.net_ping ` module. - - For Windows targets, use the :ref:`ansible.windows.win_ping ` module instead. - - For targets running Python, use the :ref:`ansible.builtin.ping ` module instead. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Test reachability to 8.8.8.8 using mgmt vrf - cisco.nxos.nxos_ping: - dest: 8.8.8.8 - vrf: management - host: 68.170.147.165 - - - name: Test reachability to a few different public IPs using mgmt vrf - cisco.nxos.nxos_ping: - dest: "{{ item }}" - vrf: management - host: 68.170.147.165 - with_items: - - 8.8.8.8 - - 4.4.4.4 - - 198.6.1.4 - - - name: Test reachability to 8.8.8.8 using mgmt vrf, size and df-bit - cisco.nxos.nxos_ping: - dest: 8.8.8.8 - df_bit: true - size: 1400 - vrf: management - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
Show the command sent
-
-
Sample:
-
['ping 8.8.8.8 count 2 vrf management']
-
-
- packet_loss - -
- string -
- 		always -
Percentage of packets lost
-
-
Sample:
-
0.00%
-
-
- packets_rx - -
- integer -
- 		always -
Packets successfully received
-
-
Sample:
-
2
-
-
- packets_tx - -
- integer -
- 		always -
Packets successfully transmitted
-
-
Sample:
-
2
-
-
- rtt - -
- dictionary -
- 		always -
Show RTT stats
-
-
Sample:
-
{'avg': 6.264, 'max': 6.564, 'min': 5.978}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_prefix_lists_module.rst b/docs/cisco.nxos.nxos_prefix_lists_module.rst deleted file mode 100644 index 25f343132..000000000 --- a/docs/cisco.nxos.nxos_prefix_lists_module.rst +++ /dev/null @@ -1,1049 +0,0 @@ -.. _cisco.nxos.nxos_prefix_lists_module: - - -**************************** -cisco.nxos.nxos_prefix_lists -**************************** - -**Prefix-Lists resource module.** - - -Version added: 2.4.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages prefix-lists configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of prefix-list configuration.
-
-
- afi - -
- string -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
The Address Family Identifier (AFI) for the prefix-lists.
-
-
- prefix_lists - -
- list - / elements=dictionary -
- 		- -
List of prefix-list configurations.
-
-
- description - -
- string -
- 		- -
Description of the prefix list
-
-
- entries - -
- list - / elements=dictionary -
- 		- -
List of configurations for the specified prefix-list
-
-
- action - -
- string -
- 		-
    Choices: -
  • permit
    • -
  • deny
    • -
- 		-
Prefix-List permit or deny.
-
-
- eq - -
- integer -
- 		- -
Exact prefix length to be matched.
-
-
- ge - -
- integer -
- 		- -
Minimum prefix length to be matched.
-
-
- le - -
- integer -
- 		- -
Maximum prefix length to be matched.
-
-
- mask - -
- string -
- 		- -
Explicit match mask.
-
-
- prefix - -
- string -
- 		- -
IP or IPv6 prefix in A.B.C.D/LEN or A:B::C:D/LEN format.
-
-
- sequence - -
- integer -
- 		- -
Sequence Number.
-
-
- name - -
- string -
- 		- -
Name of the prefix-list.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^ip(.* prefix-list').
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
Refer to examples for more details.
-
With state replaced, for the listed prefix-lists, sequences that are in running-config but not in the task are negated.
-
With state overridden, all prefix-lists that are in running-config but not in the task are negated.
-
Please refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - Unsupported for Cisco MDS - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # nxos-9k-rdo# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_prefix_lists: - config: - - afi: ipv4 - prefix_lists: - - name: AllowPrefix - description: allows engineering IPv4 networks - entries: - - sequence: 10 - action: permit - prefix: 192.0.2.0/23 - eq: 24 - - sequence: 20 - action: permit - prefix: 198.51.100.128/26 - - name: DenyPrefix - description: denies lab IPv4 networks - entries: - - sequence: 20 - action: deny - prefix: 203.0.113.0/24 - le: 25 - - - afi: ipv6 - prefix_lists: - - name: AllowIPv6Prefix - description: allows engineering IPv6 networks - entries: - - sequence: 8 - action: permit - prefix: "2001:db8:400::/38" - - sequence: 20 - action: permit - prefix: "2001:db8:8000::/35" - le: 37 - - # Task output - # ------------- - # before: [] - # - # commands: - # - "ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks" - # - "ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38" - # - "ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37" - # - "ip prefix-list AllowPrefix description allows engineering IPv4 networks" - # - "ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" - # - "ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" - # - "ip prefix-list DenyPrefix description denies lab IPv4 networks" - # - "ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25" - # - # after: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - # Using replaced - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Replace prefix-lists configurations of listed prefix-lists with provided configurations - cisco.nxos.nxos_prefix_lists: - config: - - afi: ipv4 - prefix_lists: - - name: AllowPrefix - description: allows engineering IPv4 networks - entries: - - sequence: 10 - action: permit - prefix: 203.0.113.64/27 - - - sequence: 30 - action: permit - prefix: 203.0.113.96/27 - - name: AllowPrefix2Stub - description: allow other engineering IPv4 network - state: replaced - - # Task output - # ------------- - # before: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # commands: - # - "no ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" - # - "ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27" - # - "ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27" - # - "no ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" - # - "ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network" - # - # after: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 203.0.113.64/27 - # - sequence: 30 - # action: permit - # prefix: 203.0.113.96/27 - # name: AllowPrefix - # - description: allow other engineering IPv4 network - # name: AllowPrefix2Stub - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27 - # ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27 - # ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - # Using overridden - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Override all prefix-lists configuration with provided configuration - cisco.nxos.nxos_prefix_lists: &id003 - config: - - afi: ipv4 - prefix_lists: - - name: AllowPrefix - description: allows engineering IPv4 networks - entries: - - sequence: 10 - action: permit - prefix: 203.0.113.64/27 - - - sequence: 30 - action: permit - prefix: 203.0.113.96/27 - - name: AllowPrefix2Stub - description: allow other engineering IPv4 network - state: overridden - - # Task output - # ------------- - # before: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # commands: - # - "no ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" - # - "ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27" - # - "ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27" - # - "no ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" - # - "ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network" - # - "no ip prefix-list DenyPrefix" - # - "no ipv6 prefix-list AllowIPv6Prefix" - # - # after: - # - afi: ipv4 - # prefix_lists: - # - name: AllowPrefix - # description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 203.0.113.64/27 - # - # - sequence: 30 - # action: permit - # prefix: 203.0.113.96/27 - # - name: AllowPrefix2Stub - # description: allow other engineering IPv4 network - # - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27 - # ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27 - # ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network - - # Using deleted to delete a all prefix lists for an AFI - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Delete all prefix-lists for an AFI - cisco.nxos.nxos_prefix_lists: - config: - - afi: ipv4 - state: deleted - register: result - - # Task output - # ------------- - # before: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # commands: - # - "no ip prefix-list AllowPrefix" - # - "no ip prefix-list DenyPrefix" - # - # after: - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - # Using deleted to delete a single prefix-list - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Delete a single prefix-list - cisco.nxos.nxos_prefix_lists: - config: - - afi: ipv4 - prefix_lists: - - name: AllowPrefix - state: deleted - - # Task output - # ------------- - # before: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # commands: - # - "no ip prefix-list AllowPrefix" - # - # after: - # - afi: ipv4 - # prefix_lists: - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - # Using deleted to delete all prefix-lists from the device - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Delete all prefix-lists - cisco.nxos.nxos_prefix_lists: - state: deleted - - # Task output - # ------------- - # before: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # commands: - # - "no ip prefix-list AllowPrefix" - # - "no ip prefix-list DenyPrefix" - # - "no ipv6 prefix-list AllowIPv6Prefix" - # - # after: [] - # - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # nxos-9k-rdo# - - # Using rendered - - - name: Render platform specific configuration lines with state rendered (without connecting to the device) - cisco.nxos.nxos_prefix_lists: &id001 - config: - - afi: ipv4 - prefix_lists: - - name: AllowPrefix - description: allows engineering IPv4 networks - entries: - - sequence: 10 - action: permit - prefix: 192.0.2.0/23 - eq: 24 - - sequence: 20 - action: permit - prefix: 198.51.100.128/26 - - name: DenyPrefix - description: denies lab IPv4 networks - entries: - - sequence: 20 - action: deny - prefix: 203.0.113.0/24 - le: 25 - - - afi: ipv6 - prefix_lists: - - name: AllowIPv6Prefix - description: allows engineering IPv6 networks - entries: - - sequence: 8 - action: permit - prefix: "2001:db8:400::/38" - - sequence: 20 - action: permit - prefix: "2001:db8:8000::/35" - le: 37 - state: rendered - - # Task Output (redacted) - # ----------------------- - # rendered: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - - # Using parsed - - # parsed.cfg - # ------------ - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Parse externally provided prefix-lists configuration - register: result - cisco.nxos.nxos_prefix_lists: - running_config: "{{ lookup('file', './parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - - - - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_reboot_module.rst b/docs/cisco.nxos.nxos_reboot_module.rst deleted file mode 100644 index cc94a6762..000000000 --- a/docs/cisco.nxos.nxos_reboot_module.rst +++ /dev/null @@ -1,123 +0,0 @@ -.. _cisco.nxos.nxos_reboot_module: - - -********************** -cisco.nxos.nxos_reboot -********************** - -**Reboot a network device.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Reboot a network device. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- confirm - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Safeguard boolean. Set to true if you're sure you want to reboot.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Tested against Cisco MDS NX-OS 9.2(1) - - The module will fail due to timeout issues, but the reboot will be performed anyway. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_reboot: - confirm: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- rebooted - -
- boolean -
- 		success -
Whether the device was instructed to reboot.
-
-
Sample:
-
True
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_rollback_module.rst b/docs/cisco.nxos.nxos_rollback_module.rst deleted file mode 100644 index c948e093a..000000000 --- a/docs/cisco.nxos.nxos_rollback_module.rst +++ /dev/null @@ -1,159 +0,0 @@ -.. _cisco.nxos.nxos_rollback_module: - - -************************ -cisco.nxos.nxos_rollback -************************ - -**Set a checkpoint or rollback to a checkpoint.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module offers the ability to set a configuration checkpoint file or rollback to a configuration checkpoint file on Cisco NXOS switches. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- checkpoint_file - -
- string -
- 		- -
Name of checkpoint file to create. Mutually exclusive with rollback_to.
-
-
- rollback_to - -
- string -
- 		- -
Name of checkpoint file to rollback to. Mutually exclusive with checkpoint_file.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Sometimes ``transport=nxapi`` may cause a timeout error. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_rollback: - checkpoint_file: backup.cfg - username: '{{ un }}' - password: '{{ pwd }}' - host: '{{ inventory_hostname }}' - - cisco.nxos.nxos_rollback: - rollback_to: backup.cfg - username: '{{ un }}' - password: '{{ pwd }}' - host: '{{ inventory_hostname }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- filename - -
- string -
- 		success -
The filename of the checkpoint/rollback file.
-
-
Sample:
-
backup.cfg
-
-
- status - -
- string -
- 		success -
Which operation took place and whether it was successful.
-
-
Sample:
-
rollback executed
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_route_maps_module.rst b/docs/cisco.nxos.nxos_route_maps_module.rst deleted file mode 100644 index bcdf6a426..000000000 --- a/docs/cisco.nxos.nxos_route_maps_module.rst +++ /dev/null @@ -1,4368 +0,0 @@ -.. _cisco.nxos.nxos_route_maps_module: - - -************************** -cisco.nxos.nxos_route_maps -************************** - -**Route Maps resource module.** - - -Version added: 2.2.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages route maps configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of route-map configuration.
-
-
- entries - -
- list - / elements=dictionary -
- 		- -
List of entries (identified by sequence number) for this route-map.
-
-
- action - -
- string -
- 		-
    Choices: -
  • deny
    • -
  • permit
    • -
- 		-
Route map denies or permits set operations.
-
-
- continue_sequence - -
- integer -
- 		- -
Continue on a different entry within the route-map.
-
-
- description - -
- string -
- 		- -
Description of the route-map.
-
-
- match - -
- dictionary -
- 		- -
Match values from routing table.
-
-
- as_number - -
- dictionary -
- 		- -
Match BGP peer AS number.
-
-
- as_path_list - -
- list - / elements=string -
- 		- -
AS path access list name.
-
-
- asn - -
- list - / elements=string -
- 		- -
AS number.
-
-
- as_path - -
- list - / elements=string -
- 		- -
Match BGP AS path access-list.
-
-
- community - -
- dictionary -
- 		- -
Match BGP community list.
-
-
- community_list - -
- list - / elements=string -
- 		- -
Community list.
-
-
- exact_match - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do exact matching of communities.
-
-
- evpn - -
- dictionary -
- 		- -
Match BGP EVPN Routes.
-
-
- route_types - -
- list - / elements=string -
- 		- -
Match route type for evpn route.
-
-
- extcommunity - -
- dictionary -
- 		- -
Match BGP community list.
-
-
- exact_match - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do exact matching of extended communities.
-
-
- extcommunity_list - -
- list - / elements=string -
- 		- -
Extended Community list.
-
-
- interfaces - -
- list - / elements=string -
- 		- -
Match first hop interface of route.
-
-
- ip - -
- dictionary -
- 		- -
Configure IP specific information.
-
-
- address - -
- dictionary -
- 		- -
Match address of route or match packet.
-
-
- access_list - -
- string -
- 		- -
IP access-list name (for use in route-maps for PBR only).
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- multicast - -
- dictionary -
- 		- -
Match multicast attributes.
-
-
- group - -
- dictionary -
- 		- -
Multicast Group prefix.
-
Mutually exclusive with group_range.
-
-
- prefix - -
- string -
- 		- -
IPv4 group prefix.
-
-
- group_range - -
- dictionary -
- 		- -
Multicast Group address range.
-
Mutually exclusive with group.
-
-
- first - -
- string -
- 		- -
First Group address.
-
-
- last - -
- string -
- 		- -
Last Group address.
-
-
- rp - -
- dictionary -
- 		- -
Rendezvous point.
-
-
- prefix - -
- string -
- 		- -
IPv4 rendezvous prefix.
-
-
- rp_type - -
- string -
- 		-
    Choices: -
  • ASM
    • -
  • Bidir
    • -
- 		-
Multicast rendezvous point type.
-
-
- source - -
- string -
- 		- -
Multicast source address.
-
-
- next_hop - -
- dictionary -
- 		- -
Match next-hop address of route.
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- route_source - -
- dictionary -
- 		- -
Match advertising source address of route.
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- ipv6 - -
- dictionary -
- 		- -
Configure IPv6 specific information.
-
-
- address - -
- dictionary -
- 		- -
Match address of route or match packet.
-
-
- access_list - -
- string -
- 		- -
IP access-list name (for use in route-maps for PBR only).
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- multicast - -
- dictionary -
- 		- -
Match multicast attributes.
-
-
- group - -
- dictionary -
- 		- -
Multicast Group prefix.
-
Mutually exclusive with group_range.
-
-
- prefix - -
- string -
- 		- -
IPv4 group prefix.
-
-
- group_range - -
- dictionary -
- 		- -
Multicast Group address range.
-
Mutually exclusive with group.
-
-
- first - -
- string -
- 		- -
First Group address.
-
-
- last - -
- string -
- 		- -
Last Group address.
-
-
- rp - -
- dictionary -
- 		- -
Rendezvous point.
-
-
- prefix - -
- string -
- 		- -
IPv4 rendezvous prefix.
-
-
- rp_type - -
- string -
- 		-
    Choices: -
  • ASM
    • -
  • Bidir
    • -
- 		-
Multicast rendezvous point type.
-
-
- source - -
- string -
- 		- -
Multicast source address.
-
-
- next_hop - -
- dictionary -
- 		- -
Match next-hop address of route.
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- route_source - -
- dictionary -
- 		- -
Match advertising source address of route.
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- mac_list - -
- list - / elements=string -
- 		- -
Match entries of mac-lists.
-
-
- metric - -
- list - / elements=integer -
- 		- -
Match metric of route.
-
-
- ospf_area - -
- list - / elements=integer -
- 		- -
Match ospf area.
-
-
- route_types - -
- list - / elements=string -
- 		-
    Choices: -
  • external
    • -
  • inter-area
    • -
  • internal
    • -
  • intra-area
    • -
  • level-1
    • -
  • level-2
    • -
  • local
    • -
  • nssa-external
    • -
  • type-1
    • -
  • type-2
    • -
- 		-
Match route-type of route.
-
-
- source_protocol - -
- list - / elements=string -
- 		- -
Match source protocol.
-
-
- tags - -
- list - / elements=integer -
- 		- -
Match tag of route.
-
-
- sequence - -
- integer -
- 		- -
Sequence to insert to/delete from existing route-map entry.
-
-
- set - -
- dictionary -
- 		- -
Set values in destination routing protocol.
-
-
- as_path - -
- dictionary -
- 		- -
Prepend string for a BGP AS-path attribute.
-
-
- prepend - -
- dictionary -
- 		- -
Prepend to the AS-Path.
-
-
- as_number - -
- list - / elements=string -
- 		- -
AS number.
-
-
- last_as - -
- integer -
- 		- -
Number of last-AS prepends.
-
-
- tag - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set the tag as an AS-path attribute.
-
-
- comm_list - -
- string -
- 		- -
Set BGP community list (for deletion).
-
-
- community - -
- dictionary -
- 		- -
Set BGP community attribute.
-
-
- additive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Add to existing community.
-
-
- graceful_shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Graceful Shutdown (well-known community).
-
-
- internet - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Internet (well-known community).
-
-
- local_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send outside local AS (well-known community).
-
-
- no_advertise - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not advertise to any peer (well-known community).
-
-
- no_export - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not export to next AS (well-known community).
-
-
- number - -
- list - / elements=string -
- 		- -
Community number aa:nn format
-
-
- dampening - -
- dictionary -
- 		- -
Set BGP route flap dampening parameters.
-
-
- half_life - -
- integer -
- 		- -
Half-life time for the penalty.
-
-
- max_suppress_time - -
- integer -
- 		- -
Maximum suppress time for stable route.
-
-
- start_reuse_route - -
- integer -
- 		- -
Value to start reusing a route.
-
-
- start_suppress_route - -
- integer -
- 		- -
Value to start suppressing a route.
-
-
- distance - -
- dictionary -
- 		- -
Configure administrative distance.
-
-
- igp_ebgp_routes - -
- integer -
- 		- -
Administrative distance for IGP or EBGP routes
-
-
- internal_routes - -
- integer -
- 		- -
Distance for internal routes.
-
-
- local_routes - -
- integer -
- 		- -
Distance for local routes.
-
-
- evpn - -
- dictionary -
- 		- -
Set BGP EVPN Routes.
-
-
- gateway_ip - -
- dictionary -
- 		- -
Set gateway IP for type 5 EVPN routes.
-
Cannot set ip and use-nexthop in the same route-map sequence.
-
-
- ip - -
- string -
- 		- -
Gateway IP address.
-
-
- use_nexthop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use nexthop address as gateway IP.
-
-
- extcomm_list - -
- string -
- 		- -
Set BGP extcommunity list (for deletion).
-
-
- extcommunity - -
- dictionary -
- 		- -
Set BGP extcommunity attribute.
-
-
- rt - -
- dictionary -
- 		- -
Route-Target.
-
-
- additive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Add to existing rt extcommunity.
-
-
- extcommunity_numbers - -
- list - / elements=string -
- 		- -
Extcommunity number.
-
Supported formats are ASN2:NN, ASN4:NN, IPV4:NN.
-
-
- forwarding_address - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set the forwarding address.
-
-
- ip - -
- dictionary -
- 		- -
Configure IP features.
-
-
- address - -
- dictionary -
- 		- -
Specify IP address.
-
-
- prefix_list - -
- string -
- 		- -
Name of prefix list (Max Size 63).
-
-
- next_hop - -
- dictionary -
- 		- -
Set next-hop IP address (for policy-based routing)
-
-
- address - -
- string -
- 		- -
Set space-separated list of next-hop IP addresses. Address ordering is important. Also don`t use unnecessary spaces.
-
-
- drop_on_fail - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Drop packets instead of using default routing when the configured next hop becomes unreachable
-
-
- force_order - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Enable next-hop ordering as specified in the address parameter.
-
-
- load_share - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Enable traffic load balancing across a maximum of 32 next-hop addresses
-
-
- peer_address - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
BGP prefix next hop is set to the local address of the peer.
-
If no next hop is set in the route map, the next hop is set to the one stored in the path.
-
-
- redist_unchanged - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set for next-hop address conservation for non-local generated routes.
-
Used with redistribute command. Available to maintain BGP routing compliant with RFC 4271 on Nexus OS.
-
-
- unchanged - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set for next-hop address conservation in eBGP outgoing updates
-
-
- verify_availability - -
- list - / elements=dictionary -
- 		- -
Set next-hop ip address tracking with IP SLA
-
-
- address - -
- string - / required -
- 		- -
Set one next-hop address
-
-
- drop_on_fail - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Drop packets instead of using default routing when the configured next hop becomes unreachable
-
-
- force_order - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Enable next-hop ordering as specified in the address parameter.
-
-
- load_share - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Enable traffic load balancing across a maximum of 32 next-hop addresses
-
-
- track - -
- integer - / required -
- 		- -
Set track number
-
-
- precedence - -
- string -
- 		- -
Set precedence field.
-
-
- ipv6 - -
- dictionary -
- 		- -
Configure IPv6 features.
-
-
- address - -
- dictionary -
- 		- -
Specify IP address.
-
-
- prefix_list - -
- string -
- 		- -
Name of prefix list (Max Size 63).
-
-
- precedence - -
- string -
- 		- -
Set precedence field.
-
-
- label_index - -
- integer -
- 		- -
Set Segment Routing (SR) label index of route.
-
-
- level - -
- string -
- 		-
    Choices: -
  • level-1
    • -
  • level-1-2
    • -
  • level-2
    • -
- 		-
Where to import route.
-
-
- local_preference - -
- integer -
- 		- -
BGP local preference path attribute.
-
-
- metric - -
- dictionary -
- 		- -
Set metric for destination routing protocol.
-
-
- bandwidth - -
- integer -
- 		- -
Metric value or Bandwidth in Kbits per second (Max Size 11).
-
-
- igrp_delay_metric - -
- integer -
- 		- -
IGRP delay metric.
-
-
- igrp_effective_bandwidth_metric - -
- integer -
- 		- -
IGRP Effective bandwidth metric (Loading) 255 is 100%.
-
-
- igrp_mtu - -
- integer -
- 		- -
IGRP MTU of the path.
-
-
- igrp_reliability_metric - -
- integer -
- 		- -
IGRP reliability metric where 255 is 100 percent reliable.
-
-
- metric_type - -
- string -
- 		-
    Choices: -
  • external
    • -
  • internal
    • -
  • type-1
    • -
  • type-2
    • -
- 		-
Type of metric for destination routing protocol.
-
-
- nssa_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
OSPF NSSA Areas.
-
-
- null_interface - -
- string -
- 		- -
Output Null interface.
-
-
- origin - -
- string -
- 		-
    Choices: -
  • egp
    • -
  • igp
    • -
  • incomplete
    • -
- 		-
BGP origin code.
-
-
- path_selection - -
- string -
- 		-
    Choices: -
  • all
    • -
  • backup
    • -
  • best2
    • -
  • multipaths
    • -
- 		-
Path selection criteria for BGP.
-
-
- tag - -
- integer -
- 		- -
Tag value for destination routing protocol.
-
-
- weight - -
- integer -
- 		- -
BGP weight for routing table.
-
-
- route_map - -
- string -
- 		- -
Route-map name.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^route-map'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
With state replaced, for the listed route-maps, sequences that are in running-config but not in the task are negated.
-
With state overridden, all route-maps that are in running-config but not in the task are negated.
-
Please refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - Unsupported for Cisco MDS - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k-rdo# show running-config | section "^route-map" - # nxos-9k-rdo# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_route_maps: - config: - - route_map: rmap1 - entries: - - sequence: 10 - action: permit - description: rmap1-10-permit - match: - ip: - address: - access_list: acl_1 - as_path: Allow40 - as_number: - asn: 65564 - - - sequence: 20 - action: deny - description: rmap1-20-deny - match: - community: - community_list: - - BGPCommunity1 - - BGPCommunity2 - ip: - address: - prefix_lists: - - AllowPrefix1 - - AllowPrefix2 - set: - dampening: - half_life: 30 - start_reuse_route: 1500 - start_suppress_route: 10000 - max_suppress_time: 120 - - - route_map: rmap2 - entries: - - sequence: 20 - action: permit - description: rmap2-20-permit - continue_sequence: 40 - match: - ipv6: - address: - prefix_lists: AllowIPv6Prefix - interfaces: "{{ nxos_int1 }}" - set: - as_path: - prepend: - as_number: - - 65563 - - 65568 - - 65569 - comm_list: BGPCommunity - - - sequence: 40 - action: deny - description: rmap2-40-deny - match: - route_types: - - level-1 - - level-2 - tags: 2 - ip: - multicast: - rp: - prefix: 192.0.2.0/24 - rp_type: ASM - source: 203.0.113.0/24 - group_range: - first: 239.0.0.1 - last: 239.255.255.255 - - - route_map: rmap3 - entries: - - sequence: 10 - description: "*** first stanza ***" - action: permit - set: - ip: - next_hop: - verify_availability: - - address: 3.3.3.3 - track: 1 - - address: 4.4.4.4 - track: 3 - - - sequence: 20 - description: "*** second stanza ***" - action: permit - set: - ip: - next_hop: - address: 6.6.6.6 2.2.2.2 - load_share: true - drop_on_fail: true - - - sequence: 30 - description: "*** third stanza ***" - action: permit - set: - ip: - next_hop: - peer_address: true - - - sequence: 40 - description: "*** fourth stanza ***" - action: permit - set: - ip: - next_hop: - unchanged: true - redist_unchanged: true - state: merged - - # Task output - # ------------- - # before: [] - # - # commands: - # - "route-map rmap1 permit 10" - # - "match as-number 65564" - # - "match as-path Allow40" - # - "match ip address acl_1" - # - "description rmap1-10-permit" - # - "route-map rmap1 deny 20" - # - "match community BGPCommunity1 BGPCommunity2" - # - "match ip address prefix-list AllowPrefix1 AllowPrefix2" - # - "description rmap1-20-deny" - # - "set dampening 30 1500 10000 120" - # - "route-map rmap2 permit 20" - # - "match interface Ethernet1/1" - # - "match ipv6 address prefix-list AllowIPv6Prefix" - # - "set as-path prepend 65563 65568 65569" - # - "description rmap2-20-permit" - # - "continue 40" - # - "set comm-list BGPCommunity delete" - # - "route-map rmap2 deny 40" - # - "match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM" - # - "match route-type level-1 level-2" - # - "match tag 2" - # - "description rmap2-40-deny" - # - "route-map rmap3 permit 10" - # - "description *** first stanza ***" - # - "set ip next-hop verify-availability 3.3.3.3 track 1" - # - "set ip next-hop verify-availability 4.4.4.4 track 3" - # - "route-map rmap3 permit 20" - # - "description *** second stanza ***" - # - "set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail" - # - "route-map rmap3 permit 30" - # - "description *** third stanza ***" - # - "set ip next-hop peer-address" - # - "route-map rmap3 permit 40" - # - "description *** fourth stanza ***" - # - "set ip next-hop unchanged" - # - "set ip next-hop redist-unchanged" - # - # after: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # - route_map: rmap3 - # entries: - # - sequence: 10 - # description: "*** first stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # verify_availability: - # - address: 3.3.3.3 - # track: 1 - # - address: 4.4.4.4 - # track: 3 - # - # - sequence: 20 - # description: "*** second stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # address: 6.6.6.6 2.2.2.2 - # load_share: true - # drop_on_fail: true - # - # - sequence: 30 - # description: "*** third stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # peer_address: true - # - # - sequence: 40 - # description: "*** fourth stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # unchanged: true - # redist_unchanged: true - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - # route-map rmap3 permit 10 - # description *** first stanza *** - # set ip next-hop verify-availability 3.3.3.3 track 1 - # set ip next-hop verify-availability 4.4.4.4 track 3 - # route-map rmap3 permit 20 - # description *** second stanza *** - # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail - # route-map rmap3 permit 30 - # description *** third stanza *** - # set ip next-hop peer-address - # route-map rmap3 permit 40 - # description *** fourth stanza *** - # set ip next-hop unchanged - # set ip next-hop redist-unchanged - # - # Using replaced - # (for the listed route-map(s), sequences that are in running-config but not in the task are negated) - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - # route-map rmap3 permit 10 - # description *** first stanza *** - # set ip next-hop verify-availability 3.3.3.3 track 1 - # set ip next-hop verify-availability 4.4.4.4 track 3 - # route-map rmap3 permit 20 - # description *** second stanza *** - # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail - # route-map rmap3 permit 30 - # description *** third stanza *** - # set ip next-hop peer-address - # route-map rmap3 permit 40 - # description *** fourth stanza *** - # set ip next-hop unchanged - # set ip next-hop redist-unchanged - # - - name: Replace route-maps configurations of listed route-maps with provided configurations - cisco.nxos.nxos_route_maps: - config: - - route_map: rmap1 - entries: - - sequence: 20 - action: deny - description: rmap1-20-deny - match: - community: - community_list: - - BGPCommunity4 - - BGPCommunity5 - ip: - address: - prefix_lists: - - AllowPrefix1 - set: - community: - local_as: true - - - route_map: rmap3 - entries: - - sequence: 10 - description: "*** first stanza ***" - action: permit - set: - ip: - next_hop: - verify_availability: - - address: 3.3.3.3 - track: 1 - - sequence: 20 - description: "*** second stanza ***" - action: permit - set: - ip: - next_hop: - peer_address: true - - sequence: 30 - description: "*** third stanza ***" - action: permit - set: - ip: - next_hop: - address: 6.6.6.6 2.2.2.2 - load_share: true - drop_on_fail: true - state: replaced - - # Task output - # ------------- - # before: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # - route_map: rmap3 - # entries: - # - sequence: 10 - # description: "*** first stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # verify_availability: - # - address: 3.3.3.3 - # track: 1 - # - address: 4.4.4.4 - # track: 3 - # - # - sequence: 20 - # description: "*** second stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # address: 6.6.6.6 2.2.2.2 - # load_share: true - # drop_on_fail: true - # - # - sequence: 30 - # description: "*** third stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # peer_address: true - # - # - sequence: 40 - # description: "*** fourth stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # unchanged: true - # redist_unchanged: true - # - # commands: - # - no route-map rmap1 permit 10 - # - route-map rmap1 deny 20 - # - no match community BGPCommunity1 BGPCommunity2 - # - match community BGPCommunity4 BGPCommunity5 - # - no match ip address prefix-list AllowPrefix1 AllowPrefix2 - # - match ip address prefix-list AllowPrefix1 - # - no set dampening 30 1500 10000 120 - # - set community local-AS - # - route-map rmap3 permit 10 - # - no set ip next-hop verify-availability 4.4.4.4 track 3 - # - route-map rmap3 permit 20 - # - no set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail - # - set ip next-hop peer-address - # - route-map rmap3 permit 30 - # - no set ip next-hop peer-address - # - set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail - # - no route-map rmap3 permit 40 - # - # after: - # - route_map: rmap1 - # entries: - # - sequence: 20 - # action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity4 - # - BGPCommunity5 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # set: - # community: - # local_as: true - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # - route_map: rmap3 - # entries: - # - sequence: 10 - # description: "*** first stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # verify_availability: - # - address: 3.3.3.3 - # track: 1 - # - sequence: 20 - # description: "*** second stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # peer_address: true - # - sequence: 30 - # description: "*** third stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # address: 6.6.6.6 2.2.2.2 - # load_share: true - # drop_on_fail: true - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 deny 20 - # description rmap1-20-deny - # match community BGPCommunity4 BGPCommunity5 - # match ip address prefix-list AllowPrefix1 - # set community local-AS - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - # route-map rmap3 permit 10 - # description *** first stanza *** - # set ip next-hop verify-availability 3.3.3.3 track 1 - # route-map rmap3 permit 20 - # description *** second stanza *** - # set ip next-hop peer-address - # route-map rmap3 permit 30 - # description *** third stanza *** - # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail - - # Using overridden - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - - - name: Override all route-maps configuration with provided configuration - cisco.nxos.nxos_route_maps: - config: - - route_map: rmap1 - entries: - - sequence: 20 - action: deny - description: rmap1-20-deny - match: - community: - community_list: - - BGPCommunity4 - - BGPCommunity5 - ip: - address: - prefix_lists: - - AllowPrefix1 - set: - community: - local_as: true - state: overridden - - # Task output - # ------------- - # before: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # commands: - # - no route-map rmap1 permit 10 - # - route-map rmap1 deny 20 - # - no match community BGPCommunity1 BGPCommunity2 - # - match community BGPCommunity4 BGPCommunity5 - # - no match ip address prefix-list AllowPrefix1 AllowPrefix2 - # - match ip address prefix-list AllowPrefix1 - # - no set dampening 30 1500 10000 120 - # - set community local-AS - # - no route-map rmap2 permit 20 - # - no route-map rmap2 deny 40 - # - # after: - # - route_map: rmap1 - # entries: - # - sequence: 20 - # action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity4 - # - BGPCommunity5 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # set: - # community: - # local_as: true - # - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^route-map" - # route-map rmap1 deny 20 - # description rmap1-20-deny - # match community BGPCommunity4 BGPCommunity5 - # match ip address prefix-list AllowPrefix1 - # set community local-AS - - # Using deleted to delete a single route-map - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - - - name: Delete single route-map - cisco.nxos.nxos_route_maps: - config: - - route_map: rmap1 - state: deleted - - # Task output - # ------------- - # before: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # commands: - # - no route-map rmap1 permit 10 - # - no route-map rmap1 deny 20 - # - # after: - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^route-map" - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - - # Using deleted to delete all route-maps from the device running-config - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - - - name: Delete all route-maps - cisco.nxos.nxos_route_maps: - state: deleted - - # Task output - # ------------- - # before: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # commands: - # - no route-map rmap1 permit 10 - # - no route-map rmap1 deny 20 - # - no route-map rmap2 permit 20 - # - no route-map rmap2 deny 40 - # - # after: [] - # - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^route-map" - - - name: Render platform specific configuration lines with state rendered (without connecting to the device) - cisco.nxos.nxos_route_maps: - config: - - route_map: rmap1 - entries: - - sequence: 10 - action: permit - description: rmap1-10-permit - match: - ip: - address: - access_list: acl_1 - as_path: Allow40 - as_number: - asn: 65564 - - - sequence: 20 - action: deny - description: rmap1-20-deny - match: - community: - community_list: - - BGPCommunity1 - - BGPCommunity2 - ip: - address: - prefix_lists: - - AllowPrefix1 - - AllowPrefix2 - set: - dampening: - half_life: 30 - start_reuse_route: 1500 - start_suppress_route: 10000 - max_suppress_time: 120 - - - route_map: rmap2 - entries: - - sequence: 20 - action: permit - description: rmap2-20-permit - continue_sequence: 40 - match: - ipv6: - address: - prefix_lists: AllowIPv6Prefix - interfaces: "{{ nxos_int1 }}" - set: - as_path: - prepend: - as_number: - - 65563 - - 65568 - - 65569 - comm_list: BGPCommunity - - - sequence: 40 - action: deny - description: rmap2-40-deny - match: - route_types: - - level-1 - - level-2 - tags: 2 - ip: - multicast: - rp: - prefix: 192.0.2.0/24 - rp_type: ASM - source: 203.0.113.0/24 - group_range: - first: 239.0.0.1 - last: 239.255.255.255 - state: rendered - - # Task Output (redacted) - # ----------------------- - # rendered: - # - "route-map rmap1 permit 10" - # - "match as-number 65564" - # - "match as-path Allow40" - # - "match ip address acl_1" - # - "description rmap1-10-permit" - # - "route-map rmap1 deny 20" - # - "match community BGPCommunity1 BGPCommunity2" - # - "match ip address prefix-list AllowPrefix1 AllowPrefix2" - # - "description rmap1-20-deny" - # - "set dampening 30 1500 10000 120" - # - "route-map rmap2 permit 20" - # - "match interface Ethernet1/1" - # - "match ipv6 address prefix-list AllowIPv6Prefix" - # - "set as-path prepend 65563 65568 65569" - # - "description rmap2-20-permit" - # - "continue 40" - # - "set comm-list BGPCommunity delete" - # - "route-map rmap2 deny 40" - # - "match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM" - # - "match route-type level-1 level-2" - # - "match tag 2" - # - "description rmap2-40-deny" - - # Using parsed - - # parsed.cfg - # ------------ - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - - - name: Parse externally provided route-maps configuration - cisco.nxos.nxos_route_maps: - running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - - # Using gathered - - # Existing route-map config - # --------------------------- - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - - - name: Gather route-maps facts using gathered - cisco.nxos.nxos_route_maps: - state: gathered - - # gathered: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['route-map rmap1 permit 10', 'match as-number 65564', 'match as-path Allow40', 'match ip address acl_1', 'description rmap1-10-permit', 'route-map rmap1 deny 20', 'match community BGPCommunity1 BGPCommunity2']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_rpm_module.rst b/docs/cisco.nxos.nxos_rpm_module.rst deleted file mode 100644 index 79d616a59..000000000 --- a/docs/cisco.nxos.nxos_rpm_module.rst +++ /dev/null @@ -1,226 +0,0 @@ -.. _cisco.nxos.nxos_rpm_module: - - -******************* -cisco.nxos.nxos_rpm -******************* - -**Install patch or feature rpms on Cisco NX-OS devices.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Install software maintenance upgrade (smu) RPMS and 3rd party RPMS on Cisco NX-OS devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
List of RPM/patch definitions.
-
-
- file_system - -
- string -
- 		- -
The remote file system of the device. If omitted, devices that support a file_system parameter will use their default values.
-
-
- pkg - -
- string - / required -
- 		- -
Name of the RPM package.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
- 		-
If the state is present, the rpm will be installed, If the state is absent, it will be removed.
-
-
- file_system - -
- string -
- 		- Default:
"bootflash"
- 		-
The remote file system of the device. If omitted, devices that support a file_system parameter will use their default values.
-
-
- pkg - -
- string -
- 		- -
Name of the RPM package.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
If the state is present, the rpm will be installed, If the state is absent, it will be removed.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.0(3)I2(5), 7.0(3)I4(6), 7.0(3)I5(3), 7.0(3)I6(1), 7.0(3)I7(3) - - Unsupported for Cisco MDS - - For patches, the minimum platform version needed is 7.0(3)I2(5) - - For feature rpms, the minimum platform version needed is 7.0(3)I6(1) - - The module manages the entire RPM lifecycle (Add, activate, commit, deactivate, remove) - - For reload patches, this module is NOT idempotent until the patch is committed. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_rpm: - pkg: nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000.rpm - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['install add bootflash:nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000.rpm forced', 'install activate nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000 forced', 'install commit nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Sai Chintalapudi (@saichint) diff --git a/docs/cisco.nxos.nxos_snapshot_module.rst b/docs/cisco.nxos.nxos_snapshot_module.rst deleted file mode 100644 index fe89b5b7b..000000000 --- a/docs/cisco.nxos.nxos_snapshot_module.rst +++ /dev/null @@ -1,363 +0,0 @@ -.. _cisco.nxos.nxos_snapshot_module: - - -************************ -cisco.nxos.nxos_snapshot -************************ - -**Manage snapshots of the running states of selected features.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Create snapshots of the running states of selected features, add new show commands for snapshot creation, delete and compare existing snapshots. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- action - -
- string - / required -
- 		-
    Choices: -
  • add
    • -
  • compare
    • -
  • create
    • -
  • delete
    • -
  • delete_all
    • -
- 		-
Define what snapshot action the module would perform.
-
-
- compare_option - -
- string -
- 		-
    Choices: -
  • summary
    • -
  • ipv4routes
    • -
  • ipv6routes
    • -
- 		-
Snapshot options to be used when action=compare.
-
-
- comparison_results_file - -
- string -
- 		- -
Name of the file where snapshots comparison will be stored when action=compare.
-
-
- description - -
- string -
- 		- -
Snapshot description to be used when action=create.
-
-
- element_key1 - -
- string -
- 		- -
Specify the tags used to distinguish among row entries, to be used when action=add.
-
-
- element_key2 - -
- string -
- 		- -
Specify the tags used to distinguish among row entries, to be used when action=add.
-
-
- path - -
- string -
- 		- Default:
"./"
- 		-
Specify the path of the file where new created snapshot or snapshots comparison will be stored, to be used when action=create and save_snapshot_locally=true or action=compare.
-
-
- row_id - -
- string -
- 		- -
Specifies the tag of each row entry of the show command's XML output, to be used when action=add.
-
-
- save_snapshot_locally - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Specify to locally store a new created snapshot, to be used when action=create.
-
-
- section - -
- string -
- 		- -
Used to name the show command output, to be used when action=add.
-
-
- show_command - -
- string -
- 		- -
Specify a new show command, to be used when action=add.
-
-
- snapshot1 - -
- string -
- 		- -
First snapshot to be used when action=compare.
-
-
- snapshot2 - -
- string -
- 		- -
Second snapshot to be used when action=compare.
-
-
- snapshot_name - -
- string -
- 		- -
Snapshot name, to be used when action=create or action=delete.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - ``transport=cli`` may cause timeout errors. - - The ``element_key1`` and ``element_key2`` parameter specify the tags used to distinguish among row entries. In most cases, only the element_key1 parameter needs to specified to be able to distinguish among row entries. - - ``action=compare`` will always store a comparison report on a local file. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Create a snapshot and store it locally - - cisco.nxos.nxos_snapshot: - action: create - snapshot_name: test_snapshot - description: Done with Ansible - save_snapshot_locally: true - path: /home/user/snapshots/ - - # Delete a snapshot - - cisco.nxos.nxos_snapshot: - action: delete - snapshot_name: test_snapshot - - # Delete all existing snapshots - - cisco.nxos.nxos_snapshot: - action: delete_all - - # Add a show command for snapshots creation - - cisco.nxos.nxos_snapshot: - section: myshow - show_command: show ip interface brief - row_id: ROW_intf - element_key1: intf-name - - # Compare two snapshots - - cisco.nxos.nxos_snapshot: - action: compare - snapshot1: pre_snapshot - snapshot2: post_snapshot - comparison_results_file: compare_snapshots.txt - compare_option: summary - path: ../snapshot_reports/ - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		verbose mode -
commands sent to the device
-
-
Sample:
-
['snapshot create post_snapshot Post-snapshot']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_community_module.rst b/docs/cisco.nxos.nxos_snmp_community_module.rst deleted file mode 100644 index 584d2d772..000000000 --- a/docs/cisco.nxos.nxos_snmp_community_module.rst +++ /dev/null @@ -1,201 +0,0 @@ -.. _cisco.nxos.nxos_snmp_community_module: - - -****************************** -cisco.nxos.nxos_snmp_community -****************************** - -**(deprecated, removed after 2024-01-01) Manages SNMP community configs.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated modules released with more functionality -:Alternative: nxos_snmp_server - - - -Synopsis --------- -- Manages SNMP community configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- access - -
- string -
- 		-
    Choices: -
  • ro
    • -
  • rw
    • -
- 		-
Access type for community.
-
-
- acl - -
- string -
- 		- -
ACL name to filter snmp requests or keyword 'default'.
-
-
- community - -
- string - / required -
- 		- -
Case-sensitive community string.
-
-
- group - -
- string -
- 		- -
Group to which the community belongs.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure snmp community is configured - - cisco.nxos.nxos_snmp_community: - community: TESTING7 - group: network-operator - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['snmp-server community TESTING7 group network-operator']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_host_module.rst b/docs/cisco.nxos.nxos_snmp_host_module.rst deleted file mode 100644 index 8aef0b21d..000000000 --- a/docs/cisco.nxos.nxos_snmp_host_module.rst +++ /dev/null @@ -1,288 +0,0 @@ -.. _cisco.nxos.nxos_snmp_host_module: - - -************************* -cisco.nxos.nxos_snmp_host -************************* - -**(deprecated, removed after 2024-01-01) Manages SNMP host configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated modules released with more functionality -:Alternative: nxos_snmp_server - - - -Synopsis --------- -- Manages SNMP host configuration parameters. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- community - -
- string -
- 		- -
Community string or v3 username.
-
-
- snmp_host - -
- string - / required -
- 		- -
IP address of hostname of target host.
-
-
- snmp_type - -
- string -
- 		-
    Choices: -
  • trap
    • -
  • inform
    • -
- 		-
type of message to send to host. If this is not specified, trap type is used.
-
-
- src_intf - -
- string -
- 		- -
Source interface. Must be fully qualified interface name. If state = absent, the interface is removed.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource. If state = present, the host is added to the configuration. If only vrf and/or vrf_filter and/or src_intf are given, they will be added to the existing host configuration. If state = absent, the host is removed if community parameter is given. It is possible to remove only vrf and/or src_int and/or vrf_filter by providing only those parameters and no community parameter.
-
-
- udp - -
- string -
- 		- Default:
"162"
- 		-
UDP port number (0-65535).
-
-
- v3 - -
- string -
- 		-
    Choices: -
  • noauth
    • -
  • auth
    • -
  • priv
    • -
- 		-
Use this when verion is v3. SNMPv3 Security level.
-
-
- version - -
- string -
- 		-
    Choices: -
  • v1
    • -
  • v2c
    • -
  • v3
    • -
- 		-
SNMP version. If this is not specified, v1 is used.
-
-
- vrf - -
- string -
- 		- -
VRF to use to source traffic to source. If state = absent, the vrf is removed.
-
-
- vrf_filter - -
- string -
- 		- -
Name of VRF to filter. If state = absent, the vrf is removed from the filter.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - ``state=absent`` removes the host configuration if it is configured. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure snmp host is configured - - cisco.nxos.nxos_snmp_host: - snmp_host: 192.0.2.3 - community: TESTING - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['snmp-server host 192.0.2.3 filter-vrf another_test_vrf']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_location_module.rst b/docs/cisco.nxos.nxos_snmp_location_module.rst deleted file mode 100644 index 06f564693..000000000 --- a/docs/cisco.nxos.nxos_snmp_location_module.rst +++ /dev/null @@ -1,156 +0,0 @@ -.. _cisco.nxos.nxos_snmp_location_module: - - -***************************** -cisco.nxos.nxos_snmp_location -***************************** - -**(deprecated, removed after 2024-01-01) Manages SNMP location information.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated modules released with more functionality -:Alternative: nxos_snmp_server - - - -Synopsis --------- -- Manages SNMP location configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- location - -
- string - / required -
- 		- -
Location information.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure snmp location is configured - - cisco.nxos.nxos_snmp_location: - location: Test - state: present - - # ensure snmp location is not configured - - cisco.nxos.nxos_snmp_location: - location: Test - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['snmp-server location New_Test']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_server_module.rst b/docs/cisco.nxos.nxos_snmp_server_module.rst deleted file mode 100644 index 126e16341..000000000 --- a/docs/cisco.nxos.nxos_snmp_server_module.rst +++ /dev/null @@ -1,4474 +0,0 @@ -.. _cisco.nxos.nxos_snmp_server_module: - - -*************************** -cisco.nxos.nxos_snmp_server -*************************** - -**SNMP Server resource module.** - - -Version added: 2.8.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages SNMP server configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A dict of SNMP server configuration
-
-
- aaa_user - -
- dictionary -
- 		- -
Set duration for which aaa-cached snmp user exists.
-
-
- cache_timeout - -
- integer -
- 		- -
Timeout for which aaa-cached user exists(in secs).
-
-
- communities - -
- list - / elements=dictionary -
- 		- -
Set community string and access privs.
-
-
- group - -
- string -
- 		- -
Group to which the community belongs.
-
-
- name - -
- string -
- 		- -
SNMP community string (Max Size 32).
-

aliases: community
-
-
- ro - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Read-only access with this community string.
-
-
- rw - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Read-write access with this community string.
-
-
- use_ipv4acl - -
- string -
- 		- -
Specify IPv4 ACL, the ACL name specified must be IPv4 ACL.
-
This option is unsupported on MDS switches.
-
-
- use_ipv6acl - -
- string -
- 		- -
Specify IPv6 ACL, the ACL name specified after must be IPv6 ACL.
-
This option is unsupported on MDS switches.
-
-
- contact - -
- string -
- 		- -
Modify sysContact.
-
-
- context - -
- dictionary -
- 		- -
SNMP context to be mapped.
-
-
- instance - -
- string -
- 		- -
Name of the protocol instance (Max Size 32).
-
-
- name - -
- string -
- 		- -
Name of the SNMP context (Max Size 32).
-
-
- topology - -
- string -
- 		- -
Topology associated with the SNMP context.
-
-
- vrf - -
- string -
- 		- -
VRF associated with the SNMP context.
-
This option is unsupported on MDS switches.
-
-
- counter - -
- dictionary -
- 		- -
Configure port counter configuration.
-
This option is unsupported on MDS switches.
-
-
- cache - -
- dictionary -
- 		- -
Port stats cache.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable port stats cache.
-
-
- timeout - -
- integer -
- 		- -
Timeout for which cached port stats exists(in secs).
-
-
- drop - -
- dictionary -
- 		- -
Silently drop unknown v3 user packets.
-
This option is unsupported on MDS switches.
-
-
- unknown_engine_id - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Unknown v3 engine id.
-
-
- unknown_user - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Unknown v3 user.
-
-
- engine_id - -
- dictionary -
- 		- -
Configure a local SNMPv3 engineID.
-
This option is unsupported on MDS switches.
-
-
- local - -
- string -
- 		- -
EngineID of the local agent.
-
-
- global_enforce_priv - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Globally enforce privacy for all the users.
-
-
- hosts - -
- list - / elements=dictionary -
- 		- -
Specify hosts to receive SNMP notifications.
-
SNMP hosts config lines that appear separately in running-config must be added as individual dictionaries.
-
-
- auth - -
- string -
- 		- -
Use the SNMPv3 authNoPriv Security Level.
-
-
- community - -
- string -
- 		- -
SNMP community string or SNMPv3 user name (Max Size 32).
-
-
- filter_vrf - -
- string -
- 		- -
Filters notifications to the notification host receiver based on the configured VRF.
-
This option is unsupported on MDS switches.
-
-
- host - -
- string -
- 		- -
IPv4 or IPv6 address or DNS Name of SNMP notification host.
-
-
- informs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Inform messages to this host.
-
-
- priv - -
- string -
- 		- -
Use the SNMPv3 authPriv Security Level.
-
-
- source_interface - -
- string -
- 		- -
Source interface to be used for sending out SNMP notifications to this host.
-
-
- traps - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Traps messages to this host.
-
-
- udp_port - -
- integer -
- 		- -
The notification host's UDP port number.
-
-
- use_vrf - -
- string -
- 		- -
Configures SNMP to use the selected VRF to communicate with the host receiver.
-
This option is unsupported on MDS switches.
-
-
- version - -
- string -
- 		-
    Choices: -
  • 1
    • -
  • 2c
    • -
  • 3
    • -
- 		-
SNMP version to use for notification messages.
-
-
- location - -
- string -
- 		- -
Modify sysLocation.
-
-
- mib - -
- dictionary -
- 		- -
Mib access parameters.
-
-
- community_map - -
- dictionary -
- 		- -
SNMP community.
-
-
- community - -
- string -
- 		- -
SNMP community string (Max Size 32).
-
-
- context - -
- string -
- 		- -
Name of the SNMP context (Max Size 32).
-
-
- packetsize - -
- integer -
- 		- -
Largest SNMP packet size
-
-
- protocol - -
- dictionary -
- 		- -
Snmp protocol operations.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable snmp protocol operations.
-
-
- source_interface - -
- dictionary -
- 		- -
Source interface to be used for sending out SNMP notifications.
-
This option is unsupported on MDS switches.
-
-
- informs - -
- string -
- 		- -
SNMP Inform notifications for which this source interface needs to be used.
-
-
- traps - -
- string -
- 		- -
SNMP Trap notifications for which this source interface needs to be used.
-
-
- system_shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure snmp-server for reload(2).
-
-
- tcp_session - -
- dictionary -
- 		- -
Enable one time authentication for snmp over tcp session.
-
-
- auth - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable one time authentication for snmp over tcp session.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable tcp-session.
-
This option is unsupported on MDS switches.
-
-
- traps - -
- dictionary -
- 		- -
Enable SNMP Traps
-
-
- aaa - -
- dictionary -
- 		- -
AAA traps
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable AAA traps.
-
-
- server_state_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
AAA server state change notification.
-
-
- bgp - -
- dictionary -
- 		- -
SNMP BGP traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP BGP traps.
-
-
- bridge - -
- dictionary -
- 		- -
Bridge traps.
-
This option is unsupported on MDS switches.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable bridge traps.
-
-
- newroot - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP STP Bridge MIB newroot traps.
-
-
- topologychange - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP STP Bridge MIB topologychange traps.
-
-
- callhome - -
- dictionary -
- 		- -
Callhome traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable callhome traps.
-
This option is unsupported on MDS switches.
-
-
- event_notify - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Callhome External Event Notification.
-
-
- smtp_send_fail - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
SMTP Message Send Fail notification.
-
-
- cfs - -
- dictionary -
- 		- -
CFS traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable cfs traps.
-
This option is unsupported on MDS switches.
-
-
- merge_failure - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Merge failure notification.
-
-
- state_change_notif - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
State change notification.
-
-
- config - -
- dictionary -
- 		- -
Config traps.
-
-
- ccmCLIRunningConfigChanged - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Running config change trap.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable config traps.
-
This option is unsupported on MDS switches.
-
-
- entity - -
- dictionary -
- 		- -
Entity traps.
-
-
- cefcMIBEnableStatusNotification - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
CefcMIBEnableStatusNotification.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable entity traps.
-
-
- entity_fan_status_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Fan Status Change.
-
-
- entity_mib_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity MIB change.
-
-
- entity_module_inserted - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Module Inserted.
-
-
- entity_module_removed - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Module Removed.
-
-
- entity_module_status_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Module Status Change.
-
-
- entity_power_out_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Power Out Change.
-
-
- entity_power_status_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Power Status Change.
-
-
- entity_sensor - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity sensor.
-
-
- entity_unrecognised_module - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Unrecognised Module.
-
-
- feature_control - -
- dictionary -
- 		- -
Feature-Control traps.
-
-
- ciscoFeatOpStatusChange - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Feature operation status change Notification.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable feature-control traps.
-
This option is unsupported on MDS switches.
-
-
- featureOpStatusChange - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Feature operation status change notification.
-
-
- generic - -
- dictionary -
- 		- -
Generic traps.
-
-
- coldStart - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Generic coldStart trap.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable generic traps.
-
This option is unsupported on MDS switches.
-
-
- warmStart - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Generic warmStart trap.
-
-
- license - -
- dictionary -
- 		- -
License traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable license traps.
-
This option is unsupported on MDS switches.
-
-
- notify_license_expiry - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
License Expiry Notification.
-
-
- notify_license_expiry_warning - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
License Expiry Warning Notification.
-
-
- notify_licensefile_missing - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
License File Missing Notification.
-
-
- notify_no_license_for_feature - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
No License installed for feature Notification.
-
-
- link - -
- dictionary -
- 		- -
Link traps.
-
-
- cErrDisableInterfaceEventRev1 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Err-disable state notification.
-
This option is unsupported on MDS switches.
-
-
- cieLinkDown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Cisco extended link state down notification.
-
-
- cieLinkUp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Cisco extended link state up notification.
-
-
- cisco_xcvr_mon_status_chg - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Cisco interface transceiver monitor status change notification.
-
-
- cmn_mac_move_notification - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Mac addr move trap.
-
This option is unsupported on MDS switches.
-
-
- delayed_link_state_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Delayed link state change.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable link traps.
-
This option is unsupported on MDS switches.
-
-
- extended_linkDown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IETF extended link state down notification.
-
-
- extended_linkUp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IETF extended link state up notification.
-
-
- linkDown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IETF Link state down notification.
-
-
- linkUp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IETF Link state up notification.
-
-
- mmode - -
- dictionary -
- 		- -
MMode traps.
-
This option is unsupported on MDS switches.
-
-
- cseMaintModeChangeNotify - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Maint Mode Change Notification.
-
-
- cseNormalModeChangeNotify - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Normal Mode Change Notification.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable mmode traps.
-
-
- ospf - -
- dictionary -
- 		- -
SNMP OSPF traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP OSPF traps.
-
-
- ospfv3 - -
- dictionary -
- 		- -
SNMP OSPFv3 traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP OSPFv3 traps.
-
-
- rf - -
- dictionary -
- 		- -
RF traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable rf traps.
-
This option is unsupported on MDS switches.
-
-
- redundancy_framework - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Redundancy_Framework (RF) Sup switchover MIB.
-
-
- rmon - -
- dictionary -
- 		- -
RMON traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable rmon traps.
-
This option is unsupported on MDS switches.
-
-
- fallingAlarm - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Rmon falling alarm.
-
-
- hcFallingAlarm - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
High capacity Rmon falling alarm.
-
-
- hcRisingAlarm - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
High capacity Rmon rising alarm.
-
-
- risingAlarm - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Rmon rising alarm.
-
-
- snmp - -
- dictionary -
- 		- -
SNMP traps.
-
-
- authentication - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
SNMP authentication trap.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable snmp traps.
-
This option is unsupported on MDS switches.
-
-
- storm_control - -
- dictionary -
- 		- -
Storm-Control traps.
-
-
- cpscEventRev1 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Port-Storm-Control-Event.
-
This option is unsupported on MDS switches.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable storm-control traps.
-
This option is unsupported on MDS switches.
-
-
- trap_rate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Number of traps per minute.
-
-
- stpx - -
- dictionary -
- 		- -
Stpx traps.
-
This option is unsupported on MDS switches.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable stpx traps.
-
-
- inconsistency - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP STPX MIB InconsistencyUpdate traps.
-
-
- loop_inconsistency - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP STPX MIB LoopInconsistencyUpdate traps.
-
-
- root_inconsistency - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP STPX MIB RootInconsistencyUpdate traps.
-
-
- syslog - -
- dictionary -
- 		- -
Enable syslog traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable syslog traps.
-
This option is unsupported on MDS switches.
-
-
- message_generated - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Message Generated Notification.
-
-
- sysmgr - -
- dictionary -
- 		- -
Sysmgr traps.
-
-
- cseFailSwCoreNotifyExtended - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Software Core Notification.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable sysmgr traps.
-
This option is unsupported on MDS switches.
-
-
- system - -
- dictionary -
- 		- -
System traps.
-
-
- clock_change_notification - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Clock-change-notification traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable system traps.
-
This option is unsupported on MDS switches.
-
-
- upgrade - -
- dictionary -
- 		- -
Upgrade traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable upgrade traps.
-
This option is unsupported on MDS switches.
-
-
- upgradeJobStatusNotify - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Upgrade Job Status Notification.
-
-
- upgradeOpNotifyOnCompletion - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Upgrade Global Status Notification.
-
-
- vtp - -
- dictionary -
- 		- -
VTP traps.
-
This option is unsupported on MDS switches.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable VTP traps.
-
-
- notifs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable vtpConfigRevNumberError vtpConfigDigestEnable vtpConfigRevNumberError vtpConfigDigestError vtpServerDisabled vtpVersionOneDeviceDetected vlanTrunkPortDynamicStatusChange vtpLocalModeChanged vtpVersionInUseChanged notification.
-
-
- vlancreate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable vtpVlanCreated notification.
-
-
- vlandelete - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable vtpVlanDeleted notification.
-
-
- users - -
- dictionary -
- 		- -
Define users who can access the SNMP engine.
-
-
- auth - -
- list - / elements=dictionary -
- 		- -
SNMP User authentication related settings
-
-
- authentication - -
- dictionary -
- 		- -
Authentication parameters for the user.
-
-
- algorithm - -
- string -
- 		-
    Choices: -
  • md5
    • -
  • sha
    • -
  • sha-256
    • -
- 		-
Select algorithm for authentication.
-
-
- engine_id - -
- string -
- 		- -
EngineID for configuring notif target user (for V3 informs).
-
This value needs to be enclosed in quotes in the task.
-
-
- localized_key - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specifies whether the passwords are in localized key format.
-
-
- localizedv2_key - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specifies whether the passwords are in localized V2 key format.
-
-
- password - -
- string -
- 		- -
Authentication password for user (Max Size 127).
-
If this value is localized, it has to be enclosed in quotes in the task.
-
-
- priv - -
- dictionary -
- 		- -
Encryption parameters for the user.
-
-
- aes_128 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use 128-bit AES algorithm for privacy.
-
-
- privacy_password - -
- string -
- 		- -
Privacy password for user (Max Size 130).
-
If this value is localized, it has to be enclosed in quotes in the task.
-
-
- group - -
- string -
- 		- -
Group name (ignored for notif target user) (Max Size 28).
-
-
- user - -
- string -
- 		- -
Name of the user (Max Size 28).
-
-
- use_acls - -
- list - / elements=dictionary -
- 		- -
Set IPv4 and IPv6 ACL to use.
-
-
- ipv4 - -
- string -
- 		- -
Specify IPv4 ACL, the ACL name specified after must be IPv4 ACL.
-
-
- ipv6 - -
- string -
- 		- -
Specify IPv6 ACL, the ACL name specified after must be IPv6 ACL.
-
-
- user - -
- string -
- 		- -
Name of the user (Max Size 28).
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^snmp-server'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
The states replaced and overridden have identical behaviour for this module.
-
Please refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6 on Cisco Nexus Switches. - - This module works with connection ``network_cli`` and ``httpapi``. - - Tested against Cisco MDS NX-OS 9.2(2) with connection ``network_cli``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_snmp_server: - config: - aaa_user: - cache_timeout: 36000 - communities: - - community: public - group: network-operator - - community: private - group: network-admin - contact: nxosswitchadmin@localhost - location: serverroom-1 - traps: - aaa: - server_state_change: true - system: - clock_change_notification: true - hosts: - - host: 192.0.2.1 - traps: true - version: '1' - community: public - - host: 192.0.2.1 - source_interface: Ethernet1/1 - - host: 192.0.2.2 - informs: true - version: '3' - auth: NMS - users: - auth: - - user: snmp_user_1 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - - user: snmp_user_2 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - priv: - privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' - aes_128: true - use_acls: - - user: snmp_user_1 - ipv4: acl1 - ipv6: acl2 - - user: snmp_user_2 - ipv4: acl3 - ipv6: acl4 - - # Task output - # ------------- - # before: - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # - # commands: - # - snmp-server contact nxosswitchadmin@localhost - # - snmp-server location serverroom-1 - # - snmp-server aaa-user cache-timeout 36000 - # - snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # - snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # - snmp-server host 192.0.2.1 traps version 1 public - # - snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # - snmp-server host 192.0.2.2 informs version 3 auth NMS - # - snmp-server community private group network-admin - # - snmp-server community public group network-operator - # - snmp-server enable traps aaa server-state-change - # - snmp-server enable traps system Clock-change-notification - # - # after: - # aaa_user: - # cache_timeout: 36000 - # communities: - # - community: private - # group: network-admin - # - community: public - # group: network-operator - # contact: nxosswitchadmin@localhost - # location: serverroom-1 - # traps: - # aaa: - # server_state_change: true - # system: - # clock_change_notification: true - # hosts: - # - host: 192.0.2.1 - # traps: true - # version: "1" - # community: public - # - # - host: 192.0.2.1 - # source_interface: Ethernet1/1 - # - # - host: 192.0.2.2 - # informs: true - # version: "3" - # auth: NMS - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # - # - user: snmp_user_1 - # group: network-operator - # authentication: - # algorithm: md5 - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # localized_key: true - # - # - authentication: - # algorithm: md5 - # localized_key: true - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # priv: - # aes_128: true - # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" - # group: network-operator - # user: snmp_user_2 - # - # use_acls: - # - user: snmp_user_1 - # ipv4: acl1 - # ipv6: acl2 - # - user: snmp_user_2 - # ipv4: acl3 - # ipv6: acl4 - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server contact nxosswitchadmin@localhost - # snmp-server location serverroom-1 - # snmp-server aaa-user cache-timeout 36000 - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # snmp-server host 192.0.2.1 traps version 1 public - # snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # snmp-server host 192.0.2.2 informs version 3 auth NMS - # snmp-server community private group network-admin - # snmp-server community public group network-operator - # snmp-server enable traps aaa server-state-change - # snmp-server enable traps system Clock-change-notification - - # Using replaced - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server contact nxosswitchadmin@localhost - # snmp-server location serverroom-1 - # snmp-server aaa-user cache-timeout 36000 - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # snmp-server host 192.0.2.1 traps version 1 public - # snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # snmp-server host 192.0.2.2 informs version 3 auth NMS - # snmp-server community private group network-admin - # snmp-server community public group network-operator - # snmp-server enable traps aaa server-state-change - # snmp-server enable traps system Clock-change-notification - - - name: Replace snmp-server configurations of listed snmp-server with provided configurations - cisco.nxos.nxos_snmp_server: - config: - aaa_user: - cache_timeout: 36000 - communities: - - community: public - group: network-operator - - community: secret - group: network-operator - contact: nxosswitchadmin2@localhost - location: serverroom-2 - traps: - aaa: - server_state_change: true - hosts: - - host: 192.0.2.1 - traps: true - version: '1' - community: public - - host: 192.0.2.1 - source_interface: Ethernet1/1 - - host: 192.0.3.2 - informs: true - version: '3' - auth: NMS - users: - auth: - - user: admin - group: network-admin - authentication: - algorithm: md5 - password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - localized_key: true - priv: - privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - - - user: snmp_user_1 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - - - user: snmp_user_2 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - priv: - privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' - aes_128: true - use_acls: - - user: snmp_user_1 - ipv4: acl1 - ipv6: acl2 - state: replaced - - # Task output - # ------------- - # before: - # aaa_user: - # cache_timeout: 36000 - # communities: - # - community: private - # group: network-admin - # - community: public - # group: network-operator - # contact: nxosswitchadmin@localhost - # location: serverroom-1 - # traps: - # aaa: - # server_state_change: true - # system: - # clock_change_notification: true - # hosts: - # - host: 192.0.2.1 - # traps: true - # version: "1" - # community: public - # - # - host: 192.0.2.1 - # source_interface: Ethernet1/1 - # - # - host: 192.0.2.2 - # informs: true - # version: "3" - # auth: NMS - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # - # - user: snmp_user_1 - # group: network-operator - # authentication: - # algorithm: md5 - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # localized_key: true - # - # - authentication: - # algorithm: md5 - # localized_key: true - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # priv: - # aes_128: true - # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" - # group: network-operator - # user: snmp_user_2 - # - # use_acls: - # - user: snmp_user_1 - # ipv4: acl1 - # ipv6: acl2 - # - user: snmp_user_2 - # ipv4: acl3 - # ipv6: acl4 - # - # commands: - # - snmp-server contact nxosswitchadmin2@localhost - # - no snmp-server enable traps system Clock-change-notification - # - snmp-server location serverroom-2 - # - no snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # - no snmp-server host 192.0.2.2 informs version 3 auth NMS - # - snmp-server host 192.0.3.2 informs version 3 auth NMS - # - no snmp-server community private group network-admin - # - snmp-server community secret group network-operator - # - # after: - # aaa_user: - # cache_timeout: 36000 - # communities: - # - community: public - # group: network-operator - # - community: secret - # group: network-operator - # contact: nxosswitchadmin2@localhost - # location: serverroom-2 - # traps: - # aaa: - # server_state_change: true - # hosts: - # - host: 192.0.2.1 - # traps: true - # version: '1' - # community: public - # - host: 192.0.2.1 - # source_interface: Ethernet1/1 - # - host: 192.0.3.2 - # informs: true - # version: '3' - # auth: NMS - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # - # - user: snmp_user_1 - # group: network-operator - # authentication: - # algorithm: md5 - # password: '0x5632724fb8ac3699296af26281e1d0f1' - # localized_key: true - # - # - user: snmp_user_2 - # group: network-operator - # authentication: - # algorithm: md5 - # password: '0x5632724fb8ac3699296af26281e1d0f1' - # localized_key: true - # priv: - # privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' - # aes_128: true - # - # use_acls: - # - user: snmp_user_1 - # ipv4: acl1 - # ipv6: acl2 - # - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server contact nxosswitchadmin2@localhost - # snmp-server location serverroom-2 - # snmp-server aaa-user cache-timeout 36000 - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # snmp-server host 192.0.2.1 traps version 1 public - # snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # snmp-server host 192.0.2.2 informs version 3 auth NMS - # snmp-server community secret group network-operator - # snmp-server community public group network-operator - # snmp-server enable traps aaa server-state-change - # snmp-server enable traps system Clock-change-notification - - # Using deleted - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server contact nxosswitchadmin@localhost - # snmp-server location serverroom-1 - # snmp-server aaa-user cache-timeout 36000 - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # snmp-server host 192.0.2.1 traps version 1 public - # snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # snmp-server host 192.0.2.2 informs version 3 auth NMS - # snmp-server community private group network-admin - # snmp-server community public group network-operator - # snmp-server enable traps aaa server-state-change - # snmp-server enable traps system Clock-change-notification - - - name: Delete SNMP Server configurations from the device (admin user will not be deleted) - cisco.nxos.nxos_snmp_server: - state: deleted - - # Task output - # ------------- - # before: - # aaa_user: - # cache_timeout: 36000 - # communities: - # - community: private - # group: network-admin - # - community: public - # group: network-operator - # contact: nxosswitchadmin@localhost - # location: serverroom-1 - # traps: - # aaa: - # server_state_change: true - # system: - # clock_change_notification: true - # hosts: - # - host: 192.0.2.1 - # traps: true - # version: "1" - # community: public - # - # - host: 192.0.2.1 - # source_interface: Ethernet1/1 - # - # - host: 192.0.2.2 - # informs: true - # version: "3" - # auth: NMS - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # - # - user: snmp_user_1 - # group: network-operator - # authentication: - # algorithm: md5 - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # localized_key: true - # - # - authentication: - # algorithm: md5 - # localized_key: true - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # priv: - # aes_128: true - # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" - # group: network-operator - # user: snmp_user_2 - # - # use_acls: - # - user: snmp_user_1 - # ipv4: acl1 - # ipv6: acl2 - # - user: snmp_user_2 - # ipv4: acl3 - # ipv6: acl4 - # - # commands: - # - no snmp-server contact nxosswitchadmin@localhost - # - no snmp-server location serverroom-1 - # - no snmp-server aaa-user cache-timeout 36000 - # - no snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - # - no snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - no snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - no snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # - no snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # - no snmp-server host 192.0.2.1 traps version 1 public - # - no snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # - no snmp-server host 192.0.2.2 informs version 3 auth NMS - # - no snmp-server community private group network-admin - # - no snmp-server community public group network-operator - # - no snmp-server enable traps aaa server-state-change - # - no snmp-server enable traps system Clock-change-notification - # - # after: - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - - # Using rendered - # --------------- - - - name: Render platform specific configuration lines with state rendered (without connecting to the device) - cisco.nxos.nxos_snmp_server: - config: - aaa_user: - cache_timeout: 36000 - communities: - - community: public - group: network-operator - - community: private - group: network-admin - contact: nxosswitchadmin@localhost - location: serverroom-1 - traps: - aaa: - server_state_change: true - system: - clock_change_notification: true - hosts: - - host: 192.0.2.1 - traps: true - version: '1' - community: public - - host: 192.0.2.1 - source_interface: Ethernet1/1 - - host: 192.0.2.2 - informs: true - version: '3' - auth: NMS - users: - auth: - - user: snmp_user_1 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - - user: snmp_user_2 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - priv: - privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' - aes_128: true - use_acls: - - user: snmp_user_1 - ipv4: acl1 - ipv6: acl2 - - user: snmp_user_2 - ipv4: acl3 - ipv6: acl4 - state: rendered - - - # Task Output (redacted) - # ----------------------- - # rendered: - # - snmp-server contact nxosswitchadmin@localhost - # - snmp-server location serverroom-1 - # - snmp-server aaa-user cache-timeout 36000 - # - snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # - snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # - snmp-server host 192.0.2.1 traps version 1 public - # - snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # - snmp-server host 192.0.2.2 informs version 3 auth NMS - # - snmp-server community private group network-admin - # - snmp-server community public group network-operator - # - snmp-server enable traps aaa server-state-change - # - snmp-server enable traps system Clock-change-notification - - # Using parsed - - # parsed.cfg - # ------------ - # snmp-server contact nxosswitchadmin@localhost - # snmp-server location serverroom-1 - # snmp-server aaa-user cache-timeout 36000 - # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # snmp-server host 192.0.2.1 traps version 1 public - # snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # snmp-server host 192.0.2.2 informs version 3 auth NMS - # snmp-server community private group network-admin - # snmp-server community public group network-operator - # snmp-server enable traps aaa server-state-change - # snmp-server enable traps system Clock-change-notification - - - name: Parse externally provided snmp-server configuration - cisco.nxos.nxos_snmp_server: - running_config: "{{ lookup('file', './parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # aaa_user: - # cache_timeout: 36000 - # communities: - # - community: private - # group: network-admin - # - community: public - # group: network-operator - # contact: nxosswitchadmin@localhost - # location: serverroom-1 - # traps: - # aaa: - # server_state_change: true - # system: - # clock_change_notification: true - # hosts: - # - host: 192.0.2.1 - # traps: true - # version: "1" - # community: public - # - # - host: 192.0.2.1 - # source_interface: Ethernet1/1 - # - # - host: 192.0.2.2 - # informs: true - # version: "3" - # auth: NMS - # users: - # auth: - # - user: snmp_user_1 - # group: network-operator - # authentication: - # algorithm: md5 - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # localized_key: true - # - # - authentication: - # algorithm: md5 - # localized_key: true - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # priv: - # aes_128: true - # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" - # group: network-operator - # user: snmp_user_2 - # - # use_acls: - # - user: snmp_user_1 - # ipv4: acl1 - # ipv6: acl2 - # - user: snmp_user_2 - # ipv4: acl3 - # ipv6: acl4 - # - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['sample command 1', 'sample command 2', 'sample command 3']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['sample command 1', 'sample command 2', 'sample command 3']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_snmp_traps_module.rst b/docs/cisco.nxos.nxos_snmp_traps_module.rst deleted file mode 100644 index 726a4d5fe..000000000 --- a/docs/cisco.nxos.nxos_snmp_traps_module.rst +++ /dev/null @@ -1,189 +0,0 @@ -.. _cisco.nxos.nxos_snmp_traps_module: - - -************************** -cisco.nxos.nxos_snmp_traps -************************** - -**(deprecated, removed after 2024-01-01) Manages SNMP traps.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated modules released with more functionality -:Alternative: nxos_snmp_server - - - -Synopsis --------- -- Manages SNMP traps configurations. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- group - -
- string - / required -
- 		-
    Choices: -
  • aaa
    • -
  • bfd
    • -
  • bgp
    • -
  • bridge
    • -
  • callhome
    • -
  • cfs
    • -
  • config
    • -
  • eigrp
    • -
  • entity
    • -
  • feature-control
    • -
  • generic
    • -
  • hsrp
    • -
  • license
    • -
  • link
    • -
  • lldp
    • -
  • mmode
    • -
  • ospf
    • -
  • pim
    • -
  • rf
    • -
  • rmon
    • -
  • snmp
    • -
  • storm-control
    • -
  • stpx
    • -
  • switchfabric
    • -
  • syslog
    • -
  • sysmgr
    • -
  • system
    • -
  • upgrade
    • -
  • vtp
    • -
  • all
    • -
- 		-
Case sensitive group.
-
-
- state - -
- string -
- 		-
    Choices: -
  • enabled ←
    • -
  • disabled
    • -
- 		-
Manage the state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - This module works at the group level for traps. If you need to only enable/disable 1 specific trap within a group, use the :ref:`cisco.nxos.nxos_command ` module. - - Be aware that you can set a trap only for an enabled feature. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure lldp trap configured - - cisco.nxos.nxos_snmp_traps: - group: lldp - state: enabled - - # ensure lldp trap is not configured - - cisco.nxos.nxos_snmp_traps: - group: lldp - state: disabled - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
snmp-server enable traps lldp ;
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_snmp_user_module.rst b/docs/cisco.nxos.nxos_snmp_user_module.rst deleted file mode 100644 index 2d3f6f26c..000000000 --- a/docs/cisco.nxos.nxos_snmp_user_module.rst +++ /dev/null @@ -1,235 +0,0 @@ -.. _cisco.nxos.nxos_snmp_user_module: - - -************************* -cisco.nxos.nxos_snmp_user -************************* - -**(deprecated, removed after 2024-01-01) Manages SNMP users for monitoring.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated modules released with more functionality -:Alternative: nxos_snmp_server - - - -Synopsis --------- -- Manages SNMP user configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- authentication - -
- string -
- 		-
    Choices: -
  • md5
    • -
  • sha
    • -
- 		-
Authentication parameters for the user.
-
-
- encrypt - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables AES-128 bit encryption when using privacy password.
-
-
- group - -
- string -
- 		- -
Group to which the user will belong to. If state = present, and the user is existing, the group is added to the user. If the user is not existing, user entry is created with this group argument. If state = absent, only the group is removed from the user entry. However, to maintain backward compatibility, if the existing user belongs to only one group, and if group argument is same as the existing user's group, then the user entry also is deleted.
-
-
- privacy - -
- string -
- 		- -
Privacy password for the user. This is not idempotent
-
-
- pwd - -
- string -
- 		- -
Authentication password when using md5 or sha. This is not idempotent
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- user - -
- string - / required -
- 		- -
Name of the user.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - Authentication parameters not idempotent. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_snmp_user: - user: ntc - group: network-operator - authentication: md5 - pwd: test_password - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['snmp-server user ntc network-operator auth md5 test_password']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_udld_interface_module.rst b/docs/cisco.nxos.nxos_udld_interface_module.rst deleted file mode 100644 index cba2733c0..000000000 --- a/docs/cisco.nxos.nxos_udld_interface_module.rst +++ /dev/null @@ -1,250 +0,0 @@ -.. _cisco.nxos.nxos_udld_interface_module: - - -****************************** -cisco.nxos.nxos_udld_interface -****************************** - -**Manages UDLD interface configuration params.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages UDLD interface configuration params. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- interface - -
- string - / required -
- 		- -
FULL name of the interface, i.e. Ethernet1/1-
-
-
- mode - -
- string - / required -
- 		-
    Choices: -
  • enabled
    • -
  • disabled
    • -
  • aggressive
    • -
- 		-
Manages UDLD mode for an interface.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Feature UDLD must be enabled on the device to use this module. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure Ethernet1/1 is configured to be in aggressive mode - - cisco.nxos.nxos_udld_interface: - interface: Ethernet1/1 - mode: aggressive - state: present - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - # Remove the aggressive config only if it's currently in aggressive mode and then disable udld (switch default) - - cisco.nxos.nxos_udld_interface: - interface: Ethernet1/1 - mode: aggressive - state: absent - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - # ensure Ethernet1/1 has aggressive mode enabled - - cisco.nxos.nxos_udld_interface: - interface: Ethernet1/1 - mode: enabled - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- end_state - -
- dictionary -
- 		always -
k/v pairs of configuration after module execution
-
-
Sample:
-
{'mode': 'enabled'}
-
-
- existing - -
- dictionary -
- 		always -
k/v pairs of existing configuration
-
-
Sample:
-
{'mode': 'aggressive'}
-
-
- proposed - -
- dictionary -
- 		always -
k/v pairs of parameters passed into module
-
-
Sample:
-
{'mode': 'enabled'}
-
-
- updates - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['interface ethernet1/33', 'no udld aggressive ; no udld disable']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_udld_module.rst b/docs/cisco.nxos.nxos_udld_module.rst deleted file mode 100644 index dc461bc89..000000000 --- a/docs/cisco.nxos.nxos_udld_module.rst +++ /dev/null @@ -1,256 +0,0 @@ -.. _cisco.nxos.nxos_udld_module: - - -******************** -cisco.nxos.nxos_udld -******************** - -**Manages UDLD global configuration params.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages UDLD global configuration params. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggressive - -
- string -
- 		-
    Choices: -
  • enabled
    • -
  • disabled
    • -
- 		-
Toggles aggressive mode.
-
-
- msg_time - -
- string -
- 		- -
Message time in seconds for UDLD packets or keyword 'default'.
-
-
- reset - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ability to reset all ports shut down by UDLD. 'state' parameter cannot be 'absent' when this is present.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource. When set to 'absent', aggressive and msg_time are set to their default values.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Module will fail if the udld feature has not been previously enabled. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure udld aggressive mode is globally disabled and se global message interval is 20 - - cisco.nxos.nxos_udld: - aggressive: disabled - msg_time: 20 - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - # Ensure agg mode is globally enabled and msg time is 15 - - cisco.nxos.nxos_udld: - aggressive: enabled - msg_time: 15 - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- end_state - -
- dictionary -
- 		always -
k/v pairs of udld configuration after module execution
-
-
Sample:
-
{'aggressive': 'enabled', 'msg_time': '40'}
-
-
- existing - -
- dictionary -
- 		always -
k/v pairs of existing udld configuration
-
-
Sample:
-
{'aggressive': 'disabled', 'msg_time': '15'}
-
-
- proposed - -
- dictionary -
- 		always -
k/v pairs of parameters passed into module
-
-
Sample:
-
{'aggressive': 'enabled', 'msg_time': '40'}
-
-
- updates - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['udld message-time 40', 'udld aggressive']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_user_module.rst b/docs/cisco.nxos.nxos_user_module.rst deleted file mode 100644 index a03a23a03..000000000 --- a/docs/cisco.nxos.nxos_user_module.rst +++ /dev/null @@ -1,390 +0,0 @@ -.. _cisco.nxos.nxos_user_module: - - -******************** -cisco.nxos.nxos_user -******************** - -**Manage the collection of local users on Nexus devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module provides declarative management of the local usernames configured on Cisco Nexus devices. It allows playbooks to manage either individual usernames or the collection of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
The set of username objects to be configured on the remote Cisco Nexus device. The list entries can either be the username or a hash of username and properties. This argument is mutually exclusive with the name argument.
-

aliases: users, collection
-
-
- configured_password - -
- string -
- 		- -
The password to be configured on the network device. The password needs to be provided in cleartext and it will be encrypted on the device.
-
-
- hashed_password - -
- string -
- 		- -
The hashed password to be configured on the network device. The password needs to already be encrypted.
-
-
- name - -
- string -
- 		- -
The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
-
-
- roles - -
- list - / elements=string -
- 		- -
The role argument configures the role for the username in the device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device.
-

aliases: role
-
-
- sshkey - -
- string -
- 		- -
The sshkey argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
- 		-
The state argument configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
-
-
- update_password - -
- string -
- 		-
    Choices: -
  • on_create
    • -
  • always
    • -
- 		-
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
-
-
- configured_password - -
- string -
- 		- -
The password to be configured on the network device. The password needs to be provided in cleartext and it will be encrypted on the device.
-
-
- hashed_password - -
- string -
- 		- -
The hashed password to be configured on the network device. The password needs to already be encrypted.
-
-
- name - -
- string -
- 		- -
The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
-
-
- purge - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
The purge argument instructs the module to consider the resource definition absolute. It will remove any previously configured usernames on the device with the exception of the `admin` user which cannot be deleted per nxos constraints.
-
-
- roles - -
- list - / elements=string -
- 		- -
The role argument configures the role for the username in the device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device.
-

aliases: role
-
-
- sshkey - -
- string -
- 		- -
The sshkey argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
The state argument configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
-
-
- update_password - -
- string -
- 		-
    Choices: -
  • on_create
    • -
  • always ←
    • -
- 		-
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
-
-
- - -Notes ------ - -.. note:: - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: create a new user - cisco.nxos.nxos_user: - name: ansible - sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}" - state: present - - - name: remove all users except admin - cisco.nxos.nxos_user: - purge: true - - - name: set multiple users role - cisco.nxos.nxos_user: - aggregate: - - name: netop - - name: netend - role: network-operator - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['name ansible', 'name ansible password password']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_vpc_module.rst b/docs/cisco.nxos.nxos_vpc_module.rst deleted file mode 100644 index 9e0ca3c29..000000000 --- a/docs/cisco.nxos.nxos_vpc_module.rst +++ /dev/null @@ -1,352 +0,0 @@ -.. _cisco.nxos.nxos_vpc_module: - - -******************* -cisco.nxos.nxos_vpc -******************* - -**Manages global VPC configuration** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages global VPC configuration - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- auto_recovery - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/Disables auto recovery on platforms that support disable
-
timers are not modifiable with this attribute
-
mutually exclusive with auto_recovery_reload_delay
-
-
- auto_recovery_reload_delay - -
- string -
- 		- -
Manages auto-recovery reload-delay timer in seconds
-
mutually exclusive with auto_recovery
-
-
- delay_restore - -
- string -
- 		- -
manages delay restore command and config value in seconds
-
-
- delay_restore_interface_vlan - -
- string -
- 		- -
manages delay restore interface-vlan command and config value in seconds
-
not supported on all platforms
-
-
- delay_restore_orphan_port - -
- string -
- 		- -
manages delay restore orphan-port command and config value in seconds
-
not supported on all platforms
-
-
- domain - -
- string - / required -
- 		- -
VPC domain
-
-
- peer_gw - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/Disables peer gateway
-
-
- pkl_dest - -
- string -
- 		- -
Destination (remote) IP address used for peer keepalive link
-
pkl_dest is required whenever pkl options are used.
-
-
- pkl_src - -
- string -
- 		- -
Source IP address used for peer keepalive link
-
-
- pkl_vrf - -
- string -
- 		- -
VRF used for peer keepalive link
-
The VRF must exist on the device before using pkl_vrf.
-
(Note) 'default' is an overloaded term: Default vrf context for pkl_vrf is 'management'; 'pkl_vrf: default' refers to the literal 'default' rib.
-
-
- role_priority - -
- string -
- 		- -
Role priority for device. Remember lower is better.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manages desired state of the resource
-
-
- system_priority - -
- string -
- 		- -
System priority device. Remember they must match between peers.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - The feature vpc must be enabled before this module can be used - - If not using management vrf, vrf must be globally on the device before using in the pkl config - - Although source IP isn't required on the command line it is required when using this module. The PKL VRF must also be configured prior to using this module. - - Both pkl_src and pkl_dest are needed when changing PKL VRF. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: configure a simple asn - cisco.nxos.nxos_vpc: - domain: 100 - role_priority: 1000 - system_priority: 2000 - pkl_dest: 192.168.100.4 - pkl_src: 10.1.100.20 - peer_gw: true - auto_recovery: true - - - name: configure - cisco.nxos.nxos_vpc: - domain: 100 - role_priority: 32667 - system_priority: 2000 - peer_gw: true - pkl_src: 10.1.100.2 - pkl_dest: 192.168.100.4 - auto_recovery: true - - - name: Configure VPC with delay restore and existing keepalive VRF - cisco.nxos.nxos_vpc: - domain: 10 - role_priority: 28672 - system_priority: 2000 - delay_restore: 180 - peer_gw: true - pkl_src: 1.1.1.2 - pkl_dest: 1.1.1.1 - pkl_vrf: vpckeepalive - auto_recovery: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['vpc domain 100', 'peer-keepalive destination 192.168.100.4 source 10.1.100.20 vrf management', 'auto-recovery', 'peer-gateway']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vrf_af_module.rst b/docs/cisco.nxos.nxos_vrf_af_module.rst deleted file mode 100644 index 236991587..000000000 --- a/docs/cisco.nxos.nxos_vrf_af_module.rst +++ /dev/null @@ -1,300 +0,0 @@ -.. _cisco.nxos.nxos_vrf_af_module: - - -********************** -cisco.nxos.nxos_vrf_af -********************** - -**Manages VRF AF.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages VRF AF - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
Address-Family Identifier (AFI).
-
-
- route_target_both_auto_evpn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable the EVPN route-target 'auto' setting for both import and export target communities.
-
-
- route_targets - -
- list - / elements=dictionary -
- 		- -
Specify the route-targets which should be imported and/or exported under the AF. This argument accepts a list of dicts that specify the route-target, the direction (import|export|both) and state of each route-target. Default direction is direction=both. See examples.
-
-
- direction - -
- string -
- 		-
    Choices: -
  • import
    • -
  • export
    • -
  • both ←
    • -
- 		-
Indicates the direction of the route-target (import|export|both)
-
-
- rt - -
- string - / required -
- 		- -
Defines the route-target itself
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Determines whether the route-target with the given direction should be present or not on the device.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Determines whether the config should be present or not on the device.
-
-
- vrf - -
- string - / required -
- 		- -
Name of the VRF.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Default, where supported, restores params default value. - - In case of ``state=absent`` the address-family configuration will be absent. Therefore the options ``route_target_both_auto_evpn`` and ``route_targets`` are ignored. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_target_both_auto_evpn: true - state: present - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_targets: - - rt: '65000:1000' - direction: import - - rt: '65001:1000' - direction: import - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_targets: - - rt: '65000:1000' - direction: import - - rt: '65001:1000' - state: absent - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_targets: - - rt: '65000:1000' - direction: export - - rt: '65001:1000' - direction: export - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_targets: - - rt: '65000:1000' - direction: export - state: absent - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_targets: - - rt: '65000:1000' - direction: both - state: present - - rt: '65001:1000' - direction: import - state: present - - rt: '65002:1000' - direction: both - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['vrf context ntc', 'address-family ipv4 unicast']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vrf_module.rst b/docs/cisco.nxos.nxos_vrf_module.rst deleted file mode 100644 index 6765f78b5..000000000 --- a/docs/cisco.nxos.nxos_vrf_module.rst +++ /dev/null @@ -1,494 +0,0 @@ -.. _cisco.nxos.nxos_vrf_module: - - -******************* -cisco.nxos.nxos_vrf -******************* - -**Manages global VRF configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module provides declarative management of VRFs on CISCO NXOS network devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- admin_state - -
- string -
- 		-
    Choices: -
  • up ←
    • -
  • down
    • -
- 		-
Administrative state of the VRF.
-
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
List of VRFs definitions.
-
-
- admin_state - -
- string -
- 		-
    Choices: -
  • up
    • -
  • down
    • -
- 		-
Administrative state of the VRF.
-
-
- associated_interfaces - -
- list - / elements=string -
- 		- -
This is a intent option and checks the operational state of the for given vrf name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vrf interfaces on device it will result in failure.
-
-
- delay - -
- integer -
- 		- -
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
-
-
- description - -
- string -
- 		- -
Description of the VRF or keyword 'default'.
-
-
- interfaces - -
- list - / elements=string -
- 		- -
List of interfaces to check the VRF has been configured correctly or keyword 'default'.
-
-
- name - -
- string -
- 		- -
Name of VRF to be managed.
-

aliases: vrf
-
-
- rd - -
- string -
- 		- -
VPN Route Distinguisher (RD). Valid values are a string in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword 'auto', or the keyword 'default'.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
- 		-
Manages desired state of the resource.
-
-
- vni - -
- string -
- 		- -
Specify virtual network identifier. Valid values are Integer or keyword 'default'.
-
-
- associated_interfaces - -
- list - / elements=string -
- 		- -
This is a intent option and checks the operational state of the for given vrf name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vrf interfaces on device it will result in failure.
-
-
- delay - -
- integer -
- 		- Default:
10
- 		-
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
-
-
- description - -
- string -
- 		- -
Description of the VRF or keyword 'default'.
-
-
- interfaces - -
- list - / elements=string -
- 		- -
List of interfaces to check the VRF has been configured correctly or keyword 'default'.
-
-
- name - -
- string -
- 		- -
Name of VRF to be managed.
-

aliases: vrf
-
-
- purge - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Purge VRFs not defined in the aggregate parameter.
-
-
- rd - -
- string -
- 		- -
VPN Route Distinguisher (RD). Valid values are a string in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword 'auto', or the keyword 'default'.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manages desired state of the resource.
-
-
- vni - -
- string -
- 		- -
Specify virtual network identifier. Valid values are Integer or keyword 'default'.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Cisco NX-OS creates the default VRF by itself. Therefore, you're not allowed to use default as *vrf* name in this module. - - ``vrf`` name must be shorter than 32 chars. - - VRF names are not case sensible in NX-OS. Anyway, the name is stored just like it's inserted by the user and it'll not be changed again unless the VRF is removed and re-created. i.e. ``vrf=NTC`` will create a VRF named NTC, but running it again with ``vrf=ntc`` will not cause a configuration change. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Ensure ntc VRF exists on switch - cisco.nxos.nxos_vrf: - name: ntc - description: testing - state: present - - name: Aggregate definition of VRFs - cisco.nxos.nxos_vrf: - aggregate: - - name: test1 - description: Testing - admin_state: down - - name: test2 - interfaces: Ethernet1/2 - - name: Aggregate definitions of VRFs with Purge - cisco.nxos.nxos_vrf: - aggregate: - - name: ntc1 - description: purge test1 - - name: ntc2 - description: purge test2 - state: present - purge: true - - name: Delete VRFs exist on switch - cisco.nxos.nxos_vrf: - aggregate: - - name: ntc1 - - name: ntc2 - state: absent - - name: Assign interfaces to VRF declaratively - cisco.nxos.nxos_vrf: - name: test1 - interfaces: - - Ethernet2/3 - - Ethernet2/5 - - name: Check interfaces assigned to VRF - cisco.nxos.nxos_vrf: - name: test1 - associated_interfaces: - - Ethernet2/3 - - Ethernet2/5 - - name: >- - Ensure VRF is tagged with interface Ethernet2/5 only (Removes from - Ethernet2/3) - cisco.nxos.nxos_vrf: - name: test1 - interfaces: - - Ethernet2/5 - - name: Delete VRF - cisco.nxos.nxos_vrf: - name: ntc - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['vrf context ntc', 'no shutdown', 'interface Ethernet1/2', 'no switchport', 'vrf member test2']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_vrrp_module.rst b/docs/cisco.nxos.nxos_vrrp_module.rst deleted file mode 100644 index 88183c5af..000000000 --- a/docs/cisco.nxos.nxos_vrrp_module.rst +++ /dev/null @@ -1,277 +0,0 @@ -.. _cisco.nxos.nxos_vrrp_module: - - -******************** -cisco.nxos.nxos_vrrp -******************** - -**Manages VRRP configuration on NX-OS switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages VRRP configuration on NX-OS switches. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- admin_state - -
- string -
- 		-
    Choices: -
  • shutdown ←
    • -
  • no shutdown
    • -
  • default
    • -
- 		-
Used to enable or disable the VRRP process.
-
-
- authentication - -
- string -
- 		- -
Clear text authentication string or 'default' keyword
-
-
- group - -
- string - / required -
- 		- -
VRRP group number.
-
-
- interface - -
- string - / required -
- 		- -
Full name of interface that is being managed for VRRP.
-
-
- interval - -
- string -
- 		- -
Time interval between advertisement or 'default' keyword
-
-
- preempt - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable preempt.
-
-
- priority - -
- string -
- 		- -
VRRP priority or 'default' keyword
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Specify desired state of the resource.
-
-
- vip - -
- string -
- 		- -
VRRP virtual IP address or 'default' keyword
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - VRRP feature needs to be enabled first on the system. - - SVIs must exist before using this module. - - Interface must be a L3 port before using this module. - - ``state=absent`` removes the VRRP group if it exists on the device. - - VRRP cannot be configured on loopback interfaces. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Ensure vrrp group 100 and vip 10.1.100.1 is on vlan10 - cisco.nxos.nxos_vrrp: - interface: vlan10 - group: 100 - vip: 10.1.100.1 - - - name: Ensure removal of the vrrp group config - cisco.nxos.nxos_vrrp: - interface: vlan10 - group: 100 - vip: 10.1.100.1 - state: absent - - - name: Re-config with more params - cisco.nxos.nxos_vrrp: - interface: vlan10 - group: 100 - vip: 10.1.100.1 - preempt: false - priority: 130 - authentication: AUTHKEY - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['interface vlan10', 'vrrp 150', 'address 10.1.15.1', 'authentication text testing', 'no shutdown']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vsan_module.rst b/docs/cisco.nxos.nxos_vsan_module.rst deleted file mode 100644 index 9baa64c68..000000000 --- a/docs/cisco.nxos.nxos_vsan_module.rst +++ /dev/null @@ -1,225 +0,0 @@ -.. _cisco.nxos.nxos_vsan_module: - - -******************** -cisco.nxos.nxos_vsan -******************** - -**Configuration of vsan for Cisco NXOS MDS Switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configuration of vsan for Cisco MDS NXOS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- vsan - -
- list - / elements=dictionary -
- 		- -
List of vsan details to be added or removed
-
-
- id - -
- integer - / required -
- 		- -
Vsan id
-
-
- interface - -
- list - / elements=string -
- 		- -
List of vsan's interfaces to be added
-
-
- name - -
- string -
- 		- -
Name of the vsan
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Removes the vsan if True
-
-
- suspend - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
suspend the vsan if True
-
-
- - -Notes ------ - -.. note:: - - Tested against Cisco MDS NX-OS 8.4(1) - - - -Examples --------- - -.. code-block:: yaml - - - name: Test that vsan module works - cisco.nxos.nxos_vsan: - vsan: - - id: 922 - interface: - - fc1/1 - - fc1/2 - - port-channel 1 - name: vsan-SAN-A - remove: false - suspend: false - - id: 923 - interface: - - fc1/11 - - fc1/21 - - port-channel 2 - name: vsan-SAN-B - remove: false - suspend: true - - id: 1923 - name: vsan-SAN-Old - remove: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['terminal dont-ask', 'vsan database', 'vsan 922 interface fc1/40', 'vsan 922 interface port-channel 155', 'no terminal dont-ask']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) diff --git a/docs/cisco.nxos.nxos_vxlan_vtep_module.rst b/docs/cisco.nxos.nxos_vxlan_vtep_module.rst deleted file mode 100644 index 57fdc14a3..000000000 --- a/docs/cisco.nxos.nxos_vxlan_vtep_module.rst +++ /dev/null @@ -1,332 +0,0 @@ -.. _cisco.nxos.nxos_vxlan_vtep_module: - - -************************** -cisco.nxos.nxos_vxlan_vtep -************************** - -**Manages VXLAN Network Virtualization Endpoint (NVE).** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages VXLAN Network Virtualization Endpoint (NVE) overlay interface that terminates VXLAN tunnels. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- advertise_virtual_rmac - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
The advertise_virtual_rmac parameter lets BGP to use the VMAC with VIP as next-hop when advertising type-2 routes. Should be used together with advertise_pip parameter from cisco.nxos.nxos_bgp_address_family module.
-
-
- description - -
- string -
- 		- -
Description of the NVE interface.
-
-
- global_ingress_replication_bgp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configures ingress replication protocol as bgp for all VNIs. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
-
-
- global_mcast_group_L2 - -
- string -
- 		- -
Global multicast IP prefix for L2 VNIs or the keyword 'default'. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
-
-
- global_mcast_group_L3 - -
- string -
- 		- -
Global multicast IP prefix for L3 VNIs or the keyword 'default'. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
-
-
- global_suppress_arp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables ARP suppression for all VNIs. This is available on NX-OS 9K series running 9.2.x or higher.
-
-
- host_reachability - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify mechanism for host reachability advertisement. A Boolean value of 'true' indicates that BGP will be used for host reachability advertisement. A Boolean value of 'false' indicates that no protocol is used for host reachability advertisement. Other host reachability advertisement protocols (e.g. OpenFlow, controller, etc.) are not supported.
-
-
- interface - -
- string - / required -
- 		- -
Interface name for the VXLAN Network Virtualization Endpoint.
-
-
- multisite_border_gateway_interface - -
- string -
-
added in 1.1.0
- 		- -
Specify the loopback interface whose IP address should be used for the NVE Multisite Border-gateway Interface. This is available on specific Nexus 9000 series switches running NX-OS 7.0(3)I7(x) or higher. Specify "default" to remove an existing gateway config.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively shutdown the NVE interface.
-
-
- source_interface - -
- string -
- 		- -
Specify the loopback interface whose IP address should be used for the NVE interface.
-
-
- source_interface_hold_down_time - -
- string -
- 		- -
Suppresses advertisement of the NVE loopback address until the overlay has converged.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Determines whether the config should be present or not on the device.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - The module is used to manage NVE properties, not to create NVE interfaces. Use :ref:`cisco.nxos.nxos_interfaces ` if you wish to do so. - - ``state=absent`` removes the interface. - - Default, where supported, restores params default value. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_vxlan_vtep: - interface: nve1 - description: default - host_reachability: true - source_interface: Loopback0 - source_interface_hold_down_time: 30 - shutdown: default - multisite_border_gateway_interface: Loopback0 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['interface nve1', 'source-interface loopback0', 'source-interface hold-down-time 30', 'description simple description', 'shutdown', 'host-reachability protocol bgp', 'multisite border-gateway interface loopback0']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_zone_zoneset_module.rst b/docs/cisco.nxos.nxos_zone_zoneset_module.rst deleted file mode 100644 index 95ef4972a..000000000 --- a/docs/cisco.nxos.nxos_zone_zoneset_module.rst +++ /dev/null @@ -1,537 +0,0 @@ -.. _cisco.nxos.nxos_zone_zoneset_module: - - -**************************** -cisco.nxos.nxos_zone_zoneset -**************************** - -**Configuration of zone/zoneset for Cisco NXOS MDS Switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configuration of zone/zoneset for Cisco MDS NXOS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- zone_zoneset_details - -
- list - / elements=dictionary -
- 		- -
List of zone/zoneset details to be added or removed
-
-
- default_zone - -
- string -
- 		-
    Choices: -
  • permit
    • -
  • deny
    • -
- 		-
default zone behaviour for the vsan
-
-
- mode - -
- string -
- 		-
    Choices: -
  • enhanced
    • -
  • basic
    • -
- 		-
mode of the zone for the vsan
-
-
- smart_zoning - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Removes the vsan if True
-
-
- vsan - -
- integer - / required -
- 		- -
vsan id
-
-
- zone - -
- list - / elements=dictionary -
- 		- -
List of zone options for that vsan
-
-
- members - -
- list - / elements=dictionary -
- 		- -
Members of the zone that needs to be removed or added
-
-
- devtype - -
- string -
- 		-
    Choices: -
  • initiator
    • -
  • target
    • -
  • both
    • -
- 		-
devtype of the zone member used along with Smart zoning config
-
-
- pwwn - -
- string - / required -
- 		- -
pwwn member of the zone, use alias 'device_alias' as option for device_alias member
-

aliases: device_alias
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Removes member from the zone if True
-
-
- name - -
- string - / required -
- 		- -
name of the zone
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Deletes the zone if True
-
-
- zoneset - -
- list - / elements=dictionary -
- 		- -
List of zoneset options for the vsan
-
-
- action - -
- string -
- 		-
    Choices: -
  • activate
    • -
  • deactivate
    • -
- 		-
activates/de-activates the zoneset
-
-
- members - -
- list - / elements=dictionary -
- 		- -
Members of the zoneset that needs to be removed or added
-
-
- name - -
- string - / required -
- 		- -
name of the zone that needs to be added to the zoneset or removed from the zoneset
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Removes zone member from the zoneset
-
-
- name - -
- string - / required -
- 		- -
name of the zoneset
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Removes zoneset if True
-
-
- - -Notes ------ - -.. note:: - - Tested against Cisco MDS NX-OS 8.4(1) - - - -Examples --------- - -.. code-block:: yaml - - - name: Test that zone/zoneset module works - cisco.nxos.nxos_zone_zoneset: - zone_zoneset_details: - - mode: enhanced - vsan: 22 - zone: - - members: - - pwwn: 31314874576271 - - device_alias: test123 - - pwwn: '61:61:62:62:12:12:12:12' - remove: true - name: zoneA - - members: - - pwwn: 28515514576271 - - pwwn: '62:62:62:62:21:21:21:21' - name: zoneB - - name: zoneC - remove: true - zoneset: - - action: activate - members: - - name: zoneA - - name: zoneB - - name: zoneC - remove: true - name: zsetname1 - - action: deactivate - name: zsetTestExtra - remove: true - - mode: basic - smart_zoning: true - vsan: 21 - zone: - - members: - - devtype: both - pwwn: 31314874576271 - - pwwn: '62:62:62:62:12:12:12:12' - - devtype: both - pwwn: '92:62:62:62:12:12:1a:1a' - remove: true - name: zone21A - - members: - - pwwn: 28515514576271 - - pwwn: '62:62:62:62:21:21:21:21' - name: zone21B - zoneset: - - action: activate - members: - - name: zone21A - - name: zone21B - name: zsetname212 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['terminal dont-ask', 'zone name zoneA vsan 923', 'member pwwn 11:11:11:11:11:11:11:11', 'no member device-alias test123', 'zone commit vsan 923', 'no terminal dont-ask']
-
-
- messages - -
- list -
- 		always -
debug messages
-
-
Sample:
-
['zone mode is already enhanced ,no change in zone mode configuration for vsan 922', "zone member '11:11:11:11:11:11:11:11' is already present in zone 'zoneA' in vsan 922 hence nothing to add", "zone member 'test123' is already present in zone 'zoneA' in vsan 922 hence nothing to add", "zone member '61:61:62:62:12:12:12:12' is not present in zone 'zoneA' in vsan 922 hence nothing to remove", "zone member '10:11:11:11:11:11:11:11' is already present in zone 'zoneB' in vsan 922 hence nothing to add", "zone member '62:62:62:62:21:21:21:21' is already present in zone 'zoneB' in vsan 922 hence nothing to add", "zone 'zoneC' is not present in vsan 922 , so nothing to remove"]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) From ea9ff1ceae65d5b5c44dc6152869e0ac7eff1b08 Mon Sep 17 00:00:00 2001 From: Vinay Mulugund Date: Tue, 27 Feb 2024 23:26:22 +0530 Subject: [PATCH 03/30] parsers and pre-commit fix --- README.md | 1 + ...cisco.nxos.nxos_aaa_server_host_module.rst | 343 + docs/cisco.nxos.nxos_aaa_server_module.rst | 248 + .../cisco.nxos.nxos_acl_interfaces_module.rst | 610 ++ docs/cisco.nxos.nxos_acls_module.rst | 4086 ++++++++++++ docs/cisco.nxos.nxos_banner_module.rst | 187 + docs/cisco.nxos.nxos_bfd_global_module.rst | 326 + .../cisco.nxos.nxos_bfd_interfaces_module.rst | 394 ++ docs/cisco.nxos.nxos_bgp_global_module.rst | 5843 +++++++++++++++++ ...xos_bgp_neighbor_address_family_module.rst | 3575 ++++++++++ docs/cisco.nxos.nxos_bgp_templates_module.rst | 2841 ++++++++ docs/cisco.nxos.nxos_command_module.rst | 258 + docs/cisco.nxos.nxos_config_module.rst | 566 ++ docs/cisco.nxos.nxos_devicealias_module.rst | 273 + docs/cisco.nxos.nxos_evpn_global_module.rst | 122 + docs/cisco.nxos.nxos_evpn_vni_module.rst | 212 + docs/cisco.nxos.nxos_facts_module.rst | 553 ++ docs/cisco.nxos.nxos_feature_module.rst | 150 + docs/cisco.nxos.nxos_gir_module.rst | 302 + ...xos.nxos_gir_profile_management_module.rst | 235 + docs/cisco.nxos.nxos_hostname_module.rst | 344 + ...cisco.nxos.nxos_hsrp_interfaces_module.rst | 344 + docs/cisco.nxos.nxos_hsrp_module.rst | 305 + docs/cisco.nxos.nxos_igmp_module.rst | 191 + docs/cisco.nxos.nxos_igmp_snooping_module.rst | 225 + docs/cisco.nxos.nxos_install_os_module.rst | 183 + docs/cisco.nxos.nxos_l2_interfaces_module.rst | 648 ++ docs/cisco.nxos.nxos_l3_interfaces_module.rst | 884 +++ docs/cisco.nxos.nxos_lacp_module.rst | 402 ++ ...cisco.nxos.nxos_lldp_interfaces_module.rst | 407 ++ docs/cisco.nxos.nxos_logging_module.rst | 458 ++ docs/cisco.nxos.nxos_ntp_auth_module.rst | 224 + docs/cisco.nxos.nxos_ntp_global_module.rst | 1411 ++++ docs/cisco.nxos.nxos_ntp_module.rst | 314 + docs/cisco.nxos.nxos_ntp_options_module.rst | 192 + docs/cisco.nxos.nxos_nxapi_module.rst | 300 + ...cisco.nxos.nxos_ospf_interfaces_module.rst | 1732 +++++ docs/cisco.nxos.nxos_ospfv2_module.rst | 5458 +++++++++++++++ .../cisco.nxos.nxos_overlay_global_module.rst | 120 + docs/cisco.nxos.nxos_pim_module.rst | 148 + docs/cisco.nxos.nxos_ping_module.rst | 311 + docs/cisco.nxos.nxos_prefix_lists_module.rst | 1049 +++ docs/cisco.nxos.nxos_reboot_module.rst | 123 + docs/cisco.nxos.nxos_rollback_module.rst | 159 + docs/cisco.nxos.nxos_route_maps_module.rst | 4368 ++++++++++++ docs/cisco.nxos.nxos_rpm_module.rst | 226 + docs/cisco.nxos.nxos_snapshot_module.rst | 363 + .../cisco.nxos.nxos_snmp_community_module.rst | 201 + docs/cisco.nxos.nxos_snmp_host_module.rst | 288 + docs/cisco.nxos.nxos_snmp_location_module.rst | 156 + docs/cisco.nxos.nxos_snmp_server_module.rst | 4474 +++++++++++++ docs/cisco.nxos.nxos_snmp_traps_module.rst | 189 + docs/cisco.nxos.nxos_snmp_user_module.rst | 235 + ....nxos.nxos_spanning_tree_global_module.rst | 473 ++ .../cisco.nxos.nxos_udld_interface_module.rst | 250 + docs/cisco.nxos.nxos_udld_module.rst | 256 + docs/cisco.nxos.nxos_user_module.rst | 390 ++ docs/cisco.nxos.nxos_vpc_module.rst | 352 + docs/cisco.nxos.nxos_vrf_af_module.rst | 300 + docs/cisco.nxos.nxos_vrf_module.rst | 494 ++ docs/cisco.nxos.nxos_vrrp_module.rst | 277 + docs/cisco.nxos.nxos_vsan_module.rst | 225 + docs/cisco.nxos.nxos_vxlan_vtep_module.rst | 332 + docs/cisco.nxos.nxos_zone_zoneset_module.rst | 537 ++ .../spanning_tree_global.py | 4 +- .../spanning_tree_global.py | 33 +- .../spanning_tree_global.py | 43 +- .../nxos/rm_templates/spanning_tree_global.py | 26 +- plugins/modules/nxos_spanning_tree_global.py | 17 +- 69 files changed, 51513 insertions(+), 53 deletions(-) create mode 100644 docs/cisco.nxos.nxos_aaa_server_host_module.rst create mode 100644 docs/cisco.nxos.nxos_aaa_server_module.rst create mode 100644 docs/cisco.nxos.nxos_acl_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_acls_module.rst create mode 100644 docs/cisco.nxos.nxos_banner_module.rst create mode 100644 docs/cisco.nxos.nxos_bfd_global_module.rst create mode 100644 docs/cisco.nxos.nxos_bfd_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_bgp_global_module.rst create mode 100644 docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst create mode 100644 docs/cisco.nxos.nxos_bgp_templates_module.rst create mode 100644 docs/cisco.nxos.nxos_command_module.rst create mode 100644 docs/cisco.nxos.nxos_config_module.rst create mode 100644 docs/cisco.nxos.nxos_devicealias_module.rst create mode 100644 docs/cisco.nxos.nxos_evpn_global_module.rst create mode 100644 docs/cisco.nxos.nxos_evpn_vni_module.rst create mode 100644 docs/cisco.nxos.nxos_facts_module.rst create mode 100644 docs/cisco.nxos.nxos_feature_module.rst create mode 100644 docs/cisco.nxos.nxos_gir_module.rst create mode 100644 docs/cisco.nxos.nxos_gir_profile_management_module.rst create mode 100644 docs/cisco.nxos.nxos_hostname_module.rst create mode 100644 docs/cisco.nxos.nxos_hsrp_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_hsrp_module.rst create mode 100644 docs/cisco.nxos.nxos_igmp_module.rst create mode 100644 docs/cisco.nxos.nxos_igmp_snooping_module.rst create mode 100644 docs/cisco.nxos.nxos_install_os_module.rst create mode 100644 docs/cisco.nxos.nxos_l2_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_l3_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_lacp_module.rst create mode 100644 docs/cisco.nxos.nxos_lldp_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_logging_module.rst create mode 100644 docs/cisco.nxos.nxos_ntp_auth_module.rst create mode 100644 docs/cisco.nxos.nxos_ntp_global_module.rst create mode 100644 docs/cisco.nxos.nxos_ntp_module.rst create mode 100644 docs/cisco.nxos.nxos_ntp_options_module.rst create mode 100644 docs/cisco.nxos.nxos_nxapi_module.rst create mode 100644 docs/cisco.nxos.nxos_ospf_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_ospfv2_module.rst create mode 100644 docs/cisco.nxos.nxos_overlay_global_module.rst create mode 100644 docs/cisco.nxos.nxos_pim_module.rst create mode 100644 docs/cisco.nxos.nxos_ping_module.rst create mode 100644 docs/cisco.nxos.nxos_prefix_lists_module.rst create mode 100644 docs/cisco.nxos.nxos_reboot_module.rst create mode 100644 docs/cisco.nxos.nxos_rollback_module.rst create mode 100644 docs/cisco.nxos.nxos_route_maps_module.rst create mode 100644 docs/cisco.nxos.nxos_rpm_module.rst create mode 100644 docs/cisco.nxos.nxos_snapshot_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_community_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_host_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_location_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_server_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_traps_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_user_module.rst create mode 100644 docs/cisco.nxos.nxos_udld_interface_module.rst create mode 100644 docs/cisco.nxos.nxos_udld_module.rst create mode 100644 docs/cisco.nxos.nxos_user_module.rst create mode 100644 docs/cisco.nxos.nxos_vpc_module.rst create mode 100644 docs/cisco.nxos.nxos_vrf_af_module.rst create mode 100644 docs/cisco.nxos.nxos_vrf_module.rst create mode 100644 docs/cisco.nxos.nxos_vrrp_module.rst create mode 100644 docs/cisco.nxos.nxos_vsan_module.rst create mode 100644 docs/cisco.nxos.nxos_vxlan_vtep_module.rst create mode 100644 docs/cisco.nxos.nxos_zone_zoneset_module.rst diff --git a/README.md b/README.md index 1878c8646..546315043 100644 --- a/README.md +++ b/README.md @@ -110,6 +110,7 @@ Name | Description [cisco.nxos.nxos_snmp_server](https://github.com/ansible-collections/cisco.nxos/blob/main/docs/cisco.nxos.nxos_snmp_server_module.rst)|SNMP Server resource module. [cisco.nxos.nxos_snmp_traps](https://github.com/ansible-collections/cisco.nxos/blob/main/docs/cisco.nxos.nxos_snmp_traps_module.rst)|(deprecated, removed after 2024-01-01) Manages SNMP traps. [cisco.nxos.nxos_snmp_user](https://github.com/ansible-collections/cisco.nxos/blob/main/docs/cisco.nxos.nxos_snmp_user_module.rst)|(deprecated, removed after 2024-01-01) Manages SNMP users for monitoring. +[cisco.nxos.nxos_spanning_tree_global](https://github.com/ansible-collections/cisco.nxos/blob/main/docs/cisco.nxos.nxos_spanning_tree_global_module.rst)|Resource module to configure spanning tree. [cisco.nxos.nxos_static_routes](https://github.com/ansible-collections/cisco.nxos/blob/main/docs/cisco.nxos.nxos_static_routes_module.rst)|Static routes resource module [cisco.nxos.nxos_system](https://github.com/ansible-collections/cisco.nxos/blob/main/docs/cisco.nxos.nxos_system_module.rst)|Manage the system attributes on Cisco NXOS devices [cisco.nxos.nxos_telemetry](https://github.com/ansible-collections/cisco.nxos/blob/main/docs/cisco.nxos.nxos_telemetry_module.rst)|TELEMETRY resource module diff --git a/docs/cisco.nxos.nxos_aaa_server_host_module.rst b/docs/cisco.nxos.nxos_aaa_server_host_module.rst new file mode 100644 index 000000000..5730e6359 --- /dev/null +++ b/docs/cisco.nxos.nxos_aaa_server_host_module.rst @@ -0,0 +1,343 @@ +.. _cisco.nxos.nxos_aaa_server_host_module: + + +******************************* +cisco.nxos.nxos_aaa_server_host +******************************* + +**Manages AAA server host-specific configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages AAA server host-specific configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ acct_port + +
+ string +
+ 		+ +
Alternate UDP port for RADIUS accounting or keyword 'default'.
+
+
+ address + +
+ string + / required +
+ 		+ +
Address or name of the radius or tacacs host.
+
+
+ auth_port + +
+ string +
+ 		+ +
Alternate UDP port for RADIUS authentication or keyword 'default'.
+
+
+ encrypt_type + +
+ string +
+ 		+
    Choices: +
  • 0
    • +
  • 7
    • +
+ 		+
The state of encryption applied to the entered key. O for clear text, 7 for encrypted. Type-6 encryption is not supported.
+
+
+ host_timeout + +
+ string +
+ 		+ +
Timeout period for specified host, in seconds or keyword 'default. Range is 1-60.
+
+
+ key + +
+ string +
+ 		+ +
Shared secret for the specified host or keyword 'default'.
+
+
+ server_type + +
+ string + / required +
+ 		+
    Choices: +
  • radius
    • +
  • tacacs
    • +
+ 		+
The server type is either radius or tacacs.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ tacacs_port + +
+ string +
+ 		+ +
Alternate TCP port TACACS Server or keyword 'default'.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - Changes to the host key (shared secret) are not idempotent for type 0. + - If ``state=absent`` removes the whole host configuration. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Radius Server Host Basic settings + - name: Radius Server Host Basic settings + cisco.nxos.nxos_aaa_server_host: + state: present + server_type: radius + address: 1.2.3.4 + acct_port: 2084 + host_timeout: 10 + + # Radius Server Host Key Configuration + - name: Radius Server Host Key Configuration + cisco.nxos.nxos_aaa_server_host: + state: present + server_type: radius + address: 1.2.3.4 + key: hello + encrypt_type: 7 + + # TACACS Server Host Configuration + - name: Tacacs Server Host Configuration + cisco.nxos.nxos_aaa_server_host: + state: present + server_type: tacacs + tacacs_port: 89 + host_timeout: 10 + address: 5.6.7.8 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ end_state + +
+ dictionary +
+ 		always +
k/v pairs of configuration after module execution
+
+
Sample:
+
{'address': '1.2.3.4', 'auth_port': '2084', 'host_timeout': '10', 'server_type': 'radius'}
+
+
+ existing + +
+ dictionary +
+ 		always +
k/v pairs of existing configuration
+
+
+
+ proposed + +
+ dictionary +
+ 		always +
k/v pairs of parameters passed into module
+
+
Sample:
+
{'address': '1.2.3.4', 'auth_port': '2084', 'host_timeout': '10', 'server_type': 'radius'}
+
+
+ updates + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['radius-server host 1.2.3.4 auth-port 2084 timeout 10']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_aaa_server_module.rst b/docs/cisco.nxos.nxos_aaa_server_module.rst new file mode 100644 index 000000000..1307c9033 --- /dev/null +++ b/docs/cisco.nxos.nxos_aaa_server_module.rst @@ -0,0 +1,248 @@ +.. _cisco.nxos.nxos_aaa_server_module: + + +************************** +cisco.nxos.nxos_aaa_server +************************** + +**Manages AAA server global configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages AAA server global configuration + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ deadtime + +
+ string +
+ 		+ +
Duration for which a non-reachable AAA server is skipped, in minutes or keyword 'default. Range is 1-1440. Device default is 0.
+
+
+ directed_request + +
+ string +
+ 		+
    Choices: +
  • enabled
    • +
  • disabled
    • +
  • default
    • +
+ 		+
Enables direct authentication requests to AAA server or keyword 'default' Device default is disabled.
+
+
+ encrypt_type + +
+ string +
+ 		+
    Choices: +
  • 0
    • +
  • 7
    • +
+ 		+
The state of encryption applied to the entered global key. O clear text, 7 encrypted. Type-6 encryption is not supported.
+
+
+ global_key + +
+ string +
+ 		+ +
Global AAA shared secret or keyword 'default'.
+
+
+ server_timeout + +
+ string +
+ 		+ +
Global AAA server timeout period, in seconds or keyword 'default. Range is 1-60. Device default is 5.
+
+
+ server_type + +
+ string + / required +
+ 		+
    Choices: +
  • radius
    • +
  • tacacs
    • +
+ 		+
The server type is either radius or tacacs.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • default
    • +
+ 		+
Manage the state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - The server_type parameter is always required. + - If encrypt_type is not supplied, the global AAA server key will be stored as encrypted (type 7). + - Changes to the global AAA server key with encrypt_type=0 are not idempotent. + - state=default will set the supplied parameters to their default values. The parameters that you want to default must also be set to default. If global_key=default, the global key will be removed. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Radius Server Basic settings + - name: Radius Server Basic settings + cisco.nxos.nxos_aaa_server: + server_type: radius + server_timeout: 9 + deadtime: 20 + directed_request: enabled + + # Tacacs Server Basic settings + - name: Tacacs Server Basic settings + cisco.nxos.nxos_aaa_server: + server_type: tacacs + server_timeout: 8 + deadtime: 19 + directed_request: disabled + + # Setting Global Key + - name: AAA Server Global Key + cisco.nxos.nxos_aaa_server: + server_type: radius + global_key: test_key + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['radius-server deadtime 22', 'radius-server timeout 11', 'radius-server directed-request']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_acl_interfaces_module.rst b/docs/cisco.nxos.nxos_acl_interfaces_module.rst new file mode 100644 index 000000000..a2885df02 --- /dev/null +++ b/docs/cisco.nxos.nxos_acl_interfaces_module.rst @@ -0,0 +1,610 @@ +.. _cisco.nxos.nxos_acl_interfaces_module: + + +****************************** +cisco.nxos.nxos_acl_interfaces +****************************** + +**ACL interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Add and remove Access Control Lists on interfaces in NX-OS platform + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of interfaces to be configured with ACLs
+
+
+ access_groups + +
+ list + / elements=dictionary +
+ 		+ +
List of address family indicators with ACLs to be configured on the interface
+
+
+ acls + +
+ list + / elements=dictionary +
+ 		+ +
List of Access Control Lists for the interface
+
+
+ direction + +
+ string + / required +
+ 		+
    Choices: +
  • in
    • +
  • out
    • +
+ 		+
Direction to be applied for the ACL
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the ACL to be added/removed
+
+
+ port + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use ACL as port policy.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
Address Family Indicator of the ACLs to be configured
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the interface
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • deleted
    • +
  • gathered
    • +
  • merged ←
    • +
  • overridden
    • +
  • rendered
    • +
  • replaced
    • +
  • parsed
    • +
+ 		+
The state the configuration should be left in
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------ + # + + - name: Merge ACL interfaces configuration + cisco.nxos.nxos_acl_interfaces: + config: + - name: Ethernet1/2 + access_groups: + - afi: ipv6 + acls: + - name: ACL1v6 + direction: in + + - name: Eth1/5 + access_groups: + - afi: ipv4 + acls: + - name: PortACL + direction: in + port: true + + - name: ACL1v4 + direction: out + + - afi: ipv6 + acls: + - name: ACL1v6 + direction: in + state: merged + + # After state: + # ------------ + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ip port access-group PortACL in + # ip access-group ACL1v4 out + # ipv6 traffic-filter ACL1v6 in + + # Using replaced + + # Before state: + # ------------ + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ip port access-group PortACL in + # ip access-group ACL1v4 out + # ipv6 traffic-filter ACL1v6 in + + - name: Replace interface configuration with given configuration + cisco.nxos.nxos_acl_interfaces: + config: + - name: Eth1/5 + access_groups: + - afi: ipv4 + acls: + - name: NewACLv4 + direction: out + + - name: Ethernet1/3 + access_groups: + - afi: ipv6 + acls: + - name: NewACLv6 + direction: in + port: true + state: replaced + + # After state: + # ------------ + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/3 + # ipv6 port traffic-filter NewACLv6 in + # interface Ethernet1/5 + # ip access-group NewACLv4 out + + # Using overridden + + # Before state: + # ------------ + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ip port access-group PortACL in + # ip access-group ACL1v4 out + # ipv6 traffic-filter ACL1v6 in + + - name: Override interface configuration with given configuration + cisco.nxos.nxos_acl_interfaces: + config: + - name: Ethernet1/3 + access_groups: + - afi: ipv4 + acls: + - name: ACL1v4 + direction: out + + - name: PortACL + port: true + direction: in + - afi: ipv6 + acls: + - name: NewACLv6 + direction: in + port: true + state: overridden + + # After state: + # ------------ + # interface Ethernet1/3 + # ip access-group ACL1v4 out + # ip port access-group PortACL in + # ipv6 port traffic-filter NewACLv6 in + + # Using deleted to remove ACL config from specified interfaces + + # Before state: + # ------------- + # interface Ethernet1/1 + # ip access-group ACL2v4 in + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ip port access-group PortACL in + # ip access-group ACL1v4 out + # ipv6 traffic-filter ACL1v6 in + + - name: Delete ACL configuration on interfaces + cisco.nxos.nxos_acl_interfaces: + config: + - name: Ethernet1/5 + - name: Ethernet1/2 + state: deleted + + # After state: + # ------------- + # interface Ethernet1/1 + # ip access-group ACL2v4 in + # interface Ethernet1/2 + # interface Ethernet1/5 + + # Using deleted to remove ACL config from all interfaces + + # Before state: + # ------------- + # interface Ethernet1/1 + # ip access-group ACL2v4 in + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ip port access-group PortACL in + # ip access-group ACL1v4 out + # ipv6 traffic-filter ACL1v6 in + + - name: Delete ACL configuration from all interfaces + cisco.nxos.nxos_acl_interfaces: + state: deleted + + # After state: + # ------------- + # interface Ethernet1/1 + # interface Ethernet1/2 + # interface Ethernet1/5 + + # Using parsed + + - name: Parse given configuration into structured format + cisco.nxos.nxos_acl_interfaces: + running_config: | + interface Ethernet1/2 + ipv6 traffic-filter ACL1v6 in + interface Ethernet1/5 + ipv6 traffic-filter ACL1v6 in + ip access-group ACL1v4 out + ip port access-group PortACL in + state: parsed + + # returns + # parsed: + # - name: Ethernet1/2 + # access_groups: + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # direction: in + # - name: Ethernet1/5 + # access_groups: + # - afi: ipv4 + # acls: + # - name: PortACL + # direction: in + # port: True + # - name: ACL1v4 + # direction: out + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # direction: in + + + # Using gathered: + + # Before state: + # ------------ + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ipv6 traffic-filter ACL1v6 in + # ip access-group ACL1v4 out + # ip port access-group PortACL in + + - name: Gather existing configuration from device + cisco.nxos.nxos_acl_interfaces: + config: + state: gathered + + # returns + # gathered: + # - name: Ethernet1/2 + # access_groups: + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # direction: in + # - name: Ethernet1/5 + # access_groups: + # - afi: ipv4 + # acls: + # - name: PortACL + # direction: in + # port: True + # - name: ACL1v4 + # direction: out + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # direction: in + + + # Using rendered + + - name: Render required configuration to be pushed to the device + cisco.nxos.nxos_acl_interfaces: + config: + - name: Ethernet1/2 + access_groups: + - afi: ipv6 + acls: + - name: ACL1v6 + direction: in + - name: Ethernet1/5 + access_groups: + - afi: ipv4 + acls: + - name: PortACL + direction: in + port: true + - name: ACL1v4 + direction: out + - afi: ipv6 + acls: + - name: ACL1v6 + direction: in + state: rendered + + + # returns + # rendered: + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ipv6 traffic-filter ACL1v6 in + # ip access-group ACL1v4 out + # ip port access-group PortACL in + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/2', 'ipv6 traffic-filter ACL1v6 out', 'ip port access-group PortACL in']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_acls_module.rst b/docs/cisco.nxos.nxos_acls_module.rst new file mode 100644 index 000000000..1b806511d --- /dev/null +++ b/docs/cisco.nxos.nxos_acls_module.rst @@ -0,0 +1,4086 @@ +.. _cisco.nxos.nxos_acls_module: + + +******************** +cisco.nxos.nxos_acls +******************** + +**ACLs resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manage named IP ACLs on the Cisco NX-OS platform + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary of ACL options.
+
+
+ acls + +
+ list + / elements=dictionary +
+ 		+ +
A list of the ACLs.
+
+
+ aces + +
+ list + / elements=dictionary +
+ 		+ +
The entries within the ACL.
+
+
+ destination + +
+ dictionary +
+ 		+ +
Specify the packet destination.
+
+
+ address + +
+ string +
+ 		+ +
Destination network address.
+
+
+ any + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Any destination address.
+
+
+ host + +
+ string +
+ 		+ +
Host IP address.
+
+
+ port_protocol + +
+ dictionary +
+ 		+ +
Specify the destination port or protocol (only for TCP and UDP).
+
+
+ eq + +
+ string +
+ 		+ +
Match only packets on a given port number.
+
+
+ gt + +
+ string +
+ 		+ +
Match only packets with a greater port number.
+
+
+ lt + +
+ string +
+ 		+ +
Match only packets with a lower port number.
+
+
+ neq + +
+ string +
+ 		+ +
Match only packets not on a given port number.
+
+
+ range + +
+ dictionary +
+ 		+ +
Match only packets in the range of port numbers.
+
+
+ end + +
+ string +
+ 		+ +
Specify the end of the port range.
+
+
+ start + +
+ string +
+ 		+ +
Specify the start of the port range.
+
+
+ prefix + +
+ string +
+ 		+ +
Destination network prefix. Only for prefixes of value less than 31 for ipv4 and 127 for ipv6. Prefixes of 32 (ipv4) and 128 (ipv6) should be given in the 'host' key.
+
+
+ wildcard_bits + +
+ string +
+ 		+ +
Destination wildcard bits.
+
+
+ dscp + +
+ string +
+ 		+ +
Match packets with given DSCP value.
+
+
+ fragments + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Check non-initial fragments.
+
+
+ grant + +
+ string +
+ 		+
    Choices: +
  • permit
    • +
  • deny
    • +
+ 		+
Action to be applied on the rule.
+
+
+ log + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log matches against this entry.
+
+
+ precedence + +
+ string +
+ 		+ +
Match packets with given precedence value.
+
+
+ protocol + +
+ string +
+ 		+ +
Specify the protocol.
+
+
+ protocol_options + +
+ dictionary +
+ 		+ +
All possible suboptions for the protocol chosen.
+
+
+ icmp + +
+ dictionary +
+ 		+ +
ICMP protocol options.
+
+
+ administratively_prohibited + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively prohibited
+
+
+ alternate_address + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Alternate address
+
+
+ conversion_error + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Datagram conversion
+
+
+ dod_host_prohibited + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host prohibited
+
+
+ dod_net_prohibited + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Net prohibited
+
+
+ echo + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo (ping)
+
+
+ echo_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo reply
+
+
+ echo_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo request (ping)
+
+
+ general_parameter_problem + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter problem
+
+
+ host_isolated + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host isolated
+
+
+ host_precedence_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host unreachable for precedence
+
+
+ host_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host redirect
+
+
+ host_tos_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host redirect for TOS
+
+
+ host_tos_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host unreachable for TOS
+
+
+ host_unknown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host unknown
+
+
+ host_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host unreachable
+
+
+ information_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Information replies
+
+
+ information_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Information requests
+
+
+ mask_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Mask replies
+
+
+ mask_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Mask requests
+
+
+ message_code + +
+ integer +
+ 		+ +
ICMP message code
+
+
+ message_type + +
+ integer +
+ 		+ +
ICMP message type
+
+
+ mobile_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Mobile host redirect
+
+
+ net_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Network redirect
+
+
+ net_tos_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Net redirect for TOS
+
+
+ net_tos_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Network unreachable for TOS
+
+
+ net_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Net unreachable
+
+
+ network_unknown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Network unknown
+
+
+ no_room_for_option + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter required but no room
+
+
+ option_missing + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter required but not present
+
+
+ packet_too_big + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Fragmentation needed and DF set
+
+
+ parameter_problem + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All parameter problems
+
+
+ port_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Port unreachable
+
+
+ precedence_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Precedence cutoff
+
+
+ protocol_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Protocol unreachable
+
+
+ reassembly_timeout + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Reassembly timeout
+
+
+ redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All redirects
+
+
+ router_advertisement + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router discovery advertisements
+
+
+ router_solicitation + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router discovery solicitations
+
+
+ source_quench + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Source quenches
+
+
+ source_route_failed + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Source route failed
+
+
+ time_exceeded + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All time exceeded.
+
+
+ timestamp_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Timestamp replies
+
+
+ timestamp_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Timestamp requests
+
+
+ traceroute + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Traceroute
+
+
+ ttl_exceeded + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
TTL exceeded
+
+
+ unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All unreachables
+
+
+ icmpv6 + +
+ dictionary +
+ 		+ +
ICMPv6 protocol options.
+
+
+ beyond_scope + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Destination beyond scope.
+
+
+ destination_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Destination address is unreachable.
+
+
+ echo_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo reply.
+
+
+ echo_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo request (ping).
+
+
+ fragments + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Check non-initial fragments.
+
+
+ header + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter header problem.
+
+
+ hop_limit + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Hop limit exceeded in transit.
+
+
+ mld_query + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Multicast Listener Discovery Query.
+
+
+ mld_reduction + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Multicast Listener Discovery Reduction.
+
+
+ mld_report + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Multicast Listener Discovery Report.
+
+
+ mldv2 + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Multicast Listener Discovery Protocol.
+
+
+ nd_na + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor discovery neighbor advertisements.
+
+
+ nd_ns + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor discovery neighbor solicitations.
+
+
+ next_header + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter next header problems.
+
+
+ no_admin + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administration prohibited destination.
+
+
+ no_route + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
No route to destination.
+
+
+ packet_too_big + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Packet too big.
+
+
+ parameter_option + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter option problems.
+
+
+ parameter_problem + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All parameter problems.
+
+
+ port_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Port unreachable.
+
+
+ reassembly_timeout + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Reassembly timeout.
+
+
+ renum_command + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router renumbering command.
+
+
+ renum_result + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router renumbering result.
+
+
+ renum_seq_number + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router renumbering sequence number reset.
+
+
+ router_advertisement + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor discovery router advertisements.
+
+
+ router_renumbering + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All router renumbering.
+
+
+ router_solicitation + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor discovery router solicitations.
+
+
+ telemetry_path + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
IPT enabled.
+
+
+ telemetry_queue + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Flow of interest for BDC/HDC.
+
+
+ time_exceeded + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All time exceeded.
+
+
+ unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All unreachable.
+
+
+ igmp + +
+ dictionary +
+ 		+ +
IGMP protocol options.
+
+
+ dvmrp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Distance Vector Multicast Routing Protocol
+
+
+ host_query + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host Query
+
+
+ host_report + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host Report
+
+
+ tcp + +
+ dictionary +
+ 		+ +
TCP flags.
+
+
+ ack + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the ACK bit
+
+
+ established + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match established connections
+
+
+ fin + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the FIN bit
+
+
+ psh + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the PSH bit
+
+
+ rst + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the RST bit
+
+
+ syn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the SYN bit
+
+
+ urg + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the URG bit
+
+
+ remark + +
+ string +
+ 		+ +
Access list entry comment.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence number.
+
+
+ source + +
+ dictionary +
+ 		+ +
Specify the packet source.
+
+
+ address + +
+ string +
+ 		+ +
Source network address.
+
+
+ any + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Any source address.
+
+
+ host + +
+ string +
+ 		+ +
Host IP address.
+
+
+ port_protocol + +
+ dictionary +
+ 		+ +
Specify the destination port or protocol (only for TCP and UDP).
+
+
+ eq + +
+ string +
+ 		+ +
Match only packets on a given port number.
+
+
+ gt + +
+ string +
+ 		+ +
Match only packets with a greater port number.
+
+
+ lt + +
+ string +
+ 		+ +
Match only packets with a lower port number.
+
+
+ neq + +
+ string +
+ 		+ +
Match only packets not on a given port number.
+
+
+ range + +
+ dictionary +
+ 		+ +
Match only packets in the range of port numbers.
+
+
+ end + +
+ string +
+ 		+ +
Specify the end of the port range.
+
+
+ start + +
+ string +
+ 		+ +
Specify the start of the port range.
+
+
+ prefix + +
+ string +
+ 		+ +
Source network prefix. Only for prefixes of mask value less than 31 for ipv4 and 127 for ipv6. Prefixes of mask 32 (ipv4) and 128 (ipv6) should be given in the 'host' key.
+
+
+ wildcard_bits + +
+ string +
+ 		+ +
Source wildcard bits.
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the ACL.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
The Address Family Indicator (AFI) for the ACL.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section 'ip(v6* access-list).
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • deleted
    • +
  • gathered
    • +
  • merged ←
    • +
  • overridden
    • +
  • rendered
    • +
  • replaced
    • +
  • parsed
    • +
+ 		+
The state the configuration should be left in
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - As NX-OS allows configuring a rule again with different sequence numbers, the user is expected to provide sequence numbers for the access control entries to preserve idempotency. If no sequence number is given, the rule will be added as a new rule by the device. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + + - name: Merge provided ACLs configuration with device configuration + cisco.nxos.nxos_acls: + state: merged + config: + - afi: ipv4 + acls: + - name: ACL1v4 + aces: + - grant: deny + destination: + address: 192.0.2.64 + wildcard_bits: 0.0.0.255 + source: + any: true + port_protocol: + lt: 55 + protocol: tcp + protocol_options: + tcp: + ack: true + fin: true + sequence: 50 + + - afi: ipv6 + acls: + - name: ACL1v6 + aces: + - grant: permit + sequence: 10 + source: + any: true + destination: + prefix: 2001:db8:12::/32 + protocol: sctp + + # Task Output + # ----------- + # before: [] + # + # commands: + # - ip access-list ACL1v4 + # - 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + # - ipv6 access-list ACL1v6 + # - 10 permit sctp any 2001:db8:12::/32 + # + # after: + # - acls: + # - aces: + # - destination: + # prefix: 2001:db8:12::/32 + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # name: ACL1v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # address: 192.0.2.64 + # wildcard_bits: 0.0.0.255 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # fin: true + # sequence: 50 + # source: + # any: true + # port_protocol: + # lt: '55' + # name: ACL1v4 + # afi: ipv4 + + + # After state: + # ------------ + # + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + + # Using replaced + + # Before state: + # ---------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 10 permit ip any any + # 20 deny udp any any + # ip access-list ACL2v4 + # 10 permit ahp 192.0.2.0 0.0.0.255 any + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ipv6 access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + - name: Replace existing ACL configuration with provided configuration + cisco.nxos.nxos_acls: + config: + - afi: ipv4 + - afi: ipv6 + acls: + - name: ACL1v6 + aces: + - sequence: 20 + grant: permit + source: + any: true + destination: + any: true + protocol: pim + + - remark: Replaced ACE + - name: ACL2v6 + state: replaced + + # Task Output + # ----------- + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # - ipv6 access-list ACL1v6 + # - no 10 permit sctp any any + # - no 20 remark IPv6 ACL + # - remark Replaced ACE + # - 20 permit pim any any + # - ipv6 access-list ACL2v6 + # - no 10 deny ipv6 any 2001:db8:3000::/36 + # - no 20 permit tcp host 2001:db8:2000:2::2 host 2001:db8:2000:ab::2 + # + # after: + # - acls: + # - aces: + # - remark: Replaced ACE + # sequence: 10 + # - destination: + # any: true + # grant: permit + # protocol: pim + # sequence: 20 + # source: + # any: true + # name: ACL1v6 + # - name: ACL2v6 + # afi: ipv6 + + # After state: + # --------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ipv6 access-list ACL1v6 + # 10 remark Replaced ACE + # 20 permit pim any any + # ipv6 access-list ACL2v6 + + # Using overridden + + # Before state: + # ---------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 10 permit ip any any + # 20 deny udp any any + # ip access-list ACL2v4 + # 10 permit ahp 192.0.2.0 0.0.0.255 any + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ipv6 access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + - name: Override existing configuration with provided configuration + cisco.nxos.nxos_acls: + config: + - afi: ipv4 + acls: + - name: NewACL + aces: + - grant: deny + source: + address: 192.0.2.0 + wildcard_bits: 0.0.255.255 + destination: + any: true + protocol: eigrp + - remark: Example for overridden state + state: overridden + + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ipv6 access-list ACL1v6 + # - no ipv6 access-list ACL2v6 + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # - ip access-list NewACL + # - deny eigrp 192.0.2.0 0.0.255.255 any + # - remark Example for overridden state + # + # after: + # - acls: + # - aces: + # - destination: + # any: true + # grant: deny + # protocol: eigrp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.255.255 + # - remark: Example for overridden state + # sequence: 20 + # name: NewACL + # afi: ipv4 + + # After state: + # ------------ + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list NewACL + # 10 deny eigrp 192.0.2.0 0.0.255.255 any + # 20 remark Example for overridden state + + # Using deleted - delete all + # + # Before state: + # ------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 10 permit ip any any + # 20 deny udp any any + # ip access-list ACL2v4 + # 10 permit ahp 192.0.2.0 0.0.0.255 any + # ip access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ip access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + - name: Delete all ACLs + cisco.nxos.nxos_acls: + state: deleted + + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # - no ipv6 access-list ACL1v6 + # - no ipv6 access-list ACL2v6 + # + # after: [] + + + # After state: + # ----------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # + + # Using deleted - delete AFI + + # Before state: + # ------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 10 permit ip any any + # 20 deny udp any any + # ip access-list ACL2v4 + # 10 permit ahp 192.0.2.0 0.0.0.255 any + # ip access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ip access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + - name: Delete all ACLs in given AFI + cisco.nxos.nxos_acls: + config: + - afi: ipv4 + state: deleted + + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # + # after: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + + # After state: + # ------------ + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ip access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + # Using deleted - delete ACLs + + # Before state: + # ------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 10 permit ip any any + # 20 deny udp any any + # ip access-list ACL2v4 + # 10 permit ahp 192.0.2.0 0.0.0.255 any + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ipv6 access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + - name: Delete specific ACLs + cisco.nxos.nxos_acls: + state: deleted + config: + - afi: ipv4 + acls: + - name: ACL1v4 + - name: ACL2v4 + - afi: ipv6 + acls: + - name: ACL1v6 + + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # - no ipv6 access-list ACL1v6 + # + # after: + # - acls: + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + + # After state: + # ------------ + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ipv6 access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + # Using parsed + + - name: Parse given config to structured data + cisco.nxos.nxos_acls: + running_config: | + ip access-list ACL1v4 + 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + ipv6 access-list ACL1v6 + 10 permit sctp any any + state: parsed + + # Task Output + # ------------ + # + # parsed: + # - afi: ipv4 + # acls: + # - name: ACL1v4 + # aces: + # - grant: deny + # destination: + # address: 192.0.2.64 + # wildcard_bits: 0.0.0.255 + # source: + # any: true + # port_protocol: + # lt: 55 + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # fin: true + # sequence: 50 + # + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # aces: + # - grant: permit + # sequence: 10 + # source: + # any: true + # destination: + # prefix: 2001:db8:12::/32 + # protocol: sctp + + + # Using gathered: + + # Before state: + # ------------ + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + + - name: Gather existing configuration + cisco.nxos.nxos_acls: + state: gathered + + # Task Output + # ----------- + # + # gathered: + # - afi: ipv4 + # acls: + # - name: ACL1v4 + # aces: + # - grant: deny + # destination: + # address: 192.0.2.64 + # wildcard_bits: 0.0.0.255 + # source: + # any: true + # port_protocol: + # lt: 55 + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # fin: true + # sequence: 50 + + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # aces: + # - grant: permit + # sequence: 10 + # source: + # any: true + # destination: + # prefix: 2001:db8:12::/32 + # protocol: sctp + + + # Using rendered + + - name: Render required configuration to be pushed to the device + cisco.nxos.nxos_acls: + config: + - afi: ipv4 + acls: + - name: ACL1v4 + aces: + - grant: deny + destination: + address: 192.0.2.64 + wildcard_bits: 0.0.0.255 + source: + any: true + port_protocol: + lt: 55 + protocol: tcp + protocol_options: + tcp: + ack: true + fin: true + sequence: 50 + - afi: ipv6 + acls: + - name: ACL1v6 + aces: + - grant: permit + sequence: 10 + source: + any: true + destination: + prefix: '2001:db8:12::/32' + protocol: sctp + state: rendered + + + # Task Output + # ----------- + # + # rendered: + # ip access-list ACL1v4 + # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['ip access-list ACL1v4', '10 permit ip any any precedence critical log', '20 deny tcp any lt smtp host 192.0.2.64 ack fin']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['ip access-list ACL1v4', '10 permit ip any any precedence critical log', '20 deny tcp any lt smtp host 192.0.2.64 ack fin']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_banner_module.rst b/docs/cisco.nxos.nxos_banner_module.rst new file mode 100644 index 000000000..7502173b7 --- /dev/null +++ b/docs/cisco.nxos.nxos_banner_module.rst @@ -0,0 +1,187 @@ +.. _cisco.nxos.nxos_banner_module: + + +********************** +cisco.nxos.nxos_banner +********************** + +**Manage multiline banners on Cisco NXOS devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This will configure both exec and motd banners on remote devices running Cisco NXOS. It allows playbooks to add or remove banner text from the active running configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ banner + +
+ string + / required +
+ 		+
    Choices: +
  • exec
    • +
  • motd
    • +
+ 		+
Specifies which banner that should be configured on the remote device.
+
+
+ multiline_delimiter + +
+ string +
+ 		+ Default:
"@"
+ 		+
Specify the delimiting character than will be used for configuration.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specifies whether or not the configuration is present in the current devices active running configuration.
+
+
+ text + +
+ string +
+ 		+ +
The banner text that should be present in the remote device running configuration. This argument accepts a multiline string, with no empty lines. Requires state=present.
+
+
+ + +Notes +----- + +.. note:: + - Since responses from the device are always read with surrounding whitespaces stripped, tasks that configure banners with preceeding or trailing whitespaces will not be idempotent. + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: configure the exec banner + cisco.nxos.nxos_banner: + banner: exec + text: | + this is my exec banner + that contains a multiline + string + state: present + - name: remove the motd banner + cisco.nxos.nxos_banner: + banner: motd + state: absent + - name: Configure banner from file + cisco.nxos.nxos_banner: + banner: motd + text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}" + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['banner exec', 'this is my exec banner', 'that contains a multiline', 'string']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_bfd_global_module.rst b/docs/cisco.nxos.nxos_bfd_global_module.rst new file mode 100644 index 000000000..8cd86ec48 --- /dev/null +++ b/docs/cisco.nxos.nxos_bfd_global_module.rst @@ -0,0 +1,326 @@ +.. _cisco.nxos.nxos_bfd_global_module: + + +************************** +cisco.nxos.nxos_bfd_global +************************** + +**Bidirectional Forwarding Detection (BFD) global-level configuration** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages Bidirectional Forwarding Detection (BFD) global-level configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ echo_interface + +
+ string +
+ 		+ +
Loopback interface used for echo frames.
+
Valid values are loopback interface name or 'deleted'.
+
Not supported on N5K/N6K
+
+
+ echo_rx_interval + +
+ integer +
+ 		+ +
BFD Echo receive interval in milliseconds.
+
+
+ fabricpath_interval + +
+ dictionary +
+ 		+ +
BFD fabricpath interval timer values.
+
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
+
+
+ fabricpath_slow_timer + +
+ integer +
+ 		+ +
BFD fabricpath slow rate timer in milliseconds.
+
+
+ fabricpath_vlan + +
+ integer +
+ 		+ +
BFD fabricpath control vlan.
+
+
+ interval + +
+ dictionary +
+ 		+ +
BFD interval timer values.
+
Value must be a dict defining values for keys (tx, min_rx, and multiplier)
+
+
+ ipv4_echo_rx_interval + +
+ integer +
+ 		+ +
BFD IPv4 session echo receive interval in milliseconds.
+
+
+ ipv4_interval + +
+ dictionary +
+ 		+ +
BFD IPv4 interval timer values.
+
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
+
+
+ ipv4_slow_timer + +
+ integer +
+ 		+ +
BFD IPv4 slow rate timer in milliseconds.
+
+
+ ipv6_echo_rx_interval + +
+ integer +
+ 		+ +
BFD IPv6 session echo receive interval in milliseconds.
+
+
+ ipv6_interval + +
+ dictionary +
+ 		+ +
BFD IPv6 interval timer values.
+
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
+
+
+ ipv6_slow_timer + +
+ integer +
+ 		+ +
BFD IPv6 slow rate timer in milliseconds.
+
+
+ slow_timer + +
+ integer +
+ 		+ +
BFD slow rate timer in milliseconds.
+
+
+ startup_timer + +
+ integer +
+ 		+ +
BFD delayed startup timer in seconds.
+
Not supported on N5K/N6K/N7K
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 9.2(2) + - Unsupported for Cisco MDS + - BFD global will automatically enable 'feature bfd' if it is disabled. + - BFD global does not have a 'state' parameter. All of the BFD commands are unique and are defined if 'feature bfd' is enabled. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_bfd_global: + echo_interface: Ethernet1/2 + echo_rx_interval: 50 + interval: + tx: 50 + min_rx: 50 + multiplier: 4 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ cmds + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['bfd echo-interface loopback1', 'bfd slow-timer 2000']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_bfd_interfaces_module.rst b/docs/cisco.nxos.nxos_bfd_interfaces_module.rst new file mode 100644 index 000000000..975de891c --- /dev/null +++ b/docs/cisco.nxos.nxos_bfd_interfaces_module.rst @@ -0,0 +1,394 @@ +.. _cisco.nxos.nxos_bfd_interfaces_module: + + +****************************** +cisco.nxos.nxos_bfd_interfaces +****************************** + +**BFD interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages attributes of Bidirectional Forwarding Detection (BFD) on the interface. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
The provided configuration
+
+
+ bfd + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/Disable Bidirectional Forwarding Detection (BFD) on the interface.
+
+
+ echo + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/Disable BFD Echo functionality on the interface.
+
+
+ name + +
+ string +
+ 		+ +
The name of the interface.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface|^feature bfd'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state of the configuration after module completion
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 7.0(3)I5(1). + - Unsupported for Cisco MDS + - Feature bfd should be enabled for this module. + + + +Examples +-------- + +.. code-block:: yaml + + # Using deleted + + - name: Configure interfaces + cisco.nxos.nxos_bfd_interfaces: + state: deleted + + + # Using merged + + - name: Configure interfaces + cisco.nxos.nxos_bfd_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + echo: enable + - name: Ethernet1/2 + bfd: disable + echo: disable + state: merged + + + # Using overridden + + - name: Configure interfaces + cisco.nxos.nxos_bfd_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + echo: enable + - name: Ethernet1/2 + bfd: disable + echo: disable + state: overridden + + + # Using replaced + + - name: Configure interfaces + cisco.nxos.nxos_bfd_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + echo: enable + - name: Ethernet1/2 + bfd: disable + echo: disable + state: replaced + + # Using rendered + + - name: Use rendered state to convert task input to device specific commands + cisco.nxos.nxos_bfd_interfaces: + config: + - name: Ethernet1/800 + bfd: enable + echo: enable + - name: Ethernet1/801 + bfd: disable + echo: disable + state: rendered + + # Task Output (redacted) + # ----------------------- + + # rendered: + # - "interface Ethernet1/800" + # - "bfd" + # - "bfd echo" + # - "interface Ethernet1/801" + # - "no bfd" + # - "no bfd echo" + + # Using parsed + + # parsed.cfg + # ------------ + + # feature bfd + # interface Ethernet1/800 + # no switchport + # no bfd + # no bfd echo + # interface Ethernet1/801 + # no switchport + # no bfd + # interface Ethernet1/802 + # no switchport + # no bfd echo + # interface mgmt0 + # ip address dhcp + # vrf member management + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_bfd_interfaces: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + + # parsed: + # - bfd: disable + # echo: disable + # name: Ethernet1/800 + # - bfd: disable + # echo: enable + # name: Ethernet1/801 + # - bfd: enable + # echo: disable + # name: Ethernet1/802 + # - bfd: enable + # echo: enable + # name: mgmt0 + + # Using gathered + + # Existing device config state + # ------------------------------- + + # feature bfd + # interface Ethernet1/1 + # no switchport + # no bfd + # interface Ethernet1/2 + # no switchport + # no bfd echo + # interface mgmt0 + # ip address dhcp + # vrf member management + + - name: Gather bfd_interfaces facts from the device using nxos_bfd_interfaces + cisco.nxos.nxos_bfd_interfaces: + state: gathered + + # Task output (redacted) + # ----------------------- + # gathered: + # - name: Ethernet1/1 + # bfd: disable + # echo: enable + # - name: Ethernet1/3 + # echo: disable + # bfd: enable + # - name: mgmt0 + # bfd: enable + # echo: enable + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/1', 'no bfd', 'no bfd echo']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_bgp_global_module.rst b/docs/cisco.nxos.nxos_bgp_global_module.rst new file mode 100644 index 000000000..19ee2709e --- /dev/null +++ b/docs/cisco.nxos.nxos_bgp_global_module.rst @@ -0,0 +1,5843 @@ +.. _cisco.nxos.nxos_bgp_global_module: + + +************************** +cisco.nxos.nxos_bgp_global +************************** + +**BGP Global resource module.** + + +Version added: 1.4.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages global BGP configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A list of BGP process configuration.
+
+
+ affinity_group + +
+ dictionary +
+ 		+ +
Configure an affinity group.
+
+
+ group_id + +
+ integer +
+ 		+ +
Affinity Group ID.
+
+
+ as_number + +
+ string +
+ 		+ +
Autonomous System Number of the router.
+
+
+ bestpath + +
+ dictionary +
+ 		+ +
Define the default bestpath selection algorithm.
+
+
+ always_compare_med + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare MED on paths from different AS.
+
+
+ as_path + +
+ dictionary +
+ 		+ +
AS-Path.
+
+
+ ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore AS-Path during bestpath selection.
+
+
+ multipath_relax + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Relax AS-Path restriction when choosing multipaths.
+
+
+ compare_neighborid + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
When more paths are available than max path config, use neighborid as tie-breaker.
+
+
+ compare_routerid + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare router-id for identical EBGP paths.
+
+
+ cost_community_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore cost communities in bestpath selection.
+
+
+ igp_metric_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore IGP metric for next-hop during bestpath selection.
+
+
+ med + +
+ dictionary +
+ 		+ +
MED
+
+
+ confed + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare MED only from paths originated from within a confederation.
+
+
+ missing_as_worst + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Treat missing MED as highest MED.
+
+
+ non_deterministic + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Not always pick the best-MED path among paths from same AS.
+
+
+ cluster_id + +
+ string +
+ 		+ +
Configure Route Reflector Cluster-ID.
+
+
+ confederation + +
+ dictionary +
+ 		+ +
AS confederation parameters.
+
+
+ identifier + +
+ string +
+ 		+ +
Set routing domain confederation AS.
+
+
+ peers + +
+ list + / elements=string +
+ 		+ +
Peer ASs in BGP confederation.
+
+
+ disable_policy_batching + +
+ dictionary +
+ 		+ +
Disable batching evaluation of outbound policy for a peer.
+
+
+ ipv4 + +
+ dictionary +
+ 		+ +
IPv4 address-family settings.
+
+
+ prefix_list + +
+ string +
+ 		+ +
Name of prefix-list to apply.
+
+
+ ipv6 + +
+ dictionary +
+ 		+ +
IPv6 address-family settings.
+
+
+ prefix_list + +
+ string +
+ 		+ +
Name of prefix-list to apply.
+
+
+ nexthop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Batching based on nexthop.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set policy batching.
+
+
+ dynamic_med_interval + +
+ integer +
+ 		+ +
Sets the interval for dampening of med changes.
+
+
+ enforce_first_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enforce neighbor AS is the first AS in AS-PATH attribute (EBGP).
+
+
+ enhanced_error + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable BGP Enhanced error handling.
+
+
+ fabric_soo + +
+ string +
+ 		+ +
Fabric site of origin.
+
+
+ fast_external_fallover + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Immediately reset the session if the link to a directly connected BGP peer goes down.
+
+
+ flush_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Flush routes in RIB upon controlled restart.
+
+
+ graceful_restart + +
+ dictionary +
+ 		+ +
Configure Graceful Restart functionality.
+
+
+ helper + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure Graceful Restart Helper mode functionality.
+
+
+ restart_time + +
+ integer +
+ 		+ +
Maximum time for restart advertised to peers.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable graceful-restart.
+
+
+ stalepath_time + +
+ integer +
+ 		+ +
Maximum time to keep a restarting peer's stale routes.
+
+
+ graceful_shutdown + +
+ dictionary +
+ 		+ +
Graceful-shutdown for BGP protocol.
+
+
+ activate + +
+ dictionary +
+ 		+ +
Send graceful-shutdown community on all routes.
+
+
+ route_map + +
+ string +
+ 		+ +
Apply route-map to modify attributes for outbound.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Activiate graceful-shutdown.
+
+
+ aware + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Lower preference of routes carrying graceful-shutdown community.
+
+
+ isolate + +
+ dictionary +
+ 		+ +
Isolate this router from BGP perspective.
+
+
+ include_local + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Withdraw both local and remote BGP routes.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Withdraw remote BGP routes to isolate this router.
+
+
+ log_neighbor_changes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log a message for neighbor up/down event.
+
+
+ maxas_limit + +
+ integer +
+ 		+ +
Allow AS-PATH attribute from EBGP neighbor imposing a limit on number of ASes.
+
+
+ neighbor_down + +
+ dictionary +
+ 		+ +
Handle BGP neighbor down event, due to various reasons.
+
+
+ fib_accelerate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor.
+
+
+ neighbors + +
+ list + / elements=dictionary +
+ 		+ +
Configure BGP neighbors.
+
+
+ bfd + +
+ dictionary +
+ 		+ +
Bidirectional Fast Detection for the neighbor.
+
+
+ multihop + +
+ dictionary +
+ 		+ +
Multihop session.
+
+
+ interval + +
+ dictionary +
+ 		+ +
Configure BFD session interval parameters.
+
+
+ min_rx_interval + +
+ integer +
+ 		+ +
Minimum RX interval.
+
+
+ multiplier + +
+ integer +
+ 		+ +
Detect Multiplier.
+
+
+ tx_interval + +
+ integer +
+ 		+ +
TX interval in milliseconds.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD multihop.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD for this neighbor.
+
+
+ singlehop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Single-hop session.
+
+
+ bmp_activate_server + +
+ integer +
+ 		+ +
Specify server ID for activating BMP monitoring for the peer.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Capability.
+
+
+ suppress_4_byte_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress 4-byte AS Capability.
+
+
+ description + +
+ string +
+ 		+ +
Neighbor specific descripion.
+
+
+ disable_connected_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable check for directly connected peer.
+
+
+ dont_capability_negotiate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Don't negotiate capability with this neighbor.
+
+
+ dscp + +
+ string +
+ 		+ +
Set dscp value for tcp transport.
+
+
+ dynamic_capability + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Dynamic Capability
+
+
+ ebgp_multihop + +
+ integer +
+ 		+ +
Specify multihop TTL for remote peer.
+
+
+ graceful_shutdown + +
+ dictionary +
+ 		+ +
Graceful-shutdown for this neighbor.
+
+
+ activate + +
+ dictionary +
+ 		+ +
Send graceful-shutdown community.
+
+
+ route_map + +
+ string +
+ 		+ +
Apply route-map to modify attributes for outbound.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set activate.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a template.
+
+
+ peer + +
+ string +
+ 		+ +
Peer template to inherit.
+
+
+ peer_session + +
+ string +
+ 		+ +
Peer-session template to inherit.
+
+
+ local_as + +
+ string +
+ 		+ +
Specify the local-as number for the eBGP neighbor.
+
+
+ log_neighbor_changes + +
+ dictionary +
+ 		+ +
Log message for neighbor up/down event.
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable logging of neighbor up/down event.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set log-neighbor-changes.
+
+
+ low_memory + +
+ dictionary +
+ 		+ +
Behaviour in low memory situations.
+
+
+ exempt + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not shutdown this peer when under memory pressure.
+
+
+ neighbor_address + +
+ string + / required +
+ 		+ +
IP address/Prefix of the neighbor or interface.
+
+
+ neighbor_affinity_group + +
+ dictionary +
+ 		+ +
Configure an affinity group.
+
+
+ group_id + +
+ integer +
+ 		+ +
Affinity Group ID.
+
+
+ password + +
+ dictionary +
+ 		+ +
Configure a password for neighbor.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 specifies an UNENCRYPTED neighbor password.
+
3 specifies an 3DES ENCRYPTED neighbor password will follow.
+
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
+
+
+ key + +
+ string +
+ 		+ +
Authentication password.
+
+
+ path_attribute + +
+ list + / elements=dictionary +
+ 		+ +
BGP path attribute optional filtering.
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • discard
    • +
  • treat-as-withdraw
    • +
+ 		+
Action.
+
+
+ range + +
+ dictionary +
+ 		+ +
Path attribute range.
+
+
+ end + +
+ integer +
+ 		+ +
Path attribute range end value.
+
+
+ start + +
+ integer +
+ 		+ +
Path attribute range start value.
+
+
+ type + +
+ integer +
+ 		+ +
Path attribute type
+
+
+ peer_type + +
+ string +
+ 		+
    Choices: +
  • fabric-border-leaf
    • +
  • fabric-external
    • +
+ 		+
Neighbor facing
+
+
+ remote_as + +
+ string +
+ 		+ +
Specify Autonomous System Number of the neighbor.
+
+
+ remote_as_route_map + +
+ string +
+ 		+ +
Route-map to match prefix peer AS number.
+
+
+ remove_private_as + +
+ dictionary +
+ 		+ +
Remove private AS number from outbound updates.
+
+
+ all + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All.
+
+
+ replace_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Replace.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Remove private AS.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown this neighbor.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure keepalive and hold timers.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Holdtime (seconds).
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval (seconds).
+
+
+ transport + +
+ dictionary +
+ 		+ +
BGP transport connection.
+
+
+ connection_mode + +
+ dictionary +
+ 		+ +
Specify type of connection.
+
+
+ passive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Allow passive connection setup only.
+
+
+ ttl_security + +
+ dictionary +
+ 		+ +
Enable TTL Security Mechanism.
+
+
+ hops + +
+ integer +
+ 		+ +
Specify hop count for remote peer.
+
+
+ update_source + +
+ string +
+ 		+ +
Specify source of BGP session and updates.
+
+
+ nexthop + +
+ dictionary +
+ 		+ +
Nexthop resolution options.
+
+
+ suppress_default_resolution + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Prohibit use of default route for nexthop address resolution.
+
+
+ rd + +
+ dictionary +
+ 		+ +
Secondary Route Distinguisher for vxlan multisite border gateway.
+
+
+ dual + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Generate Secondary RD for all VRFs and L2VNIs.
+
+
+ id + +
+ integer +
+ 		+ +
Specify 2 byte value for ID.
+
+
+ reconnect_interval + +
+ integer +
+ 		+ +
Configure connection reconnect interval.
+
+
+ router_id + +
+ string +
+ 		+ +
Specify the IP address to use as router-id.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown BGP protocol.
+
+
+ suppress_fib_pending + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise only routes that are programmed in hardware to peers.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure bgp related timers.
+
+
+ bestpath_limit + +
+ dictionary +
+ 		+ +
Configure timeout for first bestpath after restart.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure update-delay-always option.
+
+
+ timeout + +
+ integer +
+ 		+ +
Bestpath timeout (seconds).
+
+
+ bgp + +
+ dictionary +
+ 		+ +
Configure different bgp keepalive and holdtimes.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Holdtime (seconds).
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval (seconds).
+
+
+ prefix_peer_timeout + +
+ integer +
+ 		+ +
Prefix Peer timeout (seconds).
+
+
+ prefix_peer_wait + +
+ integer +
+ 		+ +
Configure wait timer for a prefix peer.
+
+
+ vrfs + +
+ list + / elements=dictionary +
+ 		+ +
Virtual Router Context configurations.
+
+
+ allocate_index + +
+ integer +
+ 		+ +
Configure allocate-index.
+
+
+ bestpath + +
+ dictionary +
+ 		+ +
Define the default bestpath selection algorithm.
+
+
+ always_compare_med + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare MED on paths from different AS.
+
+
+ as_path + +
+ dictionary +
+ 		+ +
AS-Path.
+
+
+ ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore AS-Path during bestpath selection.
+
+
+ multipath_relax + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Relax AS-Path restriction when choosing multipaths.
+
+
+ compare_neighborid + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
When more paths are available than max path config, use neighborid as tie-breaker.
+
+
+ compare_routerid + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare router-id for identical EBGP paths.
+
+
+ cost_community_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore cost communities in bestpath selection.
+
+
+ igp_metric_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore IGP metric for next-hop during bestpath selection.
+
+
+ med + +
+ dictionary +
+ 		+ +
MED
+
+
+ confed + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare MED only from paths originated from within a confederation.
+
+
+ missing_as_worst + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Treat missing MED as highest MED.
+
+
+ non_deterministic + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Not always pick the best-MED path among paths from same AS.
+
+
+ cluster_id + +
+ string +
+ 		+ +
Configure Route Reflector Cluster-ID.
+
+
+ confederation + +
+ dictionary +
+ 		+ +
AS confederation parameters.
+
+
+ identifier + +
+ string +
+ 		+ +
Set routing domain confederation AS.
+
+
+ peers + +
+ list + / elements=string +
+ 		+ +
Peer ASs in BGP confederation.
+
+
+ graceful_restart + +
+ dictionary +
+ 		+ +
Configure Graceful Restart functionality.
+
+
+ helper + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure Graceful Restart Helper mode functionality.
+
+
+ restart_time + +
+ integer +
+ 		+ +
Maximum time for restart advertised to peers.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable graceful-restart.
+
+
+ stalepath_time + +
+ integer +
+ 		+ +
Maximum time to keep a restarting peer's stale routes.
+
+
+ local_as + +
+ string +
+ 		+ +
Specify the local-as for this vrf.
+
+
+ log_neighbor_changes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log a message for neighbor up/down event.
+
+
+ maxas_limit + +
+ integer +
+ 		+ +
Allow AS-PATH attribute from EBGP neighbor imposing a limit on number of ASes.
+
+
+ neighbor_down + +
+ dictionary +
+ 		+ +
Handle BGP neighbor down event, due to various reasons.
+
+
+ fib_accelerate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor.
+
+
+ neighbors + +
+ list + / elements=dictionary +
+ 		+ +
Configure BGP neighbors.
+
+
+ bfd + +
+ dictionary +
+ 		+ +
Bidirectional Fast Detection for the neighbor.
+
+
+ multihop + +
+ dictionary +
+ 		+ +
Multihop session.
+
+
+ interval + +
+ dictionary +
+ 		+ +
Configure BFD session interval parameters.
+
+
+ min_rx_interval + +
+ integer +
+ 		+ +
Minimum RX interval.
+
+
+ multiplier + +
+ integer +
+ 		+ +
Detect Multiplier.
+
+
+ tx_interval + +
+ integer +
+ 		+ +
TX interval in milliseconds.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD multihop.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD for this neighbor.
+
+
+ singlehop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Single-hop session.
+
+
+ bmp_activate_server + +
+ integer +
+ 		+ +
Specify server ID for activating BMP monitoring for the peer.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Capability.
+
+
+ suppress_4_byte_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress 4-byte AS Capability.
+
+
+ description + +
+ string +
+ 		+ +
Neighbor specific descripion.
+
+
+ disable_connected_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable check for directly connected peer.
+
+
+ dont_capability_negotiate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Don't negotiate capability with this neighbor.
+
+
+ dscp + +
+ string +
+ 		+ +
Set dscp value for tcp transport.
+
+
+ dynamic_capability + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Dynamic Capability
+
+
+ ebgp_multihop + +
+ integer +
+ 		+ +
Specify multihop TTL for remote peer.
+
+
+ graceful_shutdown + +
+ dictionary +
+ 		+ +
Graceful-shutdown for this neighbor.
+
+
+ activate + +
+ dictionary +
+ 		+ +
Send graceful-shutdown community.
+
+
+ route_map + +
+ string +
+ 		+ +
Apply route-map to modify attributes for outbound.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set activate.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a template.
+
+
+ peer + +
+ string +
+ 		+ +
Peer template to inherit.
+
+
+ peer_session + +
+ string +
+ 		+ +
Peer-session template to inherit.
+
+
+ local_as + +
+ string +
+ 		+ +
Specify the local-as number for the eBGP neighbor.
+
+
+ log_neighbor_changes + +
+ dictionary +
+ 		+ +
Log message for neighbor up/down event.
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable logging of neighbor up/down event.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set log-neighbor-changes.
+
+
+ low_memory + +
+ dictionary +
+ 		+ +
Behaviour in low memory situations.
+
+
+ exempt + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not shutdown this peer when under memory pressure.
+
+
+ neighbor_address + +
+ string + / required +
+ 		+ +
IP address/Prefix of the neighbor or interface.
+
+
+ neighbor_affinity_group + +
+ dictionary +
+ 		+ +
Configure an affinity group.
+
+
+ group_id + +
+ integer +
+ 		+ +
Affinity Group ID.
+
+
+ password + +
+ dictionary +
+ 		+ +
Configure a password for neighbor.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 specifies an UNENCRYPTED neighbor password.
+
3 specifies an 3DES ENCRYPTED neighbor password will follow.
+
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
+
+
+ key + +
+ string +
+ 		+ +
Authentication password.
+
+
+ path_attribute + +
+ list + / elements=dictionary +
+ 		+ +
BGP path attribute optional filtering.
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • discard
    • +
  • treat-as-withdraw
    • +
+ 		+
Action.
+
+
+ range + +
+ dictionary +
+ 		+ +
Path attribute range.
+
+
+ end + +
+ integer +
+ 		+ +
Path attribute range end value.
+
+
+ start + +
+ integer +
+ 		+ +
Path attribute range start value.
+
+
+ type + +
+ integer +
+ 		+ +
Path attribute type
+
+
+ peer_type + +
+ string +
+ 		+
    Choices: +
  • fabric-border-leaf
    • +
  • fabric-external
    • +
+ 		+
Neighbor facing
+
+
+ remote_as + +
+ string +
+ 		+ +
Specify Autonomous System Number of the neighbor.
+
+
+ remote_as_route_map + +
+ string +
+ 		+ +
Route-map to match prefix peer AS number.
+
+
+ remove_private_as + +
+ dictionary +
+ 		+ +
Remove private AS number from outbound updates.
+
+
+ all + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All.
+
+
+ replace_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Replace.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Remove private AS.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown this neighbor.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure keepalive and hold timers.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Holdtime (seconds).
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval (seconds).
+
+
+ transport + +
+ dictionary +
+ 		+ +
BGP transport connection.
+
+
+ connection_mode + +
+ dictionary +
+ 		+ +
Specify type of connection.
+
+
+ passive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Allow passive connection setup only.
+
+
+ ttl_security + +
+ dictionary +
+ 		+ +
Enable TTL Security Mechanism.
+
+
+ hops + +
+ integer +
+ 		+ +
Specify hop count for remote peer.
+
+
+ update_source + +
+ string +
+ 		+ +
Specify source of BGP session and updates.
+
+
+ reconnect_interval + +
+ integer +
+ 		+ +
Configure connection reconnect interval.
+
+
+ router_id + +
+ string +
+ 		+ +
Specify the IP address to use as router-id.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure bgp related timers.
+
+
+ bestpath_limit + +
+ dictionary +
+ 		+ +
Configure timeout for first bestpath after restart.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure update-delay-always option.
+
+
+ timeout + +
+ integer +
+ 		+ +
Bestpath timeout (seconds).
+
+
+ bgp + +
+ dictionary +
+ 		+ +
Configure different bgp keepalive and holdtimes.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Holdtime (seconds).
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval (seconds).
+
+
+ prefix_peer_timeout + +
+ integer +
+ 		+ +
Prefix Peer timeout (seconds).
+
+
+ prefix_peer_wait + +
+ integer +
+ 		+ +
Configure wait timer for a prefix peer.
+
+
+ vrf + +
+ string +
+ 		+ +
VRF name.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^router bgp'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • purged
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
State purged removes all the BGP configurations from the target device. Use caution with this state.
+
State deleted only removes BGP attributes that this modules manages and does not negate the BGP process completely. Thereby, preserving address-family related configurations under BGP context.
+
Running states deleted and replaced will result in an error if there are address-family configuration lines present under a neighbor, or a vrf context that is to be removed. Please use the cisco.nxos.nxos_bgp_af or cisco.nxos.nxos_bgp_neighbor_af modules for prior cleanup.
+
States merged and replaced will result in a failure if BGP is already configured with a different ASN than what is provided in the task. In such cases, please use state purged to remove the existing BGP process and proceed further.
+
States replaced and overridden have the same behaviour for this module.
+
Refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # Nexus9000v# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_bgp_global: + config: + as_number: 65563 + router_id: 192.168.1.1 + bestpath: + as_path: + multipath_relax: true + compare_neighborid: true + cost_community_ignore: true + confederation: + identifier: 42 + peers: + - 65020 + - 65030 + - 65040 + log_neighbor_changes: true + maxas_limit: 20 + neighbors: + - neighbor_address: 192.168.1.100 + neighbor_affinity_group: + group_id: 160 + bmp_activate_server: 1 + remote_as: 65563 + description: NBR-1 + low_memory: + exempt: true + - neighbor_address: 192.168.1.101 + remote_as: 65563 + password: + encryption: 7 + key: 12090404011C03162E + neighbor_down: + fib_accelerate: true + vrfs: + - vrf: site-1 + allocate_index: 5000 + local_as: 200 + log_neighbor_changes: true + neighbors: + - neighbor_address: 198.51.100.1 + description: site-1-nbr-1 + password: + encryption: 3 + key: 13D4D3549493D2877B1DC116EE27A6BE + remote_as: 65562 + - neighbor_address: 198.51.100.2 + remote_as: 65562 + description: site-1-nbr-2 + - vrf: site-2 + local_as: 300 + log_neighbor_changes: true + neighbors: + - neighbor_address: 203.0.113.2 + description: site-2-nbr-1 + password: + encryption: 3 + key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + remote_as: 65568 + neighbor_down: + fib_accelerate: true + + # Task output: + # ------------ + # before: {} + # + # commands: + # - router bgp 65563 + # - bestpath as-path multipath-relax + # - bestpath compare-neighborid + # - bestpath cost-community ignore + # - confederation identifier 42 + # - log-neighbor-changes + # - maxas-limit 20 + # - neighbor-down fib-accelerate + # - router-id 192.168.1.1 + # - confederation peers 65020 65030 65040 + # - neighbor 192.168.1.100 + # - remote-as 65563 + # - affinity-group 160 + # - bmp-activate-server 1 + # - description NBR-1 + # - low-memory exempt + # - neighbor 192.168.1.101 + # - remote-as 65563 + # - password 7 12090404011C03162E + # - vrf site-1 + # - allocate-index 5000 + # - local-as 200 + # - log-neighbor-changes + # - neighbor 198.51.100.1 + # - remote-as 65562 + # - description site-1-nbr-1 + # - password 3 13D4D3549493D2877B1DC116EE27A6BE + # - neighbor 198.51.100.2 + # - remote-as 65562 + # - description site-1-nbr-2 + # - vrf site-2 + # - local-as 300 + # - log-neighbor-changes + # - neighbor-down fib-accelerate + # - neighbor 203.0.113.2 + # - remote-as 65568 + # - description site-2-nbr-1 + # - password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + # + # after: + # as_number: '65563' + # bestpath: + # as_path: + # multipath_relax: true + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65040' + # log_neighbor_changes: true + # maxas_limit: 20 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # - neighbor_address: 192.168.1.101 + # password: + # encryption: 7 + # key: 12090404011C03162E + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - allocate_index: 5000 + # local_as: '200' + # log_neighbor_changes: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 198.51.100.1 + # password: + # encryption: 3 + # key: 13D4D3549493D2877B1DC116EE27A6BE + # remote_as: '65562' + # - description: site-1-nbr-2 + # neighbor_address: 198.51.100.2 + # remote_as: '65562' + # vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - description: site-2-nbr-1 + # neighbor_address: 203.0.113.2 + # password: + # encryption: 3 + # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + # remote_as: '65568' + # vrf: site-2 + + + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65040 + # bestpath as-path multipath-relax + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 20 + # log-neighbor-changes + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # neighbor 192.168.1.101 + # remote-as 65563 + # password 7 12090404011C03162E + # vrf site-1 + # local-as 200 + # log-neighbor-changes + # allocate-index 5000 + # neighbor 198.51.100.1 + # remote-as 65562 + # description site-1-nbr-1 + # password 3 13D4D3549493D2877B1DC116EE27A6BE + # neighbor 198.51.100.2 + # remote-as 65562 + # description site-1-nbr-2 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # remote-as 65568 + # description site-2-nbr-1 + # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + # Using replaced + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65040 + # bestpath as-path multipath-relax + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 20 + # log-neighbor-changes + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # neighbor 192.168.1.101 + # remote-as 65563 + # password 7 12090404011C03162E + # vrf site-1 + # local-as 200 + # log-neighbor-changes + # allocate-index 5000 + # neighbor 198.51.100.1 + # remote-as 65562 + # description site-1-nbr-1 + # password 3 13D4D3549493D2877B1DC116EE27A6BE + # neighbor 198.51.100.2 + # remote-as 65562 + # description site-1-nbr-2 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # remote-as 65568 + # description site-2-nbr-1 + # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + - name: Replace BGP configuration with provided configuration + cisco.nxos.nxos_bgp_global: + config: + as_number: 65563 + router_id: 192.168.1.1 + bestpath: + compare_neighborid: true + cost_community_ignore: true + confederation: + identifier: 42 + peers: + - 65020 + - 65030 + - 65050 + maxas_limit: 40 + neighbors: + - neighbor_address: 192.168.1.100 + neighbor_affinity_group: + group_id: 160 + bmp_activate_server: 1 + remote_as: 65563 + description: NBR-1 + low_memory: + exempt: true + neighbor_down: + fib_accelerate: true + vrfs: + - vrf: site-2 + local_as: 300 + log_neighbor_changes: true + neighbors: + - neighbor_address: 203.0.113.2 + password: + encryption: 7 + key: 12090404011C03162E + neighbor_down: + fib_accelerate: true + state: replaced + + # Task output: + # ------------ + # before: + # as_number: '65563' + # bestpath: + # as_path: + # multipath_relax: true + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65040' + # log_neighbor_changes: true + # maxas_limit: 20 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # - neighbor_address: 192.168.1.101 + # password: + # encryption: 7 + # key: 12090404011C03162E + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - allocate_index: 5000 + # local_as: '200' + # log_neighbor_changes: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 198.51.100.1 + # password: + # encryption: 3 + # key: 13D4D3549493D2877B1DC116EE27A6BE + # remote_as: '65562' + # - description: site-1-nbr-2 + # neighbor_address: 198.51.100.2 + # remote_as: '65562' + # vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - description: site-2-nbr-1 + # neighbor_address: 203.0.113.2 + # password: + # encryption: 3 + # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + # remote_as: '65568' + # vrf: site-2 + # + # commands: + # - router bgp 65563 + # - no bestpath as-path multipath-relax + # - no log-neighbor-changes + # - maxas-limit 40 + # - no confederation peers 65020 65030 65040 + # - confederation peers 65020 65030 65050 + # - no neighbor 192.168.1.101 + # - vrf site-2 + # - neighbor 203.0.113.2 + # - no remote-as 65568 + # - no description site-2-nbr-1 + # - password 7 12090404011C03162E + # - no vrf site-1 + + # after: + # as_number: '65563' + # bestpath: + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65050' + # maxas_limit: 40 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - neighbor_address: 203.0.113.2 + # password: + # encryption: 7 + # key: 12090404011C03162E + # vrf: site-2 + # + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65050 + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 40 + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # password 7 12090404011C03162E + + # Using deleted + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65040 + # bestpath as-path multipath-relax + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 20 + # log-neighbor-changes + # address-family ipv4 unicast + # default-metric 400 + # suppress-inactive + # default-information originate + # address-family ipv6 multicast + # wait-igp-convergence + # redistribute eigrp eigrp-1 route-map site-1-rmap + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # neighbor 192.168.1.101 + # remote-as 65563 + # password 7 12090404011C03162E + # vrf site-1 + # local-as 200 + # log-neighbor-changes + # allocate-index 5000 + # address-family ipv4 multicast + # maximum-paths 40 + # dampen-igp-metric 1200 + # neighbor 198.51.100.1 + # remote-as 65562 + # description site-1-nbr-1 + # password 3 13D4D3549493D2877B1DC116EE27A6BE + # neighbor 198.51.100.2 + # remote-as 65562 + # description site-1-nbr-2 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # remote-as 65568 + # description site-1-nbr-1 + # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + - name: Delete BGP configurations handled by this module + cisco.nxos.nxos_bgp_global: + state: deleted + + # Task output: + # ------------ + + # before: + # as_number: '65563' + # bestpath: + # as_path: + # multipath_relax: true + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65040' + # log_neighbor_changes: true + # maxas_limit: 20 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # - neighbor_address: 192.168.1.101 + # password: + # encryption: 7 + # key: 12090404011C03162E + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - allocate_index: 5000 + # local_as: '200' + # log_neighbor_changes: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 198.51.100.1 + # password: + # encryption: 3 + # key: 13D4D3549493D2877B1DC116EE27A6BE + # remote_as: '65562' + # - description: site-1-nbr-2 + # neighbor_address: 198.51.100.2 + # remote_as: '65562' + # vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 203.0.113.2 + # password: + # encryption: 3 + # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + # remote_as: '65568' + # vrf: site-2 + # + # commands: + # - router bgp 65563 + # - no bestpath as-path multipath-relax + # - no bestpath compare-neighborid + # - no bestpath cost-community ignore + # - no confederation identifier 42 + # - no log-neighbor-changes + # - no maxas-limit 20 + # - no neighbor-down fib-accelerate + # - no router-id 192.168.1.1 + # - no confederation peers 65020 65030 65040 + # - no neighbor 192.168.1.100 + # - no neighbor 192.168.1.101 + # - no vrf site-1 + # - no vrf site-2 + # + # after: + # as_number: '65563' + # + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # address-family ipv4 unicast + # default-metric 400 + # suppress-inactive + # default-information originate + # address-family ipv6 multicast + # wait-igp-convergence + # redistribute eigrp eigrp-1 route-map site-1-rmap + # + + # Using purged + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65040 + # bestpath as-path multipath-relax + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 20 + # log-neighbor-changes + # address-family ipv4 unicast + # default-metric 400 + # suppress-inactive + # default-information originate + # address-family ipv6 multicast + # wait-igp-convergence + # redistribute eigrp eigrp-1 route-map site-1-rmap + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # neighbor 192.168.1.101 + # remote-as 65563 + # password 7 12090404011C03162E + # vrf site-1 + # local-as 200 + # log-neighbor-changes + # allocate-index 5000 + # address-family ipv4 multicast + # maximum-paths 40 + # dampen-igp-metric 1200 + # neighbor 198.51.100.1 + # remote-as 65562 + # description site-1-nbr-1 + # password 3 13D4D3549493D2877B1DC116EE27A6BE + # neighbor 198.51.100.2 + # remote-as 65562 + # description site-1-nbr-2 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # remote-as 65568 + # description site-1-nbr-1 + # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + - name: Purge all BGP configurations from the device + cisco.nxos.nxos_bgp_global: + state: purged + + # Task output: + # ------------ + + # before: + # as_number: '65563' + # bestpath: + # as_path: + # multipath_relax: true + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65040' + # log_neighbor_changes: true + # maxas_limit: 20 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # - neighbor_address: 192.168.1.101 + # password: + # encryption: 7 + # key: 12090404011C03162E + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - allocate_index: 5000 + # local_as: '200' + # log_neighbor_changes: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 198.51.100.1 + # password: + # encryption: 3 + # key: 13D4D3549493D2877B1DC116EE27A6BE + # remote_as: '65562' + # - description: site-1-nbr-2 + # neighbor_address: 198.51.100.2 + # remote_as: '65562' + # vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 203.0.113.2 + # password: + # encryption: 3 + # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + # remote_as: '65568' + # vrf: site-2 + # + # commands: + # - no router bgp 65563 + # + # after: {} + # + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # Nexus9000v# + + # Using rendered + + - name: Render platform specific configuration lines (without connecting to the device) + cisco.nxos.nxos_bgp_global: + config: + as_number: 65563 + router_id: 192.168.1.1 + bestpath: + as_path: + multipath_relax: true + compare_neighborid: true + cost_community_ignore: true + confederation: + identifier: 42 + peers: + - 65020 + - 65030 + - 65040 + log_neighbor_changes: true + maxas_limit: 20 + neighbors: + - neighbor_address: 192.168.1.100 + neighbor_affinity_group: + group_id: 160 + bmp_activate_server: 1 + remote_as: 65563 + description: NBR-1 + low_memory: + exempt: true + - neighbor_address: 192.168.1.101 + remote_as: 65563 + password: + encryption: 7 + key: 12090404011C03162E + neighbor_down: + fib_accelerate: true + vrfs: + - vrf: site-1 + allocate_index: 5000 + local_as: 200 + log_neighbor_changes: true + neighbors: + - neighbor_address: 198.51.100.1 + description: site-1-nbr-1 + password: + encryption: 3 + key: 13D4D3549493D2877B1DC116EE27A6BE + remote_as: 65562 + - neighbor_address: 198.51.100.2 + remote_as: 65562 + description: site-1-nbr-2 + - vrf: site-2 + local_as: 300 + log_neighbor_changes: true + neighbors: + - neighbor_address: 203.0.113.2 + description: site-1-nbr-1 + password: + encryption: 3 + key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + remote_as: 65568 + neighbor_down: + fib_accelerate: true + + # Task output: + # ------------ + # rendered: + # - router bgp 65563 + # - bestpath as-path multipath-relax + # - bestpath compare-neighborid + # - bestpath cost-community ignore + # - confederation identifier 42 + # - log-neighbor-changes + # - maxas-limit 20 + # - neighbor-down fib-accelerate + # - router-id 192.168.1.1 + # - confederation peers 65020 65030 65040 + # - neighbor 192.168.1.100 + # - remote-as 65563 + # - affinity-group 160 + # - bmp-activate-server 1 + # - description NBR-1 + # - low-memory exempt + # - neighbor 192.168.1.101 + # - remote-as 65563 + # - password 7 12090404011C03162E + # - vrf site-1 + # - allocate-index 5000 + # - local-as 200 + # - log-neighbor-changes + # - neighbor 198.51.100.1 + # - remote-as 65562 + # - description site-1-nbr-1 + # - password 3 13D4D3549493D2877B1DC116EE27A6BE + # - neighbor 198.51.100.2 + # - remote-as 65562 + # - description site-1-nbr-2 + # - vrf site-2 + # - local-as 300 + # - log-neighbor-changes + # - neighbor-down fib-accelerate + # - neighbor 203.0.113.2 + # - remote-as 65568 + # - description site-1-nbr-1 + # - password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + # Using parsed + + # parsed.cfg + # ------------ + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65040 + # bestpath as-path multipath-relax + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 20 + # log-neighbor-changes + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # neighbor 192.168.1.101 + # remote-as 65563 + # password 7 12090404011C03162E + # vrf site-1 + # local-as 200 + # log-neighbor-changes + # allocate-index 5000 + # neighbor 198.51.100.1 + # remote-as 65562 + # description site-1-nbr-1 + # password 3 13D4D3549493D2877B1DC116EE27A6BE + # neighbor 198.51.100.2 + # remote-as 65562 + # description site-1-nbr-2 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # remote-as 65568 + # description site-1-nbr-1 + # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + - name: Parse externally provided BGP config + cisco.nxos.nxos_bgp_global: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output: + # ------------ + # parsed: + # as_number: '65563' + # bestpath: + # as_path: + # multipath_relax: true + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65040' + # log_neighbor_changes: true + # maxas_limit: 20 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # - neighbor_address: 192.168.1.101 + # password: + # encryption: 7 + # key: 12090404011C03162E + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - allocate_index: 5000 + # local_as: '200' + # log_neighbor_changes: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 198.51.100.1 + # password: + # encryption: 3 + # key: 13D4D3549493D2877B1DC116EE27A6BE + # remote_as: '65562' + # - description: site-1-nbr-2 + # neighbor_address: 198.51.100.2 + # remote_as: '65562' + # vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 203.0.113.2 + # password: + # encryption: 3 + # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + # remote_as: '65568' + # vrf: site-2 + + # Using gathered + + # existing config + # + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65050 + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 40 + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # vrf site-1 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # password 7 12090404011C03162E + + - name: Gather BGP facts using gathered + cisco.nxos.nxos_bgp_global: + state: gathered + + # Task output: + # ------------ + # gathered: + # as_number: '65563' + # bestpath: + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65050' + # maxas_limit: 40 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - neighbor_address: 203.0.113.2 + # password: + # encryption: 7 + # key: 12090404011C03162E + # vrf: site-2 + + # Remove a neighbor having AF configurations with state replaced (will fail) + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # log-neighbor-changes + # maxas-limit 20 + # router-id 198.51.100.2 + # neighbor 203.0.113.2 + # address-family ipv4 unicast + # next-hop-self + # remote-as 65538 + # affinity-group 160 + # description NBR-1 + # low-memory exempt + # neighbor 192.0.2.1 + # remote-as 65537 + # password 7 12090404011C03162E + + - name: Remove a neighbor having AF configurations (should fail) + cisco.nxos.nxos_bgp_global: + config: + as_number: 65536 + router_id: 198.51.100.2 + maxas_limit: 20 + log_neighbor_changes: true + neighbors: + - neighbor_address: 192.0.2.1 + remote_as: 65537 + password: + encryption: 7 + key: 12090404011C03162E + state: replaced + + # Task output: + # ------------ + # fatal: [Nexus9000v]: FAILED! => changed=false + # msg: Neighbor 203.0.113.2 has address-family configurations. + # Please use the nxos_bgp_neighbor_af module to remove those first. + + # Remove a VRF having AF configurations with state replaced (will fail) + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # log-neighbor-changes + # maxas-limit 20 + # router-id 198.51.100.2 + # neighbor 192.0.2.1 + # remote-as 65537 + # password 7 12090404011C03162E + # vrf site-1 + # address-family ipv4 unicast + # default-information originate + # neighbor 203.0.113.2 + # remote-as 65538 + # affinity-group 160 + # description NBR-1 + # low-memory exempt + # vrf site-2 + # neighbor-down fib-accelerate + + - name: Remove a VRF having AF configurations (should fail) + cisco.nxos.nxos_bgp_global: + config: + as_number: 65536 + router_id: 198.51.100.2 + maxas_limit: 20 + log_neighbor_changes: true + neighbors: + - neighbor_address: 192.0.2.1 + remote_as: 65537 + password: + encryption: 7 + key: 12090404011C03162E + vrfs: + - vrf: site-2 + neighbor_down: + fib_accelerate: true + state: replaced + + # Task output: + # ------------ + # fatal: [Nexus9000v]: FAILED! => changed=false + # msg: VRF site-1 has address-family configurations. + # Please use the nxos_bgp_af module to remove those first. + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['router bgp 65563', 'maxas-limit 20', 'router-id 192.168.1.1', 'confederation peers 65020 65030 65040', 'neighbor 192.168.1.100', 'remote-as 65563', 'affinity-group 160', 'bmp-activate-server 1', 'description NBR-1', 'low-memory exempt', 'vrf site-1', 'log-neighbor-changes', 'neighbor 198.51.100.1', 'remote-as 65562', 'description site-1-nbr-1', 'password 3 13D4D3549493D2877B1DC116EE27A6BE']
+
+
+ gathered + +
+ dictionary +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ dictionary +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['router bgp 65563', 'maxas-limit 20', 'router-id 192.168.1.1']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst b/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst new file mode 100644 index 000000000..8668a0b9f --- /dev/null +++ b/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst @@ -0,0 +1,3575 @@ +.. _cisco.nxos.nxos_bgp_neighbor_address_family_module: + + +******************************************* +cisco.nxos.nxos_bgp_neighbor_address_family +******************************************* + +**BGP Neighbor Address Family resource module.** + + +Version added: 2.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages BGP Neighbor Address Family configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
BGP Neighbor AF configuration.
+
+
+ as_number + +
+ string +
+ 		+ +
Autonomous System Number of the router.
+
+
+ neighbors + +
+ list + / elements=dictionary +
+ 		+ +
A list of BGP Neighbor AF configuration.
+
+
+ address_family + +
+ list + / elements=dictionary +
+ 		+ +
BGP Neighbor Address Family related configurations.
+
+
+ advertise_map + +
+ dictionary +
+ 		+ +
Specify route-map for conditional advertisement.
+
+
+ exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition exists.
+
+
+ non_exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition does not exist.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
Route-map name.
+
+
+ advertisement_interval + +
+ integer +
+ 		+ +
Minimum interval between sending BGP routing updates.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
  • link-state
    • +
  • vpnv4
    • +
  • vpnv6
    • +
  • l2vpn
    • +
+ 		+
Address Family indicator.
+
+
+ allowas_in + +
+ dictionary +
+ 		+ +
Accept as-path with my AS present in it.
+
+
+ max_occurences + +
+ integer +
+ 		+ +
Number of occurrences of AS number, default is 3.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Activate allowas-in property.
+
+
+ as_override + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Override matching AS-number while sending update.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Advertise capability to the peer.
+
+
+ additional_paths + +
+ dictionary +
+ 		+ +
Additional paths capability.
+
+
+ receive + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Receive capability.
+
+
+ send + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Send capability.
+
+
+ default_originate + +
+ dictionary +
+ 		+ +
Originate a default toward this peer.
+
+
+ route_map + +
+ string +
+ 		+ +
Route-map to specify criteria for originating default.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set default-originate attribute.
+
+
+ disable_peer_as_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable checking of peer AS-number while advertising.
+
+
+ filter_list + +
+ dictionary +
+ 		+ +
Name of filter-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a template.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence number.
+
+
+ template + +
+ string +
+ 		+ +
Template name.
+
+
+ maximum_prefix + +
+ dictionary +
+ 		+ +
Maximum number of prefixes from this neighbor.
+
+
+ generate_warning_threshold + +
+ integer +
+ 		+ +
Threshold percentage at which to generate a warning.
+
+
+ max_prefix_limit + +
+ integer +
+ 		+ +
Maximum prefix limit.
+
+
+ restart_interval + +
+ integer +
+ 		+ +
Restart bgp connection after limit is exceeded.
+
+
+ warning_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Only give a warning message when limit is exceeded.
+
+
+ next_hop_self + +
+ dictionary +
+ 		+ +
Set our address as nexthop (non-reflected).
+
+
+ all_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set our address as nexthop for all routes.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set next-hop-self attribute.
+
+
+ next_hop_third_party + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compute a third-party nexthop if possible.
+
+
+ prefix_list + +
+ dictionary +
+ 		+ +
Apply prefix-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ rewrite_evpn_rt_asn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Auto generate RTs for EBGP neighbor.
+
+
+ rewrite_rt_asn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Auto generate RTs for EBGP neighbor.
+
+
+ route_map + +
+ dictionary +
+ 		+ +
Apply route-map to neighbor.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ route_reflector_client + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure a neighbor as Route reflector client.
+
+
+ safi + +
+ string +
+ 		+
    Choices: +
  • unicast
    • +
  • multicast
    • +
  • mvpn
    • +
  • evpn
    • +
+ 		+
Sub Address Family indicator.
+
+
+ send_community + +
+ dictionary +
+ 		+ +
Send Community attribute to this neighbor.
+
+
+ both + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Standard and Extended Community attributes.
+
+
+ extended + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Extended Community attribute.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set send-community attribute.
+
+
+ standard + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Standard Community attribute.
+
+
+ soft_reconfiguration_inbound + +
+ dictionary +
+ 		+ +
Soft reconfiguration.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always perform inbound soft reconfiguration.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set soft-reconfiguration inbound attribute.
+
+
+ soo + +
+ string +
+ 		+ +
Specify Site-of-origin extcommunity.
+
+
+ suppress_inactive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise only active routes to peer.
+
+
+ unsuppress_map + +
+ string +
+ 		+ +
Route-map to selectively unsuppress suppressed routes.
+
+
+ weight + +
+ integer +
+ 		+ +
Set default weight for routes from this neighbor.
+
+
+ neighbor_address + +
+ string + / required +
+ 		+ +
IP/IPv6 address of the neighbor.
+
+
+ vrfs + +
+ list + / elements=dictionary +
+ 		+ +
Virtual Router Context.
+
+
+ neighbors + +
+ list + / elements=dictionary +
+ 		+ +
A list of BGP Neighbor AF configuration.
+
+
+ address_family + +
+ list + / elements=dictionary +
+ 		+ +
BGP Neighbor Address Family related configurations.
+
+
+ advertise_map + +
+ dictionary +
+ 		+ +
Specify route-map for conditional advertisement.
+
+
+ exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition exists.
+
+
+ non_exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition does not exist.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
Route-map name.
+
+
+ advertisement_interval + +
+ integer +
+ 		+ +
Minimum interval between sending BGP routing updates.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
  • link-state
    • +
  • vpnv4
    • +
  • vpnv6
    • +
  • l2vpn
    • +
+ 		+
Address Family indicator.
+
+
+ allowas_in + +
+ dictionary +
+ 		+ +
Accept as-path with my AS present in it.
+
+
+ max_occurences + +
+ integer +
+ 		+ +
Number of occurrences of AS number, default is 3.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Activate allowas-in property.
+
+
+ as_override + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Override matching AS-number while sending update.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Advertise capability to the peer.
+
+
+ additional_paths + +
+ dictionary +
+ 		+ +
Additional paths capability.
+
+
+ receive + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Receive capability.
+
+
+ send + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Send capability.
+
+
+ default_originate + +
+ dictionary +
+ 		+ +
Originate a default toward this peer.
+
+
+ route_map + +
+ string +
+ 		+ +
Route-map to specify criteria for originating default.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set default-originate attribute.
+
+
+ disable_peer_as_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable checking of peer AS-number while advertising.
+
+
+ filter_list + +
+ dictionary +
+ 		+ +
Name of filter-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a template.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence number.
+
+
+ template + +
+ string +
+ 		+ +
Template name.
+
+
+ maximum_prefix + +
+ dictionary +
+ 		+ +
Maximum number of prefixes from this neighbor.
+
+
+ generate_warning_threshold + +
+ integer +
+ 		+ +
Threshold percentage at which to generate a warning.
+
+
+ max_prefix_limit + +
+ integer +
+ 		+ +
Maximum prefix limit.
+
+
+ restart_interval + +
+ integer +
+ 		+ +
Restart bgp connection after limit is exceeded.
+
+
+ warning_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Only give a warning message when limit is exceeded.
+
+
+ next_hop_self + +
+ dictionary +
+ 		+ +
Set our address as nexthop (non-reflected).
+
+
+ all_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set our address as nexthop for all routes.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set next-hop-self attribute.
+
+
+ next_hop_third_party + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compute a third-party nexthop if possible.
+
+
+ prefix_list + +
+ dictionary +
+ 		+ +
Apply prefix-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ rewrite_evpn_rt_asn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Auto generate RTs for EBGP neighbor.
+
+
+ rewrite_rt_asn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Auto generate RTs for EBGP neighbor.
+
+
+ route_map + +
+ dictionary +
+ 		+ +
Apply route-map to neighbor.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ route_reflector_client + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure a neighbor as Route reflector client.
+
+
+ safi + +
+ string +
+ 		+
    Choices: +
  • unicast
    • +
  • multicast
    • +
  • mvpn
    • +
  • evpn
    • +
+ 		+
Sub Address Family indicator.
+
+
+ send_community + +
+ dictionary +
+ 		+ +
Send Community attribute to this neighbor.
+
+
+ both + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Standard and Extended Community attributes.
+
+
+ extended + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Extended Community attribute.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set send-community attribute.
+
+
+ standard + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Standard Community attribute.
+
+
+ soft_reconfiguration_inbound + +
+ dictionary +
+ 		+ +
Soft reconfiguration.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always perform inbound soft reconfiguration.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set soft-reconfiguration inbound attribute.
+
+
+ soo + +
+ string +
+ 		+ +
Specify Site-of-origin extcommunity.
+
+
+ suppress_inactive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise only active routes to peer.
+
+
+ unsuppress_map + +
+ string +
+ 		+ +
Route-map to selectively unsuppress suppressed routes.
+
+
+ weight + +
+ integer +
+ 		+ +
Set default weight for routes from this neighbor.
+
+
+ neighbor_address + +
+ string + / required +
+ 		+ +
IP/IPv6 address of the neighbor.
+
+
+ vrf + +
+ string +
+ 		+ +
VRF name.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^router bgp'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
State deleted only removes BGP attributes that this modules manages and does not negate the BGP process completely.
+
Refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - For managing BGP address family configurations please use the :ref:`cisco.nxos.nxos_bgp_address_family ` module. + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # Nexus9000v# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_bgp_neighbor_address_family: &id001 + config: + as_number: 65536 + neighbors: + - neighbor_address: 192.0.2.32 + address_family: + - afi: ipv4 + safi: unicast + maximum_prefix: + max_prefix_limit: 20 + generate_warning_threshold: 75 + weight: 100 + prefix_list: + inbound: rmap1 + outbound: rmap2 + - afi: ipv6 + safi: unicast + - neighbor_address: 192.0.2.33 + address_family: + - afi: ipv4 + safi: multicast + inherit: + template: BasePolicy + sequence: 200 + vrfs: + - vrf: site-1 + neighbors: + - neighbor_address: 203.0.113.1 + address_family: + - afi: ipv4 + safi: unicast + suppress_inactive: true + next_hop_self: + set: true + - neighbor_address: 203.0.113.2 + address_family: + - afi: ipv6 + safi: unicast + - afi: ipv4 + safi: multicast + send_community: + set: true + + # Task output: + # ------------ + # before: {} + # + # commands: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - address-family ipv4 unicast + # - maximum-prefix 20 75 + # - weight 100 + # - prefix-list rmap1 in + # - prefix-list rmap2 out + # - address-family ipv6 unicast + # - neighbor 192.0.2.33 + # - address-family ipv4 multicast + # - inherit peer-policy BasePolicy 200 + # - vrf site-1 + # - neighbor 203.0.113.1 + # - address-family ipv4 unicast + # - suppress-inactive + # - next-hop-self + # - neighbor 203.0.113.2 + # - address-family ipv6 unicast + # - address-family ipv4 multicast + # - send-community + # + # after: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + # Using replaced + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + - name: Replace specified neighbor AFs with given configuration + cisco.nxos.nxos_bgp_neighbor_address_family: &replaced + config: + as_number: 65536 + neighbors: + - neighbor_address: 192.0.2.32 + address_family: + - afi: ipv4 + safi: unicast + weight: 110 + - afi: ipv6 + safi: unicast + - neighbor_address: 192.0.2.33 + address_family: + - afi: ipv4 + safi: multicast + inherit: + template: BasePolicy + sequence: 200 + vrfs: + - vrf: site-1 + neighbors: + - neighbor_address: 203.0.113.1 + address_family: + - afi: ipv4 + safi: unicast + - neighbor_address: 203.0.113.2 + address_family: + - afi: ipv6 + safi: unicast + - afi: ipv4 + safi: multicast + send_community: + set: true + state: replaced + + # Task output: + # ------------ + # before: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + # + # commands: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - address-family ipv4 unicast + # - no maximum-prefix 20 75 + # - weight 110 + # - no prefix-list rmap1 in + # - no prefix-list rmap2 out + # - vrf site-1 + # - neighbor 203.0.113.1 + # - address-family ipv4 unicast + # - no suppress-inactive + # - no next-hop-self + # + # after: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # weight: 110 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # weight 110 + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + # Using overridden + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + - name: Override all BGP AF configuration with provided configuration + cisco.nxos.nxos_bgp_neighbor_address_family: + config: + as_number: 65536 + neighbors: + - neighbor_address: 192.0.2.32 + address_family: + - afi: ipv4 + safi: unicast + vrfs: + - vrf: site-1 + neighbors: + - neighbor_address: 203.0.113.1 + address_family: + - afi: ipv4 + safi: unicast + suppress_inactive: true + next_hop_self: + set: true + state: overridden + + # Task output: + # ------------ + # before: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + # + # commands: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - address-family ipv4 unicast + # - no maximum-prefix 20 75 + # - no weight 100 + # - no prefix-list rmap1 in + # - no prefix-list rmap2 out + # - no address-family ipv6 unicast + # - neighbor 192.0.2.33 + # - no address-family ipv4 multicast + # - vrf site-1 + # - neighbor 203.0.113.2 + # - no address-family ipv4 multicast + # - no address-family ipv6 unicast + # + # after: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + + # Using deleted to remove specified neighbor AFs + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + - name: Delete BGP configs handled by this module + cisco.nxos.nxos_bgp_neighbor_address_family: + config: + as_number: 65536 + neighbors: + - neighbor_address: 192.0.2.32 + address_family: + - afi: ipv4 + safi: unicast + vrfs: + - vrf: site-1 + neighbors: + - neighbor_address: 203.0.113.2 + address_family: + - afi: ipv6 + safi: unicast + state: deleted + + # Task output: + # ------------ + # before: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + # + # commands: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - no address-family ipv4 unicast + # - vrf site-1 + # - neighbor 203.0.113.2 + # - no address-family ipv6 unicast + # + # after: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # + + # Using deleted to remove all neighbor AFs + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + - name: Delete all BGP neighbor AF configs handled by this module + cisco.nxos.nxos_bgp_neighbor_address_family: + state: deleted + + # Task output: + # ------------ + # before: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + # + # commands: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - no address-family ipv4 unicast + # - no address-family ipv6 unicast + # - neighbor 192.0.2.33 + # - no address-family ipv4 multicast + # - vrf site-1 + # - neighbor 203.0.113.1 + # - no address-family ipv4 unicast + # - neighbor 203.0.113.2 + # - no address-family ipv6 unicast + # - no address-family ipv4 multicast + # + # after: + # as_number: "65536" + # + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # neighbor 192.0.2.33 + # vrf site-1 + # neighbor 203.0.113.1 + # neighbor 203.0.113.2 + # + + # Using rendered + + - name: Render platform specific configuration lines with state rendered (without connecting to the device) + cisco.nxos.nxos_bgp_neighbor_address_family: + config: + as_number: 65536 + neighbors: + - neighbor_address: 192.0.2.32 + address_family: + - afi: ipv4 + safi: unicast + maximum_prefix: + max_prefix_limit: 20 + generate_warning_threshold: 75 + weight: 100 + prefix_list: + inbound: rmap1 + outbound: rmap2 + - afi: ipv6 + safi: unicast + - neighbor_address: 192.0.2.33 + address_family: + - afi: ipv4 + safi: multicast + inherit: + template: BasePolicy + sequence: 200 + vrfs: + - vrf: site-1 + neighbors: + - neighbor_address: 203.0.113.1 + address_family: + - afi: ipv4 + safi: unicast + suppress_inactive: true + next_hop_self: + set: true + - neighbor_address: 203.0.113.2 + address_family: + - afi: ipv6 + safi: unicast + - afi: ipv4 + safi: multicast + send_community: + set: true + state: rendered + + # Task output: + # ------------ + # rendered: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - address-family ipv4 unicast + # - maximum-prefix 20 75 + # - weight 100 + # - prefix-list rmap1 in + # - prefix-list rmap2 out + # - address-family ipv6 unicast + # - neighbor 192.0.2.33 + # - address-family ipv4 multicast + # - inherit peer-policy BasePolicy 200 + # - vrf site-1 + # - neighbor 203.0.113.1 + # - address-family ipv4 unicast + # - suppress-inactive + # - next-hop-self + # - neighbor 203.0.113.2 + # - address-family ipv6 unicast + # - address-family ipv4 multicast + # - send-community + + # Using parsed + + # parsed.cfg + # ------------ + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + + - name: Parse externally provided BGP neighbor AF config + register: result + cisco.nxos.nxos_bgp_neighbor_address_family: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output: + # ------------ + # parsed: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['router bgp 65536', 'neighbor 192.0.2.32', 'address-family ipv4 unicast']
+
+
+ gathered + +
+ dictionary +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ dictionary +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['router bgp 65536', 'neighbor 192.0.2.32', 'address-family ipv4 unicast']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_bgp_templates_module.rst b/docs/cisco.nxos.nxos_bgp_templates_module.rst new file mode 100644 index 000000000..9287d7a60 --- /dev/null +++ b/docs/cisco.nxos.nxos_bgp_templates_module.rst @@ -0,0 +1,2841 @@ +.. _cisco.nxos.nxos_bgp_templates_module: + + +***************************** +cisco.nxos.nxos_bgp_templates +***************************** + +**BGP Templates resource module.** + + +Version added: 4.2.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages BGP templates on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A list of BGP templates.
+
+
+ as_number + +
+ string +
+ 		+ +
Autonomous System Number of the router.
+
+
+ neighbor + +
+ list + / elements=dictionary +
+ 		+ +
Configure BGP peer templates.
+
+
+ address_family + +
+ list + / elements=dictionary +
+ 		+ +
Configure an address-family for peer.
+
+
+ advertise_map + +
+ dictionary +
+ 		+ +
Specify route-map for conditional advertisement.
+
+
+ exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition exists.
+
+
+ non_exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition does not exist.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
Route-map name.
+
+
+ advertisement_interval + +
+ integer +
+ 		+ +
Minimum interval between sending BGP routing updates.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
  • link-state
    • +
  • l2vpn
    • +
+ 		+
Address Family indicator.
+
+
+ allowas_in + +
+ dictionary +
+ 		+ +
Accept as-path with my AS present in it.
+
+
+ max_occurences + +
+ integer +
+ 		+ +
Number of occurrences of AS number, default is 3.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Activate allowas-in property.
+
+
+ as_override + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Override matching AS-number while sending update.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Advertise capability to the peer.
+
+
+ additional_paths + +
+ dictionary +
+ 		+ +
Additional paths capability.
+
+
+ receive + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Receive capability.
+
+
+ send + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Send capability.
+
+
+ default_originate + +
+ dictionary +
+ 		+ +
Originate a default toward this peer.
+
+
+ route_map + +
+ string +
+ 		+ +
Route-map to specify criteria for originating default.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set default-originate attribute.
+
+
+ disable_peer_as_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable checking of peer AS-number while advertising.
+
+
+ filter_list + +
+ dictionary +
+ 		+ +
Name of filter-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a peer-policy template.
+
+
+ peer_policy + +
+ string +
+ 		+ +
Peer-policy template to inherit.
+
+
+ maximum_prefix + +
+ dictionary +
+ 		+ +
Maximum number of prefixes from this neighbor.
+
+
+ generate_warning_threshold + +
+ integer +
+ 		+ +
Threshold percentage at which to generate a warning.
+
+
+ max_prefix_limit + +
+ integer +
+ 		+ +
Maximum prefix limit.
+
+
+ restart_interval + +
+ integer +
+ 		+ +
Restart bgp connection after limit is exceeded.
+
+
+ warning_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Only give a warning message when limit is exceeded.
+
+
+ next_hop_self + +
+ dictionary +
+ 		+ +
Set our address as nexthop (non-reflected).
+
+
+ all_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set our address as nexthop for all routes.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set next-hop-self attribute.
+
+
+ next_hop_third_party + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compute a third-party nexthop if possible.
+
+
+ prefix_list + +
+ dictionary +
+ 		+ +
Apply prefix-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ route_map + +
+ dictionary +
+ 		+ +
Apply route-map to neighbor.
+
+
+ inbound + +
+ string +
+ 		+ +
Name of policy to apply to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Name of policy to apply to outgoing routes.
+
+
+ route_reflector_client + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure a neighbor as Route reflector client.
+
+
+ safi + +
+ string +
+ 		+
    Choices: +
  • unicast
    • +
  • multicast
    • +
  • mvpn
    • +
  • evpn
    • +
+ 		+
Sub Address Family indicator.
+
+
+ send_community + +
+ string +
+ 		+
    Choices: +
  • standard
    • +
  • extended
    • +
  • both
    • +
+ 		+
Send Community attribute to this neighbor.
+
+
+ soft_reconfiguration_inbound + +
+ dictionary +
+ 		+ +
Soft reconfiguration.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always perform inbound soft reconfiguration.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set soft-reconfiguration inbound attribute.
+
+
+ soo + +
+ string +
+ 		+ +
Specify Site-of-origin extcommunity.
+
+
+ suppress_inactive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise only active routes to peer.
+
+
+ unsuppress_map + +
+ string +
+ 		+ +
Route-map to selectively unsuppress suppressed routes.
+
+
+ weight + +
+ integer +
+ 		+ +
Set default weight for routes from this neighbor.
+
+
+ bfd + +
+ dictionary +
+ 		+ +
Bidirectional Fast Detection for the neighbor.
+
+
+ multihop + +
+ dictionary +
+ 		+ +
Multihop session.
+
+
+ interval + +
+ dictionary +
+ 		+ +
Configure BFD session interval parameters.
+
+
+ min_rx_interval + +
+ integer + / required +
+ 		+ +
Minimum RX interval.
+
+
+ multiplier + +
+ integer + / required +
+ 		+ +
Detect Multiplier.
+
+
+ tx_interval + +
+ integer + / required +
+ 		+ +
TX interval in milliseconds.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD multihop.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD for this neighbor.
+
+
+ singlehop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Single-hop session.
+
+
+ bmp_activate_server + +
+ integer +
+ 		+ +
Specify server ID for activating BMP monitoring for the peer.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Capability.
+
+
+ suppress_4_byte_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress 4-byte AS Capability.
+
+
+ description + +
+ string +
+ 		+ +
Neighbor specific descripion.
+
+
+ disable_connected_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable check for directly connected peer.
+
+
+ dont_capability_negotiate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Don't negotiate capability with this neighbor.
+
+
+ dscp + +
+ string +
+ 		+ +
Set dscp value for tcp transport.
+
+
+ dynamic_capability + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Dynamic Capability
+
+
+ ebgp_multihop + +
+ integer +
+ 		+ +
Specify multihop TTL for remote peer.
+
+
+ graceful_shutdown + +
+ dictionary +
+ 		+ +
Graceful-shutdown for this neighbor.
+
+
+ activate + +
+ dictionary +
+ 		+ +
Send graceful-shutdown community.
+
+
+ route_map + +
+ string +
+ 		+ +
Apply route-map to modify attributes for outbound.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set activate.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a template.
+
+
+ peer_session + +
+ string +
+ 		+ +
Peer-session template to inherit.
+
+
+ local_as + +
+ string +
+ 		+ +
Specify the local-as number for the eBGP neighbor.
+
+
+ log_neighbor_changes + +
+ dictionary +
+ 		+ +
Log message for neighbor up/down event.
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable logging of neighbor up/down event.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set log-neighbor-changes.
+
+
+ low_memory + +
+ dictionary +
+ 		+ +
Behaviour in low memory situations.
+
+
+ exempt + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not shutdown this peer when under memory pressure.
+
+
+ name + +
+ string +
+ 		+ +
Name of the BGP peer template.
+
+
+ password + +
+ dictionary +
+ 		+ +
Configure a password for neighbor.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 specifies an UNENCRYPTED neighbor password.
+
3 specifies an 3DES ENCRYPTED neighbor password will follow.
+
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
+
+
+ key + +
+ string +
+ 		+ +
Authentication password.
+
+
+ path_attribute + +
+ list + / elements=dictionary +
+ 		+ +
BGP path attribute optional filtering.
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • discard
    • +
  • treat-as-withdraw
    • +
+ 		+
Action.
+
+
+ range + +
+ dictionary +
+ 		+ +
Path attribute range.
+
+
+ end + +
+ integer +
+ 		+ +
Path attribute range end value.
+
+
+ start + +
+ integer +
+ 		+ +
Path attribute range start value.
+
+
+ type + +
+ integer +
+ 		+ +
Path attribute type
+
+
+ remote_as + +
+ string +
+ 		+ +
Specify Autonomous System Number of the neighbor.
+
+
+ remove_private_as + +
+ dictionary +
+ 		+ +
Remove private AS number from outbound updates.
+
+
+ all + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All.
+
+
+ replace_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Replace.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Remove private AS.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown this neighbor.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure keepalive and hold timers.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Holdtime (seconds).
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval (seconds).
+
+
+ transport + +
+ dictionary +
+ 		+ +
BGP transport connection.
+
+
+ connection_mode + +
+ dictionary +
+ 		+ +
Specify type of connection.
+
+
+ passive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Allow passive connection setup only.
+
+
+ ttl_security + +
+ dictionary +
+ 		+ +
Enable TTL Security Mechanism.
+
+
+ hops + +
+ integer +
+ 		+ +
Specify hop count for remote peer.
+
+
+ update_source + +
+ string +
+ 		+ +
Specify source of BGP session and updates.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config bgp | section 'template'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
Refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # -------------- + # + # nxos9k# show running-config | section "^router bgp" + # nxos9k# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_bgp_templates: + config: + as_number: 65536 + neighbor: + - name: neighbor_tmplt_1 + address_family: + - afi: ipv4 + safi: unicast + advertise_map: + route_map: rmap1 + non_exist_map: nemap1 + advertisement_interval: 60 + disable_peer_as_check: true + bmp_activate_server: 2 + capability: + suppress_4_byte_as: true + description: Test_BGP_PEER_TEMPLATE_1 + local_as: 65536 + remote_as: 65001 + + - name: neighbor_tmplt_2 + description: Test_BGP_PEER_TEMPLATE_2 + address_family: + - afi: ipv4 + safi: multicast + advertise_map: + route_map: rmap1 + exist_map: emap1 + as_override: true + filter_list: + inbound: flist1 + outbound: flist2 + inherit: + peer_session: psession1 + timers: + holdtime: 100 + keepalive: 45 + # Task Output: + # ------------ + # before: {} + # + # commands: + # - router bgp 65536 + # - template peer neighbor_tmplt_1 + # - bmp-activate-server 2 + # - capability suppress 4-byte-as + # - description Test_BGP_PEER_TEMPLATE_1 + # - local-as 65536 + # - remote-as 65001 + # - address-family ipv4 unicast + # - advertise-map rmap1 non-exist-map nemap1 + # - advertisement-interval 60 + # - disable-peer-as-check + # - template peer neighbor_tmplt_2 + # - description Test_BGP_PEER_TEMPLATE_2 + # - inherit peer-session psession1 + # - timers 45 100 + # - address-family ipv4 multicast + # - advertise-map rmap1 exist-map emap1 + # - as-override + # - filter-list flist1 in + # - filter-list flist2 out + # + # after: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # bmp_activate_server: 2 + # capability: + # suppress_4_byte_as: true + # description: Test_BGP_PEER_TEMPLATE_1 + # local_as: "65536" + # remote_as: "65001" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + + # After state: + # -------------- + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # capability suppress 4-byte-as + # bmp-activate-server 2 + # description Test_BGP_PEER_TEMPLATE_1 + # local-as 65536 + # remote-as 65001 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + # Using replaced + + # Before state: + # ------------- + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # capability suppress 4-byte-as + # description Test_BGP_PEER_TEMPLATE_1 + # bmp-activate-server 2 + # local-as 65536 + # remote-as 65001 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + - name: Replace BGP templates configuration with provided configuration + cisco.nxos.nxos_bgp_templates: + config: + as_number: 65536 + neighbor: + - name: neighbor_tmplt_1 + address_family: + - afi: ipv4 + safi: unicast + advertise_map: + route_map: rmap1 + non_exist_map: nemap1 + advertisement_interval: 60 + disable_peer_as_check: true + inherit: + peer_session: psession1 + description: Test_BGP_PEER_TEMPLATE_1 + local_as: 65537 + state: replaced + + # Task output: + # ------------ + # + # before: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # bmp_activate_server: 2 + # capability: + # suppress_4_byte_as: true + # description: Test_BGP_PEER_TEMPLATE_1 + # local_as: "65536" + # remote_as: "65001" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + # + # commands: + # - router bgp 65536 + # - template peer neighbor_tmplt_1 + # - no bmp-activate-server 2 + # - no capability suppress 4-byte-as + # - inherit peer-session psession1 + # - local-as 65537 + # - no remote-as 65001 + # + # after: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # description: Test_BGP_PEER_TEMPLATE_1 + # inherit: + # peer_session: psession1 + # local_as: "65537" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + + # After state: + # ------------ + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # inherit peer-session psession1 + # description Test_BGP_PEER_TEMPLATE_1 + # local-as 65537 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # bmp-activate-server 2 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + # Using overridden + # + # Before state: + # ------------- + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # capability suppress 4-byte-as + # description Test_BGP_PEER_TEMPLATE_1 + # bmp-activate-server 2 + # local-as 65536 + # remote-as 65001 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + - name: Override BGP templates configuration with provided configuration + cisco.nxos.nxos_bgp_templates: + config: + as_number: 65536 + neighbor: + - name: neighbor_tmplt_1 + address_family: + - afi: ipv4 + safi: unicast + advertise_map: + route_map: rmap1 + non_exist_map: nemap1 + advertisement_interval: 60 + disable_peer_as_check: true + inherit: + peer_session: psession1 + description: Test_BGP_PEER_TEMPLATE_1 + local_as: 65537 + state: overridden + + # Task output: + # ------------ + # + # before: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # bmp_activate_server: 2 + # capability: + # suppress_4_byte_as: true + # description: Test_BGP_PEER_TEMPLATE_1 + # local_as: "65536" + # remote_as: "65001" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + # + # commands: + # - router bgp 65536 + # - template peer neighbor_tmplt_1 + # - no bmp-activate-server 2 + # - no capability suppress 4-byte-as + # - inherit peer-session psession1 + # - local-as 65537 + # - no remote-as 65001 + # - no template peer neighbor_tmplt_2 + # + # after: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # description: Test_BGP_PEER_TEMPLATE_1 + # inherit: + # peer_session: psession1 + # local_as: "65537" + + # After state: + # ------------ + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # inherit peer-session psession1 + # description Test_BGP_PEER_TEMPLATE_1 + # local-as 65537 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + + # Using deleted + + # Before state: + # -------------- + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # capability suppress 4-byte-as + # description Test_BGP_PEER_TEMPLATE_1 + # bmp-activate-server 2 + # local-as 65536 + # remote-as 65001 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + - name: Delete BGP configs handled by this module + cisco.nxos.nxos_bgp_templates: + state: deleted + + # Task output: + # ------------ + # + # before: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # bmp_activate_server: 2 + # capability: + # suppress_4_byte_as: true + # description: Test_BGP_PEER_TEMPLATE_1 + # local_as: "65536" + # remote_as: "65001" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + # + # commands: + # - router bgp 65536 + # - no template peer neighbor_tmplt_1 + # - no template peer neighbor_tmplt_2 + # + # after: {} + + # After state: + # ------------- + # nxos9k# show running-config | section "^router bgp" + # nxos9k# + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['router bgp 65536', 'template peer neighbor_tmplt_1', 'no bmp-activate-server 2', 'no capability suppress 4-byte-as', 'inherit peer-session psession1', 'local-as 65537', 'no remote-as 65001', 'no template peer neighbor_tmplt_2']
+
+
+ gathered + +
+ dictionary +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ dictionary +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['router bgp 65536', 'template peer neighbor_tmplt_1', 'bmp-activate-server 2', 'no capability suppress 4-byte-as', 'no template peer neighbor_tmplt_2']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_command_module.rst b/docs/cisco.nxos.nxos_command_module.rst new file mode 100644 index 000000000..4308a6582 --- /dev/null +++ b/docs/cisco.nxos.nxos_command_module.rst @@ -0,0 +1,258 @@ +.. _cisco.nxos.nxos_command_module: + + +*********************** +cisco.nxos.nxos_command +*********************** + +**Run arbitrary command on Cisco NXOS devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Sends an arbitrary command to an NXOS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ commands + +
+ list + / elements=raw + / required +
+ 		+ +
The commands to send to the remote NXOS device. The resulting output from the command is returned. If the wait_for argument is provided, the module is not returned until the condition is satisfied or the number of retires as expired.
+
The commands argument also accepts an alternative form that allows for complex values that specify the command to run and the output format to return. This can be done on a command by command basis. The complex argument supports the keywords command and output where command is the command to run and output is one of 'text' or 'json'.
+
If a command sent to the device requires answering a prompt, it is possible to pass a dict containing command, answer and prompt. Common answers are 'y' or "\r" (carriage return, must be double quotes). See examples.
+
+
+ interval + +
+ integer +
+ 		+ Default:
1
+ 		+
Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditional, the interval indicates how to long to wait before trying the command again.
+
+
+ match + +
+ string +
+ 		+
    Choices: +
  • any
    • +
  • all ←
    • +
+ 		+
The match argument is used in conjunction with the wait_for argument to specify the match policy. Valid values are all or any. If the value is set to all then all conditionals in the wait_for must be satisfied. If the value is set to any then only one of the values must be satisfied.
+
+
+ retries + +
+ integer +
+ 		+ Default:
9
+ 		+
Specifies the number of retries a command should by tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait_for conditionals.
+
The commands are run once when retries is set to 0.
+
+
+ wait_for + +
+ list + / elements=string +
+ 		+ +
Specifies what to evaluate from the output of the command and what conditionals to apply. This argument will cause the task to wait for a particular conditional to be true before moving forward. If the conditional is not true by the configured retries, the task fails. See examples.
+

aliases: waitfor
+
+
+ + +Notes +----- + +.. note:: + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: run show version on remote devices + cisco.nxos.nxos_command: + commands: show version + + - name: run show version and check to see if output contains Cisco + cisco.nxos.nxos_command: + commands: show version + wait_for: result[0] contains Cisco + + - name: run multiple commands on remote nodes + cisco.nxos.nxos_command: + commands: + - show version + - show interfaces + + - name: run multiple commands and evaluate the output + cisco.nxos.nxos_command: + commands: + - show version + - show interfaces + wait_for: + - result[0] contains Cisco + - result[1] contains loopback0 + + - name: run commands and specify the output format + cisco.nxos.nxos_command: + commands: + - command: show version + output: json + + - name: run commands that require answering a prompt + cisco.nxos.nxos_command: + commands: + - configure terminal + - command: no feature npv + prompt: Do you want to continue + answer: y + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ failed_conditions + +
+ list +
+ 		failed +
The list of conditionals that have failed
+
+
Sample:
+
['...', '...']
+
+
+ stdout + +
+ list +
+ 		always apart from low level errors (such as action plugin) +
The set of responses from the commands
+
+
Sample:
+
['...', '...']
+
+
+ stdout_lines + +
+ list +
+ 		always apart from low level errors (such as action plugin) +
The value of stdout split into a list
+
+
Sample:
+
[['...', '...'], ['...'], ['...']]
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_config_module.rst b/docs/cisco.nxos.nxos_config_module.rst new file mode 100644 index 000000000..3ead5ab50 --- /dev/null +++ b/docs/cisco.nxos.nxos_config_module.rst @@ -0,0 +1,566 @@ +.. _cisco.nxos.nxos_config_module: + + +********************** +cisco.nxos.nxos_config +********************** + +**Manage Cisco NXOS configuration sections** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- 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. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ after + +
+ list + / elements=string +
+ 		+ +
The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with before this allows the playbook designer to append a set of commands to be executed after the command set.
+
+
+ backup + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
This argument will cause the module to create a full backup of the current running-config from the remote device before any changes are made. If the backup_options value is not given, the backup file is written to the backup folder in the playbook root directory or role root directory, if playbook is part of an ansible role. If the directory does not exist, it is created.
+
+
+ backup_options + +
+ dictionary +
+ 		+ +
This is a dict object containing configurable options related to backup file path. The value of this option is read only when backup is set to True, if backup is set to false this option will be silently ignored.
+
+
+ dir_path + +
+ path +
+ 		+ +
This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be created and the filename is either the value of filename or default filename as described in filename options description. If the path value is not given in that case a backup directory will be created in the current working directory and backup configuration will be copied in filename within backup directory.
+
+
+ filename + +
+ string +
+ 		+ +
The filename to be used to store the backup configuration. If the filename is not given it will be generated based on the hostname, current time and date in format defined by <hostname>_config.<current-date>@<current-time>
+
+
+ before + +
+ list + / elements=string +
+ 		+ +
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.
+
+
+ defaults + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
The 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
+
+
+ diff_against + +
+ string +
+ 		+
    Choices: +
  • startup
    • +
  • intended
    • +
  • running
    • +
+ 		+
When using the ansible-playbook --diff command line argument the module can generate diffs against different sources.
+
When this option is configure as startup, the module will return the diff of the running-config against the startup-config.
+
When this option is configured as intended, the module will return the diff of the running-config against the configuration provided in the intended_config argument.
+
When this option is configured as running, the module will return the before and after diff of the running-config with respect to any changes made to the device configuration.
+
+
+ diff_ignore_lines + +
+ list + / elements=string +
+ 		+ +
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.
+
+
+ intended_config + +
+ string +
+ 		+ +
The 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 diff_against value and set it to intended. The configuration lines for this value should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure correct diff.
+
+
+ lines + +
+ list + / elements=string +
+ 		+ +
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 to ensure idempotency and correct diff. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser.
+

aliases: commands
+
+
+ match + +
+ string +
+ 		+
    Choices: +
  • line ←
    • +
  • strict
    • +
  • exact
    • +
  • none
    • +
+ 		+
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 line, commands are matched line by line. If match is set to strict, command lines are matched with respect to position. If match is set to exact, command lines must be an equal match. Finally, if match is set to none, the module will not attempt to compare the source configuration with the running configuration on the remote device.
+
+
+ parents + +
+ list + / elements=string +
+ 		+ +
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.
+
+
+ replace + +
+ string +
+ 		+
    Choices: +
  • line ←
    • +
  • block
    • +
  • config
    • +
+ 		+
Instructs the module on the way to perform the configuration on the device. If the replace argument is set to line then the modified lines are pushed to the device in configuration mode. If the replace argument is set to block then the entire command block is pushed to the device in configuration mode if any line is not correct. replace config will only work for NX-OS versions that support `config replace`.
+
+
+ replace_src + +
+ string +
+ 		+ +
The 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 replace with value config. This is mutually exclusive with the lines and src arguments. This argument will only work for NX-OS versions that support `config replace`. Use nxos_file_copy module to copy the flat file to remote device and then use the path with this argument. The configuration lines in the file should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure idempotency and correct diff.
+
+
+ running_config + +
+ string +
+ 		+ +
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 running_config argument allows the implementer to pass in the configuration to use as the base config for comparison. The configuration lines for this option should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure idempotency and correct diff.
+

aliases: config
+
+
+ save_when + +
+ string +
+ 		+
    Choices: +
  • always
    • +
  • never ←
    • +
  • modified
    • +
  • changed
    • +
+ 		+
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 always, then the running-config will always be copied to the startup-config and the modified flag will always be set to True. If the argument is set to 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 never, the running-config will never be copied to the startup-config. If the argument is set to changed, then the running-config will only be copied to the startup-config if the task has made a change. changed was added in Ansible 2.6.
+
+
+ src + +
+ path +
+ 		+ +
The 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 lines and parents arguments. The configuration lines in the source file should be similar to how it will appear if present in the running-configuration of the device including indentation to ensure idempotency and correct diff.
+
+
+ + +Notes +----- + +.. note:: + - Unsupported for Cisco MDS + - Abbreviated commands are NOT idempotent, see https://docs.ansible.com/ansible/latest/network/user_guide/faq.html#why-do-the-config-modules-always-return-changed-true-with-abbreviated-commands. + - To ensure idempotency and correct diff the configuration lines in the relevant module options should be similar to how they appear if present in the running configuration on device including the indentation. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: configure top level configuration and save it + cisco.nxos.nxos_config: + lines: hostname {{ inventory_hostname }} + save_when: modified + + - name: diff the running-config against a provided config + cisco.nxos.nxos_config: + diff_against: intended + intended_config: "{{ lookup('file', 'master.cfg') }}" + + - cisco.nxos.nxos_config: + lines: + - 10 permit ip 192.0.2.1/32 any log + - 20 permit ip 192.0.2.2/32 any log + - 30 permit ip 192.0.2.3/32 any log + - 40 permit ip 192.0.2.4/32 any log + - 50 permit ip 192.0.2.5/32 any log + parents: ip access-list test + before: no ip access-list test + match: exact + + - cisco.nxos.nxos_config: + lines: + - 10 permit ip 192.0.2.1/32 any log + - 20 permit ip 192.0.2.2/32 any log + - 30 permit ip 192.0.2.3/32 any log + - 40 permit ip 192.0.2.4/32 any log + parents: ip access-list test + before: no ip access-list test + replace: block + + - name: replace config with flat file + cisco.nxos.nxos_config: + replace_src: config.txt + replace: config + + - name: for idempotency, use full-form commands + cisco.nxos.nxos_config: + lines: + # - shut + - shutdown + # parents: int eth1/1 + parents: interface Ethernet1/1 + + - name: configurable backup path + cisco.nxos.nxos_config: + backup: true + backup_options: + filename: backup.cfg + dir_path: /home/user + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ backup_path + +
+ string +
+ 		when backup is yes +
The full path to the backup file
+
+
Sample:
+
/playbooks/ansible/backup/nxos_config.2016-07-16@22:28:34
+
+
+ commands + +
+ list +
+ 		always +
The set of commands that will be pushed to the remote device
+
+
Sample:
+
['hostname foo', 'vlan 1', 'name default']
+
+
+ date + +
+ string +
+ 		when backup is yes +
The date extracted from the backup file name
+
+
Sample:
+
2016-07-16
+
+
+ filename + +
+ string +
+ 		when backup is yes and filename is not specified in backup options +
The name of the backup file
+
+
Sample:
+
nxos_config.2016-07-16@22:28:34
+
+
+ shortname + +
+ string +
+ 		when backup is yes and filename is not specified in backup options +
The full path to the backup file excluding the timestamp
+
+
Sample:
+
/playbooks/ansible/backup/nxos_config
+
+
+ time + +
+ string +
+ 		when backup is yes +
The time extracted from the backup file name
+
+
Sample:
+
22:28:34
+
+
+ updates + +
+ list +
+ 		always +
The set of commands that will be pushed to the remote device
+
+
Sample:
+
['hostname foo', 'vlan 1', 'name default']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_devicealias_module.rst b/docs/cisco.nxos.nxos_devicealias_module.rst new file mode 100644 index 000000000..081c8759f --- /dev/null +++ b/docs/cisco.nxos.nxos_devicealias_module.rst @@ -0,0 +1,273 @@ +.. _cisco.nxos.nxos_devicealias_module: + + +*************************** +cisco.nxos.nxos_devicealias +*************************** + +**Configuration of device alias for Cisco NXOS MDS Switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Configuration of device alias for Cisco MDS NXOS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ da + +
+ list + / elements=dictionary +
+ 		+ +
List of device-alias to be added or removed
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the device-alias to be added or removed
+
+
+ pwwn + +
+ string +
+ 		+ +
pwwn to which the name needs to be associated with
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Removes the device-alias if set to True
+
+
+ distribute + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable device-alias distribution
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • basic
    • +
  • enhanced
    • +
+ 		+
Mode of devices-alias, basic or enhanced
+
+
+ rename + +
+ list + / elements=dictionary +
+ 		+ +
List of device-alias to be renamed
+
+
+ new_name + +
+ string + / required +
+ 		+ +
New name of the device-alias
+
+
+ old_name + +
+ string + / required +
+ 		+ +
Old name of the device-alias that needs to be renamed
+
+
+ + +Notes +----- + +.. note:: + - Tested against Cisco MDS NX-OS 8.4(1) + + + +Examples +-------- + +.. code-block:: yaml + + - name: Test that device alias module works + cisco.nxos.nxos_devicealias: + da: + - name: test1_add + pwwn: 56:2:22:11:22:88:11:67 + - name: test2_add + pwwn: 65:22:22:11:22:22:11:d + - name: dev1 + remove: true + - name: dev2 + remove: true + distribute: true + mode: enhanced + rename: + - new_name: bcd + old_name: abc + - new_name: bcd1 + old_name: abc1 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['terminal dont-ask', 'device-alias database', 'device-alias name somename pwwn 10:00:00:00:89:a1:01:03', 'device-alias name somename1 pwwn 10:00:00:00:89:a1:02:03', 'device-alias commit', 'no terminal dont-ask']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) diff --git a/docs/cisco.nxos.nxos_evpn_global_module.rst b/docs/cisco.nxos.nxos_evpn_global_module.rst new file mode 100644 index 000000000..d1b2a8241 --- /dev/null +++ b/docs/cisco.nxos.nxos_evpn_global_module.rst @@ -0,0 +1,122 @@ +.. _cisco.nxos.nxos_evpn_global_module: + + +*************************** +cisco.nxos.nxos_evpn_global +*************************** + +**Handles the EVPN control plane for VXLAN.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Handles the EVPN control plane for VXLAN. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ nv_overlay_evpn + +
+ boolean + / required +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
EVPN control plane.
+
+
+ + +Notes +----- + +.. note:: + - This module is not supported on Nexus 3000 series of switches. + - Unsupported for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_evpn_global: + nv_overlay_evpn: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The set of commands to be sent to the remote device
+
+
Sample:
+
['nv overlay evpn']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_evpn_vni_module.rst b/docs/cisco.nxos.nxos_evpn_vni_module.rst new file mode 100644 index 000000000..530a9ff18 --- /dev/null +++ b/docs/cisco.nxos.nxos_evpn_vni_module.rst @@ -0,0 +1,212 @@ +.. _cisco.nxos.nxos_evpn_vni_module: + + +************************ +cisco.nxos.nxos_evpn_vni +************************ + +**Manages Cisco EVPN VXLAN Network Identifier (VNI).** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages Cisco Ethernet Virtual Private Network (EVPN) VXLAN Network Identifier (VNI) configurations of a Nexus device. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ route_distinguisher + +
+ string +
+ 		+ +
The VPN Route Distinguisher (RD). The RD is combined with the IPv4 or IPv6 prefix learned by the PE router to create a globally unique address.
+
+
+ route_target_both + +
+ list + / elements=string +
+ 		+ +
Enables/Disables route-target settings for both import and export target communities using a single property.
+
+
+ route_target_export + +
+ list + / elements=string +
+ 		+ +
Sets the route-target 'export' extended communities.
+
+
+ route_target_import + +
+ list + / elements=string +
+ 		+ +
Sets the route-target 'import' extended communities.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Determines whether the config should be present or not on the device.
+
+
+ vni + +
+ string + / required +
+ 		+ +
The EVPN VXLAN Network Identifier.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - default, where supported, restores params default value. + - RD override is not permitted. You should set it to the default values first and then reconfigure it. + - ``route_target_both``, ``route_target_import`` and ``route_target_export valid`` values are a list of extended communities, (i.e. ['1.2.3.4:5', '33:55']) or the keywords 'auto' or 'default'. + - The ``route_target_both`` property is discouraged due to the inconsistent behavior of the property across Nexus platforms and image versions. For this reason it is recommended to use explicit ``route_target_export`` and ``route_target_import`` properties instead of ``route_target_both``. + - RD valid values are a string in one of the route-distinguisher formats, the keyword 'auto', or the keyword 'default'. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: vni configuration + cisco.nxos.nxos_evpn_vni: + vni: 6000 + route_distinguisher: 60:10 + route_target_import: + - "5000:10" + - "4100:100" + route_target_export: auto + route_target_both: default + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['evpn', 'vni 6000 l2', 'route-target import 5001:10']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_facts_module.rst b/docs/cisco.nxos.nxos_facts_module.rst new file mode 100644 index 000000000..3ce96abea --- /dev/null +++ b/docs/cisco.nxos.nxos_facts_module.rst @@ -0,0 +1,553 @@ +.. _cisco.nxos.nxos_facts_module: + + +********************* +cisco.nxos.nxos_facts +********************* + +**Gets facts about NX-OS switches** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Collects facts from Cisco Nexus devices running the NX-OS operating system. Fact collection is supported over both ``network_cli`` and ``httpapi``. This module prepends all of the base network fact keys with ``ansible_net_``. The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ available_network_resources + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
When set to true a list of network resources for which resource modules are available will be provided.
+
+
+ gather_network_resources + +
+ list + / elements=string +
+ 		+ +
When supplied, this argument will gather configuration facts only for the given subset. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
+
Valid subsets are all, bfd_interfaces, lag_interfaces, telemetry, vlans, lacp, lacp_interfaces, interfaces, l3_interfaces, l2_interfaces, lldp_global, acls, acl_interfaces, ospfv2, ospfv3, ospf_interfaces, bgp_global, bgp_address_family, route_maps, prefix_lists, logging_global, ntp_global, snmp_server, hostname.
+
+
+ gather_subset + +
+ list + / elements=string +
+ 		+ Default:
"min"
+ 		+
When supplied, this argument will gather operational facts only for the given subset. Possible values for this argument include all, hardware, config, legacy, interfaces, and min. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Gather all legacy facts + cisco.nxos.nxos_facts: + gather_subset: all + - name: Gather only the config and default facts + cisco.nxos.nxos_facts: + gather_subset: + - config + - name: Do not gather hardware facts + cisco.nxos.nxos_facts: + gather_subset: + - '!hardware' + - name: Gather legacy and resource facts + cisco.nxos.nxos_facts: + gather_subset: all + gather_network_resources: all + - name: Gather only the interfaces resource facts and no legacy facts + cisco.nxos.nxos_facts: + gather_subset: + - '!all' + - '!min' + gather_network_resources: + - interfaces + - name: Gather interfaces resource and minimal legacy facts + cisco.nxos.nxos_facts: + gather_subset: min + gather_network_resources: interfaces + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ ansible_net_all_ipv4_addresses + +
+ list +
+ 		when interfaces is configured +
All IPv4 addresses configured on the device
+
+
+
+ ansible_net_all_ipv6_addresses + +
+ list +
+ 		when interfaces is configured +
All IPv6 addresses configured on the device
+
+
+
+ ansible_net_api + +
+ string +
+ 		always +
The name of the transport
+
+
+
+ ansible_net_config + +
+ string +
+ 		when config is configured +
The current active config from the device
+
+
+
+ ansible_net_filesystems + +
+ list +
+ 		when hardware is configured +
All file system names available on the device
+
+
+
+ ansible_net_gather_network_resources + +
+ list +
+ 		when the resource is configured +
The list of fact for network resource subsets collected from the device
+
+
+
+ ansible_net_gather_subset + +
+ list +
+ 		always +
The list of fact subsets collected from the device
+
+
+
+ ansible_net_hostname + +
+ string +
+ 		always +
The configured hostname of the device
+
+
+
+ ansible_net_image + +
+ string +
+ 		always +
The image file the device is running
+
+
+
+ ansible_net_interfaces + +
+ dictionary +
+ 		when interfaces is configured +
A hash of all interfaces running on the system
+
+
+
+ ansible_net_license_hostid + +
+ string +
+ 		always +
The License host id of the device
+
+
+
+ ansible_net_memfree_mb + +
+ integer +
+ 		when hardware is configured +
The available free memory on the remote device in Mb
+
+
+
+ ansible_net_memtotal_mb + +
+ integer +
+ 		when hardware is configured +
The total memory on the remote device in Mb
+
+
+
+ ansible_net_model + +
+ string +
+ 		always +
The model name returned from the device
+
+
+
+ ansible_net_neighbors + +
+ dictionary +
+ 		when interfaces is configured +
The list of LLDP and CDP neighbors from the device. If both, CDP and LLDP neighbor data is present on one port, CDP is preferred.
+
+
+
+ ansible_net_python_version + +
+ string +
+ 		always +
The Python version Ansible controller is using
+
+
+
+ ansible_net_serialnum + +
+ string +
+ 		always +
The serial number of the remote device
+
+
+
+ ansible_net_version + +
+ string +
+ 		always +
The operating system version running on the remote device
+
+
+
+ fan_info + +
+ dictionary +
+ 		when legacy is configured +
A hash of facts about fans in the remote device
+
+
+
+ hostname + +
+ dictionary +
+ 		when legacy is configured +
The configured hostname of the remote device
+
+
+
+ interfaces_list + +
+ dictionary +
+ 		when legacy is configured +
The list of interface names on the remote device
+
+
+
+ kickstart + +
+ string +
+ 		when legacy is configured +
The software version used to boot the system
+
+
+
+ module + +
+ dictionary +
+ 		when legacy is configured +
A hash of facts about the modules in a remote device
+
+
+
+ platform + +
+ string +
+ 		when legacy is configured +
The hardware platform reported by the remote device
+
+
+
+ power_supply_info + +
+ string +
+ 		when legacy is configured +
A hash of facts about the power supplies in the remote device
+
+
+
+ vlan_list + +
+ list +
+ 		when legacy is configured +
The list of VLAN IDs configured on the remote device
+
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_feature_module.rst b/docs/cisco.nxos.nxos_feature_module.rst new file mode 100644 index 000000000..ee2539180 --- /dev/null +++ b/docs/cisco.nxos.nxos_feature_module.rst @@ -0,0 +1,150 @@ +.. _cisco.nxos.nxos_feature_module: + + +*********************** +cisco.nxos.nxos_feature +*********************** + +**Manage features in NX-OS switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Offers ability to enable and disable features in NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ feature + +
+ string + / required +
+ 		+ +
Name of feature.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • enabled ←
    • +
  • disabled
    • +
+ 		+
Desired state of the feature.
+
+
+ + +Notes +----- + +.. note:: + - Tested against Cisco MDS NX-OS 9.2(2) + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - 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 Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The set of commands to be sent to the remote device
+
+
Sample:
+
['nv overlay evpn']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) +- Suhas Bharadwaj (@srbharadwaj) diff --git a/docs/cisco.nxos.nxos_gir_module.rst b/docs/cisco.nxos.nxos_gir_module.rst new file mode 100644 index 000000000..61c809ea0 --- /dev/null +++ b/docs/cisco.nxos.nxos_gir_module.rst @@ -0,0 +1,302 @@ +.. _cisco.nxos.nxos_gir_module: + + +******************* +cisco.nxos.nxos_gir +******************* + +**Trigger a graceful removal or insertion (GIR) of the switch.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Trigger a graceful removal or insertion (GIR) of the switch. +- GIR processing may take more than 2 minutes. Timeout settings are automatically extended to 200s when user timeout settings are insufficient. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specify desired state of the resource.
+
+
+ system_mode_maintenance + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
When system_mode_maintenance=true it puts all enabled protocols in maintenance mode (using the isolate command). When system_mode_maintenance=false it puts all enabled protocols in normal mode (using the no isolate command).
+
+
+ system_mode_maintenance_dont_generate_profile + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
When system_mode_maintenance_dont_generate_profile=true it prevents the dynamic searching of enabled protocols and executes commands configured in a maintenance-mode profile. Use this option if you want the system to use a maintenance-mode profile that you have created. When system_mode_maintenance_dont_generate_profile=false it prevents the dynamic searching of enabled protocols and executes commands configured in a normal-mode profile. Use this option if you want the system to use a normal-mode profile that you have created.
+
+
+ system_mode_maintenance_on_reload_reset_reason + +
+ string +
+ 		+
    Choices: +
  • hw_error
    • +
  • svc_failure
    • +
  • kern_failure
    • +
  • wdog_timeout
    • +
  • fatal_error
    • +
  • lc_failure
    • +
  • match_any
    • +
  • manual_reload
    • +
  • any_other
    • +
  • maintenance
    • +
+ 		+
Boots the switch into maintenance mode automatically in the event of a specified system crash. Note that not all reset reasons are applicable for all platforms. Also if reset reason is set to match_any, it is not idempotent as it turns on all reset reasons. If reset reason is match_any and state is absent, it turns off all the reset reasons.
+
+
+ system_mode_maintenance_shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Shuts down all protocols, vPC domains, and interfaces except the management interface (using the shutdown command). This option is disruptive while system_mode_maintenance (which uses the isolate command) is not.
+
+
+ system_mode_maintenance_timeout + +
+ string +
+ 		+ +
Keeps the switch in maintenance mode for a specified number of minutes. Range is 5-65535.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - ``state`` has effect only in combination with ``system_mode_maintenance_timeout`` or ``system_mode_maintenance_on_reload_reset_reason``. + - Using ``system_mode_maintenance`` and ``system_mode_maintenance_dont_generate_profile`` would make the module fail, but the system mode will be triggered anyway. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Trigger system maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance: true + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Trigger system normal mode + - cisco.nxos.nxos_gir: + system_mode_maintenance: false + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Configure on-reload reset-reason for maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance_on_reload_reset_reason: manual_reload + state: present + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Add on-reload reset-reason for maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance_on_reload_reset_reason: hw_error + state: present + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Remove on-reload reset-reason for maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance_on_reload_reset_reason: manual_reload + state: absent + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Set timeout for maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance_timeout: 30 + state: present + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Remove timeout for maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance_timeout: 30 + state: absent + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ final_system_mode + +
+ string +
+ 		verbose mode +
describe the last system mode
+
+
Sample:
+
normal
+
+
+ updates + +
+ list +
+ 		verbose mode +
commands sent to the device
+
+
Sample:
+
['terminal dont-ask', 'system mode maintenance timeout 10']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_gir_profile_management_module.rst b/docs/cisco.nxos.nxos_gir_profile_management_module.rst new file mode 100644 index 000000000..95d85ae9b --- /dev/null +++ b/docs/cisco.nxos.nxos_gir_profile_management_module.rst @@ -0,0 +1,235 @@ +.. _cisco.nxos.nxos_gir_profile_management_module: + + +************************************** +cisco.nxos.nxos_gir_profile_management +************************************** + +**Create a maintenance-mode or normal-mode profile for GIR.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manage a maintenance-mode or normal-mode profile with configuration commands that can be applied during graceful removal or graceful insertion. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ commands + +
+ list + / elements=string +
+ 		+ +
List of commands to be included into the profile.
+
+
+ mode + +
+ string + / required +
+ 		+
    Choices: +
  • maintenance
    • +
  • normal
    • +
+ 		+
Configure the profile as Maintenance or Normal mode.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specify desired state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - ``state=absent`` removes the whole profile. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Create a maintenance-mode profile + - cisco.nxos.nxos_gir_profile_management: + mode: maintenance + commands: + - router eigrp 11 + - isolate + + # Remove the maintenance-mode profile + - cisco.nxos.nxos_gir_profile_management: + mode: maintenance + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ end_state + +
+ list +
+ 		verbose mode +
list of profile entries after module execution.
+
+
Sample:
+
['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete', 'router eigrp 11', 'isolate']
+
+
+ existing + +
+ list +
+ 		verbose mode +
list of existing profile commands.
+
+
Sample:
+
['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete']
+
+
+ proposed + +
+ list +
+ 		verbose mode +
list of commands passed into module.
+
+
Sample:
+
['router eigrp 11', 'isolate']
+
+
+ updates + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['configure maintenance profile maintenance-mode', 'router eigrp 11', 'isolate']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_hostname_module.rst b/docs/cisco.nxos.nxos_hostname_module.rst new file mode 100644 index 000000000..c8a9ee45d --- /dev/null +++ b/docs/cisco.nxos.nxos_hostname_module.rst @@ -0,0 +1,344 @@ +.. _cisco.nxos.nxos_hostname_module: + + +************************ +cisco.nxos.nxos_hostname +************************ + +**Hostname resource module.** + + +Version added: 2.9.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages hostname configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A dictionary of hostname configuration.
+
+
+ hostname + +
+ string +
+ 		+ +
Hostname of the device.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section hostname.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
The states merged, replaced and overridden have identical behaviour for this module.
+
Refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged (replaced, overridden has the same behaviour) + + # Before state: + # ------------- + # nxos-9k-rdo# show running-config | section ^hostname + # nxos-9k-rdo# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_hostname: + config: + hostname: NXOSv-9k + + # Task output + # ------------- + # before: {} + # + # commands: + # - hostname NXOSv-9k + # + # after: + # hostname: NXOSv-9k + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section ^hostname + # hostname NXOSv-9k + # + + # Using deleted + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section ^hostname + # hostname NXOSv-9k + + - name: Delete hostname from running-config + cisco.nxos.nxos_hostname: + state: deleted + + # Task output + # ------------- + # before: + # hostname: NXOSv-9k + # + # commands: + # - no hostname NXOSv-9k + # + # after: {} + + # Using gathered + + - name: Gather hostname facts using gathered + cisco.nxos.nxos_hostname: + state: gathered + + # Task output (redacted) + # ----------------------- + # gathered: + # hostname: NXOSv-9k + + # Using rendered + + - name: Render platform specific configuration lines (without connecting to the device) + cisco.nxos.nxos_hostname: + config: + hostname: NXOSv-9k + + # Task Output (redacted) + # ----------------------- + # rendered: + # - hostname NXOSv-9k + + # Using parsed + + # parsed.cfg + # ------------ + # hostname NXOSv-9k + + - name: Parse externally provided hostname config + cisco.nxos.nxos_hostname: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # hostname: NXOSv-9k + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['hostname switch01']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['hostname switch01']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst b/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst new file mode 100644 index 000000000..163612413 --- /dev/null +++ b/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst @@ -0,0 +1,344 @@ +.. _cisco.nxos.nxos_hsrp_interfaces_module: + + +******************************* +cisco.nxos.nxos_hsrp_interfaces +******************************* + +**HSRP interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages Hot Standby Router Protocol (HSRP) interface attributes. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
The provided configuration
+
+
+ bfd + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/Disable HSRP Bidirectional Forwarding Detection (BFD) on the interface.
+
+
+ name + +
+ string +
+ 		+ +
The name of the interface.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state the configuration should be left in
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 7.0(3)I5(1). + - Feature bfd should be enabled for this module. + - Unsupported for Cisco MDS + + + +Examples +-------- + +.. code-block:: yaml + + # Using deleted + + - name: Configure hsrp attributes on interfaces + cisco.nxos.nxos_hsrp_interfaces: + config: + - name: Ethernet1/1 + - name: Ethernet1/2 + operation: deleted + + + # Using merged + + - name: Configure hsrp attributes on interfaces + cisco.nxos.nxos_hsrp_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + - name: Ethernet1/2 + bfd: disable + operation: merged + + + # Using overridden + + - name: Configure hsrp attributes on interfaces + cisco.nxos.nxos_hsrp_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + - name: Ethernet1/2 + bfd: disable + operation: overridden + + + # Using replaced + + - name: Configure hsrp attributes on interfaces + cisco.nxos.nxos_hsrp_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + - name: Ethernet1/2 + bfd: disable + operation: replaced + + # Using rendered + + - name: Use rendered state to convert task input to device specific commands + cisco.nxos.nxos_hsrp_interfaces: + config: + - name: Ethernet1/800 + bfd: enable + - name: Ethernet1/801 + bfd: enable + state: rendered + + # Task Output (redacted) + # ----------------------- + + # rendered: + # - "interface Ethernet1/800" + # - "hsrp bfd" + # - "interface Ethernet1/801" + # - "hsrp bfd" + + # Using parsed + + # parsed.cfg + # ------------ + # interface Ethernet1/800 + # no switchport + # hsrp bfd + # interface Ethernet1/801 + # no switchport + # hsrp bfd + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_hsrp_interfaces: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + + # parsed: + # - name: Ethernet1/800 + # bfd: enable + # - name: Ethernet1/801 + # bfd: enable + + # Using gathered + + # Existing device config state + # ------------------------------- + + # interface Ethernet1/1 + # no switchport + # hsrp bfd + # interface Ethernet1/2 + # no switchport + # hsrp bfd + # interface Ethernet1/3 + # no switchport + + - name: Gather hsrp_interfaces facts from the device using nxos_hsrp_interfaces + cisco.nxos.nxos_hsrp_interfaces: + state: gathered + + # Task output (redacted) + # ----------------------- + + # gathered: + # - name: Ethernet1/1 + # bfd: enable + # - name: Ethernet1/2 + # bfd: enable + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/1', 'hsrp bfd']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_hsrp_module.rst b/docs/cisco.nxos.nxos_hsrp_module.rst new file mode 100644 index 000000000..0a55a4423 --- /dev/null +++ b/docs/cisco.nxos.nxos_hsrp_module.rst @@ -0,0 +1,305 @@ +.. _cisco.nxos.nxos_hsrp_module: + + +******************** +cisco.nxos.nxos_hsrp +******************** + +**Manages HSRP configuration on NX-OS switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages HSRP configuration on NX-OS switches. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ auth_string + +
+ string +
+ 		+ +
Authentication string. If this needs to be hidden(for md5 type), the string should be 7 followed by the key string. Otherwise, it can be 0 followed by key string or just key string (for backward compatibility). For text type, this should be just be a key string. if this is 'default', authentication is removed.
+
+
+ auth_type + +
+ string +
+ 		+
    Choices: +
  • text
    • +
  • md5
    • +
+ 		+
Authentication type.
+
+
+ group + +
+ string + / required +
+ 		+ +
HSRP group number.
+
+
+ interface + +
+ string + / required +
+ 		+ +
Full name of interface that is being managed for HSRP.
+
+
+ preempt + +
+ string +
+ 		+
    Choices: +
  • enabled
    • +
  • disabled
    • +
+ 		+
Enable/Disable preempt.
+
+
+ priority + +
+ string +
+ 		+ +
HSRP priority or keyword 'default'.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specify desired state of the resource.
+
+
+ version + +
+ string +
+ 		+
    Choices: +
  • 1 ←
    • +
  • 2
    • +
+ 		+
HSRP version.
+
+
+ vip + +
+ string +
+ 		+ +
HSRP virtual IP address or keyword 'default'
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - HSRP feature needs to be enabled first on the system. + - SVIs must exist before using this module. + - Interface must be a L3 port before using this module. + - HSRP cannot be configured on loopback interfaces. + - MD5 authentication is only possible with HSRPv2 while it is ignored if HSRPv1 is used instead, while it will not raise any error. Here we allow MD5 authentication only with HSRPv2 in order to enforce better practice. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Ensure HSRP is configured with following params on a SVI + cisco.nxos.nxos_hsrp: + group: 10 + vip: 10.1.1.1 + priority: 150 + interface: vlan10 + preempt: enabled + + - name: Ensure HSRP is configured with following params on a SVI with clear text authentication + cisco.nxos.nxos_hsrp: + group: 10 + vip: 10.1.1.1 + priority: 150 + interface: vlan10 + preempt: enabled + auth_type: text + auth_string: CISCO + + - name: Ensure HSRP is configured with md5 authentication and clear authentication + string + cisco.nxos.nxos_hsrp: + group: 10 + vip: 10.1.1.1 + priority: 150 + interface: vlan10 + preempt: enabled + auth_type: md5 + auth_string: 0 1234 + + - name: Ensure HSRP is configured with md5 authentication and hidden authentication + string + cisco.nxos.nxos_hsrp: + group: 10 + vip: 10.1.1.1 + priority: 150 + interface: vlan10 + preempt: enabled + auth_type: md5 + auth_string: 7 1234 + + - name: Remove HSRP config for given interface, group, and VIP + cisco.nxos.nxos_hsrp: + group: 10 + interface: vlan10 + vip: 10.1.1.1 + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['interface vlan10', 'hsrp version 2', 'hsrp 30', 'ip 10.30.1.1']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_igmp_module.rst b/docs/cisco.nxos.nxos_igmp_module.rst new file mode 100644 index 000000000..dbb46206f --- /dev/null +++ b/docs/cisco.nxos.nxos_igmp_module.rst @@ -0,0 +1,191 @@ +.. _cisco.nxos.nxos_igmp_module: + + +******************** +cisco.nxos.nxos_igmp +******************** + +**Manages IGMP global configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages IGMP global configuration configuration settings. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ enforce_rtr_alert + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables or disables the enforce router alert option check for IGMPv2 and IGMPv3 packets.
+
+
+ flush_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Removes routes when the IGMP process is restarted. By default, routes are not flushed.
+
+
+ restart + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Restarts the igmp process (using an exec config command).
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • default
    • +
+ 		+
Manages desired state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - When ``state=default``, all supported params will be reset to a default state. + - If restart is set to true with other params set, the restart will happen last, i.e. after the configuration takes place. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Default igmp global params (all params except restart) + cisco.nxos.nxos_igmp: + state: default + + - name: Ensure the following igmp global config exists on the device + cisco.nxos.nxos_igmp: + flush_routes: true + enforce_rtr_alert: true + + - name: Restart the igmp process + cisco.nxos.nxos_igmp: + restart: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ updates + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['ip igmp flush-routes']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_igmp_snooping_module.rst b/docs/cisco.nxos.nxos_igmp_snooping_module.rst new file mode 100644 index 000000000..31af97509 --- /dev/null +++ b/docs/cisco.nxos.nxos_igmp_snooping_module.rst @@ -0,0 +1,225 @@ +.. _cisco.nxos.nxos_igmp_snooping_module: + + +***************************** +cisco.nxos.nxos_igmp_snooping +***************************** + +**Manages IGMP snooping global configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages IGMP snooping global configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ group_timeout + +
+ string +
+ 		+ +
Group membership timeout value for all VLANs on the device. Accepted values are integer in range 1-10080, never and default.
+
+
+ link_local_grp_supp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Global link-local groups suppression.
+
+
+ report_supp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Global IGMPv1/IGMPv2 Report Suppression.
+
+
+ snooping + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/disables IGMP snooping on the switch.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • default
    • +
+ 		+
Manage the state of the resource.
+
+
+ v3_report_supp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Global IGMPv3 Report Suppression and Proxy Reporting.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - When ``state=default``, params will be reset to a default state. + - ``group_timeout`` also accepts *never* as an input. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure igmp snooping params supported in this module are in there default state + - cisco.nxos.nxos_igmp_snooping: + state: default + + # ensure following igmp snooping params are in the desired state + - cisco.nxos.nxos_igmp_snooping: + group_timeout: never + snooping: true + link_local_grp_supp: false + optimize_mcast_flood: false + report_supp: true + v3_report_supp: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['ip igmp snooping link-local-groups-suppression', 'ip igmp snooping group-timeout 50', 'no ip igmp snooping report-suppression', 'no ip igmp snooping v3-report-suppression', 'no ip igmp snooping']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_install_os_module.rst b/docs/cisco.nxos.nxos_install_os_module.rst new file mode 100644 index 000000000..ddd630d01 --- /dev/null +++ b/docs/cisco.nxos.nxos_install_os_module.rst @@ -0,0 +1,183 @@ +.. _cisco.nxos.nxos_install_os_module: + + +************************** +cisco.nxos.nxos_install_os +************************** + +**Set boot options like boot, kickstart image and issu.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Install an operating system by setting the boot options like boot image and kickstart image and optionally select to install using ISSU (In Server Software Upgrade). + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ issu + +
+ string +
+ 		+
    Choices: +
  • required
    • +
  • desired
    • +
  • yes
    • +
  • no ←
    • +
+ 		+
Upgrade using In Service Software Upgrade (ISSU). (Supported on N5k, N7k, N9k platforms)
+
Selecting 'required' or 'yes' means that upgrades will only proceed if the switch is capable of ISSU.
+
Selecting 'desired' means that upgrades will use ISSU if possible but will fall back to disruptive upgrade if needed.
+
Selecting 'no' means do not use ISSU. Forced disruptive.
+
+
+ kickstart_image_file + +
+ string +
+ 		+ +
Name of the kickstart image file on flash. (Not required on all Nexus platforms)
+
+
+ system_image_file + +
+ string + / required +
+ 		+ +
Name of the system (or combined) image file on flash.
+
+
+ + +Notes +----- + +.. note:: + - Tested against the following platforms and images - N9k 7.0(3)I4(6), 7.0(3)I5(3), 7.0(3)I6(1), 7.0(3)I7(1), 7.0(3)F2(2), 7.0(3)F3(2) - N3k 6.0(2)A8(6), 6.0(2)A8(8), 7.0(3)I6(1), 7.0(3)I7(1) - N7k 7.3(0)D1(1), 8.0(1), 8.1(1), 8.2(1) + - Tested against Cisco MDS NX-OS 9.2(1) + - This module requires both the ANSIBLE_PERSISTENT_CONNECT_TIMEOUT and ANSIBLE_PERSISTENT_COMMAND_TIMEOUT timers to be set to 600 seconds or higher. The module will exit if the timers are not set properly. + - When using connection local, ANSIBLE_PERSISTENT_CONNECT_TIMEOUT and ANSIBLE_PERSISTENT_COMMAND_TIMEOUT can only be set using ENV variables or the ansible.cfg file. + - Do not include full file paths, just the name of the file(s) stored on the top level flash directory. + - This module attempts to install the software immediately, which may trigger a reboot. + - In check mode, the module will indicate if an upgrade is needed and whether or not the upgrade is disruptive or non-disruptive(ISSU). + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Install OS on N9k + check_mode: false + cisco.nxos.nxos_install_os: + system_image_file: nxos.7.0.3.I6.1.bin + issu: desired + + - name: Wait for device to come back up with new image + wait_for: + port: 22 + state: started + timeout: 500 + delay: 60 + host: '{{ inventory_hostname }}' + + - name: Check installed OS for newly installed version + nxos_command: + commands: [show version | json] + register: output + + - assert: + that: + - output['stdout'][0]['kickstart_ver_str'] == '7.0(3)I6(1)' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ install_state + +
+ dictionary +
+ 		always +
Boot and install information.
+
+
Sample:
+
{'install_state': ['Compatibility check is done:', 'Module bootable Impact Install-type Reason', '------ -------- -------------- ------------ ------', ' 1 yes non-disruptive reset ', 'Images will be upgraded according to following table:', 'Module Image Running-Version(pri:alt) New-Version Upg-Required', '------ ---------- ---------------------------------------- -------------------- ------------', ' 1 nxos 7.0(3)I6(1) 7.0(3)I7(1) yes', ' 1 bios v4.4.0(07/12/2017) v4.4.0(07/12/2017) no']}
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbibo (@GGabriele) diff --git a/docs/cisco.nxos.nxos_l2_interfaces_module.rst b/docs/cisco.nxos.nxos_l2_interfaces_module.rst new file mode 100644 index 000000000..bfad0cf31 --- /dev/null +++ b/docs/cisco.nxos.nxos_l2_interfaces_module.rst @@ -0,0 +1,648 @@ +.. _cisco.nxos.nxos_l2_interfaces_module: + + +***************************** +cisco.nxos.nxos_l2_interfaces +***************************** + +**L2 interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages Layer-2 interfaces attributes of NX-OS Interfaces. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary of Layer-2 interface options
+
+
+ access + +
+ dictionary +
+ 		+ +
Switchport mode access command to configure the interface as a Layer-2 access.
+
+
+ vlan + +
+ integer +
+ 		+ +
Configure given VLAN in access port. It's used as the access VLAN ID.
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • dot1q-tunnel
    • +
  • access
    • +
  • trunk
    • +
  • fex-fabric
    • +
  • fabricpath
    • +
+ 		+
Mode in which interface needs to be configured.
+
Access mode is not shown in interface facts, so idempotency will not be maintained for switchport mode access and every time the output will come as changed=True.
+
+
+ name + +
+ string + / required +
+ 		+ +
Full name of interface, i.e. Ethernet1/1.
+
+
+ trunk + +
+ dictionary +
+ 		+ +
Switchport mode trunk command to configure the interface as a Layer-2 trunk.
+
+
+ allowed_vlans + +
+ string +
+ 		+ +
List of allowed VLANs in a given trunk port. These are the only VLANs that will be configured on the trunk.
+
+
+ native_vlan + +
+ integer +
+ 		+ +
Native VLAN to be configured in trunk port. It is used as the trunk native VLAN ID.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section ^interface.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state of the configuration after module completion.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOS 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # interface Ethernet1/2 + # switchport trunk native vlan 20 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + - name: Merge provided configuration with device configuration + cisco.nxos.nxos_l2_interfaces: + config: + - name: Ethernet1/1 + trunk: + native_vlan: 10 + allowed_vlans: 2,4,15 + - name: Ethernet1/2 + access: + vlan: 30 + state: merged + + # Task Output + # ----------- + # + # before: + # - name: Loopback999 + # - name: Ethernet1/2 + # - name: mgmt0 + # - name: Ethernet1/1 + # commands: + # - interface Ethernet1/1 + # - switchport trunk allowed vlan 2,4,15 + # - switchport trunk native vlan 10 + # - interface Ethernet1/2 + # - switchport access vlan 30 + # after: + # - name: Ethernet1/1 + # trunk: + # allowed_vlans: 2,4,15 + # native_vlan: 10 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + # - name: Loopback999 + + # After state: + # ------------ + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # switchport trunk native vlan 10 + # switchport trunk allowed vlans 2,4,15 + # interface Ethernet1/2 + # switchport access vlan 30 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + # Using replaced + + # Before state: + # ------------- + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # switchport trunk native vlan 10 + # switchport trunk allowed vlans 2,4,15 + # interface Ethernet1/2 + # switchport access vlan 30 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + - name: Replace device configuration of specified L2 interfaces with provided configuration. + cisco.nxos.nxos_l2_interfaces: + config: + - name: Ethernet1/1 + trunk: + native_vlan: 20 + allowed_vlans: 5-10, 15 + state: replaced + + # Task Output + # ----------- + # + # before: + # - name: Ethernet1/1 + # trunk: + # allowed_vlans: 2,4,15 + # native_vlan: 10 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + # commands: + # - interface Ethernet1/1 + # - no switchport trunk native vlan + # - switchport trunk allowed vlan 5-10,15 + # - switchport trunk native vlan 20 + # after: + # - name: Ethernet1/1 + # trunk: + # allowed_vlans: 5-10,15 + # native_vlan: 20 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + + # After state: + # ------------ + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # switchport trunk native vlan 20 + # switchport trunk allowed vlan 5-10,15 + # interface Ethernet1/2 + # switchport trunk native vlan 20 + # switchport mode trunk + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + # Using overridden + + # Before state: + # ------------- + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # switchport trunk native vlan 20 + # switchport trunk allowed vlan 5-10,15 + # interface Ethernet1/2 + # switchport trunk native vlan 20 + # switchport mode trunk + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + - name: Override device configuration with provided configuration. + cisco.nxos.nxos_l2_interfaces: + config: + - name: Ethernet1/2 + access: + vlan: 30 + state: overridden + + # Task Output + # ----------- + # + # before: + # - name: Ethernet1/1 + # trunk: + # allowed_vlans: 5,6,7,8,9,10,15 + # native_vlan: 20 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + # commands: + # - interface Ethernet1/1 + # - no switchport trunk allowed vlan + # - no switchport trunk native vlan + # after: + # - name: Ethernet1/1 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + + # After state: + # ------------ + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # interface Ethernet1/2 + # switchport access vlan 30 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + + # Using deleted + + # Before state: + # ------------- + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # switchport trunk native vlan 10 + # switchport trunk allowed vlan 2,4,15 + # interface Ethernet1/2 + # switchport access vlan 30 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + - name: Delete L2 attributes of given interfaces (Note This won't delete the interface + itself). + cisco.nxos.nxos_l2_interfaces: + config: + - name: Ethernet1/1 + - name: Ethernet1/2 + state: deleted + + # Task Output + # ----------- + # + # before: + # - name: Ethernet1/1 + # trunk: + # allowed_vlans: 2,4,15 + # native_vlan: 10 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + # commands: + # - interface Ethernet1/1 + # - no switchport trunk allowed vlan + # - no switchport trunk native vlan + # - interface Ethernet1/2 + # - no switchport access vlan + # after: + # - name: Ethernet1/1 + # - name: Ethernet1/2 + # - name: mgmt0 + + # After state: + # ------------ + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # interface Ethernet1/2 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + # Using rendered + + - name: Render platform specific configuration lines (without connecting to the device) + cisco.nxos.nxos_l2_interfaces: + config: + - name: Ethernet1/1 + trunk: + native_vlan: 10 + allowed_vlans: 2,4,15 + - name: Ethernet1/2 + access: + vlan: 30 + - name: Ethernet1/3 + trunk: + native_vlan: 20 + allowed_vlans: 5-10, 15 + state: rendered + + # Task Output + # ----------- + # + # rendered: + # - interface Ethernet1/1 + # - switchport trunk allowed vlan 2,4,15 + # - switchport trunk native vlan 10 + # - interface Ethernet1/2 + # - switchport access vlan 30 + # - interface Ethernet1/3 + # - switchport trunk allowed vlan 5-10,15 + # - switchport trunk native vlan 20 + + # Using parsed + + # parsed.cfg + # ------------ + # + # interface Ethernet1/800 + # switchport access vlan 18 + # switchport trunk allowed vlan 210 + # interface Ethernet1/801 + # switchport trunk allowed vlan 2,4,15 + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_l2_interfaces: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output + # ----------- + # + # parsed: + # - name: Ethernet1/800 + # access: + # vlan: 18 + # trunk: + # allowed_vlans: "210" + # - name: Ethernet1/801 + # trunk: + # allowed_vlans: "2,4,15" + + # Using gathered + + # Before state: + # ------------- + # + # switch# sh running-config | section ^interface + # interface Ethernet1/1 + # switchport access vlan 6 + # switchport trunk allowed vlan 200 + # interface Ethernet1/2 + # switchport trunk native vlan 10 + + - name: Gather l2_interfaces facts from the device using nxos_l2_interfaces + cisco.nxos.nxos_l2_interfaces: + state: gathered + + # Task output + # ----------- + # + # gathered: + # - name: "Ethernet1/1" + # access: + # vlan: 6 + # trunk: + # allowed_vlans: "200" + # - name: "Ethernet1/2" + # trunk: + # native_vlan: 10 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/1', 'switchport trunk allowed vlan 2,4,15', 'switchport trunk native vlan 10', 'interface Ethernet1/2', 'switchport access vlan 30', 'interface Ethernet1/3', 'switchport trunk allowed vlan 5,6,7,8,9,10,15', 'switchport trunk native vlan 20']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_l3_interfaces_module.rst b/docs/cisco.nxos.nxos_l3_interfaces_module.rst new file mode 100644 index 000000000..28a56bdf8 --- /dev/null +++ b/docs/cisco.nxos.nxos_l3_interfaces_module.rst @@ -0,0 +1,884 @@ +.. _cisco.nxos.nxos_l3_interfaces_module: + + +***************************** +cisco.nxos.nxos_l3_interfaces +***************************** + +**L3 interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages Layer-3 interfaces attributes of NX-OS Interfaces. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary of Layer-3 interface options
+
+
+ dot1q + +
+ integer +
+ 		+ +
Configures IEEE 802.1Q VLAN encapsulation on a subinterface.
+
+
+ evpn_multisite_tracking + +
+ string +
+
added in 1.1.0
+ 		+
    Choices: +
  • fabric-tracking
    • +
  • dci-tracking
    • +
+ 		+
VxLAN evpn multisite Interface tracking. Supported only on selected model.
+
+
+ ipv4 + +
+ list + / elements=dictionary +
+ 		+ +
IPv4 address and attributes of the L3 interface.
+
+
+ address + +
+ string +
+ 		+ +
IPV4 address of the L3 interface.
+
+
+ secondary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
A boolean attribute to manage addition of secondary IP address.
+
+
+ tag + +
+ integer +
+ 		+ +
URIB route tag value for local/direct routes.
+
+
+ ipv6 + +
+ list + / elements=dictionary +
+ 		+ +
IPv6 address and attributes of the L3 interface.
+
+
+ address + +
+ string +
+ 		+ +
IPV6 address of the L3 interface.
+
+
+ tag + +
+ integer +
+ 		+ +
URIB route tag value for local/direct routes.
+
+
+ ipv6_redirects + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/disables ipv6 redirects.
+
+
+ name + +
+ string + / required +
+ 		+ +
Full name of L3 interface, i.e. Ethernet1/1.
+
+
+ redirects + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/disables ipv4 redirects.
+
+
+ unreachables + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/disables ip redirects.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state of the configuration after module completion.
+
The state overridden would override the IP address configuration of all interfaces on the device with the provided configuration in the task. Use caution with this state as you may loose access to the device.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOS 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no shutdown + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + - name: Merge provided configuration with device configuration. + cisco.nxos.nxos_l3_interfaces: + config: + - name: Ethernet1/6 + ipv4: + - address: 192.168.1.1/24 + tag: 5 + - address: 10.1.1.1/24 + secondary: true + tag: 10 + ipv6: + - address: fd5d:12c9:2201:2::1/64 + tag: 6 + - name: Ethernet1/7.42 + redirects: false + unreachables: false + state: merged + + # Task Output + # ----------- + # + # before: + # - name: Ethernet1/6 + # - name: Ethernet1/7 + # - ipv4: + # - address: dhcp + # name: mgmt0 + # commands: + # - interface Ethernet1/6 + # - ip address 192.168.1.1/24 tag 5 + # - ip address 10.1.1.1/24 secondary tag 10 + # - ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + # - interface Ethernet1/7 + # - no ip redirects + # after: + # - ipv4: + # - address: 192.168.1.1/24 + # tag: 5 + # - address: 10.1.1.1/24 + # secondary: true + # tag: 10 + # ipv6: + # - address: fd5d:12c9:2201:2::1/64 + # tag: 6 + # name: Ethernet1/6 + # redirects: false + # - name: Ethernet1/7 + # redirects: false + # - ipv4: + # - address: dhcp + # name: mgmt0 + + # After state: + # ------------ + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no ip redirects + # ip address 192.168.1.1/24 tag 5 + # ip address 10.1.1.1/24 secondary tag 10 + # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no ip redirects + # no shutdown + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + + # Using replaced + + # Before state: + # ------------- + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no ip redirects + # ip address 192.168.1.1/24 tag 5 + # ip address 10.1.1.1/24 secondary tag 10 + # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no ip redirects + # no shutdown + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + - name: Replace device configuration of specified L3 interfaces with provided configuration. + cisco.nxos.nxos_l3_interfaces: + config: + - name: Ethernet1/6 + ipv4: + - address: 192.168.22.3/24 + state: replaced + + # Task Output + # ----------- + # + # before: + # - ipv4: + # - address: 192.168.1.1/24 + # tag: 5 + # - address: 10.1.1.1/24 + # secondary: true + # tag: 10 + # ipv6: + # - address: fd5d:12c9:2201:2::1/64 + # tag: 6 + # name: Ethernet1/6 + # redirects: false + # - name: Ethernet1/7 + # redirects: false + # - ipv4: + # - address: dhcp + # name: mgmt0 + # commands: + # - interface Ethernet1/6 + # - ip address 192.168.22.3/24 + # - no ipv6 address fd5d:12c9:2201:2::1/64 + # - ip redirects + # after: + # - ipv4: + # - address: 192.168.22.3/24 + # - address: 10.1.1.1/24 + # secondary: true + # tag: 10 + # name: Ethernet1/6 + # redirects: false + # - name: Ethernet1/7 + # redirects: false + # - ipv4: + # - address: dhcp + # name: mgmt0 + + # After state: + # ------------ + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no ip redirects + # ip address 192.168.22.3/24 + # ip address 10.1.1.1/24 secondary tag 10 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no ip redirects + # no shutdown + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + # Using overridden + + # Before state: + # ------------- + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no ip redirects + # ip address 192.168.1.1/24 tag 5 + # ip address 10.1.1.1/24 secondary tag 10 + # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no ip redirects + # no shutdown + # interface Ethernet1/7.42 + # no ip redirects + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + - name: Override device configuration with provided configuration. + cisco.nxos.nxos_l3_interfaces: + config: + - ipv4: + - address: dhcp + name: mgmt0 + - name: Ethernet1/6 + ipv4: + - address: 192.168.22.3/24 + state: overridden + + # Task Output + # ----------- + # + # before: + # - ipv4: + # - address: 192.168.1.1/24 + # tag: 5 + # - address: 10.1.1.1/24 + # secondary: true + # tag: 10 + # ipv6: + # - address: fd5d:12c9:2201:2::1/64 + # tag: 6 + # name: Ethernet1/6 + # redirects: false + # - name: Ethernet1/7 + # redirects: false + # - name: Ethernet1/7.42 + # redirects: false + # - ipv4: + # - address: dhcp + # name: mgmt0 + # commands: + # - interface Ethernet1/6 + # - no ipv6 address fd5d:12c9:2201:2::1/64 + # - no ip address 10.1.1.1/24 secondary + # - ip address 192.168.22.3/24 + # - ip redirects + # - interface Ethernet1/7 + # - ip redirects + # - interface Ethernet1/7.42 + # - ip redirects + # after: + # - ipv4: + # - address: 192.168.22.3/24 + # name: Ethernet1/6 + # - name: Ethernet1/7 + # - name: Ethernet1/7.42 + # - ipv4: + # - address: dhcp + # name: mgmt0 + + # After state: + # ------------ + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # ip address 192.168.22.3/24 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no shutdown + # interface Ethernet1/7.42 + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + # Using deleted + + # Before state: + # ------------- + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # ip address 192.168.22.3/24 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no shutdown + # interface Ethernet1/7.42 + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + - name: Delete L3 attributes of given interfaces (This won't delete the interface + itself). + cisco.nxos.nxos_l3_interfaces: + config: + - name: Ethernet1/6 + - name: Ethernet1/2 + state: deleted + + # Task Output + # ----------- + # + # before: + # - name: Ethernet1/2 + # - ipv4: + # - address: 192.168.22.3/24 + # name: Ethernet1/6 + # - name: Ethernet1/7 + # - name: Ethernet1/7.42 + # - ipv4: + # - address: dhcp + # name: mgmt0 + # commands: + # - interface Ethernet1/6 + # - no ip address + # after: + # - name: Ethernet1/2 + # - name: Ethernet1/7 + # - name: Ethernet1/7.42 + # - ipv4: + # - address: dhcp + # name: mgmt0 + + # After state: + # ------------ + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no shutdown + # interface Ethernet1/7.42 + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + # Using rendered + + - name: Use rendered state to convert task input to device specific commands + cisco.nxos.nxos_l3_interfaces: + config: + - name: Ethernet1/800 + ipv4: + - address: 192.168.1.100/24 + tag: 5 + - address: 10.1.1.1/24 + secondary: true + tag: 10 + - name: Ethernet1/800 + ipv6: + - address: fd5d:12c9:2201:2::1/64 + tag: 6 + state: rendered + + # Task Output + # ----------- + # + # rendered: + # - interface Ethernet1/800 + # - ip address 192.168.1.100/24 tag 5 + # - ip address 10.1.1.1/24 secondary tag 10 + # - interface Ethernet1/800 + # - ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + + # Using parsed + + # parsed.cfg + # ---------- + # + # interface Ethernet1/800 + # ip address 192.168.1.100/24 tag 5 + # ip address 10.1.1.1/24 secondary tag 10 + # no ip redirects + # interface Ethernet1/801 + # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + # ip unreachables + # interface mgmt0 + # ip address dhcp + # vrf member management + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_l3_interfaces: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output + # ----------- + # + # parsed: + # - name: Ethernet1/800 + # ipv4: + # - address: 192.168.1.100/24 + # tag: 5 + # - address: 10.1.1.1/24 + # secondary: True + # tag: 10 + # redirects: False + # - name: Ethernet1/801 + # ipv6: + # - address: fd5d:12c9:2201:2::1/64 + # tag: 6 + # unreachables: True + + # Using gathered + + # Before state: + # ------------- + # + # interface Ethernet1/1 + # ip address 192.0.2.100/24 + # interface Ethernet1/2 + # no ip redirects + # ip address 203.0.113.10/24 + # ip unreachables + # ipv6 address 2001:db8::1/32 + + - name: Gather l3_interfaces facts from the device using nxos_l3_interfaces + cisco.nxos.nxos_l3_interfaces: + state: gathered + + # Task output + # ----------- + # + # gathered: + # - name: Ethernet1/1 + # ipv4: + # - address: 192.0.2.100/24 + # - name: Ethernet1/2 + # ipv4: + # - address: 203.0.113.10/24 + # ipv6: + # - address: 2001:db8::1/32 + # redirects: False + # unreachables: True + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/2', 'ip address 192.168.0.1/2']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_lacp_module.rst b/docs/cisco.nxos.nxos_lacp_module.rst new file mode 100644 index 000000000..b0410c783 --- /dev/null +++ b/docs/cisco.nxos.nxos_lacp_module.rst @@ -0,0 +1,402 @@ +.. _cisco.nxos.nxos_lacp_module: + + +******************** +cisco.nxos.nxos_lacp +******************** + +**LACP resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages Global Link Aggregation Control Protocol (LACP) on NX-OS devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
LACP global options.
+
+
+ system + +
+ dictionary +
+ 		+ +
LACP system options
+
+
+ mac + +
+ dictionary +
+ 		+ +
MAC address to be used for the LACP Protocol exchanges
+
+
+ address + +
+ string +
+ 		+ +
MAC-address (FORMAT :xxxx.xxxx.xxxx).
+
+
+ role + +
+ string +
+ 		+
    Choices: +
  • primary
    • +
  • secondary
    • +
+ 		+
The role for the Switch.
+
+
+ priority + +
+ integer +
+ 		+ +
The system priority to use in LACP negotiations.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | include lacp.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state of the configuration after module completion.
+
States replaced and overridden have the same behaviour for this module.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOS 7.3.(0)D1(1) on VIRL. + - Unsupported for Cisco MDS + - Feature lacp should be enabled for this module. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + + - name: Merge provided configuration with device configuration. + cisco.nxos.nxos_lacp: + config: + system: + priority: 10 + mac: + address: 00c1.4c00.bd15 + state: merged + + # After state: + # ------------ + # + # lacp system-priority 10 + # lacp system-mac 00c1.4c00.bd15 + + + # Using replaced + + # Before state: + # ------------- + # + # lacp system-priority 10 + + - name: Replace device global lacp configuration with the given configuration. + cisco.nxos.nxos_lacp: + config: + system: + mac: + address: 00c1.4c00.bd15 + state: replaced + + # After state: + # ------------ + # + # lacp system-mac 00c1.4c00.bd15 + + + # Using deleted + + # Before state: + # ------------- + # + # lacp system-priority 10 + + - name: Delete global LACP configurations. + cisco.nxos.nxos_lacp: + state: deleted + + # After state: + # ------------ + # + + # Using rendered + + - name: Render platform specific configuration lines (without connecting to the device) + cisco.nxos.nxos_lacp: + config: + system: + priority: 10 + mac: + address: 00c1.4c00.bd15 + role: secondary + state: rendered + + # Task Output (redacted) + # ----------------------- + + # rendered: + # - "lacp system-priority 10" + # - "lacp system-mac 00c1.4c00.bd15 role secondary" + + # Using parsed + + # parsed.cfg + # ------------ + # lacp system-priority 10 + # lacp system-mac 00c1.4c00.bd15 role secondary + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_lacp: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # system: + # priority: 10 + # mac: + # address: 00c1.4c00.bd15 + # role: secondary + + # Using gathered + + # Existing device config state + # ------------------------------- + # Nexus9000v# show running-config | include lacp + # lacp system-priority 11 + # lacp system-mac 00c1.4c00.bd15 role primary + + - name: Gather lacp facts from the device using nxos_lacp + cisco.nxos.nxos_lacp: + state: gathered + + # Task output (redacted) + # ----------------------- + # gathered: + # system: + # priority: 11 + # mac: + # address: 00c1.4c00.bd15 + # role: primary + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['lacp system-priority 15', 'lacp system-mac 00c1.4c00.bd15 role primary']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_lldp_interfaces_module.rst b/docs/cisco.nxos.nxos_lldp_interfaces_module.rst new file mode 100644 index 000000000..d634e9aa4 --- /dev/null +++ b/docs/cisco.nxos.nxos_lldp_interfaces_module.rst @@ -0,0 +1,407 @@ +.. _cisco.nxos.nxos_lldp_interfaces_module: + + +******************************* +cisco.nxos.nxos_lldp_interfaces +******************************* + +**LLDP interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages interfaces' configuration for Link Layer Discovery Protocol (LLDP) on NX-OS platforms. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of link layer discovery configurations for interfaces.
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the interface
+
+
+ receive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Used to enable or disable the reception of LLDP packets on that interface. By default, this is enabled after LLDP is enabled globally.
+
+
+ tlv_set + +
+ dictionary +
+ 		+ +
Used to configure TLV parameters on the interface
+
+
+ management_address + +
+ string +
+ 		+ +
Used to mention the IPv4 or IPv6 management address for the interface
+
+
+ vlan + +
+ integer +
+ 		+ +
Used to mention the VLAN for the interface
+
+
+ transmit + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Used to enable or disable the transmission of LLDP packets on that interface. By default, this is enabled after LLDP is enabled globally.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section ^interface.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state the configuration should be left in
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOS 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - The LLDP feature needs to be enabled before using this module + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + + - name: Merge provided configuration with device configuration + cisco.nxos.nxos_lldp_interfaces: + config: + - name: Ethernet1/4 + receive: false + transmit: true + tlv_set: + management_address: 192.168.122.64 + vlan: 12 + state: merged + + # After state: + # ------------- + # + # interface Ethernet1/4 + # no lldp receive + # lldp tlv-set management-address 192.168.122.64 + # lldp tlv-set vlan 12 + + + # Using replaced + + # Before state: + # ------------ + # + # interface Ethernet1/4 + # no lldp receive + # lldp tlv-set management-address 192.168.122.64 + # interface Ethernet1/5 + # no lldp transmit + # lldp tlv-set vlan 10 + + - name: Replace LLDP configuration on interfaces with given configuration + cisco.nxos.nxos_lldp_interfaces: + config: + - name: Ethernet1/4 + transmit: false + tlv_set: + vlan: 2 + state: replaced + + + # After state: + # ----------- + # + # interface Ethernet1/4 + # no lldp transmit + # lldp tlv_set vlan 2 + # interface Ethernet1/5 + # no lldp transmit + # lldp tlv-set vlan 10 + + + # Using overridden + + # Before state: + # ------------ + # + # interface Ethernet1/4 + # no lldp receive + # lldp tlv-set management-address 192.168.122.64 + # interface Ethernet1/5 + # no lldp transmit + # lldp tlv-set vlan 10 + + - name: Override LLDP configuration on all interfaces with given configuration + cisco.nxos.nxos_lldp_interfaces: + config: + - name: Ethernet1/7 + receive: false + tlv_set: + vlan: 12 + state: overridden + + + # After state: + # ----------- + # + # interface Ethernet1/7 + # no lldp receive + # lldp tlv_set vlan 12 + + + # Using deleted + + # Before state: + # ------------ + # + # interface Ethernet1/4 + # lldp tlv-set management vlan 24 + # no lldp transmit + # interface mgmt0 + # no lldp receive + + - name: Delete LLDP interfaces configuration + cisco.nxos.nxos_lldp_interfaces: + state: deleted + + # After state: + # ------------ + # + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/2', 'lldp receive', 'lldp tlv-set vlan 12']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_logging_module.rst b/docs/cisco.nxos.nxos_logging_module.rst new file mode 100644 index 000000000..9dafd8e33 --- /dev/null +++ b/docs/cisco.nxos.nxos_logging_module.rst @@ -0,0 +1,458 @@ +.. _cisco.nxos.nxos_logging_module: + + +*********************** +cisco.nxos.nxos_logging +*********************** + +**Manage logging on network devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2023-08-01 +:Why: Updated module released with more functionality. +:Alternative: nxos_logging_global + + + +Synopsis +-------- +- This module provides declarative management of logging on Cisco NX-OS devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ aggregate + +
+ list + / elements=dictionary +
+ 		+ +
List of logging definitions.
+
+
+ dest + +
+ string +
+ 		+
    Choices: +
  • console
    • +
  • logfile
    • +
  • module
    • +
  • monitor
    • +
  • server
    • +
+ 		+
Destination of the logs.
+
+
+ dest_level + +
+ integer +
+ 		+ +
Set logging severity levels.
+

aliases: level
+
+
+ event + +
+ string +
+ 		+
    Choices: +
  • link-enable
    • +
  • link-default
    • +
  • trunk-enable
    • +
  • trunk-default
    • +
+ 		+
Link/trunk enable/default interface configuration logging
+
+
+ facility + +
+ string +
+ 		+ +
Facility name for logging.
+
+
+ facility_level + +
+ integer +
+ 		+ +
Set logging severity levels for facility based log messages.
+
+
+ facility_link_status + +
+ string +
+ 		+
    Choices: +
  • link-down-notif
    • +
  • link-down-error
    • +
  • link-up-notif
    • +
  • link-up-error
    • +
+ 		+
Set logging facility ethpm link status. Not idempotent with version 6.0 images.
+
+
+ file_size + +
+ integer +
+ 		+ +
Set logfile size
+
+
+ interface + +
+ string +
+ 		+ +
Interface to be used while configuring source-interface for logging (e.g., 'Ethernet1/2', 'mgmt0')
+
+
+ interface_message + +
+ string +
+ 		+
    Choices: +
  • add-interface-description
    • +
+ 		+
Add interface description to interface syslogs. Does not work with version 6.0 images using nxapi as a transport.
+
+
+ name + +
+ string +
+ 		+ +
If value of dest is logfile it indicates file-name.
+
+
+ purge + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Remove any switch logging configuration that does not match what has been configured Not supported for ansible_connection local. All nxos_logging tasks must use the same ansible_connection type.
+
+
+ remote_server + +
+ string +
+ 		+ +
Hostname or IP Address for remote logging (when dest is 'server').
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
State of the logging configuration.
+
+
+ timestamp + +
+ string +
+ 		+
    Choices: +
  • microseconds
    • +
  • milliseconds
    • +
  • seconds
    • +
+ 		+
Set logging timestamp format
+
+
+ use_vrf + +
+ string +
+ 		+ +
VRF to be used while configuring remote logging (when dest is 'server').
+
+
+ + +Notes +----- + +.. note:: + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: configure console logging with level + cisco.nxos.nxos_logging: + dest: console + level: 2 + state: present + - name: remove console logging configuration + cisco.nxos.nxos_logging: + dest: console + level: 2 + state: absent + - name: configure file logging with level + cisco.nxos.nxos_logging: + dest: logfile + name: testfile + dest_level: 3 + state: present + - name: Configure logging logfile with size + cisco.nxos.nxos_logging: + dest: logfile + name: testfile + dest_level: 3 + file_size: 16384 + - name: configure facility level logging + cisco.nxos.nxos_logging: + facility: daemon + facility_level: 0 + state: present + - name: remove facility level logging + cisco.nxos.nxos_logging: + facility: daemon + facility_level: 0 + state: absent + - name: Configure Remote Logging + cisco.nxos.nxos_logging: + dest: server + remote_server: test-syslogserver.com + facility: auth + facility_level: 1 + use_vrf: management + state: present + - name: Configure Source Interface for Logging + cisco.nxos.nxos_logging: + interface: mgmt0 + state: present + - name: Purge nxos_logging configuration not managed by this playbook + cisco.nxos.nxos_logging: + purge: true + - name: Configure logging timestamp + cisco.nxos.nxos_logging: + timestamp: milliseconds + state: present + - name: Configure logging facility ethpm link status + cisco.nxos.nxos_logging: + facility: ethpm + facility_link_status: link-up-notif + state: present + - name: Configure logging message ethernet description + cisco.nxos.nxos_logging: + interface_message: add-interface-description + state: present + - name: Configure logging event link enable + cisco.nxos.nxos_logging: + event: link-enable + state: present + - name: Configure logging using aggregate + cisco.nxos.nxos_logging: + aggregate: + - {dest: console, dest_level: 2} + - {dest: logfile, dest_level: 2, name: testfile} + - {facility: daemon, facility_level: 0} + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['logging console 2', 'logging logfile testfile 3', 'logging level daemon 0']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2023-08-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_ntp_auth_module.rst b/docs/cisco.nxos.nxos_ntp_auth_module.rst new file mode 100644 index 000000000..c825cd017 --- /dev/null +++ b/docs/cisco.nxos.nxos_ntp_auth_module.rst @@ -0,0 +1,224 @@ +.. _cisco.nxos.nxos_ntp_auth_module: + + +************************ +cisco.nxos.nxos_ntp_auth +************************ + +**Manages NTP authentication.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated module released with more functionality. +:Alternative: nxos_ntp_global + + + +Synopsis +-------- +- Manages NTP authentication. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ auth_type + +
+ string +
+ 		+
    Choices: +
  • text ←
    • +
  • encrypt
    • +
+ 		+
Whether the given md5string is in cleartext or has been encrypted. If in cleartext, the device will encrypt it before storing it.
+
+
+ authentication + +
+ string +
+ 		+
    Choices: +
  • on
    • +
  • off
    • +
+ 		+
Turns NTP authentication on or off.
+
+
+ key_id + +
+ string +
+ 		+ +
Authentication key identifier (numeric).
+
+
+ md5string + +
+ string +
+ 		+ +
MD5 String.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ trusted_key + +
+ string +
+ 		+
    Choices: +
  • false ←
    • +
  • true
    • +
+ 		+
Whether the given key is required to be supplied by a time source for the device to synchronize to the time source.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - If ``state=absent``, the module will remove the given key configuration if it exists. + - If ``state=absent`` and ``authentication=on``, authentication will be turned off. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Basic NTP authentication configuration + - cisco.nxos.nxos_ntp_auth: + key_id: 32 + md5string: hello + auth_type: text + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['ntp authentication-key 32 md5 helloWorld 0', 'ntp trusted-key 32']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_ntp_global_module.rst b/docs/cisco.nxos.nxos_ntp_global_module.rst new file mode 100644 index 000000000..b77fc9440 --- /dev/null +++ b/docs/cisco.nxos.nxos_ntp_global_module.rst @@ -0,0 +1,1411 @@ +.. _cisco.nxos.nxos_ntp_global_module: + + +************************** +cisco.nxos.nxos_ntp_global +************************** + +**NTP Global resource module.** + + +Version added: 2.6.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages ntp configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A dict of ntp configuration.
+
+
+ access_group + +
+ dictionary +
+ 		+ +
NTP access-group.
+
This option is unsupported on MDS switches.
+
+
+ match_all + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Scan ACLs present in all ntp access groups.
+
+
+ peer + +
+ list + / elements=dictionary +
+ 		+ +
Access-group peer.
+
+
+ access_list + +
+ string +
+ 		+ +
Name of access list.
+
+
+ query_only + +
+ list + / elements=dictionary +
+ 		+ +
Access-group query-only.
+
+
+ access_list + +
+ string +
+ 		+ +
Name of access list.
+
+
+ serve + +
+ list + / elements=dictionary +
+ 		+ +
Access-group serve.
+
+
+ access_list + +
+ string +
+ 		+ +
Name of access list.
+
+
+ serve_only + +
+ list + / elements=dictionary +
+ 		+ +
Access-group serve-only.
+
+
+ access_list + +
+ string +
+ 		+ +
Name of access list.
+
+
+ allow + +
+ dictionary +
+ 		+ +
Enable/Disable the packets.
+
+
+ control + +
+ dictionary +
+ 		+ +
Control mode packets.
+
+
+ rate_limit + +
+ integer +
+ 		+ +
Rate-limit delay.
+
+
+ private + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable Private mode packets.
+
+
+ authenticate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable authentication.
+
+
+ authentication_keys + +
+ list + / elements=dictionary +
+ 		+ +
NTP authentication key.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 for Clear text
+
7 for Encrypted
+
+
+ id + +
+ integer +
+ 		+ +
Authentication key number (range 1-65535).
+
+
+ key + +
+ string +
+ 		+ +
Authentication key.
+
+
+ logging + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable logging of NTPD Events.
+
+
+ master + +
+ dictionary +
+ 		+ +
Act as NTP master clock.
+
This option is unsupported on MDS switches.
+
+
+ stratum + +
+ integer +
+ 		+ +
Stratum number.
+
+
+ passive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
NTP passive command.
+
This option is unsupported on MDS switches.
+
+
+ peers + +
+ list + / elements=dictionary +
+ 		+ +
NTP Peers.
+
+
+ key_id + +
+ integer +
+ 		+ +
Keyid to be used while communicating to this server.
+
+
+ maxpoll + +
+ integer +
+ 		+ +
Maximum interval to poll a peer.
+
Poll interval in secs to a power of 2.
+
+
+ minpoll + +
+ integer +
+ 		+ +
Minimum interval to poll a peer.
+
Poll interval in secs to a power of 2.
+
+
+ peer + +
+ string +
+ 		+ +
Hostname/IP address of the NTP Peer.
+
+
+ prefer + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Preferred Server.
+
+
+ vrf + +
+ string +
+ 		+ +
Display per-VRF information.
+
This option is unsupported on MDS switches.
+

aliases: use_vrf
+
+
+ servers + +
+ list + / elements=dictionary +
+ 		+ +
NTP servers.
+
+
+ key_id + +
+ integer +
+ 		+ +
Keyid to be used while communicating to this server.
+
+
+ maxpoll + +
+ integer +
+ 		+ +
Maximum interval to poll a peer.
+
Poll interval in secs to a power of 2.
+
+
+ minpoll + +
+ integer +
+ 		+ +
Minimum interval to poll a peer.
+
Poll interval in secs to a power of 2.
+
+
+ prefer + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Preferred Server.
+
+
+ server + +
+ string +
+ 		+ +
Hostname/IP address of the NTP Peer.
+
+
+ vrf + +
+ string +
+ 		+ +
Display per-VRF information.
+
This option is not applicable for MDS switches.
+

aliases: use_vrf
+
+
+ source + +
+ string +
+ 		+ +
Source of NTP packets.
+
This option is unsupported on MDS switches.
+
+
+ source_interface + +
+ string +
+ 		+ +
Source interface sending NTP packets.
+
+
+ trusted_keys + +
+ list + / elements=dictionary +
+ 		+ +
NTP trusted-key number.
+
+
+ key_id + +
+ integer +
+ 		+ +
Trusted-Key number.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config ntp.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
The states replaced and overridden have identical behaviour for this module.
+
Please refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6 on Cisco Nexus Switches. + - This module works with connection ``network_cli`` and ``httpapi``. + - Tested against Cisco MDS NX-OS 9.2(2) with connection ``network_cli``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k-rdo# show running-config ntp + # nxos-9k-rdo# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_ntp_global: &id001 + config: + access_group: + peer: + - access_list: PeerAcl1 + serve: + - access_list: ServeAcl1 + authenticate: true + authentication_keys: + - id: 1001 + key: vagwwtKfkv + encryption: 7 + - id: 1002 + key: vagwwtKfkvgthz + encryption: 7 + logging: true + master: + stratum: 2 + peers: + - peer: 192.0.2.1 + key_id: 1 + maxpoll: 15 + minpoll: 5 + vrf: default + - peer: 192.0.2.2 + key_id: 2 + prefer: true + vrf: siteA + servers: + - server: 198.51.100.1 + key_id: 2 + vrf: default + - server: 203.0.113.1 + key_id: 1 + vrf: siteB + + # Task output + # ------------- + # before: {} + # + # commands: + # - "ntp authenticate" + # - "ntp logging" + # - "ntp master 2" + # - "ntp authentication-keys 1001 md5 vagwwtKfkv 7" + # - "ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" + # - "ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" + # - "ntp peer 192.0.2.2 prefer use-vrf siteA key 2" + # - "ntp server 198.51.100.1 use-vrf default key 2" + # - "ntp server 203.0.113.1 use-vrf siteB key 1" + # - "ntp access-group peer PeerAcl1" + # - "ntp access-group serve ServeAcl1" + # + # after: + # access_group: + # peer: + # - access_list: PeerAcl1 + # serve: + # - access_list: ServeAcl1 + # authenticate: true + # authentication_keys: + # - id: 1001 + # key: vagwwtKfkv + # encryption: 7 + # - id: 1002 + # key: vagwwtKfkvgthz + # encryption: 7 + # logging: true + # master: + # stratum: 2 + # peers: + # - peer: 192.0.2.1 + # key_id: 1 + # maxpoll: 15 + # minpoll: 5 + # vrf: default + # - peer: 192.0.2.2 + # key_id: 2 + # prefer: true + # vrf: siteA + # servers: + # - server: 198.51.100.1 + # key_id: 2 + # vrf: default + # - server: 203.0.113.1 + # key_id: 1 + # vrf: siteB + + # After state: + # ------------ + # nxos-9k-rdo# show running-config ntp + # ntp authenticate + # ntp logging + # ntp master 2 + # ntp authentication-keys 1001 md5 vagwwtKfkv 7 + # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 + # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 + # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 + # ntp server 198.51.100.1 use-vrf default key 2 + # ntp server 203.0.113.1 use-vrf siteB key 1 + # ntp access-group peer PeerAcl1 + # ntp access-group serve ServeAcl1 + + # Using replaced + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config ntp + # ntp authenticate + # ntp logging + # ntp master 2 + # ntp authentication-keys 1001 md5 vagwwtKfkv 7 + # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 + # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 + # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 + # ntp server 198.51.100.1 use-vrf default key 2 + # ntp server 203.0.113.1 use-vrf siteB key 1 + # ntp access-group peer PeerAcl1 + # ntp access-group serve ServeAcl1 + + - name: Replace logging global configurations of listed logging global with provided configurations + cisco.nxos.nxos_ntp_global: + config: + access_group: + peer: + - access_list: PeerAcl2 + serve: + - access_list: ServeAcl2 + logging: true + master: + stratum: 2 + peers: + - peer: 192.0.2.1 + key_id: 1 + maxpoll: 15 + minpoll: 5 + vrf: default + - peer: 192.0.2.5 + key_id: 2 + prefer: true + vrf: siteA + servers: + - server: 198.51.100.1 + key_id: 2 + vrf: default + state: replaced + + # Task output + # ------------- + # before: + # access_group: + # peer: + # - access_list: PeerAcl1 + # serve: + # - access_list: ServeAcl1 + # authenticate: true + # authentication_keys: + # - id: 1001 + # key: vagwwtKfkv + # encryption: 7 + # - id: 1002 + # key: vagwwtKfkvgthz + # encryption: 7 + # logging: true + # master: + # stratum: 2 + # peers: + # - peer: 192.0.2.1 + # key_id: 1 + # maxpoll: 15 + # minpoll: 5 + # vrf: default + # - peer: 192.0.2.2 + # key_id: 2 + # prefer: true + # vrf: siteA + # servers: + # - server: 198.51.100.1 + # key_id: 2 + # vrf: default + # - server: 203.0.113.1 + # key_id: 1 + # vrf: siteB + # + # commands: + # - "no ntp authenticate" + # - "no ntp authentication-keys 1001 md5 vagwwtKfkv 7" + # - "no ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" + # - "ntp peer 192.0.2.5 prefer use-vrf siteA key 2" + # - "no ntp peer 192.0.2.2 prefer use-vrf siteA key 2" + # - "no ntp server 203.0.113.1 use-vrf siteB key 1" + # - "ntp access-group peer PeerAcl2" + # - "no ntp access-group peer PeerAcl1" + # - "ntp access-group serve ServeAcl2" + # - "no ntp access-group serve ServeAcl1" + # + # after: + # access_group: + # peer: + # - access_list: PeerAcl2 + # serve: + # - access_list: ServeAcl2 + # logging: true + # master: + # stratum: 2 + # peers: + # - peer: 192.0.2.1 + # key_id: 1 + # maxpoll: 15 + # minpoll: 5 + # vrf: default + # - peer: 192.0.2.5 + # key_id: 2 + # prefer: true + # vrf: siteA + # servers: + # - server: 198.51.100.1 + # key_id: 2 + # vrf: default + + # After state: + # ------------ + # nxos-9k-rdo# show running-config ntp + # ntp logging + # ntp master 2 + # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 + # ntp peer 192.0.2.5 prefer use-vrf siteA key 2 + # ntp server 198.51.100.1 use-vrf default key 2 + # ntp access-group peer PeerAcl2 + # ntp access-group serve ServeAcl2 + + # Using deleted to delete all logging configurations + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config ntp + + - name: Delete all logging configuration + cisco.nxos.nxos_ntp_global: + state: deleted + + # Task output + # ------------- + # before: + # access_group: + # peer: + # - access_list: PeerAcl1 + # serve: + # - access_list: ServeAcl1 + # authenticate: true + # authentication_keys: + # - id: 1001 + # key: vagwwtKfkv + # encryption: 7 + # - id: 1002 + # key: vagwwtKfkvgthz + # encryption: 7 + # logging: true + # master: + # stratum: 2 + # peers: + # - peer: 192.0.2.1 + # key_id: 1 + # maxpoll: 15 + # minpoll: 5 + # vrf: default + # - peer: 192.0.2.2 + # key_id: 2 + # prefer: true + # vrf: siteA + # servers: + # - server: 198.51.100.1 + # key_id: 2 + # vrf: default + # - server: 203.0.113.1 + # key_id: 1 + # vrf: siteB + # + # commands: + # - "no ntp authenticate" + # - "no ntp logging" + # - "no ntp master 2" + # - "no ntp authentication-keys 1001 md5 vagwwtKfkv 7" + # - "no ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" + # - "no ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" + # - "no ntp peer 192.0.2.2 prefer use-vrf siteA key 2" + # - "no ntp server 198.51.100.1 use-vrf default key 2" + # - "no ntp server 203.0.113.1 use-vrf siteB key 1" + # - "no ntp access-group peer PeerAcl1" + # - "no ntp access-group serve ServeAcl1" + # + # after: {} + + # After state: + # ------------ + # nxos-9k-rdo# show running-config ntp + # nxos-9k-rdo# + + # Using rendered + + - name: Render platform specific configuration lines with state rendered (without connecting to the device) + cisco.nxos.nxos_ntp_global: + config: + access_group: + peer: + - access_list: PeerAcl1 + serve: + - access_list: ServeAcl1 + authenticate: true + authentication_keys: + - id: 1001 + key: vagwwtKfkv + encryption: 7 + - id: 1002 + key: vagwwtKfkvgthz + encryption: 7 + logging: true + master: + stratum: 2 + peers: + - peer: 192.0.2.1 + key_id: 1 + maxpoll: 15 + minpoll: 5 + vrf: default + - peer: 192.0.2.2 + key_id: 2 + prefer: true + vrf: siteA + servers: + - server: 198.51.100.1 + key_id: 2 + vrf: default + - server: 203.0.113.1 + key_id: 1 + vrf: siteB + state: rendered + + # Task Output (redacted) + # ----------------------- + # rendered: + # - "ntp authenticate" + # - "ntp logging" + # - "ntp master 2" + # - "ntp authentication-keys 1001 md5 vagwwtKfkv 7" + # - "ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" + # - "ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" + # - "ntp peer 192.0.2.2 prefer use-vrf siteA key 2" + # - "ntp server 198.51.100.1 use-vrf default key 2" + # - "ntp server 203.0.113.1 use-vrf siteB key 1" + # - "ntp access-group peer PeerAcl1" + # - "ntp access-group serve ServeAcl1" + + # Using parsed + + # parsed.cfg + # ------------ + # ntp authenticate + # ntp logging + # ntp master 2 + # ntp authentication-keys 1001 md5 vagwwtKfkv 7 + # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 + # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 + # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 + # ntp server 198.51.100.1 use-vrf default key 2 + # ntp server 203.0.113.1 use-vrf siteB key 1 + # ntp access-group peer PeerAcl1 + # ntp access-group serve ServeAcl1 + + - name: Parse externally provided ntp configuration + cisco.nxos.nxos_ntp_global: + running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # access_group: + # peer: + # - access_list: PeerAcl1 + # serve: + # - access_list: ServeAcl1 + # authenticate: true + # authentication_keys: + # - id: 1001 + # key: vagwwtKfkv + # encryption: 7 + # - id: 1002 + # key: vagwwtKfkvgthz + # encryption: 7 + # logging: true + # master: + # stratum: 2 + # peers: + # - peer: 192.0.2.1 + # key_id: 1 + # maxpoll: 15 + # minpoll: 5 + # vrf: default + # - peer: 192.0.2.2 + # key_id: 2 + # prefer: true + # vrf: siteA + # servers: + # - server: 198.51.100.1 + # key_id: 2 + # vrf: default + # - server: 203.0.113.1 + # key_id: 1 + # vrf: siteB + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['ntp master stratum 2', 'ntp peer 198.51.100.1 use-vrf test maxpoll 7', 'ntp authentication-key 10 md5 wawyhanx2 7', 'ntp access-group peer PeerAcl1', 'ntp access-group peer PeerAcl2', 'ntp access-group query-only QueryAcl1']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['ntp master stratum 2', 'ntp peer 198.51.100.1 use-vrf test maxpoll 7', 'ntp authentication-key 10 md5 wawyhanx2 7', 'ntp access-group peer PeerAcl1', 'ntp access-group peer PeerAcl2', 'ntp access-group query-only QueryAcl1']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_ntp_module.rst b/docs/cisco.nxos.nxos_ntp_module.rst new file mode 100644 index 000000000..3fa835a96 --- /dev/null +++ b/docs/cisco.nxos.nxos_ntp_module.rst @@ -0,0 +1,314 @@ +.. _cisco.nxos.nxos_ntp_module: + + +******************* +cisco.nxos.nxos_ntp +******************* + +**Manages core NTP configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated module released with more functionality. +:Alternative: nxos_ntp_global + + + +Synopsis +-------- +- Manages core NTP configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ key_id + +
+ string +
+ 		+ +
Authentication key identifier to use with given NTP server or peer or keyword 'default'.
+
+
+ peer + +
+ string +
+ 		+ +
Network address of NTP peer.
+
+
+ prefer + +
+ string +
+ 		+
    Choices: +
  • enabled
    • +
  • disabled
    • +
+ 		+
Makes given NTP server or peer the preferred NTP server or peer for the device.
+
+
+ server + +
+ string +
+ 		+ +
Network address of NTP server.
+
+
+ source_addr + +
+ string +
+ 		+ +
Local source address from which NTP messages are sent or keyword 'default'.
+
+
+ source_int + +
+ string +
+ 		+ +
Local source interface from which NTP messages are sent. Must be fully qualified interface name or keyword 'default'
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ vrf_name + +
+ string +
+ 		+ +
Makes the device communicate with the given NTP server or peer over a specific VRF or keyword 'default'.
+
+
+ + +Notes +----- + +.. note:: + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Set NTP Server with parameters + - cisco.nxos.nxos_ntp: + server: 1.2.3.4 + key_id: 32 + prefer: enabled + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ end_state + +
+ dictionary +
+ 		always +
k/v pairs of ntp info after module execution
+
+
Sample:
+
{'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'server', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'source'}
+
+
+ existing + +
+ dictionary +
+ 		always +
k/v pairs of existing ntp server/peer
+
+
Sample:
+
{'address': '192.0.2.2', 'key_id': '32', 'peer_type': 'server', 'prefer': 'enabled', 'source': 'ethernet2/1', 'source_type': 'source-interface'}
+
+
+ proposed + +
+ dictionary +
+ 		always +
k/v pairs of parameters passed into module
+
+
Sample:
+
{'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'server', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'source'}
+
+
+ updates + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['ntp server 192.0.2.2 prefer key 48', 'no ntp source-interface ethernet2/1', 'ntp source 192.0.2.3']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_ntp_options_module.rst b/docs/cisco.nxos.nxos_ntp_options_module.rst new file mode 100644 index 000000000..e99825641 --- /dev/null +++ b/docs/cisco.nxos.nxos_ntp_options_module.rst @@ -0,0 +1,192 @@ +.. _cisco.nxos.nxos_ntp_options_module: + + +*************************** +cisco.nxos.nxos_ntp_options +*************************** + +**Manages NTP options.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated module released with more functionality. +:Alternative: nxos_ntp_global + + + +Synopsis +-------- +- Manages NTP options, e.g. authoritative server and logging. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ logging + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Sets whether NTP logging is enabled on the device.
+
+
+ master + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Sets whether the device is an authoritative NTP server.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ stratum + +
+ string +
+ 		+ +
If master=true, an optional stratum can be supplied (1-15). The device default is 8.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - When ``state=absent``, master and logging will be set to False and stratum will be removed as well + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Basic NTP options configuration + - cisco.nxos.nxos_ntp_options: + master: true + stratum: 12 + logging: false + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ updates + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['no ntp logging', 'ntp master 12']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_nxapi_module.rst b/docs/cisco.nxos.nxos_nxapi_module.rst new file mode 100644 index 000000000..182fe1516 --- /dev/null +++ b/docs/cisco.nxos.nxos_nxapi_module.rst @@ -0,0 +1,300 @@ +.. _cisco.nxos.nxos_nxapi_module: + + +********************* +cisco.nxos.nxos_nxapi +********************* + +**Manage NXAPI configuration on an NXOS device.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Configures the NXAPI feature on devices running Cisco NXOS. The NXAPI feature is absent from the configuration by default. Since this module manages the NXAPI feature it only supports the use of the ``Cli`` transport. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ http + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
Controls the operating state of the HTTP protocol as one of the underlying transports for NXAPI. By default, NXAPI will enable the HTTP transport when the feature is first configured. To disable the use of the HTTP transport, set the value of this argument to False.
+

aliases: enable_http
+
+
+ http_port + +
+ integer +
+ 		+ Default:
80
+ 		+
Configure the port with which the HTTP server will listen on for requests. By default, NXAPI will bind the HTTP service to the standard HTTP port 80. This argument accepts valid port values in the range of 1 to 65535.
+
+
+ https + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Controls the operating state of the HTTPS protocol as one of the underlying transports for NXAPI. By default, NXAPI will disable the HTTPS transport when the feature is first configured. To enable the use of the HTTPS transport, set the value of this argument to True.
+

aliases: enable_https
+
+
+ https_port + +
+ integer +
+ 		+ Default:
443
+ 		+
Configure the port with which the HTTPS server will listen on for requests. By default, NXAPI will bind the HTTPS service to the standard HTTPS port 443. This argument accepts valid port values in the range of 1 to 65535.
+
+
+ sandbox + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
The NXAPI feature provides a web base UI for developers for entering commands. This feature is initially disabled when the NXAPI feature is configured for the first time. When the sandbox argument is set to True, the developer sandbox URL will accept requests and when the value is set to False, the sandbox URL is unavailable. This is supported on NX-OS 7K series.
+

aliases: enable_sandbox
+
+
+ ssl_strong_ciphers + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Controls the use of whether strong or weak ciphers are configured. By default, this feature is disabled and weak ciphers are configured. To enable the use of strong ciphers, set the value of this argument to True.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
The state argument controls whether or not the NXAPI feature is configured on the remote device. When the value is present the NXAPI feature configuration is present in the device running-config. When the values is absent the feature configuration is removed from the running-config.
+
+
+ tlsv1_0 + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
Controls the use of the Transport Layer Security version 1.0 is configured. By default, this feature is enabled. To disable the use of TLSV1.0, set the value of this argument to True.
+
+
+ tlsv1_1 + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Controls the use of the Transport Layer Security version 1.1 is configured. By default, this feature is disabled. To enable the use of TLSV1.1, set the value of this argument to True.
+
+
+ tlsv1_2 + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Controls the use of the Transport Layer Security version 1.2 is configured. By default, this feature is disabled. To enable the use of TLSV1.2, set the value of this argument to True.
+
+
+ + +Notes +----- + +.. note:: + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Enable NXAPI access with default configuration + cisco.nxos.nxos_nxapi: + state: present + + - name: Enable NXAPI with no HTTP, HTTPS at port 9443 and sandbox disabled + cisco.nxos.nxos_nxapi: + enable_http: false + https_port: 9443 + https: true + enable_sandbox: false + + - name: remove NXAPI configuration + cisco.nxos.nxos_nxapi: + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ updates + +
+ list +
+ 		always +
Returns the list of commands that need to be pushed into the remote device to satisfy the arguments
+
+
Sample:
+
['no feature nxapi']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_ospf_interfaces_module.rst b/docs/cisco.nxos.nxos_ospf_interfaces_module.rst new file mode 100644 index 000000000..ff69b6e71 --- /dev/null +++ b/docs/cisco.nxos.nxos_ospf_interfaces_module.rst @@ -0,0 +1,1732 @@ +.. _cisco.nxos.nxos_ospf_interfaces_module: + + +******************************* +cisco.nxos.nxos_ospf_interfaces +******************************* + +**OSPF Interfaces Resource Module.** + + +Version added: 1.3.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages OSPF(v2/v3) configuration of interfaces on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of OSPF configuration for interfaces.
+
+
+ address_family + +
+ list + / elements=dictionary +
+ 		+ +
OSPF settings on the interfaces in address-family context.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
Address Family Identifier (AFI) for OSPF settings on the interfaces.
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Authentication settings on the interface.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable authentication on the interface.
+
+
+ key_chain + +
+ string +
+ 		+ +
Authentication password key-chain.
+
+
+ message_digest + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use message-digest authentication.
+
+
+ null_auth + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use null(disable) authentication.
+
+
+ authentication_key + +
+ dictionary +
+ 		+ +
Configure the authentication key for the interface.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 Specifies an UNENCRYPTED authentication key will follow.
+
3 Specifies an 3DES ENCRYPTED authentication key will follow.
+
7 Specifies a Cisco type 7 ENCRYPTED authentication key will follow.
+
+
+ key + +
+ string + / required +
+ 		+ +
Authentication key.
+
Valid values are Cisco type 7 ENCRYPTED password, 3DES ENCRYPTED password and UNENCRYPTED (cleartext) password based on the value of encryption key.
+
+
+ cost + +
+ integer +
+ 		+ +
Cost associated with interface.
+
+
+ dead_interval + +
+ integer +
+ 		+ +
Dead interval value (in seconds).
+
+
+ default_passive_interface + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set passive-interface attribute on this interface to default.
+
This option is mutually exclusive with passive_interface.
+
+
+ hello_interval + +
+ integer +
+ 		+ +
Hello interval value (in seconds).
+
+
+ instance + +
+ integer +
+ 		+ +
Instance identifier.
+
+
+ message_digest_key + +
+ dictionary +
+ 		+ +
Message digest authentication password (key) settings.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 Specifies an UNENCRYPTED ospf password (key) will follow.
+
3 Specifies an 3DES ENCRYPTED ospf password (key) will follow.
+
7 Specifies a Cisco type 7 ENCRYPTED the ospf password (key) will follow.
+
+
+ key + +
+ string + / required +
+ 		+ +
Authentication key.
+
Valid values are Cisco type 7 ENCRYPTED password, 3DES ENCRYPTED password and UNENCRYPTED (cleartext) password based on the value of encryption key.
+
+
+ key_id + +
+ integer + / required +
+ 		+ +
Key ID.
+
+
+ mtu_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable OSPF MTU mismatch detection.
+
+
+ multi_areas + +
+ list + / elements=string +
+ 		+ +
Multi-Areas associated with interface (not tied to OSPF process).
+
Valid values are Area Ids as an integer or IP address.
+
+
+ network + +
+ string +
+ 		+
    Choices: +
  • broadcast
    • +
  • point-to-point
    • +
+ 		+
Network type.
+
+
+ passive_interface + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress routing updates on the interface.
+
This option is mutually exclusive with default_passive_interface.
+
+
+ priority + +
+ integer +
+ 		+ +
Router priority.
+
+
+ processes + +
+ list + / elements=dictionary +
+ 		+ +
Interfaces configuration for an OSPF process.
+
+
+ area + +
+ dictionary +
+ 		+ +
Area associated with interface.
+
+
+ area_id + +
+ string + / required +
+ 		+ +
Area ID in IP address format.
+
+
+ secondaries + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not include secondary IPv4/IPv6 addresses.
+
+
+ multi_areas + +
+ list + / elements=string +
+ 		+ +
Multi-Areas associated with interface.
+
Valid values are Area Ids as an integer or IP address.
+
+
+ process_id + +
+ string + / required +
+ 		+ +
OSPF process tag.
+
+
+ retransmit_interval + +
+ integer +
+ 		+ +
Packet retransmission interval.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Shutdown OSPF on this interface.
+
+
+ transmit_delay + +
+ integer +
+ 		+ +
Packet transmission delay.
+
+
+ name + +
+ string + / required +
+ 		+ +
Name/Identifier of the interface.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section "^interface".
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • parsed
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
+
+ + +Notes +----- + +.. note:: + - Unsupported for Cisco MDS + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # interface Ethernet1/2 + # no switchport + # interface Ethernet1/3 + # no switchport + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_ospf_interfaces: + config: + - name: Ethernet1/1 + address_family: + - afi: ipv4 + processes: + - process_id: '100' + area: + area_id: 1.1.1.1 + secondaries: false + multi_areas: + - 11.11.11.11 + - afi: ipv6 + processes: + - process_id: '200' + area: + area_id: 2.2.2.2 + multi_areas: + - 21.0.0.0 + - process_id: '300' + multi_areas: + - 50.50.50.50 + multi_areas: + - 16.10.10.10 + - name: Ethernet1/2 + address_family: + - afi: ipv4 + authentication: + enable: true + key_chain: test-1 + message_digest_key: + key_id: 10 + encryption: 3 + key: abc01d272be25d29 + cost: 100 + - afi: ipv6 + network: broadcast + shutdown: true + - name: Ethernet1/3 + address_family: + - afi: ipv4 + authentication_key: + encryption: 7 + key: 12090404011C03162E + state: merged + + # Task output: + # ------------ + # before: + # - name: Ethernet1/1 + # - name: Ethernet1/2 + # - name: Ethernet1/3 + # + # commands: + # - interface Ethernet1/1 + # - ip router ospf multi-area 11.11.11.11 + # - ip router ospf 100 area 1.1.1.1 secondaries none + # - ipv6 router ospfv3 multi-area 16.10.10.10 + # - ipv6 router ospfv3 200 area 2.2.2.2 + # - ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - ipv6 router ospfv3 300 multi-area 50.50.50.50 + # - interface Ethernet1/2 + # - ip ospf authentication key-chain test-1 + # - ip ospf authentication + # - ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # - ip ospf cost 100 + # - ospfv3 network broadcast + # - ospfv3 shutdown + # - interface Ethernet1/3 + # - ip ospf authentication-key 7 12090404011C03162E + # + # after: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + + # After state: + # ------------ + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + + # Using replaced + + # Before state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + - name: Replace OSPF configurations of listed interfaces with provided configurations + cisco.nxos.nxos_ospf_interfaces: + config: + - name: Ethernet1/1 + address_family: + - afi: ipv4 + processes: + - process_id: "100" + area: + area_id: 1.1.1.1 + secondaries: false + multi_areas: + - 11.11.11.12 + - name: Ethernet1/3 + state: replaced + + # Task output: + # ------------ + # before: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + # + # commands: + # - interface Ethernet1/1 + # - ip router ospf multi-area 11.11.11.12 + # - no ip router ospf multi-area 11.11.11.11 + # - no ipv6 router ospfv3 multi-area 16.10.10.10 + # - no ipv6 router ospfv3 200 area 2.2.2.2 + # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 + # - interface Ethernet1/3 + # - no ip ospf authentication-key 7 12090404011C03162E + # + # after: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.12 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - name: Ethernet1/3 + # + # After state: + # ------------ + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.12 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + + + # Using overridden + + # Before state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + - name: Override all OSPF interfaces configuration with provided configuration + cisco.nxos.nxos_ospf_interfaces: + config: + - name: Ethernet1/1 + address_family: + - afi: ipv4 + processes: + - process_id: "100" + area: + area_id: 1.1.1.1 + secondaries: false + multi_areas: + - 11.11.11.12 + state: overridden + + # Task output: + # ------------ + # before: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + # + # commands: + # - interface Ethernet1/2 + # - no ip ospf authentication key-chain test-1 + # - no ip ospf authentication + # - no ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # - no ip ospf cost 100 + # - no ospfv3 network broadcast + # - no ospfv3 shutdown + # - interface Ethernet1/3 + # - no ip ospf authentication-key 7 12090404011C03162E + # - interface Ethernet1/1 + # - ip router ospf multi-area 11.11.11.12 + # - no ip router ospf multi-area 11.11.11.11 + # - no ipv6 router ospfv3 multi-area 16.10.10.10 + # - no ipv6 router ospfv3 200 area 2.2.2.2 + # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 + # + # after: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.12 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # name: Ethernet1/1 + # - name: Ethernet1/2 + # - name: Ethernet1/3 + + # After state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.12 + # interface Ethernet1/2 + # no switchport + # interface Ethernet1/3 + # no switchport + + # Using deleted to delete OSPF config of a single interface + + # Before state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + - name: Delete OSPF config from a single interface + cisco.nxos.nxos_ospf_interfaces: + config: + - name: Ethernet1/1 + state: deleted + + # Task output: + # ------------ + # before: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + # + # commands: + # - interface Ethernet1/1 + # - no ip router ospf multi-area 11.11.11.11 + # - no ip router ospf 100 area 1.1.1.1 secondaries none + # - no ipv6 router ospfv3 multi-area 16.10.10.10 + # - no ipv6 router ospfv3 200 area 2.2.2.2 + # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 + # + # after: + # - name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + + + # After state: + # ------------ + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + # Using deleted to delete OSPF config from all interfaces + + # Before state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + - name: Delete OSPF config from all interfaces + cisco.nxos.nxos_ospf_interfaces: + state: deleted + + # Task output: + # ------------ + # before: + # - name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + # + # commands: + # - interface Ethernet1/1 + # - no ip router ospf multi-area 11.11.11.11 + # - no ip router ospf 100 area 1.1.1.1 secondaries none + # - no ipv6 router ospfv3 multi-area 16.10.10.10 + # - no ipv6 router ospfv3 200 area 2.2.2.2 + # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 + # - interface Ethernet1/2 + # - no ip ospf authentication key-chain test-1 + # - no ip ospf authentication + # - no ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # - no ip ospf cost 100 + # - no ospfv3 network broadcast + # - no ospfv3 shutdown + # - interface Ethernet1/3 + # - no ip ospf authentication-key 7 12090404011C03162E + # + # after: + # - name: Ethernet1/1 + # - name: Ethernet1/2 + # - name: Ethernet1/3 + + # After state: + # ------------ + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # interface Ethernet1/2 + # no switchport + # interface Ethernet1/3 + # no switchport + + # Using rendered + + - name: >- + Render platform specific configuration lines with state rendered (without + connecting to the device) + cisco.nxos.nxos_ospf_interfaces: + config: + - name: Ethernet1/1 + address_family: + - afi: ipv4 + processes: + - process_id: '100' + area: + area_id: 1.1.1.1 + secondaries: false + multi_areas: + - 11.11.11.11 + - afi: ipv6 + processes: + - process_id: '200' + area: + area_id: 2.2.2.2 + multi_areas: + - 21.0.0.0 + - process_id: '300' + multi_areas: + - 50.50.50.50 + multi_areas: + - 16.10.10.10 + - name: Ethernet1/2 + address_family: + - afi: ipv4 + authentication: + enable: true + key_chain: test-1 + message_digest_key: + key_id: 10 + encryption: 3 + key: abc01d272be25d29 + cost: 100 + - afi: ipv6 + network: broadcast + shutdown: true + - name: Ethernet1/3 + address_family: + - afi: ipv4 + authentication_key: + encryption: 7 + key: 12090404011C03162E + state: rendered + + + # Task Output: + # ------------ + # rendered: + # - interface Ethernet1/1 + # - ip router ospf multi-area 11.11.11.11 + # - ip router ospf 100 area 1.1.1.1 secondaries none + # - ipv6 router ospfv3 multi-area 16.10.10.10 + # - ipv6 router ospfv3 200 area 2.2.2.2 + # - ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - ipv6 router ospfv3 300 multi-area 50.50.50.50 + # - interface Ethernet1/2 + # - ip ospf authentication key-chain test-1 + # - ip ospf authentication + # - ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # - ip ospf cost 100 + # - ospfv3 network broadcast + # - ospfv3 shutdown + # - interface Ethernet1/3 + # - ip ospf authentication-key 7 12090404011C03162E + + # Using parsed + + # parsed.cfg + # ------------ + # interface Ethernet1/1 + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # interface Ethernet1/2 + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # ip ospf authentication-key 7 12090404011C03162E + + - name: arse externally provided OSPF interfaces config + cisco.nxos.nxos_ospf_interfaces: + running_config: "{{ lookup('file', 'ospf_interfaces.cfg') }}" + state: parsed + + # Task output: + # ------------ + # parsed: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + + # Using gathered + + # On-box config + + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.12 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + + # Task output: + # ------------ + # gathered: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.12 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - name: Ethernet1/3 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/1', 'ip router ospf multi-area 11.11.11.11', 'ip router ospf 100 area 1.1.1.1 secondaries none', 'no ipv6 router ospfv3 multi-area 16.10.10.10', 'ipv6 router ospfv3 200 area 2.2.2.2', 'ipv6 router ospfv3 200 multi-area 21.0.0.0', 'ipv6 router ospfv3 300 multi-area 50.50.50.50', 'interface Ethernet1/2', 'no ip ospf authentication key-chain test-1', 'ip ospf authentication']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['interface Ethernet1/1', 'ip router ospf multi-area 11.11.11.11', 'ip router ospf 100 area 1.1.1.1 secondaries none']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_ospfv2_module.rst b/docs/cisco.nxos.nxos_ospfv2_module.rst new file mode 100644 index 000000000..2115d34f2 --- /dev/null +++ b/docs/cisco.nxos.nxos_ospfv2_module.rst @@ -0,0 +1,5458 @@ +.. _cisco.nxos.nxos_ospfv2_module: + + +********************** +cisco.nxos.nxos_ospfv2 +********************** + +**OSPFv2 resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages OSPFv2 configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A list of OSPF process configuration.
+
+
+ processes + +
+ list + / elements=dictionary +
+ 		+ +
A list of OSPF instances' configurations.
+
+
+ areas + +
+ list + / elements=dictionary +
+ 		+ +
Configure properties of OSPF Areas.
+
+
+ area_id + +
+ string + / required +
+ 		+ +
The Area ID in IP Address format.
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Authentication settings for the Area.
+
+
+ message_digest + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use message-digest authentication.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set authentication for the area.
+
+
+ default_cost + +
+ integer +
+ 		+ +
Specify the default cost for default summary LSA.
+
+
+ filter_list + +
+ list + / elements=dictionary +
+ 		+ +
Filter prefixes between OSPF areas.
+
+
+ direction + +
+ string + / required +
+ 		+
    Choices: +
  • in
    • +
  • out
    • +
+ 		+
The direction to apply the route map.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
The Route-map name.
+
+
+ nssa + +
+ dictionary +
+ 		+ +
NSSA settings for the area.
+
+
+ default_information_originate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Originate Type-7 default LSA into NSSA area.
+
+
+ no_redistribution + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send redistributed LSAs into NSSA area.
+
+
+ no_summary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send summary LSAs into NSSA area.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure area as NSSA.
+
+
+ translate + +
+ dictionary +
+ 		+ +
Translate LSA.
+
+
+ type7 + +
+ dictionary +
+ 		+ +
Translate from Type 7 to Type 5.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always translate LSAs
+
+
+ never + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Never translate LSAs
+
+
+ supress_fa + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress forwarding address in translated LSAs.
+
+
+ ranges + +
+ list + / elements=dictionary +
+ 		+ +
Configure an address range for the area.
+
+
+ cost + +
+ integer +
+ 		+ +
Cost to use for the range.
+
+
+ not_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress advertising the specified range.
+
+
+ prefix + +
+ string + / required +
+ 		+ +
IP in Prefix format (x.x.x.x/len)
+
+
+ stub + +
+ dictionary +
+ 		+ +
Settings for configuring the area as a stub.
+
+
+ no_summary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Prevent ABR from sending summary LSAs into stub area.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure the area as a stub.
+
+
+ auto_cost + +
+ dictionary +
+ 		+ +
Calculate OSPF cost according to bandwidth.
+
+
+ reference_bandwidth + +
+ integer + / required +
+ 		+ +
Reference bandwidth used to assign OSPF cost.
+
+
+ unit + +
+ string + / required +
+ 		+
    Choices: +
  • Gbps
    • +
  • Mbps
    • +
+ 		+
Specify in which unit the reference bandwidth is specified.
+
+
+ bfd + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable BFD on all OSPF interfaces.
+
+
+ default_information + +
+ dictionary +
+ 		+ +
Control distribution of default routes.
+
+
+ originate + +
+ dictionary +
+ 		+ +
Distribute a default route.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always advertise a default route.
+
+
+ route_map + +
+ string +
+ 		+ +
Policy to control distribution of default routes
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable distribution of default route.
+
+
+ default_metric + +
+ integer +
+ 		+ +
Specify default metric for redistributed routes.
+
+
+ distance + +
+ integer +
+ 		+ +
Configure the OSPF administrative distance.
+
+
+ flush_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Flush routes on a non-graceful controlled restart.
+
+
+ graceful_restart + +
+ dictionary +
+ 		+ +
Configure graceful restart.
+
+
+ grace_period + +
+ integer +
+ 		+ +
Configure maximum interval to restart gracefully.
+
+
+ helper_disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable helper mode.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable graceful-restart.
+
+
+ isolate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Isolate this router from OSPF perspective.
+
+
+ log_adjacency_changes + +
+ dictionary +
+ 		+ +
Log changes in adjacency state.
+
+
+ detail + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Notify all state changes.
+
+
+ log + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable logging changes in adjacency state.
+
+
+ max_lsa + +
+ dictionary +
+ 		+ +
Feature to limit the number of non-self-originated LSAs.
+
+
+ ignore_count + +
+ integer +
+ 		+ +
Set count on how many times adjacencies can be suppressed.
+
+
+ ignore_time + +
+ integer +
+ 		+ +
Set time during which all adjacencies are suppressed.
+
+
+ max_non_self_generated_lsa + +
+ integer + / required +
+ 		+ +
Set the maximum number of non self-generated LSAs.
+
+
+ reset_time + +
+ integer +
+ 		+ +
Set number of minutes after which ignore-count is reset to zero.
+
+
+ threshold + +
+ integer +
+ 		+ +
Threshold value (%) at which to generate a warning message.
+
+
+ warning_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log a warning message when limit is exceeded.
+
+
+ max_metric + +
+ dictionary +
+ 		+ +
Maximize the cost metric.
+
+
+ router_lsa + +
+ dictionary +
+ 		+ +
Router LSA configuration.
+
+
+ external_lsa + +
+ dictionary +
+ 		+ +
External LSA configuration.
+
+
+ max_metric_value + +
+ integer +
+ 		+ +
Set max metric value for external LSAs.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set external-lsa attribute.
+
+
+ include_stub + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise Max metric for Stub links as well.
+
+
+ on_startup + +
+ dictionary +
+ 		+ +
Effective only at startup.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set on-startup attribute.
+
+
+ wait_for_bgp_asn + +
+ integer +
+ 		+ +
ASN of BGP to wait for.
+
+
+ wait_period + +
+ integer +
+ 		+ +
Wait period in seconds after startup.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set router-lsa attribute.
+
+
+ summary_lsa + +
+ dictionary +
+ 		+ +
Summary LSAs configuration.
+
+
+ max_metric_value + +
+ integer +
+ 		+ +
Max metric value for summary LSAs.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set summary-lsa attribute.
+
+
+ maximum_paths + +
+ integer +
+ 		+ +
Maximum paths per destination.
+
+
+ mpls + +
+ dictionary +
+ 		+ +
OSPF MPLS configuration settings.
+
+
+ traffic_eng + +
+ dictionary +
+ 		+ +
OSPF MPLS Traffic Engineering commands.
+
+
+ areas + +
+ list + / elements=dictionary +
+ 		+ +
List of Area IDs.
+
+
+ area_id + +
+ string +
+ 		+ +
Area Id in ip address format.
+
+
+ multicast_intact + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
MPLS TE multicast support.
+
+
+ router_id + +
+ string +
+ 		+ +
Router ID associated with TE.
+
+
+ name_lookup + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Display OSPF router ids as DNS names.
+
+
+ passive_interface + +
+ dictionary +
+ 		+ +
Suppress routing updates on the interface.
+
+
+ default + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Interfaces passive by default.
+
+
+ process_id + +
+ string + / required +
+ 		+ +
The OSPF process tag.
+
+
+ redistribute + +
+ list + / elements=dictionary +
+ 		+ +
Redistribute information from another routing protocol.
+
+
+ id + +
+ string +
+ 		+ +
The identifier for the protocol specified.
+
+
+ protocol + +
+ string + / required +
+ 		+
    Choices: +
  • bgp
    • +
  • direct
    • +
  • eigrp
    • +
  • isis
    • +
  • lisp
    • +
  • ospf
    • +
  • rip
    • +
  • static
    • +
+ 		+
The name of the protocol.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
The route map policy to constrain redistribution.
+
+
+ rfc1583compatibility + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure 1583 compatibility for external path preferences.
+
+
+ router_id + +
+ string +
+ 		+ +
Set OSPF process router-id.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Shutdown the OSPF protocol instance.
+
+
+ summary_address + +
+ list + / elements=dictionary +
+ 		+ +
Configure route summarization for redistribution.
+
+
+ not_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress advertising the specified summary.
+
+
+ prefix + +
+ string + / required +
+ 		+ +
IP prefix in format x.x.x.x/ml.
+
+
+ tag + +
+ integer +
+ 		+ +
A 32-bit tag value.
+
+
+ table_map + +
+ dictionary +
+ 		+ +
Policy for filtering/modifying OSPF routes before sending them to RIB.
+
+
+ filter + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Block the OSPF routes from being sent to RIB.
+
+
+ name + +
+ string + / required +
+ 		+ +
The Route Map name.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure timer related constants.
+
+
+ lsa_arrival + +
+ integer +
+ 		+ +
Mimimum interval between arrival of a LSA.
+
+
+ lsa_group_pacing + +
+ integer +
+ 		+ +
LSA group refresh/maxage interval.
+
+
+ throttle + +
+ dictionary +
+ 		+ +
Configure throttle related constants.
+
+
+ lsa + +
+ dictionary +
+ 		+ +
Set rate-limiting for LSA generation.
+
+
+ hold_interval + +
+ integer +
+ 		+ +
The hold interval.
+
+
+ max_interval + +
+ integer +
+ 		+ +
The max interval.
+
+
+ start_interval + +
+ integer +
+ 		+ +
The start interval.
+
+
+ spf + +
+ dictionary +
+ 		+ +
Set OSPF SPF timers.
+
+
+ initial_spf_delay + +
+ integer +
+ 		+ +
Initial SPF schedule delay in milliseconds.
+
+
+ max_wait_time + +
+ integer +
+ 		+ +
Maximum wait time between SPF calculations.
+
+
+ min_hold_time + +
+ integer +
+ 		+ +
Minimum hold time between SPF calculations.
+
+
+ vrfs + +
+ list + / elements=dictionary +
+ 		+ +
Configure VRF specific OSPF settings.
+
+
+ areas + +
+ list + / elements=dictionary +
+ 		+ +
Configure properties of OSPF Areas.
+
+
+ area_id + +
+ string + / required +
+ 		+ +
The Area ID in IP Address format.
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Authentication settings for the Area.
+
+
+ message_digest + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use message-digest authentication.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set authentication for the area.
+
+
+ default_cost + +
+ integer +
+ 		+ +
Specify the default cost for default summary LSA.
+
+
+ filter_list + +
+ list + / elements=dictionary +
+ 		+ +
Filter prefixes between OSPF areas.
+
+
+ direction + +
+ string + / required +
+ 		+
    Choices: +
  • in
    • +
  • out
    • +
+ 		+
The direction to apply the route map.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
The Route-map name.
+
+
+ nssa + +
+ dictionary +
+ 		+ +
NSSA settings for the area.
+
+
+ default_information_originate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Originate Type-7 default LSA into NSSA area.
+
+
+ no_redistribution + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send redistributed LSAs into NSSA area.
+
+
+ no_summary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send summary LSAs into NSSA area.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure area as NSSA.
+
+
+ translate + +
+ dictionary +
+ 		+ +
Translate LSA.
+
+
+ type7 + +
+ dictionary +
+ 		+ +
Translate from Type 7 to Type 5.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always translate LSAs
+
+
+ never + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Never translate LSAs
+
+
+ supress_fa + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress forwarding address in translated LSAs.
+
+
+ ranges + +
+ list + / elements=dictionary +
+ 		+ +
Configure an address range for the area.
+
+
+ cost + +
+ integer +
+ 		+ +
Cost to use for the range.
+
+
+ not_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress advertising the specified range.
+
+
+ prefix + +
+ string + / required +
+ 		+ +
IP in Prefix format (x.x.x.x/len)
+
+
+ stub + +
+ dictionary +
+ 		+ +
Settings for configuring the area as a stub.
+
+
+ no_summary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Prevent ABR from sending summary LSAs into stub area.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure the area as a stub.
+
+
+ auto_cost + +
+ dictionary +
+ 		+ +
Calculate OSPF cost according to bandwidth.
+
+
+ reference_bandwidth + +
+ integer + / required +
+ 		+ +
Reference bandwidth used to assign OSPF cost.
+
+
+ unit + +
+ string + / required +
+ 		+
    Choices: +
  • Gbps
    • +
  • Mbps
    • +
+ 		+
Specify in which unit the reference bandwidth is specified.
+
+
+ bfd + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable BFD on all OSPF interfaces.
+
+
+ capability + +
+ dictionary +
+ 		+ +
OSPF capability settings.
+
+
+ vrf_lite + +
+ dictionary +
+ 		+ +
Enable VRF-lite capability settings.
+
+
+ evpn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ethernet VPN.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable VRF-lite support.
+
+
+ default_information + +
+ dictionary +
+ 		+ +
Control distribution of default routes.
+
+
+ originate + +
+ dictionary +
+ 		+ +
Distribute a default route.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always advertise a default route.
+
+
+ route_map + +
+ string +
+ 		+ +
Policy to control distribution of default routes
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable distribution of default route.
+
+
+ default_metric + +
+ integer +
+ 		+ +
Specify default metric for redistributed routes.
+
+
+ distance + +
+ integer +
+ 		+ +
Configure the OSPF administrative distance.
+
+
+ down_bit_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure a PE router to ignore the DN bit for network summary, external and NSSA external LSA.
+
+
+ graceful_restart + +
+ dictionary +
+ 		+ +
Configure graceful restart.
+
+
+ grace_period + +
+ integer +
+ 		+ +
Configure maximum interval to restart gracefully.
+
+
+ helper_disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable helper mode.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable graceful-restart.
+
+
+ log_adjacency_changes + +
+ dictionary +
+ 		+ +
Log changes in adjacency state.
+
+
+ detail + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Notify all state changes.
+
+
+ log + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable logging changes in adjacency state.
+
+
+ max_lsa + +
+ dictionary +
+ 		+ +
Feature to limit the number of non-self-originated LSAs.
+
+
+ ignore_count + +
+ integer +
+ 		+ +
Set count on how many times adjacencies can be suppressed.
+
+
+ ignore_time + +
+ integer +
+ 		+ +
Set time during which all adjacencies are suppressed.
+
+
+ max_non_self_generated_lsa + +
+ integer + / required +
+ 		+ +
Set the maximum number of non self-generated LSAs.
+
+
+ reset_time + +
+ integer +
+ 		+ +
Set number of minutes after which ignore-count is reset to zero.
+
+
+ threshold + +
+ integer +
+ 		+ +
Threshold value (%) at which to generate a warning message.
+
+
+ warning_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log a warning message when limit is exceeded.
+
+
+ max_metric + +
+ dictionary +
+ 		+ +
Maximize the cost metric.
+
+
+ router_lsa + +
+ dictionary +
+ 		+ +
Router LSA configuration.
+
+
+ external_lsa + +
+ dictionary +
+ 		+ +
External LSA configuration.
+
+
+ max_metric_value + +
+ integer +
+ 		+ +
Set max metric value for external LSAs.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set external-lsa attribute.
+
+
+ include_stub + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise Max metric for Stub links as well.
+
+
+ on_startup + +
+ dictionary +
+ 		+ +
Effective only at startup.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set on-startup attribute.
+
+
+ wait_for_bgp_asn + +
+ integer +
+ 		+ +
ASN of BGP to wait for.
+
+
+ wait_period + +
+ integer +
+ 		+ +
Wait period in seconds after startup.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set router-lsa attribute.
+
+
+ summary_lsa + +
+ dictionary +
+ 		+ +
Summary LSAs configuration.
+
+
+ max_metric_value + +
+ integer +
+ 		+ +
Max metric value for summary LSAs.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set summary-lsa attribute.
+
+
+ maximum_paths + +
+ integer +
+ 		+ +
Maximum paths per destination.
+
+
+ name_lookup + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Display OSPF router ids as DNS names.
+
+
+ passive_interface + +
+ dictionary +
+ 		+ +
Suppress routing updates on the interface.
+
+
+ default + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Interfaces passive by default.
+
+
+ redistribute + +
+ list + / elements=dictionary +
+ 		+ +
Redistribute information from another routing protocol.
+
+
+ id + +
+ string +
+ 		+ +
The identifier for the protocol specified.
+
+
+ protocol + +
+ string + / required +
+ 		+
    Choices: +
  • bgp
    • +
  • direct
    • +
  • eigrp
    • +
  • isis
    • +
  • lisp
    • +
  • ospf
    • +
  • rip
    • +
  • static
    • +
+ 		+
The name of the protocol.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
The route map policy to constrain redistribution.
+
+
+ rfc1583compatibility + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure 1583 compatibility for external path preferences.
+
+
+ router_id + +
+ string +
+ 		+ +
Set OSPF process router-id.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Shutdown the OSPF protocol instance.
+
+
+ summary_address + +
+ list + / elements=dictionary +
+ 		+ +
Configure route summarization for redistribution.
+
+
+ not_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress advertising the specified summary.
+
+
+ prefix + +
+ string + / required +
+ 		+ +
IP prefix in format x.x.x.x/ml.
+
+
+ tag + +
+ integer +
+ 		+ +
A 32-bit tag value.
+
+
+ table_map + +
+ dictionary +
+ 		+ +
Policy for filtering/modifying OSPF routes before sending them to RIB.
+
+
+ filter + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Block the OSPF routes from being sent to RIB.
+
+
+ name + +
+ string + / required +
+ 		+ +
The Route Map name.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure timer related constants.
+
+
+ lsa_arrival + +
+ integer +
+ 		+ +
Mimimum interval between arrival of a LSA.
+
+
+ lsa_group_pacing + +
+ integer +
+ 		+ +
LSA group refresh/maxage interval.
+
+
+ throttle + +
+ dictionary +
+ 		+ +
Configure throttle related constants.
+
+
+ lsa + +
+ dictionary +
+ 		+ +
Set rate-limiting for LSA generation.
+
+
+ hold_interval + +
+ integer +
+ 		+ +
The hold interval.
+
+
+ max_interval + +
+ integer +
+ 		+ +
The max interval.
+
+
+ start_interval + +
+ integer +
+ 		+ +
The start interval.
+
+
+ spf + +
+ dictionary +
+ 		+ +
Set OSPF SPF timers.
+
+
+ initial_spf_delay + +
+ integer +
+ 		+ +
Initial SPF schedule delay in milliseconds.
+
+
+ max_wait_time + +
+ integer +
+ 		+ +
Maximum wait time between SPF calculations.
+
+
+ min_hold_time + +
+ integer +
+ 		+ +
Minimum hold time between SPF calculations.
+
+
+ vrf + +
+ string + / required +
+ 		+ +
Name/Identifier of the VRF.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section "^router ospf .*".
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • parsed
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 7.0(3)I5(1). + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # nxos-9k-rdo# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_ospfv2: + config: + processes: + - process_id: 100 + router_id: 203.0.113.20 + - process_id: 102 + router_id: 198.51.100.1 + areas: + - area_id: 0.0.0.100 + filter_list: + - route_map: rmap_1 + direction: in + - route_map: rmap_2 + direction: out + ranges: + - prefix: 198.51.100.64/27 + not_advertise: true + - prefix: 198.51.100.96/27 + cost: 120 + - area_id: 0.0.0.101 + authentication: + message_digest: true + redistribute: + - protocol: eigrp + id: 120 + route_map: rmap_1 + - protocol: direct + route_map: ospf102-direct-connect + vrfs: + - vrf: zone1 + router_id: 198.51.100.129 + redistribute: + - protocol: static + route_map: zone1-static-connect + summary_address: + - prefix: 198.51.100.128/27 + tag: 121 + - prefix: 198.51.100.160/27 + areas: + - area_id: 0.0.0.102 + nssa: + default_information_originate: true + no_summary: true + - area_id: 0.0.0.103 + nssa: + no_summary: true + translate: + type7: + always: true + - vrf: zone2 + auto_cost: + reference_bandwidth: 45 + unit: Gbps + state: merged + + # Task output: + # ------------ + # before: {} + # + # commands: + # - router ospf 102 + # - router-id 198.51.100.1 + # - redistribute eigrp 120 route-map rmap_1 + # - redistribute direct route-map ospf102-direct-connect + # - area 0.0.0.100 filter-list route-map rmap_1 in + # - area 0.0.0.100 filter-list route-map rmap_2 out + # - area 0.0.0.100 range 198.51.100.64/27 not-advertise + # - area 0.0.0.100 range 198.51.100.96/27 cost 120 + # - area 0.0.0.101 authentication message-digest + # - vrf zone1 + # - router-id 198.51.100.129 + # - summary-address 198.51.100.128/27 tag 121 + # - summary-address 198.51.100.160/27 + # - redistribute static route-map zone1-static-connect + # - area 0.0.0.102 nssa no-summary default-information-originate + # - area 0.0.0.103 nssa no-summary + # - area 0.0.0.103 nssa translate type7 always + # - vrf zone2 + # - auto-cost reference-bandwidth 45 Gbps + # - router ospf 100 + # - router-id 203.0.113.20 + # + # after: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.100 + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # - cost: 120 + # prefix: 198.51.100.96/27 + # - area_id: 0.0.0.101 + # authentication: + # message_digest: true + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # - area_id: 0.0.0.103 + # nssa: + # no_summary: true + # translate: + # type7: + # always: true + # redistribute: + # - protocol: static + # route_map: zone1-static-connect + # router_id: 198.51.100.129 + # vrf: zone1 + # - auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # vrf: zone2 + # + + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # area 0.0.0.100 range 198.51.100.96/27 cost 120 + # area 0.0.0.101 authentication message-digest + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # area 0.0.0.103 nssa no-summary + # area 0.0.0.103 nssa translate type7 always + # redistribute static route-map zone1-static-connect + # summary-address 198.51.100.128/27 tag 121 + # summary-address 198.51.100.160/27 + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + + # Using replaced + + # Before state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # area 0.0.0.100 range 198.51.100.96/27 cost 120 + # area 0.0.0.101 authentication message-digest + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # area 0.0.0.103 nssa no-summary + # area 0.0.0.103 nssa translate type7 always + # redistribute static route-map zone1-static-connect + # summary-address 198.51.100.128/27 tag 121 + # summary-address 198.51.100.160/27 + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + + - name: >- + Replace device configurations of listed OSPF processes with provided + configurations + cisco.nxos.nxos_ospfv2: + config: + processes: + - process_id: 102 + router_id: 198.51.100.1 + areas: + - area_id: 0.0.0.100 + filter_list: + - route_map: rmap_8 + direction: in + ranges: + - prefix: 198.51.100.64/27 + not_advertise: true + - area_id: 0.0.0.101 + stub: + no_summary: true + redistribute: + - protocol: eigrp + id: 130 + route_map: rmap_1 + - protocol: direct + route_map: ospf102-direct-connect + vrfs: + - vrf: zone1 + router_id: 198.51.100.129 + redistribute: + - protocol: bgp + id: 65563 + route_map: zone1-bgp-connect + areas: + - area_id: 0.0.0.102 + nssa: + default_information_originate: true + no_summary: true + state: replaced + + + # Task output: + # ------------ + # before: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.100 + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # - cost: 120 + # prefix: 198.51.100.96/27 + # - area_id: 0.0.0.101 + # authentication: + # message_digest: true + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # - area_id: 0.0.0.103 + # nssa: + # no_summary: true + # translate: + # type7: + # always: true + # redistribute: + # - protocol: static + # route_map: zone1-static-connect + # router_id: 198.51.100.129 + # vrf: zone1 + # - auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # vrf: zone2 + # + # commands: + # - router ospf 102 + # - redistribute eigrp 130 route-map rmap_1 + # - no redistribute eigrp 120 route-map rmap_1 + # - area 0.0.0.100 filter-list route-map rmap_8 in + # - no area 0.0.0.100 filter-list route-map rmap_2 out + # - no area 0.0.0.100 range 198.51.100.96/27 + # - no area 0.0.0.101 authentication + # - area 0.0.0.101 stub no-summary + # - vrf zone1 + # - no summary-address 198.51.100.128/27 tag 121 + # - no summary-address 198.51.100.160/27 + # - redistribute bgp 65563 route-map zone1-bgp-connect + # - no redistribute static route-map zone1-static-connect + # - no area 0.0.0.103 nssa + # - no area 0.0.0.103 nssa translate type7 always + # - no vrf zone2 + # + # after: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.101 + # stub: + # no_summary: true + # - area_id: 0.0.0.100 + # filter_list: + # - direction: in + # route_map: rmap_8 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "130" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # redistribute: + # - id: "65563" + # protocol: bgp + # route_map: zone1-bgp-connect + # router_id: 198.51.100.129 + # vrf: zone1 + + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # area 0.0.0.101 stub no-summary + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 130 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_8 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # redistribute bgp 65563 route-map zone1-bgp-connect + + # Using overridden + + # Before state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # area 0.0.0.100 range 198.51.100.96/27 cost 120 + # area 0.0.0.101 authentication message-digest + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # area 0.0.0.103 nssa no-summary + # area 0.0.0.103 nssa translate type7 always + # redistribute static route-map zone1-static-connect + # summary-address 198.51.100.128/27 tag 121 + # summary-address 198.51.100.160/27 + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + + - name: Override all OSPF configuration with provided configuration + cisco.nxos.nxos_ospfv2: + config: + processes: + - process_id: 104 + router_id: 203.0.113.20 + - process_id: 102 + router_id: 198.51.100.1 + shutdown: true + state: overridden + + # Task output: + # ------------ + # before: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.100 + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # - cost: 120 + # prefix: 198.51.100.96/27 + # - area_id: 0.0.0.101 + # authentication: + # message_digest: true + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # - area_id: 0.0.0.103 + # nssa: + # no_summary: true + # translate: + # type7: + # always: true + # redistribute: + # - protocol: static + # route_map: zone1-static-connect + # router_id: 198.51.100.129 + # vrf: zone1 + # - auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # vrf: zone2 + # + # commands: + # - no router ospf 100 + # - router ospf 104 + # - router-id 203.0.113.20 + # - router ospf 102 + # - shutdown + # - no redistribute direct route-map ospf102-direct-connect + # - no redistribute eigrp 120 route-map rmap_1 + # - no area 0.0.0.100 filter-list route-map rmap_2 out + # - no area 0.0.0.100 filter-list route-map rmap_1 in + # - no area 0.0.0.100 range 198.51.100.64/27 + # - no area 0.0.0.100 range 198.51.100.96/27 + # - no area 0.0.0.101 authentication + # - no vrf zone1 + # - no vrf zone2 + # + # after: + # processes: + # - process_id: "102" + # router_id: 198.51.100.1 + # shutdown: true + # - process_id: "104" + # router_id: 203.0.113.20 + + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 102 + # router-id 198.51.100.1 + # shutdown + # router ospf 104 + # router-id 203.0.113.20 + + # Using deleted to delete a single OSPF process + + # Before state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # area 0.0.0.100 range 198.51.100.96/27 cost 120 + # area 0.0.0.101 authentication message-digest + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # area 0.0.0.103 nssa no-summary + # area 0.0.0.103 nssa translate type7 always + # redistribute static route-map zone1-static-connect + # summary-address 198.51.100.128/27 tag 121 + # summary-address 198.51.100.160/27 + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + + - name: Delete a single OSPF process + cisco.nxos.nxos_ospfv2: + config: + processes: + - process_id: 102 + state: deleted + + # Task output: + # ------------ + # before: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.100 + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # - cost: 120 + # prefix: 198.51.100.96/27 + # - area_id: 0.0.0.101 + # authentication: + # message_digest: true + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # - area_id: 0.0.0.103 + # nssa: + # no_summary: true + # translate: + # type7: + # always: true + # redistribute: + # - protocol: static + # route_map: zone1-static-connect + # router_id: 198.51.100.129 + # vrf: zone1 + # - auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # vrf: zone2 + # + # commands: + # - no router ospf 102 + # + # after: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + + # Using deleted all OSPF processes from the device + + # Before state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # area 0.0.0.100 range 198.51.100.96/27 cost 120 + # area 0.0.0.101 authentication message-digest + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # area 0.0.0.103 nssa no-summary + # area 0.0.0.103 nssa translate type7 always + # redistribute static route-map zone1-static-connect + # summary-address 198.51.100.128/27 tag 121 + # summary-address 198.51.100.160/27 + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + + - name: Delete all OSPF processes from the device + cisco.nxos.nxos_ospfv2: + state: deleted + + # Task output: + # ------------ + # before: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.100 + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # - cost: 120 + # prefix: 198.51.100.96/27 + # - area_id: 0.0.0.101 + # authentication: + # message_digest: true + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # - area_id: 0.0.0.103 + # nssa: + # no_summary: true + # translate: + # type7: + # always: true + # redistribute: + # - protocol: static + # route_map: zone1-static-connect + # router_id: 198.51.100.129 + # vrf: zone1 + # - auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # vrf: zone2 + # + # commands: + # - no router ospf 100 + # - no router ospf 102 + # + # after: {} + + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # nxos-9k-rdo# + + # Using rendered + + - name: >- + Render platform specific configuration lines (without connecting to the + device) + cisco.nxos.nxos_ospfv2: + config: + processes: + - process_id: 100 + router_id: 203.0.113.20 + - process_id: 102 + router_id: 198.51.100.1 + areas: + - area_id: 0.0.0.100 + filter_list: + - route_map: rmap_1 + direction: in + - route_map: rmap_2 + direction: out + ranges: + - prefix: 198.51.100.64/27 + not_advertise: true + - prefix: 198.51.100.96/27 + cost: 120 + - area_id: 0.0.0.101 + authentication: + message_digest: true + redistribute: + - protocol: eigrp + id: 120 + route_map: rmap_1 + - protocol: direct + route_map: ospf102-direct-connect + vrfs: + - vrf: zone1 + router_id: 198.51.100.129 + redistribute: + - protocol: static + route_map: zone1-static-connect + summary_address: + - prefix: 198.51.100.128/27 + tag: 121 + - prefix: 198.51.100.160/27 + areas: + - area_id: 0.0.0.102 + nssa: + default_information_originate: true + no_summary: true + - area_id: 0.0.0.103 + nssa: + no_summary: true + translate: + type7: + always: true + - vrf: zone2 + auto_cost: + reference_bandwidth: 45 + unit: Gbps + state: rendered + + + # Task output: + # ------------ + # rendered: + # - router ospf 100 + # - router-id 203.0.113.20 + # - router ospf 102 + # - router-id 198.51.100.1 + # - redistribute eigrp 120 route-map rmap_1 + # - redistribute direct route-map ospf102-direct-connect + # - area 0.0.0.100 filter-list route-map rmap_1 in + # - area 0.0.0.100 filter-list route-map rmap_2 out + # - area 0.0.0.100 range 198.51.100.64/27 not-advertise + # - area 0.0.0.100 range 198.51.100.96/27 cost 120 + # - area 0.0.0.101 authentication message-digest + # - vrf zone1 + # - router-id 198.51.100.129 + # - summary-address 198.51.100.128/27 tag 121 + # - summary-address 198.51.100.160/27 + # - redistribute static route-map zone1-static-connect + # - area 0.0.0.102 nssa no-summary default-information-originate + # - area 0.0.0.103 nssa no-summary + # - area 0.0.0.103 nssa translate type7 always + # - vrf zone2 + # - auto-cost reference-bandwidth 45 Gbps + + # Using parsed + + # parsed.cfg + # ------------ + # router ospf 100 + # router-id 192.0.100.1 + # area 0.0.0.101 nssa no-summary no-redistribution + # area 0.0.0.102 stub no-summary + # redistribute direct route-map ospf-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 192.0.2.0/24 not-advertise + # area 0.0.0.100 range 192.0.3.0/24 cost 120 + # area 0.0.0.100 authentication message-digest + # vrf zone1 + # router-id 192.0.100.2 + # area 0.0.100.1 nssa no-summary no-redistribution + # redistribute static route-map zone1-direct-connect + # summary-address 10.0.0.0/24 tag 120 + # summary-address 11.0.0.0/24 not-advertise + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + # down-bit-ignore + # capability vrf-lite evpn + # shutdown + # router ospf 102 + # router-id 198.54.100.1 + # shutdown + # vrf zone2 + # summary-address 192.0.8.0/24 tag 120 + # vrf zone4 + # shutdown + + - name: Parse externally provided OSPFv2 config + cisco.nxos.nxos_ospfv2: + running_config: "{{ lookup('file', 'ospfv2.cfg') }}" + state: parsed + + # Task output: + # ------------ + # parsed: + # processes: + # - process_id: "100" + # areas: + # - area_id: 0.0.0.101 + # nssa: + # no_redistribution: true + # no_summary: true + # - area_id: 0.0.0.102 + # stub: + # no_summary: true + # - area_id: 0.0.0.100 + # authentication: + # message_digest: true + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 192.0.2.0/24 + # - cost: 120 + # prefix: 192.0.3.0/24 + # redistribute: + # - protocol: direct + # route_map: ospf-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 192.0.100.1 + # vrfs: + # - vrf: zone1 + # areas: + # - area_id: 0.0.100.1 + # nssa: + # no_redistribution: true + # no_summary: true + # redistribute: + # - protocol: static + # route_map: zone1-direct-connect + # router_id: 192.0.100.2 + # summary_address: + # - prefix: 10.0.0.0/24 + # tag: 120 + # - not_advertise: true + # prefix: 11.0.0.0/24 + # - vrf: zone2 + # auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # capability: + # vrf_lite: + # evpn: true + # down_bit_ignore: true + # shutdown: true + # - process_id: "102" + # router_id: 198.54.100.1 + # shutdown: true + # vrfs: + # - vrf: zone2 + # summary_address: + # - prefix: 192.0.8.0/24 + # tag: 120 + # - vrf: zone4 + # shutdown: true + + # Using gathered + + - name: Gather OSPFv2 facts using gathered + cisco.nxos.nxos_ospfv2: + state: gathered + + # Task output: + # ------------ + # gathered: + # processes: + # - process_id: "102" + # areas: + # - area_id: 0.0.0.101 + # stub: + # no_summary: true + # - area_id: 0.0.0.100 + # filter_list: + # - direction: in + # route_map: rmap_8 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "130" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - vrf: zone1 + # areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # redistribute: + # - id: "65563" + # protocol: bgp + # route_map: zone1-bgp-connect + # router_id: 198.51.100.129 + # + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['router ospf 102', 'router-id 198.54.100.1', 'router ospf 100', 'router-id 192.0.100.1', 'redistribute eigrp 120 route-map rmap_1', 'redistribute direct route-map ospf-direct-connect', 'area 0.0.0.100 filter-list route-map rmap_1 in', 'area 0.0.0.100 filter-list route-map rmap_2 out', 'area 0.0.0.100 range 192.0.2.0/24 not-advertise', 'area 0.0.0.100 range 192.0.3.0/24 cost 120', 'vrf zone1', 'router-id 192.0.100.2', 'summary-address 10.0.0.0/24 tag 121', 'summary-address 11.0.0.0/24', 'redistribute static route-map zone1-direct-connect', 'vrf zone2', 'auto-cost reference-bandwidth 45 Gbps', 'capability vrf-lite evpn']
+
+
+ gathered + +
+ dictionary +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ dictionary +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['router ospf 102', 'router-id 198.54.100.1', 'router ospf 100']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_overlay_global_module.rst b/docs/cisco.nxos.nxos_overlay_global_module.rst new file mode 100644 index 000000000..1a1b8d975 --- /dev/null +++ b/docs/cisco.nxos.nxos_overlay_global_module.rst @@ -0,0 +1,120 @@ +.. _cisco.nxos.nxos_overlay_global_module: + + +****************************** +cisco.nxos.nxos_overlay_global +****************************** + +**Configures anycast gateway MAC of the switch.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Configures anycast gateway MAC of the switch. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ anycast_gateway_mac + +
+ string + / required +
+ 		+ +
Anycast gateway mac of the switch.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Default restores params default value + - Supported MAC address format are "E.E.E", "EE-EE-EE-EE-EE-EE", "EE:EE:EE:EE:EE:EE" and "EEEE.EEEE.EEEE" + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_overlay_global: + anycast_gateway_mac: b.b.b + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['fabric forwarding anycast-gateway-mac 000B.000B.000B']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_pim_module.rst b/docs/cisco.nxos.nxos_pim_module.rst new file mode 100644 index 000000000..e19eee567 --- /dev/null +++ b/docs/cisco.nxos.nxos_pim_module.rst @@ -0,0 +1,148 @@ +.. _cisco.nxos.nxos_pim_module: + + +******************* +cisco.nxos.nxos_pim +******************* + +**Manages configuration of a PIM instance.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages configuration of a Protocol Independent Multicast (PIM) instance. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ bfd + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enables BFD on all PIM interfaces.
+
Dependency: ''feature bfd''
+
+
+ ssm_range + +
+ list + / elements=string +
+ 		+ Default:
[]
+ 		+
Configure group ranges for Source Specific Multicast (SSM). Valid values are multicast addresses or the keyword none or keyword default. none removes all SSM group ranges. 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 default, otherwise use the default option.
+
+
+ + +Notes +----- + +.. note:: + - Unsupported for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - 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 Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['ip pim bfd', 'ip pim ssm range 224.0.0.0/8']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_ping_module.rst b/docs/cisco.nxos.nxos_ping_module.rst new file mode 100644 index 000000000..d0d805868 --- /dev/null +++ b/docs/cisco.nxos.nxos_ping_module.rst @@ -0,0 +1,311 @@ +.. _cisco.nxos.nxos_ping_module: + + +******************** +cisco.nxos.nxos_ping +******************** + +**Tests reachability using ping from Nexus switch.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Tests reachability using ping from switch to a remote destination. +- For a general purpose network module, see the :ref:`ansible.netcommon.net_ping ` module. +- For Windows targets, use the :ref:`ansible.windows.win_ping ` module instead. +- For targets running Python, use the :ref:`ansible.builtin.ping ` module instead. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ count + +
+ integer +
+ 		+ Default:
5
+ 		+
Number of packets to send.
+
+
+ dest + +
+ string + / required +
+ 		+ +
IP address or hostname (resolvable by switch) of remote node.
+
+
+ df_bit + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Set the DF bit.
+
+
+ size + +
+ integer +
+ 		+ +
Size of packets to send.
+
+
+ source + +
+ string +
+ 		+ +
Source IP Address or hostname (resolvable by switch)
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • absent
    • +
  • present ←
    • +
+ 		+
Determines if the expected result is success or fail.
+
+
+ vrf + +
+ string +
+ 		+ +
Outgoing VRF.
+
+
+ + +Notes +----- + +.. note:: + - Unsupported for Cisco MDS + - For a general purpose network module, see the :ref:`ansible.netcommon.net_ping ` module. + - For Windows targets, use the :ref:`ansible.windows.win_ping ` module instead. + - For targets running Python, use the :ref:`ansible.builtin.ping ` module instead. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Test reachability to 8.8.8.8 using mgmt vrf + cisco.nxos.nxos_ping: + dest: 8.8.8.8 + vrf: management + host: 68.170.147.165 + + - name: Test reachability to a few different public IPs using mgmt vrf + cisco.nxos.nxos_ping: + dest: "{{ item }}" + vrf: management + host: 68.170.147.165 + with_items: + - 8.8.8.8 + - 4.4.4.4 + - 198.6.1.4 + + - name: Test reachability to 8.8.8.8 using mgmt vrf, size and df-bit + cisco.nxos.nxos_ping: + dest: 8.8.8.8 + df_bit: true + size: 1400 + vrf: management + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
Show the command sent
+
+
Sample:
+
['ping 8.8.8.8 count 2 vrf management']
+
+
+ packet_loss + +
+ string +
+ 		always +
Percentage of packets lost
+
+
Sample:
+
0.00%
+
+
+ packets_rx + +
+ integer +
+ 		always +
Packets successfully received
+
+
Sample:
+
2
+
+
+ packets_tx + +
+ integer +
+ 		always +
Packets successfully transmitted
+
+
Sample:
+
2
+
+
+ rtt + +
+ dictionary +
+ 		always +
Show RTT stats
+
+
Sample:
+
{'avg': 6.264, 'max': 6.564, 'min': 5.978}
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_prefix_lists_module.rst b/docs/cisco.nxos.nxos_prefix_lists_module.rst new file mode 100644 index 000000000..25f343132 --- /dev/null +++ b/docs/cisco.nxos.nxos_prefix_lists_module.rst @@ -0,0 +1,1049 @@ +.. _cisco.nxos.nxos_prefix_lists_module: + + +**************************** +cisco.nxos.nxos_prefix_lists +**************************** + +**Prefix-Lists resource module.** + + +Version added: 2.4.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages prefix-lists configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of prefix-list configuration.
+
+
+ afi + +
+ string +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
The Address Family Identifier (AFI) for the prefix-lists.
+
+
+ prefix_lists + +
+ list + / elements=dictionary +
+ 		+ +
List of prefix-list configurations.
+
+
+ description + +
+ string +
+ 		+ +
Description of the prefix list
+
+
+ entries + +
+ list + / elements=dictionary +
+ 		+ +
List of configurations for the specified prefix-list
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • permit
    • +
  • deny
    • +
+ 		+
Prefix-List permit or deny.
+
+
+ eq + +
+ integer +
+ 		+ +
Exact prefix length to be matched.
+
+
+ ge + +
+ integer +
+ 		+ +
Minimum prefix length to be matched.
+
+
+ le + +
+ integer +
+ 		+ +
Maximum prefix length to be matched.
+
+
+ mask + +
+ string +
+ 		+ +
Explicit match mask.
+
+
+ prefix + +
+ string +
+ 		+ +
IP or IPv6 prefix in A.B.C.D/LEN or A:B::C:D/LEN format.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence Number.
+
+
+ name + +
+ string +
+ 		+ +
Name of the prefix-list.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^ip(.* prefix-list').
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
Refer to examples for more details.
+
With state replaced, for the listed prefix-lists, sequences that are in running-config but not in the task are negated.
+
With state overridden, all prefix-lists that are in running-config but not in the task are negated.
+
Please refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # nxos-9k-rdo# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_prefix_lists: + config: + - afi: ipv4 + prefix_lists: + - name: AllowPrefix + description: allows engineering IPv4 networks + entries: + - sequence: 10 + action: permit + prefix: 192.0.2.0/23 + eq: 24 + - sequence: 20 + action: permit + prefix: 198.51.100.128/26 + - name: DenyPrefix + description: denies lab IPv4 networks + entries: + - sequence: 20 + action: deny + prefix: 203.0.113.0/24 + le: 25 + + - afi: ipv6 + prefix_lists: + - name: AllowIPv6Prefix + description: allows engineering IPv6 networks + entries: + - sequence: 8 + action: permit + prefix: "2001:db8:400::/38" + - sequence: 20 + action: permit + prefix: "2001:db8:8000::/35" + le: 37 + + # Task output + # ------------- + # before: [] + # + # commands: + # - "ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks" + # - "ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38" + # - "ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37" + # - "ip prefix-list AllowPrefix description allows engineering IPv4 networks" + # - "ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" + # - "ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" + # - "ip prefix-list DenyPrefix description denies lab IPv4 networks" + # - "ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25" + # + # after: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + # Using replaced + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Replace prefix-lists configurations of listed prefix-lists with provided configurations + cisco.nxos.nxos_prefix_lists: + config: + - afi: ipv4 + prefix_lists: + - name: AllowPrefix + description: allows engineering IPv4 networks + entries: + - sequence: 10 + action: permit + prefix: 203.0.113.64/27 + + - sequence: 30 + action: permit + prefix: 203.0.113.96/27 + - name: AllowPrefix2Stub + description: allow other engineering IPv4 network + state: replaced + + # Task output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # commands: + # - "no ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" + # - "ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27" + # - "ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27" + # - "no ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" + # - "ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network" + # + # after: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 203.0.113.64/27 + # - sequence: 30 + # action: permit + # prefix: 203.0.113.96/27 + # name: AllowPrefix + # - description: allow other engineering IPv4 network + # name: AllowPrefix2Stub + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27 + # ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27 + # ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + # Using overridden + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Override all prefix-lists configuration with provided configuration + cisco.nxos.nxos_prefix_lists: &id003 + config: + - afi: ipv4 + prefix_lists: + - name: AllowPrefix + description: allows engineering IPv4 networks + entries: + - sequence: 10 + action: permit + prefix: 203.0.113.64/27 + + - sequence: 30 + action: permit + prefix: 203.0.113.96/27 + - name: AllowPrefix2Stub + description: allow other engineering IPv4 network + state: overridden + + # Task output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # commands: + # - "no ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" + # - "ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27" + # - "ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27" + # - "no ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" + # - "ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network" + # - "no ip prefix-list DenyPrefix" + # - "no ipv6 prefix-list AllowIPv6Prefix" + # + # after: + # - afi: ipv4 + # prefix_lists: + # - name: AllowPrefix + # description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 203.0.113.64/27 + # + # - sequence: 30 + # action: permit + # prefix: 203.0.113.96/27 + # - name: AllowPrefix2Stub + # description: allow other engineering IPv4 network + # + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27 + # ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27 + # ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network + + # Using deleted to delete a all prefix lists for an AFI + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Delete all prefix-lists for an AFI + cisco.nxos.nxos_prefix_lists: + config: + - afi: ipv4 + state: deleted + register: result + + # Task output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # commands: + # - "no ip prefix-list AllowPrefix" + # - "no ip prefix-list DenyPrefix" + # + # after: + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + # Using deleted to delete a single prefix-list + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Delete a single prefix-list + cisco.nxos.nxos_prefix_lists: + config: + - afi: ipv4 + prefix_lists: + - name: AllowPrefix + state: deleted + + # Task output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # commands: + # - "no ip prefix-list AllowPrefix" + # + # after: + # - afi: ipv4 + # prefix_lists: + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + # Using deleted to delete all prefix-lists from the device + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Delete all prefix-lists + cisco.nxos.nxos_prefix_lists: + state: deleted + + # Task output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # commands: + # - "no ip prefix-list AllowPrefix" + # - "no ip prefix-list DenyPrefix" + # - "no ipv6 prefix-list AllowIPv6Prefix" + # + # after: [] + # + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # nxos-9k-rdo# + + # Using rendered + + - name: Render platform specific configuration lines with state rendered (without connecting to the device) + cisco.nxos.nxos_prefix_lists: &id001 + config: + - afi: ipv4 + prefix_lists: + - name: AllowPrefix + description: allows engineering IPv4 networks + entries: + - sequence: 10 + action: permit + prefix: 192.0.2.0/23 + eq: 24 + - sequence: 20 + action: permit + prefix: 198.51.100.128/26 + - name: DenyPrefix + description: denies lab IPv4 networks + entries: + - sequence: 20 + action: deny + prefix: 203.0.113.0/24 + le: 25 + + - afi: ipv6 + prefix_lists: + - name: AllowIPv6Prefix + description: allows engineering IPv6 networks + entries: + - sequence: 8 + action: permit + prefix: "2001:db8:400::/38" + - sequence: 20 + action: permit + prefix: "2001:db8:8000::/35" + le: 37 + state: rendered + + # Task Output (redacted) + # ----------------------- + # rendered: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + + # Using parsed + + # parsed.cfg + # ------------ + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Parse externally provided prefix-lists configuration + register: result + cisco.nxos.nxos_prefix_lists: + running_config: "{{ lookup('file', './parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + + + + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_reboot_module.rst b/docs/cisco.nxos.nxos_reboot_module.rst new file mode 100644 index 000000000..cc94a6762 --- /dev/null +++ b/docs/cisco.nxos.nxos_reboot_module.rst @@ -0,0 +1,123 @@ +.. _cisco.nxos.nxos_reboot_module: + + +********************** +cisco.nxos.nxos_reboot +********************** + +**Reboot a network device.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Reboot a network device. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ confirm + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Safeguard boolean. Set to true if you're sure you want to reboot.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Tested against Cisco MDS NX-OS 9.2(1) + - The module will fail due to timeout issues, but the reboot will be performed anyway. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_reboot: + confirm: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ rebooted + +
+ boolean +
+ 		success +
Whether the device was instructed to reboot.
+
+
Sample:
+
True
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_rollback_module.rst b/docs/cisco.nxos.nxos_rollback_module.rst new file mode 100644 index 000000000..c948e093a --- /dev/null +++ b/docs/cisco.nxos.nxos_rollback_module.rst @@ -0,0 +1,159 @@ +.. _cisco.nxos.nxos_rollback_module: + + +************************ +cisco.nxos.nxos_rollback +************************ + +**Set a checkpoint or rollback to a checkpoint.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module offers the ability to set a configuration checkpoint file or rollback to a configuration checkpoint file on Cisco NXOS switches. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ checkpoint_file + +
+ string +
+ 		+ +
Name of checkpoint file to create. Mutually exclusive with rollback_to.
+
+
+ rollback_to + +
+ string +
+ 		+ +
Name of checkpoint file to rollback to. Mutually exclusive with checkpoint_file.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Sometimes ``transport=nxapi`` may cause a timeout error. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_rollback: + checkpoint_file: backup.cfg + username: '{{ un }}' + password: '{{ pwd }}' + host: '{{ inventory_hostname }}' + - cisco.nxos.nxos_rollback: + rollback_to: backup.cfg + username: '{{ un }}' + password: '{{ pwd }}' + host: '{{ inventory_hostname }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ filename + +
+ string +
+ 		success +
The filename of the checkpoint/rollback file.
+
+
Sample:
+
backup.cfg
+
+
+ status + +
+ string +
+ 		success +
Which operation took place and whether it was successful.
+
+
Sample:
+
rollback executed
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_route_maps_module.rst b/docs/cisco.nxos.nxos_route_maps_module.rst new file mode 100644 index 000000000..bcdf6a426 --- /dev/null +++ b/docs/cisco.nxos.nxos_route_maps_module.rst @@ -0,0 +1,4368 @@ +.. _cisco.nxos.nxos_route_maps_module: + + +************************** +cisco.nxos.nxos_route_maps +************************** + +**Route Maps resource module.** + + +Version added: 2.2.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages route maps configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of route-map configuration.
+
+
+ entries + +
+ list + / elements=dictionary +
+ 		+ +
List of entries (identified by sequence number) for this route-map.
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • deny
    • +
  • permit
    • +
+ 		+
Route map denies or permits set operations.
+
+
+ continue_sequence + +
+ integer +
+ 		+ +
Continue on a different entry within the route-map.
+
+
+ description + +
+ string +
+ 		+ +
Description of the route-map.
+
+
+ match + +
+ dictionary +
+ 		+ +
Match values from routing table.
+
+
+ as_number + +
+ dictionary +
+ 		+ +
Match BGP peer AS number.
+
+
+ as_path_list + +
+ list + / elements=string +
+ 		+ +
AS path access list name.
+
+
+ asn + +
+ list + / elements=string +
+ 		+ +
AS number.
+
+
+ as_path + +
+ list + / elements=string +
+ 		+ +
Match BGP AS path access-list.
+
+
+ community + +
+ dictionary +
+ 		+ +
Match BGP community list.
+
+
+ community_list + +
+ list + / elements=string +
+ 		+ +
Community list.
+
+
+ exact_match + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do exact matching of communities.
+
+
+ evpn + +
+ dictionary +
+ 		+ +
Match BGP EVPN Routes.
+
+
+ route_types + +
+ list + / elements=string +
+ 		+ +
Match route type for evpn route.
+
+
+ extcommunity + +
+ dictionary +
+ 		+ +
Match BGP community list.
+
+
+ exact_match + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do exact matching of extended communities.
+
+
+ extcommunity_list + +
+ list + / elements=string +
+ 		+ +
Extended Community list.
+
+
+ interfaces + +
+ list + / elements=string +
+ 		+ +
Match first hop interface of route.
+
+
+ ip + +
+ dictionary +
+ 		+ +
Configure IP specific information.
+
+
+ address + +
+ dictionary +
+ 		+ +
Match address of route or match packet.
+
+
+ access_list + +
+ string +
+ 		+ +
IP access-list name (for use in route-maps for PBR only).
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ multicast + +
+ dictionary +
+ 		+ +
Match multicast attributes.
+
+
+ group + +
+ dictionary +
+ 		+ +
Multicast Group prefix.
+
Mutually exclusive with group_range.
+
+
+ prefix + +
+ string +
+ 		+ +
IPv4 group prefix.
+
+
+ group_range + +
+ dictionary +
+ 		+ +
Multicast Group address range.
+
Mutually exclusive with group.
+
+
+ first + +
+ string +
+ 		+ +
First Group address.
+
+
+ last + +
+ string +
+ 		+ +
Last Group address.
+
+
+ rp + +
+ dictionary +
+ 		+ +
Rendezvous point.
+
+
+ prefix + +
+ string +
+ 		+ +
IPv4 rendezvous prefix.
+
+
+ rp_type + +
+ string +
+ 		+
    Choices: +
  • ASM
    • +
  • Bidir
    • +
+ 		+
Multicast rendezvous point type.
+
+
+ source + +
+ string +
+ 		+ +
Multicast source address.
+
+
+ next_hop + +
+ dictionary +
+ 		+ +
Match next-hop address of route.
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ route_source + +
+ dictionary +
+ 		+ +
Match advertising source address of route.
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ ipv6 + +
+ dictionary +
+ 		+ +
Configure IPv6 specific information.
+
+
+ address + +
+ dictionary +
+ 		+ +
Match address of route or match packet.
+
+
+ access_list + +
+ string +
+ 		+ +
IP access-list name (for use in route-maps for PBR only).
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ multicast + +
+ dictionary +
+ 		+ +
Match multicast attributes.
+
+
+ group + +
+ dictionary +
+ 		+ +
Multicast Group prefix.
+
Mutually exclusive with group_range.
+
+
+ prefix + +
+ string +
+ 		+ +
IPv4 group prefix.
+
+
+ group_range + +
+ dictionary +
+ 		+ +
Multicast Group address range.
+
Mutually exclusive with group.
+
+
+ first + +
+ string +
+ 		+ +
First Group address.
+
+
+ last + +
+ string +
+ 		+ +
Last Group address.
+
+
+ rp + +
+ dictionary +
+ 		+ +
Rendezvous point.
+
+
+ prefix + +
+ string +
+ 		+ +
IPv4 rendezvous prefix.
+
+
+ rp_type + +
+ string +
+ 		+
    Choices: +
  • ASM
    • +
  • Bidir
    • +
+ 		+
Multicast rendezvous point type.
+
+
+ source + +
+ string +
+ 		+ +
Multicast source address.
+
+
+ next_hop + +
+ dictionary +
+ 		+ +
Match next-hop address of route.
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ route_source + +
+ dictionary +
+ 		+ +
Match advertising source address of route.
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ mac_list + +
+ list + / elements=string +
+ 		+ +
Match entries of mac-lists.
+
+
+ metric + +
+ list + / elements=integer +
+ 		+ +
Match metric of route.
+
+
+ ospf_area + +
+ list + / elements=integer +
+ 		+ +
Match ospf area.
+
+
+ route_types + +
+ list + / elements=string +
+ 		+
    Choices: +
  • external
    • +
  • inter-area
    • +
  • internal
    • +
  • intra-area
    • +
  • level-1
    • +
  • level-2
    • +
  • local
    • +
  • nssa-external
    • +
  • type-1
    • +
  • type-2
    • +
+ 		+
Match route-type of route.
+
+
+ source_protocol + +
+ list + / elements=string +
+ 		+ +
Match source protocol.
+
+
+ tags + +
+ list + / elements=integer +
+ 		+ +
Match tag of route.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence to insert to/delete from existing route-map entry.
+
+
+ set + +
+ dictionary +
+ 		+ +
Set values in destination routing protocol.
+
+
+ as_path + +
+ dictionary +
+ 		+ +
Prepend string for a BGP AS-path attribute.
+
+
+ prepend + +
+ dictionary +
+ 		+ +
Prepend to the AS-Path.
+
+
+ as_number + +
+ list + / elements=string +
+ 		+ +
AS number.
+
+
+ last_as + +
+ integer +
+ 		+ +
Number of last-AS prepends.
+
+
+ tag + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set the tag as an AS-path attribute.
+
+
+ comm_list + +
+ string +
+ 		+ +
Set BGP community list (for deletion).
+
+
+ community + +
+ dictionary +
+ 		+ +
Set BGP community attribute.
+
+
+ additive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Add to existing community.
+
+
+ graceful_shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Graceful Shutdown (well-known community).
+
+
+ internet + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Internet (well-known community).
+
+
+ local_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send outside local AS (well-known community).
+
+
+ no_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not advertise to any peer (well-known community).
+
+
+ no_export + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not export to next AS (well-known community).
+
+
+ number + +
+ list + / elements=string +
+ 		+ +
Community number aa:nn format
+
+
+ dampening + +
+ dictionary +
+ 		+ +
Set BGP route flap dampening parameters.
+
+
+ half_life + +
+ integer +
+ 		+ +
Half-life time for the penalty.
+
+
+ max_suppress_time + +
+ integer +
+ 		+ +
Maximum suppress time for stable route.
+
+
+ start_reuse_route + +
+ integer +
+ 		+ +
Value to start reusing a route.
+
+
+ start_suppress_route + +
+ integer +
+ 		+ +
Value to start suppressing a route.
+
+
+ distance + +
+ dictionary +
+ 		+ +
Configure administrative distance.
+
+
+ igp_ebgp_routes + +
+ integer +
+ 		+ +
Administrative distance for IGP or EBGP routes
+
+
+ internal_routes + +
+ integer +
+ 		+ +
Distance for internal routes.
+
+
+ local_routes + +
+ integer +
+ 		+ +
Distance for local routes.
+
+
+ evpn + +
+ dictionary +
+ 		+ +
Set BGP EVPN Routes.
+
+
+ gateway_ip + +
+ dictionary +
+ 		+ +
Set gateway IP for type 5 EVPN routes.
+
Cannot set ip and use-nexthop in the same route-map sequence.
+
+
+ ip + +
+ string +
+ 		+ +
Gateway IP address.
+
+
+ use_nexthop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use nexthop address as gateway IP.
+
+
+ extcomm_list + +
+ string +
+ 		+ +
Set BGP extcommunity list (for deletion).
+
+
+ extcommunity + +
+ dictionary +
+ 		+ +
Set BGP extcommunity attribute.
+
+
+ rt + +
+ dictionary +
+ 		+ +
Route-Target.
+
+
+ additive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Add to existing rt extcommunity.
+
+
+ extcommunity_numbers + +
+ list + / elements=string +
+ 		+ +
Extcommunity number.
+
Supported formats are ASN2:NN, ASN4:NN, IPV4:NN.
+
+
+ forwarding_address + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set the forwarding address.
+
+
+ ip + +
+ dictionary +
+ 		+ +
Configure IP features.
+
+
+ address + +
+ dictionary +
+ 		+ +
Specify IP address.
+
+
+ prefix_list + +
+ string +
+ 		+ +
Name of prefix list (Max Size 63).
+
+
+ next_hop + +
+ dictionary +
+ 		+ +
Set next-hop IP address (for policy-based routing)
+
+
+ address + +
+ string +
+ 		+ +
Set space-separated list of next-hop IP addresses. Address ordering is important. Also don`t use unnecessary spaces.
+
+
+ drop_on_fail + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Drop packets instead of using default routing when the configured next hop becomes unreachable
+
+
+ force_order + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Enable next-hop ordering as specified in the address parameter.
+
+
+ load_share + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Enable traffic load balancing across a maximum of 32 next-hop addresses
+
+
+ peer_address + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
BGP prefix next hop is set to the local address of the peer.
+
If no next hop is set in the route map, the next hop is set to the one stored in the path.
+
+
+ redist_unchanged + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set for next-hop address conservation for non-local generated routes.
+
Used with redistribute command. Available to maintain BGP routing compliant with RFC 4271 on Nexus OS.
+
+
+ unchanged + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set for next-hop address conservation in eBGP outgoing updates
+
+
+ verify_availability + +
+ list + / elements=dictionary +
+ 		+ +
Set next-hop ip address tracking with IP SLA
+
+
+ address + +
+ string + / required +
+ 		+ +
Set one next-hop address
+
+
+ drop_on_fail + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Drop packets instead of using default routing when the configured next hop becomes unreachable
+
+
+ force_order + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Enable next-hop ordering as specified in the address parameter.
+
+
+ load_share + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Enable traffic load balancing across a maximum of 32 next-hop addresses
+
+
+ track + +
+ integer + / required +
+ 		+ +
Set track number
+
+
+ precedence + +
+ string +
+ 		+ +
Set precedence field.
+
+
+ ipv6 + +
+ dictionary +
+ 		+ +
Configure IPv6 features.
+
+
+ address + +
+ dictionary +
+ 		+ +
Specify IP address.
+
+
+ prefix_list + +
+ string +
+ 		+ +
Name of prefix list (Max Size 63).
+
+
+ precedence + +
+ string +
+ 		+ +
Set precedence field.
+
+
+ label_index + +
+ integer +
+ 		+ +
Set Segment Routing (SR) label index of route.
+
+
+ level + +
+ string +
+ 		+
    Choices: +
  • level-1
    • +
  • level-1-2
    • +
  • level-2
    • +
+ 		+
Where to import route.
+
+
+ local_preference + +
+ integer +
+ 		+ +
BGP local preference path attribute.
+
+
+ metric + +
+ dictionary +
+ 		+ +
Set metric for destination routing protocol.
+
+
+ bandwidth + +
+ integer +
+ 		+ +
Metric value or Bandwidth in Kbits per second (Max Size 11).
+
+
+ igrp_delay_metric + +
+ integer +
+ 		+ +
IGRP delay metric.
+
+
+ igrp_effective_bandwidth_metric + +
+ integer +
+ 		+ +
IGRP Effective bandwidth metric (Loading) 255 is 100%.
+
+
+ igrp_mtu + +
+ integer +
+ 		+ +
IGRP MTU of the path.
+
+
+ igrp_reliability_metric + +
+ integer +
+ 		+ +
IGRP reliability metric where 255 is 100 percent reliable.
+
+
+ metric_type + +
+ string +
+ 		+
    Choices: +
  • external
    • +
  • internal
    • +
  • type-1
    • +
  • type-2
    • +
+ 		+
Type of metric for destination routing protocol.
+
+
+ nssa_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
OSPF NSSA Areas.
+
+
+ null_interface + +
+ string +
+ 		+ +
Output Null interface.
+
+
+ origin + +
+ string +
+ 		+
    Choices: +
  • egp
    • +
  • igp
    • +
  • incomplete
    • +
+ 		+
BGP origin code.
+
+
+ path_selection + +
+ string +
+ 		+
    Choices: +
  • all
    • +
  • backup
    • +
  • best2
    • +
  • multipaths
    • +
+ 		+
Path selection criteria for BGP.
+
+
+ tag + +
+ integer +
+ 		+ +
Tag value for destination routing protocol.
+
+
+ weight + +
+ integer +
+ 		+ +
BGP weight for routing table.
+
+
+ route_map + +
+ string +
+ 		+ +
Route-map name.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^route-map'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
With state replaced, for the listed route-maps, sequences that are in running-config but not in the task are negated.
+
With state overridden, all route-maps that are in running-config but not in the task are negated.
+
Please refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k-rdo# show running-config | section "^route-map" + # nxos-9k-rdo# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_route_maps: + config: + - route_map: rmap1 + entries: + - sequence: 10 + action: permit + description: rmap1-10-permit + match: + ip: + address: + access_list: acl_1 + as_path: Allow40 + as_number: + asn: 65564 + + - sequence: 20 + action: deny + description: rmap1-20-deny + match: + community: + community_list: + - BGPCommunity1 + - BGPCommunity2 + ip: + address: + prefix_lists: + - AllowPrefix1 + - AllowPrefix2 + set: + dampening: + half_life: 30 + start_reuse_route: 1500 + start_suppress_route: 10000 + max_suppress_time: 120 + + - route_map: rmap2 + entries: + - sequence: 20 + action: permit + description: rmap2-20-permit + continue_sequence: 40 + match: + ipv6: + address: + prefix_lists: AllowIPv6Prefix + interfaces: "{{ nxos_int1 }}" + set: + as_path: + prepend: + as_number: + - 65563 + - 65568 + - 65569 + comm_list: BGPCommunity + + - sequence: 40 + action: deny + description: rmap2-40-deny + match: + route_types: + - level-1 + - level-2 + tags: 2 + ip: + multicast: + rp: + prefix: 192.0.2.0/24 + rp_type: ASM + source: 203.0.113.0/24 + group_range: + first: 239.0.0.1 + last: 239.255.255.255 + + - route_map: rmap3 + entries: + - sequence: 10 + description: "*** first stanza ***" + action: permit + set: + ip: + next_hop: + verify_availability: + - address: 3.3.3.3 + track: 1 + - address: 4.4.4.4 + track: 3 + + - sequence: 20 + description: "*** second stanza ***" + action: permit + set: + ip: + next_hop: + address: 6.6.6.6 2.2.2.2 + load_share: true + drop_on_fail: true + + - sequence: 30 + description: "*** third stanza ***" + action: permit + set: + ip: + next_hop: + peer_address: true + + - sequence: 40 + description: "*** fourth stanza ***" + action: permit + set: + ip: + next_hop: + unchanged: true + redist_unchanged: true + state: merged + + # Task output + # ------------- + # before: [] + # + # commands: + # - "route-map rmap1 permit 10" + # - "match as-number 65564" + # - "match as-path Allow40" + # - "match ip address acl_1" + # - "description rmap1-10-permit" + # - "route-map rmap1 deny 20" + # - "match community BGPCommunity1 BGPCommunity2" + # - "match ip address prefix-list AllowPrefix1 AllowPrefix2" + # - "description rmap1-20-deny" + # - "set dampening 30 1500 10000 120" + # - "route-map rmap2 permit 20" + # - "match interface Ethernet1/1" + # - "match ipv6 address prefix-list AllowIPv6Prefix" + # - "set as-path prepend 65563 65568 65569" + # - "description rmap2-20-permit" + # - "continue 40" + # - "set comm-list BGPCommunity delete" + # - "route-map rmap2 deny 40" + # - "match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM" + # - "match route-type level-1 level-2" + # - "match tag 2" + # - "description rmap2-40-deny" + # - "route-map rmap3 permit 10" + # - "description *** first stanza ***" + # - "set ip next-hop verify-availability 3.3.3.3 track 1" + # - "set ip next-hop verify-availability 4.4.4.4 track 3" + # - "route-map rmap3 permit 20" + # - "description *** second stanza ***" + # - "set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail" + # - "route-map rmap3 permit 30" + # - "description *** third stanza ***" + # - "set ip next-hop peer-address" + # - "route-map rmap3 permit 40" + # - "description *** fourth stanza ***" + # - "set ip next-hop unchanged" + # - "set ip next-hop redist-unchanged" + # + # after: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # - route_map: rmap3 + # entries: + # - sequence: 10 + # description: "*** first stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # verify_availability: + # - address: 3.3.3.3 + # track: 1 + # - address: 4.4.4.4 + # track: 3 + # + # - sequence: 20 + # description: "*** second stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # address: 6.6.6.6 2.2.2.2 + # load_share: true + # drop_on_fail: true + # + # - sequence: 30 + # description: "*** third stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # peer_address: true + # + # - sequence: 40 + # description: "*** fourth stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # unchanged: true + # redist_unchanged: true + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + # route-map rmap3 permit 10 + # description *** first stanza *** + # set ip next-hop verify-availability 3.3.3.3 track 1 + # set ip next-hop verify-availability 4.4.4.4 track 3 + # route-map rmap3 permit 20 + # description *** second stanza *** + # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail + # route-map rmap3 permit 30 + # description *** third stanza *** + # set ip next-hop peer-address + # route-map rmap3 permit 40 + # description *** fourth stanza *** + # set ip next-hop unchanged + # set ip next-hop redist-unchanged + # + # Using replaced + # (for the listed route-map(s), sequences that are in running-config but not in the task are negated) + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + # route-map rmap3 permit 10 + # description *** first stanza *** + # set ip next-hop verify-availability 3.3.3.3 track 1 + # set ip next-hop verify-availability 4.4.4.4 track 3 + # route-map rmap3 permit 20 + # description *** second stanza *** + # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail + # route-map rmap3 permit 30 + # description *** third stanza *** + # set ip next-hop peer-address + # route-map rmap3 permit 40 + # description *** fourth stanza *** + # set ip next-hop unchanged + # set ip next-hop redist-unchanged + # + - name: Replace route-maps configurations of listed route-maps with provided configurations + cisco.nxos.nxos_route_maps: + config: + - route_map: rmap1 + entries: + - sequence: 20 + action: deny + description: rmap1-20-deny + match: + community: + community_list: + - BGPCommunity4 + - BGPCommunity5 + ip: + address: + prefix_lists: + - AllowPrefix1 + set: + community: + local_as: true + + - route_map: rmap3 + entries: + - sequence: 10 + description: "*** first stanza ***" + action: permit + set: + ip: + next_hop: + verify_availability: + - address: 3.3.3.3 + track: 1 + - sequence: 20 + description: "*** second stanza ***" + action: permit + set: + ip: + next_hop: + peer_address: true + - sequence: 30 + description: "*** third stanza ***" + action: permit + set: + ip: + next_hop: + address: 6.6.6.6 2.2.2.2 + load_share: true + drop_on_fail: true + state: replaced + + # Task output + # ------------- + # before: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # - route_map: rmap3 + # entries: + # - sequence: 10 + # description: "*** first stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # verify_availability: + # - address: 3.3.3.3 + # track: 1 + # - address: 4.4.4.4 + # track: 3 + # + # - sequence: 20 + # description: "*** second stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # address: 6.6.6.6 2.2.2.2 + # load_share: true + # drop_on_fail: true + # + # - sequence: 30 + # description: "*** third stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # peer_address: true + # + # - sequence: 40 + # description: "*** fourth stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # unchanged: true + # redist_unchanged: true + # + # commands: + # - no route-map rmap1 permit 10 + # - route-map rmap1 deny 20 + # - no match community BGPCommunity1 BGPCommunity2 + # - match community BGPCommunity4 BGPCommunity5 + # - no match ip address prefix-list AllowPrefix1 AllowPrefix2 + # - match ip address prefix-list AllowPrefix1 + # - no set dampening 30 1500 10000 120 + # - set community local-AS + # - route-map rmap3 permit 10 + # - no set ip next-hop verify-availability 4.4.4.4 track 3 + # - route-map rmap3 permit 20 + # - no set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail + # - set ip next-hop peer-address + # - route-map rmap3 permit 30 + # - no set ip next-hop peer-address + # - set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail + # - no route-map rmap3 permit 40 + # + # after: + # - route_map: rmap1 + # entries: + # - sequence: 20 + # action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity4 + # - BGPCommunity5 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # set: + # community: + # local_as: true + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # - route_map: rmap3 + # entries: + # - sequence: 10 + # description: "*** first stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # verify_availability: + # - address: 3.3.3.3 + # track: 1 + # - sequence: 20 + # description: "*** second stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # peer_address: true + # - sequence: 30 + # description: "*** third stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # address: 6.6.6.6 2.2.2.2 + # load_share: true + # drop_on_fail: true + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 deny 20 + # description rmap1-20-deny + # match community BGPCommunity4 BGPCommunity5 + # match ip address prefix-list AllowPrefix1 + # set community local-AS + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + # route-map rmap3 permit 10 + # description *** first stanza *** + # set ip next-hop verify-availability 3.3.3.3 track 1 + # route-map rmap3 permit 20 + # description *** second stanza *** + # set ip next-hop peer-address + # route-map rmap3 permit 30 + # description *** third stanza *** + # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail + + # Using overridden + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + + - name: Override all route-maps configuration with provided configuration + cisco.nxos.nxos_route_maps: + config: + - route_map: rmap1 + entries: + - sequence: 20 + action: deny + description: rmap1-20-deny + match: + community: + community_list: + - BGPCommunity4 + - BGPCommunity5 + ip: + address: + prefix_lists: + - AllowPrefix1 + set: + community: + local_as: true + state: overridden + + # Task output + # ------------- + # before: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # commands: + # - no route-map rmap1 permit 10 + # - route-map rmap1 deny 20 + # - no match community BGPCommunity1 BGPCommunity2 + # - match community BGPCommunity4 BGPCommunity5 + # - no match ip address prefix-list AllowPrefix1 AllowPrefix2 + # - match ip address prefix-list AllowPrefix1 + # - no set dampening 30 1500 10000 120 + # - set community local-AS + # - no route-map rmap2 permit 20 + # - no route-map rmap2 deny 40 + # + # after: + # - route_map: rmap1 + # entries: + # - sequence: 20 + # action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity4 + # - BGPCommunity5 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # set: + # community: + # local_as: true + # + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^route-map" + # route-map rmap1 deny 20 + # description rmap1-20-deny + # match community BGPCommunity4 BGPCommunity5 + # match ip address prefix-list AllowPrefix1 + # set community local-AS + + # Using deleted to delete a single route-map + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + + - name: Delete single route-map + cisco.nxos.nxos_route_maps: + config: + - route_map: rmap1 + state: deleted + + # Task output + # ------------- + # before: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # commands: + # - no route-map rmap1 permit 10 + # - no route-map rmap1 deny 20 + # + # after: + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^route-map" + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + + # Using deleted to delete all route-maps from the device running-config + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + + - name: Delete all route-maps + cisco.nxos.nxos_route_maps: + state: deleted + + # Task output + # ------------- + # before: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # commands: + # - no route-map rmap1 permit 10 + # - no route-map rmap1 deny 20 + # - no route-map rmap2 permit 20 + # - no route-map rmap2 deny 40 + # + # after: [] + # + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^route-map" + + - name: Render platform specific configuration lines with state rendered (without connecting to the device) + cisco.nxos.nxos_route_maps: + config: + - route_map: rmap1 + entries: + - sequence: 10 + action: permit + description: rmap1-10-permit + match: + ip: + address: + access_list: acl_1 + as_path: Allow40 + as_number: + asn: 65564 + + - sequence: 20 + action: deny + description: rmap1-20-deny + match: + community: + community_list: + - BGPCommunity1 + - BGPCommunity2 + ip: + address: + prefix_lists: + - AllowPrefix1 + - AllowPrefix2 + set: + dampening: + half_life: 30 + start_reuse_route: 1500 + start_suppress_route: 10000 + max_suppress_time: 120 + + - route_map: rmap2 + entries: + - sequence: 20 + action: permit + description: rmap2-20-permit + continue_sequence: 40 + match: + ipv6: + address: + prefix_lists: AllowIPv6Prefix + interfaces: "{{ nxos_int1 }}" + set: + as_path: + prepend: + as_number: + - 65563 + - 65568 + - 65569 + comm_list: BGPCommunity + + - sequence: 40 + action: deny + description: rmap2-40-deny + match: + route_types: + - level-1 + - level-2 + tags: 2 + ip: + multicast: + rp: + prefix: 192.0.2.0/24 + rp_type: ASM + source: 203.0.113.0/24 + group_range: + first: 239.0.0.1 + last: 239.255.255.255 + state: rendered + + # Task Output (redacted) + # ----------------------- + # rendered: + # - "route-map rmap1 permit 10" + # - "match as-number 65564" + # - "match as-path Allow40" + # - "match ip address acl_1" + # - "description rmap1-10-permit" + # - "route-map rmap1 deny 20" + # - "match community BGPCommunity1 BGPCommunity2" + # - "match ip address prefix-list AllowPrefix1 AllowPrefix2" + # - "description rmap1-20-deny" + # - "set dampening 30 1500 10000 120" + # - "route-map rmap2 permit 20" + # - "match interface Ethernet1/1" + # - "match ipv6 address prefix-list AllowIPv6Prefix" + # - "set as-path prepend 65563 65568 65569" + # - "description rmap2-20-permit" + # - "continue 40" + # - "set comm-list BGPCommunity delete" + # - "route-map rmap2 deny 40" + # - "match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM" + # - "match route-type level-1 level-2" + # - "match tag 2" + # - "description rmap2-40-deny" + + # Using parsed + + # parsed.cfg + # ------------ + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + + - name: Parse externally provided route-maps configuration + cisco.nxos.nxos_route_maps: + running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + + # Using gathered + + # Existing route-map config + # --------------------------- + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + + - name: Gather route-maps facts using gathered + cisco.nxos.nxos_route_maps: + state: gathered + + # gathered: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['route-map rmap1 permit 10', 'match as-number 65564', 'match as-path Allow40', 'match ip address acl_1', 'description rmap1-10-permit', 'route-map rmap1 deny 20', 'match community BGPCommunity1 BGPCommunity2']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_rpm_module.rst b/docs/cisco.nxos.nxos_rpm_module.rst new file mode 100644 index 000000000..79d616a59 --- /dev/null +++ b/docs/cisco.nxos.nxos_rpm_module.rst @@ -0,0 +1,226 @@ +.. _cisco.nxos.nxos_rpm_module: + + +******************* +cisco.nxos.nxos_rpm +******************* + +**Install patch or feature rpms on Cisco NX-OS devices.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Install software maintenance upgrade (smu) RPMS and 3rd party RPMS on Cisco NX-OS devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ aggregate + +
+ list + / elements=dictionary +
+ 		+ +
List of RPM/patch definitions.
+
+
+ file_system + +
+ string +
+ 		+ +
The remote file system of the device. If omitted, devices that support a file_system parameter will use their default values.
+
+
+ pkg + +
+ string + / required +
+ 		+ +
Name of the RPM package.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
If the state is present, the rpm will be installed, If the state is absent, it will be removed.
+
+
+ file_system + +
+ string +
+ 		+ Default:
"bootflash"
+ 		+
The remote file system of the device. If omitted, devices that support a file_system parameter will use their default values.
+
+
+ pkg + +
+ string +
+ 		+ +
Name of the RPM package.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
If the state is present, the rpm will be installed, If the state is absent, it will be removed.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.0(3)I2(5), 7.0(3)I4(6), 7.0(3)I5(3), 7.0(3)I6(1), 7.0(3)I7(3) + - Unsupported for Cisco MDS + - For patches, the minimum platform version needed is 7.0(3)I2(5) + - For feature rpms, the minimum platform version needed is 7.0(3)I6(1) + - The module manages the entire RPM lifecycle (Add, activate, commit, deactivate, remove) + - For reload patches, this module is NOT idempotent until the patch is committed. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_rpm: + pkg: nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000.rpm + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['install add bootflash:nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000.rpm forced', 'install activate nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000 forced', 'install commit nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Sai Chintalapudi (@saichint) diff --git a/docs/cisco.nxos.nxos_snapshot_module.rst b/docs/cisco.nxos.nxos_snapshot_module.rst new file mode 100644 index 000000000..fe89b5b7b --- /dev/null +++ b/docs/cisco.nxos.nxos_snapshot_module.rst @@ -0,0 +1,363 @@ +.. _cisco.nxos.nxos_snapshot_module: + + +************************ +cisco.nxos.nxos_snapshot +************************ + +**Manage snapshots of the running states of selected features.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Create snapshots of the running states of selected features, add new show commands for snapshot creation, delete and compare existing snapshots. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ action + +
+ string + / required +
+ 		+
    Choices: +
  • add
    • +
  • compare
    • +
  • create
    • +
  • delete
    • +
  • delete_all
    • +
+ 		+
Define what snapshot action the module would perform.
+
+
+ compare_option + +
+ string +
+ 		+
    Choices: +
  • summary
    • +
  • ipv4routes
    • +
  • ipv6routes
    • +
+ 		+
Snapshot options to be used when action=compare.
+
+
+ comparison_results_file + +
+ string +
+ 		+ +
Name of the file where snapshots comparison will be stored when action=compare.
+
+
+ description + +
+ string +
+ 		+ +
Snapshot description to be used when action=create.
+
+
+ element_key1 + +
+ string +
+ 		+ +
Specify the tags used to distinguish among row entries, to be used when action=add.
+
+
+ element_key2 + +
+ string +
+ 		+ +
Specify the tags used to distinguish among row entries, to be used when action=add.
+
+
+ path + +
+ string +
+ 		+ Default:
"./"
+ 		+
Specify the path of the file where new created snapshot or snapshots comparison will be stored, to be used when action=create and save_snapshot_locally=true or action=compare.
+
+
+ row_id + +
+ string +
+ 		+ +
Specifies the tag of each row entry of the show command's XML output, to be used when action=add.
+
+
+ save_snapshot_locally + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Specify to locally store a new created snapshot, to be used when action=create.
+
+
+ section + +
+ string +
+ 		+ +
Used to name the show command output, to be used when action=add.
+
+
+ show_command + +
+ string +
+ 		+ +
Specify a new show command, to be used when action=add.
+
+
+ snapshot1 + +
+ string +
+ 		+ +
First snapshot to be used when action=compare.
+
+
+ snapshot2 + +
+ string +
+ 		+ +
Second snapshot to be used when action=compare.
+
+
+ snapshot_name + +
+ string +
+ 		+ +
Snapshot name, to be used when action=create or action=delete.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - ``transport=cli`` may cause timeout errors. + - The ``element_key1`` and ``element_key2`` parameter specify the tags used to distinguish among row entries. In most cases, only the element_key1 parameter needs to specified to be able to distinguish among row entries. + - ``action=compare`` will always store a comparison report on a local file. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Create a snapshot and store it locally + - cisco.nxos.nxos_snapshot: + action: create + snapshot_name: test_snapshot + description: Done with Ansible + save_snapshot_locally: true + path: /home/user/snapshots/ + + # Delete a snapshot + - cisco.nxos.nxos_snapshot: + action: delete + snapshot_name: test_snapshot + + # Delete all existing snapshots + - cisco.nxos.nxos_snapshot: + action: delete_all + + # Add a show command for snapshots creation + - cisco.nxos.nxos_snapshot: + section: myshow + show_command: show ip interface brief + row_id: ROW_intf + element_key1: intf-name + + # Compare two snapshots + - cisco.nxos.nxos_snapshot: + action: compare + snapshot1: pre_snapshot + snapshot2: post_snapshot + comparison_results_file: compare_snapshots.txt + compare_option: summary + path: ../snapshot_reports/ + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		verbose mode +
commands sent to the device
+
+
Sample:
+
['snapshot create post_snapshot Post-snapshot']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_community_module.rst b/docs/cisco.nxos.nxos_snmp_community_module.rst new file mode 100644 index 000000000..584d2d772 --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_community_module.rst @@ -0,0 +1,201 @@ +.. _cisco.nxos.nxos_snmp_community_module: + + +****************************** +cisco.nxos.nxos_snmp_community +****************************** + +**(deprecated, removed after 2024-01-01) Manages SNMP community configs.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated modules released with more functionality +:Alternative: nxos_snmp_server + + + +Synopsis +-------- +- Manages SNMP community configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ access + +
+ string +
+ 		+
    Choices: +
  • ro
    • +
  • rw
    • +
+ 		+
Access type for community.
+
+
+ acl + +
+ string +
+ 		+ +
ACL name to filter snmp requests or keyword 'default'.
+
+
+ community + +
+ string + / required +
+ 		+ +
Case-sensitive community string.
+
+
+ group + +
+ string +
+ 		+ +
Group to which the community belongs.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure snmp community is configured + - cisco.nxos.nxos_snmp_community: + community: TESTING7 + group: network-operator + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['snmp-server community TESTING7 group network-operator']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_host_module.rst b/docs/cisco.nxos.nxos_snmp_host_module.rst new file mode 100644 index 000000000..8aef0b21d --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_host_module.rst @@ -0,0 +1,288 @@ +.. _cisco.nxos.nxos_snmp_host_module: + + +************************* +cisco.nxos.nxos_snmp_host +************************* + +**(deprecated, removed after 2024-01-01) Manages SNMP host configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated modules released with more functionality +:Alternative: nxos_snmp_server + + + +Synopsis +-------- +- Manages SNMP host configuration parameters. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ community + +
+ string +
+ 		+ +
Community string or v3 username.
+
+
+ snmp_host + +
+ string + / required +
+ 		+ +
IP address of hostname of target host.
+
+
+ snmp_type + +
+ string +
+ 		+
    Choices: +
  • trap
    • +
  • inform
    • +
+ 		+
type of message to send to host. If this is not specified, trap type is used.
+
+
+ src_intf + +
+ string +
+ 		+ +
Source interface. Must be fully qualified interface name. If state = absent, the interface is removed.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource. If state = present, the host is added to the configuration. If only vrf and/or vrf_filter and/or src_intf are given, they will be added to the existing host configuration. If state = absent, the host is removed if community parameter is given. It is possible to remove only vrf and/or src_int and/or vrf_filter by providing only those parameters and no community parameter.
+
+
+ udp + +
+ string +
+ 		+ Default:
"162"
+ 		+
UDP port number (0-65535).
+
+
+ v3 + +
+ string +
+ 		+
    Choices: +
  • noauth
    • +
  • auth
    • +
  • priv
    • +
+ 		+
Use this when verion is v3. SNMPv3 Security level.
+
+
+ version + +
+ string +
+ 		+
    Choices: +
  • v1
    • +
  • v2c
    • +
  • v3
    • +
+ 		+
SNMP version. If this is not specified, v1 is used.
+
+
+ vrf + +
+ string +
+ 		+ +
VRF to use to source traffic to source. If state = absent, the vrf is removed.
+
+
+ vrf_filter + +
+ string +
+ 		+ +
Name of VRF to filter. If state = absent, the vrf is removed from the filter.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - ``state=absent`` removes the host configuration if it is configured. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure snmp host is configured + - cisco.nxos.nxos_snmp_host: + snmp_host: 192.0.2.3 + community: TESTING + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['snmp-server host 192.0.2.3 filter-vrf another_test_vrf']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_location_module.rst b/docs/cisco.nxos.nxos_snmp_location_module.rst new file mode 100644 index 000000000..06f564693 --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_location_module.rst @@ -0,0 +1,156 @@ +.. _cisco.nxos.nxos_snmp_location_module: + + +***************************** +cisco.nxos.nxos_snmp_location +***************************** + +**(deprecated, removed after 2024-01-01) Manages SNMP location information.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated modules released with more functionality +:Alternative: nxos_snmp_server + + + +Synopsis +-------- +- Manages SNMP location configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ location + +
+ string + / required +
+ 		+ +
Location information.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure snmp location is configured + - cisco.nxos.nxos_snmp_location: + location: Test + state: present + + # ensure snmp location is not configured + - cisco.nxos.nxos_snmp_location: + location: Test + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['snmp-server location New_Test']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_server_module.rst b/docs/cisco.nxos.nxos_snmp_server_module.rst new file mode 100644 index 000000000..126e16341 --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_server_module.rst @@ -0,0 +1,4474 @@ +.. _cisco.nxos.nxos_snmp_server_module: + + +*************************** +cisco.nxos.nxos_snmp_server +*************************** + +**SNMP Server resource module.** + + +Version added: 2.8.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages SNMP server configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A dict of SNMP server configuration
+
+
+ aaa_user + +
+ dictionary +
+ 		+ +
Set duration for which aaa-cached snmp user exists.
+
+
+ cache_timeout + +
+ integer +
+ 		+ +
Timeout for which aaa-cached user exists(in secs).
+
+
+ communities + +
+ list + / elements=dictionary +
+ 		+ +
Set community string and access privs.
+
+
+ group + +
+ string +
+ 		+ +
Group to which the community belongs.
+
+
+ name + +
+ string +
+ 		+ +
SNMP community string (Max Size 32).
+

aliases: community
+
+
+ ro + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Read-only access with this community string.
+
+
+ rw + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Read-write access with this community string.
+
+
+ use_ipv4acl + +
+ string +
+ 		+ +
Specify IPv4 ACL, the ACL name specified must be IPv4 ACL.
+
This option is unsupported on MDS switches.
+
+
+ use_ipv6acl + +
+ string +
+ 		+ +
Specify IPv6 ACL, the ACL name specified after must be IPv6 ACL.
+
This option is unsupported on MDS switches.
+
+
+ contact + +
+ string +
+ 		+ +
Modify sysContact.
+
+
+ context + +
+ dictionary +
+ 		+ +
SNMP context to be mapped.
+
+
+ instance + +
+ string +
+ 		+ +
Name of the protocol instance (Max Size 32).
+
+
+ name + +
+ string +
+ 		+ +
Name of the SNMP context (Max Size 32).
+
+
+ topology + +
+ string +
+ 		+ +
Topology associated with the SNMP context.
+
+
+ vrf + +
+ string +
+ 		+ +
VRF associated with the SNMP context.
+
This option is unsupported on MDS switches.
+
+
+ counter + +
+ dictionary +
+ 		+ +
Configure port counter configuration.
+
This option is unsupported on MDS switches.
+
+
+ cache + +
+ dictionary +
+ 		+ +
Port stats cache.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable port stats cache.
+
+
+ timeout + +
+ integer +
+ 		+ +
Timeout for which cached port stats exists(in secs).
+
+
+ drop + +
+ dictionary +
+ 		+ +
Silently drop unknown v3 user packets.
+
This option is unsupported on MDS switches.
+
+
+ unknown_engine_id + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Unknown v3 engine id.
+
+
+ unknown_user + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Unknown v3 user.
+
+
+ engine_id + +
+ dictionary +
+ 		+ +
Configure a local SNMPv3 engineID.
+
This option is unsupported on MDS switches.
+
+
+ local + +
+ string +
+ 		+ +
EngineID of the local agent.
+
+
+ global_enforce_priv + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Globally enforce privacy for all the users.
+
+
+ hosts + +
+ list + / elements=dictionary +
+ 		+ +
Specify hosts to receive SNMP notifications.
+
SNMP hosts config lines that appear separately in running-config must be added as individual dictionaries.
+
+
+ auth + +
+ string +
+ 		+ +
Use the SNMPv3 authNoPriv Security Level.
+
+
+ community + +
+ string +
+ 		+ +
SNMP community string or SNMPv3 user name (Max Size 32).
+
+
+ filter_vrf + +
+ string +
+ 		+ +
Filters notifications to the notification host receiver based on the configured VRF.
+
This option is unsupported on MDS switches.
+
+
+ host + +
+ string +
+ 		+ +
IPv4 or IPv6 address or DNS Name of SNMP notification host.
+
+
+ informs + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Inform messages to this host.
+
+
+ priv + +
+ string +
+ 		+ +
Use the SNMPv3 authPriv Security Level.
+
+
+ source_interface + +
+ string +
+ 		+ +
Source interface to be used for sending out SNMP notifications to this host.
+
+
+ traps + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Traps messages to this host.
+
+
+ udp_port + +
+ integer +
+ 		+ +
The notification host's UDP port number.
+
+
+ use_vrf + +
+ string +
+ 		+ +
Configures SNMP to use the selected VRF to communicate with the host receiver.
+
This option is unsupported on MDS switches.
+
+
+ version + +
+ string +
+ 		+
    Choices: +
  • 1
    • +
  • 2c
    • +
  • 3
    • +
+ 		+
SNMP version to use for notification messages.
+
+
+ location + +
+ string +
+ 		+ +
Modify sysLocation.
+
+
+ mib + +
+ dictionary +
+ 		+ +
Mib access parameters.
+
+
+ community_map + +
+ dictionary +
+ 		+ +
SNMP community.
+
+
+ community + +
+ string +
+ 		+ +
SNMP community string (Max Size 32).
+
+
+ context + +
+ string +
+ 		+ +
Name of the SNMP context (Max Size 32).
+
+
+ packetsize + +
+ integer +
+ 		+ +
Largest SNMP packet size
+
+
+ protocol + +
+ dictionary +
+ 		+ +
Snmp protocol operations.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable snmp protocol operations.
+
+
+ source_interface + +
+ dictionary +
+ 		+ +
Source interface to be used for sending out SNMP notifications.
+
This option is unsupported on MDS switches.
+
+
+ informs + +
+ string +
+ 		+ +
SNMP Inform notifications for which this source interface needs to be used.
+
+
+ traps + +
+ string +
+ 		+ +
SNMP Trap notifications for which this source interface needs to be used.
+
+
+ system_shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure snmp-server for reload(2).
+
+
+ tcp_session + +
+ dictionary +
+ 		+ +
Enable one time authentication for snmp over tcp session.
+
+
+ auth + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable one time authentication for snmp over tcp session.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable tcp-session.
+
This option is unsupported on MDS switches.
+
+
+ traps + +
+ dictionary +
+ 		+ +
Enable SNMP Traps
+
+
+ aaa + +
+ dictionary +
+ 		+ +
AAA traps
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable AAA traps.
+
+
+ server_state_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
AAA server state change notification.
+
+
+ bgp + +
+ dictionary +
+ 		+ +
SNMP BGP traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP BGP traps.
+
+
+ bridge + +
+ dictionary +
+ 		+ +
Bridge traps.
+
This option is unsupported on MDS switches.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable bridge traps.
+
+
+ newroot + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP STP Bridge MIB newroot traps.
+
+
+ topologychange + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP STP Bridge MIB topologychange traps.
+
+
+ callhome + +
+ dictionary +
+ 		+ +
Callhome traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable callhome traps.
+
This option is unsupported on MDS switches.
+
+
+ event_notify + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Callhome External Event Notification.
+
+
+ smtp_send_fail + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
SMTP Message Send Fail notification.
+
+
+ cfs + +
+ dictionary +
+ 		+ +
CFS traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable cfs traps.
+
This option is unsupported on MDS switches.
+
+
+ merge_failure + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Merge failure notification.
+
+
+ state_change_notif + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
State change notification.
+
+
+ config + +
+ dictionary +
+ 		+ +
Config traps.
+
+
+ ccmCLIRunningConfigChanged + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Running config change trap.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable config traps.
+
This option is unsupported on MDS switches.
+
+
+ entity + +
+ dictionary +
+ 		+ +
Entity traps.
+
+
+ cefcMIBEnableStatusNotification + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
CefcMIBEnableStatusNotification.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable entity traps.
+
+
+ entity_fan_status_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Fan Status Change.
+
+
+ entity_mib_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity MIB change.
+
+
+ entity_module_inserted + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Module Inserted.
+
+
+ entity_module_removed + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Module Removed.
+
+
+ entity_module_status_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Module Status Change.
+
+
+ entity_power_out_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Power Out Change.
+
+
+ entity_power_status_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Power Status Change.
+
+
+ entity_sensor + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity sensor.
+
+
+ entity_unrecognised_module + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Unrecognised Module.
+
+
+ feature_control + +
+ dictionary +
+ 		+ +
Feature-Control traps.
+
+
+ ciscoFeatOpStatusChange + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Feature operation status change Notification.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable feature-control traps.
+
This option is unsupported on MDS switches.
+
+
+ featureOpStatusChange + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Feature operation status change notification.
+
+
+ generic + +
+ dictionary +
+ 		+ +
Generic traps.
+
+
+ coldStart + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Generic coldStart trap.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable generic traps.
+
This option is unsupported on MDS switches.
+
+
+ warmStart + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Generic warmStart trap.
+
+
+ license + +
+ dictionary +
+ 		+ +
License traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable license traps.
+
This option is unsupported on MDS switches.
+
+
+ notify_license_expiry + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
License Expiry Notification.
+
+
+ notify_license_expiry_warning + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
License Expiry Warning Notification.
+
+
+ notify_licensefile_missing + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
License File Missing Notification.
+
+
+ notify_no_license_for_feature + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
No License installed for feature Notification.
+
+
+ link + +
+ dictionary +
+ 		+ +
Link traps.
+
+
+ cErrDisableInterfaceEventRev1 + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Err-disable state notification.
+
This option is unsupported on MDS switches.
+
+
+ cieLinkDown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Cisco extended link state down notification.
+
+
+ cieLinkUp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Cisco extended link state up notification.
+
+
+ cisco_xcvr_mon_status_chg + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Cisco interface transceiver monitor status change notification.
+
+
+ cmn_mac_move_notification + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Mac addr move trap.
+
This option is unsupported on MDS switches.
+
+
+ delayed_link_state_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Delayed link state change.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable link traps.
+
This option is unsupported on MDS switches.
+
+
+ extended_linkDown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
IETF extended link state down notification.
+
+
+ extended_linkUp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
IETF extended link state up notification.
+
+
+ linkDown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
IETF Link state down notification.
+
+
+ linkUp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
IETF Link state up notification.
+
+
+ mmode + +
+ dictionary +
+ 		+ +
MMode traps.
+
This option is unsupported on MDS switches.
+
+
+ cseMaintModeChangeNotify + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Maint Mode Change Notification.
+
+
+ cseNormalModeChangeNotify + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Normal Mode Change Notification.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable mmode traps.
+
+
+ ospf + +
+ dictionary +
+ 		+ +
SNMP OSPF traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP OSPF traps.
+
+
+ ospfv3 + +
+ dictionary +
+ 		+ +
SNMP OSPFv3 traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP OSPFv3 traps.
+
+
+ rf + +
+ dictionary +
+ 		+ +
RF traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable rf traps.
+
This option is unsupported on MDS switches.
+
+
+ redundancy_framework + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Redundancy_Framework (RF) Sup switchover MIB.
+
+
+ rmon + +
+ dictionary +
+ 		+ +
RMON traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable rmon traps.
+
This option is unsupported on MDS switches.
+
+
+ fallingAlarm + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Rmon falling alarm.
+
+
+ hcFallingAlarm + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
High capacity Rmon falling alarm.
+
+
+ hcRisingAlarm + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
High capacity Rmon rising alarm.
+
+
+ risingAlarm + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Rmon rising alarm.
+
+
+ snmp + +
+ dictionary +
+ 		+ +
SNMP traps.
+
+
+ authentication + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
SNMP authentication trap.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable snmp traps.
+
This option is unsupported on MDS switches.
+
+
+ storm_control + +
+ dictionary +
+ 		+ +
Storm-Control traps.
+
+
+ cpscEventRev1 + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Port-Storm-Control-Event.
+
This option is unsupported on MDS switches.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable storm-control traps.
+
This option is unsupported on MDS switches.
+
+
+ trap_rate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Number of traps per minute.
+
+
+ stpx + +
+ dictionary +
+ 		+ +
Stpx traps.
+
This option is unsupported on MDS switches.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable stpx traps.
+
+
+ inconsistency + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP STPX MIB InconsistencyUpdate traps.
+
+
+ loop_inconsistency + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP STPX MIB LoopInconsistencyUpdate traps.
+
+
+ root_inconsistency + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP STPX MIB RootInconsistencyUpdate traps.
+
+
+ syslog + +
+ dictionary +
+ 		+ +
Enable syslog traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable syslog traps.
+
This option is unsupported on MDS switches.
+
+
+ message_generated + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Message Generated Notification.
+
+
+ sysmgr + +
+ dictionary +
+ 		+ +
Sysmgr traps.
+
+
+ cseFailSwCoreNotifyExtended + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Software Core Notification.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable sysmgr traps.
+
This option is unsupported on MDS switches.
+
+
+ system + +
+ dictionary +
+ 		+ +
System traps.
+
+
+ clock_change_notification + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Clock-change-notification traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable system traps.
+
This option is unsupported on MDS switches.
+
+
+ upgrade + +
+ dictionary +
+ 		+ +
Upgrade traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable upgrade traps.
+
This option is unsupported on MDS switches.
+
+
+ upgradeJobStatusNotify + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Upgrade Job Status Notification.
+
+
+ upgradeOpNotifyOnCompletion + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Upgrade Global Status Notification.
+
+
+ vtp + +
+ dictionary +
+ 		+ +
VTP traps.
+
This option is unsupported on MDS switches.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable VTP traps.
+
+
+ notifs + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable vtpConfigRevNumberError vtpConfigDigestEnable vtpConfigRevNumberError vtpConfigDigestError vtpServerDisabled vtpVersionOneDeviceDetected vlanTrunkPortDynamicStatusChange vtpLocalModeChanged vtpVersionInUseChanged notification.
+
+
+ vlancreate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable vtpVlanCreated notification.
+
+
+ vlandelete + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable vtpVlanDeleted notification.
+
+
+ users + +
+ dictionary +
+ 		+ +
Define users who can access the SNMP engine.
+
+
+ auth + +
+ list + / elements=dictionary +
+ 		+ +
SNMP User authentication related settings
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Authentication parameters for the user.
+
+
+ algorithm + +
+ string +
+ 		+
    Choices: +
  • md5
    • +
  • sha
    • +
  • sha-256
    • +
+ 		+
Select algorithm for authentication.
+
+
+ engine_id + +
+ string +
+ 		+ +
EngineID for configuring notif target user (for V3 informs).
+
This value needs to be enclosed in quotes in the task.
+
+
+ localized_key + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specifies whether the passwords are in localized key format.
+
+
+ localizedv2_key + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specifies whether the passwords are in localized V2 key format.
+
+
+ password + +
+ string +
+ 		+ +
Authentication password for user (Max Size 127).
+
If this value is localized, it has to be enclosed in quotes in the task.
+
+
+ priv + +
+ dictionary +
+ 		+ +
Encryption parameters for the user.
+
+
+ aes_128 + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use 128-bit AES algorithm for privacy.
+
+
+ privacy_password + +
+ string +
+ 		+ +
Privacy password for user (Max Size 130).
+
If this value is localized, it has to be enclosed in quotes in the task.
+
+
+ group + +
+ string +
+ 		+ +
Group name (ignored for notif target user) (Max Size 28).
+
+
+ user + +
+ string +
+ 		+ +
Name of the user (Max Size 28).
+
+
+ use_acls + +
+ list + / elements=dictionary +
+ 		+ +
Set IPv4 and IPv6 ACL to use.
+
+
+ ipv4 + +
+ string +
+ 		+ +
Specify IPv4 ACL, the ACL name specified after must be IPv4 ACL.
+
+
+ ipv6 + +
+ string +
+ 		+ +
Specify IPv6 ACL, the ACL name specified after must be IPv6 ACL.
+
+
+ user + +
+ string +
+ 		+ +
Name of the user (Max Size 28).
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^snmp-server'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
The states replaced and overridden have identical behaviour for this module.
+
Please refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6 on Cisco Nexus Switches. + - This module works with connection ``network_cli`` and ``httpapi``. + - Tested against Cisco MDS NX-OS 9.2(2) with connection ``network_cli``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_snmp_server: + config: + aaa_user: + cache_timeout: 36000 + communities: + - community: public + group: network-operator + - community: private + group: network-admin + contact: nxosswitchadmin@localhost + location: serverroom-1 + traps: + aaa: + server_state_change: true + system: + clock_change_notification: true + hosts: + - host: 192.0.2.1 + traps: true + version: '1' + community: public + - host: 192.0.2.1 + source_interface: Ethernet1/1 + - host: 192.0.2.2 + informs: true + version: '3' + auth: NMS + users: + auth: + - user: snmp_user_1 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + - user: snmp_user_2 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + priv: + privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' + aes_128: true + use_acls: + - user: snmp_user_1 + ipv4: acl1 + ipv6: acl2 + - user: snmp_user_2 + ipv4: acl3 + ipv6: acl4 + + # Task output + # ------------- + # before: + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # + # commands: + # - snmp-server contact nxosswitchadmin@localhost + # - snmp-server location serverroom-1 + # - snmp-server aaa-user cache-timeout 36000 + # - snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # - snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # - snmp-server host 192.0.2.1 traps version 1 public + # - snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # - snmp-server host 192.0.2.2 informs version 3 auth NMS + # - snmp-server community private group network-admin + # - snmp-server community public group network-operator + # - snmp-server enable traps aaa server-state-change + # - snmp-server enable traps system Clock-change-notification + # + # after: + # aaa_user: + # cache_timeout: 36000 + # communities: + # - community: private + # group: network-admin + # - community: public + # group: network-operator + # contact: nxosswitchadmin@localhost + # location: serverroom-1 + # traps: + # aaa: + # server_state_change: true + # system: + # clock_change_notification: true + # hosts: + # - host: 192.0.2.1 + # traps: true + # version: "1" + # community: public + # + # - host: 192.0.2.1 + # source_interface: Ethernet1/1 + # + # - host: 192.0.2.2 + # informs: true + # version: "3" + # auth: NMS + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # + # - user: snmp_user_1 + # group: network-operator + # authentication: + # algorithm: md5 + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # localized_key: true + # + # - authentication: + # algorithm: md5 + # localized_key: true + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # priv: + # aes_128: true + # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" + # group: network-operator + # user: snmp_user_2 + # + # use_acls: + # - user: snmp_user_1 + # ipv4: acl1 + # ipv6: acl2 + # - user: snmp_user_2 + # ipv4: acl3 + # ipv6: acl4 + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server contact nxosswitchadmin@localhost + # snmp-server location serverroom-1 + # snmp-server aaa-user cache-timeout 36000 + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # snmp-server host 192.0.2.1 traps version 1 public + # snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # snmp-server host 192.0.2.2 informs version 3 auth NMS + # snmp-server community private group network-admin + # snmp-server community public group network-operator + # snmp-server enable traps aaa server-state-change + # snmp-server enable traps system Clock-change-notification + + # Using replaced + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server contact nxosswitchadmin@localhost + # snmp-server location serverroom-1 + # snmp-server aaa-user cache-timeout 36000 + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # snmp-server host 192.0.2.1 traps version 1 public + # snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # snmp-server host 192.0.2.2 informs version 3 auth NMS + # snmp-server community private group network-admin + # snmp-server community public group network-operator + # snmp-server enable traps aaa server-state-change + # snmp-server enable traps system Clock-change-notification + + - name: Replace snmp-server configurations of listed snmp-server with provided configurations + cisco.nxos.nxos_snmp_server: + config: + aaa_user: + cache_timeout: 36000 + communities: + - community: public + group: network-operator + - community: secret + group: network-operator + contact: nxosswitchadmin2@localhost + location: serverroom-2 + traps: + aaa: + server_state_change: true + hosts: + - host: 192.0.2.1 + traps: true + version: '1' + community: public + - host: 192.0.2.1 + source_interface: Ethernet1/1 + - host: 192.0.3.2 + informs: true + version: '3' + auth: NMS + users: + auth: + - user: admin + group: network-admin + authentication: + algorithm: md5 + password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + localized_key: true + priv: + privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + + - user: snmp_user_1 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + + - user: snmp_user_2 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + priv: + privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' + aes_128: true + use_acls: + - user: snmp_user_1 + ipv4: acl1 + ipv6: acl2 + state: replaced + + # Task output + # ------------- + # before: + # aaa_user: + # cache_timeout: 36000 + # communities: + # - community: private + # group: network-admin + # - community: public + # group: network-operator + # contact: nxosswitchadmin@localhost + # location: serverroom-1 + # traps: + # aaa: + # server_state_change: true + # system: + # clock_change_notification: true + # hosts: + # - host: 192.0.2.1 + # traps: true + # version: "1" + # community: public + # + # - host: 192.0.2.1 + # source_interface: Ethernet1/1 + # + # - host: 192.0.2.2 + # informs: true + # version: "3" + # auth: NMS + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # + # - user: snmp_user_1 + # group: network-operator + # authentication: + # algorithm: md5 + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # localized_key: true + # + # - authentication: + # algorithm: md5 + # localized_key: true + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # priv: + # aes_128: true + # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" + # group: network-operator + # user: snmp_user_2 + # + # use_acls: + # - user: snmp_user_1 + # ipv4: acl1 + # ipv6: acl2 + # - user: snmp_user_2 + # ipv4: acl3 + # ipv6: acl4 + # + # commands: + # - snmp-server contact nxosswitchadmin2@localhost + # - no snmp-server enable traps system Clock-change-notification + # - snmp-server location serverroom-2 + # - no snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # - no snmp-server host 192.0.2.2 informs version 3 auth NMS + # - snmp-server host 192.0.3.2 informs version 3 auth NMS + # - no snmp-server community private group network-admin + # - snmp-server community secret group network-operator + # + # after: + # aaa_user: + # cache_timeout: 36000 + # communities: + # - community: public + # group: network-operator + # - community: secret + # group: network-operator + # contact: nxosswitchadmin2@localhost + # location: serverroom-2 + # traps: + # aaa: + # server_state_change: true + # hosts: + # - host: 192.0.2.1 + # traps: true + # version: '1' + # community: public + # - host: 192.0.2.1 + # source_interface: Ethernet1/1 + # - host: 192.0.3.2 + # informs: true + # version: '3' + # auth: NMS + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # + # - user: snmp_user_1 + # group: network-operator + # authentication: + # algorithm: md5 + # password: '0x5632724fb8ac3699296af26281e1d0f1' + # localized_key: true + # + # - user: snmp_user_2 + # group: network-operator + # authentication: + # algorithm: md5 + # password: '0x5632724fb8ac3699296af26281e1d0f1' + # localized_key: true + # priv: + # privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' + # aes_128: true + # + # use_acls: + # - user: snmp_user_1 + # ipv4: acl1 + # ipv6: acl2 + # + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server contact nxosswitchadmin2@localhost + # snmp-server location serverroom-2 + # snmp-server aaa-user cache-timeout 36000 + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # snmp-server host 192.0.2.1 traps version 1 public + # snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # snmp-server host 192.0.2.2 informs version 3 auth NMS + # snmp-server community secret group network-operator + # snmp-server community public group network-operator + # snmp-server enable traps aaa server-state-change + # snmp-server enable traps system Clock-change-notification + + # Using deleted + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server contact nxosswitchadmin@localhost + # snmp-server location serverroom-1 + # snmp-server aaa-user cache-timeout 36000 + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # snmp-server host 192.0.2.1 traps version 1 public + # snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # snmp-server host 192.0.2.2 informs version 3 auth NMS + # snmp-server community private group network-admin + # snmp-server community public group network-operator + # snmp-server enable traps aaa server-state-change + # snmp-server enable traps system Clock-change-notification + + - name: Delete SNMP Server configurations from the device (admin user will not be deleted) + cisco.nxos.nxos_snmp_server: + state: deleted + + # Task output + # ------------- + # before: + # aaa_user: + # cache_timeout: 36000 + # communities: + # - community: private + # group: network-admin + # - community: public + # group: network-operator + # contact: nxosswitchadmin@localhost + # location: serverroom-1 + # traps: + # aaa: + # server_state_change: true + # system: + # clock_change_notification: true + # hosts: + # - host: 192.0.2.1 + # traps: true + # version: "1" + # community: public + # + # - host: 192.0.2.1 + # source_interface: Ethernet1/1 + # + # - host: 192.0.2.2 + # informs: true + # version: "3" + # auth: NMS + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # + # - user: snmp_user_1 + # group: network-operator + # authentication: + # algorithm: md5 + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # localized_key: true + # + # - authentication: + # algorithm: md5 + # localized_key: true + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # priv: + # aes_128: true + # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" + # group: network-operator + # user: snmp_user_2 + # + # use_acls: + # - user: snmp_user_1 + # ipv4: acl1 + # ipv6: acl2 + # - user: snmp_user_2 + # ipv4: acl3 + # ipv6: acl4 + # + # commands: + # - no snmp-server contact nxosswitchadmin@localhost + # - no snmp-server location serverroom-1 + # - no snmp-server aaa-user cache-timeout 36000 + # - no snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + # - no snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - no snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - no snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # - no snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # - no snmp-server host 192.0.2.1 traps version 1 public + # - no snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # - no snmp-server host 192.0.2.2 informs version 3 auth NMS + # - no snmp-server community private group network-admin + # - no snmp-server community public group network-operator + # - no snmp-server enable traps aaa server-state-change + # - no snmp-server enable traps system Clock-change-notification + # + # after: + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + + # Using rendered + # --------------- + + - name: Render platform specific configuration lines with state rendered (without connecting to the device) + cisco.nxos.nxos_snmp_server: + config: + aaa_user: + cache_timeout: 36000 + communities: + - community: public + group: network-operator + - community: private + group: network-admin + contact: nxosswitchadmin@localhost + location: serverroom-1 + traps: + aaa: + server_state_change: true + system: + clock_change_notification: true + hosts: + - host: 192.0.2.1 + traps: true + version: '1' + community: public + - host: 192.0.2.1 + source_interface: Ethernet1/1 + - host: 192.0.2.2 + informs: true + version: '3' + auth: NMS + users: + auth: + - user: snmp_user_1 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + - user: snmp_user_2 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + priv: + privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' + aes_128: true + use_acls: + - user: snmp_user_1 + ipv4: acl1 + ipv6: acl2 + - user: snmp_user_2 + ipv4: acl3 + ipv6: acl4 + state: rendered + + + # Task Output (redacted) + # ----------------------- + # rendered: + # - snmp-server contact nxosswitchadmin@localhost + # - snmp-server location serverroom-1 + # - snmp-server aaa-user cache-timeout 36000 + # - snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # - snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # - snmp-server host 192.0.2.1 traps version 1 public + # - snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # - snmp-server host 192.0.2.2 informs version 3 auth NMS + # - snmp-server community private group network-admin + # - snmp-server community public group network-operator + # - snmp-server enable traps aaa server-state-change + # - snmp-server enable traps system Clock-change-notification + + # Using parsed + + # parsed.cfg + # ------------ + # snmp-server contact nxosswitchadmin@localhost + # snmp-server location serverroom-1 + # snmp-server aaa-user cache-timeout 36000 + # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # snmp-server host 192.0.2.1 traps version 1 public + # snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # snmp-server host 192.0.2.2 informs version 3 auth NMS + # snmp-server community private group network-admin + # snmp-server community public group network-operator + # snmp-server enable traps aaa server-state-change + # snmp-server enable traps system Clock-change-notification + + - name: Parse externally provided snmp-server configuration + cisco.nxos.nxos_snmp_server: + running_config: "{{ lookup('file', './parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # aaa_user: + # cache_timeout: 36000 + # communities: + # - community: private + # group: network-admin + # - community: public + # group: network-operator + # contact: nxosswitchadmin@localhost + # location: serverroom-1 + # traps: + # aaa: + # server_state_change: true + # system: + # clock_change_notification: true + # hosts: + # - host: 192.0.2.1 + # traps: true + # version: "1" + # community: public + # + # - host: 192.0.2.1 + # source_interface: Ethernet1/1 + # + # - host: 192.0.2.2 + # informs: true + # version: "3" + # auth: NMS + # users: + # auth: + # - user: snmp_user_1 + # group: network-operator + # authentication: + # algorithm: md5 + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # localized_key: true + # + # - authentication: + # algorithm: md5 + # localized_key: true + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # priv: + # aes_128: true + # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" + # group: network-operator + # user: snmp_user_2 + # + # use_acls: + # - user: snmp_user_1 + # ipv4: acl1 + # ipv6: acl2 + # - user: snmp_user_2 + # ipv4: acl3 + # ipv6: acl4 + # + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['sample command 1', 'sample command 2', 'sample command 3']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['sample command 1', 'sample command 2', 'sample command 3']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_snmp_traps_module.rst b/docs/cisco.nxos.nxos_snmp_traps_module.rst new file mode 100644 index 000000000..726a4d5fe --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_traps_module.rst @@ -0,0 +1,189 @@ +.. _cisco.nxos.nxos_snmp_traps_module: + + +************************** +cisco.nxos.nxos_snmp_traps +************************** + +**(deprecated, removed after 2024-01-01) Manages SNMP traps.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated modules released with more functionality +:Alternative: nxos_snmp_server + + + +Synopsis +-------- +- Manages SNMP traps configurations. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ group + +
+ string + / required +
+ 		+
    Choices: +
  • aaa
    • +
  • bfd
    • +
  • bgp
    • +
  • bridge
    • +
  • callhome
    • +
  • cfs
    • +
  • config
    • +
  • eigrp
    • +
  • entity
    • +
  • feature-control
    • +
  • generic
    • +
  • hsrp
    • +
  • license
    • +
  • link
    • +
  • lldp
    • +
  • mmode
    • +
  • ospf
    • +
  • pim
    • +
  • rf
    • +
  • rmon
    • +
  • snmp
    • +
  • storm-control
    • +
  • stpx
    • +
  • switchfabric
    • +
  • syslog
    • +
  • sysmgr
    • +
  • system
    • +
  • upgrade
    • +
  • vtp
    • +
  • all
    • +
+ 		+
Case sensitive group.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • enabled ←
    • +
  • disabled
    • +
+ 		+
Manage the state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - This module works at the group level for traps. If you need to only enable/disable 1 specific trap within a group, use the :ref:`cisco.nxos.nxos_command ` module. + - Be aware that you can set a trap only for an enabled feature. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure lldp trap configured + - cisco.nxos.nxos_snmp_traps: + group: lldp + state: enabled + + # ensure lldp trap is not configured + - cisco.nxos.nxos_snmp_traps: + group: lldp + state: disabled + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
snmp-server enable traps lldp ;
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_snmp_user_module.rst b/docs/cisco.nxos.nxos_snmp_user_module.rst new file mode 100644 index 000000000..2d3f6f26c --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_user_module.rst @@ -0,0 +1,235 @@ +.. _cisco.nxos.nxos_snmp_user_module: + + +************************* +cisco.nxos.nxos_snmp_user +************************* + +**(deprecated, removed after 2024-01-01) Manages SNMP users for monitoring.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated modules released with more functionality +:Alternative: nxos_snmp_server + + + +Synopsis +-------- +- Manages SNMP user configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ authentication + +
+ string +
+ 		+
    Choices: +
  • md5
    • +
  • sha
    • +
+ 		+
Authentication parameters for the user.
+
+
+ encrypt + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables AES-128 bit encryption when using privacy password.
+
+
+ group + +
+ string +
+ 		+ +
Group to which the user will belong to. If state = present, and the user is existing, the group is added to the user. If the user is not existing, user entry is created with this group argument. If state = absent, only the group is removed from the user entry. However, to maintain backward compatibility, if the existing user belongs to only one group, and if group argument is same as the existing user's group, then the user entry also is deleted.
+
+
+ privacy + +
+ string +
+ 		+ +
Privacy password for the user. This is not idempotent
+
+
+ pwd + +
+ string +
+ 		+ +
Authentication password when using md5 or sha. This is not idempotent
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ user + +
+ string + / required +
+ 		+ +
Name of the user.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - Authentication parameters not idempotent. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_snmp_user: + user: ntc + group: network-operator + authentication: md5 + pwd: test_password + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['snmp-server user ntc network-operator auth md5 test_password']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_spanning_tree_global_module.rst b/docs/cisco.nxos.nxos_spanning_tree_global_module.rst index e69de29bb..5b1c17af8 100644 --- a/docs/cisco.nxos.nxos_spanning_tree_global_module.rst +++ b/docs/cisco.nxos.nxos_spanning_tree_global_module.rst @@ -0,0 +1,473 @@ +.. _cisco.nxos.nxos_spanning_tree_global_module: + + +************************************ +cisco.nxos.nxos_spanning_tree_global +************************************ + +**Resource module to configure spanning tree.** + + +Version added: 6.0.3 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module configures and manages the attributes of Spanning-tree on Cisco NXOS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A dict of Spanning-tree options.
+
+
+ bridge_assurance + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable bridge assurance.
+
+
+ bridge_domain + +
+ string +
+ 		+ +
+
+ fcoe + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable STP for FCoE VLANs.
+
+
+ lc_issu + +
+ string +
+ 		+
    Choices: +
  • auto
    • +
  • disruptive
    • +
  • non-disruptive
    • +
+ 		+
Configure Linecard ISSU type.
+
+
+ loopguard_default + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Spanning tree loopguard .
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • mst
    • +
  • rapid-pvst
    • +
+ 		+
Spanning tree mode.
+
+
+ pathcost_method + +
+ string +
+ 		+
    Choices: +
  • long
    • +
  • short
    • +
+ 		+
Spanning tree pathcost options.
+
+
+ port_type + +
+ dictionary +
+ 		+ +
Spanning tree port type.
+
+
+ default + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable default port type.
+
+
+ edge + +
+ string +
+ 		+
    Choices: +
  • bpdufilter
    • +
  • bpduguard
    • +
  • default
    • +
+ 		+
Enable edge port type.
+
+
+ network + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable network port type.
+
+
+ vlan + +
+ string +
+ 		+ +
Spanning tree VLAN range.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NXOS device by executing the command show running-config | section ^spanning-tree.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • rendered
    • +
  • gathered
    • +
  • purged
    • +
  • parsed
    • +
+ 		+
The state the configuration should be left in
+
The states rendered, gathered and parsed does not perform any change on the device.
+
The state rendered will transform the configuration in config option to platform specific CLI commands which will be returned in the rendered key within the result. For state rendered active connection to remote host is not required.
+
The state gathered will fetch the running configuration from device and transform it into structured data in the format as per the resource module argspec and the value is returned in the gathered key within the result.
+
The state parsed reads the configuration from running_config option and transforms it into JSON format as per the resource module parameters and the value is returned in the parsed key within the result. The value of running_config option should be the same format as the output of command show running-config | include ip route|ipv6 route executed on device. For state parsed active connection to remote host is not required.
+
The state purged negates virtual/logical interfaces that are specified in task from running-config.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - This module works with connection ``network_cli`` and ``httpapi``. See https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html + + + + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['sample command 1', 'sample command 2', 'sample command 3']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['sample command 1', 'sample command 2', 'sample command 3']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Vinay Mulugund (@roverflow) diff --git a/docs/cisco.nxos.nxos_udld_interface_module.rst b/docs/cisco.nxos.nxos_udld_interface_module.rst new file mode 100644 index 000000000..cba2733c0 --- /dev/null +++ b/docs/cisco.nxos.nxos_udld_interface_module.rst @@ -0,0 +1,250 @@ +.. _cisco.nxos.nxos_udld_interface_module: + + +****************************** +cisco.nxos.nxos_udld_interface +****************************** + +**Manages UDLD interface configuration params.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages UDLD interface configuration params. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ interface + +
+ string + / required +
+ 		+ +
FULL name of the interface, i.e. Ethernet1/1-
+
+
+ mode + +
+ string + / required +
+ 		+
    Choices: +
  • enabled
    • +
  • disabled
    • +
  • aggressive
    • +
+ 		+
Manages UDLD mode for an interface.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Feature UDLD must be enabled on the device to use this module. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure Ethernet1/1 is configured to be in aggressive mode + - cisco.nxos.nxos_udld_interface: + interface: Ethernet1/1 + mode: aggressive + state: present + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + # Remove the aggressive config only if it's currently in aggressive mode and then disable udld (switch default) + - cisco.nxos.nxos_udld_interface: + interface: Ethernet1/1 + mode: aggressive + state: absent + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + # ensure Ethernet1/1 has aggressive mode enabled + - cisco.nxos.nxos_udld_interface: + interface: Ethernet1/1 + mode: enabled + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ end_state + +
+ dictionary +
+ 		always +
k/v pairs of configuration after module execution
+
+
Sample:
+
{'mode': 'enabled'}
+
+
+ existing + +
+ dictionary +
+ 		always +
k/v pairs of existing configuration
+
+
Sample:
+
{'mode': 'aggressive'}
+
+
+ proposed + +
+ dictionary +
+ 		always +
k/v pairs of parameters passed into module
+
+
Sample:
+
{'mode': 'enabled'}
+
+
+ updates + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['interface ethernet1/33', 'no udld aggressive ; no udld disable']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_udld_module.rst b/docs/cisco.nxos.nxos_udld_module.rst new file mode 100644 index 000000000..dc461bc89 --- /dev/null +++ b/docs/cisco.nxos.nxos_udld_module.rst @@ -0,0 +1,256 @@ +.. _cisco.nxos.nxos_udld_module: + + +******************** +cisco.nxos.nxos_udld +******************** + +**Manages UDLD global configuration params.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages UDLD global configuration params. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ aggressive + +
+ string +
+ 		+
    Choices: +
  • enabled
    • +
  • disabled
    • +
+ 		+
Toggles aggressive mode.
+
+
+ msg_time + +
+ string +
+ 		+ +
Message time in seconds for UDLD packets or keyword 'default'.
+
+
+ reset + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ability to reset all ports shut down by UDLD. 'state' parameter cannot be 'absent' when this is present.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource. When set to 'absent', aggressive and msg_time are set to their default values.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Module will fail if the udld feature has not been previously enabled. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure udld aggressive mode is globally disabled and se global message interval is 20 + - cisco.nxos.nxos_udld: + aggressive: disabled + msg_time: 20 + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + # Ensure agg mode is globally enabled and msg time is 15 + - cisco.nxos.nxos_udld: + aggressive: enabled + msg_time: 15 + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ end_state + +
+ dictionary +
+ 		always +
k/v pairs of udld configuration after module execution
+
+
Sample:
+
{'aggressive': 'enabled', 'msg_time': '40'}
+
+
+ existing + +
+ dictionary +
+ 		always +
k/v pairs of existing udld configuration
+
+
Sample:
+
{'aggressive': 'disabled', 'msg_time': '15'}
+
+
+ proposed + +
+ dictionary +
+ 		always +
k/v pairs of parameters passed into module
+
+
Sample:
+
{'aggressive': 'enabled', 'msg_time': '40'}
+
+
+ updates + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['udld message-time 40', 'udld aggressive']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_user_module.rst b/docs/cisco.nxos.nxos_user_module.rst new file mode 100644 index 000000000..a03a23a03 --- /dev/null +++ b/docs/cisco.nxos.nxos_user_module.rst @@ -0,0 +1,390 @@ +.. _cisco.nxos.nxos_user_module: + + +******************** +cisco.nxos.nxos_user +******************** + +**Manage the collection of local users on Nexus devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module provides declarative management of the local usernames configured on Cisco Nexus devices. It allows playbooks to manage either individual usernames or the collection of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ aggregate + +
+ list + / elements=dictionary +
+ 		+ +
The set of username objects to be configured on the remote Cisco Nexus device. The list entries can either be the username or a hash of username and properties. This argument is mutually exclusive with the name argument.
+

aliases: users, collection
+
+
+ configured_password + +
+ string +
+ 		+ +
The password to be configured on the network device. The password needs to be provided in cleartext and it will be encrypted on the device.
+
+
+ hashed_password + +
+ string +
+ 		+ +
The hashed password to be configured on the network device. The password needs to already be encrypted.
+
+
+ name + +
+ string +
+ 		+ +
The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
+
+
+ roles + +
+ list + / elements=string +
+ 		+ +
The role argument configures the role for the username in the device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device.
+

aliases: role
+
+
+ sshkey + +
+ string +
+ 		+ +
The sshkey argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
The state argument configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
+
+
+ update_password + +
+ string +
+ 		+
    Choices: +
  • on_create
    • +
  • always
    • +
+ 		+
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
+
+
+ configured_password + +
+ string +
+ 		+ +
The password to be configured on the network device. The password needs to be provided in cleartext and it will be encrypted on the device.
+
+
+ hashed_password + +
+ string +
+ 		+ +
The hashed password to be configured on the network device. The password needs to already be encrypted.
+
+
+ name + +
+ string +
+ 		+ +
The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
+
+
+ purge + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
The purge argument instructs the module to consider the resource definition absolute. It will remove any previously configured usernames on the device with the exception of the `admin` user which cannot be deleted per nxos constraints.
+
+
+ roles + +
+ list + / elements=string +
+ 		+ +
The role argument configures the role for the username in the device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device.
+

aliases: role
+
+
+ sshkey + +
+ string +
+ 		+ +
The sshkey argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
The state argument configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
+
+
+ update_password + +
+ string +
+ 		+
    Choices: +
  • on_create
    • +
  • always ←
    • +
+ 		+
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
+
+
+ + +Notes +----- + +.. note:: + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: create a new user + cisco.nxos.nxos_user: + name: ansible + sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}" + state: present + + - name: remove all users except admin + cisco.nxos.nxos_user: + purge: true + + - name: set multiple users role + cisco.nxos.nxos_user: + aggregate: + - name: netop + - name: netend + role: network-operator + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['name ansible', 'name ansible password password']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_vpc_module.rst b/docs/cisco.nxos.nxos_vpc_module.rst new file mode 100644 index 000000000..9e0ca3c29 --- /dev/null +++ b/docs/cisco.nxos.nxos_vpc_module.rst @@ -0,0 +1,352 @@ +.. _cisco.nxos.nxos_vpc_module: + + +******************* +cisco.nxos.nxos_vpc +******************* + +**Manages global VPC configuration** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages global VPC configuration + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ auto_recovery + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/Disables auto recovery on platforms that support disable
+
timers are not modifiable with this attribute
+
mutually exclusive with auto_recovery_reload_delay
+
+
+ auto_recovery_reload_delay + +
+ string +
+ 		+ +
Manages auto-recovery reload-delay timer in seconds
+
mutually exclusive with auto_recovery
+
+
+ delay_restore + +
+ string +
+ 		+ +
manages delay restore command and config value in seconds
+
+
+ delay_restore_interface_vlan + +
+ string +
+ 		+ +
manages delay restore interface-vlan command and config value in seconds
+
not supported on all platforms
+
+
+ delay_restore_orphan_port + +
+ string +
+ 		+ +
manages delay restore orphan-port command and config value in seconds
+
not supported on all platforms
+
+
+ domain + +
+ string + / required +
+ 		+ +
VPC domain
+
+
+ peer_gw + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/Disables peer gateway
+
+
+ pkl_dest + +
+ string +
+ 		+ +
Destination (remote) IP address used for peer keepalive link
+
pkl_dest is required whenever pkl options are used.
+
+
+ pkl_src + +
+ string +
+ 		+ +
Source IP address used for peer keepalive link
+
+
+ pkl_vrf + +
+ string +
+ 		+ +
VRF used for peer keepalive link
+
The VRF must exist on the device before using pkl_vrf.
+
(Note) 'default' is an overloaded term: Default vrf context for pkl_vrf is 'management'; 'pkl_vrf: default' refers to the literal 'default' rib.
+
+
+ role_priority + +
+ string +
+ 		+ +
Role priority for device. Remember lower is better.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manages desired state of the resource
+
+
+ system_priority + +
+ string +
+ 		+ +
System priority device. Remember they must match between peers.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - The feature vpc must be enabled before this module can be used + - If not using management vrf, vrf must be globally on the device before using in the pkl config + - Although source IP isn't required on the command line it is required when using this module. The PKL VRF must also be configured prior to using this module. + - Both pkl_src and pkl_dest are needed when changing PKL VRF. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: configure a simple asn + cisco.nxos.nxos_vpc: + domain: 100 + role_priority: 1000 + system_priority: 2000 + pkl_dest: 192.168.100.4 + pkl_src: 10.1.100.20 + peer_gw: true + auto_recovery: true + + - name: configure + cisco.nxos.nxos_vpc: + domain: 100 + role_priority: 32667 + system_priority: 2000 + peer_gw: true + pkl_src: 10.1.100.2 + pkl_dest: 192.168.100.4 + auto_recovery: true + + - name: Configure VPC with delay restore and existing keepalive VRF + cisco.nxos.nxos_vpc: + domain: 10 + role_priority: 28672 + system_priority: 2000 + delay_restore: 180 + peer_gw: true + pkl_src: 1.1.1.2 + pkl_dest: 1.1.1.1 + pkl_vrf: vpckeepalive + auto_recovery: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['vpc domain 100', 'peer-keepalive destination 192.168.100.4 source 10.1.100.20 vrf management', 'auto-recovery', 'peer-gateway']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vrf_af_module.rst b/docs/cisco.nxos.nxos_vrf_af_module.rst new file mode 100644 index 000000000..236991587 --- /dev/null +++ b/docs/cisco.nxos.nxos_vrf_af_module.rst @@ -0,0 +1,300 @@ +.. _cisco.nxos.nxos_vrf_af_module: + + +********************** +cisco.nxos.nxos_vrf_af +********************** + +**Manages VRF AF.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages VRF AF + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
Address-Family Identifier (AFI).
+
+
+ route_target_both_auto_evpn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable the EVPN route-target 'auto' setting for both import and export target communities.
+
+
+ route_targets + +
+ list + / elements=dictionary +
+ 		+ +
Specify the route-targets which should be imported and/or exported under the AF. This argument accepts a list of dicts that specify the route-target, the direction (import|export|both) and state of each route-target. Default direction is direction=both. See examples.
+
+
+ direction + +
+ string +
+ 		+
    Choices: +
  • import
    • +
  • export
    • +
  • both ←
    • +
+ 		+
Indicates the direction of the route-target (import|export|both)
+
+
+ rt + +
+ string + / required +
+ 		+ +
Defines the route-target itself
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Determines whether the route-target with the given direction should be present or not on the device.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Determines whether the config should be present or not on the device.
+
+
+ vrf + +
+ string + / required +
+ 		+ +
Name of the VRF.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Default, where supported, restores params default value. + - In case of ``state=absent`` the address-family configuration will be absent. Therefore the options ``route_target_both_auto_evpn`` and ``route_targets`` are ignored. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_target_both_auto_evpn: true + state: present + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_targets: + - rt: '65000:1000' + direction: import + - rt: '65001:1000' + direction: import + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_targets: + - rt: '65000:1000' + direction: import + - rt: '65001:1000' + state: absent + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_targets: + - rt: '65000:1000' + direction: export + - rt: '65001:1000' + direction: export + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_targets: + - rt: '65000:1000' + direction: export + state: absent + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_targets: + - rt: '65000:1000' + direction: both + state: present + - rt: '65001:1000' + direction: import + state: present + - rt: '65002:1000' + direction: both + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['vrf context ntc', 'address-family ipv4 unicast']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vrf_module.rst b/docs/cisco.nxos.nxos_vrf_module.rst new file mode 100644 index 000000000..6765f78b5 --- /dev/null +++ b/docs/cisco.nxos.nxos_vrf_module.rst @@ -0,0 +1,494 @@ +.. _cisco.nxos.nxos_vrf_module: + + +******************* +cisco.nxos.nxos_vrf +******************* + +**Manages global VRF configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module provides declarative management of VRFs on CISCO NXOS network devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ admin_state + +
+ string +
+ 		+
    Choices: +
  • up ←
    • +
  • down
    • +
+ 		+
Administrative state of the VRF.
+
+
+ aggregate + +
+ list + / elements=dictionary +
+ 		+ +
List of VRFs definitions.
+
+
+ admin_state + +
+ string +
+ 		+
    Choices: +
  • up
    • +
  • down
    • +
+ 		+
Administrative state of the VRF.
+
+
+ associated_interfaces + +
+ list + / elements=string +
+ 		+ +
This is a intent option and checks the operational state of the for given vrf name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vrf interfaces on device it will result in failure.
+
+
+ delay + +
+ integer +
+ 		+ +
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
+
+
+ description + +
+ string +
+ 		+ +
Description of the VRF or keyword 'default'.
+
+
+ interfaces + +
+ list + / elements=string +
+ 		+ +
List of interfaces to check the VRF has been configured correctly or keyword 'default'.
+
+
+ name + +
+ string +
+ 		+ +
Name of VRF to be managed.
+

aliases: vrf
+
+
+ rd + +
+ string +
+ 		+ +
VPN Route Distinguisher (RD). Valid values are a string in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword 'auto', or the keyword 'default'.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
Manages desired state of the resource.
+
+
+ vni + +
+ string +
+ 		+ +
Specify virtual network identifier. Valid values are Integer or keyword 'default'.
+
+
+ associated_interfaces + +
+ list + / elements=string +
+ 		+ +
This is a intent option and checks the operational state of the for given vrf name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vrf interfaces on device it will result in failure.
+
+
+ delay + +
+ integer +
+ 		+ Default:
10
+ 		+
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
+
+
+ description + +
+ string +
+ 		+ +
Description of the VRF or keyword 'default'.
+
+
+ interfaces + +
+ list + / elements=string +
+ 		+ +
List of interfaces to check the VRF has been configured correctly or keyword 'default'.
+
+
+ name + +
+ string +
+ 		+ +
Name of VRF to be managed.
+

aliases: vrf
+
+
+ purge + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Purge VRFs not defined in the aggregate parameter.
+
+
+ rd + +
+ string +
+ 		+ +
VPN Route Distinguisher (RD). Valid values are a string in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword 'auto', or the keyword 'default'.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manages desired state of the resource.
+
+
+ vni + +
+ string +
+ 		+ +
Specify virtual network identifier. Valid values are Integer or keyword 'default'.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Cisco NX-OS creates the default VRF by itself. Therefore, you're not allowed to use default as *vrf* name in this module. + - ``vrf`` name must be shorter than 32 chars. + - VRF names are not case sensible in NX-OS. Anyway, the name is stored just like it's inserted by the user and it'll not be changed again unless the VRF is removed and re-created. i.e. ``vrf=NTC`` will create a VRF named NTC, but running it again with ``vrf=ntc`` will not cause a configuration change. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Ensure ntc VRF exists on switch + cisco.nxos.nxos_vrf: + name: ntc + description: testing + state: present + - name: Aggregate definition of VRFs + cisco.nxos.nxos_vrf: + aggregate: + - name: test1 + description: Testing + admin_state: down + - name: test2 + interfaces: Ethernet1/2 + - name: Aggregate definitions of VRFs with Purge + cisco.nxos.nxos_vrf: + aggregate: + - name: ntc1 + description: purge test1 + - name: ntc2 + description: purge test2 + state: present + purge: true + - name: Delete VRFs exist on switch + cisco.nxos.nxos_vrf: + aggregate: + - name: ntc1 + - name: ntc2 + state: absent + - name: Assign interfaces to VRF declaratively + cisco.nxos.nxos_vrf: + name: test1 + interfaces: + - Ethernet2/3 + - Ethernet2/5 + - name: Check interfaces assigned to VRF + cisco.nxos.nxos_vrf: + name: test1 + associated_interfaces: + - Ethernet2/3 + - Ethernet2/5 + - name: >- + Ensure VRF is tagged with interface Ethernet2/5 only (Removes from + Ethernet2/3) + cisco.nxos.nxos_vrf: + name: test1 + interfaces: + - Ethernet2/5 + - name: Delete VRF + cisco.nxos.nxos_vrf: + name: ntc + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['vrf context ntc', 'no shutdown', 'interface Ethernet1/2', 'no switchport', 'vrf member test2']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_vrrp_module.rst b/docs/cisco.nxos.nxos_vrrp_module.rst new file mode 100644 index 000000000..88183c5af --- /dev/null +++ b/docs/cisco.nxos.nxos_vrrp_module.rst @@ -0,0 +1,277 @@ +.. _cisco.nxos.nxos_vrrp_module: + + +******************** +cisco.nxos.nxos_vrrp +******************** + +**Manages VRRP configuration on NX-OS switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages VRRP configuration on NX-OS switches. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ admin_state + +
+ string +
+ 		+
    Choices: +
  • shutdown ←
    • +
  • no shutdown
    • +
  • default
    • +
+ 		+
Used to enable or disable the VRRP process.
+
+
+ authentication + +
+ string +
+ 		+ +
Clear text authentication string or 'default' keyword
+
+
+ group + +
+ string + / required +
+ 		+ +
VRRP group number.
+
+
+ interface + +
+ string + / required +
+ 		+ +
Full name of interface that is being managed for VRRP.
+
+
+ interval + +
+ string +
+ 		+ +
Time interval between advertisement or 'default' keyword
+
+
+ preempt + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable preempt.
+
+
+ priority + +
+ string +
+ 		+ +
VRRP priority or 'default' keyword
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specify desired state of the resource.
+
+
+ vip + +
+ string +
+ 		+ +
VRRP virtual IP address or 'default' keyword
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - VRRP feature needs to be enabled first on the system. + - SVIs must exist before using this module. + - Interface must be a L3 port before using this module. + - ``state=absent`` removes the VRRP group if it exists on the device. + - VRRP cannot be configured on loopback interfaces. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Ensure vrrp group 100 and vip 10.1.100.1 is on vlan10 + cisco.nxos.nxos_vrrp: + interface: vlan10 + group: 100 + vip: 10.1.100.1 + + - name: Ensure removal of the vrrp group config + cisco.nxos.nxos_vrrp: + interface: vlan10 + group: 100 + vip: 10.1.100.1 + state: absent + + - name: Re-config with more params + cisco.nxos.nxos_vrrp: + interface: vlan10 + group: 100 + vip: 10.1.100.1 + preempt: false + priority: 130 + authentication: AUTHKEY + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['interface vlan10', 'vrrp 150', 'address 10.1.15.1', 'authentication text testing', 'no shutdown']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vsan_module.rst b/docs/cisco.nxos.nxos_vsan_module.rst new file mode 100644 index 000000000..9baa64c68 --- /dev/null +++ b/docs/cisco.nxos.nxos_vsan_module.rst @@ -0,0 +1,225 @@ +.. _cisco.nxos.nxos_vsan_module: + + +******************** +cisco.nxos.nxos_vsan +******************** + +**Configuration of vsan for Cisco NXOS MDS Switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Configuration of vsan for Cisco MDS NXOS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ vsan + +
+ list + / elements=dictionary +
+ 		+ +
List of vsan details to be added or removed
+
+
+ id + +
+ integer + / required +
+ 		+ +
Vsan id
+
+
+ interface + +
+ list + / elements=string +
+ 		+ +
List of vsan's interfaces to be added
+
+
+ name + +
+ string +
+ 		+ +
Name of the vsan
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Removes the vsan if True
+
+
+ suspend + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
suspend the vsan if True
+
+
+ + +Notes +----- + +.. note:: + - Tested against Cisco MDS NX-OS 8.4(1) + + + +Examples +-------- + +.. code-block:: yaml + + - name: Test that vsan module works + cisco.nxos.nxos_vsan: + vsan: + - id: 922 + interface: + - fc1/1 + - fc1/2 + - port-channel 1 + name: vsan-SAN-A + remove: false + suspend: false + - id: 923 + interface: + - fc1/11 + - fc1/21 + - port-channel 2 + name: vsan-SAN-B + remove: false + suspend: true + - id: 1923 + name: vsan-SAN-Old + remove: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['terminal dont-ask', 'vsan database', 'vsan 922 interface fc1/40', 'vsan 922 interface port-channel 155', 'no terminal dont-ask']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) diff --git a/docs/cisco.nxos.nxos_vxlan_vtep_module.rst b/docs/cisco.nxos.nxos_vxlan_vtep_module.rst new file mode 100644 index 000000000..57fdc14a3 --- /dev/null +++ b/docs/cisco.nxos.nxos_vxlan_vtep_module.rst @@ -0,0 +1,332 @@ +.. _cisco.nxos.nxos_vxlan_vtep_module: + + +************************** +cisco.nxos.nxos_vxlan_vtep +************************** + +**Manages VXLAN Network Virtualization Endpoint (NVE).** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages VXLAN Network Virtualization Endpoint (NVE) overlay interface that terminates VXLAN tunnels. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ advertise_virtual_rmac + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
The advertise_virtual_rmac parameter lets BGP to use the VMAC with VIP as next-hop when advertising type-2 routes. Should be used together with advertise_pip parameter from cisco.nxos.nxos_bgp_address_family module.
+
+
+ description + +
+ string +
+ 		+ +
Description of the NVE interface.
+
+
+ global_ingress_replication_bgp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configures ingress replication protocol as bgp for all VNIs. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
+
+
+ global_mcast_group_L2 + +
+ string +
+ 		+ +
Global multicast IP prefix for L2 VNIs or the keyword 'default'. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
+
+
+ global_mcast_group_L3 + +
+ string +
+ 		+ +
Global multicast IP prefix for L3 VNIs or the keyword 'default'. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
+
+
+ global_suppress_arp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables ARP suppression for all VNIs. This is available on NX-OS 9K series running 9.2.x or higher.
+
+
+ host_reachability + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specify mechanism for host reachability advertisement. A Boolean value of 'true' indicates that BGP will be used for host reachability advertisement. A Boolean value of 'false' indicates that no protocol is used for host reachability advertisement. Other host reachability advertisement protocols (e.g. OpenFlow, controller, etc.) are not supported.
+
+
+ interface + +
+ string + / required +
+ 		+ +
Interface name for the VXLAN Network Virtualization Endpoint.
+
+
+ multisite_border_gateway_interface + +
+ string +
+
added in 1.1.0
+ 		+ +
Specify the loopback interface whose IP address should be used for the NVE Multisite Border-gateway Interface. This is available on specific Nexus 9000 series switches running NX-OS 7.0(3)I7(x) or higher. Specify "default" to remove an existing gateway config.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown the NVE interface.
+
+
+ source_interface + +
+ string +
+ 		+ +
Specify the loopback interface whose IP address should be used for the NVE interface.
+
+
+ source_interface_hold_down_time + +
+ string +
+ 		+ +
Suppresses advertisement of the NVE loopback address until the overlay has converged.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Determines whether the config should be present or not on the device.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - The module is used to manage NVE properties, not to create NVE interfaces. Use :ref:`cisco.nxos.nxos_interfaces ` if you wish to do so. + - ``state=absent`` removes the interface. + - Default, where supported, restores params default value. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_vxlan_vtep: + interface: nve1 + description: default + host_reachability: true + source_interface: Loopback0 + source_interface_hold_down_time: 30 + shutdown: default + multisite_border_gateway_interface: Loopback0 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['interface nve1', 'source-interface loopback0', 'source-interface hold-down-time 30', 'description simple description', 'shutdown', 'host-reachability protocol bgp', 'multisite border-gateway interface loopback0']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_zone_zoneset_module.rst b/docs/cisco.nxos.nxos_zone_zoneset_module.rst new file mode 100644 index 000000000..95ef4972a --- /dev/null +++ b/docs/cisco.nxos.nxos_zone_zoneset_module.rst @@ -0,0 +1,537 @@ +.. _cisco.nxos.nxos_zone_zoneset_module: + + +**************************** +cisco.nxos.nxos_zone_zoneset +**************************** + +**Configuration of zone/zoneset for Cisco NXOS MDS Switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Configuration of zone/zoneset for Cisco MDS NXOS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ zone_zoneset_details + +
+ list + / elements=dictionary +
+ 		+ +
List of zone/zoneset details to be added or removed
+
+
+ default_zone + +
+ string +
+ 		+
    Choices: +
  • permit
    • +
  • deny
    • +
+ 		+
default zone behaviour for the vsan
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • enhanced
    • +
  • basic
    • +
+ 		+
mode of the zone for the vsan
+
+
+ smart_zoning + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Removes the vsan if True
+
+
+ vsan + +
+ integer + / required +
+ 		+ +
vsan id
+
+
+ zone + +
+ list + / elements=dictionary +
+ 		+ +
List of zone options for that vsan
+
+
+ members + +
+ list + / elements=dictionary +
+ 		+ +
Members of the zone that needs to be removed or added
+
+
+ devtype + +
+ string +
+ 		+
    Choices: +
  • initiator
    • +
  • target
    • +
  • both
    • +
+ 		+
devtype of the zone member used along with Smart zoning config
+
+
+ pwwn + +
+ string + / required +
+ 		+ +
pwwn member of the zone, use alias 'device_alias' as option for device_alias member
+

aliases: device_alias
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Removes member from the zone if True
+
+
+ name + +
+ string + / required +
+ 		+ +
name of the zone
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Deletes the zone if True
+
+
+ zoneset + +
+ list + / elements=dictionary +
+ 		+ +
List of zoneset options for the vsan
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • activate
    • +
  • deactivate
    • +
+ 		+
activates/de-activates the zoneset
+
+
+ members + +
+ list + / elements=dictionary +
+ 		+ +
Members of the zoneset that needs to be removed or added
+
+
+ name + +
+ string + / required +
+ 		+ +
name of the zone that needs to be added to the zoneset or removed from the zoneset
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Removes zone member from the zoneset
+
+
+ name + +
+ string + / required +
+ 		+ +
name of the zoneset
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Removes zoneset if True
+
+
+ + +Notes +----- + +.. note:: + - Tested against Cisco MDS NX-OS 8.4(1) + + + +Examples +-------- + +.. code-block:: yaml + + - name: Test that zone/zoneset module works + cisco.nxos.nxos_zone_zoneset: + zone_zoneset_details: + - mode: enhanced + vsan: 22 + zone: + - members: + - pwwn: 31314874576271 + - device_alias: test123 + - pwwn: '61:61:62:62:12:12:12:12' + remove: true + name: zoneA + - members: + - pwwn: 28515514576271 + - pwwn: '62:62:62:62:21:21:21:21' + name: zoneB + - name: zoneC + remove: true + zoneset: + - action: activate + members: + - name: zoneA + - name: zoneB + - name: zoneC + remove: true + name: zsetname1 + - action: deactivate + name: zsetTestExtra + remove: true + - mode: basic + smart_zoning: true + vsan: 21 + zone: + - members: + - devtype: both + pwwn: 31314874576271 + - pwwn: '62:62:62:62:12:12:12:12' + - devtype: both + pwwn: '92:62:62:62:12:12:1a:1a' + remove: true + name: zone21A + - members: + - pwwn: 28515514576271 + - pwwn: '62:62:62:62:21:21:21:21' + name: zone21B + zoneset: + - action: activate + members: + - name: zone21A + - name: zone21B + name: zsetname212 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['terminal dont-ask', 'zone name zoneA vsan 923', 'member pwwn 11:11:11:11:11:11:11:11', 'no member device-alias test123', 'zone commit vsan 923', 'no terminal dont-ask']
+
+
+ messages + +
+ list +
+ 		always +
debug messages
+
+
Sample:
+
['zone mode is already enhanced ,no change in zone mode configuration for vsan 922', "zone member '11:11:11:11:11:11:11:11' is already present in zone 'zoneA' in vsan 922 hence nothing to add", "zone member 'test123' is already present in zone 'zoneA' in vsan 922 hence nothing to add", "zone member '61:61:62:62:12:12:12:12' is not present in zone 'zoneA' in vsan 922 hence nothing to remove", "zone member '10:11:11:11:11:11:11:11' is already present in zone 'zoneB' in vsan 922 hence nothing to add", "zone member '62:62:62:62:21:21:21:21' is already present in zone 'zoneB' in vsan 922 hence nothing to add", "zone 'zoneC' is not present in vsan 922 , so nothing to remove"]
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) diff --git a/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py index 0ecd94a36..b4aafb37a 100644 --- a/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py @@ -5,6 +5,7 @@ from __future__ import absolute_import, division, print_function + __metaclass__ = type ############################################# @@ -29,8 +30,7 @@ class Spanning_tree_globalArgs(object): # pylint: disable=R0903 - """The arg spec for the nxos_spanning_tree_global module - """ + """The arg spec for the nxos_spanning_tree_global module""" argument_spec = { "config": { diff --git a/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py index 533773294..1c4663861 100644 --- a/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py @@ -7,6 +7,7 @@ from __future__ import absolute_import, division, print_function + __metaclass__ = type """ @@ -20,15 +21,14 @@ from copy import deepcopy from ansible.module_utils.six import iteritems -from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import ( - dict_merge, -) from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.rm_base.resource_module import ( ResourceModule, ) -from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.facts.facts import ( - Facts, +from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import ( + dict_merge, ) + +from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.facts.facts import Facts from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.rm_templates.spanning_tree_global import ( Spanning_tree_globalTemplate, ) @@ -47,11 +47,10 @@ def __init__(self, module): resource="spanning_tree_global", tmplt=Spanning_tree_globalTemplate(), ) - self.parsers = [ - ] + self.parsers = [] def execute_module(self): - """ Execute the module + """Execute the module :rtype: A dictionary :returns: The result from module execution @@ -62,11 +61,11 @@ def execute_module(self): return self.result def generate_commands(self): - """ Generate configuration commands to send based on - want, have and desired state. + """Generate configuration commands to send based on + want, have and desired state. """ - wantd = {entry['name']: entry for entry in self.want} - haved = {entry['name']: entry for entry in self.have} + wantd = {entry["name"]: entry for entry in self.want} + haved = {entry["name"]: entry for entry in self.have} # if state is merged, merge want onto have and then compare if self.state == "merged": @@ -74,9 +73,7 @@ def generate_commands(self): # if state is deleted, empty out wantd and set haved to wantd if self.state == "deleted": - haved = { - k: v for k, v in iteritems(haved) if k in wantd or not wantd - } + haved = {k: v for k, v in iteritems(haved) if k in wantd or not wantd} wantd = {} # remove superfluous config for overridden and deleted @@ -90,8 +87,8 @@ def generate_commands(self): def _compare(self, want, have): """Leverages the base class `compare()` method and - populates the list of commands to be run by comparing - the `want` and `have` data with the `parsers` defined - for the Spanning_tree_global network resource. + populates the list of commands to be run by comparing + the `want` and `have` data with the `parsers` defined + for the Spanning_tree_global network resource. """ self.compare(parsers=self.parsers, want=want, have=have) diff --git a/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py index 660374104..971c68cbd 100644 --- a/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py @@ -5,6 +5,7 @@ from __future__ import absolute_import, division, print_function + __metaclass__ = type """ @@ -17,26 +18,31 @@ from copy import deepcopy from ansible.module_utils.six import iteritems -from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import ( - utils, +from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import utils + +from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.argspec.spanning_tree_global.spanning_tree_global import ( + Spanning_tree_globalArgs, ) from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.rm_templates.spanning_tree_global import ( Spanning_tree_globalTemplate, ) -from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.argspec.spanning_tree_global.spanning_tree_global import ( - Spanning_tree_globalArgs, -) + class Spanning_tree_globalFacts(object): - """ The nxos spanning_tree_global facts class - """ + """The nxos spanning_tree_global facts class""" - def __init__(self, module, subspec='config', options='options'): + def __init__(self, module, subspec="config", options="options"): self._module = module self.argument_spec = Spanning_tree_globalArgs.argument_spec + def get_config(self, connection): + """Wrapper method for `connection.get()` + This method exists solely to allow the unit test framework to mock device connection calls. + """ + return connection.get("show running-config | section '^spanning-tree'") + def populate_facts(self, connection, ansible_facts, data=None): - """ Populate the facts for Spanning_tree_global network resource + """Populate the facts for Spanning_tree_global network resource :param connection: the device connection :param ansible_facts: Facts dictionary @@ -49,19 +55,26 @@ def populate_facts(self, connection, ansible_facts, data=None): objs = [] if not data: - data = connection.get() + data = self.get_config(connection) # parse native config using the Spanning_tree_global template - spanning_tree_global_parser = Spanning_tree_globalTemplate(lines=data.splitlines(), module=self._module) + spanning_tree_global_parser = Spanning_tree_globalTemplate( + lines=data.splitlines(), + module=self._module, + ) objs = list(spanning_tree_global_parser.parse().values()) - ansible_facts['ansible_network_resources'].pop('spanning_tree_global', None) + ansible_facts["ansible_network_resources"].pop("spanning_tree_global", None) params = utils.remove_empties( - spanning_tree_global_parser.validate_config(self.argument_spec, {"config": objs}, redact=True) + spanning_tree_global_parser.validate_config( + self.argument_spec, + {"config": objs}, + redact=True, + ), ) - facts['spanning_tree_global'] = params['config'] - ansible_facts['ansible_network_resources'].update(facts) + facts["spanning_tree_global"] = params["config"] + ansible_facts["ansible_network_resources"].update(facts) return ansible_facts diff --git a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py index 3c0b1aeff..a1c45741b 100644 --- a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py @@ -5,6 +5,7 @@ from __future__ import absolute_import, division, print_function + __metaclass__ = type """ @@ -15,10 +16,12 @@ """ import re + from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.rm_base.network_template import ( NetworkTemplate, ) + class Spanning_tree_globalTemplate(NetworkTemplate): def __init__(self, lines=None, module=None): super(Spanning_tree_globalTemplate, self).__init__(lines=lines, tmplt=self, module=module) @@ -26,24 +29,29 @@ def __init__(self, lines=None, module=None): # fmt: off PARSERS = [ { - "name": "key_a", + "name": "bridge_assurance", "getval": re.compile( r""" - ^key_a\s(?P\S+) - $""", re.VERBOSE), - "setval": "", + ^spanning-tree + \sbridge\s(?Passurance) + $""", re.VERBOSE, + ), + "setval": "spanning-tree bridge assurance", "result": { + "bridge_assurance": "{{ True if assurance is defined else None }}", }, - "shared": True }, { - "name": "key_b", + "name": "mode", "getval": re.compile( r""" - \s+key_b\s(?P\S+) - $""", re.VERBOSE), - "setval": "", + ^spanning-tree + (\smode\s(?Pmst|rapid-pvst)) + $""", re.VERBOSE, + ), + "setval": "spanning-tree mode {{ mode }}", "result": { + "mode": "{{ mode }}", }, }, ] diff --git a/plugins/modules/nxos_spanning_tree_global.py b/plugins/modules/nxos_spanning_tree_global.py index 3215af314..48d030ed7 100644 --- a/plugins/modules/nxos_spanning_tree_global.py +++ b/plugins/modules/nxos_spanning_tree_global.py @@ -10,22 +10,20 @@ from __future__ import absolute_import, division, print_function + __metaclass__ = type DOCUMENTATION = """ +--- module: nxos_spanning_tree_global -extends_documentation_fragment: -- cisco.nxos.nxos -short_description: - - Resource module to configure spanning tree. -description: - - This module configures and manages the attributes of Spanning-tree on Cisco NXOS. +short_description: Resource module to configure spanning tree. +description: This module configures and manages the attributes of Spanning-tree on Cisco NXOS. version_added: 6.0.3 author: Vinay Mulugund (@roverflow) notes: - - Tested against NX-OS 9.3.6. - - This module works with connection C(network_cli) and C(httpapi). - See U(https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html) +- Tested against NX-OS 9.3.6. +- This module works with connection C(network_cli) and C(httpapi). + See U(https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html) options: config: description: A dict of Spanning-tree options. @@ -177,6 +175,7 @@ """ from ansible.module_utils.basic import AnsibleModule + from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.argspec.spanning_tree_global.spanning_tree_global import ( Spanning_tree_globalArgs, ) From 4aae7125b7fe04e3d86174620acdfc6b03c9f7aa Mon Sep 17 00:00:00 2001 From: Vinay Mulugund Date: Tue, 27 Feb 2024 23:29:47 +0530 Subject: [PATCH 04/30] symlink --- plugins/action/spanning_tree_global.py | 1 + 1 file changed, 1 insertion(+) create mode 120000 plugins/action/spanning_tree_global.py diff --git a/plugins/action/spanning_tree_global.py b/plugins/action/spanning_tree_global.py new file mode 120000 index 000000000..a69e27103 --- /dev/null +++ b/plugins/action/spanning_tree_global.py @@ -0,0 +1 @@ +nxos.py \ No newline at end of file From 48b4ab10b24a20be6bd8b9c6e96b2ebd9ae1dc6a Mon Sep 17 00:00:00 2001 From: Vinay Mulugund Date: Tue, 27 Feb 2024 23:31:36 +0530 Subject: [PATCH 05/30] changelog --- changelogs/fragments/spanning_tree_global.yml | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 changelogs/fragments/spanning_tree_global.yml diff --git a/changelogs/fragments/spanning_tree_global.yml b/changelogs/fragments/spanning_tree_global.yml new file mode 100644 index 000000000..082c8004b --- /dev/null +++ b/changelogs/fragments/spanning_tree_global.yml @@ -0,0 +1,3 @@ +--- +major_changes: + - spanning_tree_global - add a new resource module for nxos spanning tree global configuration. From 7961a6cac5db19c930f4100f633edbb330531149 Mon Sep 17 00:00:00 2001 From: Vinay Mulugund Date: Wed, 28 Feb 2024 10:47:55 +0530 Subject: [PATCH 06/30] Added more parsers --- .../nxos/rm_templates/spanning_tree_global.py | 53 +++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py index a1c45741b..22ad44fc0 100644 --- a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py @@ -41,6 +41,59 @@ def __init__(self, lines=None, module=None): "bridge_assurance": "{{ True if assurance is defined else None }}", }, }, + { + "name": "bridge_domain", + "getval": re.compile( + r""" + ^spanning-tree + \sbridge-domain\s(?P\S+) + $""", re.VERBOSE, + ), + "setval": "spanning-tree bridge-domain {{ range }}", + "result": { + "bridge_domain": "{{ range }}", + }, + }, + { + "name": "fcoe", + "getval": re.compile( + r""" + ^spanning-tree + \s(?Pfcoe) + $""", re.VERBOSE, + ), + "setval": "spanning-tree fcoe", + "result": { + "fcoe": "{{ True if fcoe is defined else None }}", + }, + }, + { + "name": "lc_issu", + "getval": re.compile( + r""" + ^spanning-tree + \slc-issu\s(?Pauto|disruptive|non-disruptive) + $""", re.VERBOSE, + ), + "setval": "spanning-tree lc-issu {{ lc_issu }}", + "result": { + "lc_issu": "{{ lc_issu }}", + }, + }, + { + "name": "loopguard_default", + "getval": re.compile( + r""" + ^spanning-tree + \sloopguard + \s(?Pdefault) + $""", re.VERBOSE, + ), + "setval": "spanning-tree loopguard default", + "result": { + "loopguard_default": "{{ True if default is defined else None }}", + }, + }, { "name": "mode", "getval": re.compile( From 29889faa0be2a9d3b6d5e3fcf93e0dc539cfd525 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 28 Feb 2024 05:18:40 +0000 Subject: [PATCH 07/30] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .../network/nxos/rm_templates/spanning_tree_global.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py index 22ad44fc0..d2ceb8ee7 100644 --- a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py @@ -78,7 +78,7 @@ def __init__(self, lines=None, module=None): "setval": "spanning-tree lc-issu {{ lc_issu }}", "result": { "lc_issu": "{{ lc_issu }}", - }, + }, }, { "name": "loopguard_default", @@ -92,7 +92,7 @@ def __init__(self, lines=None, module=None): "setval": "spanning-tree loopguard default", "result": { "loopguard_default": "{{ True if default is defined else None }}", - }, + }, }, { "name": "mode", From a5b3f28c5decbd9d6dde95ab51028a4e428b3859 Mon Sep 17 00:00:00 2001 From: Vinay Mulugund Date: Thu, 7 Mar 2024 18:45:27 +0530 Subject: [PATCH 08/30] changed argspec --- .../spanning_tree_global.py | 147 ++++++++++- plugins/modules/nxos_spanning_tree_global.py | 235 ++++++++++++++++-- 2 files changed, 361 insertions(+), 21 deletions(-) diff --git a/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py index b4aafb37a..602d5a6f4 100644 --- a/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py @@ -5,7 +5,6 @@ from __future__ import absolute_import, division, print_function - __metaclass__ = type ############################################# @@ -30,14 +29,63 @@ class Spanning_tree_globalArgs(object): # pylint: disable=R0903 - """The arg spec for the nxos_spanning_tree_global module""" + """The arg spec for the nxos_spanning_tree_global module + """ argument_spec = { "config": { "type": "dict", "options": { - "bridge_assurance": {"type": "bool"}, - "bridge_domain": {"type": "str"}, + "bridge": { + "type": "dict", + "options": { + "bridge_assurance": {"type": "bool"}, + "bridge_domain": { + "type": "dict", + "options": { + "bd_list_range": {"type": "str"}, + "forward_time": {"type": "int"}, + "hello_time": {"type": "int"}, + "max_age": {"type": "int"}, + "priority": {"type": "int"}, + "root": { + "type": "dict", + "mutually_exclusive": [ + ["primary", "secondary"] + ], + "options": { + "primary": { + "type": "dict", + "options": { + "enable": {"type": "bool"}, + "diameter": {"type": "int"}, + "hello_time": {"type": "int"}, + }, + }, + "secondary": { + "type": "dict", + "options": { + "enable": {"type": "bool"}, + "diameter": {"type": "int"}, + "hello_time": {"type": "int"}, + }, + }, + }, + }, + }, + }, + }, + }, + "domain": { + "type": "dict", + "mutually_exclusive": [["identifier", "disable", "enable"]], + "options": { + "identifier": {"type": "int"}, + "disable": {"type": "bool"}, + "enable": {"type": "bool"}, + "clear_stats": {"type": "bool"}, + }, + }, "fcoe": {"type": "bool"}, "lc_issu": { "type": "str", @@ -45,6 +93,32 @@ class Spanning_tree_globalArgs(object): # pylint: disable=R0903 }, "loopguard_default": {"type": "bool"}, "mode": {"type": "str", "choices": ["mst", "rapid-pvst"]}, + "mst": { + "type": "dict", + "options": { + "forward-time": {"type": "int"}, + "hello-time": {"type": "int"}, + "max_age": {"type": "int"}, + "max_hops": {"type": "int"}, + "simulate_pvst_global": {"type": "bool"}, + "configure_mst": { + "type": "list", + "elements": "dict", + "options": { + "name": {"type": "str"}, + "revision": {"type": "int"}, + "private_vlan_sync": {"type": "bool"}, + "instance_vlan": { + "type": "dict", + "options": { + "instance_id": {"type": "int"}, + "vlan_range": {"type": "str"}, + }, + }, + }, + }, + }, + }, "pathcost_method": {"type": "str", "choices": ["long", "short"]}, "port_type": { "type": "dict", @@ -58,7 +132,70 @@ class Spanning_tree_globalArgs(object): # pylint: disable=R0903 "default": {"type": "bool"}, }, }, - "vlan": {"type": "str"}, + "pseudo_info": { + "type": "dict", + "options": { + "bridge_domain_info": { + "type": "dict", + "mutually_exclusive": [["designated", "root"]], + "options": { + "range": {"type": "str"}, + "designated_priority": {"type": "int"}, + "root_priority": {"type": "int\\"}, + }, + }, + "mst_info": { + "type": "dict", + "mutually_exclusive": [["designated", "root"]], + "options": { + "range": {"type": "str"}, + "designated_priority": {"type": "int"}, + "root_priority": {"type": "int"}, + }, + }, + "vlan_info": { + "type": "dict", + "mutually_exclusive": [["designated", "root"]], + "options": { + "range": {"type": "str"}, + "designated_priority": {"type": "int"}, + "root_priority": {"type": "int"}, + }, + }, + }, + }, + "vlan": { + "type": "dict", + "options": { + "vlan_range": {"type": "str"}, + "forward_time": {"type": "int"}, + "hello_time": {"type": "int"}, + "max_age": {"type": "int"}, + "priority": {"type": "int"}, + "root": { + "type": "dict", + "mutually_exclusive": [["primary", "secondary"]], + "options": { + "primary": { + "type": "dict", + "options": { + "enable": {"type": "bool"}, + "diameter": {"type": "int"}, + "hello_time": {"type": "int"}, + }, + }, + "secondary": { + "type": "dict", + "options": { + "enable": {"type": "bool"}, + "diameter": {"type": "int"}, + "hello_time": {"type": "int"}, + }, + }, + }, + }, + }, + }, }, }, "running_config": {"type": "str"}, diff --git a/plugins/modules/nxos_spanning_tree_global.py b/plugins/modules/nxos_spanning_tree_global.py index 48d030ed7..fc4066fc6 100644 --- a/plugins/modules/nxos_spanning_tree_global.py +++ b/plugins/modules/nxos_spanning_tree_global.py @@ -10,31 +10,99 @@ from __future__ import absolute_import, division, print_function - __metaclass__ = type DOCUMENTATION = """ ---- module: nxos_spanning_tree_global -short_description: Resource module to configure spanning tree. -description: This module configures and manages the attributes of Spanning-tree on Cisco NXOS. +short_description: + - Resource module to configure spanning tree. +description: + - This module configures and manages the attributes of Spanning-tree on Cisco NXOS. version_added: 6.0.3 author: Vinay Mulugund (@roverflow) notes: -- Tested against NX-OS 9.3.6. -- This module works with connection C(network_cli) and C(httpapi). - See U(https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html) + - Tested against NX-OS 9.3.6. + - This module works with connection C(network_cli) and C(httpapi). + See U(https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html) options: config: description: A dict of Spanning-tree options. type: dict suboptions: - bridge_assurance: - description: Enable bridge assurance. - type: bool - bridge_domain: - decsription: Bridge-Domain Spanning Trees range. - type: str + bridge: + description: Bridge options in spanning-tree. + type: dict + suboptions: + bridge_assurance: + description: Enable bridge assurance. + type: bool + bridge_domain: + decsription: Bridge-Domain Spanning Trees range. + type: dict + suboptions: + bd_list_range: + description: Bridge-Domain Spanning Trees range. + type: str + forward_time: + description: Forward time for bridge domain. + type: int + hello_time: + description: Hello time for bridge domain. + type: int + max_age: + description: Max age for bridge domain. + type: int + priority: + description: Priority for bridge domain. + type: int + root: + description: Configure switch as root. + type: dict + mutually_exclusive: [["primary", "secondary"]] + suboptions: + primary: + description: Configure primary root. + type: dict + suboptions: + enable: + description: Enable primary root. + type: bool + diameter: + description: Priority for primary root. + type: int + hello_time: + description: Configure secondary root. + type: int + secondary: + description: Configure secondary root. + type: dict + suboptions: + enable: + description: Enable primary root. + type: bool + diameter: + description: Priority for primary root. + type: int + hello_time: + description: Configure secondary root. + type: int + domain: + description: Spanning tree domain options. + type: dict + mutually_exclusive: [["identifier", "disable", "enable"]] + suboptions: + identifier: + description: Spanning tree domain identifier. + type: int + disable: + description: Disable spanning tree domain. + type: bool + enable: + description: Enable spanning tree domain. + type: bool + clear_stats: + description: Clear spanning tree domain statistics. + type: bool fcoe: description: Enable STP for FCoE VLANs. type: bool @@ -54,6 +122,49 @@ choices: - mst - rapid-pvst + mst: + description: Multiple spanning tree configuration. + type: dict + suboptions: + forward-time: + description: Forward time for MST. + type: int + hello-time: + description: Hello time for MST. + type: int + max_age: + description: Max age for MST. + type: int + max_hops: + description: Max hops for MST. + type: int + simulate_pvst_global: + description: Enable Simulate PVST global. + type: bool + configure_mst: + description: MST configuration submode options. + type: list + elements: dict + suboptions: + name: + description: MST configuration submode instance name. + type: str + revision: + description: MST configuration submode instance revision. + type: int + private_vlan_sync: + description: MST configuration submode private vlan sync. + type: bool + instance_vlan: + description: MST configuration submode instance. + type: dict + suboptions: + instance_id: + description: MST configuration submode instance id. + type: int + vlan_range: + description: MST configuration submode instance vlan range. + type: str pathcost_method: description: Spanning tree pathcost options. type: str @@ -78,9 +189,102 @@ default: description: Enable default port type. type: bool + pseudo_info: + description: Configure spanning tree pseudo information + type: dict + suboptions: + bridge_domain_info: + description: Pseudo information bridge domain. + type: dict + mutually_exclusive: [["designated", "root"]] + suboptions: + range: + description: Pseudo information bridge domain range. + type: str + designated_priority: + description: Pseudo information bridge domain designated priority. + type: int + root_priority: + description: Pseudo information bridge domain root priority. + type: int\ + mst_info: + description: Pseudo information MST. + type: dict + mutually_exclusive: [["designated", "root"]] + suboptions: + range: + description: Pseudo information MST range. + type: str + designated_priority: + description: Pseudo information MST designated priority. + type: int + root_priority: + description: Pseudo information MST root priority. + type: int + vlan_info: + description: Pseudo information MST. + type: dict + mutually_exclusive: [["designated", "root"]] + suboptions: + range: + description: Pseudo information MST range. + type: str + designated_priority: + description: Pseudo information MST designated priority. + type: int + root_priority: + description: Pseudo information MST root priority. + type: int vlan: - description: Spanning tree VLAN range. - type: str + description: VLAN Switch Spanning Trees. + type: dict + suboptions: + vlan_range: + description: VLAN range for spanning tree. + type: str + forward_time: + description: Forward time for VLAN. + type: int + hello_time: + description: Hello time for VLAN. + type: int + max_age: + description: Max age for VLAN. + type: int + priority: + description: Priority for VLAN. + type: int + root: + description: Configure switch as root. + type: dict + mutually_exclusive: [["primary", "secondary"]] + suboptions: + primary: + description: Configure primary root. + type: dict + suboptions: + enable: + description: Enable primary root. + type: bool + diameter: + description: Priority for primary root. + type: int + hello_time: + description: Configure secondary root. + type: int + secondary: + description: Configure secondary root. + type: dict + suboptions: + enable: + description: Enable primary root. + type: bool + diameter: + description: Priority for primary root. + type: int + hello_time: + description: Configure secondary root. + type: int running_config: description: - This option is used only with state I(parsed). @@ -175,7 +379,6 @@ """ from ansible.module_utils.basic import AnsibleModule - from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.argspec.spanning_tree_global.spanning_tree_global import ( Spanning_tree_globalArgs, ) From 432118a273f8bd1dbdcf9c6b620136112d326067 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 7 Mar 2024 13:17:59 +0000 Subject: [PATCH 09/30] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- ...cisco.nxos.nxos_aaa_server_host_module.rst | 343 - docs/cisco.nxos.nxos_aaa_server_module.rst | 248 - .../cisco.nxos.nxos_acl_interfaces_module.rst | 610 -- docs/cisco.nxos.nxos_acls_module.rst | 4086 ------------ docs/cisco.nxos.nxos_banner_module.rst | 187 - docs/cisco.nxos.nxos_bfd_global_module.rst | 326 - .../cisco.nxos.nxos_bfd_interfaces_module.rst | 394 -- docs/cisco.nxos.nxos_bgp_global_module.rst | 5843 ----------------- ...xos_bgp_neighbor_address_family_module.rst | 3575 ---------- docs/cisco.nxos.nxos_bgp_templates_module.rst | 2841 -------- docs/cisco.nxos.nxos_command_module.rst | 258 - docs/cisco.nxos.nxos_config_module.rst | 566 -- docs/cisco.nxos.nxos_devicealias_module.rst | 273 - docs/cisco.nxos.nxos_evpn_global_module.rst | 122 - docs/cisco.nxos.nxos_evpn_vni_module.rst | 212 - docs/cisco.nxos.nxos_facts_module.rst | 553 -- docs/cisco.nxos.nxos_feature_module.rst | 150 - docs/cisco.nxos.nxos_gir_module.rst | 302 - ...xos.nxos_gir_profile_management_module.rst | 235 - docs/cisco.nxos.nxos_hostname_module.rst | 344 - ...cisco.nxos.nxos_hsrp_interfaces_module.rst | 344 - docs/cisco.nxos.nxos_hsrp_module.rst | 305 - docs/cisco.nxos.nxos_igmp_module.rst | 191 - docs/cisco.nxos.nxos_igmp_snooping_module.rst | 225 - docs/cisco.nxos.nxos_install_os_module.rst | 183 - docs/cisco.nxos.nxos_l2_interfaces_module.rst | 648 -- docs/cisco.nxos.nxos_l3_interfaces_module.rst | 884 --- docs/cisco.nxos.nxos_lacp_module.rst | 402 -- ...cisco.nxos.nxos_lldp_interfaces_module.rst | 407 -- docs/cisco.nxos.nxos_logging_module.rst | 458 -- docs/cisco.nxos.nxos_ntp_auth_module.rst | 224 - docs/cisco.nxos.nxos_ntp_global_module.rst | 1411 ---- docs/cisco.nxos.nxos_ntp_module.rst | 314 - docs/cisco.nxos.nxos_ntp_options_module.rst | 192 - docs/cisco.nxos.nxos_nxapi_module.rst | 300 - ...cisco.nxos.nxos_ospf_interfaces_module.rst | 1732 ----- docs/cisco.nxos.nxos_ospfv2_module.rst | 5458 --------------- .../cisco.nxos.nxos_overlay_global_module.rst | 120 - docs/cisco.nxos.nxos_pim_module.rst | 148 - docs/cisco.nxos.nxos_ping_module.rst | 311 - docs/cisco.nxos.nxos_prefix_lists_module.rst | 1049 --- docs/cisco.nxos.nxos_reboot_module.rst | 123 - docs/cisco.nxos.nxos_rollback_module.rst | 159 - docs/cisco.nxos.nxos_route_maps_module.rst | 4368 ------------ docs/cisco.nxos.nxos_rpm_module.rst | 226 - docs/cisco.nxos.nxos_snapshot_module.rst | 363 - .../cisco.nxos.nxos_snmp_community_module.rst | 201 - docs/cisco.nxos.nxos_snmp_host_module.rst | 288 - docs/cisco.nxos.nxos_snmp_location_module.rst | 156 - docs/cisco.nxos.nxos_snmp_server_module.rst | 4474 ------------- docs/cisco.nxos.nxos_snmp_traps_module.rst | 189 - docs/cisco.nxos.nxos_snmp_user_module.rst | 235 - ....nxos.nxos_spanning_tree_global_module.rst | 473 -- .../cisco.nxos.nxos_udld_interface_module.rst | 250 - docs/cisco.nxos.nxos_udld_module.rst | 256 - docs/cisco.nxos.nxos_user_module.rst | 390 -- docs/cisco.nxos.nxos_vpc_module.rst | 352 - docs/cisco.nxos.nxos_vrf_af_module.rst | 300 - docs/cisco.nxos.nxos_vrf_module.rst | 494 -- docs/cisco.nxos.nxos_vrrp_module.rst | 277 - docs/cisco.nxos.nxos_vsan_module.rst | 225 - docs/cisco.nxos.nxos_vxlan_vtep_module.rst | 332 - docs/cisco.nxos.nxos_zone_zoneset_module.rst | 537 -- 63 files changed, 51442 deletions(-) delete mode 100644 docs/cisco.nxos.nxos_aaa_server_host_module.rst delete mode 100644 docs/cisco.nxos.nxos_aaa_server_module.rst delete mode 100644 docs/cisco.nxos.nxos_acl_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_acls_module.rst delete mode 100644 docs/cisco.nxos.nxos_banner_module.rst delete mode 100644 docs/cisco.nxos.nxos_bfd_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_bfd_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_bgp_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst delete mode 100644 docs/cisco.nxos.nxos_bgp_templates_module.rst delete mode 100644 docs/cisco.nxos.nxos_command_module.rst delete mode 100644 docs/cisco.nxos.nxos_config_module.rst delete mode 100644 docs/cisco.nxos.nxos_devicealias_module.rst delete mode 100644 docs/cisco.nxos.nxos_evpn_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_evpn_vni_module.rst delete mode 100644 docs/cisco.nxos.nxos_facts_module.rst delete mode 100644 docs/cisco.nxos.nxos_feature_module.rst delete mode 100644 docs/cisco.nxos.nxos_gir_module.rst delete mode 100644 docs/cisco.nxos.nxos_gir_profile_management_module.rst delete mode 100644 docs/cisco.nxos.nxos_hostname_module.rst delete mode 100644 docs/cisco.nxos.nxos_hsrp_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_hsrp_module.rst delete mode 100644 docs/cisco.nxos.nxos_igmp_module.rst delete mode 100644 docs/cisco.nxos.nxos_igmp_snooping_module.rst delete mode 100644 docs/cisco.nxos.nxos_install_os_module.rst delete mode 100644 docs/cisco.nxos.nxos_l2_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_l3_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_lacp_module.rst delete mode 100644 docs/cisco.nxos.nxos_lldp_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_logging_module.rst delete mode 100644 docs/cisco.nxos.nxos_ntp_auth_module.rst delete mode 100644 docs/cisco.nxos.nxos_ntp_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_ntp_module.rst delete mode 100644 docs/cisco.nxos.nxos_ntp_options_module.rst delete mode 100644 docs/cisco.nxos.nxos_nxapi_module.rst delete mode 100644 docs/cisco.nxos.nxos_ospf_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_ospfv2_module.rst delete mode 100644 docs/cisco.nxos.nxos_overlay_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_pim_module.rst delete mode 100644 docs/cisco.nxos.nxos_ping_module.rst delete mode 100644 docs/cisco.nxos.nxos_prefix_lists_module.rst delete mode 100644 docs/cisco.nxos.nxos_reboot_module.rst delete mode 100644 docs/cisco.nxos.nxos_rollback_module.rst delete mode 100644 docs/cisco.nxos.nxos_route_maps_module.rst delete mode 100644 docs/cisco.nxos.nxos_rpm_module.rst delete mode 100644 docs/cisco.nxos.nxos_snapshot_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_community_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_host_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_location_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_server_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_traps_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_user_module.rst delete mode 100644 docs/cisco.nxos.nxos_spanning_tree_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_udld_interface_module.rst delete mode 100644 docs/cisco.nxos.nxos_udld_module.rst delete mode 100644 docs/cisco.nxos.nxos_user_module.rst delete mode 100644 docs/cisco.nxos.nxos_vpc_module.rst delete mode 100644 docs/cisco.nxos.nxos_vrf_af_module.rst delete mode 100644 docs/cisco.nxos.nxos_vrf_module.rst delete mode 100644 docs/cisco.nxos.nxos_vrrp_module.rst delete mode 100644 docs/cisco.nxos.nxos_vsan_module.rst delete mode 100644 docs/cisco.nxos.nxos_vxlan_vtep_module.rst delete mode 100644 docs/cisco.nxos.nxos_zone_zoneset_module.rst diff --git a/docs/cisco.nxos.nxos_aaa_server_host_module.rst b/docs/cisco.nxos.nxos_aaa_server_host_module.rst deleted file mode 100644 index 5730e6359..000000000 --- a/docs/cisco.nxos.nxos_aaa_server_host_module.rst +++ /dev/null @@ -1,343 +0,0 @@ -.. _cisco.nxos.nxos_aaa_server_host_module: - - -******************************* -cisco.nxos.nxos_aaa_server_host -******************************* - -**Manages AAA server host-specific configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages AAA server host-specific configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- acct_port - -
- string -
- 		- -
Alternate UDP port for RADIUS accounting or keyword 'default'.
-
-
- address - -
- string - / required -
- 		- -
Address or name of the radius or tacacs host.
-
-
- auth_port - -
- string -
- 		- -
Alternate UDP port for RADIUS authentication or keyword 'default'.
-
-
- encrypt_type - -
- string -
- 		-
    Choices: -
  • 0
    • -
  • 7
    • -
- 		-
The state of encryption applied to the entered key. O for clear text, 7 for encrypted. Type-6 encryption is not supported.
-
-
- host_timeout - -
- string -
- 		- -
Timeout period for specified host, in seconds or keyword 'default. Range is 1-60.
-
-
- key - -
- string -
- 		- -
Shared secret for the specified host or keyword 'default'.
-
-
- server_type - -
- string - / required -
- 		-
    Choices: -
  • radius
    • -
  • tacacs
    • -
- 		-
The server type is either radius or tacacs.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- tacacs_port - -
- string -
- 		- -
Alternate TCP port TACACS Server or keyword 'default'.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - Changes to the host key (shared secret) are not idempotent for type 0. - - If ``state=absent`` removes the whole host configuration. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Radius Server Host Basic settings - - name: Radius Server Host Basic settings - cisco.nxos.nxos_aaa_server_host: - state: present - server_type: radius - address: 1.2.3.4 - acct_port: 2084 - host_timeout: 10 - - # Radius Server Host Key Configuration - - name: Radius Server Host Key Configuration - cisco.nxos.nxos_aaa_server_host: - state: present - server_type: radius - address: 1.2.3.4 - key: hello - encrypt_type: 7 - - # TACACS Server Host Configuration - - name: Tacacs Server Host Configuration - cisco.nxos.nxos_aaa_server_host: - state: present - server_type: tacacs - tacacs_port: 89 - host_timeout: 10 - address: 5.6.7.8 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- end_state - -
- dictionary -
- 		always -
k/v pairs of configuration after module execution
-
-
Sample:
-
{'address': '1.2.3.4', 'auth_port': '2084', 'host_timeout': '10', 'server_type': 'radius'}
-
-
- existing - -
- dictionary -
- 		always -
k/v pairs of existing configuration
-
-
-
- proposed - -
- dictionary -
- 		always -
k/v pairs of parameters passed into module
-
-
Sample:
-
{'address': '1.2.3.4', 'auth_port': '2084', 'host_timeout': '10', 'server_type': 'radius'}
-
-
- updates - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['radius-server host 1.2.3.4 auth-port 2084 timeout 10']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_aaa_server_module.rst b/docs/cisco.nxos.nxos_aaa_server_module.rst deleted file mode 100644 index 1307c9033..000000000 --- a/docs/cisco.nxos.nxos_aaa_server_module.rst +++ /dev/null @@ -1,248 +0,0 @@ -.. _cisco.nxos.nxos_aaa_server_module: - - -************************** -cisco.nxos.nxos_aaa_server -************************** - -**Manages AAA server global configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages AAA server global configuration - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- deadtime - -
- string -
- 		- -
Duration for which a non-reachable AAA server is skipped, in minutes or keyword 'default. Range is 1-1440. Device default is 0.
-
-
- directed_request - -
- string -
- 		-
    Choices: -
  • enabled
    • -
  • disabled
    • -
  • default
    • -
- 		-
Enables direct authentication requests to AAA server or keyword 'default' Device default is disabled.
-
-
- encrypt_type - -
- string -
- 		-
    Choices: -
  • 0
    • -
  • 7
    • -
- 		-
The state of encryption applied to the entered global key. O clear text, 7 encrypted. Type-6 encryption is not supported.
-
-
- global_key - -
- string -
- 		- -
Global AAA shared secret or keyword 'default'.
-
-
- server_timeout - -
- string -
- 		- -
Global AAA server timeout period, in seconds or keyword 'default. Range is 1-60. Device default is 5.
-
-
- server_type - -
- string - / required -
- 		-
    Choices: -
  • radius
    • -
  • tacacs
    • -
- 		-
The server type is either radius or tacacs.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • default
    • -
- 		-
Manage the state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - The server_type parameter is always required. - - If encrypt_type is not supplied, the global AAA server key will be stored as encrypted (type 7). - - Changes to the global AAA server key with encrypt_type=0 are not idempotent. - - state=default will set the supplied parameters to their default values. The parameters that you want to default must also be set to default. If global_key=default, the global key will be removed. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Radius Server Basic settings - - name: Radius Server Basic settings - cisco.nxos.nxos_aaa_server: - server_type: radius - server_timeout: 9 - deadtime: 20 - directed_request: enabled - - # Tacacs Server Basic settings - - name: Tacacs Server Basic settings - cisco.nxos.nxos_aaa_server: - server_type: tacacs - server_timeout: 8 - deadtime: 19 - directed_request: disabled - - # Setting Global Key - - name: AAA Server Global Key - cisco.nxos.nxos_aaa_server: - server_type: radius - global_key: test_key - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['radius-server deadtime 22', 'radius-server timeout 11', 'radius-server directed-request']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_acl_interfaces_module.rst b/docs/cisco.nxos.nxos_acl_interfaces_module.rst deleted file mode 100644 index a2885df02..000000000 --- a/docs/cisco.nxos.nxos_acl_interfaces_module.rst +++ /dev/null @@ -1,610 +0,0 @@ -.. _cisco.nxos.nxos_acl_interfaces_module: - - -****************************** -cisco.nxos.nxos_acl_interfaces -****************************** - -**ACL interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Add and remove Access Control Lists on interfaces in NX-OS platform - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of interfaces to be configured with ACLs
-
-
- access_groups - -
- list - / elements=dictionary -
- 		- -
List of address family indicators with ACLs to be configured on the interface
-
-
- acls - -
- list - / elements=dictionary -
- 		- -
List of Access Control Lists for the interface
-
-
- direction - -
- string - / required -
- 		-
    Choices: -
  • in
    • -
  • out
    • -
- 		-
Direction to be applied for the ACL
-
-
- name - -
- string - / required -
- 		- -
Name of the ACL to be added/removed
-
-
- port - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use ACL as port policy.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
Address Family Indicator of the ACLs to be configured
-
-
- name - -
- string - / required -
- 		- -
Name of the interface
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • deleted
    • -
  • gathered
    • -
  • merged ←
    • -
  • overridden
    • -
  • rendered
    • -
  • replaced
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------ - # - - - name: Merge ACL interfaces configuration - cisco.nxos.nxos_acl_interfaces: - config: - - name: Ethernet1/2 - access_groups: - - afi: ipv6 - acls: - - name: ACL1v6 - direction: in - - - name: Eth1/5 - access_groups: - - afi: ipv4 - acls: - - name: PortACL - direction: in - port: true - - - name: ACL1v4 - direction: out - - - afi: ipv6 - acls: - - name: ACL1v6 - direction: in - state: merged - - # After state: - # ------------ - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ip port access-group PortACL in - # ip access-group ACL1v4 out - # ipv6 traffic-filter ACL1v6 in - - # Using replaced - - # Before state: - # ------------ - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ip port access-group PortACL in - # ip access-group ACL1v4 out - # ipv6 traffic-filter ACL1v6 in - - - name: Replace interface configuration with given configuration - cisco.nxos.nxos_acl_interfaces: - config: - - name: Eth1/5 - access_groups: - - afi: ipv4 - acls: - - name: NewACLv4 - direction: out - - - name: Ethernet1/3 - access_groups: - - afi: ipv6 - acls: - - name: NewACLv6 - direction: in - port: true - state: replaced - - # After state: - # ------------ - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/3 - # ipv6 port traffic-filter NewACLv6 in - # interface Ethernet1/5 - # ip access-group NewACLv4 out - - # Using overridden - - # Before state: - # ------------ - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ip port access-group PortACL in - # ip access-group ACL1v4 out - # ipv6 traffic-filter ACL1v6 in - - - name: Override interface configuration with given configuration - cisco.nxos.nxos_acl_interfaces: - config: - - name: Ethernet1/3 - access_groups: - - afi: ipv4 - acls: - - name: ACL1v4 - direction: out - - - name: PortACL - port: true - direction: in - - afi: ipv6 - acls: - - name: NewACLv6 - direction: in - port: true - state: overridden - - # After state: - # ------------ - # interface Ethernet1/3 - # ip access-group ACL1v4 out - # ip port access-group PortACL in - # ipv6 port traffic-filter NewACLv6 in - - # Using deleted to remove ACL config from specified interfaces - - # Before state: - # ------------- - # interface Ethernet1/1 - # ip access-group ACL2v4 in - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ip port access-group PortACL in - # ip access-group ACL1v4 out - # ipv6 traffic-filter ACL1v6 in - - - name: Delete ACL configuration on interfaces - cisco.nxos.nxos_acl_interfaces: - config: - - name: Ethernet1/5 - - name: Ethernet1/2 - state: deleted - - # After state: - # ------------- - # interface Ethernet1/1 - # ip access-group ACL2v4 in - # interface Ethernet1/2 - # interface Ethernet1/5 - - # Using deleted to remove ACL config from all interfaces - - # Before state: - # ------------- - # interface Ethernet1/1 - # ip access-group ACL2v4 in - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ip port access-group PortACL in - # ip access-group ACL1v4 out - # ipv6 traffic-filter ACL1v6 in - - - name: Delete ACL configuration from all interfaces - cisco.nxos.nxos_acl_interfaces: - state: deleted - - # After state: - # ------------- - # interface Ethernet1/1 - # interface Ethernet1/2 - # interface Ethernet1/5 - - # Using parsed - - - name: Parse given configuration into structured format - cisco.nxos.nxos_acl_interfaces: - running_config: | - interface Ethernet1/2 - ipv6 traffic-filter ACL1v6 in - interface Ethernet1/5 - ipv6 traffic-filter ACL1v6 in - ip access-group ACL1v4 out - ip port access-group PortACL in - state: parsed - - # returns - # parsed: - # - name: Ethernet1/2 - # access_groups: - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # direction: in - # - name: Ethernet1/5 - # access_groups: - # - afi: ipv4 - # acls: - # - name: PortACL - # direction: in - # port: True - # - name: ACL1v4 - # direction: out - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # direction: in - - - # Using gathered: - - # Before state: - # ------------ - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ipv6 traffic-filter ACL1v6 in - # ip access-group ACL1v4 out - # ip port access-group PortACL in - - - name: Gather existing configuration from device - cisco.nxos.nxos_acl_interfaces: - config: - state: gathered - - # returns - # gathered: - # - name: Ethernet1/2 - # access_groups: - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # direction: in - # - name: Ethernet1/5 - # access_groups: - # - afi: ipv4 - # acls: - # - name: PortACL - # direction: in - # port: True - # - name: ACL1v4 - # direction: out - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # direction: in - - - # Using rendered - - - name: Render required configuration to be pushed to the device - cisco.nxos.nxos_acl_interfaces: - config: - - name: Ethernet1/2 - access_groups: - - afi: ipv6 - acls: - - name: ACL1v6 - direction: in - - name: Ethernet1/5 - access_groups: - - afi: ipv4 - acls: - - name: PortACL - direction: in - port: true - - name: ACL1v4 - direction: out - - afi: ipv6 - acls: - - name: ACL1v6 - direction: in - state: rendered - - - # returns - # rendered: - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ipv6 traffic-filter ACL1v6 in - # ip access-group ACL1v4 out - # ip port access-group PortACL in - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/2', 'ipv6 traffic-filter ACL1v6 out', 'ip port access-group PortACL in']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_acls_module.rst b/docs/cisco.nxos.nxos_acls_module.rst deleted file mode 100644 index 1b806511d..000000000 --- a/docs/cisco.nxos.nxos_acls_module.rst +++ /dev/null @@ -1,4086 +0,0 @@ -.. _cisco.nxos.nxos_acls_module: - - -******************** -cisco.nxos.nxos_acls -******************** - -**ACLs resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manage named IP ACLs on the Cisco NX-OS platform - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A dictionary of ACL options.
-
-
- acls - -
- list - / elements=dictionary -
- 		- -
A list of the ACLs.
-
-
- aces - -
- list - / elements=dictionary -
- 		- -
The entries within the ACL.
-
-
- destination - -
- dictionary -
- 		- -
Specify the packet destination.
-
-
- address - -
- string -
- 		- -
Destination network address.
-
-
- any - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Any destination address.
-
-
- host - -
- string -
- 		- -
Host IP address.
-
-
- port_protocol - -
- dictionary -
- 		- -
Specify the destination port or protocol (only for TCP and UDP).
-
-
- eq - -
- string -
- 		- -
Match only packets on a given port number.
-
-
- gt - -
- string -
- 		- -
Match only packets with a greater port number.
-
-
- lt - -
- string -
- 		- -
Match only packets with a lower port number.
-
-
- neq - -
- string -
- 		- -
Match only packets not on a given port number.
-
-
- range - -
- dictionary -
- 		- -
Match only packets in the range of port numbers.
-
-
- end - -
- string -
- 		- -
Specify the end of the port range.
-
-
- start - -
- string -
- 		- -
Specify the start of the port range.
-
-
- prefix - -
- string -
- 		- -
Destination network prefix. Only for prefixes of value less than 31 for ipv4 and 127 for ipv6. Prefixes of 32 (ipv4) and 128 (ipv6) should be given in the 'host' key.
-
-
- wildcard_bits - -
- string -
- 		- -
Destination wildcard bits.
-
-
- dscp - -
- string -
- 		- -
Match packets with given DSCP value.
-
-
- fragments - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Check non-initial fragments.
-
-
- grant - -
- string -
- 		-
    Choices: -
  • permit
    • -
  • deny
    • -
- 		-
Action to be applied on the rule.
-
-
- log - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Log matches against this entry.
-
-
- precedence - -
- string -
- 		- -
Match packets with given precedence value.
-
-
- protocol - -
- string -
- 		- -
Specify the protocol.
-
-
- protocol_options - -
- dictionary -
- 		- -
All possible suboptions for the protocol chosen.
-
-
- icmp - -
- dictionary -
- 		- -
ICMP protocol options.
-
-
- administratively_prohibited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively prohibited
-
-
- alternate_address - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Alternate address
-
-
- conversion_error - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Datagram conversion
-
-
- dod_host_prohibited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host prohibited
-
-
- dod_net_prohibited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Net prohibited
-
-
- echo - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo (ping)
-
-
- echo_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo reply
-
-
- echo_request - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo request (ping)
-
-
- general_parameter_problem - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter problem
-
-
- host_isolated - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host isolated
-
-
- host_precedence_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host unreachable for precedence
-
-
- host_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host redirect
-
-
- host_tos_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host redirect for TOS
-
-
- host_tos_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host unreachable for TOS
-
-
- host_unknown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host unknown
-
-
- host_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host unreachable
-
-
- information_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Information replies
-
-
- information_request - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Information requests
-
-
- mask_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Mask replies
-
-
- mask_request - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Mask requests
-
-
- message_code - -
- integer -
- 		- -
ICMP message code
-
-
- message_type - -
- integer -
- 		- -
ICMP message type
-
-
- mobile_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Mobile host redirect
-
-
- net_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Network redirect
-
-
- net_tos_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Net redirect for TOS
-
-
- net_tos_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Network unreachable for TOS
-
-
- net_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Net unreachable
-
-
- network_unknown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Network unknown
-
-
- no_room_for_option - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter required but no room
-
-
- option_missing - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter required but not present
-
-
- packet_too_big - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Fragmentation needed and DF set
-
-
- parameter_problem - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All parameter problems
-
-
- port_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Port unreachable
-
-
- precedence_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Precedence cutoff
-
-
- protocol_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Protocol unreachable
-
-
- reassembly_timeout - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Reassembly timeout
-
-
- redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All redirects
-
-
- router_advertisement - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router discovery advertisements
-
-
- router_solicitation - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router discovery solicitations
-
-
- source_quench - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Source quenches
-
-
- source_route_failed - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Source route failed
-
-
- time_exceeded - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All time exceeded.
-
-
- timestamp_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Timestamp replies
-
-
- timestamp_request - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Timestamp requests
-
-
- traceroute - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Traceroute
-
-
- ttl_exceeded - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
TTL exceeded
-
-
- unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All unreachables
-
-
- icmpv6 - -
- dictionary -
- 		- -
ICMPv6 protocol options.
-
-
- beyond_scope - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Destination beyond scope.
-
-
- destination_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Destination address is unreachable.
-
-
- echo_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo reply.
-
-
- echo_request - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo request (ping).
-
-
- fragments - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Check non-initial fragments.
-
-
- header - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter header problem.
-
-
- hop_limit - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Hop limit exceeded in transit.
-
-
- mld_query - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Multicast Listener Discovery Query.
-
-
- mld_reduction - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Multicast Listener Discovery Reduction.
-
-
- mld_report - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Multicast Listener Discovery Report.
-
-
- mldv2 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Multicast Listener Discovery Protocol.
-
-
- nd_na - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Neighbor discovery neighbor advertisements.
-
-
- nd_ns - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Neighbor discovery neighbor solicitations.
-
-
- next_header - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter next header problems.
-
-
- no_admin - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administration prohibited destination.
-
-
- no_route - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
No route to destination.
-
-
- packet_too_big - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Packet too big.
-
-
- parameter_option - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter option problems.
-
-
- parameter_problem - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All parameter problems.
-
-
- port_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Port unreachable.
-
-
- reassembly_timeout - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Reassembly timeout.
-
-
- renum_command - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router renumbering command.
-
-
- renum_result - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router renumbering result.
-
-
- renum_seq_number - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router renumbering sequence number reset.
-
-
- router_advertisement - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Neighbor discovery router advertisements.
-
-
- router_renumbering - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All router renumbering.
-
-
- router_solicitation - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Neighbor discovery router solicitations.
-
-
- telemetry_path - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IPT enabled.
-
-
- telemetry_queue - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flow of interest for BDC/HDC.
-
-
- time_exceeded - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All time exceeded.
-
-
- unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All unreachable.
-
-
- igmp - -
- dictionary -
- 		- -
IGMP protocol options.
-
-
- dvmrp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Distance Vector Multicast Routing Protocol
-
-
- host_query - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host Query
-
-
- host_report - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host Report
-
-
- tcp - -
- dictionary -
- 		- -
TCP flags.
-
-
- ack - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the ACK bit
-
-
- established - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match established connections
-
-
- fin - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the FIN bit
-
-
- psh - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the PSH bit
-
-
- rst - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the RST bit
-
-
- syn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the SYN bit
-
-
- urg - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the URG bit
-
-
- remark - -
- string -
- 		- -
Access list entry comment.
-
-
- sequence - -
- integer -
- 		- -
Sequence number.
-
-
- source - -
- dictionary -
- 		- -
Specify the packet source.
-
-
- address - -
- string -
- 		- -
Source network address.
-
-
- any - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Any source address.
-
-
- host - -
- string -
- 		- -
Host IP address.
-
-
- port_protocol - -
- dictionary -
- 		- -
Specify the destination port or protocol (only for TCP and UDP).
-
-
- eq - -
- string -
- 		- -
Match only packets on a given port number.
-
-
- gt - -
- string -
- 		- -
Match only packets with a greater port number.
-
-
- lt - -
- string -
- 		- -
Match only packets with a lower port number.
-
-
- neq - -
- string -
- 		- -
Match only packets not on a given port number.
-
-
- range - -
- dictionary -
- 		- -
Match only packets in the range of port numbers.
-
-
- end - -
- string -
- 		- -
Specify the end of the port range.
-
-
- start - -
- string -
- 		- -
Specify the start of the port range.
-
-
- prefix - -
- string -
- 		- -
Source network prefix. Only for prefixes of mask value less than 31 for ipv4 and 127 for ipv6. Prefixes of mask 32 (ipv4) and 128 (ipv6) should be given in the 'host' key.
-
-
- wildcard_bits - -
- string -
- 		- -
Source wildcard bits.
-
-
- name - -
- string - / required -
- 		- -
Name of the ACL.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
The Address Family Indicator (AFI) for the ACL.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section 'ip(v6* access-list).
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • deleted
    • -
  • gathered
    • -
  • merged ←
    • -
  • overridden
    • -
  • rendered
    • -
  • replaced
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - As NX-OS allows configuring a rule again with different sequence numbers, the user is expected to provide sequence numbers for the access control entries to preserve idempotency. If no sequence number is given, the rule will be added as a new rule by the device. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - - - name: Merge provided ACLs configuration with device configuration - cisco.nxos.nxos_acls: - state: merged - config: - - afi: ipv4 - acls: - - name: ACL1v4 - aces: - - grant: deny - destination: - address: 192.0.2.64 - wildcard_bits: 0.0.0.255 - source: - any: true - port_protocol: - lt: 55 - protocol: tcp - protocol_options: - tcp: - ack: true - fin: true - sequence: 50 - - - afi: ipv6 - acls: - - name: ACL1v6 - aces: - - grant: permit - sequence: 10 - source: - any: true - destination: - prefix: 2001:db8:12::/32 - protocol: sctp - - # Task Output - # ----------- - # before: [] - # - # commands: - # - ip access-list ACL1v4 - # - 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin - # - ipv6 access-list ACL1v6 - # - 10 permit sctp any 2001:db8:12::/32 - # - # after: - # - acls: - # - aces: - # - destination: - # prefix: 2001:db8:12::/32 - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # name: ACL1v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # address: 192.0.2.64 - # wildcard_bits: 0.0.0.255 - # grant: deny - # protocol: tcp - # protocol_options: - # tcp: - # ack: true - # fin: true - # sequence: 50 - # source: - # any: true - # port_protocol: - # lt: '55' - # name: ACL1v4 - # afi: ipv4 - - - # After state: - # ------------ - # - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - - # Using replaced - - # Before state: - # ---------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 10 permit ip any any - # 20 deny udp any any - # ip access-list ACL2v4 - # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ipv6 access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - - name: Replace existing ACL configuration with provided configuration - cisco.nxos.nxos_acls: - config: - - afi: ipv4 - - afi: ipv6 - acls: - - name: ACL1v6 - aces: - - sequence: 20 - grant: permit - source: - any: true - destination: - any: true - protocol: pim - - - remark: Replaced ACE - - name: ACL2v6 - state: replaced - - # Task Output - # ----------- - # before: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ip - # sequence: 10 - # source: - # any: true - # - destination: - # any: true - # grant: deny - # protocol: udp - # sequence: 20 - # source: - # any: true - # name: ACL1v4 - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ahp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.0.255 - # name: ACL2v4 - # afi: ipv4 - # - # commands: - # - no ip access-list ACL1v4 - # - no ip access-list ACL2v4 - # - ipv6 access-list ACL1v6 - # - no 10 permit sctp any any - # - no 20 remark IPv6 ACL - # - remark Replaced ACE - # - 20 permit pim any any - # - ipv6 access-list ACL2v6 - # - no 10 deny ipv6 any 2001:db8:3000::/36 - # - no 20 permit tcp host 2001:db8:2000:2::2 host 2001:db8:2000:ab::2 - # - # after: - # - acls: - # - aces: - # - remark: Replaced ACE - # sequence: 10 - # - destination: - # any: true - # grant: permit - # protocol: pim - # sequence: 20 - # source: - # any: true - # name: ACL1v6 - # - name: ACL2v6 - # afi: ipv6 - - # After state: - # --------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ipv6 access-list ACL1v6 - # 10 remark Replaced ACE - # 20 permit pim any any - # ipv6 access-list ACL2v6 - - # Using overridden - - # Before state: - # ---------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 10 permit ip any any - # 20 deny udp any any - # ip access-list ACL2v4 - # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ipv6 access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - - name: Override existing configuration with provided configuration - cisco.nxos.nxos_acls: - config: - - afi: ipv4 - acls: - - name: NewACL - aces: - - grant: deny - source: - address: 192.0.2.0 - wildcard_bits: 0.0.255.255 - destination: - any: true - protocol: eigrp - - remark: Example for overridden state - state: overridden - - # Task Output - # ----------- - # - # before: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ip - # sequence: 10 - # source: - # any: true - # - destination: - # any: true - # grant: deny - # protocol: udp - # sequence: 20 - # source: - # any: true - # name: ACL1v4 - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ahp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.0.255 - # name: ACL2v4 - # afi: ipv4 - # - # commands: - # - no ipv6 access-list ACL1v6 - # - no ipv6 access-list ACL2v6 - # - no ip access-list ACL1v4 - # - no ip access-list ACL2v4 - # - ip access-list NewACL - # - deny eigrp 192.0.2.0 0.0.255.255 any - # - remark Example for overridden state - # - # after: - # - acls: - # - aces: - # - destination: - # any: true - # grant: deny - # protocol: eigrp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.255.255 - # - remark: Example for overridden state - # sequence: 20 - # name: NewACL - # afi: ipv4 - - # After state: - # ------------ - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list NewACL - # 10 deny eigrp 192.0.2.0 0.0.255.255 any - # 20 remark Example for overridden state - - # Using deleted - delete all - # - # Before state: - # ------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 10 permit ip any any - # 20 deny udp any any - # ip access-list ACL2v4 - # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ip access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ip access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - - name: Delete all ACLs - cisco.nxos.nxos_acls: - state: deleted - - # Task Output - # ----------- - # - # before: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ip - # sequence: 10 - # source: - # any: true - # - destination: - # any: true - # grant: deny - # protocol: udp - # sequence: 20 - # source: - # any: true - # name: ACL1v4 - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ahp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.0.255 - # name: ACL2v4 - # afi: ipv4 - # - # commands: - # - no ip access-list ACL1v4 - # - no ip access-list ACL2v4 - # - no ipv6 access-list ACL1v6 - # - no ipv6 access-list ACL2v6 - # - # after: [] - - - # After state: - # ----------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # - - # Using deleted - delete AFI - - # Before state: - # ------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 10 permit ip any any - # 20 deny udp any any - # ip access-list ACL2v4 - # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ip access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ip access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - - name: Delete all ACLs in given AFI - cisco.nxos.nxos_acls: - config: - - afi: ipv4 - state: deleted - - # Task Output - # ----------- - # - # before: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ip - # sequence: 10 - # source: - # any: true - # - destination: - # any: true - # grant: deny - # protocol: udp - # sequence: 20 - # source: - # any: true - # name: ACL1v4 - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ahp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.0.255 - # name: ACL2v4 - # afi: ipv4 - # - # commands: - # - no ip access-list ACL1v4 - # - no ip access-list ACL2v4 - # - # after: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - - # After state: - # ------------ - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ip access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - # Using deleted - delete ACLs - - # Before state: - # ------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 10 permit ip any any - # 20 deny udp any any - # ip access-list ACL2v4 - # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ipv6 access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - - name: Delete specific ACLs - cisco.nxos.nxos_acls: - state: deleted - config: - - afi: ipv4 - acls: - - name: ACL1v4 - - name: ACL2v4 - - afi: ipv6 - acls: - - name: ACL1v6 - - # Task Output - # ----------- - # - # before: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ip - # sequence: 10 - # source: - # any: true - # - destination: - # any: true - # grant: deny - # protocol: udp - # sequence: 20 - # source: - # any: true - # name: ACL1v4 - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ahp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.0.255 - # name: ACL2v4 - # afi: ipv4 - # - # commands: - # - no ip access-list ACL1v4 - # - no ip access-list ACL2v4 - # - no ipv6 access-list ACL1v6 - # - # after: - # - acls: - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - - # After state: - # ------------ - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ipv6 access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - # Using parsed - - - name: Parse given config to structured data - cisco.nxos.nxos_acls: - running_config: | - ip access-list ACL1v4 - 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin - ipv6 access-list ACL1v6 - 10 permit sctp any any - state: parsed - - # Task Output - # ------------ - # - # parsed: - # - afi: ipv4 - # acls: - # - name: ACL1v4 - # aces: - # - grant: deny - # destination: - # address: 192.0.2.64 - # wildcard_bits: 0.0.0.255 - # source: - # any: true - # port_protocol: - # lt: 55 - # protocol: tcp - # protocol_options: - # tcp: - # ack: true - # fin: true - # sequence: 50 - # - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # aces: - # - grant: permit - # sequence: 10 - # source: - # any: true - # destination: - # prefix: 2001:db8:12::/32 - # protocol: sctp - - - # Using gathered: - - # Before state: - # ------------ - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - - - name: Gather existing configuration - cisco.nxos.nxos_acls: - state: gathered - - # Task Output - # ----------- - # - # gathered: - # - afi: ipv4 - # acls: - # - name: ACL1v4 - # aces: - # - grant: deny - # destination: - # address: 192.0.2.64 - # wildcard_bits: 0.0.0.255 - # source: - # any: true - # port_protocol: - # lt: 55 - # protocol: tcp - # protocol_options: - # tcp: - # ack: true - # fin: true - # sequence: 50 - - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # aces: - # - grant: permit - # sequence: 10 - # source: - # any: true - # destination: - # prefix: 2001:db8:12::/32 - # protocol: sctp - - - # Using rendered - - - name: Render required configuration to be pushed to the device - cisco.nxos.nxos_acls: - config: - - afi: ipv4 - acls: - - name: ACL1v4 - aces: - - grant: deny - destination: - address: 192.0.2.64 - wildcard_bits: 0.0.0.255 - source: - any: true - port_protocol: - lt: 55 - protocol: tcp - protocol_options: - tcp: - ack: true - fin: true - sequence: 50 - - afi: ipv6 - acls: - - name: ACL1v6 - aces: - - grant: permit - sequence: 10 - source: - any: true - destination: - prefix: '2001:db8:12::/32' - protocol: sctp - state: rendered - - - # Task Output - # ----------- - # - # rendered: - # ip access-list ACL1v4 - # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['ip access-list ACL1v4', '10 permit ip any any precedence critical log', '20 deny tcp any lt smtp host 192.0.2.64 ack fin']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['ip access-list ACL1v4', '10 permit ip any any precedence critical log', '20 deny tcp any lt smtp host 192.0.2.64 ack fin']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_banner_module.rst b/docs/cisco.nxos.nxos_banner_module.rst deleted file mode 100644 index 7502173b7..000000000 --- a/docs/cisco.nxos.nxos_banner_module.rst +++ /dev/null @@ -1,187 +0,0 @@ -.. _cisco.nxos.nxos_banner_module: - - -********************** -cisco.nxos.nxos_banner -********************** - -**Manage multiline banners on Cisco NXOS devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This will configure both exec and motd banners on remote devices running Cisco NXOS. It allows playbooks to add or remove banner text from the active running configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- banner - -
- string - / required -
- 		-
    Choices: -
  • exec
    • -
  • motd
    • -
- 		-
Specifies which banner that should be configured on the remote device.
-
-
- multiline_delimiter - -
- string -
- 		- Default:
"@"
- 		-
Specify the delimiting character than will be used for configuration.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Specifies whether or not the configuration is present in the current devices active running configuration.
-
-
- text - -
- string -
- 		- -
The banner text that should be present in the remote device running configuration. This argument accepts a multiline string, with no empty lines. Requires state=present.
-
-
- - -Notes ------ - -.. note:: - - Since responses from the device are always read with surrounding whitespaces stripped, tasks that configure banners with preceeding or trailing whitespaces will not be idempotent. - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: configure the exec banner - cisco.nxos.nxos_banner: - banner: exec - text: | - this is my exec banner - that contains a multiline - string - state: present - - name: remove the motd banner - cisco.nxos.nxos_banner: - banner: motd - state: absent - - name: Configure banner from file - cisco.nxos.nxos_banner: - banner: motd - text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}" - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['banner exec', 'this is my exec banner', 'that contains a multiline', 'string']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_bfd_global_module.rst b/docs/cisco.nxos.nxos_bfd_global_module.rst deleted file mode 100644 index 8cd86ec48..000000000 --- a/docs/cisco.nxos.nxos_bfd_global_module.rst +++ /dev/null @@ -1,326 +0,0 @@ -.. _cisco.nxos.nxos_bfd_global_module: - - -************************** -cisco.nxos.nxos_bfd_global -************************** - -**Bidirectional Forwarding Detection (BFD) global-level configuration** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages Bidirectional Forwarding Detection (BFD) global-level configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- echo_interface - -
- string -
- 		- -
Loopback interface used for echo frames.
-
Valid values are loopback interface name or 'deleted'.
-
Not supported on N5K/N6K
-
-
- echo_rx_interval - -
- integer -
- 		- -
BFD Echo receive interval in milliseconds.
-
-
- fabricpath_interval - -
- dictionary -
- 		- -
BFD fabricpath interval timer values.
-
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
-
-
- fabricpath_slow_timer - -
- integer -
- 		- -
BFD fabricpath slow rate timer in milliseconds.
-
-
- fabricpath_vlan - -
- integer -
- 		- -
BFD fabricpath control vlan.
-
-
- interval - -
- dictionary -
- 		- -
BFD interval timer values.
-
Value must be a dict defining values for keys (tx, min_rx, and multiplier)
-
-
- ipv4_echo_rx_interval - -
- integer -
- 		- -
BFD IPv4 session echo receive interval in milliseconds.
-
-
- ipv4_interval - -
- dictionary -
- 		- -
BFD IPv4 interval timer values.
-
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
-
-
- ipv4_slow_timer - -
- integer -
- 		- -
BFD IPv4 slow rate timer in milliseconds.
-
-
- ipv6_echo_rx_interval - -
- integer -
- 		- -
BFD IPv6 session echo receive interval in milliseconds.
-
-
- ipv6_interval - -
- dictionary -
- 		- -
BFD IPv6 interval timer values.
-
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
-
-
- ipv6_slow_timer - -
- integer -
- 		- -
BFD IPv6 slow rate timer in milliseconds.
-
-
- slow_timer - -
- integer -
- 		- -
BFD slow rate timer in milliseconds.
-
-
- startup_timer - -
- integer -
- 		- -
BFD delayed startup timer in seconds.
-
Not supported on N5K/N6K/N7K
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 9.2(2) - - Unsupported for Cisco MDS - - BFD global will automatically enable 'feature bfd' if it is disabled. - - BFD global does not have a 'state' parameter. All of the BFD commands are unique and are defined if 'feature bfd' is enabled. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_bfd_global: - echo_interface: Ethernet1/2 - echo_rx_interval: 50 - interval: - tx: 50 - min_rx: 50 - multiplier: 4 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- cmds - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['bfd echo-interface loopback1', 'bfd slow-timer 2000']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_bfd_interfaces_module.rst b/docs/cisco.nxos.nxos_bfd_interfaces_module.rst deleted file mode 100644 index 975de891c..000000000 --- a/docs/cisco.nxos.nxos_bfd_interfaces_module.rst +++ /dev/null @@ -1,394 +0,0 @@ -.. _cisco.nxos.nxos_bfd_interfaces_module: - - -****************************** -cisco.nxos.nxos_bfd_interfaces -****************************** - -**BFD interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages attributes of Bidirectional Forwarding Detection (BFD) on the interface. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
The provided configuration
-
-
- bfd - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Enable/Disable Bidirectional Forwarding Detection (BFD) on the interface.
-
-
- echo - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Enable/Disable BFD Echo functionality on the interface.
-
-
- name - -
- string -
- 		- -
The name of the interface.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface|^feature bfd'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state of the configuration after module completion
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 7.0(3)I5(1). - - Unsupported for Cisco MDS - - Feature bfd should be enabled for this module. - - - -Examples --------- - -.. code-block:: yaml - - # Using deleted - - - name: Configure interfaces - cisco.nxos.nxos_bfd_interfaces: - state: deleted - - - # Using merged - - - name: Configure interfaces - cisco.nxos.nxos_bfd_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - echo: enable - - name: Ethernet1/2 - bfd: disable - echo: disable - state: merged - - - # Using overridden - - - name: Configure interfaces - cisco.nxos.nxos_bfd_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - echo: enable - - name: Ethernet1/2 - bfd: disable - echo: disable - state: overridden - - - # Using replaced - - - name: Configure interfaces - cisco.nxos.nxos_bfd_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - echo: enable - - name: Ethernet1/2 - bfd: disable - echo: disable - state: replaced - - # Using rendered - - - name: Use rendered state to convert task input to device specific commands - cisco.nxos.nxos_bfd_interfaces: - config: - - name: Ethernet1/800 - bfd: enable - echo: enable - - name: Ethernet1/801 - bfd: disable - echo: disable - state: rendered - - # Task Output (redacted) - # ----------------------- - - # rendered: - # - "interface Ethernet1/800" - # - "bfd" - # - "bfd echo" - # - "interface Ethernet1/801" - # - "no bfd" - # - "no bfd echo" - - # Using parsed - - # parsed.cfg - # ------------ - - # feature bfd - # interface Ethernet1/800 - # no switchport - # no bfd - # no bfd echo - # interface Ethernet1/801 - # no switchport - # no bfd - # interface Ethernet1/802 - # no switchport - # no bfd echo - # interface mgmt0 - # ip address dhcp - # vrf member management - - - name: Use parsed state to convert externally supplied config to structured format - cisco.nxos.nxos_bfd_interfaces: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - - # parsed: - # - bfd: disable - # echo: disable - # name: Ethernet1/800 - # - bfd: disable - # echo: enable - # name: Ethernet1/801 - # - bfd: enable - # echo: disable - # name: Ethernet1/802 - # - bfd: enable - # echo: enable - # name: mgmt0 - - # Using gathered - - # Existing device config state - # ------------------------------- - - # feature bfd - # interface Ethernet1/1 - # no switchport - # no bfd - # interface Ethernet1/2 - # no switchport - # no bfd echo - # interface mgmt0 - # ip address dhcp - # vrf member management - - - name: Gather bfd_interfaces facts from the device using nxos_bfd_interfaces - cisco.nxos.nxos_bfd_interfaces: - state: gathered - - # Task output (redacted) - # ----------------------- - # gathered: - # - name: Ethernet1/1 - # bfd: disable - # echo: enable - # - name: Ethernet1/3 - # echo: disable - # bfd: enable - # - name: mgmt0 - # bfd: enable - # echo: enable - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/1', 'no bfd', 'no bfd echo']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_bgp_global_module.rst b/docs/cisco.nxos.nxos_bgp_global_module.rst deleted file mode 100644 index 19ee2709e..000000000 --- a/docs/cisco.nxos.nxos_bgp_global_module.rst +++ /dev/null @@ -1,5843 +0,0 @@ -.. _cisco.nxos.nxos_bgp_global_module: - - -************************** -cisco.nxos.nxos_bgp_global -************************** - -**BGP Global resource module.** - - -Version added: 1.4.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages global BGP configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A list of BGP process configuration.
-
-
- affinity_group - -
- dictionary -
- 		- -
Configure an affinity group.
-
-
- group_id - -
- integer -
- 		- -
Affinity Group ID.
-
-
- as_number - -
- string -
- 		- -
Autonomous System Number of the router.
-
-
- bestpath - -
- dictionary -
- 		- -
Define the default bestpath selection algorithm.
-
-
- always_compare_med - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare MED on paths from different AS.
-
-
- as_path - -
- dictionary -
- 		- -
AS-Path.
-
-
- ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore AS-Path during bestpath selection.
-
-
- multipath_relax - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Relax AS-Path restriction when choosing multipaths.
-
-
- compare_neighborid - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
When more paths are available than max path config, use neighborid as tie-breaker.
-
-
- compare_routerid - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare router-id for identical EBGP paths.
-
-
- cost_community_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore cost communities in bestpath selection.
-
-
- igp_metric_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore IGP metric for next-hop during bestpath selection.
-
-
- med - -
- dictionary -
- 		- -
MED
-
-
- confed - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare MED only from paths originated from within a confederation.
-
-
- missing_as_worst - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Treat missing MED as highest MED.
-
-
- non_deterministic - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Not always pick the best-MED path among paths from same AS.
-
-
- cluster_id - -
- string -
- 		- -
Configure Route Reflector Cluster-ID.
-
-
- confederation - -
- dictionary -
- 		- -
AS confederation parameters.
-
-
- identifier - -
- string -
- 		- -
Set routing domain confederation AS.
-
-
- peers - -
- list - / elements=string -
- 		- -
Peer ASs in BGP confederation.
-
-
- disable_policy_batching - -
- dictionary -
- 		- -
Disable batching evaluation of outbound policy for a peer.
-
-
- ipv4 - -
- dictionary -
- 		- -
IPv4 address-family settings.
-
-
- prefix_list - -
- string -
- 		- -
Name of prefix-list to apply.
-
-
- ipv6 - -
- dictionary -
- 		- -
IPv6 address-family settings.
-
-
- prefix_list - -
- string -
- 		- -
Name of prefix-list to apply.
-
-
- nexthop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Batching based on nexthop.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set policy batching.
-
-
- dynamic_med_interval - -
- integer -
- 		- -
Sets the interval for dampening of med changes.
-
-
- enforce_first_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enforce neighbor AS is the first AS in AS-PATH attribute (EBGP).
-
-
- enhanced_error - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable BGP Enhanced error handling.
-
-
- fabric_soo - -
- string -
- 		- -
Fabric site of origin.
-
-
- fast_external_fallover - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Immediately reset the session if the link to a directly connected BGP peer goes down.
-
-
- flush_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flush routes in RIB upon controlled restart.
-
-
- graceful_restart - -
- dictionary -
- 		- -
Configure Graceful Restart functionality.
-
-
- helper - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure Graceful Restart Helper mode functionality.
-
-
- restart_time - -
- integer -
- 		- -
Maximum time for restart advertised to peers.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable graceful-restart.
-
-
- stalepath_time - -
- integer -
- 		- -
Maximum time to keep a restarting peer's stale routes.
-
-
- graceful_shutdown - -
- dictionary -
- 		- -
Graceful-shutdown for BGP protocol.
-
-
- activate - -
- dictionary -
- 		- -
Send graceful-shutdown community on all routes.
-
-
- route_map - -
- string -
- 		- -
Apply route-map to modify attributes for outbound.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Activiate graceful-shutdown.
-
-
- aware - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Lower preference of routes carrying graceful-shutdown community.
-
-
- isolate - -
- dictionary -
- 		- -
Isolate this router from BGP perspective.
-
-
- include_local - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Withdraw both local and remote BGP routes.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Withdraw remote BGP routes to isolate this router.
-
-
- log_neighbor_changes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Log a message for neighbor up/down event.
-
-
- maxas_limit - -
- integer -
- 		- -
Allow AS-PATH attribute from EBGP neighbor imposing a limit on number of ASes.
-
-
- neighbor_down - -
- dictionary -
- 		- -
Handle BGP neighbor down event, due to various reasons.
-
-
- fib_accelerate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor.
-
-
- neighbors - -
- list - / elements=dictionary -
- 		- -
Configure BGP neighbors.
-
-
- bfd - -
- dictionary -
- 		- -
Bidirectional Fast Detection for the neighbor.
-
-
- multihop - -
- dictionary -
- 		- -
Multihop session.
-
-
- interval - -
- dictionary -
- 		- -
Configure BFD session interval parameters.
-
-
- min_rx_interval - -
- integer -
- 		- -
Minimum RX interval.
-
-
- multiplier - -
- integer -
- 		- -
Detect Multiplier.
-
-
- tx_interval - -
- integer -
- 		- -
TX interval in milliseconds.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD multihop.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD for this neighbor.
-
-
- singlehop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Single-hop session.
-
-
- bmp_activate_server - -
- integer -
- 		- -
Specify server ID for activating BMP monitoring for the peer.
-
-
- capability - -
- dictionary -
- 		- -
Capability.
-
-
- suppress_4_byte_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress 4-byte AS Capability.
-
-
- description - -
- string -
- 		- -
Neighbor specific descripion.
-
-
- disable_connected_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable check for directly connected peer.
-
-
- dont_capability_negotiate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't negotiate capability with this neighbor.
-
-
- dscp - -
- string -
- 		- -
Set dscp value for tcp transport.
-
-
- dynamic_capability - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Dynamic Capability
-
-
- ebgp_multihop - -
- integer -
- 		- -
Specify multihop TTL for remote peer.
-
-
- graceful_shutdown - -
- dictionary -
- 		- -
Graceful-shutdown for this neighbor.
-
-
- activate - -
- dictionary -
- 		- -
Send graceful-shutdown community.
-
-
- route_map - -
- string -
- 		- -
Apply route-map to modify attributes for outbound.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set activate.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a template.
-
-
- peer - -
- string -
- 		- -
Peer template to inherit.
-
-
- peer_session - -
- string -
- 		- -
Peer-session template to inherit.
-
-
- local_as - -
- string -
- 		- -
Specify the local-as number for the eBGP neighbor.
-
-
- log_neighbor_changes - -
- dictionary -
- 		- -
Log message for neighbor up/down event.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable logging of neighbor up/down event.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set log-neighbor-changes.
-
-
- low_memory - -
- dictionary -
- 		- -
Behaviour in low memory situations.
-
-
- exempt - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not shutdown this peer when under memory pressure.
-
-
- neighbor_address - -
- string - / required -
- 		- -
IP address/Prefix of the neighbor or interface.
-
-
- neighbor_affinity_group - -
- dictionary -
- 		- -
Configure an affinity group.
-
-
- group_id - -
- integer -
- 		- -
Affinity Group ID.
-
-
- password - -
- dictionary -
- 		- -
Configure a password for neighbor.
-
-
- encryption - -
- integer -
- 		- -
0 specifies an UNENCRYPTED neighbor password.
-
3 specifies an 3DES ENCRYPTED neighbor password will follow.
-
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
-
-
- key - -
- string -
- 		- -
Authentication password.
-
-
- path_attribute - -
- list - / elements=dictionary -
- 		- -
BGP path attribute optional filtering.
-
-
- action - -
- string -
- 		-
    Choices: -
  • discard
    • -
  • treat-as-withdraw
    • -
- 		-
Action.
-
-
- range - -
- dictionary -
- 		- -
Path attribute range.
-
-
- end - -
- integer -
- 		- -
Path attribute range end value.
-
-
- start - -
- integer -
- 		- -
Path attribute range start value.
-
-
- type - -
- integer -
- 		- -
Path attribute type
-
-
- peer_type - -
- string -
- 		-
    Choices: -
  • fabric-border-leaf
    • -
  • fabric-external
    • -
- 		-
Neighbor facing
-
-
- remote_as - -
- string -
- 		- -
Specify Autonomous System Number of the neighbor.
-
-
- remote_as_route_map - -
- string -
- 		- -
Route-map to match prefix peer AS number.
-
-
- remove_private_as - -
- dictionary -
- 		- -
Remove private AS number from outbound updates.
-
-
- all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All.
-
-
- replace_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Replace.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove private AS.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively shutdown this neighbor.
-
-
- timers - -
- dictionary -
- 		- -
Configure keepalive and hold timers.
-
-
- holdtime - -
- integer -
- 		- -
Holdtime (seconds).
-
-
- keepalive - -
- integer -
- 		- -
Keepalive interval (seconds).
-
-
- transport - -
- dictionary -
- 		- -
BGP transport connection.
-
-
- connection_mode - -
- dictionary -
- 		- -
Specify type of connection.
-
-
- passive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow passive connection setup only.
-
-
- ttl_security - -
- dictionary -
- 		- -
Enable TTL Security Mechanism.
-
-
- hops - -
- integer -
- 		- -
Specify hop count for remote peer.
-
-
- update_source - -
- string -
- 		- -
Specify source of BGP session and updates.
-
-
- nexthop - -
- dictionary -
- 		- -
Nexthop resolution options.
-
-
- suppress_default_resolution - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Prohibit use of default route for nexthop address resolution.
-
-
- rd - -
- dictionary -
- 		- -
Secondary Route Distinguisher for vxlan multisite border gateway.
-
-
- dual - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Generate Secondary RD for all VRFs and L2VNIs.
-
-
- id - -
- integer -
- 		- -
Specify 2 byte value for ID.
-
-
- reconnect_interval - -
- integer -
- 		- -
Configure connection reconnect interval.
-
-
- router_id - -
- string -
- 		- -
Specify the IP address to use as router-id.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively shutdown BGP protocol.
-
-
- suppress_fib_pending - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise only routes that are programmed in hardware to peers.
-
-
- timers - -
- dictionary -
- 		- -
Configure bgp related timers.
-
-
- bestpath_limit - -
- dictionary -
- 		- -
Configure timeout for first bestpath after restart.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure update-delay-always option.
-
-
- timeout - -
- integer -
- 		- -
Bestpath timeout (seconds).
-
-
- bgp - -
- dictionary -
- 		- -
Configure different bgp keepalive and holdtimes.
-
-
- holdtime - -
- integer -
- 		- -
Holdtime (seconds).
-
-
- keepalive - -
- integer -
- 		- -
Keepalive interval (seconds).
-
-
- prefix_peer_timeout - -
- integer -
- 		- -
Prefix Peer timeout (seconds).
-
-
- prefix_peer_wait - -
- integer -
- 		- -
Configure wait timer for a prefix peer.
-
-
- vrfs - -
- list - / elements=dictionary -
- 		- -
Virtual Router Context configurations.
-
-
- allocate_index - -
- integer -
- 		- -
Configure allocate-index.
-
-
- bestpath - -
- dictionary -
- 		- -
Define the default bestpath selection algorithm.
-
-
- always_compare_med - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare MED on paths from different AS.
-
-
- as_path - -
- dictionary -
- 		- -
AS-Path.
-
-
- ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore AS-Path during bestpath selection.
-
-
- multipath_relax - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Relax AS-Path restriction when choosing multipaths.
-
-
- compare_neighborid - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
When more paths are available than max path config, use neighborid as tie-breaker.
-
-
- compare_routerid - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare router-id for identical EBGP paths.
-
-
- cost_community_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore cost communities in bestpath selection.
-
-
- igp_metric_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore IGP metric for next-hop during bestpath selection.
-
-
- med - -
- dictionary -
- 		- -
MED
-
-
- confed - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare MED only from paths originated from within a confederation.
-
-
- missing_as_worst - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Treat missing MED as highest MED.
-
-
- non_deterministic - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Not always pick the best-MED path among paths from same AS.
-
-
- cluster_id - -
- string -
- 		- -
Configure Route Reflector Cluster-ID.
-
-
- confederation - -
- dictionary -
- 		- -
AS confederation parameters.
-
-
- identifier - -
- string -
- 		- -
Set routing domain confederation AS.
-
-
- peers - -
- list - / elements=string -
- 		- -
Peer ASs in BGP confederation.
-
-
- graceful_restart - -
- dictionary -
- 		- -
Configure Graceful Restart functionality.
-
-
- helper - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure Graceful Restart Helper mode functionality.
-
-
- restart_time - -
- integer -
- 		- -
Maximum time for restart advertised to peers.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable graceful-restart.
-
-
- stalepath_time - -
- integer -
- 		- -
Maximum time to keep a restarting peer's stale routes.
-
-
- local_as - -
- string -
- 		- -
Specify the local-as for this vrf.
-
-
- log_neighbor_changes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Log a message for neighbor up/down event.
-
-
- maxas_limit - -
- integer -
- 		- -
Allow AS-PATH attribute from EBGP neighbor imposing a limit on number of ASes.
-
-
- neighbor_down - -
- dictionary -
- 		- -
Handle BGP neighbor down event, due to various reasons.
-
-
- fib_accelerate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor.
-
-
- neighbors - -
- list - / elements=dictionary -
- 		- -
Configure BGP neighbors.
-
-
- bfd - -
- dictionary -
- 		- -
Bidirectional Fast Detection for the neighbor.
-
-
- multihop - -
- dictionary -
- 		- -
Multihop session.
-
-
- interval - -
- dictionary -
- 		- -
Configure BFD session interval parameters.
-
-
- min_rx_interval - -
- integer -
- 		- -
Minimum RX interval.
-
-
- multiplier - -
- integer -
- 		- -
Detect Multiplier.
-
-
- tx_interval - -
- integer -
- 		- -
TX interval in milliseconds.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD multihop.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD for this neighbor.
-
-
- singlehop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Single-hop session.
-
-
- bmp_activate_server - -
- integer -
- 		- -
Specify server ID for activating BMP monitoring for the peer.
-
-
- capability - -
- dictionary -
- 		- -
Capability.
-
-
- suppress_4_byte_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress 4-byte AS Capability.
-
-
- description - -
- string -
- 		- -
Neighbor specific descripion.
-
-
- disable_connected_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable check for directly connected peer.
-
-
- dont_capability_negotiate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't negotiate capability with this neighbor.
-
-
- dscp - -
- string -
- 		- -
Set dscp value for tcp transport.
-
-
- dynamic_capability - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Dynamic Capability
-
-
- ebgp_multihop - -
- integer -
- 		- -
Specify multihop TTL for remote peer.
-
-
- graceful_shutdown - -
- dictionary -
- 		- -
Graceful-shutdown for this neighbor.
-
-
- activate - -
- dictionary -
- 		- -
Send graceful-shutdown community.
-
-
- route_map - -
- string -
- 		- -
Apply route-map to modify attributes for outbound.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set activate.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a template.
-
-
- peer - -
- string -
- 		- -
Peer template to inherit.
-
-
- peer_session - -
- string -
- 		- -
Peer-session template to inherit.
-
-
- local_as - -
- string -
- 		- -
Specify the local-as number for the eBGP neighbor.
-
-
- log_neighbor_changes - -
- dictionary -
- 		- -
Log message for neighbor up/down event.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable logging of neighbor up/down event.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set log-neighbor-changes.
-
-
- low_memory - -
- dictionary -
- 		- -
Behaviour in low memory situations.
-
-
- exempt - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not shutdown this peer when under memory pressure.
-
-
- neighbor_address - -
- string - / required -
- 		- -
IP address/Prefix of the neighbor or interface.
-
-
- neighbor_affinity_group - -
- dictionary -
- 		- -
Configure an affinity group.
-
-
- group_id - -
- integer -
- 		- -
Affinity Group ID.
-
-
- password - -
- dictionary -
- 		- -
Configure a password for neighbor.
-
-
- encryption - -
- integer -
- 		- -
0 specifies an UNENCRYPTED neighbor password.
-
3 specifies an 3DES ENCRYPTED neighbor password will follow.
-
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
-
-
- key - -
- string -
- 		- -
Authentication password.
-
-
- path_attribute - -
- list - / elements=dictionary -
- 		- -
BGP path attribute optional filtering.
-
-
- action - -
- string -
- 		-
    Choices: -
  • discard
    • -
  • treat-as-withdraw
    • -
- 		-
Action.
-
-
- range - -
- dictionary -
- 		- -
Path attribute range.
-
-
- end - -
- integer -
- 		- -
Path attribute range end value.
-
-
- start - -
- integer -
- 		- -
Path attribute range start value.
-
-
- type - -
- integer -
- 		- -
Path attribute type
-
-
- peer_type - -
- string -
- 		-
    Choices: -
  • fabric-border-leaf
    • -
  • fabric-external
    • -
- 		-
Neighbor facing
-
-
- remote_as - -
- string -
- 		- -
Specify Autonomous System Number of the neighbor.
-
-
- remote_as_route_map - -
- string -
- 		- -
Route-map to match prefix peer AS number.
-
-
- remove_private_as - -
- dictionary -
- 		- -
Remove private AS number from outbound updates.
-
-
- all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All.
-
-
- replace_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Replace.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove private AS.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively shutdown this neighbor.
-
-
- timers - -
- dictionary -
- 		- -
Configure keepalive and hold timers.
-
-
- holdtime - -
- integer -
- 		- -
Holdtime (seconds).
-
-
- keepalive - -
- integer -
- 		- -
Keepalive interval (seconds).
-
-
- transport - -
- dictionary -
- 		- -
BGP transport connection.
-
-
- connection_mode - -
- dictionary -
- 		- -
Specify type of connection.
-
-
- passive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow passive connection setup only.
-
-
- ttl_security - -
- dictionary -
- 		- -
Enable TTL Security Mechanism.
-
-
- hops - -
- integer -
- 		- -
Specify hop count for remote peer.
-
-
- update_source - -
- string -
- 		- -
Specify source of BGP session and updates.
-
-
- reconnect_interval - -
- integer -
- 		- -
Configure connection reconnect interval.
-
-
- router_id - -
- string -
- 		- -
Specify the IP address to use as router-id.
-
-
- timers - -
- dictionary -
- 		- -
Configure bgp related timers.
-
-
- bestpath_limit - -
- dictionary -
- 		- -
Configure timeout for first bestpath after restart.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure update-delay-always option.
-
-
- timeout - -
- integer -
- 		- -
Bestpath timeout (seconds).
-
-
- bgp - -
- dictionary -
- 		- -
Configure different bgp keepalive and holdtimes.
-
-
- holdtime - -
- integer -
- 		- -
Holdtime (seconds).
-
-
- keepalive - -
- integer -
- 		- -
Keepalive interval (seconds).
-
-
- prefix_peer_timeout - -
- integer -
- 		- -
Prefix Peer timeout (seconds).
-
-
- prefix_peer_wait - -
- integer -
- 		- -
Configure wait timer for a prefix peer.
-
-
- vrf - -
- string -
- 		- -
VRF name.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^router bgp'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • purged
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
State purged removes all the BGP configurations from the target device. Use caution with this state.
-
State deleted only removes BGP attributes that this modules manages and does not negate the BGP process completely. Thereby, preserving address-family related configurations under BGP context.
-
Running states deleted and replaced will result in an error if there are address-family configuration lines present under a neighbor, or a vrf context that is to be removed. Please use the cisco.nxos.nxos_bgp_af or cisco.nxos.nxos_bgp_neighbor_af modules for prior cleanup.
-
States merged and replaced will result in a failure if BGP is already configured with a different ASN than what is provided in the task. In such cases, please use state purged to remove the existing BGP process and proceed further.
-
States replaced and overridden have the same behaviour for this module.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - Unsupported for Cisco MDS - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # Nexus9000v# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_bgp_global: - config: - as_number: 65563 - router_id: 192.168.1.1 - bestpath: - as_path: - multipath_relax: true - compare_neighborid: true - cost_community_ignore: true - confederation: - identifier: 42 - peers: - - 65020 - - 65030 - - 65040 - log_neighbor_changes: true - maxas_limit: 20 - neighbors: - - neighbor_address: 192.168.1.100 - neighbor_affinity_group: - group_id: 160 - bmp_activate_server: 1 - remote_as: 65563 - description: NBR-1 - low_memory: - exempt: true - - neighbor_address: 192.168.1.101 - remote_as: 65563 - password: - encryption: 7 - key: 12090404011C03162E - neighbor_down: - fib_accelerate: true - vrfs: - - vrf: site-1 - allocate_index: 5000 - local_as: 200 - log_neighbor_changes: true - neighbors: - - neighbor_address: 198.51.100.1 - description: site-1-nbr-1 - password: - encryption: 3 - key: 13D4D3549493D2877B1DC116EE27A6BE - remote_as: 65562 - - neighbor_address: 198.51.100.2 - remote_as: 65562 - description: site-1-nbr-2 - - vrf: site-2 - local_as: 300 - log_neighbor_changes: true - neighbors: - - neighbor_address: 203.0.113.2 - description: site-2-nbr-1 - password: - encryption: 3 - key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - remote_as: 65568 - neighbor_down: - fib_accelerate: true - - # Task output: - # ------------ - # before: {} - # - # commands: - # - router bgp 65563 - # - bestpath as-path multipath-relax - # - bestpath compare-neighborid - # - bestpath cost-community ignore - # - confederation identifier 42 - # - log-neighbor-changes - # - maxas-limit 20 - # - neighbor-down fib-accelerate - # - router-id 192.168.1.1 - # - confederation peers 65020 65030 65040 - # - neighbor 192.168.1.100 - # - remote-as 65563 - # - affinity-group 160 - # - bmp-activate-server 1 - # - description NBR-1 - # - low-memory exempt - # - neighbor 192.168.1.101 - # - remote-as 65563 - # - password 7 12090404011C03162E - # - vrf site-1 - # - allocate-index 5000 - # - local-as 200 - # - log-neighbor-changes - # - neighbor 198.51.100.1 - # - remote-as 65562 - # - description site-1-nbr-1 - # - password 3 13D4D3549493D2877B1DC116EE27A6BE - # - neighbor 198.51.100.2 - # - remote-as 65562 - # - description site-1-nbr-2 - # - vrf site-2 - # - local-as 300 - # - log-neighbor-changes - # - neighbor-down fib-accelerate - # - neighbor 203.0.113.2 - # - remote-as 65568 - # - description site-2-nbr-1 - # - password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - # - # after: - # as_number: '65563' - # bestpath: - # as_path: - # multipath_relax: true - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65040' - # log_neighbor_changes: true - # maxas_limit: 20 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # - neighbor_address: 192.168.1.101 - # password: - # encryption: 7 - # key: 12090404011C03162E - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - allocate_index: 5000 - # local_as: '200' - # log_neighbor_changes: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 198.51.100.1 - # password: - # encryption: 3 - # key: 13D4D3549493D2877B1DC116EE27A6BE - # remote_as: '65562' - # - description: site-1-nbr-2 - # neighbor_address: 198.51.100.2 - # remote_as: '65562' - # vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - description: site-2-nbr-1 - # neighbor_address: 203.0.113.2 - # password: - # encryption: 3 - # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - # remote_as: '65568' - # vrf: site-2 - - - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65040 - # bestpath as-path multipath-relax - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 20 - # log-neighbor-changes - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # neighbor 192.168.1.101 - # remote-as 65563 - # password 7 12090404011C03162E - # vrf site-1 - # local-as 200 - # log-neighbor-changes - # allocate-index 5000 - # neighbor 198.51.100.1 - # remote-as 65562 - # description site-1-nbr-1 - # password 3 13D4D3549493D2877B1DC116EE27A6BE - # neighbor 198.51.100.2 - # remote-as 65562 - # description site-1-nbr-2 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # remote-as 65568 - # description site-2-nbr-1 - # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - # Using replaced - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65040 - # bestpath as-path multipath-relax - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 20 - # log-neighbor-changes - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # neighbor 192.168.1.101 - # remote-as 65563 - # password 7 12090404011C03162E - # vrf site-1 - # local-as 200 - # log-neighbor-changes - # allocate-index 5000 - # neighbor 198.51.100.1 - # remote-as 65562 - # description site-1-nbr-1 - # password 3 13D4D3549493D2877B1DC116EE27A6BE - # neighbor 198.51.100.2 - # remote-as 65562 - # description site-1-nbr-2 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # remote-as 65568 - # description site-2-nbr-1 - # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - - name: Replace BGP configuration with provided configuration - cisco.nxos.nxos_bgp_global: - config: - as_number: 65563 - router_id: 192.168.1.1 - bestpath: - compare_neighborid: true - cost_community_ignore: true - confederation: - identifier: 42 - peers: - - 65020 - - 65030 - - 65050 - maxas_limit: 40 - neighbors: - - neighbor_address: 192.168.1.100 - neighbor_affinity_group: - group_id: 160 - bmp_activate_server: 1 - remote_as: 65563 - description: NBR-1 - low_memory: - exempt: true - neighbor_down: - fib_accelerate: true - vrfs: - - vrf: site-2 - local_as: 300 - log_neighbor_changes: true - neighbors: - - neighbor_address: 203.0.113.2 - password: - encryption: 7 - key: 12090404011C03162E - neighbor_down: - fib_accelerate: true - state: replaced - - # Task output: - # ------------ - # before: - # as_number: '65563' - # bestpath: - # as_path: - # multipath_relax: true - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65040' - # log_neighbor_changes: true - # maxas_limit: 20 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # - neighbor_address: 192.168.1.101 - # password: - # encryption: 7 - # key: 12090404011C03162E - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - allocate_index: 5000 - # local_as: '200' - # log_neighbor_changes: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 198.51.100.1 - # password: - # encryption: 3 - # key: 13D4D3549493D2877B1DC116EE27A6BE - # remote_as: '65562' - # - description: site-1-nbr-2 - # neighbor_address: 198.51.100.2 - # remote_as: '65562' - # vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - description: site-2-nbr-1 - # neighbor_address: 203.0.113.2 - # password: - # encryption: 3 - # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - # remote_as: '65568' - # vrf: site-2 - # - # commands: - # - router bgp 65563 - # - no bestpath as-path multipath-relax - # - no log-neighbor-changes - # - maxas-limit 40 - # - no confederation peers 65020 65030 65040 - # - confederation peers 65020 65030 65050 - # - no neighbor 192.168.1.101 - # - vrf site-2 - # - neighbor 203.0.113.2 - # - no remote-as 65568 - # - no description site-2-nbr-1 - # - password 7 12090404011C03162E - # - no vrf site-1 - - # after: - # as_number: '65563' - # bestpath: - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65050' - # maxas_limit: 40 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - neighbor_address: 203.0.113.2 - # password: - # encryption: 7 - # key: 12090404011C03162E - # vrf: site-2 - # - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65050 - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 40 - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # password 7 12090404011C03162E - - # Using deleted - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65040 - # bestpath as-path multipath-relax - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 20 - # log-neighbor-changes - # address-family ipv4 unicast - # default-metric 400 - # suppress-inactive - # default-information originate - # address-family ipv6 multicast - # wait-igp-convergence - # redistribute eigrp eigrp-1 route-map site-1-rmap - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # neighbor 192.168.1.101 - # remote-as 65563 - # password 7 12090404011C03162E - # vrf site-1 - # local-as 200 - # log-neighbor-changes - # allocate-index 5000 - # address-family ipv4 multicast - # maximum-paths 40 - # dampen-igp-metric 1200 - # neighbor 198.51.100.1 - # remote-as 65562 - # description site-1-nbr-1 - # password 3 13D4D3549493D2877B1DC116EE27A6BE - # neighbor 198.51.100.2 - # remote-as 65562 - # description site-1-nbr-2 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # remote-as 65568 - # description site-1-nbr-1 - # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - - name: Delete BGP configurations handled by this module - cisco.nxos.nxos_bgp_global: - state: deleted - - # Task output: - # ------------ - - # before: - # as_number: '65563' - # bestpath: - # as_path: - # multipath_relax: true - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65040' - # log_neighbor_changes: true - # maxas_limit: 20 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # - neighbor_address: 192.168.1.101 - # password: - # encryption: 7 - # key: 12090404011C03162E - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - allocate_index: 5000 - # local_as: '200' - # log_neighbor_changes: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 198.51.100.1 - # password: - # encryption: 3 - # key: 13D4D3549493D2877B1DC116EE27A6BE - # remote_as: '65562' - # - description: site-1-nbr-2 - # neighbor_address: 198.51.100.2 - # remote_as: '65562' - # vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 203.0.113.2 - # password: - # encryption: 3 - # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - # remote_as: '65568' - # vrf: site-2 - # - # commands: - # - router bgp 65563 - # - no bestpath as-path multipath-relax - # - no bestpath compare-neighborid - # - no bestpath cost-community ignore - # - no confederation identifier 42 - # - no log-neighbor-changes - # - no maxas-limit 20 - # - no neighbor-down fib-accelerate - # - no router-id 192.168.1.1 - # - no confederation peers 65020 65030 65040 - # - no neighbor 192.168.1.100 - # - no neighbor 192.168.1.101 - # - no vrf site-1 - # - no vrf site-2 - # - # after: - # as_number: '65563' - # - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # address-family ipv4 unicast - # default-metric 400 - # suppress-inactive - # default-information originate - # address-family ipv6 multicast - # wait-igp-convergence - # redistribute eigrp eigrp-1 route-map site-1-rmap - # - - # Using purged - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65040 - # bestpath as-path multipath-relax - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 20 - # log-neighbor-changes - # address-family ipv4 unicast - # default-metric 400 - # suppress-inactive - # default-information originate - # address-family ipv6 multicast - # wait-igp-convergence - # redistribute eigrp eigrp-1 route-map site-1-rmap - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # neighbor 192.168.1.101 - # remote-as 65563 - # password 7 12090404011C03162E - # vrf site-1 - # local-as 200 - # log-neighbor-changes - # allocate-index 5000 - # address-family ipv4 multicast - # maximum-paths 40 - # dampen-igp-metric 1200 - # neighbor 198.51.100.1 - # remote-as 65562 - # description site-1-nbr-1 - # password 3 13D4D3549493D2877B1DC116EE27A6BE - # neighbor 198.51.100.2 - # remote-as 65562 - # description site-1-nbr-2 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # remote-as 65568 - # description site-1-nbr-1 - # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - - name: Purge all BGP configurations from the device - cisco.nxos.nxos_bgp_global: - state: purged - - # Task output: - # ------------ - - # before: - # as_number: '65563' - # bestpath: - # as_path: - # multipath_relax: true - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65040' - # log_neighbor_changes: true - # maxas_limit: 20 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # - neighbor_address: 192.168.1.101 - # password: - # encryption: 7 - # key: 12090404011C03162E - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - allocate_index: 5000 - # local_as: '200' - # log_neighbor_changes: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 198.51.100.1 - # password: - # encryption: 3 - # key: 13D4D3549493D2877B1DC116EE27A6BE - # remote_as: '65562' - # - description: site-1-nbr-2 - # neighbor_address: 198.51.100.2 - # remote_as: '65562' - # vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 203.0.113.2 - # password: - # encryption: 3 - # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - # remote_as: '65568' - # vrf: site-2 - # - # commands: - # - no router bgp 65563 - # - # after: {} - # - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # Nexus9000v# - - # Using rendered - - - name: Render platform specific configuration lines (without connecting to the device) - cisco.nxos.nxos_bgp_global: - config: - as_number: 65563 - router_id: 192.168.1.1 - bestpath: - as_path: - multipath_relax: true - compare_neighborid: true - cost_community_ignore: true - confederation: - identifier: 42 - peers: - - 65020 - - 65030 - - 65040 - log_neighbor_changes: true - maxas_limit: 20 - neighbors: - - neighbor_address: 192.168.1.100 - neighbor_affinity_group: - group_id: 160 - bmp_activate_server: 1 - remote_as: 65563 - description: NBR-1 - low_memory: - exempt: true - - neighbor_address: 192.168.1.101 - remote_as: 65563 - password: - encryption: 7 - key: 12090404011C03162E - neighbor_down: - fib_accelerate: true - vrfs: - - vrf: site-1 - allocate_index: 5000 - local_as: 200 - log_neighbor_changes: true - neighbors: - - neighbor_address: 198.51.100.1 - description: site-1-nbr-1 - password: - encryption: 3 - key: 13D4D3549493D2877B1DC116EE27A6BE - remote_as: 65562 - - neighbor_address: 198.51.100.2 - remote_as: 65562 - description: site-1-nbr-2 - - vrf: site-2 - local_as: 300 - log_neighbor_changes: true - neighbors: - - neighbor_address: 203.0.113.2 - description: site-1-nbr-1 - password: - encryption: 3 - key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - remote_as: 65568 - neighbor_down: - fib_accelerate: true - - # Task output: - # ------------ - # rendered: - # - router bgp 65563 - # - bestpath as-path multipath-relax - # - bestpath compare-neighborid - # - bestpath cost-community ignore - # - confederation identifier 42 - # - log-neighbor-changes - # - maxas-limit 20 - # - neighbor-down fib-accelerate - # - router-id 192.168.1.1 - # - confederation peers 65020 65030 65040 - # - neighbor 192.168.1.100 - # - remote-as 65563 - # - affinity-group 160 - # - bmp-activate-server 1 - # - description NBR-1 - # - low-memory exempt - # - neighbor 192.168.1.101 - # - remote-as 65563 - # - password 7 12090404011C03162E - # - vrf site-1 - # - allocate-index 5000 - # - local-as 200 - # - log-neighbor-changes - # - neighbor 198.51.100.1 - # - remote-as 65562 - # - description site-1-nbr-1 - # - password 3 13D4D3549493D2877B1DC116EE27A6BE - # - neighbor 198.51.100.2 - # - remote-as 65562 - # - description site-1-nbr-2 - # - vrf site-2 - # - local-as 300 - # - log-neighbor-changes - # - neighbor-down fib-accelerate - # - neighbor 203.0.113.2 - # - remote-as 65568 - # - description site-1-nbr-1 - # - password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - # Using parsed - - # parsed.cfg - # ------------ - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65040 - # bestpath as-path multipath-relax - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 20 - # log-neighbor-changes - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # neighbor 192.168.1.101 - # remote-as 65563 - # password 7 12090404011C03162E - # vrf site-1 - # local-as 200 - # log-neighbor-changes - # allocate-index 5000 - # neighbor 198.51.100.1 - # remote-as 65562 - # description site-1-nbr-1 - # password 3 13D4D3549493D2877B1DC116EE27A6BE - # neighbor 198.51.100.2 - # remote-as 65562 - # description site-1-nbr-2 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # remote-as 65568 - # description site-1-nbr-1 - # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - - name: Parse externally provided BGP config - cisco.nxos.nxos_bgp_global: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output: - # ------------ - # parsed: - # as_number: '65563' - # bestpath: - # as_path: - # multipath_relax: true - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65040' - # log_neighbor_changes: true - # maxas_limit: 20 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # - neighbor_address: 192.168.1.101 - # password: - # encryption: 7 - # key: 12090404011C03162E - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - allocate_index: 5000 - # local_as: '200' - # log_neighbor_changes: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 198.51.100.1 - # password: - # encryption: 3 - # key: 13D4D3549493D2877B1DC116EE27A6BE - # remote_as: '65562' - # - description: site-1-nbr-2 - # neighbor_address: 198.51.100.2 - # remote_as: '65562' - # vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 203.0.113.2 - # password: - # encryption: 3 - # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - # remote_as: '65568' - # vrf: site-2 - - # Using gathered - - # existing config - # - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65050 - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 40 - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # vrf site-1 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # password 7 12090404011C03162E - - - name: Gather BGP facts using gathered - cisco.nxos.nxos_bgp_global: - state: gathered - - # Task output: - # ------------ - # gathered: - # as_number: '65563' - # bestpath: - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65050' - # maxas_limit: 40 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - neighbor_address: 203.0.113.2 - # password: - # encryption: 7 - # key: 12090404011C03162E - # vrf: site-2 - - # Remove a neighbor having AF configurations with state replaced (will fail) - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # log-neighbor-changes - # maxas-limit 20 - # router-id 198.51.100.2 - # neighbor 203.0.113.2 - # address-family ipv4 unicast - # next-hop-self - # remote-as 65538 - # affinity-group 160 - # description NBR-1 - # low-memory exempt - # neighbor 192.0.2.1 - # remote-as 65537 - # password 7 12090404011C03162E - - - name: Remove a neighbor having AF configurations (should fail) - cisco.nxos.nxos_bgp_global: - config: - as_number: 65536 - router_id: 198.51.100.2 - maxas_limit: 20 - log_neighbor_changes: true - neighbors: - - neighbor_address: 192.0.2.1 - remote_as: 65537 - password: - encryption: 7 - key: 12090404011C03162E - state: replaced - - # Task output: - # ------------ - # fatal: [Nexus9000v]: FAILED! => changed=false - # msg: Neighbor 203.0.113.2 has address-family configurations. - # Please use the nxos_bgp_neighbor_af module to remove those first. - - # Remove a VRF having AF configurations with state replaced (will fail) - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # log-neighbor-changes - # maxas-limit 20 - # router-id 198.51.100.2 - # neighbor 192.0.2.1 - # remote-as 65537 - # password 7 12090404011C03162E - # vrf site-1 - # address-family ipv4 unicast - # default-information originate - # neighbor 203.0.113.2 - # remote-as 65538 - # affinity-group 160 - # description NBR-1 - # low-memory exempt - # vrf site-2 - # neighbor-down fib-accelerate - - - name: Remove a VRF having AF configurations (should fail) - cisco.nxos.nxos_bgp_global: - config: - as_number: 65536 - router_id: 198.51.100.2 - maxas_limit: 20 - log_neighbor_changes: true - neighbors: - - neighbor_address: 192.0.2.1 - remote_as: 65537 - password: - encryption: 7 - key: 12090404011C03162E - vrfs: - - vrf: site-2 - neighbor_down: - fib_accelerate: true - state: replaced - - # Task output: - # ------------ - # fatal: [Nexus9000v]: FAILED! => changed=false - # msg: VRF site-1 has address-family configurations. - # Please use the nxos_bgp_af module to remove those first. - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['router bgp 65563', 'maxas-limit 20', 'router-id 192.168.1.1', 'confederation peers 65020 65030 65040', 'neighbor 192.168.1.100', 'remote-as 65563', 'affinity-group 160', 'bmp-activate-server 1', 'description NBR-1', 'low-memory exempt', 'vrf site-1', 'log-neighbor-changes', 'neighbor 198.51.100.1', 'remote-as 65562', 'description site-1-nbr-1', 'password 3 13D4D3549493D2877B1DC116EE27A6BE']
-
-
- gathered - -
- dictionary -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- dictionary -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['router bgp 65563', 'maxas-limit 20', 'router-id 192.168.1.1']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst b/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst deleted file mode 100644 index 8668a0b9f..000000000 --- a/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst +++ /dev/null @@ -1,3575 +0,0 @@ -.. _cisco.nxos.nxos_bgp_neighbor_address_family_module: - - -******************************************* -cisco.nxos.nxos_bgp_neighbor_address_family -******************************************* - -**BGP Neighbor Address Family resource module.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages BGP Neighbor Address Family configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
BGP Neighbor AF configuration.
-
-
- as_number - -
- string -
- 		- -
Autonomous System Number of the router.
-
-
- neighbors - -
- list - / elements=dictionary -
- 		- -
A list of BGP Neighbor AF configuration.
-
-
- address_family - -
- list - / elements=dictionary -
- 		- -
BGP Neighbor Address Family related configurations.
-
-
- advertise_map - -
- dictionary -
- 		- -
Specify route-map for conditional advertisement.
-
-
- exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition exists.
-
-
- non_exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition does not exist.
-
-
- route_map - -
- string - / required -
- 		- -
Route-map name.
-
-
- advertisement_interval - -
- integer -
- 		- -
Minimum interval between sending BGP routing updates.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
  • link-state
    • -
  • vpnv4
    • -
  • vpnv6
    • -
  • l2vpn
    • -
- 		-
Address Family indicator.
-
-
- allowas_in - -
- dictionary -
- 		- -
Accept as-path with my AS present in it.
-
-
- max_occurences - -
- integer -
- 		- -
Number of occurrences of AS number, default is 3.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Activate allowas-in property.
-
-
- as_override - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Override matching AS-number while sending update.
-
-
- capability - -
- dictionary -
- 		- -
Advertise capability to the peer.
-
-
- additional_paths - -
- dictionary -
- 		- -
Additional paths capability.
-
-
- receive - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Receive capability.
-
-
- send - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Send capability.
-
-
- default_originate - -
- dictionary -
- 		- -
Originate a default toward this peer.
-
-
- route_map - -
- string -
- 		- -
Route-map to specify criteria for originating default.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set default-originate attribute.
-
-
- disable_peer_as_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable checking of peer AS-number while advertising.
-
-
- filter_list - -
- dictionary -
- 		- -
Name of filter-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a template.
-
-
- sequence - -
- integer -
- 		- -
Sequence number.
-
-
- template - -
- string -
- 		- -
Template name.
-
-
- maximum_prefix - -
- dictionary -
- 		- -
Maximum number of prefixes from this neighbor.
-
-
- generate_warning_threshold - -
- integer -
- 		- -
Threshold percentage at which to generate a warning.
-
-
- max_prefix_limit - -
- integer -
- 		- -
Maximum prefix limit.
-
-
- restart_interval - -
- integer -
- 		- -
Restart bgp connection after limit is exceeded.
-
-
- warning_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Only give a warning message when limit is exceeded.
-
-
- next_hop_self - -
- dictionary -
- 		- -
Set our address as nexthop (non-reflected).
-
-
- all_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set our address as nexthop for all routes.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set next-hop-self attribute.
-
-
- next_hop_third_party - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compute a third-party nexthop if possible.
-
-
- prefix_list - -
- dictionary -
- 		- -
Apply prefix-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- rewrite_evpn_rt_asn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Auto generate RTs for EBGP neighbor.
-
-
- rewrite_rt_asn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Auto generate RTs for EBGP neighbor.
-
-
- route_map - -
- dictionary -
- 		- -
Apply route-map to neighbor.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- route_reflector_client - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure a neighbor as Route reflector client.
-
-
- safi - -
- string -
- 		-
    Choices: -
  • unicast
    • -
  • multicast
    • -
  • mvpn
    • -
  • evpn
    • -
- 		-
Sub Address Family indicator.
-
-
- send_community - -
- dictionary -
- 		- -
Send Community attribute to this neighbor.
-
-
- both - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Standard and Extended Community attributes.
-
-
- extended - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Extended Community attribute.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set send-community attribute.
-
-
- standard - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Standard Community attribute.
-
-
- soft_reconfiguration_inbound - -
- dictionary -
- 		- -
Soft reconfiguration.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always perform inbound soft reconfiguration.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set soft-reconfiguration inbound attribute.
-
-
- soo - -
- string -
- 		- -
Specify Site-of-origin extcommunity.
-
-
- suppress_inactive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise only active routes to peer.
-
-
- unsuppress_map - -
- string -
- 		- -
Route-map to selectively unsuppress suppressed routes.
-
-
- weight - -
- integer -
- 		- -
Set default weight for routes from this neighbor.
-
-
- neighbor_address - -
- string - / required -
- 		- -
IP/IPv6 address of the neighbor.
-
-
- vrfs - -
- list - / elements=dictionary -
- 		- -
Virtual Router Context.
-
-
- neighbors - -
- list - / elements=dictionary -
- 		- -
A list of BGP Neighbor AF configuration.
-
-
- address_family - -
- list - / elements=dictionary -
- 		- -
BGP Neighbor Address Family related configurations.
-
-
- advertise_map - -
- dictionary -
- 		- -
Specify route-map for conditional advertisement.
-
-
- exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition exists.
-
-
- non_exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition does not exist.
-
-
- route_map - -
- string - / required -
- 		- -
Route-map name.
-
-
- advertisement_interval - -
- integer -
- 		- -
Minimum interval between sending BGP routing updates.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
  • link-state
    • -
  • vpnv4
    • -
  • vpnv6
    • -
  • l2vpn
    • -
- 		-
Address Family indicator.
-
-
- allowas_in - -
- dictionary -
- 		- -
Accept as-path with my AS present in it.
-
-
- max_occurences - -
- integer -
- 		- -
Number of occurrences of AS number, default is 3.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Activate allowas-in property.
-
-
- as_override - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Override matching AS-number while sending update.
-
-
- capability - -
- dictionary -
- 		- -
Advertise capability to the peer.
-
-
- additional_paths - -
- dictionary -
- 		- -
Additional paths capability.
-
-
- receive - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Receive capability.
-
-
- send - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Send capability.
-
-
- default_originate - -
- dictionary -
- 		- -
Originate a default toward this peer.
-
-
- route_map - -
- string -
- 		- -
Route-map to specify criteria for originating default.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set default-originate attribute.
-
-
- disable_peer_as_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable checking of peer AS-number while advertising.
-
-
- filter_list - -
- dictionary -
- 		- -
Name of filter-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a template.
-
-
- sequence - -
- integer -
- 		- -
Sequence number.
-
-
- template - -
- string -
- 		- -
Template name.
-
-
- maximum_prefix - -
- dictionary -
- 		- -
Maximum number of prefixes from this neighbor.
-
-
- generate_warning_threshold - -
- integer -
- 		- -
Threshold percentage at which to generate a warning.
-
-
- max_prefix_limit - -
- integer -
- 		- -
Maximum prefix limit.
-
-
- restart_interval - -
- integer -
- 		- -
Restart bgp connection after limit is exceeded.
-
-
- warning_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Only give a warning message when limit is exceeded.
-
-
- next_hop_self - -
- dictionary -
- 		- -
Set our address as nexthop (non-reflected).
-
-
- all_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set our address as nexthop for all routes.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set next-hop-self attribute.
-
-
- next_hop_third_party - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compute a third-party nexthop if possible.
-
-
- prefix_list - -
- dictionary -
- 		- -
Apply prefix-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- rewrite_evpn_rt_asn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Auto generate RTs for EBGP neighbor.
-
-
- rewrite_rt_asn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Auto generate RTs for EBGP neighbor.
-
-
- route_map - -
- dictionary -
- 		- -
Apply route-map to neighbor.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- route_reflector_client - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure a neighbor as Route reflector client.
-
-
- safi - -
- string -
- 		-
    Choices: -
  • unicast
    • -
  • multicast
    • -
  • mvpn
    • -
  • evpn
    • -
- 		-
Sub Address Family indicator.
-
-
- send_community - -
- dictionary -
- 		- -
Send Community attribute to this neighbor.
-
-
- both - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Standard and Extended Community attributes.
-
-
- extended - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Extended Community attribute.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set send-community attribute.
-
-
- standard - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Standard Community attribute.
-
-
- soft_reconfiguration_inbound - -
- dictionary -
- 		- -
Soft reconfiguration.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always perform inbound soft reconfiguration.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set soft-reconfiguration inbound attribute.
-
-
- soo - -
- string -
- 		- -
Specify Site-of-origin extcommunity.
-
-
- suppress_inactive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise only active routes to peer.
-
-
- unsuppress_map - -
- string -
- 		- -
Route-map to selectively unsuppress suppressed routes.
-
-
- weight - -
- integer -
- 		- -
Set default weight for routes from this neighbor.
-
-
- neighbor_address - -
- string - / required -
- 		- -
IP/IPv6 address of the neighbor.
-
-
- vrf - -
- string -
- 		- -
VRF name.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^router bgp'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
State deleted only removes BGP attributes that this modules manages and does not negate the BGP process completely.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - Unsupported for Cisco MDS - - For managing BGP address family configurations please use the :ref:`cisco.nxos.nxos_bgp_address_family ` module. - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # Nexus9000v# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_bgp_neighbor_address_family: &id001 - config: - as_number: 65536 - neighbors: - - neighbor_address: 192.0.2.32 - address_family: - - afi: ipv4 - safi: unicast - maximum_prefix: - max_prefix_limit: 20 - generate_warning_threshold: 75 - weight: 100 - prefix_list: - inbound: rmap1 - outbound: rmap2 - - afi: ipv6 - safi: unicast - - neighbor_address: 192.0.2.33 - address_family: - - afi: ipv4 - safi: multicast - inherit: - template: BasePolicy - sequence: 200 - vrfs: - - vrf: site-1 - neighbors: - - neighbor_address: 203.0.113.1 - address_family: - - afi: ipv4 - safi: unicast - suppress_inactive: true - next_hop_self: - set: true - - neighbor_address: 203.0.113.2 - address_family: - - afi: ipv6 - safi: unicast - - afi: ipv4 - safi: multicast - send_community: - set: true - - # Task output: - # ------------ - # before: {} - # - # commands: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - address-family ipv4 unicast - # - maximum-prefix 20 75 - # - weight 100 - # - prefix-list rmap1 in - # - prefix-list rmap2 out - # - address-family ipv6 unicast - # - neighbor 192.0.2.33 - # - address-family ipv4 multicast - # - inherit peer-policy BasePolicy 200 - # - vrf site-1 - # - neighbor 203.0.113.1 - # - address-family ipv4 unicast - # - suppress-inactive - # - next-hop-self - # - neighbor 203.0.113.2 - # - address-family ipv6 unicast - # - address-family ipv4 multicast - # - send-community - # - # after: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - # Using replaced - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - - name: Replace specified neighbor AFs with given configuration - cisco.nxos.nxos_bgp_neighbor_address_family: &replaced - config: - as_number: 65536 - neighbors: - - neighbor_address: 192.0.2.32 - address_family: - - afi: ipv4 - safi: unicast - weight: 110 - - afi: ipv6 - safi: unicast - - neighbor_address: 192.0.2.33 - address_family: - - afi: ipv4 - safi: multicast - inherit: - template: BasePolicy - sequence: 200 - vrfs: - - vrf: site-1 - neighbors: - - neighbor_address: 203.0.113.1 - address_family: - - afi: ipv4 - safi: unicast - - neighbor_address: 203.0.113.2 - address_family: - - afi: ipv6 - safi: unicast - - afi: ipv4 - safi: multicast - send_community: - set: true - state: replaced - - # Task output: - # ------------ - # before: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - # - # commands: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - address-family ipv4 unicast - # - no maximum-prefix 20 75 - # - weight 110 - # - no prefix-list rmap1 in - # - no prefix-list rmap2 out - # - vrf site-1 - # - neighbor 203.0.113.1 - # - address-family ipv4 unicast - # - no suppress-inactive - # - no next-hop-self - # - # after: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # weight: 110 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # weight 110 - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - # Using overridden - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - - name: Override all BGP AF configuration with provided configuration - cisco.nxos.nxos_bgp_neighbor_address_family: - config: - as_number: 65536 - neighbors: - - neighbor_address: 192.0.2.32 - address_family: - - afi: ipv4 - safi: unicast - vrfs: - - vrf: site-1 - neighbors: - - neighbor_address: 203.0.113.1 - address_family: - - afi: ipv4 - safi: unicast - suppress_inactive: true - next_hop_self: - set: true - state: overridden - - # Task output: - # ------------ - # before: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - # - # commands: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - address-family ipv4 unicast - # - no maximum-prefix 20 75 - # - no weight 100 - # - no prefix-list rmap1 in - # - no prefix-list rmap2 out - # - no address-family ipv6 unicast - # - neighbor 192.0.2.33 - # - no address-family ipv4 multicast - # - vrf site-1 - # - neighbor 203.0.113.2 - # - no address-family ipv4 multicast - # - no address-family ipv6 unicast - # - # after: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - - # Using deleted to remove specified neighbor AFs - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - - name: Delete BGP configs handled by this module - cisco.nxos.nxos_bgp_neighbor_address_family: - config: - as_number: 65536 - neighbors: - - neighbor_address: 192.0.2.32 - address_family: - - afi: ipv4 - safi: unicast - vrfs: - - vrf: site-1 - neighbors: - - neighbor_address: 203.0.113.2 - address_family: - - afi: ipv6 - safi: unicast - state: deleted - - # Task output: - # ------------ - # before: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - # - # commands: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - no address-family ipv4 unicast - # - vrf site-1 - # - neighbor 203.0.113.2 - # - no address-family ipv6 unicast - # - # after: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # - - # Using deleted to remove all neighbor AFs - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - - name: Delete all BGP neighbor AF configs handled by this module - cisco.nxos.nxos_bgp_neighbor_address_family: - state: deleted - - # Task output: - # ------------ - # before: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - # - # commands: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - no address-family ipv4 unicast - # - no address-family ipv6 unicast - # - neighbor 192.0.2.33 - # - no address-family ipv4 multicast - # - vrf site-1 - # - neighbor 203.0.113.1 - # - no address-family ipv4 unicast - # - neighbor 203.0.113.2 - # - no address-family ipv6 unicast - # - no address-family ipv4 multicast - # - # after: - # as_number: "65536" - # - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # neighbor 192.0.2.33 - # vrf site-1 - # neighbor 203.0.113.1 - # neighbor 203.0.113.2 - # - - # Using rendered - - - name: Render platform specific configuration lines with state rendered (without connecting to the device) - cisco.nxos.nxos_bgp_neighbor_address_family: - config: - as_number: 65536 - neighbors: - - neighbor_address: 192.0.2.32 - address_family: - - afi: ipv4 - safi: unicast - maximum_prefix: - max_prefix_limit: 20 - generate_warning_threshold: 75 - weight: 100 - prefix_list: - inbound: rmap1 - outbound: rmap2 - - afi: ipv6 - safi: unicast - - neighbor_address: 192.0.2.33 - address_family: - - afi: ipv4 - safi: multicast - inherit: - template: BasePolicy - sequence: 200 - vrfs: - - vrf: site-1 - neighbors: - - neighbor_address: 203.0.113.1 - address_family: - - afi: ipv4 - safi: unicast - suppress_inactive: true - next_hop_self: - set: true - - neighbor_address: 203.0.113.2 - address_family: - - afi: ipv6 - safi: unicast - - afi: ipv4 - safi: multicast - send_community: - set: true - state: rendered - - # Task output: - # ------------ - # rendered: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - address-family ipv4 unicast - # - maximum-prefix 20 75 - # - weight 100 - # - prefix-list rmap1 in - # - prefix-list rmap2 out - # - address-family ipv6 unicast - # - neighbor 192.0.2.33 - # - address-family ipv4 multicast - # - inherit peer-policy BasePolicy 200 - # - vrf site-1 - # - neighbor 203.0.113.1 - # - address-family ipv4 unicast - # - suppress-inactive - # - next-hop-self - # - neighbor 203.0.113.2 - # - address-family ipv6 unicast - # - address-family ipv4 multicast - # - send-community - - # Using parsed - - # parsed.cfg - # ------------ - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - - - name: Parse externally provided BGP neighbor AF config - register: result - cisco.nxos.nxos_bgp_neighbor_address_family: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output: - # ------------ - # parsed: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['router bgp 65536', 'neighbor 192.0.2.32', 'address-family ipv4 unicast']
-
-
- gathered - -
- dictionary -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- dictionary -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['router bgp 65536', 'neighbor 192.0.2.32', 'address-family ipv4 unicast']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_bgp_templates_module.rst b/docs/cisco.nxos.nxos_bgp_templates_module.rst deleted file mode 100644 index 9287d7a60..000000000 --- a/docs/cisco.nxos.nxos_bgp_templates_module.rst +++ /dev/null @@ -1,2841 +0,0 @@ -.. _cisco.nxos.nxos_bgp_templates_module: - - -***************************** -cisco.nxos.nxos_bgp_templates -***************************** - -**BGP Templates resource module.** - - -Version added: 4.2.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages BGP templates on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A list of BGP templates.
-
-
- as_number - -
- string -
- 		- -
Autonomous System Number of the router.
-
-
- neighbor - -
- list - / elements=dictionary -
- 		- -
Configure BGP peer templates.
-
-
- address_family - -
- list - / elements=dictionary -
- 		- -
Configure an address-family for peer.
-
-
- advertise_map - -
- dictionary -
- 		- -
Specify route-map for conditional advertisement.
-
-
- exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition exists.
-
-
- non_exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition does not exist.
-
-
- route_map - -
- string - / required -
- 		- -
Route-map name.
-
-
- advertisement_interval - -
- integer -
- 		- -
Minimum interval between sending BGP routing updates.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
  • link-state
    • -
  • l2vpn
    • -
- 		-
Address Family indicator.
-
-
- allowas_in - -
- dictionary -
- 		- -
Accept as-path with my AS present in it.
-
-
- max_occurences - -
- integer -
- 		- -
Number of occurrences of AS number, default is 3.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Activate allowas-in property.
-
-
- as_override - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Override matching AS-number while sending update.
-
-
- capability - -
- dictionary -
- 		- -
Advertise capability to the peer.
-
-
- additional_paths - -
- dictionary -
- 		- -
Additional paths capability.
-
-
- receive - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Receive capability.
-
-
- send - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Send capability.
-
-
- default_originate - -
- dictionary -
- 		- -
Originate a default toward this peer.
-
-
- route_map - -
- string -
- 		- -
Route-map to specify criteria for originating default.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set default-originate attribute.
-
-
- disable_peer_as_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable checking of peer AS-number while advertising.
-
-
- filter_list - -
- dictionary -
- 		- -
Name of filter-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a peer-policy template.
-
-
- peer_policy - -
- string -
- 		- -
Peer-policy template to inherit.
-
-
- maximum_prefix - -
- dictionary -
- 		- -
Maximum number of prefixes from this neighbor.
-
-
- generate_warning_threshold - -
- integer -
- 		- -
Threshold percentage at which to generate a warning.
-
-
- max_prefix_limit - -
- integer -
- 		- -
Maximum prefix limit.
-
-
- restart_interval - -
- integer -
- 		- -
Restart bgp connection after limit is exceeded.
-
-
- warning_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Only give a warning message when limit is exceeded.
-
-
- next_hop_self - -
- dictionary -
- 		- -
Set our address as nexthop (non-reflected).
-
-
- all_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set our address as nexthop for all routes.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set next-hop-self attribute.
-
-
- next_hop_third_party - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compute a third-party nexthop if possible.
-
-
- prefix_list - -
- dictionary -
- 		- -
Apply prefix-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- route_map - -
- dictionary -
- 		- -
Apply route-map to neighbor.
-
-
- inbound - -
- string -
- 		- -
Name of policy to apply to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Name of policy to apply to outgoing routes.
-
-
- route_reflector_client - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure a neighbor as Route reflector client.
-
-
- safi - -
- string -
- 		-
    Choices: -
  • unicast
    • -
  • multicast
    • -
  • mvpn
    • -
  • evpn
    • -
- 		-
Sub Address Family indicator.
-
-
- send_community - -
- string -
- 		-
    Choices: -
  • standard
    • -
  • extended
    • -
  • both
    • -
- 		-
Send Community attribute to this neighbor.
-
-
- soft_reconfiguration_inbound - -
- dictionary -
- 		- -
Soft reconfiguration.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always perform inbound soft reconfiguration.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set soft-reconfiguration inbound attribute.
-
-
- soo - -
- string -
- 		- -
Specify Site-of-origin extcommunity.
-
-
- suppress_inactive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise only active routes to peer.
-
-
- unsuppress_map - -
- string -
- 		- -
Route-map to selectively unsuppress suppressed routes.
-
-
- weight - -
- integer -
- 		- -
Set default weight for routes from this neighbor.
-
-
- bfd - -
- dictionary -
- 		- -
Bidirectional Fast Detection for the neighbor.
-
-
- multihop - -
- dictionary -
- 		- -
Multihop session.
-
-
- interval - -
- dictionary -
- 		- -
Configure BFD session interval parameters.
-
-
- min_rx_interval - -
- integer - / required -
- 		- -
Minimum RX interval.
-
-
- multiplier - -
- integer - / required -
- 		- -
Detect Multiplier.
-
-
- tx_interval - -
- integer - / required -
- 		- -
TX interval in milliseconds.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD multihop.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD for this neighbor.
-
-
- singlehop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Single-hop session.
-
-
- bmp_activate_server - -
- integer -
- 		- -
Specify server ID for activating BMP monitoring for the peer.
-
-
- capability - -
- dictionary -
- 		- -
Capability.
-
-
- suppress_4_byte_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress 4-byte AS Capability.
-
-
- description - -
- string -
- 		- -
Neighbor specific descripion.
-
-
- disable_connected_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable check for directly connected peer.
-
-
- dont_capability_negotiate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't negotiate capability with this neighbor.
-
-
- dscp - -
- string -
- 		- -
Set dscp value for tcp transport.
-
-
- dynamic_capability - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Dynamic Capability
-
-
- ebgp_multihop - -
- integer -
- 		- -
Specify multihop TTL for remote peer.
-
-
- graceful_shutdown - -
- dictionary -
- 		- -
Graceful-shutdown for this neighbor.
-
-
- activate - -
- dictionary -
- 		- -
Send graceful-shutdown community.
-
-
- route_map - -
- string -
- 		- -
Apply route-map to modify attributes for outbound.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set activate.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a template.
-
-
- peer_session - -
- string -
- 		- -
Peer-session template to inherit.
-
-
- local_as - -
- string -
- 		- -
Specify the local-as number for the eBGP neighbor.
-
-
- log_neighbor_changes - -
- dictionary -
- 		- -
Log message for neighbor up/down event.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable logging of neighbor up/down event.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set log-neighbor-changes.
-
-
- low_memory - -
- dictionary -
- 		- -
Behaviour in low memory situations.
-
-
- exempt - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not shutdown this peer when under memory pressure.
-
-
- name - -
- string -
- 		- -
Name of the BGP peer template.
-
-
- password - -
- dictionary -
- 		- -
Configure a password for neighbor.
-
-
- encryption - -
- integer -
- 		- -
0 specifies an UNENCRYPTED neighbor password.
-
3 specifies an 3DES ENCRYPTED neighbor password will follow.
-
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
-
-
- key - -
- string -
- 		- -
Authentication password.
-
-
- path_attribute - -
- list - / elements=dictionary -
- 		- -
BGP path attribute optional filtering.
-
-
- action - -
- string -
- 		-
    Choices: -
  • discard
    • -
  • treat-as-withdraw
    • -
- 		-
Action.
-
-
- range - -
- dictionary -
- 		- -
Path attribute range.
-
-
- end - -
- integer -
- 		- -
Path attribute range end value.
-
-
- start - -
- integer -
- 		- -
Path attribute range start value.
-
-
- type - -
- integer -
- 		- -
Path attribute type
-
-
- remote_as - -
- string -
- 		- -
Specify Autonomous System Number of the neighbor.
-
-
- remove_private_as - -
- dictionary -
- 		- -
Remove private AS number from outbound updates.
-
-
- all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All.
-
-
- replace_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Replace.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove private AS.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively shutdown this neighbor.
-
-
- timers - -
- dictionary -
- 		- -
Configure keepalive and hold timers.
-
-
- holdtime - -
- integer -
- 		- -
Holdtime (seconds).
-
-
- keepalive - -
- integer -
- 		- -
Keepalive interval (seconds).
-
-
- transport - -
- dictionary -
- 		- -
BGP transport connection.
-
-
- connection_mode - -
- dictionary -
- 		- -
Specify type of connection.
-
-
- passive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow passive connection setup only.
-
-
- ttl_security - -
- dictionary -
- 		- -
Enable TTL Security Mechanism.
-
-
- hops - -
- integer -
- 		- -
Specify hop count for remote peer.
-
-
- update_source - -
- string -
- 		- -
Specify source of BGP session and updates.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config bgp | section 'template'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - Unsupported for Cisco MDS - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # -------------- - # - # nxos9k# show running-config | section "^router bgp" - # nxos9k# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_bgp_templates: - config: - as_number: 65536 - neighbor: - - name: neighbor_tmplt_1 - address_family: - - afi: ipv4 - safi: unicast - advertise_map: - route_map: rmap1 - non_exist_map: nemap1 - advertisement_interval: 60 - disable_peer_as_check: true - bmp_activate_server: 2 - capability: - suppress_4_byte_as: true - description: Test_BGP_PEER_TEMPLATE_1 - local_as: 65536 - remote_as: 65001 - - - name: neighbor_tmplt_2 - description: Test_BGP_PEER_TEMPLATE_2 - address_family: - - afi: ipv4 - safi: multicast - advertise_map: - route_map: rmap1 - exist_map: emap1 - as_override: true - filter_list: - inbound: flist1 - outbound: flist2 - inherit: - peer_session: psession1 - timers: - holdtime: 100 - keepalive: 45 - # Task Output: - # ------------ - # before: {} - # - # commands: - # - router bgp 65536 - # - template peer neighbor_tmplt_1 - # - bmp-activate-server 2 - # - capability suppress 4-byte-as - # - description Test_BGP_PEER_TEMPLATE_1 - # - local-as 65536 - # - remote-as 65001 - # - address-family ipv4 unicast - # - advertise-map rmap1 non-exist-map nemap1 - # - advertisement-interval 60 - # - disable-peer-as-check - # - template peer neighbor_tmplt_2 - # - description Test_BGP_PEER_TEMPLATE_2 - # - inherit peer-session psession1 - # - timers 45 100 - # - address-family ipv4 multicast - # - advertise-map rmap1 exist-map emap1 - # - as-override - # - filter-list flist1 in - # - filter-list flist2 out - # - # after: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # bmp_activate_server: 2 - # capability: - # suppress_4_byte_as: true - # description: Test_BGP_PEER_TEMPLATE_1 - # local_as: "65536" - # remote_as: "65001" - # - # - name: neighbor_tmplt_2 - # description: Test_BGP_PEER_TEMPLATE_2 - # address_family: - # - afi: ipv4 - # safi: multicast - # advertise_map: - # exist_map: emap1 - # route_map: rmap1 - # as_override: true - # filter_list: - # inbound: flist1 - # outbound: flist2 - # inherit: - # peer_session: psession1 - # timers: - # holdtime: 100 - # keepalive: 45 - - # After state: - # -------------- - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # capability suppress 4-byte-as - # bmp-activate-server 2 - # description Test_BGP_PEER_TEMPLATE_1 - # local-as 65536 - # remote-as 65001 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - # template peer neighbor_tmplt_2 - # description Test_BGP_PEER_TEMPLATE_2 - # inherit peer-session psession1 - # timers 45 100 - # address-family ipv4 multicast - # advertise-map rmap1 exist-map emap1 - # as-override - # filter-list flist1 in - # filter-list flist2 out - - # Using replaced - - # Before state: - # ------------- - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # capability suppress 4-byte-as - # description Test_BGP_PEER_TEMPLATE_1 - # bmp-activate-server 2 - # local-as 65536 - # remote-as 65001 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - # template peer neighbor_tmplt_2 - # description Test_BGP_PEER_TEMPLATE_2 - # inherit peer-session psession1 - # timers 45 100 - # address-family ipv4 multicast - # advertise-map rmap1 exist-map emap1 - # as-override - # filter-list flist1 in - # filter-list flist2 out - - - name: Replace BGP templates configuration with provided configuration - cisco.nxos.nxos_bgp_templates: - config: - as_number: 65536 - neighbor: - - name: neighbor_tmplt_1 - address_family: - - afi: ipv4 - safi: unicast - advertise_map: - route_map: rmap1 - non_exist_map: nemap1 - advertisement_interval: 60 - disable_peer_as_check: true - inherit: - peer_session: psession1 - description: Test_BGP_PEER_TEMPLATE_1 - local_as: 65537 - state: replaced - - # Task output: - # ------------ - # - # before: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # bmp_activate_server: 2 - # capability: - # suppress_4_byte_as: true - # description: Test_BGP_PEER_TEMPLATE_1 - # local_as: "65536" - # remote_as: "65001" - # - # - name: neighbor_tmplt_2 - # description: Test_BGP_PEER_TEMPLATE_2 - # address_family: - # - afi: ipv4 - # safi: multicast - # advertise_map: - # exist_map: emap1 - # route_map: rmap1 - # as_override: true - # filter_list: - # inbound: flist1 - # outbound: flist2 - # inherit: - # peer_session: psession1 - # timers: - # holdtime: 100 - # keepalive: 45 - # - # commands: - # - router bgp 65536 - # - template peer neighbor_tmplt_1 - # - no bmp-activate-server 2 - # - no capability suppress 4-byte-as - # - inherit peer-session psession1 - # - local-as 65537 - # - no remote-as 65001 - # - # after: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # description: Test_BGP_PEER_TEMPLATE_1 - # inherit: - # peer_session: psession1 - # local_as: "65537" - # - # - name: neighbor_tmplt_2 - # description: Test_BGP_PEER_TEMPLATE_2 - # address_family: - # - afi: ipv4 - # safi: multicast - # advertise_map: - # exist_map: emap1 - # route_map: rmap1 - # as_override: true - # filter_list: - # inbound: flist1 - # outbound: flist2 - # inherit: - # peer_session: psession1 - # timers: - # holdtime: 100 - # keepalive: 45 - - # After state: - # ------------ - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # inherit peer-session psession1 - # description Test_BGP_PEER_TEMPLATE_1 - # local-as 65537 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - # template peer neighbor_tmplt_2 - # description Test_BGP_PEER_TEMPLATE_2 - # inherit peer-session psession1 - # bmp-activate-server 2 - # timers 45 100 - # address-family ipv4 multicast - # advertise-map rmap1 exist-map emap1 - # as-override - # filter-list flist1 in - # filter-list flist2 out - - # Using overridden - # - # Before state: - # ------------- - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # capability suppress 4-byte-as - # description Test_BGP_PEER_TEMPLATE_1 - # bmp-activate-server 2 - # local-as 65536 - # remote-as 65001 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - # template peer neighbor_tmplt_2 - # description Test_BGP_PEER_TEMPLATE_2 - # inherit peer-session psession1 - # timers 45 100 - # address-family ipv4 multicast - # advertise-map rmap1 exist-map emap1 - # as-override - # filter-list flist1 in - # filter-list flist2 out - - - name: Override BGP templates configuration with provided configuration - cisco.nxos.nxos_bgp_templates: - config: - as_number: 65536 - neighbor: - - name: neighbor_tmplt_1 - address_family: - - afi: ipv4 - safi: unicast - advertise_map: - route_map: rmap1 - non_exist_map: nemap1 - advertisement_interval: 60 - disable_peer_as_check: true - inherit: - peer_session: psession1 - description: Test_BGP_PEER_TEMPLATE_1 - local_as: 65537 - state: overridden - - # Task output: - # ------------ - # - # before: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # bmp_activate_server: 2 - # capability: - # suppress_4_byte_as: true - # description: Test_BGP_PEER_TEMPLATE_1 - # local_as: "65536" - # remote_as: "65001" - # - # - name: neighbor_tmplt_2 - # description: Test_BGP_PEER_TEMPLATE_2 - # address_family: - # - afi: ipv4 - # safi: multicast - # advertise_map: - # exist_map: emap1 - # route_map: rmap1 - # as_override: true - # filter_list: - # inbound: flist1 - # outbound: flist2 - # inherit: - # peer_session: psession1 - # timers: - # holdtime: 100 - # keepalive: 45 - # - # commands: - # - router bgp 65536 - # - template peer neighbor_tmplt_1 - # - no bmp-activate-server 2 - # - no capability suppress 4-byte-as - # - inherit peer-session psession1 - # - local-as 65537 - # - no remote-as 65001 - # - no template peer neighbor_tmplt_2 - # - # after: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # description: Test_BGP_PEER_TEMPLATE_1 - # inherit: - # peer_session: psession1 - # local_as: "65537" - - # After state: - # ------------ - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # inherit peer-session psession1 - # description Test_BGP_PEER_TEMPLATE_1 - # local-as 65537 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - - # Using deleted - - # Before state: - # -------------- - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # capability suppress 4-byte-as - # description Test_BGP_PEER_TEMPLATE_1 - # bmp-activate-server 2 - # local-as 65536 - # remote-as 65001 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - # template peer neighbor_tmplt_2 - # description Test_BGP_PEER_TEMPLATE_2 - # inherit peer-session psession1 - # timers 45 100 - # address-family ipv4 multicast - # advertise-map rmap1 exist-map emap1 - # as-override - # filter-list flist1 in - # filter-list flist2 out - - - name: Delete BGP configs handled by this module - cisco.nxos.nxos_bgp_templates: - state: deleted - - # Task output: - # ------------ - # - # before: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # bmp_activate_server: 2 - # capability: - # suppress_4_byte_as: true - # description: Test_BGP_PEER_TEMPLATE_1 - # local_as: "65536" - # remote_as: "65001" - # - # - name: neighbor_tmplt_2 - # description: Test_BGP_PEER_TEMPLATE_2 - # address_family: - # - afi: ipv4 - # safi: multicast - # advertise_map: - # exist_map: emap1 - # route_map: rmap1 - # as_override: true - # filter_list: - # inbound: flist1 - # outbound: flist2 - # inherit: - # peer_session: psession1 - # timers: - # holdtime: 100 - # keepalive: 45 - # - # commands: - # - router bgp 65536 - # - no template peer neighbor_tmplt_1 - # - no template peer neighbor_tmplt_2 - # - # after: {} - - # After state: - # ------------- - # nxos9k# show running-config | section "^router bgp" - # nxos9k# - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['router bgp 65536', 'template peer neighbor_tmplt_1', 'no bmp-activate-server 2', 'no capability suppress 4-byte-as', 'inherit peer-session psession1', 'local-as 65537', 'no remote-as 65001', 'no template peer neighbor_tmplt_2']
-
-
- gathered - -
- dictionary -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- dictionary -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['router bgp 65536', 'template peer neighbor_tmplt_1', 'bmp-activate-server 2', 'no capability suppress 4-byte-as', 'no template peer neighbor_tmplt_2']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_command_module.rst b/docs/cisco.nxos.nxos_command_module.rst deleted file mode 100644 index 4308a6582..000000000 --- a/docs/cisco.nxos.nxos_command_module.rst +++ /dev/null @@ -1,258 +0,0 @@ -.. _cisco.nxos.nxos_command_module: - - -*********************** -cisco.nxos.nxos_command -*********************** - -**Run arbitrary command on Cisco NXOS devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Sends an arbitrary command to an NXOS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- commands - -
- list - / elements=raw - / required -
- 		- -
The commands to send to the remote NXOS device. The resulting output from the command is returned. If the wait_for argument is provided, the module is not returned until the condition is satisfied or the number of retires as expired.
-
The commands argument also accepts an alternative form that allows for complex values that specify the command to run and the output format to return. This can be done on a command by command basis. The complex argument supports the keywords command and output where command is the command to run and output is one of 'text' or 'json'.
-
If a command sent to the device requires answering a prompt, it is possible to pass a dict containing command, answer and prompt. Common answers are 'y' or "\r" (carriage return, must be double quotes). See examples.
-
-
- interval - -
- integer -
- 		- Default:
1
- 		-
Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditional, the interval indicates how to long to wait before trying the command again.
-
-
- match - -
- string -
- 		-
    Choices: -
  • any
    • -
  • all ←
    • -
- 		-
The match argument is used in conjunction with the wait_for argument to specify the match policy. Valid values are all or any. If the value is set to all then all conditionals in the wait_for must be satisfied. If the value is set to any then only one of the values must be satisfied.
-
-
- retries - -
- integer -
- 		- Default:
9
- 		-
Specifies the number of retries a command should by tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait_for conditionals.
-
The commands are run once when retries is set to 0.
-
-
- wait_for - -
- list - / elements=string -
- 		- -
Specifies what to evaluate from the output of the command and what conditionals to apply. This argument will cause the task to wait for a particular conditional to be true before moving forward. If the conditional is not true by the configured retries, the task fails. See examples.
-

aliases: waitfor
-
-
- - -Notes ------ - -.. note:: - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: run show version on remote devices - cisco.nxos.nxos_command: - commands: show version - - - name: run show version and check to see if output contains Cisco - cisco.nxos.nxos_command: - commands: show version - wait_for: result[0] contains Cisco - - - name: run multiple commands on remote nodes - cisco.nxos.nxos_command: - commands: - - show version - - show interfaces - - - name: run multiple commands and evaluate the output - cisco.nxos.nxos_command: - commands: - - show version - - show interfaces - wait_for: - - result[0] contains Cisco - - result[1] contains loopback0 - - - name: run commands and specify the output format - cisco.nxos.nxos_command: - commands: - - command: show version - output: json - - - name: run commands that require answering a prompt - cisco.nxos.nxos_command: - commands: - - configure terminal - - command: no feature npv - prompt: Do you want to continue - answer: y - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- failed_conditions - -
- list -
- 		failed -
The list of conditionals that have failed
-
-
Sample:
-
['...', '...']
-
-
- stdout - -
- list -
- 		always apart from low level errors (such as action plugin) -
The set of responses from the commands
-
-
Sample:
-
['...', '...']
-
-
- stdout_lines - -
- list -
- 		always apart from low level errors (such as action plugin) -
The value of stdout split into a list
-
-
Sample:
-
[['...', '...'], ['...'], ['...']]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_config_module.rst b/docs/cisco.nxos.nxos_config_module.rst deleted file mode 100644 index 3ead5ab50..000000000 --- a/docs/cisco.nxos.nxos_config_module.rst +++ /dev/null @@ -1,566 +0,0 @@ -.. _cisco.nxos.nxos_config_module: - - -********************** -cisco.nxos.nxos_config -********************** - -**Manage Cisco NXOS configuration sections** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- 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. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- after - -
- list - / elements=string -
- 		- -
The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with before this allows the playbook designer to append a set of commands to be executed after the command set.
-
-
- backup - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
This argument will cause the module to create a full backup of the current running-config from the remote device before any changes are made. If the backup_options value is not given, the backup file is written to the backup folder in the playbook root directory or role root directory, if playbook is part of an ansible role. If the directory does not exist, it is created.
-
-
- backup_options - -
- dictionary -
- 		- -
This is a dict object containing configurable options related to backup file path. The value of this option is read only when backup is set to True, if backup is set to false this option will be silently ignored.
-
-
- dir_path - -
- path -
- 		- -
This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be created and the filename is either the value of filename or default filename as described in filename options description. If the path value is not given in that case a backup directory will be created in the current working directory and backup configuration will be copied in filename within backup directory.
-
-
- filename - -
- string -
- 		- -
The filename to be used to store the backup configuration. If the filename is not given it will be generated based on the hostname, current time and date in format defined by <hostname>_config.<current-date>@<current-time>
-
-
- before - -
- list - / elements=string -
- 		- -
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.
-
-
- defaults - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
The 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
-
-
- diff_against - -
- string -
- 		-
    Choices: -
  • startup
    • -
  • intended
    • -
  • running
    • -
- 		-
When using the ansible-playbook --diff command line argument the module can generate diffs against different sources.
-
When this option is configure as startup, the module will return the diff of the running-config against the startup-config.
-
When this option is configured as intended, the module will return the diff of the running-config against the configuration provided in the intended_config argument.
-
When this option is configured as running, the module will return the before and after diff of the running-config with respect to any changes made to the device configuration.
-
-
- diff_ignore_lines - -
- list - / elements=string -
- 		- -
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.
-
-
- intended_config - -
- string -
- 		- -
The 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 diff_against value and set it to intended. The configuration lines for this value should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure correct diff.
-
-
- lines - -
- list - / elements=string -
- 		- -
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 to ensure idempotency and correct diff. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser.
-

aliases: commands
-
-
- match - -
- string -
- 		-
    Choices: -
  • line ←
    • -
  • strict
    • -
  • exact
    • -
  • none
    • -
- 		-
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 line, commands are matched line by line. If match is set to strict, command lines are matched with respect to position. If match is set to exact, command lines must be an equal match. Finally, if match is set to none, the module will not attempt to compare the source configuration with the running configuration on the remote device.
-
-
- parents - -
- list - / elements=string -
- 		- -
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.
-
-
- replace - -
- string -
- 		-
    Choices: -
  • line ←
    • -
  • block
    • -
  • config
    • -
- 		-
Instructs the module on the way to perform the configuration on the device. If the replace argument is set to line then the modified lines are pushed to the device in configuration mode. If the replace argument is set to block then the entire command block is pushed to the device in configuration mode if any line is not correct. replace config will only work for NX-OS versions that support `config replace`.
-
-
- replace_src - -
- string -
- 		- -
The 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 replace with value config. This is mutually exclusive with the lines and src arguments. This argument will only work for NX-OS versions that support `config replace`. Use nxos_file_copy module to copy the flat file to remote device and then use the path with this argument. The configuration lines in the file should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure idempotency and correct diff.
-
-
- running_config - -
- string -
- 		- -
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 running_config argument allows the implementer to pass in the configuration to use as the base config for comparison. The configuration lines for this option should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure idempotency and correct diff.
-

aliases: config
-
-
- save_when - -
- string -
- 		-
    Choices: -
  • always
    • -
  • never ←
    • -
  • modified
    • -
  • changed
    • -
- 		-
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 always, then the running-config will always be copied to the startup-config and the modified flag will always be set to True. If the argument is set to 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 never, the running-config will never be copied to the startup-config. If the argument is set to changed, then the running-config will only be copied to the startup-config if the task has made a change. changed was added in Ansible 2.6.
-
-
- src - -
- path -
- 		- -
The 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 lines and parents arguments. The configuration lines in the source file should be similar to how it will appear if present in the running-configuration of the device including indentation to ensure idempotency and correct diff.
-
-
- - -Notes ------ - -.. note:: - - Unsupported for Cisco MDS - - Abbreviated commands are NOT idempotent, see https://docs.ansible.com/ansible/latest/network/user_guide/faq.html#why-do-the-config-modules-always-return-changed-true-with-abbreviated-commands. - - To ensure idempotency and correct diff the configuration lines in the relevant module options should be similar to how they appear if present in the running configuration on device including the indentation. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: configure top level configuration and save it - cisco.nxos.nxos_config: - lines: hostname {{ inventory_hostname }} - save_when: modified - - - name: diff the running-config against a provided config - cisco.nxos.nxos_config: - diff_against: intended - intended_config: "{{ lookup('file', 'master.cfg') }}" - - - cisco.nxos.nxos_config: - lines: - - 10 permit ip 192.0.2.1/32 any log - - 20 permit ip 192.0.2.2/32 any log - - 30 permit ip 192.0.2.3/32 any log - - 40 permit ip 192.0.2.4/32 any log - - 50 permit ip 192.0.2.5/32 any log - parents: ip access-list test - before: no ip access-list test - match: exact - - - cisco.nxos.nxos_config: - lines: - - 10 permit ip 192.0.2.1/32 any log - - 20 permit ip 192.0.2.2/32 any log - - 30 permit ip 192.0.2.3/32 any log - - 40 permit ip 192.0.2.4/32 any log - parents: ip access-list test - before: no ip access-list test - replace: block - - - name: replace config with flat file - cisco.nxos.nxos_config: - replace_src: config.txt - replace: config - - - name: for idempotency, use full-form commands - cisco.nxos.nxos_config: - lines: - # - shut - - shutdown - # parents: int eth1/1 - parents: interface Ethernet1/1 - - - name: configurable backup path - cisco.nxos.nxos_config: - backup: true - backup_options: - filename: backup.cfg - dir_path: /home/user - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- backup_path - -
- string -
- 		when backup is yes -
The full path to the backup file
-
-
Sample:
-
/playbooks/ansible/backup/nxos_config.2016-07-16@22:28:34
-
-
- commands - -
- list -
- 		always -
The set of commands that will be pushed to the remote device
-
-
Sample:
-
['hostname foo', 'vlan 1', 'name default']
-
-
- date - -
- string -
- 		when backup is yes -
The date extracted from the backup file name
-
-
Sample:
-
2016-07-16
-
-
- filename - -
- string -
- 		when backup is yes and filename is not specified in backup options -
The name of the backup file
-
-
Sample:
-
nxos_config.2016-07-16@22:28:34
-
-
- shortname - -
- string -
- 		when backup is yes and filename is not specified in backup options -
The full path to the backup file excluding the timestamp
-
-
Sample:
-
/playbooks/ansible/backup/nxos_config
-
-
- time - -
- string -
- 		when backup is yes -
The time extracted from the backup file name
-
-
Sample:
-
22:28:34
-
-
- updates - -
- list -
- 		always -
The set of commands that will be pushed to the remote device
-
-
Sample:
-
['hostname foo', 'vlan 1', 'name default']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_devicealias_module.rst b/docs/cisco.nxos.nxos_devicealias_module.rst deleted file mode 100644 index 081c8759f..000000000 --- a/docs/cisco.nxos.nxos_devicealias_module.rst +++ /dev/null @@ -1,273 +0,0 @@ -.. _cisco.nxos.nxos_devicealias_module: - - -*************************** -cisco.nxos.nxos_devicealias -*************************** - -**Configuration of device alias for Cisco NXOS MDS Switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configuration of device alias for Cisco MDS NXOS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- da - -
- list - / elements=dictionary -
- 		- -
List of device-alias to be added or removed
-
-
- name - -
- string - / required -
- 		- -
Name of the device-alias to be added or removed
-
-
- pwwn - -
- string -
- 		- -
pwwn to which the name needs to be associated with
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Removes the device-alias if set to True
-
-
- distribute - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable device-alias distribution
-
-
- mode - -
- string -
- 		-
    Choices: -
  • basic
    • -
  • enhanced
    • -
- 		-
Mode of devices-alias, basic or enhanced
-
-
- rename - -
- list - / elements=dictionary -
- 		- -
List of device-alias to be renamed
-
-
- new_name - -
- string - / required -
- 		- -
New name of the device-alias
-
-
- old_name - -
- string - / required -
- 		- -
Old name of the device-alias that needs to be renamed
-
-
- - -Notes ------ - -.. note:: - - Tested against Cisco MDS NX-OS 8.4(1) - - - -Examples --------- - -.. code-block:: yaml - - - name: Test that device alias module works - cisco.nxos.nxos_devicealias: - da: - - name: test1_add - pwwn: 56:2:22:11:22:88:11:67 - - name: test2_add - pwwn: 65:22:22:11:22:22:11:d - - name: dev1 - remove: true - - name: dev2 - remove: true - distribute: true - mode: enhanced - rename: - - new_name: bcd - old_name: abc - - new_name: bcd1 - old_name: abc1 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['terminal dont-ask', 'device-alias database', 'device-alias name somename pwwn 10:00:00:00:89:a1:01:03', 'device-alias name somename1 pwwn 10:00:00:00:89:a1:02:03', 'device-alias commit', 'no terminal dont-ask']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) diff --git a/docs/cisco.nxos.nxos_evpn_global_module.rst b/docs/cisco.nxos.nxos_evpn_global_module.rst deleted file mode 100644 index d1b2a8241..000000000 --- a/docs/cisco.nxos.nxos_evpn_global_module.rst +++ /dev/null @@ -1,122 +0,0 @@ -.. _cisco.nxos.nxos_evpn_global_module: - - -*************************** -cisco.nxos.nxos_evpn_global -*************************** - -**Handles the EVPN control plane for VXLAN.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Handles the EVPN control plane for VXLAN. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- nv_overlay_evpn - -
- boolean - / required -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
EVPN control plane.
-
-
- - -Notes ------ - -.. note:: - - This module is not supported on Nexus 3000 series of switches. - - Unsupported for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_evpn_global: - nv_overlay_evpn: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The set of commands to be sent to the remote device
-
-
Sample:
-
['nv overlay evpn']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_evpn_vni_module.rst b/docs/cisco.nxos.nxos_evpn_vni_module.rst deleted file mode 100644 index 530a9ff18..000000000 --- a/docs/cisco.nxos.nxos_evpn_vni_module.rst +++ /dev/null @@ -1,212 +0,0 @@ -.. _cisco.nxos.nxos_evpn_vni_module: - - -************************ -cisco.nxos.nxos_evpn_vni -************************ - -**Manages Cisco EVPN VXLAN Network Identifier (VNI).** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages Cisco Ethernet Virtual Private Network (EVPN) VXLAN Network Identifier (VNI) configurations of a Nexus device. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- route_distinguisher - -
- string -
- 		- -
The VPN Route Distinguisher (RD). The RD is combined with the IPv4 or IPv6 prefix learned by the PE router to create a globally unique address.
-
-
- route_target_both - -
- list - / elements=string -
- 		- -
Enables/Disables route-target settings for both import and export target communities using a single property.
-
-
- route_target_export - -
- list - / elements=string -
- 		- -
Sets the route-target 'export' extended communities.
-
-
- route_target_import - -
- list - / elements=string -
- 		- -
Sets the route-target 'import' extended communities.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Determines whether the config should be present or not on the device.
-
-
- vni - -
- string - / required -
- 		- -
The EVPN VXLAN Network Identifier.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - default, where supported, restores params default value. - - RD override is not permitted. You should set it to the default values first and then reconfigure it. - - ``route_target_both``, ``route_target_import`` and ``route_target_export valid`` values are a list of extended communities, (i.e. ['1.2.3.4:5', '33:55']) or the keywords 'auto' or 'default'. - - The ``route_target_both`` property is discouraged due to the inconsistent behavior of the property across Nexus platforms and image versions. For this reason it is recommended to use explicit ``route_target_export`` and ``route_target_import`` properties instead of ``route_target_both``. - - RD valid values are a string in one of the route-distinguisher formats, the keyword 'auto', or the keyword 'default'. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: vni configuration - cisco.nxos.nxos_evpn_vni: - vni: 6000 - route_distinguisher: 60:10 - route_target_import: - - "5000:10" - - "4100:100" - route_target_export: auto - route_target_both: default - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['evpn', 'vni 6000 l2', 'route-target import 5001:10']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_facts_module.rst b/docs/cisco.nxos.nxos_facts_module.rst deleted file mode 100644 index 3ce96abea..000000000 --- a/docs/cisco.nxos.nxos_facts_module.rst +++ /dev/null @@ -1,553 +0,0 @@ -.. _cisco.nxos.nxos_facts_module: - - -********************* -cisco.nxos.nxos_facts -********************* - -**Gets facts about NX-OS switches** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Collects facts from Cisco Nexus devices running the NX-OS operating system. Fact collection is supported over both ``network_cli`` and ``httpapi``. This module prepends all of the base network fact keys with ``ansible_net_``. The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- available_network_resources - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
When set to true a list of network resources for which resource modules are available will be provided.
-
-
- gather_network_resources - -
- list - / elements=string -
- 		- -
When supplied, this argument will gather configuration facts only for the given subset. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
-
Valid subsets are all, bfd_interfaces, lag_interfaces, telemetry, vlans, lacp, lacp_interfaces, interfaces, l3_interfaces, l2_interfaces, lldp_global, acls, acl_interfaces, ospfv2, ospfv3, ospf_interfaces, bgp_global, bgp_address_family, route_maps, prefix_lists, logging_global, ntp_global, snmp_server, hostname.
-
-
- gather_subset - -
- list - / elements=string -
- 		- Default:
"min"
- 		-
When supplied, this argument will gather operational facts only for the given subset. Possible values for this argument include all, hardware, config, legacy, interfaces, and min. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Gather all legacy facts - cisco.nxos.nxos_facts: - gather_subset: all - - name: Gather only the config and default facts - cisco.nxos.nxos_facts: - gather_subset: - - config - - name: Do not gather hardware facts - cisco.nxos.nxos_facts: - gather_subset: - - '!hardware' - - name: Gather legacy and resource facts - cisco.nxos.nxos_facts: - gather_subset: all - gather_network_resources: all - - name: Gather only the interfaces resource facts and no legacy facts - cisco.nxos.nxos_facts: - gather_subset: - - '!all' - - '!min' - gather_network_resources: - - interfaces - - name: Gather interfaces resource and minimal legacy facts - cisco.nxos.nxos_facts: - gather_subset: min - gather_network_resources: interfaces - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- ansible_net_all_ipv4_addresses - -
- list -
- 		when interfaces is configured -
All IPv4 addresses configured on the device
-
-
-
- ansible_net_all_ipv6_addresses - -
- list -
- 		when interfaces is configured -
All IPv6 addresses configured on the device
-
-
-
- ansible_net_api - -
- string -
- 		always -
The name of the transport
-
-
-
- ansible_net_config - -
- string -
- 		when config is configured -
The current active config from the device
-
-
-
- ansible_net_filesystems - -
- list -
- 		when hardware is configured -
All file system names available on the device
-
-
-
- ansible_net_gather_network_resources - -
- list -
- 		when the resource is configured -
The list of fact for network resource subsets collected from the device
-
-
-
- ansible_net_gather_subset - -
- list -
- 		always -
The list of fact subsets collected from the device
-
-
-
- ansible_net_hostname - -
- string -
- 		always -
The configured hostname of the device
-
-
-
- ansible_net_image - -
- string -
- 		always -
The image file the device is running
-
-
-
- ansible_net_interfaces - -
- dictionary -
- 		when interfaces is configured -
A hash of all interfaces running on the system
-
-
-
- ansible_net_license_hostid - -
- string -
- 		always -
The License host id of the device
-
-
-
- ansible_net_memfree_mb - -
- integer -
- 		when hardware is configured -
The available free memory on the remote device in Mb
-
-
-
- ansible_net_memtotal_mb - -
- integer -
- 		when hardware is configured -
The total memory on the remote device in Mb
-
-
-
- ansible_net_model - -
- string -
- 		always -
The model name returned from the device
-
-
-
- ansible_net_neighbors - -
- dictionary -
- 		when interfaces is configured -
The list of LLDP and CDP neighbors from the device. If both, CDP and LLDP neighbor data is present on one port, CDP is preferred.
-
-
-
- ansible_net_python_version - -
- string -
- 		always -
The Python version Ansible controller is using
-
-
-
- ansible_net_serialnum - -
- string -
- 		always -
The serial number of the remote device
-
-
-
- ansible_net_version - -
- string -
- 		always -
The operating system version running on the remote device
-
-
-
- fan_info - -
- dictionary -
- 		when legacy is configured -
A hash of facts about fans in the remote device
-
-
-
- hostname - -
- dictionary -
- 		when legacy is configured -
The configured hostname of the remote device
-
-
-
- interfaces_list - -
- dictionary -
- 		when legacy is configured -
The list of interface names on the remote device
-
-
-
- kickstart - -
- string -
- 		when legacy is configured -
The software version used to boot the system
-
-
-
- module - -
- dictionary -
- 		when legacy is configured -
A hash of facts about the modules in a remote device
-
-
-
- platform - -
- string -
- 		when legacy is configured -
The hardware platform reported by the remote device
-
-
-
- power_supply_info - -
- string -
- 		when legacy is configured -
A hash of facts about the power supplies in the remote device
-
-
-
- vlan_list - -
- list -
- 		when legacy is configured -
The list of VLAN IDs configured on the remote device
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_feature_module.rst b/docs/cisco.nxos.nxos_feature_module.rst deleted file mode 100644 index ee2539180..000000000 --- a/docs/cisco.nxos.nxos_feature_module.rst +++ /dev/null @@ -1,150 +0,0 @@ -.. _cisco.nxos.nxos_feature_module: - - -*********************** -cisco.nxos.nxos_feature -*********************** - -**Manage features in NX-OS switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Offers ability to enable and disable features in NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- feature - -
- string - / required -
- 		- -
Name of feature.
-
-
- state - -
- string -
- 		-
    Choices: -
  • enabled ←
    • -
  • disabled
    • -
- 		-
Desired state of the feature.
-
-
- - -Notes ------ - -.. note:: - - Tested against Cisco MDS NX-OS 9.2(2) - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - 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 Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The set of commands to be sent to the remote device
-
-
Sample:
-
['nv overlay evpn']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) -- Suhas Bharadwaj (@srbharadwaj) diff --git a/docs/cisco.nxos.nxos_gir_module.rst b/docs/cisco.nxos.nxos_gir_module.rst deleted file mode 100644 index 61c809ea0..000000000 --- a/docs/cisco.nxos.nxos_gir_module.rst +++ /dev/null @@ -1,302 +0,0 @@ -.. _cisco.nxos.nxos_gir_module: - - -******************* -cisco.nxos.nxos_gir -******************* - -**Trigger a graceful removal or insertion (GIR) of the switch.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Trigger a graceful removal or insertion (GIR) of the switch. -- GIR processing may take more than 2 minutes. Timeout settings are automatically extended to 200s when user timeout settings are insufficient. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Specify desired state of the resource.
-
-
- system_mode_maintenance - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
When system_mode_maintenance=true it puts all enabled protocols in maintenance mode (using the isolate command). When system_mode_maintenance=false it puts all enabled protocols in normal mode (using the no isolate command).
-
-
- system_mode_maintenance_dont_generate_profile - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
When system_mode_maintenance_dont_generate_profile=true it prevents the dynamic searching of enabled protocols and executes commands configured in a maintenance-mode profile. Use this option if you want the system to use a maintenance-mode profile that you have created. When system_mode_maintenance_dont_generate_profile=false it prevents the dynamic searching of enabled protocols and executes commands configured in a normal-mode profile. Use this option if you want the system to use a normal-mode profile that you have created.
-
-
- system_mode_maintenance_on_reload_reset_reason - -
- string -
- 		-
    Choices: -
  • hw_error
    • -
  • svc_failure
    • -
  • kern_failure
    • -
  • wdog_timeout
    • -
  • fatal_error
    • -
  • lc_failure
    • -
  • match_any
    • -
  • manual_reload
    • -
  • any_other
    • -
  • maintenance
    • -
- 		-
Boots the switch into maintenance mode automatically in the event of a specified system crash. Note that not all reset reasons are applicable for all platforms. Also if reset reason is set to match_any, it is not idempotent as it turns on all reset reasons. If reset reason is match_any and state is absent, it turns off all the reset reasons.
-
-
- system_mode_maintenance_shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Shuts down all protocols, vPC domains, and interfaces except the management interface (using the shutdown command). This option is disruptive while system_mode_maintenance (which uses the isolate command) is not.
-
-
- system_mode_maintenance_timeout - -
- string -
- 		- -
Keeps the switch in maintenance mode for a specified number of minutes. Range is 5-65535.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - ``state`` has effect only in combination with ``system_mode_maintenance_timeout`` or ``system_mode_maintenance_on_reload_reset_reason``. - - Using ``system_mode_maintenance`` and ``system_mode_maintenance_dont_generate_profile`` would make the module fail, but the system mode will be triggered anyway. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Trigger system maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance: true - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Trigger system normal mode - - cisco.nxos.nxos_gir: - system_mode_maintenance: false - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Configure on-reload reset-reason for maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance_on_reload_reset_reason: manual_reload - state: present - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Add on-reload reset-reason for maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance_on_reload_reset_reason: hw_error - state: present - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Remove on-reload reset-reason for maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance_on_reload_reset_reason: manual_reload - state: absent - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Set timeout for maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance_timeout: 30 - state: present - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Remove timeout for maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance_timeout: 30 - state: absent - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- final_system_mode - -
- string -
- 		verbose mode -
describe the last system mode
-
-
Sample:
-
normal
-
-
- updates - -
- list -
- 		verbose mode -
commands sent to the device
-
-
Sample:
-
['terminal dont-ask', 'system mode maintenance timeout 10']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_gir_profile_management_module.rst b/docs/cisco.nxos.nxos_gir_profile_management_module.rst deleted file mode 100644 index 95d85ae9b..000000000 --- a/docs/cisco.nxos.nxos_gir_profile_management_module.rst +++ /dev/null @@ -1,235 +0,0 @@ -.. _cisco.nxos.nxos_gir_profile_management_module: - - -************************************** -cisco.nxos.nxos_gir_profile_management -************************************** - -**Create a maintenance-mode or normal-mode profile for GIR.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manage a maintenance-mode or normal-mode profile with configuration commands that can be applied during graceful removal or graceful insertion. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- commands - -
- list - / elements=string -
- 		- -
List of commands to be included into the profile.
-
-
- mode - -
- string - / required -
- 		-
    Choices: -
  • maintenance
    • -
  • normal
    • -
- 		-
Configure the profile as Maintenance or Normal mode.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Specify desired state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - ``state=absent`` removes the whole profile. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Create a maintenance-mode profile - - cisco.nxos.nxos_gir_profile_management: - mode: maintenance - commands: - - router eigrp 11 - - isolate - - # Remove the maintenance-mode profile - - cisco.nxos.nxos_gir_profile_management: - mode: maintenance - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- end_state - -
- list -
- 		verbose mode -
list of profile entries after module execution.
-
-
Sample:
-
['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete', 'router eigrp 11', 'isolate']
-
-
- existing - -
- list -
- 		verbose mode -
list of existing profile commands.
-
-
Sample:
-
['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete']
-
-
- proposed - -
- list -
- 		verbose mode -
list of commands passed into module.
-
-
Sample:
-
['router eigrp 11', 'isolate']
-
-
- updates - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['configure maintenance profile maintenance-mode', 'router eigrp 11', 'isolate']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_hostname_module.rst b/docs/cisco.nxos.nxos_hostname_module.rst deleted file mode 100644 index c8a9ee45d..000000000 --- a/docs/cisco.nxos.nxos_hostname_module.rst +++ /dev/null @@ -1,344 +0,0 @@ -.. _cisco.nxos.nxos_hostname_module: - - -************************ -cisco.nxos.nxos_hostname -************************ - -**Hostname resource module.** - - -Version added: 2.9.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages hostname configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A dictionary of hostname configuration.
-
-
- hostname - -
- string -
- 		- -
Hostname of the device.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section hostname.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
The states merged, replaced and overridden have identical behaviour for this module.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged (replaced, overridden has the same behaviour) - - # Before state: - # ------------- - # nxos-9k-rdo# show running-config | section ^hostname - # nxos-9k-rdo# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_hostname: - config: - hostname: NXOSv-9k - - # Task output - # ------------- - # before: {} - # - # commands: - # - hostname NXOSv-9k - # - # after: - # hostname: NXOSv-9k - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section ^hostname - # hostname NXOSv-9k - # - - # Using deleted - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section ^hostname - # hostname NXOSv-9k - - - name: Delete hostname from running-config - cisco.nxos.nxos_hostname: - state: deleted - - # Task output - # ------------- - # before: - # hostname: NXOSv-9k - # - # commands: - # - no hostname NXOSv-9k - # - # after: {} - - # Using gathered - - - name: Gather hostname facts using gathered - cisco.nxos.nxos_hostname: - state: gathered - - # Task output (redacted) - # ----------------------- - # gathered: - # hostname: NXOSv-9k - - # Using rendered - - - name: Render platform specific configuration lines (without connecting to the device) - cisco.nxos.nxos_hostname: - config: - hostname: NXOSv-9k - - # Task Output (redacted) - # ----------------------- - # rendered: - # - hostname NXOSv-9k - - # Using parsed - - # parsed.cfg - # ------------ - # hostname NXOSv-9k - - - name: Parse externally provided hostname config - cisco.nxos.nxos_hostname: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # hostname: NXOSv-9k - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['hostname switch01']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['hostname switch01']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst b/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst deleted file mode 100644 index 163612413..000000000 --- a/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst +++ /dev/null @@ -1,344 +0,0 @@ -.. _cisco.nxos.nxos_hsrp_interfaces_module: - - -******************************* -cisco.nxos.nxos_hsrp_interfaces -******************************* - -**HSRP interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages Hot Standby Router Protocol (HSRP) interface attributes. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
The provided configuration
-
-
- bfd - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Enable/Disable HSRP Bidirectional Forwarding Detection (BFD) on the interface.
-
-
- name - -
- string -
- 		- -
The name of the interface.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 7.0(3)I5(1). - - Feature bfd should be enabled for this module. - - Unsupported for Cisco MDS - - - -Examples --------- - -.. code-block:: yaml - - # Using deleted - - - name: Configure hsrp attributes on interfaces - cisco.nxos.nxos_hsrp_interfaces: - config: - - name: Ethernet1/1 - - name: Ethernet1/2 - operation: deleted - - - # Using merged - - - name: Configure hsrp attributes on interfaces - cisco.nxos.nxos_hsrp_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - - name: Ethernet1/2 - bfd: disable - operation: merged - - - # Using overridden - - - name: Configure hsrp attributes on interfaces - cisco.nxos.nxos_hsrp_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - - name: Ethernet1/2 - bfd: disable - operation: overridden - - - # Using replaced - - - name: Configure hsrp attributes on interfaces - cisco.nxos.nxos_hsrp_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - - name: Ethernet1/2 - bfd: disable - operation: replaced - - # Using rendered - - - name: Use rendered state to convert task input to device specific commands - cisco.nxos.nxos_hsrp_interfaces: - config: - - name: Ethernet1/800 - bfd: enable - - name: Ethernet1/801 - bfd: enable - state: rendered - - # Task Output (redacted) - # ----------------------- - - # rendered: - # - "interface Ethernet1/800" - # - "hsrp bfd" - # - "interface Ethernet1/801" - # - "hsrp bfd" - - # Using parsed - - # parsed.cfg - # ------------ - # interface Ethernet1/800 - # no switchport - # hsrp bfd - # interface Ethernet1/801 - # no switchport - # hsrp bfd - - - name: Use parsed state to convert externally supplied config to structured format - cisco.nxos.nxos_hsrp_interfaces: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - - # parsed: - # - name: Ethernet1/800 - # bfd: enable - # - name: Ethernet1/801 - # bfd: enable - - # Using gathered - - # Existing device config state - # ------------------------------- - - # interface Ethernet1/1 - # no switchport - # hsrp bfd - # interface Ethernet1/2 - # no switchport - # hsrp bfd - # interface Ethernet1/3 - # no switchport - - - name: Gather hsrp_interfaces facts from the device using nxos_hsrp_interfaces - cisco.nxos.nxos_hsrp_interfaces: - state: gathered - - # Task output (redacted) - # ----------------------- - - # gathered: - # - name: Ethernet1/1 - # bfd: enable - # - name: Ethernet1/2 - # bfd: enable - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/1', 'hsrp bfd']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_hsrp_module.rst b/docs/cisco.nxos.nxos_hsrp_module.rst deleted file mode 100644 index 0a55a4423..000000000 --- a/docs/cisco.nxos.nxos_hsrp_module.rst +++ /dev/null @@ -1,305 +0,0 @@ -.. _cisco.nxos.nxos_hsrp_module: - - -******************** -cisco.nxos.nxos_hsrp -******************** - -**Manages HSRP configuration on NX-OS switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages HSRP configuration on NX-OS switches. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- auth_string - -
- string -
- 		- -
Authentication string. If this needs to be hidden(for md5 type), the string should be 7 followed by the key string. Otherwise, it can be 0 followed by key string or just key string (for backward compatibility). For text type, this should be just be a key string. if this is 'default', authentication is removed.
-
-
- auth_type - -
- string -
- 		-
    Choices: -
  • text
    • -
  • md5
    • -
- 		-
Authentication type.
-
-
- group - -
- string - / required -
- 		- -
HSRP group number.
-
-
- interface - -
- string - / required -
- 		- -
Full name of interface that is being managed for HSRP.
-
-
- preempt - -
- string -
- 		-
    Choices: -
  • enabled
    • -
  • disabled
    • -
- 		-
Enable/Disable preempt.
-
-
- priority - -
- string -
- 		- -
HSRP priority or keyword 'default'.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Specify desired state of the resource.
-
-
- version - -
- string -
- 		-
    Choices: -
  • 1 ←
    • -
  • 2
    • -
- 		-
HSRP version.
-
-
- vip - -
- string -
- 		- -
HSRP virtual IP address or keyword 'default'
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - HSRP feature needs to be enabled first on the system. - - SVIs must exist before using this module. - - Interface must be a L3 port before using this module. - - HSRP cannot be configured on loopback interfaces. - - MD5 authentication is only possible with HSRPv2 while it is ignored if HSRPv1 is used instead, while it will not raise any error. Here we allow MD5 authentication only with HSRPv2 in order to enforce better practice. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Ensure HSRP is configured with following params on a SVI - cisco.nxos.nxos_hsrp: - group: 10 - vip: 10.1.1.1 - priority: 150 - interface: vlan10 - preempt: enabled - - - name: Ensure HSRP is configured with following params on a SVI with clear text authentication - cisco.nxos.nxos_hsrp: - group: 10 - vip: 10.1.1.1 - priority: 150 - interface: vlan10 - preempt: enabled - auth_type: text - auth_string: CISCO - - - name: Ensure HSRP is configured with md5 authentication and clear authentication - string - cisco.nxos.nxos_hsrp: - group: 10 - vip: 10.1.1.1 - priority: 150 - interface: vlan10 - preempt: enabled - auth_type: md5 - auth_string: 0 1234 - - - name: Ensure HSRP is configured with md5 authentication and hidden authentication - string - cisco.nxos.nxos_hsrp: - group: 10 - vip: 10.1.1.1 - priority: 150 - interface: vlan10 - preempt: enabled - auth_type: md5 - auth_string: 7 1234 - - - name: Remove HSRP config for given interface, group, and VIP - cisco.nxos.nxos_hsrp: - group: 10 - interface: vlan10 - vip: 10.1.1.1 - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['interface vlan10', 'hsrp version 2', 'hsrp 30', 'ip 10.30.1.1']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_igmp_module.rst b/docs/cisco.nxos.nxos_igmp_module.rst deleted file mode 100644 index dbb46206f..000000000 --- a/docs/cisco.nxos.nxos_igmp_module.rst +++ /dev/null @@ -1,191 +0,0 @@ -.. _cisco.nxos.nxos_igmp_module: - - -******************** -cisco.nxos.nxos_igmp -******************** - -**Manages IGMP global configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages IGMP global configuration configuration settings. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- enforce_rtr_alert - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables or disables the enforce router alert option check for IGMPv2 and IGMPv3 packets.
-
-
- flush_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Removes routes when the IGMP process is restarted. By default, routes are not flushed.
-
-
- restart - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Restarts the igmp process (using an exec config command).
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • default
    • -
- 		-
Manages desired state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - When ``state=default``, all supported params will be reset to a default state. - - If restart is set to true with other params set, the restart will happen last, i.e. after the configuration takes place. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Default igmp global params (all params except restart) - cisco.nxos.nxos_igmp: - state: default - - - name: Ensure the following igmp global config exists on the device - cisco.nxos.nxos_igmp: - flush_routes: true - enforce_rtr_alert: true - - - name: Restart the igmp process - cisco.nxos.nxos_igmp: - restart: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- updates - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['ip igmp flush-routes']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_igmp_snooping_module.rst b/docs/cisco.nxos.nxos_igmp_snooping_module.rst deleted file mode 100644 index 31af97509..000000000 --- a/docs/cisco.nxos.nxos_igmp_snooping_module.rst +++ /dev/null @@ -1,225 +0,0 @@ -.. _cisco.nxos.nxos_igmp_snooping_module: - - -***************************** -cisco.nxos.nxos_igmp_snooping -***************************** - -**Manages IGMP snooping global configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages IGMP snooping global configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- group_timeout - -
- string -
- 		- -
Group membership timeout value for all VLANs on the device. Accepted values are integer in range 1-10080, never and default.
-
-
- link_local_grp_supp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Global link-local groups suppression.
-
-
- report_supp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Global IGMPv1/IGMPv2 Report Suppression.
-
-
- snooping - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/disables IGMP snooping on the switch.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • default
    • -
- 		-
Manage the state of the resource.
-
-
- v3_report_supp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Global IGMPv3 Report Suppression and Proxy Reporting.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - When ``state=default``, params will be reset to a default state. - - ``group_timeout`` also accepts *never* as an input. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure igmp snooping params supported in this module are in there default state - - cisco.nxos.nxos_igmp_snooping: - state: default - - # ensure following igmp snooping params are in the desired state - - cisco.nxos.nxos_igmp_snooping: - group_timeout: never - snooping: true - link_local_grp_supp: false - optimize_mcast_flood: false - report_supp: true - v3_report_supp: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['ip igmp snooping link-local-groups-suppression', 'ip igmp snooping group-timeout 50', 'no ip igmp snooping report-suppression', 'no ip igmp snooping v3-report-suppression', 'no ip igmp snooping']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_install_os_module.rst b/docs/cisco.nxos.nxos_install_os_module.rst deleted file mode 100644 index ddd630d01..000000000 --- a/docs/cisco.nxos.nxos_install_os_module.rst +++ /dev/null @@ -1,183 +0,0 @@ -.. _cisco.nxos.nxos_install_os_module: - - -************************** -cisco.nxos.nxos_install_os -************************** - -**Set boot options like boot, kickstart image and issu.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Install an operating system by setting the boot options like boot image and kickstart image and optionally select to install using ISSU (In Server Software Upgrade). - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- issu - -
- string -
- 		-
    Choices: -
  • required
    • -
  • desired
    • -
  • yes
    • -
  • no ←
    • -
- 		-
Upgrade using In Service Software Upgrade (ISSU). (Supported on N5k, N7k, N9k platforms)
-
Selecting 'required' or 'yes' means that upgrades will only proceed if the switch is capable of ISSU.
-
Selecting 'desired' means that upgrades will use ISSU if possible but will fall back to disruptive upgrade if needed.
-
Selecting 'no' means do not use ISSU. Forced disruptive.
-
-
- kickstart_image_file - -
- string -
- 		- -
Name of the kickstart image file on flash. (Not required on all Nexus platforms)
-
-
- system_image_file - -
- string - / required -
- 		- -
Name of the system (or combined) image file on flash.
-
-
- - -Notes ------ - -.. note:: - - Tested against the following platforms and images - N9k 7.0(3)I4(6), 7.0(3)I5(3), 7.0(3)I6(1), 7.0(3)I7(1), 7.0(3)F2(2), 7.0(3)F3(2) - N3k 6.0(2)A8(6), 6.0(2)A8(8), 7.0(3)I6(1), 7.0(3)I7(1) - N7k 7.3(0)D1(1), 8.0(1), 8.1(1), 8.2(1) - - Tested against Cisco MDS NX-OS 9.2(1) - - This module requires both the ANSIBLE_PERSISTENT_CONNECT_TIMEOUT and ANSIBLE_PERSISTENT_COMMAND_TIMEOUT timers to be set to 600 seconds or higher. The module will exit if the timers are not set properly. - - When using connection local, ANSIBLE_PERSISTENT_CONNECT_TIMEOUT and ANSIBLE_PERSISTENT_COMMAND_TIMEOUT can only be set using ENV variables or the ansible.cfg file. - - Do not include full file paths, just the name of the file(s) stored on the top level flash directory. - - This module attempts to install the software immediately, which may trigger a reboot. - - In check mode, the module will indicate if an upgrade is needed and whether or not the upgrade is disruptive or non-disruptive(ISSU). - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Install OS on N9k - check_mode: false - cisco.nxos.nxos_install_os: - system_image_file: nxos.7.0.3.I6.1.bin - issu: desired - - - name: Wait for device to come back up with new image - wait_for: - port: 22 - state: started - timeout: 500 - delay: 60 - host: '{{ inventory_hostname }}' - - - name: Check installed OS for newly installed version - nxos_command: - commands: [show version | json] - register: output - - - assert: - that: - - output['stdout'][0]['kickstart_ver_str'] == '7.0(3)I6(1)' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- install_state - -
- dictionary -
- 		always -
Boot and install information.
-
-
Sample:
-
{'install_state': ['Compatibility check is done:', 'Module bootable Impact Install-type Reason', '------ -------- -------------- ------------ ------', ' 1 yes non-disruptive reset ', 'Images will be upgraded according to following table:', 'Module Image Running-Version(pri:alt) New-Version Upg-Required', '------ ---------- ---------------------------------------- -------------------- ------------', ' 1 nxos 7.0(3)I6(1) 7.0(3)I7(1) yes', ' 1 bios v4.4.0(07/12/2017) v4.4.0(07/12/2017) no']}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbibo (@GGabriele) diff --git a/docs/cisco.nxos.nxos_l2_interfaces_module.rst b/docs/cisco.nxos.nxos_l2_interfaces_module.rst deleted file mode 100644 index bfad0cf31..000000000 --- a/docs/cisco.nxos.nxos_l2_interfaces_module.rst +++ /dev/null @@ -1,648 +0,0 @@ -.. _cisco.nxos.nxos_l2_interfaces_module: - - -***************************** -cisco.nxos.nxos_l2_interfaces -***************************** - -**L2 interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages Layer-2 interfaces attributes of NX-OS Interfaces. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A dictionary of Layer-2 interface options
-
-
- access - -
- dictionary -
- 		- -
Switchport mode access command to configure the interface as a Layer-2 access.
-
-
- vlan - -
- integer -
- 		- -
Configure given VLAN in access port. It's used as the access VLAN ID.
-
-
- mode - -
- string -
- 		-
    Choices: -
  • dot1q-tunnel
    • -
  • access
    • -
  • trunk
    • -
  • fex-fabric
    • -
  • fabricpath
    • -
- 		-
Mode in which interface needs to be configured.
-
Access mode is not shown in interface facts, so idempotency will not be maintained for switchport mode access and every time the output will come as changed=True.
-
-
- name - -
- string - / required -
- 		- -
Full name of interface, i.e. Ethernet1/1.
-
-
- trunk - -
- dictionary -
- 		- -
Switchport mode trunk command to configure the interface as a Layer-2 trunk.
-
-
- allowed_vlans - -
- string -
- 		- -
List of allowed VLANs in a given trunk port. These are the only VLANs that will be configured on the trunk.
-
-
- native_vlan - -
- integer -
- 		- -
Native VLAN to be configured in trunk port. It is used as the trunk native VLAN ID.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section ^interface.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state of the configuration after module completion.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOS 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # interface Ethernet1/2 - # switchport trunk native vlan 20 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - - name: Merge provided configuration with device configuration - cisco.nxos.nxos_l2_interfaces: - config: - - name: Ethernet1/1 - trunk: - native_vlan: 10 - allowed_vlans: 2,4,15 - - name: Ethernet1/2 - access: - vlan: 30 - state: merged - - # Task Output - # ----------- - # - # before: - # - name: Loopback999 - # - name: Ethernet1/2 - # - name: mgmt0 - # - name: Ethernet1/1 - # commands: - # - interface Ethernet1/1 - # - switchport trunk allowed vlan 2,4,15 - # - switchport trunk native vlan 10 - # - interface Ethernet1/2 - # - switchport access vlan 30 - # after: - # - name: Ethernet1/1 - # trunk: - # allowed_vlans: 2,4,15 - # native_vlan: 10 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - # - name: Loopback999 - - # After state: - # ------------ - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # switchport trunk native vlan 10 - # switchport trunk allowed vlans 2,4,15 - # interface Ethernet1/2 - # switchport access vlan 30 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - # Using replaced - - # Before state: - # ------------- - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # switchport trunk native vlan 10 - # switchport trunk allowed vlans 2,4,15 - # interface Ethernet1/2 - # switchport access vlan 30 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - - name: Replace device configuration of specified L2 interfaces with provided configuration. - cisco.nxos.nxos_l2_interfaces: - config: - - name: Ethernet1/1 - trunk: - native_vlan: 20 - allowed_vlans: 5-10, 15 - state: replaced - - # Task Output - # ----------- - # - # before: - # - name: Ethernet1/1 - # trunk: - # allowed_vlans: 2,4,15 - # native_vlan: 10 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - # commands: - # - interface Ethernet1/1 - # - no switchport trunk native vlan - # - switchport trunk allowed vlan 5-10,15 - # - switchport trunk native vlan 20 - # after: - # - name: Ethernet1/1 - # trunk: - # allowed_vlans: 5-10,15 - # native_vlan: 20 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - - # After state: - # ------------ - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # switchport trunk native vlan 20 - # switchport trunk allowed vlan 5-10,15 - # interface Ethernet1/2 - # switchport trunk native vlan 20 - # switchport mode trunk - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - # Using overridden - - # Before state: - # ------------- - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # switchport trunk native vlan 20 - # switchport trunk allowed vlan 5-10,15 - # interface Ethernet1/2 - # switchport trunk native vlan 20 - # switchport mode trunk - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - - name: Override device configuration with provided configuration. - cisco.nxos.nxos_l2_interfaces: - config: - - name: Ethernet1/2 - access: - vlan: 30 - state: overridden - - # Task Output - # ----------- - # - # before: - # - name: Ethernet1/1 - # trunk: - # allowed_vlans: 5,6,7,8,9,10,15 - # native_vlan: 20 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - # commands: - # - interface Ethernet1/1 - # - no switchport trunk allowed vlan - # - no switchport trunk native vlan - # after: - # - name: Ethernet1/1 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - - # After state: - # ------------ - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # interface Ethernet1/2 - # switchport access vlan 30 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - - # Using deleted - - # Before state: - # ------------- - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # switchport trunk native vlan 10 - # switchport trunk allowed vlan 2,4,15 - # interface Ethernet1/2 - # switchport access vlan 30 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - - name: Delete L2 attributes of given interfaces (Note This won't delete the interface - itself). - cisco.nxos.nxos_l2_interfaces: - config: - - name: Ethernet1/1 - - name: Ethernet1/2 - state: deleted - - # Task Output - # ----------- - # - # before: - # - name: Ethernet1/1 - # trunk: - # allowed_vlans: 2,4,15 - # native_vlan: 10 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - # commands: - # - interface Ethernet1/1 - # - no switchport trunk allowed vlan - # - no switchport trunk native vlan - # - interface Ethernet1/2 - # - no switchport access vlan - # after: - # - name: Ethernet1/1 - # - name: Ethernet1/2 - # - name: mgmt0 - - # After state: - # ------------ - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # interface Ethernet1/2 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - # Using rendered - - - name: Render platform specific configuration lines (without connecting to the device) - cisco.nxos.nxos_l2_interfaces: - config: - - name: Ethernet1/1 - trunk: - native_vlan: 10 - allowed_vlans: 2,4,15 - - name: Ethernet1/2 - access: - vlan: 30 - - name: Ethernet1/3 - trunk: - native_vlan: 20 - allowed_vlans: 5-10, 15 - state: rendered - - # Task Output - # ----------- - # - # rendered: - # - interface Ethernet1/1 - # - switchport trunk allowed vlan 2,4,15 - # - switchport trunk native vlan 10 - # - interface Ethernet1/2 - # - switchport access vlan 30 - # - interface Ethernet1/3 - # - switchport trunk allowed vlan 5-10,15 - # - switchport trunk native vlan 20 - - # Using parsed - - # parsed.cfg - # ------------ - # - # interface Ethernet1/800 - # switchport access vlan 18 - # switchport trunk allowed vlan 210 - # interface Ethernet1/801 - # switchport trunk allowed vlan 2,4,15 - - - name: Use parsed state to convert externally supplied config to structured format - cisco.nxos.nxos_l2_interfaces: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output - # ----------- - # - # parsed: - # - name: Ethernet1/800 - # access: - # vlan: 18 - # trunk: - # allowed_vlans: "210" - # - name: Ethernet1/801 - # trunk: - # allowed_vlans: "2,4,15" - - # Using gathered - - # Before state: - # ------------- - # - # switch# sh running-config | section ^interface - # interface Ethernet1/1 - # switchport access vlan 6 - # switchport trunk allowed vlan 200 - # interface Ethernet1/2 - # switchport trunk native vlan 10 - - - name: Gather l2_interfaces facts from the device using nxos_l2_interfaces - cisco.nxos.nxos_l2_interfaces: - state: gathered - - # Task output - # ----------- - # - # gathered: - # - name: "Ethernet1/1" - # access: - # vlan: 6 - # trunk: - # allowed_vlans: "200" - # - name: "Ethernet1/2" - # trunk: - # native_vlan: 10 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/1', 'switchport trunk allowed vlan 2,4,15', 'switchport trunk native vlan 10', 'interface Ethernet1/2', 'switchport access vlan 30', 'interface Ethernet1/3', 'switchport trunk allowed vlan 5,6,7,8,9,10,15', 'switchport trunk native vlan 20']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_l3_interfaces_module.rst b/docs/cisco.nxos.nxos_l3_interfaces_module.rst deleted file mode 100644 index 28a56bdf8..000000000 --- a/docs/cisco.nxos.nxos_l3_interfaces_module.rst +++ /dev/null @@ -1,884 +0,0 @@ -.. _cisco.nxos.nxos_l3_interfaces_module: - - -***************************** -cisco.nxos.nxos_l3_interfaces -***************************** - -**L3 interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages Layer-3 interfaces attributes of NX-OS Interfaces. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A dictionary of Layer-3 interface options
-
-
- dot1q - -
- integer -
- 		- -
Configures IEEE 802.1Q VLAN encapsulation on a subinterface.
-
-
- evpn_multisite_tracking - -
- string -
-
added in 1.1.0
- 		-
    Choices: -
  • fabric-tracking
    • -
  • dci-tracking
    • -
- 		-
VxLAN evpn multisite Interface tracking. Supported only on selected model.
-
-
- ipv4 - -
- list - / elements=dictionary -
- 		- -
IPv4 address and attributes of the L3 interface.
-
-
- address - -
- string -
- 		- -
IPV4 address of the L3 interface.
-
-
- secondary - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
A boolean attribute to manage addition of secondary IP address.
-
-
- tag - -
- integer -
- 		- -
URIB route tag value for local/direct routes.
-
-
- ipv6 - -
- list - / elements=dictionary -
- 		- -
IPv6 address and attributes of the L3 interface.
-
-
- address - -
- string -
- 		- -
IPV6 address of the L3 interface.
-
-
- tag - -
- integer -
- 		- -
URIB route tag value for local/direct routes.
-
-
- ipv6_redirects - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/disables ipv6 redirects.
-
-
- name - -
- string - / required -
- 		- -
Full name of L3 interface, i.e. Ethernet1/1.
-
-
- redirects - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/disables ipv4 redirects.
-
-
- unreachables - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/disables ip redirects.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state of the configuration after module completion.
-
The state overridden would override the IP address configuration of all interfaces on the device with the provided configuration in the task. Use caution with this state as you may loose access to the device.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOS 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no shutdown - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - - name: Merge provided configuration with device configuration. - cisco.nxos.nxos_l3_interfaces: - config: - - name: Ethernet1/6 - ipv4: - - address: 192.168.1.1/24 - tag: 5 - - address: 10.1.1.1/24 - secondary: true - tag: 10 - ipv6: - - address: fd5d:12c9:2201:2::1/64 - tag: 6 - - name: Ethernet1/7.42 - redirects: false - unreachables: false - state: merged - - # Task Output - # ----------- - # - # before: - # - name: Ethernet1/6 - # - name: Ethernet1/7 - # - ipv4: - # - address: dhcp - # name: mgmt0 - # commands: - # - interface Ethernet1/6 - # - ip address 192.168.1.1/24 tag 5 - # - ip address 10.1.1.1/24 secondary tag 10 - # - ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - # - interface Ethernet1/7 - # - no ip redirects - # after: - # - ipv4: - # - address: 192.168.1.1/24 - # tag: 5 - # - address: 10.1.1.1/24 - # secondary: true - # tag: 10 - # ipv6: - # - address: fd5d:12c9:2201:2::1/64 - # tag: 6 - # name: Ethernet1/6 - # redirects: false - # - name: Ethernet1/7 - # redirects: false - # - ipv4: - # - address: dhcp - # name: mgmt0 - - # After state: - # ------------ - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no ip redirects - # ip address 192.168.1.1/24 tag 5 - # ip address 10.1.1.1/24 secondary tag 10 - # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no ip redirects - # no shutdown - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - - # Using replaced - - # Before state: - # ------------- - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no ip redirects - # ip address 192.168.1.1/24 tag 5 - # ip address 10.1.1.1/24 secondary tag 10 - # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no ip redirects - # no shutdown - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - - name: Replace device configuration of specified L3 interfaces with provided configuration. - cisco.nxos.nxos_l3_interfaces: - config: - - name: Ethernet1/6 - ipv4: - - address: 192.168.22.3/24 - state: replaced - - # Task Output - # ----------- - # - # before: - # - ipv4: - # - address: 192.168.1.1/24 - # tag: 5 - # - address: 10.1.1.1/24 - # secondary: true - # tag: 10 - # ipv6: - # - address: fd5d:12c9:2201:2::1/64 - # tag: 6 - # name: Ethernet1/6 - # redirects: false - # - name: Ethernet1/7 - # redirects: false - # - ipv4: - # - address: dhcp - # name: mgmt0 - # commands: - # - interface Ethernet1/6 - # - ip address 192.168.22.3/24 - # - no ipv6 address fd5d:12c9:2201:2::1/64 - # - ip redirects - # after: - # - ipv4: - # - address: 192.168.22.3/24 - # - address: 10.1.1.1/24 - # secondary: true - # tag: 10 - # name: Ethernet1/6 - # redirects: false - # - name: Ethernet1/7 - # redirects: false - # - ipv4: - # - address: dhcp - # name: mgmt0 - - # After state: - # ------------ - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no ip redirects - # ip address 192.168.22.3/24 - # ip address 10.1.1.1/24 secondary tag 10 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no ip redirects - # no shutdown - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - # Using overridden - - # Before state: - # ------------- - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no ip redirects - # ip address 192.168.1.1/24 tag 5 - # ip address 10.1.1.1/24 secondary tag 10 - # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no ip redirects - # no shutdown - # interface Ethernet1/7.42 - # no ip redirects - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - - name: Override device configuration with provided configuration. - cisco.nxos.nxos_l3_interfaces: - config: - - ipv4: - - address: dhcp - name: mgmt0 - - name: Ethernet1/6 - ipv4: - - address: 192.168.22.3/24 - state: overridden - - # Task Output - # ----------- - # - # before: - # - ipv4: - # - address: 192.168.1.1/24 - # tag: 5 - # - address: 10.1.1.1/24 - # secondary: true - # tag: 10 - # ipv6: - # - address: fd5d:12c9:2201:2::1/64 - # tag: 6 - # name: Ethernet1/6 - # redirects: false - # - name: Ethernet1/7 - # redirects: false - # - name: Ethernet1/7.42 - # redirects: false - # - ipv4: - # - address: dhcp - # name: mgmt0 - # commands: - # - interface Ethernet1/6 - # - no ipv6 address fd5d:12c9:2201:2::1/64 - # - no ip address 10.1.1.1/24 secondary - # - ip address 192.168.22.3/24 - # - ip redirects - # - interface Ethernet1/7 - # - ip redirects - # - interface Ethernet1/7.42 - # - ip redirects - # after: - # - ipv4: - # - address: 192.168.22.3/24 - # name: Ethernet1/6 - # - name: Ethernet1/7 - # - name: Ethernet1/7.42 - # - ipv4: - # - address: dhcp - # name: mgmt0 - - # After state: - # ------------ - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # ip address 192.168.22.3/24 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no shutdown - # interface Ethernet1/7.42 - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - # Using deleted - - # Before state: - # ------------- - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # ip address 192.168.22.3/24 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no shutdown - # interface Ethernet1/7.42 - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - - name: Delete L3 attributes of given interfaces (This won't delete the interface - itself). - cisco.nxos.nxos_l3_interfaces: - config: - - name: Ethernet1/6 - - name: Ethernet1/2 - state: deleted - - # Task Output - # ----------- - # - # before: - # - name: Ethernet1/2 - # - ipv4: - # - address: 192.168.22.3/24 - # name: Ethernet1/6 - # - name: Ethernet1/7 - # - name: Ethernet1/7.42 - # - ipv4: - # - address: dhcp - # name: mgmt0 - # commands: - # - interface Ethernet1/6 - # - no ip address - # after: - # - name: Ethernet1/2 - # - name: Ethernet1/7 - # - name: Ethernet1/7.42 - # - ipv4: - # - address: dhcp - # name: mgmt0 - - # After state: - # ------------ - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no shutdown - # interface Ethernet1/7.42 - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - # Using rendered - - - name: Use rendered state to convert task input to device specific commands - cisco.nxos.nxos_l3_interfaces: - config: - - name: Ethernet1/800 - ipv4: - - address: 192.168.1.100/24 - tag: 5 - - address: 10.1.1.1/24 - secondary: true - tag: 10 - - name: Ethernet1/800 - ipv6: - - address: fd5d:12c9:2201:2::1/64 - tag: 6 - state: rendered - - # Task Output - # ----------- - # - # rendered: - # - interface Ethernet1/800 - # - ip address 192.168.1.100/24 tag 5 - # - ip address 10.1.1.1/24 secondary tag 10 - # - interface Ethernet1/800 - # - ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - - # Using parsed - - # parsed.cfg - # ---------- - # - # interface Ethernet1/800 - # ip address 192.168.1.100/24 tag 5 - # ip address 10.1.1.1/24 secondary tag 10 - # no ip redirects - # interface Ethernet1/801 - # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - # ip unreachables - # interface mgmt0 - # ip address dhcp - # vrf member management - - - name: Use parsed state to convert externally supplied config to structured format - cisco.nxos.nxos_l3_interfaces: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output - # ----------- - # - # parsed: - # - name: Ethernet1/800 - # ipv4: - # - address: 192.168.1.100/24 - # tag: 5 - # - address: 10.1.1.1/24 - # secondary: True - # tag: 10 - # redirects: False - # - name: Ethernet1/801 - # ipv6: - # - address: fd5d:12c9:2201:2::1/64 - # tag: 6 - # unreachables: True - - # Using gathered - - # Before state: - # ------------- - # - # interface Ethernet1/1 - # ip address 192.0.2.100/24 - # interface Ethernet1/2 - # no ip redirects - # ip address 203.0.113.10/24 - # ip unreachables - # ipv6 address 2001:db8::1/32 - - - name: Gather l3_interfaces facts from the device using nxos_l3_interfaces - cisco.nxos.nxos_l3_interfaces: - state: gathered - - # Task output - # ----------- - # - # gathered: - # - name: Ethernet1/1 - # ipv4: - # - address: 192.0.2.100/24 - # - name: Ethernet1/2 - # ipv4: - # - address: 203.0.113.10/24 - # ipv6: - # - address: 2001:db8::1/32 - # redirects: False - # unreachables: True - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/2', 'ip address 192.168.0.1/2']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_lacp_module.rst b/docs/cisco.nxos.nxos_lacp_module.rst deleted file mode 100644 index b0410c783..000000000 --- a/docs/cisco.nxos.nxos_lacp_module.rst +++ /dev/null @@ -1,402 +0,0 @@ -.. _cisco.nxos.nxos_lacp_module: - - -******************** -cisco.nxos.nxos_lacp -******************** - -**LACP resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages Global Link Aggregation Control Protocol (LACP) on NX-OS devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
LACP global options.
-
-
- system - -
- dictionary -
- 		- -
LACP system options
-
-
- mac - -
- dictionary -
- 		- -
MAC address to be used for the LACP Protocol exchanges
-
-
- address - -
- string -
- 		- -
MAC-address (FORMAT :xxxx.xxxx.xxxx).
-
-
- role - -
- string -
- 		-
    Choices: -
  • primary
    • -
  • secondary
    • -
- 		-
The role for the Switch.
-
-
- priority - -
- integer -
- 		- -
The system priority to use in LACP negotiations.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | include lacp.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state of the configuration after module completion.
-
States replaced and overridden have the same behaviour for this module.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOS 7.3.(0)D1(1) on VIRL. - - Unsupported for Cisco MDS - - Feature lacp should be enabled for this module. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # - - - name: Merge provided configuration with device configuration. - cisco.nxos.nxos_lacp: - config: - system: - priority: 10 - mac: - address: 00c1.4c00.bd15 - state: merged - - # After state: - # ------------ - # - # lacp system-priority 10 - # lacp system-mac 00c1.4c00.bd15 - - - # Using replaced - - # Before state: - # ------------- - # - # lacp system-priority 10 - - - name: Replace device global lacp configuration with the given configuration. - cisco.nxos.nxos_lacp: - config: - system: - mac: - address: 00c1.4c00.bd15 - state: replaced - - # After state: - # ------------ - # - # lacp system-mac 00c1.4c00.bd15 - - - # Using deleted - - # Before state: - # ------------- - # - # lacp system-priority 10 - - - name: Delete global LACP configurations. - cisco.nxos.nxos_lacp: - state: deleted - - # After state: - # ------------ - # - - # Using rendered - - - name: Render platform specific configuration lines (without connecting to the device) - cisco.nxos.nxos_lacp: - config: - system: - priority: 10 - mac: - address: 00c1.4c00.bd15 - role: secondary - state: rendered - - # Task Output (redacted) - # ----------------------- - - # rendered: - # - "lacp system-priority 10" - # - "lacp system-mac 00c1.4c00.bd15 role secondary" - - # Using parsed - - # parsed.cfg - # ------------ - # lacp system-priority 10 - # lacp system-mac 00c1.4c00.bd15 role secondary - - - name: Use parsed state to convert externally supplied config to structured format - cisco.nxos.nxos_lacp: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # system: - # priority: 10 - # mac: - # address: 00c1.4c00.bd15 - # role: secondary - - # Using gathered - - # Existing device config state - # ------------------------------- - # Nexus9000v# show running-config | include lacp - # lacp system-priority 11 - # lacp system-mac 00c1.4c00.bd15 role primary - - - name: Gather lacp facts from the device using nxos_lacp - cisco.nxos.nxos_lacp: - state: gathered - - # Task output (redacted) - # ----------------------- - # gathered: - # system: - # priority: 11 - # mac: - # address: 00c1.4c00.bd15 - # role: primary - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['lacp system-priority 15', 'lacp system-mac 00c1.4c00.bd15 role primary']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_lldp_interfaces_module.rst b/docs/cisco.nxos.nxos_lldp_interfaces_module.rst deleted file mode 100644 index d634e9aa4..000000000 --- a/docs/cisco.nxos.nxos_lldp_interfaces_module.rst +++ /dev/null @@ -1,407 +0,0 @@ -.. _cisco.nxos.nxos_lldp_interfaces_module: - - -******************************* -cisco.nxos.nxos_lldp_interfaces -******************************* - -**LLDP interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages interfaces' configuration for Link Layer Discovery Protocol (LLDP) on NX-OS platforms. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of link layer discovery configurations for interfaces.
-
-
- name - -
- string - / required -
- 		- -
Name of the interface
-
-
- receive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Used to enable or disable the reception of LLDP packets on that interface. By default, this is enabled after LLDP is enabled globally.
-
-
- tlv_set - -
- dictionary -
- 		- -
Used to configure TLV parameters on the interface
-
-
- management_address - -
- string -
- 		- -
Used to mention the IPv4 or IPv6 management address for the interface
-
-
- vlan - -
- integer -
- 		- -
Used to mention the VLAN for the interface
-
-
- transmit - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Used to enable or disable the transmission of LLDP packets on that interface. By default, this is enabled after LLDP is enabled globally.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section ^interface.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOS 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - The LLDP feature needs to be enabled before using this module - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # - - - name: Merge provided configuration with device configuration - cisco.nxos.nxos_lldp_interfaces: - config: - - name: Ethernet1/4 - receive: false - transmit: true - tlv_set: - management_address: 192.168.122.64 - vlan: 12 - state: merged - - # After state: - # ------------- - # - # interface Ethernet1/4 - # no lldp receive - # lldp tlv-set management-address 192.168.122.64 - # lldp tlv-set vlan 12 - - - # Using replaced - - # Before state: - # ------------ - # - # interface Ethernet1/4 - # no lldp receive - # lldp tlv-set management-address 192.168.122.64 - # interface Ethernet1/5 - # no lldp transmit - # lldp tlv-set vlan 10 - - - name: Replace LLDP configuration on interfaces with given configuration - cisco.nxos.nxos_lldp_interfaces: - config: - - name: Ethernet1/4 - transmit: false - tlv_set: - vlan: 2 - state: replaced - - - # After state: - # ----------- - # - # interface Ethernet1/4 - # no lldp transmit - # lldp tlv_set vlan 2 - # interface Ethernet1/5 - # no lldp transmit - # lldp tlv-set vlan 10 - - - # Using overridden - - # Before state: - # ------------ - # - # interface Ethernet1/4 - # no lldp receive - # lldp tlv-set management-address 192.168.122.64 - # interface Ethernet1/5 - # no lldp transmit - # lldp tlv-set vlan 10 - - - name: Override LLDP configuration on all interfaces with given configuration - cisco.nxos.nxos_lldp_interfaces: - config: - - name: Ethernet1/7 - receive: false - tlv_set: - vlan: 12 - state: overridden - - - # After state: - # ----------- - # - # interface Ethernet1/7 - # no lldp receive - # lldp tlv_set vlan 12 - - - # Using deleted - - # Before state: - # ------------ - # - # interface Ethernet1/4 - # lldp tlv-set management vlan 24 - # no lldp transmit - # interface mgmt0 - # no lldp receive - - - name: Delete LLDP interfaces configuration - cisco.nxos.nxos_lldp_interfaces: - state: deleted - - # After state: - # ------------ - # - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/2', 'lldp receive', 'lldp tlv-set vlan 12']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_logging_module.rst b/docs/cisco.nxos.nxos_logging_module.rst deleted file mode 100644 index 9dafd8e33..000000000 --- a/docs/cisco.nxos.nxos_logging_module.rst +++ /dev/null @@ -1,458 +0,0 @@ -.. _cisco.nxos.nxos_logging_module: - - -*********************** -cisco.nxos.nxos_logging -*********************** - -**Manage logging on network devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2023-08-01 -:Why: Updated module released with more functionality. -:Alternative: nxos_logging_global - - - -Synopsis --------- -- This module provides declarative management of logging on Cisco NX-OS devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
List of logging definitions.
-
-
- dest - -
- string -
- 		-
    Choices: -
  • console
    • -
  • logfile
    • -
  • module
    • -
  • monitor
    • -
  • server
    • -
- 		-
Destination of the logs.
-
-
- dest_level - -
- integer -
- 		- -
Set logging severity levels.
-

aliases: level
-
-
- event - -
- string -
- 		-
    Choices: -
  • link-enable
    • -
  • link-default
    • -
  • trunk-enable
    • -
  • trunk-default
    • -
- 		-
Link/trunk enable/default interface configuration logging
-
-
- facility - -
- string -
- 		- -
Facility name for logging.
-
-
- facility_level - -
- integer -
- 		- -
Set logging severity levels for facility based log messages.
-
-
- facility_link_status - -
- string -
- 		-
    Choices: -
  • link-down-notif
    • -
  • link-down-error
    • -
  • link-up-notif
    • -
  • link-up-error
    • -
- 		-
Set logging facility ethpm link status. Not idempotent with version 6.0 images.
-
-
- file_size - -
- integer -
- 		- -
Set logfile size
-
-
- interface - -
- string -
- 		- -
Interface to be used while configuring source-interface for logging (e.g., 'Ethernet1/2', 'mgmt0')
-
-
- interface_message - -
- string -
- 		-
    Choices: -
  • add-interface-description
    • -
- 		-
Add interface description to interface syslogs. Does not work with version 6.0 images using nxapi as a transport.
-
-
- name - -
- string -
- 		- -
If value of dest is logfile it indicates file-name.
-
-
- purge - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Remove any switch logging configuration that does not match what has been configured Not supported for ansible_connection local. All nxos_logging tasks must use the same ansible_connection type.
-
-
- remote_server - -
- string -
- 		- -
Hostname or IP Address for remote logging (when dest is 'server').
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
State of the logging configuration.
-
-
- timestamp - -
- string -
- 		-
    Choices: -
  • microseconds
    • -
  • milliseconds
    • -
  • seconds
    • -
- 		-
Set logging timestamp format
-
-
- use_vrf - -
- string -
- 		- -
VRF to be used while configuring remote logging (when dest is 'server').
-
-
- - -Notes ------ - -.. note:: - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: configure console logging with level - cisco.nxos.nxos_logging: - dest: console - level: 2 - state: present - - name: remove console logging configuration - cisco.nxos.nxos_logging: - dest: console - level: 2 - state: absent - - name: configure file logging with level - cisco.nxos.nxos_logging: - dest: logfile - name: testfile - dest_level: 3 - state: present - - name: Configure logging logfile with size - cisco.nxos.nxos_logging: - dest: logfile - name: testfile - dest_level: 3 - file_size: 16384 - - name: configure facility level logging - cisco.nxos.nxos_logging: - facility: daemon - facility_level: 0 - state: present - - name: remove facility level logging - cisco.nxos.nxos_logging: - facility: daemon - facility_level: 0 - state: absent - - name: Configure Remote Logging - cisco.nxos.nxos_logging: - dest: server - remote_server: test-syslogserver.com - facility: auth - facility_level: 1 - use_vrf: management - state: present - - name: Configure Source Interface for Logging - cisco.nxos.nxos_logging: - interface: mgmt0 - state: present - - name: Purge nxos_logging configuration not managed by this playbook - cisco.nxos.nxos_logging: - purge: true - - name: Configure logging timestamp - cisco.nxos.nxos_logging: - timestamp: milliseconds - state: present - - name: Configure logging facility ethpm link status - cisco.nxos.nxos_logging: - facility: ethpm - facility_link_status: link-up-notif - state: present - - name: Configure logging message ethernet description - cisco.nxos.nxos_logging: - interface_message: add-interface-description - state: present - - name: Configure logging event link enable - cisco.nxos.nxos_logging: - event: link-enable - state: present - - name: Configure logging using aggregate - cisco.nxos.nxos_logging: - aggregate: - - {dest: console, dest_level: 2} - - {dest: logfile, dest_level: 2, name: testfile} - - {facility: daemon, facility_level: 0} - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['logging console 2', 'logging logfile testfile 3', 'logging level daemon 0']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2023-08-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_ntp_auth_module.rst b/docs/cisco.nxos.nxos_ntp_auth_module.rst deleted file mode 100644 index c825cd017..000000000 --- a/docs/cisco.nxos.nxos_ntp_auth_module.rst +++ /dev/null @@ -1,224 +0,0 @@ -.. _cisco.nxos.nxos_ntp_auth_module: - - -************************ -cisco.nxos.nxos_ntp_auth -************************ - -**Manages NTP authentication.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated module released with more functionality. -:Alternative: nxos_ntp_global - - - -Synopsis --------- -- Manages NTP authentication. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- auth_type - -
- string -
- 		-
    Choices: -
  • text ←
    • -
  • encrypt
    • -
- 		-
Whether the given md5string is in cleartext or has been encrypted. If in cleartext, the device will encrypt it before storing it.
-
-
- authentication - -
- string -
- 		-
    Choices: -
  • on
    • -
  • off
    • -
- 		-
Turns NTP authentication on or off.
-
-
- key_id - -
- string -
- 		- -
Authentication key identifier (numeric).
-
-
- md5string - -
- string -
- 		- -
MD5 String.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- trusted_key - -
- string -
- 		-
    Choices: -
  • false ←
    • -
  • true
    • -
- 		-
Whether the given key is required to be supplied by a time source for the device to synchronize to the time source.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - If ``state=absent``, the module will remove the given key configuration if it exists. - - If ``state=absent`` and ``authentication=on``, authentication will be turned off. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Basic NTP authentication configuration - - cisco.nxos.nxos_ntp_auth: - key_id: 32 - md5string: hello - auth_type: text - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['ntp authentication-key 32 md5 helloWorld 0', 'ntp trusted-key 32']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_ntp_global_module.rst b/docs/cisco.nxos.nxos_ntp_global_module.rst deleted file mode 100644 index b77fc9440..000000000 --- a/docs/cisco.nxos.nxos_ntp_global_module.rst +++ /dev/null @@ -1,1411 +0,0 @@ -.. _cisco.nxos.nxos_ntp_global_module: - - -************************** -cisco.nxos.nxos_ntp_global -************************** - -**NTP Global resource module.** - - -Version added: 2.6.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages ntp configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A dict of ntp configuration.
-
-
- access_group - -
- dictionary -
- 		- -
NTP access-group.
-
This option is unsupported on MDS switches.
-
-
- match_all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Scan ACLs present in all ntp access groups.
-
-
- peer - -
- list - / elements=dictionary -
- 		- -
Access-group peer.
-
-
- access_list - -
- string -
- 		- -
Name of access list.
-
-
- query_only - -
- list - / elements=dictionary -
- 		- -
Access-group query-only.
-
-
- access_list - -
- string -
- 		- -
Name of access list.
-
-
- serve - -
- list - / elements=dictionary -
- 		- -
Access-group serve.
-
-
- access_list - -
- string -
- 		- -
Name of access list.
-
-
- serve_only - -
- list - / elements=dictionary -
- 		- -
Access-group serve-only.
-
-
- access_list - -
- string -
- 		- -
Name of access list.
-
-
- allow - -
- dictionary -
- 		- -
Enable/Disable the packets.
-
-
- control - -
- dictionary -
- 		- -
Control mode packets.
-
-
- rate_limit - -
- integer -
- 		- -
Rate-limit delay.
-
-
- private - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable Private mode packets.
-
-
- authenticate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable authentication.
-
-
- authentication_keys - -
- list - / elements=dictionary -
- 		- -
NTP authentication key.
-
-
- encryption - -
- integer -
- 		- -
0 for Clear text
-
7 for Encrypted
-
-
- id - -
- integer -
- 		- -
Authentication key number (range 1-65535).
-
-
- key - -
- string -
- 		- -
Authentication key.
-
-
- logging - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable logging of NTPD Events.
-
-
- master - -
- dictionary -
- 		- -
Act as NTP master clock.
-
This option is unsupported on MDS switches.
-
-
- stratum - -
- integer -
- 		- -
Stratum number.
-
-
- passive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
NTP passive command.
-
This option is unsupported on MDS switches.
-
-
- peers - -
- list - / elements=dictionary -
- 		- -
NTP Peers.
-
-
- key_id - -
- integer -
- 		- -
Keyid to be used while communicating to this server.
-
-
- maxpoll - -
- integer -
- 		- -
Maximum interval to poll a peer.
-
Poll interval in secs to a power of 2.
-
-
- minpoll - -
- integer -
- 		- -
Minimum interval to poll a peer.
-
Poll interval in secs to a power of 2.
-
-
- peer - -
- string -
- 		- -
Hostname/IP address of the NTP Peer.
-
-
- prefer - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Preferred Server.
-
-
- vrf - -
- string -
- 		- -
Display per-VRF information.
-
This option is unsupported on MDS switches.
-

aliases: use_vrf
-
-
- servers - -
- list - / elements=dictionary -
- 		- -
NTP servers.
-
-
- key_id - -
- integer -
- 		- -
Keyid to be used while communicating to this server.
-
-
- maxpoll - -
- integer -
- 		- -
Maximum interval to poll a peer.
-
Poll interval in secs to a power of 2.
-
-
- minpoll - -
- integer -
- 		- -
Minimum interval to poll a peer.
-
Poll interval in secs to a power of 2.
-
-
- prefer - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Preferred Server.
-
-
- server - -
- string -
- 		- -
Hostname/IP address of the NTP Peer.
-
-
- vrf - -
- string -
- 		- -
Display per-VRF information.
-
This option is not applicable for MDS switches.
-

aliases: use_vrf
-
-
- source - -
- string -
- 		- -
Source of NTP packets.
-
This option is unsupported on MDS switches.
-
-
- source_interface - -
- string -
- 		- -
Source interface sending NTP packets.
-
-
- trusted_keys - -
- list - / elements=dictionary -
- 		- -
NTP trusted-key number.
-
-
- key_id - -
- integer -
- 		- -
Trusted-Key number.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config ntp.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
The states replaced and overridden have identical behaviour for this module.
-
Please refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6 on Cisco Nexus Switches. - - This module works with connection ``network_cli`` and ``httpapi``. - - Tested against Cisco MDS NX-OS 9.2(2) with connection ``network_cli``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k-rdo# show running-config ntp - # nxos-9k-rdo# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_ntp_global: &id001 - config: - access_group: - peer: - - access_list: PeerAcl1 - serve: - - access_list: ServeAcl1 - authenticate: true - authentication_keys: - - id: 1001 - key: vagwwtKfkv - encryption: 7 - - id: 1002 - key: vagwwtKfkvgthz - encryption: 7 - logging: true - master: - stratum: 2 - peers: - - peer: 192.0.2.1 - key_id: 1 - maxpoll: 15 - minpoll: 5 - vrf: default - - peer: 192.0.2.2 - key_id: 2 - prefer: true - vrf: siteA - servers: - - server: 198.51.100.1 - key_id: 2 - vrf: default - - server: 203.0.113.1 - key_id: 1 - vrf: siteB - - # Task output - # ------------- - # before: {} - # - # commands: - # - "ntp authenticate" - # - "ntp logging" - # - "ntp master 2" - # - "ntp authentication-keys 1001 md5 vagwwtKfkv 7" - # - "ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" - # - "ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" - # - "ntp peer 192.0.2.2 prefer use-vrf siteA key 2" - # - "ntp server 198.51.100.1 use-vrf default key 2" - # - "ntp server 203.0.113.1 use-vrf siteB key 1" - # - "ntp access-group peer PeerAcl1" - # - "ntp access-group serve ServeAcl1" - # - # after: - # access_group: - # peer: - # - access_list: PeerAcl1 - # serve: - # - access_list: ServeAcl1 - # authenticate: true - # authentication_keys: - # - id: 1001 - # key: vagwwtKfkv - # encryption: 7 - # - id: 1002 - # key: vagwwtKfkvgthz - # encryption: 7 - # logging: true - # master: - # stratum: 2 - # peers: - # - peer: 192.0.2.1 - # key_id: 1 - # maxpoll: 15 - # minpoll: 5 - # vrf: default - # - peer: 192.0.2.2 - # key_id: 2 - # prefer: true - # vrf: siteA - # servers: - # - server: 198.51.100.1 - # key_id: 2 - # vrf: default - # - server: 203.0.113.1 - # key_id: 1 - # vrf: siteB - - # After state: - # ------------ - # nxos-9k-rdo# show running-config ntp - # ntp authenticate - # ntp logging - # ntp master 2 - # ntp authentication-keys 1001 md5 vagwwtKfkv 7 - # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 - # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 - # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 - # ntp server 198.51.100.1 use-vrf default key 2 - # ntp server 203.0.113.1 use-vrf siteB key 1 - # ntp access-group peer PeerAcl1 - # ntp access-group serve ServeAcl1 - - # Using replaced - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config ntp - # ntp authenticate - # ntp logging - # ntp master 2 - # ntp authentication-keys 1001 md5 vagwwtKfkv 7 - # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 - # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 - # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 - # ntp server 198.51.100.1 use-vrf default key 2 - # ntp server 203.0.113.1 use-vrf siteB key 1 - # ntp access-group peer PeerAcl1 - # ntp access-group serve ServeAcl1 - - - name: Replace logging global configurations of listed logging global with provided configurations - cisco.nxos.nxos_ntp_global: - config: - access_group: - peer: - - access_list: PeerAcl2 - serve: - - access_list: ServeAcl2 - logging: true - master: - stratum: 2 - peers: - - peer: 192.0.2.1 - key_id: 1 - maxpoll: 15 - minpoll: 5 - vrf: default - - peer: 192.0.2.5 - key_id: 2 - prefer: true - vrf: siteA - servers: - - server: 198.51.100.1 - key_id: 2 - vrf: default - state: replaced - - # Task output - # ------------- - # before: - # access_group: - # peer: - # - access_list: PeerAcl1 - # serve: - # - access_list: ServeAcl1 - # authenticate: true - # authentication_keys: - # - id: 1001 - # key: vagwwtKfkv - # encryption: 7 - # - id: 1002 - # key: vagwwtKfkvgthz - # encryption: 7 - # logging: true - # master: - # stratum: 2 - # peers: - # - peer: 192.0.2.1 - # key_id: 1 - # maxpoll: 15 - # minpoll: 5 - # vrf: default - # - peer: 192.0.2.2 - # key_id: 2 - # prefer: true - # vrf: siteA - # servers: - # - server: 198.51.100.1 - # key_id: 2 - # vrf: default - # - server: 203.0.113.1 - # key_id: 1 - # vrf: siteB - # - # commands: - # - "no ntp authenticate" - # - "no ntp authentication-keys 1001 md5 vagwwtKfkv 7" - # - "no ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" - # - "ntp peer 192.0.2.5 prefer use-vrf siteA key 2" - # - "no ntp peer 192.0.2.2 prefer use-vrf siteA key 2" - # - "no ntp server 203.0.113.1 use-vrf siteB key 1" - # - "ntp access-group peer PeerAcl2" - # - "no ntp access-group peer PeerAcl1" - # - "ntp access-group serve ServeAcl2" - # - "no ntp access-group serve ServeAcl1" - # - # after: - # access_group: - # peer: - # - access_list: PeerAcl2 - # serve: - # - access_list: ServeAcl2 - # logging: true - # master: - # stratum: 2 - # peers: - # - peer: 192.0.2.1 - # key_id: 1 - # maxpoll: 15 - # minpoll: 5 - # vrf: default - # - peer: 192.0.2.5 - # key_id: 2 - # prefer: true - # vrf: siteA - # servers: - # - server: 198.51.100.1 - # key_id: 2 - # vrf: default - - # After state: - # ------------ - # nxos-9k-rdo# show running-config ntp - # ntp logging - # ntp master 2 - # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 - # ntp peer 192.0.2.5 prefer use-vrf siteA key 2 - # ntp server 198.51.100.1 use-vrf default key 2 - # ntp access-group peer PeerAcl2 - # ntp access-group serve ServeAcl2 - - # Using deleted to delete all logging configurations - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config ntp - - - name: Delete all logging configuration - cisco.nxos.nxos_ntp_global: - state: deleted - - # Task output - # ------------- - # before: - # access_group: - # peer: - # - access_list: PeerAcl1 - # serve: - # - access_list: ServeAcl1 - # authenticate: true - # authentication_keys: - # - id: 1001 - # key: vagwwtKfkv - # encryption: 7 - # - id: 1002 - # key: vagwwtKfkvgthz - # encryption: 7 - # logging: true - # master: - # stratum: 2 - # peers: - # - peer: 192.0.2.1 - # key_id: 1 - # maxpoll: 15 - # minpoll: 5 - # vrf: default - # - peer: 192.0.2.2 - # key_id: 2 - # prefer: true - # vrf: siteA - # servers: - # - server: 198.51.100.1 - # key_id: 2 - # vrf: default - # - server: 203.0.113.1 - # key_id: 1 - # vrf: siteB - # - # commands: - # - "no ntp authenticate" - # - "no ntp logging" - # - "no ntp master 2" - # - "no ntp authentication-keys 1001 md5 vagwwtKfkv 7" - # - "no ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" - # - "no ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" - # - "no ntp peer 192.0.2.2 prefer use-vrf siteA key 2" - # - "no ntp server 198.51.100.1 use-vrf default key 2" - # - "no ntp server 203.0.113.1 use-vrf siteB key 1" - # - "no ntp access-group peer PeerAcl1" - # - "no ntp access-group serve ServeAcl1" - # - # after: {} - - # After state: - # ------------ - # nxos-9k-rdo# show running-config ntp - # nxos-9k-rdo# - - # Using rendered - - - name: Render platform specific configuration lines with state rendered (without connecting to the device) - cisco.nxos.nxos_ntp_global: - config: - access_group: - peer: - - access_list: PeerAcl1 - serve: - - access_list: ServeAcl1 - authenticate: true - authentication_keys: - - id: 1001 - key: vagwwtKfkv - encryption: 7 - - id: 1002 - key: vagwwtKfkvgthz - encryption: 7 - logging: true - master: - stratum: 2 - peers: - - peer: 192.0.2.1 - key_id: 1 - maxpoll: 15 - minpoll: 5 - vrf: default - - peer: 192.0.2.2 - key_id: 2 - prefer: true - vrf: siteA - servers: - - server: 198.51.100.1 - key_id: 2 - vrf: default - - server: 203.0.113.1 - key_id: 1 - vrf: siteB - state: rendered - - # Task Output (redacted) - # ----------------------- - # rendered: - # - "ntp authenticate" - # - "ntp logging" - # - "ntp master 2" - # - "ntp authentication-keys 1001 md5 vagwwtKfkv 7" - # - "ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" - # - "ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" - # - "ntp peer 192.0.2.2 prefer use-vrf siteA key 2" - # - "ntp server 198.51.100.1 use-vrf default key 2" - # - "ntp server 203.0.113.1 use-vrf siteB key 1" - # - "ntp access-group peer PeerAcl1" - # - "ntp access-group serve ServeAcl1" - - # Using parsed - - # parsed.cfg - # ------------ - # ntp authenticate - # ntp logging - # ntp master 2 - # ntp authentication-keys 1001 md5 vagwwtKfkv 7 - # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 - # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 - # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 - # ntp server 198.51.100.1 use-vrf default key 2 - # ntp server 203.0.113.1 use-vrf siteB key 1 - # ntp access-group peer PeerAcl1 - # ntp access-group serve ServeAcl1 - - - name: Parse externally provided ntp configuration - cisco.nxos.nxos_ntp_global: - running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # access_group: - # peer: - # - access_list: PeerAcl1 - # serve: - # - access_list: ServeAcl1 - # authenticate: true - # authentication_keys: - # - id: 1001 - # key: vagwwtKfkv - # encryption: 7 - # - id: 1002 - # key: vagwwtKfkvgthz - # encryption: 7 - # logging: true - # master: - # stratum: 2 - # peers: - # - peer: 192.0.2.1 - # key_id: 1 - # maxpoll: 15 - # minpoll: 5 - # vrf: default - # - peer: 192.0.2.2 - # key_id: 2 - # prefer: true - # vrf: siteA - # servers: - # - server: 198.51.100.1 - # key_id: 2 - # vrf: default - # - server: 203.0.113.1 - # key_id: 1 - # vrf: siteB - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['ntp master stratum 2', 'ntp peer 198.51.100.1 use-vrf test maxpoll 7', 'ntp authentication-key 10 md5 wawyhanx2 7', 'ntp access-group peer PeerAcl1', 'ntp access-group peer PeerAcl2', 'ntp access-group query-only QueryAcl1']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['ntp master stratum 2', 'ntp peer 198.51.100.1 use-vrf test maxpoll 7', 'ntp authentication-key 10 md5 wawyhanx2 7', 'ntp access-group peer PeerAcl1', 'ntp access-group peer PeerAcl2', 'ntp access-group query-only QueryAcl1']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_ntp_module.rst b/docs/cisco.nxos.nxos_ntp_module.rst deleted file mode 100644 index 3fa835a96..000000000 --- a/docs/cisco.nxos.nxos_ntp_module.rst +++ /dev/null @@ -1,314 +0,0 @@ -.. _cisco.nxos.nxos_ntp_module: - - -******************* -cisco.nxos.nxos_ntp -******************* - -**Manages core NTP configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated module released with more functionality. -:Alternative: nxos_ntp_global - - - -Synopsis --------- -- Manages core NTP configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- key_id - -
- string -
- 		- -
Authentication key identifier to use with given NTP server or peer or keyword 'default'.
-
-
- peer - -
- string -
- 		- -
Network address of NTP peer.
-
-
- prefer - -
- string -
- 		-
    Choices: -
  • enabled
    • -
  • disabled
    • -
- 		-
Makes given NTP server or peer the preferred NTP server or peer for the device.
-
-
- server - -
- string -
- 		- -
Network address of NTP server.
-
-
- source_addr - -
- string -
- 		- -
Local source address from which NTP messages are sent or keyword 'default'.
-
-
- source_int - -
- string -
- 		- -
Local source interface from which NTP messages are sent. Must be fully qualified interface name or keyword 'default'
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- vrf_name - -
- string -
- 		- -
Makes the device communicate with the given NTP server or peer over a specific VRF or keyword 'default'.
-
-
- - -Notes ------ - -.. note:: - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Set NTP Server with parameters - - cisco.nxos.nxos_ntp: - server: 1.2.3.4 - key_id: 32 - prefer: enabled - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- end_state - -
- dictionary -
- 		always -
k/v pairs of ntp info after module execution
-
-
Sample:
-
{'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'server', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'source'}
-
-
- existing - -
- dictionary -
- 		always -
k/v pairs of existing ntp server/peer
-
-
Sample:
-
{'address': '192.0.2.2', 'key_id': '32', 'peer_type': 'server', 'prefer': 'enabled', 'source': 'ethernet2/1', 'source_type': 'source-interface'}
-
-
- proposed - -
- dictionary -
- 		always -
k/v pairs of parameters passed into module
-
-
Sample:
-
{'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'server', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'source'}
-
-
- updates - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['ntp server 192.0.2.2 prefer key 48', 'no ntp source-interface ethernet2/1', 'ntp source 192.0.2.3']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_ntp_options_module.rst b/docs/cisco.nxos.nxos_ntp_options_module.rst deleted file mode 100644 index e99825641..000000000 --- a/docs/cisco.nxos.nxos_ntp_options_module.rst +++ /dev/null @@ -1,192 +0,0 @@ -.. _cisco.nxos.nxos_ntp_options_module: - - -*************************** -cisco.nxos.nxos_ntp_options -*************************** - -**Manages NTP options.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated module released with more functionality. -:Alternative: nxos_ntp_global - - - -Synopsis --------- -- Manages NTP options, e.g. authoritative server and logging. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- logging - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Sets whether NTP logging is enabled on the device.
-
-
- master - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Sets whether the device is an authoritative NTP server.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- stratum - -
- string -
- 		- -
If master=true, an optional stratum can be supplied (1-15). The device default is 8.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - When ``state=absent``, master and logging will be set to False and stratum will be removed as well - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Basic NTP options configuration - - cisco.nxos.nxos_ntp_options: - master: true - stratum: 12 - logging: false - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- updates - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['no ntp logging', 'ntp master 12']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_nxapi_module.rst b/docs/cisco.nxos.nxos_nxapi_module.rst deleted file mode 100644 index 182fe1516..000000000 --- a/docs/cisco.nxos.nxos_nxapi_module.rst +++ /dev/null @@ -1,300 +0,0 @@ -.. _cisco.nxos.nxos_nxapi_module: - - -********************* -cisco.nxos.nxos_nxapi -********************* - -**Manage NXAPI configuration on an NXOS device.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configures the NXAPI feature on devices running Cisco NXOS. The NXAPI feature is absent from the configuration by default. Since this module manages the NXAPI feature it only supports the use of the ``Cli`` transport. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- http - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Controls the operating state of the HTTP protocol as one of the underlying transports for NXAPI. By default, NXAPI will enable the HTTP transport when the feature is first configured. To disable the use of the HTTP transport, set the value of this argument to False.
-

aliases: enable_http
-
-
- http_port - -
- integer -
- 		- Default:
80
- 		-
Configure the port with which the HTTP server will listen on for requests. By default, NXAPI will bind the HTTP service to the standard HTTP port 80. This argument accepts valid port values in the range of 1 to 65535.
-
-
- https - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Controls the operating state of the HTTPS protocol as one of the underlying transports for NXAPI. By default, NXAPI will disable the HTTPS transport when the feature is first configured. To enable the use of the HTTPS transport, set the value of this argument to True.
-

aliases: enable_https
-
-
- https_port - -
- integer -
- 		- Default:
443
- 		-
Configure the port with which the HTTPS server will listen on for requests. By default, NXAPI will bind the HTTPS service to the standard HTTPS port 443. This argument accepts valid port values in the range of 1 to 65535.
-
-
- sandbox - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
The NXAPI feature provides a web base UI for developers for entering commands. This feature is initially disabled when the NXAPI feature is configured for the first time. When the sandbox argument is set to True, the developer sandbox URL will accept requests and when the value is set to False, the sandbox URL is unavailable. This is supported on NX-OS 7K series.
-

aliases: enable_sandbox
-
-
- ssl_strong_ciphers - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Controls the use of whether strong or weak ciphers are configured. By default, this feature is disabled and weak ciphers are configured. To enable the use of strong ciphers, set the value of this argument to True.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
The state argument controls whether or not the NXAPI feature is configured on the remote device. When the value is present the NXAPI feature configuration is present in the device running-config. When the values is absent the feature configuration is removed from the running-config.
-
-
- tlsv1_0 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Controls the use of the Transport Layer Security version 1.0 is configured. By default, this feature is enabled. To disable the use of TLSV1.0, set the value of this argument to True.
-
-
- tlsv1_1 - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Controls the use of the Transport Layer Security version 1.1 is configured. By default, this feature is disabled. To enable the use of TLSV1.1, set the value of this argument to True.
-
-
- tlsv1_2 - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Controls the use of the Transport Layer Security version 1.2 is configured. By default, this feature is disabled. To enable the use of TLSV1.2, set the value of this argument to True.
-
-
- - -Notes ------ - -.. note:: - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Enable NXAPI access with default configuration - cisco.nxos.nxos_nxapi: - state: present - - - name: Enable NXAPI with no HTTP, HTTPS at port 9443 and sandbox disabled - cisco.nxos.nxos_nxapi: - enable_http: false - https_port: 9443 - https: true - enable_sandbox: false - - - name: remove NXAPI configuration - cisco.nxos.nxos_nxapi: - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- updates - -
- list -
- 		always -
Returns the list of commands that need to be pushed into the remote device to satisfy the arguments
-
-
Sample:
-
['no feature nxapi']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_ospf_interfaces_module.rst b/docs/cisco.nxos.nxos_ospf_interfaces_module.rst deleted file mode 100644 index ff69b6e71..000000000 --- a/docs/cisco.nxos.nxos_ospf_interfaces_module.rst +++ /dev/null @@ -1,1732 +0,0 @@ -.. _cisco.nxos.nxos_ospf_interfaces_module: - - -******************************* -cisco.nxos.nxos_ospf_interfaces -******************************* - -**OSPF Interfaces Resource Module.** - - -Version added: 1.3.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages OSPF(v2/v3) configuration of interfaces on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of OSPF configuration for interfaces.
-
-
- address_family - -
- list - / elements=dictionary -
- 		- -
OSPF settings on the interfaces in address-family context.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
Address Family Identifier (AFI) for OSPF settings on the interfaces.
-
-
- authentication - -
- dictionary -
- 		- -
Authentication settings on the interface.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/disable authentication on the interface.
-
-
- key_chain - -
- string -
- 		- -
Authentication password key-chain.
-
-
- message_digest - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use message-digest authentication.
-
-
- null_auth - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use null(disable) authentication.
-
-
- authentication_key - -
- dictionary -
- 		- -
Configure the authentication key for the interface.
-
-
- encryption - -
- integer -
- 		- -
0 Specifies an UNENCRYPTED authentication key will follow.
-
3 Specifies an 3DES ENCRYPTED authentication key will follow.
-
7 Specifies a Cisco type 7 ENCRYPTED authentication key will follow.
-
-
- key - -
- string - / required -
- 		- -
Authentication key.
-
Valid values are Cisco type 7 ENCRYPTED password, 3DES ENCRYPTED password and UNENCRYPTED (cleartext) password based on the value of encryption key.
-
-
- cost - -
- integer -
- 		- -
Cost associated with interface.
-
-
- dead_interval - -
- integer -
- 		- -
Dead interval value (in seconds).
-
-
- default_passive_interface - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set passive-interface attribute on this interface to default.
-
This option is mutually exclusive with passive_interface.
-
-
- hello_interval - -
- integer -
- 		- -
Hello interval value (in seconds).
-
-
- instance - -
- integer -
- 		- -
Instance identifier.
-
-
- message_digest_key - -
- dictionary -
- 		- -
Message digest authentication password (key) settings.
-
-
- encryption - -
- integer -
- 		- -
0 Specifies an UNENCRYPTED ospf password (key) will follow.
-
3 Specifies an 3DES ENCRYPTED ospf password (key) will follow.
-
7 Specifies a Cisco type 7 ENCRYPTED the ospf password (key) will follow.
-
-
- key - -
- string - / required -
- 		- -
Authentication key.
-
Valid values are Cisco type 7 ENCRYPTED password, 3DES ENCRYPTED password and UNENCRYPTED (cleartext) password based on the value of encryption key.
-
-
- key_id - -
- integer - / required -
- 		- -
Key ID.
-
-
- mtu_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/disable OSPF MTU mismatch detection.
-
-
- multi_areas - -
- list - / elements=string -
- 		- -
Multi-Areas associated with interface (not tied to OSPF process).
-
Valid values are Area Ids as an integer or IP address.
-
-
- network - -
- string -
- 		-
    Choices: -
  • broadcast
    • -
  • point-to-point
    • -
- 		-
Network type.
-
-
- passive_interface - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress routing updates on the interface.
-
This option is mutually exclusive with default_passive_interface.
-
-
- priority - -
- integer -
- 		- -
Router priority.
-
-
- processes - -
- list - / elements=dictionary -
- 		- -
Interfaces configuration for an OSPF process.
-
-
- area - -
- dictionary -
- 		- -
Area associated with interface.
-
-
- area_id - -
- string - / required -
- 		- -
Area ID in IP address format.
-
-
- secondaries - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not include secondary IPv4/IPv6 addresses.
-
-
- multi_areas - -
- list - / elements=string -
- 		- -
Multi-Areas associated with interface.
-
Valid values are Area Ids as an integer or IP address.
-
-
- process_id - -
- string - / required -
- 		- -
OSPF process tag.
-
-
- retransmit_interval - -
- integer -
- 		- -
Packet retransmission interval.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Shutdown OSPF on this interface.
-
-
- transmit_delay - -
- integer -
- 		- -
Packet transmission delay.
-
-
- name - -
- string - / required -
- 		- -
Name/Identifier of the interface.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section "^interface".
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • parsed
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
-
- - -Notes ------ - -.. note:: - - Unsupported for Cisco MDS - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # interface Ethernet1/2 - # no switchport - # interface Ethernet1/3 - # no switchport - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_ospf_interfaces: - config: - - name: Ethernet1/1 - address_family: - - afi: ipv4 - processes: - - process_id: '100' - area: - area_id: 1.1.1.1 - secondaries: false - multi_areas: - - 11.11.11.11 - - afi: ipv6 - processes: - - process_id: '200' - area: - area_id: 2.2.2.2 - multi_areas: - - 21.0.0.0 - - process_id: '300' - multi_areas: - - 50.50.50.50 - multi_areas: - - 16.10.10.10 - - name: Ethernet1/2 - address_family: - - afi: ipv4 - authentication: - enable: true - key_chain: test-1 - message_digest_key: - key_id: 10 - encryption: 3 - key: abc01d272be25d29 - cost: 100 - - afi: ipv6 - network: broadcast - shutdown: true - - name: Ethernet1/3 - address_family: - - afi: ipv4 - authentication_key: - encryption: 7 - key: 12090404011C03162E - state: merged - - # Task output: - # ------------ - # before: - # - name: Ethernet1/1 - # - name: Ethernet1/2 - # - name: Ethernet1/3 - # - # commands: - # - interface Ethernet1/1 - # - ip router ospf multi-area 11.11.11.11 - # - ip router ospf 100 area 1.1.1.1 secondaries none - # - ipv6 router ospfv3 multi-area 16.10.10.10 - # - ipv6 router ospfv3 200 area 2.2.2.2 - # - ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - interface Ethernet1/2 - # - ip ospf authentication key-chain test-1 - # - ip ospf authentication - # - ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # - ip ospf cost 100 - # - ospfv3 network broadcast - # - ospfv3 shutdown - # - interface Ethernet1/3 - # - ip ospf authentication-key 7 12090404011C03162E - # - # after: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.11 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # - afi: ipv6 - # multi_areas: - # - 16.10.10.10 - # processes: - # - area: - # area_id: 2.2.2.2 - # multi_areas: - # - 21.0.0.0 - # process_id: '200' - # - multi_areas: - # - 50.50.50.50 - # process_id: '300' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - - # After state: - # ------------ - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - - # Using replaced - - # Before state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - - name: Replace OSPF configurations of listed interfaces with provided configurations - cisco.nxos.nxos_ospf_interfaces: - config: - - name: Ethernet1/1 - address_family: - - afi: ipv4 - processes: - - process_id: "100" - area: - area_id: 1.1.1.1 - secondaries: false - multi_areas: - - 11.11.11.12 - - name: Ethernet1/3 - state: replaced - - # Task output: - # ------------ - # before: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.11 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # - afi: ipv6 - # multi_areas: - # - 16.10.10.10 - # processes: - # - area: - # area_id: 2.2.2.2 - # multi_areas: - # - 21.0.0.0 - # process_id: '200' - # - multi_areas: - # - 50.50.50.50 - # process_id: '300' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - # - # commands: - # - interface Ethernet1/1 - # - ip router ospf multi-area 11.11.11.12 - # - no ip router ospf multi-area 11.11.11.11 - # - no ipv6 router ospfv3 multi-area 16.10.10.10 - # - no ipv6 router ospfv3 200 area 2.2.2.2 - # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - interface Ethernet1/3 - # - no ip ospf authentication-key 7 12090404011C03162E - # - # after: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.12 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - name: Ethernet1/3 - # - # After state: - # ------------ - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.12 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - - - # Using overridden - - # Before state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - - name: Override all OSPF interfaces configuration with provided configuration - cisco.nxos.nxos_ospf_interfaces: - config: - - name: Ethernet1/1 - address_family: - - afi: ipv4 - processes: - - process_id: "100" - area: - area_id: 1.1.1.1 - secondaries: false - multi_areas: - - 11.11.11.12 - state: overridden - - # Task output: - # ------------ - # before: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.11 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # - afi: ipv6 - # multi_areas: - # - 16.10.10.10 - # processes: - # - area: - # area_id: 2.2.2.2 - # multi_areas: - # - 21.0.0.0 - # process_id: '200' - # - multi_areas: - # - 50.50.50.50 - # process_id: '300' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - # - # commands: - # - interface Ethernet1/2 - # - no ip ospf authentication key-chain test-1 - # - no ip ospf authentication - # - no ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # - no ip ospf cost 100 - # - no ospfv3 network broadcast - # - no ospfv3 shutdown - # - interface Ethernet1/3 - # - no ip ospf authentication-key 7 12090404011C03162E - # - interface Ethernet1/1 - # - ip router ospf multi-area 11.11.11.12 - # - no ip router ospf multi-area 11.11.11.11 - # - no ipv6 router ospfv3 multi-area 16.10.10.10 - # - no ipv6 router ospfv3 200 area 2.2.2.2 - # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - # after: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.12 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # name: Ethernet1/1 - # - name: Ethernet1/2 - # - name: Ethernet1/3 - - # After state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.12 - # interface Ethernet1/2 - # no switchport - # interface Ethernet1/3 - # no switchport - - # Using deleted to delete OSPF config of a single interface - - # Before state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - - name: Delete OSPF config from a single interface - cisco.nxos.nxos_ospf_interfaces: - config: - - name: Ethernet1/1 - state: deleted - - # Task output: - # ------------ - # before: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.11 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # - afi: ipv6 - # multi_areas: - # - 16.10.10.10 - # processes: - # - area: - # area_id: 2.2.2.2 - # multi_areas: - # - 21.0.0.0 - # process_id: '200' - # - multi_areas: - # - 50.50.50.50 - # process_id: '300' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - # - # commands: - # - interface Ethernet1/1 - # - no ip router ospf multi-area 11.11.11.11 - # - no ip router ospf 100 area 1.1.1.1 secondaries none - # - no ipv6 router ospfv3 multi-area 16.10.10.10 - # - no ipv6 router ospfv3 200 area 2.2.2.2 - # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - # after: - # - name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - - - # After state: - # ------------ - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - # Using deleted to delete OSPF config from all interfaces - - # Before state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - - name: Delete OSPF config from all interfaces - cisco.nxos.nxos_ospf_interfaces: - state: deleted - - # Task output: - # ------------ - # before: - # - name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - # - # commands: - # - interface Ethernet1/1 - # - no ip router ospf multi-area 11.11.11.11 - # - no ip router ospf 100 area 1.1.1.1 secondaries none - # - no ipv6 router ospfv3 multi-area 16.10.10.10 - # - no ipv6 router ospfv3 200 area 2.2.2.2 - # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - interface Ethernet1/2 - # - no ip ospf authentication key-chain test-1 - # - no ip ospf authentication - # - no ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # - no ip ospf cost 100 - # - no ospfv3 network broadcast - # - no ospfv3 shutdown - # - interface Ethernet1/3 - # - no ip ospf authentication-key 7 12090404011C03162E - # - # after: - # - name: Ethernet1/1 - # - name: Ethernet1/2 - # - name: Ethernet1/3 - - # After state: - # ------------ - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # interface Ethernet1/2 - # no switchport - # interface Ethernet1/3 - # no switchport - - # Using rendered - - - name: >- - Render platform specific configuration lines with state rendered (without - connecting to the device) - cisco.nxos.nxos_ospf_interfaces: - config: - - name: Ethernet1/1 - address_family: - - afi: ipv4 - processes: - - process_id: '100' - area: - area_id: 1.1.1.1 - secondaries: false - multi_areas: - - 11.11.11.11 - - afi: ipv6 - processes: - - process_id: '200' - area: - area_id: 2.2.2.2 - multi_areas: - - 21.0.0.0 - - process_id: '300' - multi_areas: - - 50.50.50.50 - multi_areas: - - 16.10.10.10 - - name: Ethernet1/2 - address_family: - - afi: ipv4 - authentication: - enable: true - key_chain: test-1 - message_digest_key: - key_id: 10 - encryption: 3 - key: abc01d272be25d29 - cost: 100 - - afi: ipv6 - network: broadcast - shutdown: true - - name: Ethernet1/3 - address_family: - - afi: ipv4 - authentication_key: - encryption: 7 - key: 12090404011C03162E - state: rendered - - - # Task Output: - # ------------ - # rendered: - # - interface Ethernet1/1 - # - ip router ospf multi-area 11.11.11.11 - # - ip router ospf 100 area 1.1.1.1 secondaries none - # - ipv6 router ospfv3 multi-area 16.10.10.10 - # - ipv6 router ospfv3 200 area 2.2.2.2 - # - ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - interface Ethernet1/2 - # - ip ospf authentication key-chain test-1 - # - ip ospf authentication - # - ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # - ip ospf cost 100 - # - ospfv3 network broadcast - # - ospfv3 shutdown - # - interface Ethernet1/3 - # - ip ospf authentication-key 7 12090404011C03162E - - # Using parsed - - # parsed.cfg - # ------------ - # interface Ethernet1/1 - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # interface Ethernet1/2 - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # ip ospf authentication-key 7 12090404011C03162E - - - name: arse externally provided OSPF interfaces config - cisco.nxos.nxos_ospf_interfaces: - running_config: "{{ lookup('file', 'ospf_interfaces.cfg') }}" - state: parsed - - # Task output: - # ------------ - # parsed: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.11 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # - afi: ipv6 - # multi_areas: - # - 16.10.10.10 - # processes: - # - area: - # area_id: 2.2.2.2 - # multi_areas: - # - 21.0.0.0 - # process_id: '200' - # - multi_areas: - # - 50.50.50.50 - # process_id: '300' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - - # Using gathered - - # On-box config - - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.12 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - - # Task output: - # ------------ - # gathered: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.12 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - name: Ethernet1/3 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/1', 'ip router ospf multi-area 11.11.11.11', 'ip router ospf 100 area 1.1.1.1 secondaries none', 'no ipv6 router ospfv3 multi-area 16.10.10.10', 'ipv6 router ospfv3 200 area 2.2.2.2', 'ipv6 router ospfv3 200 multi-area 21.0.0.0', 'ipv6 router ospfv3 300 multi-area 50.50.50.50', 'interface Ethernet1/2', 'no ip ospf authentication key-chain test-1', 'ip ospf authentication']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['interface Ethernet1/1', 'ip router ospf multi-area 11.11.11.11', 'ip router ospf 100 area 1.1.1.1 secondaries none']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_ospfv2_module.rst b/docs/cisco.nxos.nxos_ospfv2_module.rst deleted file mode 100644 index 2115d34f2..000000000 --- a/docs/cisco.nxos.nxos_ospfv2_module.rst +++ /dev/null @@ -1,5458 +0,0 @@ -.. _cisco.nxos.nxos_ospfv2_module: - - -********************** -cisco.nxos.nxos_ospfv2 -********************** - -**OSPFv2 resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages OSPFv2 configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A list of OSPF process configuration.
-
-
- processes - -
- list - / elements=dictionary -
- 		- -
A list of OSPF instances' configurations.
-
-
- areas - -
- list - / elements=dictionary -
- 		- -
Configure properties of OSPF Areas.
-
-
- area_id - -
- string - / required -
- 		- -
The Area ID in IP Address format.
-
-
- authentication - -
- dictionary -
- 		- -
Authentication settings for the Area.
-
-
- message_digest - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use message-digest authentication.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set authentication for the area.
-
-
- default_cost - -
- integer -
- 		- -
Specify the default cost for default summary LSA.
-
-
- filter_list - -
- list - / elements=dictionary -
- 		- -
Filter prefixes between OSPF areas.
-
-
- direction - -
- string - / required -
- 		-
    Choices: -
  • in
    • -
  • out
    • -
- 		-
The direction to apply the route map.
-
-
- route_map - -
- string - / required -
- 		- -
The Route-map name.
-
-
- nssa - -
- dictionary -
- 		- -
NSSA settings for the area.
-
-
- default_information_originate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Originate Type-7 default LSA into NSSA area.
-
-
- no_redistribution - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send redistributed LSAs into NSSA area.
-
-
- no_summary - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send summary LSAs into NSSA area.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure area as NSSA.
-
-
- translate - -
- dictionary -
- 		- -
Translate LSA.
-
-
- type7 - -
- dictionary -
- 		- -
Translate from Type 7 to Type 5.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always translate LSAs
-
-
- never - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Never translate LSAs
-
-
- supress_fa - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress forwarding address in translated LSAs.
-
-
- ranges - -
- list - / elements=dictionary -
- 		- -
Configure an address range for the area.
-
-
- cost - -
- integer -
- 		- -
Cost to use for the range.
-
-
- not_advertise - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress advertising the specified range.
-
-
- prefix - -
- string - / required -
- 		- -
IP in Prefix format (x.x.x.x/len)
-
-
- stub - -
- dictionary -
- 		- -
Settings for configuring the area as a stub.
-
-
- no_summary - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Prevent ABR from sending summary LSAs into stub area.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure the area as a stub.
-
-
- auto_cost - -
- dictionary -
- 		- -
Calculate OSPF cost according to bandwidth.
-
-
- reference_bandwidth - -
- integer - / required -
- 		- -
Reference bandwidth used to assign OSPF cost.
-
-
- unit - -
- string - / required -
- 		-
    Choices: -
  • Gbps
    • -
  • Mbps
    • -
- 		-
Specify in which unit the reference bandwidth is specified.
-
-
- bfd - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable BFD on all OSPF interfaces.
-
-
- default_information - -
- dictionary -
- 		- -
Control distribution of default routes.
-
-
- originate - -
- dictionary -
- 		- -
Distribute a default route.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always advertise a default route.
-
-
- route_map - -
- string -
- 		- -
Policy to control distribution of default routes
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable distribution of default route.
-
-
- default_metric - -
- integer -
- 		- -
Specify default metric for redistributed routes.
-
-
- distance - -
- integer -
- 		- -
Configure the OSPF administrative distance.
-
-
- flush_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flush routes on a non-graceful controlled restart.
-
-
- graceful_restart - -
- dictionary -
- 		- -
Configure graceful restart.
-
-
- grace_period - -
- integer -
- 		- -
Configure maximum interval to restart gracefully.
-
-
- helper_disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable helper mode.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable graceful-restart.
-
-
- isolate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Isolate this router from OSPF perspective.
-
-
- log_adjacency_changes - -
- dictionary -
- 		- -
Log changes in adjacency state.
-
-
- detail - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Notify all state changes.
-
-
- log - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/disable logging changes in adjacency state.
-
-
- max_lsa - -
- dictionary -
- 		- -
Feature to limit the number of non-self-originated LSAs.
-
-
- ignore_count - -
- integer -
- 		- -
Set count on how many times adjacencies can be suppressed.
-
-
- ignore_time - -
- integer -
- 		- -
Set time during which all adjacencies are suppressed.
-
-
- max_non_self_generated_lsa - -
- integer - / required -
- 		- -
Set the maximum number of non self-generated LSAs.
-
-
- reset_time - -
- integer -
- 		- -
Set number of minutes after which ignore-count is reset to zero.
-
-
- threshold - -
- integer -
- 		- -
Threshold value (%) at which to generate a warning message.
-
-
- warning_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Log a warning message when limit is exceeded.
-
-
- max_metric - -
- dictionary -
- 		- -
Maximize the cost metric.
-
-
- router_lsa - -
- dictionary -
- 		- -
Router LSA configuration.
-
-
- external_lsa - -
- dictionary -
- 		- -
External LSA configuration.
-
-
- max_metric_value - -
- integer -
- 		- -
Set max metric value for external LSAs.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set external-lsa attribute.
-
-
- include_stub - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise Max metric for Stub links as well.
-
-
- on_startup - -
- dictionary -
- 		- -
Effective only at startup.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set on-startup attribute.
-
-
- wait_for_bgp_asn - -
- integer -
- 		- -
ASN of BGP to wait for.
-
-
- wait_period - -
- integer -
- 		- -
Wait period in seconds after startup.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set router-lsa attribute.
-
-
- summary_lsa - -
- dictionary -
- 		- -
Summary LSAs configuration.
-
-
- max_metric_value - -
- integer -
- 		- -
Max metric value for summary LSAs.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set summary-lsa attribute.
-
-
- maximum_paths - -
- integer -
- 		- -
Maximum paths per destination.
-
-
- mpls - -
- dictionary -
- 		- -
OSPF MPLS configuration settings.
-
-
- traffic_eng - -
- dictionary -
- 		- -
OSPF MPLS Traffic Engineering commands.
-
-
- areas - -
- list - / elements=dictionary -
- 		- -
List of Area IDs.
-
-
- area_id - -
- string -
- 		- -
Area Id in ip address format.
-
-
- multicast_intact - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
MPLS TE multicast support.
-
-
- router_id - -
- string -
- 		- -
Router ID associated with TE.
-
-
- name_lookup - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Display OSPF router ids as DNS names.
-
-
- passive_interface - -
- dictionary -
- 		- -
Suppress routing updates on the interface.
-
-
- default - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Interfaces passive by default.
-
-
- process_id - -
- string - / required -
- 		- -
The OSPF process tag.
-
-
- redistribute - -
- list - / elements=dictionary -
- 		- -
Redistribute information from another routing protocol.
-
-
- id - -
- string -
- 		- -
The identifier for the protocol specified.
-
-
- protocol - -
- string - / required -
- 		-
    Choices: -
  • bgp
    • -
  • direct
    • -
  • eigrp
    • -
  • isis
    • -
  • lisp
    • -
  • ospf
    • -
  • rip
    • -
  • static
    • -
- 		-
The name of the protocol.
-
-
- route_map - -
- string - / required -
- 		- -
The route map policy to constrain redistribution.
-
-
- rfc1583compatibility - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure 1583 compatibility for external path preferences.
-
-
- router_id - -
- string -
- 		- -
Set OSPF process router-id.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Shutdown the OSPF protocol instance.
-
-
- summary_address - -
- list - / elements=dictionary -
- 		- -
Configure route summarization for redistribution.
-
-
- not_advertise - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress advertising the specified summary.
-
-
- prefix - -
- string - / required -
- 		- -
IP prefix in format x.x.x.x/ml.
-
-
- tag - -
- integer -
- 		- -
A 32-bit tag value.
-
-
- table_map - -
- dictionary -
- 		- -
Policy for filtering/modifying OSPF routes before sending them to RIB.
-
-
- filter - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Block the OSPF routes from being sent to RIB.
-
-
- name - -
- string - / required -
- 		- -
The Route Map name.
-
-
- timers - -
- dictionary -
- 		- -
Configure timer related constants.
-
-
- lsa_arrival - -
- integer -
- 		- -
Mimimum interval between arrival of a LSA.
-
-
- lsa_group_pacing - -
- integer -
- 		- -
LSA group refresh/maxage interval.
-
-
- throttle - -
- dictionary -
- 		- -
Configure throttle related constants.
-
-
- lsa - -
- dictionary -
- 		- -
Set rate-limiting for LSA generation.
-
-
- hold_interval - -
- integer -
- 		- -
The hold interval.
-
-
- max_interval - -
- integer -
- 		- -
The max interval.
-
-
- start_interval - -
- integer -
- 		- -
The start interval.
-
-
- spf - -
- dictionary -
- 		- -
Set OSPF SPF timers.
-
-
- initial_spf_delay - -
- integer -
- 		- -
Initial SPF schedule delay in milliseconds.
-
-
- max_wait_time - -
- integer -
- 		- -
Maximum wait time between SPF calculations.
-
-
- min_hold_time - -
- integer -
- 		- -
Minimum hold time between SPF calculations.
-
-
- vrfs - -
- list - / elements=dictionary -
- 		- -
Configure VRF specific OSPF settings.
-
-
- areas - -
- list - / elements=dictionary -
- 		- -
Configure properties of OSPF Areas.
-
-
- area_id - -
- string - / required -
- 		- -
The Area ID in IP Address format.
-
-
- authentication - -
- dictionary -
- 		- -
Authentication settings for the Area.
-
-
- message_digest - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use message-digest authentication.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set authentication for the area.
-
-
- default_cost - -
- integer -
- 		- -
Specify the default cost for default summary LSA.
-
-
- filter_list - -
- list - / elements=dictionary -
- 		- -
Filter prefixes between OSPF areas.
-
-
- direction - -
- string - / required -
- 		-
    Choices: -
  • in
    • -
  • out
    • -
- 		-
The direction to apply the route map.
-
-
- route_map - -
- string - / required -
- 		- -
The Route-map name.
-
-
- nssa - -
- dictionary -
- 		- -
NSSA settings for the area.
-
-
- default_information_originate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Originate Type-7 default LSA into NSSA area.
-
-
- no_redistribution - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send redistributed LSAs into NSSA area.
-
-
- no_summary - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send summary LSAs into NSSA area.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure area as NSSA.
-
-
- translate - -
- dictionary -
- 		- -
Translate LSA.
-
-
- type7 - -
- dictionary -
- 		- -
Translate from Type 7 to Type 5.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always translate LSAs
-
-
- never - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Never translate LSAs
-
-
- supress_fa - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress forwarding address in translated LSAs.
-
-
- ranges - -
- list - / elements=dictionary -
- 		- -
Configure an address range for the area.
-
-
- cost - -
- integer -
- 		- -
Cost to use for the range.
-
-
- not_advertise - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress advertising the specified range.
-
-
- prefix - -
- string - / required -
- 		- -
IP in Prefix format (x.x.x.x/len)
-
-
- stub - -
- dictionary -
- 		- -
Settings for configuring the area as a stub.
-
-
- no_summary - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Prevent ABR from sending summary LSAs into stub area.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure the area as a stub.
-
-
- auto_cost - -
- dictionary -
- 		- -
Calculate OSPF cost according to bandwidth.
-
-
- reference_bandwidth - -
- integer - / required -
- 		- -
Reference bandwidth used to assign OSPF cost.
-
-
- unit - -
- string - / required -
- 		-
    Choices: -
  • Gbps
    • -
  • Mbps
    • -
- 		-
Specify in which unit the reference bandwidth is specified.
-
-
- bfd - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable BFD on all OSPF interfaces.
-
-
- capability - -
- dictionary -
- 		- -
OSPF capability settings.
-
-
- vrf_lite - -
- dictionary -
- 		- -
Enable VRF-lite capability settings.
-
-
- evpn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ethernet VPN.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable VRF-lite support.
-
-
- default_information - -
- dictionary -
- 		- -
Control distribution of default routes.
-
-
- originate - -
- dictionary -
- 		- -
Distribute a default route.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always advertise a default route.
-
-
- route_map - -
- string -
- 		- -
Policy to control distribution of default routes
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable distribution of default route.
-
-
- default_metric - -
- integer -
- 		- -
Specify default metric for redistributed routes.
-
-
- distance - -
- integer -
- 		- -
Configure the OSPF administrative distance.
-
-
- down_bit_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure a PE router to ignore the DN bit for network summary, external and NSSA external LSA.
-
-
- graceful_restart - -
- dictionary -
- 		- -
Configure graceful restart.
-
-
- grace_period - -
- integer -
- 		- -
Configure maximum interval to restart gracefully.
-
-
- helper_disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable helper mode.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable graceful-restart.
-
-
- log_adjacency_changes - -
- dictionary -
- 		- -
Log changes in adjacency state.
-
-
- detail - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Notify all state changes.
-
-
- log - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/disable logging changes in adjacency state.
-
-
- max_lsa - -
- dictionary -
- 		- -
Feature to limit the number of non-self-originated LSAs.
-
-
- ignore_count - -
- integer -
- 		- -
Set count on how many times adjacencies can be suppressed.
-
-
- ignore_time - -
- integer -
- 		- -
Set time during which all adjacencies are suppressed.
-
-
- max_non_self_generated_lsa - -
- integer - / required -
- 		- -
Set the maximum number of non self-generated LSAs.
-
-
- reset_time - -
- integer -
- 		- -
Set number of minutes after which ignore-count is reset to zero.
-
-
- threshold - -
- integer -
- 		- -
Threshold value (%) at which to generate a warning message.
-
-
- warning_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Log a warning message when limit is exceeded.
-
-
- max_metric - -
- dictionary -
- 		- -
Maximize the cost metric.
-
-
- router_lsa - -
- dictionary -
- 		- -
Router LSA configuration.
-
-
- external_lsa - -
- dictionary -
- 		- -
External LSA configuration.
-
-
- max_metric_value - -
- integer -
- 		- -
Set max metric value for external LSAs.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set external-lsa attribute.
-
-
- include_stub - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise Max metric for Stub links as well.
-
-
- on_startup - -
- dictionary -
- 		- -
Effective only at startup.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set on-startup attribute.
-
-
- wait_for_bgp_asn - -
- integer -
- 		- -
ASN of BGP to wait for.
-
-
- wait_period - -
- integer -
- 		- -
Wait period in seconds after startup.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set router-lsa attribute.
-
-
- summary_lsa - -
- dictionary -
- 		- -
Summary LSAs configuration.
-
-
- max_metric_value - -
- integer -
- 		- -
Max metric value for summary LSAs.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set summary-lsa attribute.
-
-
- maximum_paths - -
- integer -
- 		- -
Maximum paths per destination.
-
-
- name_lookup - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Display OSPF router ids as DNS names.
-
-
- passive_interface - -
- dictionary -
- 		- -
Suppress routing updates on the interface.
-
-
- default - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Interfaces passive by default.
-
-
- redistribute - -
- list - / elements=dictionary -
- 		- -
Redistribute information from another routing protocol.
-
-
- id - -
- string -
- 		- -
The identifier for the protocol specified.
-
-
- protocol - -
- string - / required -
- 		-
    Choices: -
  • bgp
    • -
  • direct
    • -
  • eigrp
    • -
  • isis
    • -
  • lisp
    • -
  • ospf
    • -
  • rip
    • -
  • static
    • -
- 		-
The name of the protocol.
-
-
- route_map - -
- string - / required -
- 		- -
The route map policy to constrain redistribution.
-
-
- rfc1583compatibility - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure 1583 compatibility for external path preferences.
-
-
- router_id - -
- string -
- 		- -
Set OSPF process router-id.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Shutdown the OSPF protocol instance.
-
-
- summary_address - -
- list - / elements=dictionary -
- 		- -
Configure route summarization for redistribution.
-
-
- not_advertise - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress advertising the specified summary.
-
-
- prefix - -
- string - / required -
- 		- -
IP prefix in format x.x.x.x/ml.
-
-
- tag - -
- integer -
- 		- -
A 32-bit tag value.
-
-
- table_map - -
- dictionary -
- 		- -
Policy for filtering/modifying OSPF routes before sending them to RIB.
-
-
- filter - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Block the OSPF routes from being sent to RIB.
-
-
- name - -
- string - / required -
- 		- -
The Route Map name.
-
-
- timers - -
- dictionary -
- 		- -
Configure timer related constants.
-
-
- lsa_arrival - -
- integer -
- 		- -
Mimimum interval between arrival of a LSA.
-
-
- lsa_group_pacing - -
- integer -
- 		- -
LSA group refresh/maxage interval.
-
-
- throttle - -
- dictionary -
- 		- -
Configure throttle related constants.
-
-
- lsa - -
- dictionary -
- 		- -
Set rate-limiting for LSA generation.
-
-
- hold_interval - -
- integer -
- 		- -
The hold interval.
-
-
- max_interval - -
- integer -
- 		- -
The max interval.
-
-
- start_interval - -
- integer -
- 		- -
The start interval.
-
-
- spf - -
- dictionary -
- 		- -
Set OSPF SPF timers.
-
-
- initial_spf_delay - -
- integer -
- 		- -
Initial SPF schedule delay in milliseconds.
-
-
- max_wait_time - -
- integer -
- 		- -
Maximum wait time between SPF calculations.
-
-
- min_hold_time - -
- integer -
- 		- -
Minimum hold time between SPF calculations.
-
-
- vrf - -
- string - / required -
- 		- -
Name/Identifier of the VRF.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section "^router ospf .*".
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • parsed
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 7.0(3)I5(1). - - Unsupported for Cisco MDS - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # nxos-9k-rdo# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_ospfv2: - config: - processes: - - process_id: 100 - router_id: 203.0.113.20 - - process_id: 102 - router_id: 198.51.100.1 - areas: - - area_id: 0.0.0.100 - filter_list: - - route_map: rmap_1 - direction: in - - route_map: rmap_2 - direction: out - ranges: - - prefix: 198.51.100.64/27 - not_advertise: true - - prefix: 198.51.100.96/27 - cost: 120 - - area_id: 0.0.0.101 - authentication: - message_digest: true - redistribute: - - protocol: eigrp - id: 120 - route_map: rmap_1 - - protocol: direct - route_map: ospf102-direct-connect - vrfs: - - vrf: zone1 - router_id: 198.51.100.129 - redistribute: - - protocol: static - route_map: zone1-static-connect - summary_address: - - prefix: 198.51.100.128/27 - tag: 121 - - prefix: 198.51.100.160/27 - areas: - - area_id: 0.0.0.102 - nssa: - default_information_originate: true - no_summary: true - - area_id: 0.0.0.103 - nssa: - no_summary: true - translate: - type7: - always: true - - vrf: zone2 - auto_cost: - reference_bandwidth: 45 - unit: Gbps - state: merged - - # Task output: - # ------------ - # before: {} - # - # commands: - # - router ospf 102 - # - router-id 198.51.100.1 - # - redistribute eigrp 120 route-map rmap_1 - # - redistribute direct route-map ospf102-direct-connect - # - area 0.0.0.100 filter-list route-map rmap_1 in - # - area 0.0.0.100 filter-list route-map rmap_2 out - # - area 0.0.0.100 range 198.51.100.64/27 not-advertise - # - area 0.0.0.100 range 198.51.100.96/27 cost 120 - # - area 0.0.0.101 authentication message-digest - # - vrf zone1 - # - router-id 198.51.100.129 - # - summary-address 198.51.100.128/27 tag 121 - # - summary-address 198.51.100.160/27 - # - redistribute static route-map zone1-static-connect - # - area 0.0.0.102 nssa no-summary default-information-originate - # - area 0.0.0.103 nssa no-summary - # - area 0.0.0.103 nssa translate type7 always - # - vrf zone2 - # - auto-cost reference-bandwidth 45 Gbps - # - router ospf 100 - # - router-id 203.0.113.20 - # - # after: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.100 - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # - cost: 120 - # prefix: 198.51.100.96/27 - # - area_id: 0.0.0.101 - # authentication: - # message_digest: true - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # - area_id: 0.0.0.103 - # nssa: - # no_summary: true - # translate: - # type7: - # always: true - # redistribute: - # - protocol: static - # route_map: zone1-static-connect - # router_id: 198.51.100.129 - # vrf: zone1 - # - auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # vrf: zone2 - # - - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # area 0.0.0.100 range 198.51.100.96/27 cost 120 - # area 0.0.0.101 authentication message-digest - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # area 0.0.0.103 nssa no-summary - # area 0.0.0.103 nssa translate type7 always - # redistribute static route-map zone1-static-connect - # summary-address 198.51.100.128/27 tag 121 - # summary-address 198.51.100.160/27 - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - - # Using replaced - - # Before state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # area 0.0.0.100 range 198.51.100.96/27 cost 120 - # area 0.0.0.101 authentication message-digest - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # area 0.0.0.103 nssa no-summary - # area 0.0.0.103 nssa translate type7 always - # redistribute static route-map zone1-static-connect - # summary-address 198.51.100.128/27 tag 121 - # summary-address 198.51.100.160/27 - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - - - name: >- - Replace device configurations of listed OSPF processes with provided - configurations - cisco.nxos.nxos_ospfv2: - config: - processes: - - process_id: 102 - router_id: 198.51.100.1 - areas: - - area_id: 0.0.0.100 - filter_list: - - route_map: rmap_8 - direction: in - ranges: - - prefix: 198.51.100.64/27 - not_advertise: true - - area_id: 0.0.0.101 - stub: - no_summary: true - redistribute: - - protocol: eigrp - id: 130 - route_map: rmap_1 - - protocol: direct - route_map: ospf102-direct-connect - vrfs: - - vrf: zone1 - router_id: 198.51.100.129 - redistribute: - - protocol: bgp - id: 65563 - route_map: zone1-bgp-connect - areas: - - area_id: 0.0.0.102 - nssa: - default_information_originate: true - no_summary: true - state: replaced - - - # Task output: - # ------------ - # before: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.100 - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # - cost: 120 - # prefix: 198.51.100.96/27 - # - area_id: 0.0.0.101 - # authentication: - # message_digest: true - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # - area_id: 0.0.0.103 - # nssa: - # no_summary: true - # translate: - # type7: - # always: true - # redistribute: - # - protocol: static - # route_map: zone1-static-connect - # router_id: 198.51.100.129 - # vrf: zone1 - # - auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # vrf: zone2 - # - # commands: - # - router ospf 102 - # - redistribute eigrp 130 route-map rmap_1 - # - no redistribute eigrp 120 route-map rmap_1 - # - area 0.0.0.100 filter-list route-map rmap_8 in - # - no area 0.0.0.100 filter-list route-map rmap_2 out - # - no area 0.0.0.100 range 198.51.100.96/27 - # - no area 0.0.0.101 authentication - # - area 0.0.0.101 stub no-summary - # - vrf zone1 - # - no summary-address 198.51.100.128/27 tag 121 - # - no summary-address 198.51.100.160/27 - # - redistribute bgp 65563 route-map zone1-bgp-connect - # - no redistribute static route-map zone1-static-connect - # - no area 0.0.0.103 nssa - # - no area 0.0.0.103 nssa translate type7 always - # - no vrf zone2 - # - # after: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.101 - # stub: - # no_summary: true - # - area_id: 0.0.0.100 - # filter_list: - # - direction: in - # route_map: rmap_8 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "130" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # redistribute: - # - id: "65563" - # protocol: bgp - # route_map: zone1-bgp-connect - # router_id: 198.51.100.129 - # vrf: zone1 - - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # area 0.0.0.101 stub no-summary - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 130 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_8 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # redistribute bgp 65563 route-map zone1-bgp-connect - - # Using overridden - - # Before state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # area 0.0.0.100 range 198.51.100.96/27 cost 120 - # area 0.0.0.101 authentication message-digest - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # area 0.0.0.103 nssa no-summary - # area 0.0.0.103 nssa translate type7 always - # redistribute static route-map zone1-static-connect - # summary-address 198.51.100.128/27 tag 121 - # summary-address 198.51.100.160/27 - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - - - name: Override all OSPF configuration with provided configuration - cisco.nxos.nxos_ospfv2: - config: - processes: - - process_id: 104 - router_id: 203.0.113.20 - - process_id: 102 - router_id: 198.51.100.1 - shutdown: true - state: overridden - - # Task output: - # ------------ - # before: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.100 - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # - cost: 120 - # prefix: 198.51.100.96/27 - # - area_id: 0.0.0.101 - # authentication: - # message_digest: true - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # - area_id: 0.0.0.103 - # nssa: - # no_summary: true - # translate: - # type7: - # always: true - # redistribute: - # - protocol: static - # route_map: zone1-static-connect - # router_id: 198.51.100.129 - # vrf: zone1 - # - auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # vrf: zone2 - # - # commands: - # - no router ospf 100 - # - router ospf 104 - # - router-id 203.0.113.20 - # - router ospf 102 - # - shutdown - # - no redistribute direct route-map ospf102-direct-connect - # - no redistribute eigrp 120 route-map rmap_1 - # - no area 0.0.0.100 filter-list route-map rmap_2 out - # - no area 0.0.0.100 filter-list route-map rmap_1 in - # - no area 0.0.0.100 range 198.51.100.64/27 - # - no area 0.0.0.100 range 198.51.100.96/27 - # - no area 0.0.0.101 authentication - # - no vrf zone1 - # - no vrf zone2 - # - # after: - # processes: - # - process_id: "102" - # router_id: 198.51.100.1 - # shutdown: true - # - process_id: "104" - # router_id: 203.0.113.20 - - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 102 - # router-id 198.51.100.1 - # shutdown - # router ospf 104 - # router-id 203.0.113.20 - - # Using deleted to delete a single OSPF process - - # Before state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # area 0.0.0.100 range 198.51.100.96/27 cost 120 - # area 0.0.0.101 authentication message-digest - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # area 0.0.0.103 nssa no-summary - # area 0.0.0.103 nssa translate type7 always - # redistribute static route-map zone1-static-connect - # summary-address 198.51.100.128/27 tag 121 - # summary-address 198.51.100.160/27 - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - - - name: Delete a single OSPF process - cisco.nxos.nxos_ospfv2: - config: - processes: - - process_id: 102 - state: deleted - - # Task output: - # ------------ - # before: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.100 - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # - cost: 120 - # prefix: 198.51.100.96/27 - # - area_id: 0.0.0.101 - # authentication: - # message_digest: true - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # - area_id: 0.0.0.103 - # nssa: - # no_summary: true - # translate: - # type7: - # always: true - # redistribute: - # - protocol: static - # route_map: zone1-static-connect - # router_id: 198.51.100.129 - # vrf: zone1 - # - auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # vrf: zone2 - # - # commands: - # - no router ospf 102 - # - # after: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - - # Using deleted all OSPF processes from the device - - # Before state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # area 0.0.0.100 range 198.51.100.96/27 cost 120 - # area 0.0.0.101 authentication message-digest - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # area 0.0.0.103 nssa no-summary - # area 0.0.0.103 nssa translate type7 always - # redistribute static route-map zone1-static-connect - # summary-address 198.51.100.128/27 tag 121 - # summary-address 198.51.100.160/27 - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - - - name: Delete all OSPF processes from the device - cisco.nxos.nxos_ospfv2: - state: deleted - - # Task output: - # ------------ - # before: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.100 - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # - cost: 120 - # prefix: 198.51.100.96/27 - # - area_id: 0.0.0.101 - # authentication: - # message_digest: true - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # - area_id: 0.0.0.103 - # nssa: - # no_summary: true - # translate: - # type7: - # always: true - # redistribute: - # - protocol: static - # route_map: zone1-static-connect - # router_id: 198.51.100.129 - # vrf: zone1 - # - auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # vrf: zone2 - # - # commands: - # - no router ospf 100 - # - no router ospf 102 - # - # after: {} - - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # nxos-9k-rdo# - - # Using rendered - - - name: >- - Render platform specific configuration lines (without connecting to the - device) - cisco.nxos.nxos_ospfv2: - config: - processes: - - process_id: 100 - router_id: 203.0.113.20 - - process_id: 102 - router_id: 198.51.100.1 - areas: - - area_id: 0.0.0.100 - filter_list: - - route_map: rmap_1 - direction: in - - route_map: rmap_2 - direction: out - ranges: - - prefix: 198.51.100.64/27 - not_advertise: true - - prefix: 198.51.100.96/27 - cost: 120 - - area_id: 0.0.0.101 - authentication: - message_digest: true - redistribute: - - protocol: eigrp - id: 120 - route_map: rmap_1 - - protocol: direct - route_map: ospf102-direct-connect - vrfs: - - vrf: zone1 - router_id: 198.51.100.129 - redistribute: - - protocol: static - route_map: zone1-static-connect - summary_address: - - prefix: 198.51.100.128/27 - tag: 121 - - prefix: 198.51.100.160/27 - areas: - - area_id: 0.0.0.102 - nssa: - default_information_originate: true - no_summary: true - - area_id: 0.0.0.103 - nssa: - no_summary: true - translate: - type7: - always: true - - vrf: zone2 - auto_cost: - reference_bandwidth: 45 - unit: Gbps - state: rendered - - - # Task output: - # ------------ - # rendered: - # - router ospf 100 - # - router-id 203.0.113.20 - # - router ospf 102 - # - router-id 198.51.100.1 - # - redistribute eigrp 120 route-map rmap_1 - # - redistribute direct route-map ospf102-direct-connect - # - area 0.0.0.100 filter-list route-map rmap_1 in - # - area 0.0.0.100 filter-list route-map rmap_2 out - # - area 0.0.0.100 range 198.51.100.64/27 not-advertise - # - area 0.0.0.100 range 198.51.100.96/27 cost 120 - # - area 0.0.0.101 authentication message-digest - # - vrf zone1 - # - router-id 198.51.100.129 - # - summary-address 198.51.100.128/27 tag 121 - # - summary-address 198.51.100.160/27 - # - redistribute static route-map zone1-static-connect - # - area 0.0.0.102 nssa no-summary default-information-originate - # - area 0.0.0.103 nssa no-summary - # - area 0.0.0.103 nssa translate type7 always - # - vrf zone2 - # - auto-cost reference-bandwidth 45 Gbps - - # Using parsed - - # parsed.cfg - # ------------ - # router ospf 100 - # router-id 192.0.100.1 - # area 0.0.0.101 nssa no-summary no-redistribution - # area 0.0.0.102 stub no-summary - # redistribute direct route-map ospf-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 192.0.2.0/24 not-advertise - # area 0.0.0.100 range 192.0.3.0/24 cost 120 - # area 0.0.0.100 authentication message-digest - # vrf zone1 - # router-id 192.0.100.2 - # area 0.0.100.1 nssa no-summary no-redistribution - # redistribute static route-map zone1-direct-connect - # summary-address 10.0.0.0/24 tag 120 - # summary-address 11.0.0.0/24 not-advertise - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - # down-bit-ignore - # capability vrf-lite evpn - # shutdown - # router ospf 102 - # router-id 198.54.100.1 - # shutdown - # vrf zone2 - # summary-address 192.0.8.0/24 tag 120 - # vrf zone4 - # shutdown - - - name: Parse externally provided OSPFv2 config - cisco.nxos.nxos_ospfv2: - running_config: "{{ lookup('file', 'ospfv2.cfg') }}" - state: parsed - - # Task output: - # ------------ - # parsed: - # processes: - # - process_id: "100" - # areas: - # - area_id: 0.0.0.101 - # nssa: - # no_redistribution: true - # no_summary: true - # - area_id: 0.0.0.102 - # stub: - # no_summary: true - # - area_id: 0.0.0.100 - # authentication: - # message_digest: true - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 192.0.2.0/24 - # - cost: 120 - # prefix: 192.0.3.0/24 - # redistribute: - # - protocol: direct - # route_map: ospf-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 192.0.100.1 - # vrfs: - # - vrf: zone1 - # areas: - # - area_id: 0.0.100.1 - # nssa: - # no_redistribution: true - # no_summary: true - # redistribute: - # - protocol: static - # route_map: zone1-direct-connect - # router_id: 192.0.100.2 - # summary_address: - # - prefix: 10.0.0.0/24 - # tag: 120 - # - not_advertise: true - # prefix: 11.0.0.0/24 - # - vrf: zone2 - # auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # capability: - # vrf_lite: - # evpn: true - # down_bit_ignore: true - # shutdown: true - # - process_id: "102" - # router_id: 198.54.100.1 - # shutdown: true - # vrfs: - # - vrf: zone2 - # summary_address: - # - prefix: 192.0.8.0/24 - # tag: 120 - # - vrf: zone4 - # shutdown: true - - # Using gathered - - - name: Gather OSPFv2 facts using gathered - cisco.nxos.nxos_ospfv2: - state: gathered - - # Task output: - # ------------ - # gathered: - # processes: - # - process_id: "102" - # areas: - # - area_id: 0.0.0.101 - # stub: - # no_summary: true - # - area_id: 0.0.0.100 - # filter_list: - # - direction: in - # route_map: rmap_8 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "130" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - vrf: zone1 - # areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # redistribute: - # - id: "65563" - # protocol: bgp - # route_map: zone1-bgp-connect - # router_id: 198.51.100.129 - # - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['router ospf 102', 'router-id 198.54.100.1', 'router ospf 100', 'router-id 192.0.100.1', 'redistribute eigrp 120 route-map rmap_1', 'redistribute direct route-map ospf-direct-connect', 'area 0.0.0.100 filter-list route-map rmap_1 in', 'area 0.0.0.100 filter-list route-map rmap_2 out', 'area 0.0.0.100 range 192.0.2.0/24 not-advertise', 'area 0.0.0.100 range 192.0.3.0/24 cost 120', 'vrf zone1', 'router-id 192.0.100.2', 'summary-address 10.0.0.0/24 tag 121', 'summary-address 11.0.0.0/24', 'redistribute static route-map zone1-direct-connect', 'vrf zone2', 'auto-cost reference-bandwidth 45 Gbps', 'capability vrf-lite evpn']
-
-
- gathered - -
- dictionary -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- dictionary -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['router ospf 102', 'router-id 198.54.100.1', 'router ospf 100']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_overlay_global_module.rst b/docs/cisco.nxos.nxos_overlay_global_module.rst deleted file mode 100644 index 1a1b8d975..000000000 --- a/docs/cisco.nxos.nxos_overlay_global_module.rst +++ /dev/null @@ -1,120 +0,0 @@ -.. _cisco.nxos.nxos_overlay_global_module: - - -****************************** -cisco.nxos.nxos_overlay_global -****************************** - -**Configures anycast gateway MAC of the switch.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configures anycast gateway MAC of the switch. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- anycast_gateway_mac - -
- string - / required -
- 		- -
Anycast gateway mac of the switch.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Default restores params default value - - Supported MAC address format are "E.E.E", "EE-EE-EE-EE-EE-EE", "EE:EE:EE:EE:EE:EE" and "EEEE.EEEE.EEEE" - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_overlay_global: - anycast_gateway_mac: b.b.b - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['fabric forwarding anycast-gateway-mac 000B.000B.000B']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_pim_module.rst b/docs/cisco.nxos.nxos_pim_module.rst deleted file mode 100644 index e19eee567..000000000 --- a/docs/cisco.nxos.nxos_pim_module.rst +++ /dev/null @@ -1,148 +0,0 @@ -.. _cisco.nxos.nxos_pim_module: - - -******************* -cisco.nxos.nxos_pim -******************* - -**Manages configuration of a PIM instance.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages configuration of a Protocol Independent Multicast (PIM) instance. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- bfd - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Enables BFD on all PIM interfaces.
-
Dependency: ''feature bfd''
-
-
- ssm_range - -
- list - / elements=string -
- 		- Default:
[]
- 		-
Configure group ranges for Source Specific Multicast (SSM). Valid values are multicast addresses or the keyword none or keyword default. none removes all SSM group ranges. 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 default, otherwise use the default option.
-
-
- - -Notes ------ - -.. note:: - - Unsupported for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - 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 Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['ip pim bfd', 'ip pim ssm range 224.0.0.0/8']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_ping_module.rst b/docs/cisco.nxos.nxos_ping_module.rst deleted file mode 100644 index d0d805868..000000000 --- a/docs/cisco.nxos.nxos_ping_module.rst +++ /dev/null @@ -1,311 +0,0 @@ -.. _cisco.nxos.nxos_ping_module: - - -******************** -cisco.nxos.nxos_ping -******************** - -**Tests reachability using ping from Nexus switch.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Tests reachability using ping from switch to a remote destination. -- For a general purpose network module, see the :ref:`ansible.netcommon.net_ping ` module. -- For Windows targets, use the :ref:`ansible.windows.win_ping ` module instead. -- For targets running Python, use the :ref:`ansible.builtin.ping ` module instead. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- count - -
- integer -
- 		- Default:
5
- 		-
Number of packets to send.
-
-
- dest - -
- string - / required -
- 		- -
IP address or hostname (resolvable by switch) of remote node.
-
-
- df_bit - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Set the DF bit.
-
-
- size - -
- integer -
- 		- -
Size of packets to send.
-
-
- source - -
- string -
- 		- -
Source IP Address or hostname (resolvable by switch)
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Determines if the expected result is success or fail.
-
-
- vrf - -
- string -
- 		- -
Outgoing VRF.
-
-
- - -Notes ------ - -.. note:: - - Unsupported for Cisco MDS - - For a general purpose network module, see the :ref:`ansible.netcommon.net_ping ` module. - - For Windows targets, use the :ref:`ansible.windows.win_ping ` module instead. - - For targets running Python, use the :ref:`ansible.builtin.ping ` module instead. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Test reachability to 8.8.8.8 using mgmt vrf - cisco.nxos.nxos_ping: - dest: 8.8.8.8 - vrf: management - host: 68.170.147.165 - - - name: Test reachability to a few different public IPs using mgmt vrf - cisco.nxos.nxos_ping: - dest: "{{ item }}" - vrf: management - host: 68.170.147.165 - with_items: - - 8.8.8.8 - - 4.4.4.4 - - 198.6.1.4 - - - name: Test reachability to 8.8.8.8 using mgmt vrf, size and df-bit - cisco.nxos.nxos_ping: - dest: 8.8.8.8 - df_bit: true - size: 1400 - vrf: management - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
Show the command sent
-
-
Sample:
-
['ping 8.8.8.8 count 2 vrf management']
-
-
- packet_loss - -
- string -
- 		always -
Percentage of packets lost
-
-
Sample:
-
0.00%
-
-
- packets_rx - -
- integer -
- 		always -
Packets successfully received
-
-
Sample:
-
2
-
-
- packets_tx - -
- integer -
- 		always -
Packets successfully transmitted
-
-
Sample:
-
2
-
-
- rtt - -
- dictionary -
- 		always -
Show RTT stats
-
-
Sample:
-
{'avg': 6.264, 'max': 6.564, 'min': 5.978}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_prefix_lists_module.rst b/docs/cisco.nxos.nxos_prefix_lists_module.rst deleted file mode 100644 index 25f343132..000000000 --- a/docs/cisco.nxos.nxos_prefix_lists_module.rst +++ /dev/null @@ -1,1049 +0,0 @@ -.. _cisco.nxos.nxos_prefix_lists_module: - - -**************************** -cisco.nxos.nxos_prefix_lists -**************************** - -**Prefix-Lists resource module.** - - -Version added: 2.4.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages prefix-lists configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of prefix-list configuration.
-
-
- afi - -
- string -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
The Address Family Identifier (AFI) for the prefix-lists.
-
-
- prefix_lists - -
- list - / elements=dictionary -
- 		- -
List of prefix-list configurations.
-
-
- description - -
- string -
- 		- -
Description of the prefix list
-
-
- entries - -
- list - / elements=dictionary -
- 		- -
List of configurations for the specified prefix-list
-
-
- action - -
- string -
- 		-
    Choices: -
  • permit
    • -
  • deny
    • -
- 		-
Prefix-List permit or deny.
-
-
- eq - -
- integer -
- 		- -
Exact prefix length to be matched.
-
-
- ge - -
- integer -
- 		- -
Minimum prefix length to be matched.
-
-
- le - -
- integer -
- 		- -
Maximum prefix length to be matched.
-
-
- mask - -
- string -
- 		- -
Explicit match mask.
-
-
- prefix - -
- string -
- 		- -
IP or IPv6 prefix in A.B.C.D/LEN or A:B::C:D/LEN format.
-
-
- sequence - -
- integer -
- 		- -
Sequence Number.
-
-
- name - -
- string -
- 		- -
Name of the prefix-list.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^ip(.* prefix-list').
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
Refer to examples for more details.
-
With state replaced, for the listed prefix-lists, sequences that are in running-config but not in the task are negated.
-
With state overridden, all prefix-lists that are in running-config but not in the task are negated.
-
Please refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - Unsupported for Cisco MDS - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # nxos-9k-rdo# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_prefix_lists: - config: - - afi: ipv4 - prefix_lists: - - name: AllowPrefix - description: allows engineering IPv4 networks - entries: - - sequence: 10 - action: permit - prefix: 192.0.2.0/23 - eq: 24 - - sequence: 20 - action: permit - prefix: 198.51.100.128/26 - - name: DenyPrefix - description: denies lab IPv4 networks - entries: - - sequence: 20 - action: deny - prefix: 203.0.113.0/24 - le: 25 - - - afi: ipv6 - prefix_lists: - - name: AllowIPv6Prefix - description: allows engineering IPv6 networks - entries: - - sequence: 8 - action: permit - prefix: "2001:db8:400::/38" - - sequence: 20 - action: permit - prefix: "2001:db8:8000::/35" - le: 37 - - # Task output - # ------------- - # before: [] - # - # commands: - # - "ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks" - # - "ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38" - # - "ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37" - # - "ip prefix-list AllowPrefix description allows engineering IPv4 networks" - # - "ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" - # - "ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" - # - "ip prefix-list DenyPrefix description denies lab IPv4 networks" - # - "ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25" - # - # after: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - # Using replaced - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Replace prefix-lists configurations of listed prefix-lists with provided configurations - cisco.nxos.nxos_prefix_lists: - config: - - afi: ipv4 - prefix_lists: - - name: AllowPrefix - description: allows engineering IPv4 networks - entries: - - sequence: 10 - action: permit - prefix: 203.0.113.64/27 - - - sequence: 30 - action: permit - prefix: 203.0.113.96/27 - - name: AllowPrefix2Stub - description: allow other engineering IPv4 network - state: replaced - - # Task output - # ------------- - # before: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # commands: - # - "no ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" - # - "ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27" - # - "ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27" - # - "no ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" - # - "ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network" - # - # after: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 203.0.113.64/27 - # - sequence: 30 - # action: permit - # prefix: 203.0.113.96/27 - # name: AllowPrefix - # - description: allow other engineering IPv4 network - # name: AllowPrefix2Stub - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27 - # ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27 - # ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - # Using overridden - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Override all prefix-lists configuration with provided configuration - cisco.nxos.nxos_prefix_lists: &id003 - config: - - afi: ipv4 - prefix_lists: - - name: AllowPrefix - description: allows engineering IPv4 networks - entries: - - sequence: 10 - action: permit - prefix: 203.0.113.64/27 - - - sequence: 30 - action: permit - prefix: 203.0.113.96/27 - - name: AllowPrefix2Stub - description: allow other engineering IPv4 network - state: overridden - - # Task output - # ------------- - # before: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # commands: - # - "no ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" - # - "ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27" - # - "ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27" - # - "no ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" - # - "ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network" - # - "no ip prefix-list DenyPrefix" - # - "no ipv6 prefix-list AllowIPv6Prefix" - # - # after: - # - afi: ipv4 - # prefix_lists: - # - name: AllowPrefix - # description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 203.0.113.64/27 - # - # - sequence: 30 - # action: permit - # prefix: 203.0.113.96/27 - # - name: AllowPrefix2Stub - # description: allow other engineering IPv4 network - # - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27 - # ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27 - # ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network - - # Using deleted to delete a all prefix lists for an AFI - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Delete all prefix-lists for an AFI - cisco.nxos.nxos_prefix_lists: - config: - - afi: ipv4 - state: deleted - register: result - - # Task output - # ------------- - # before: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # commands: - # - "no ip prefix-list AllowPrefix" - # - "no ip prefix-list DenyPrefix" - # - # after: - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - # Using deleted to delete a single prefix-list - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Delete a single prefix-list - cisco.nxos.nxos_prefix_lists: - config: - - afi: ipv4 - prefix_lists: - - name: AllowPrefix - state: deleted - - # Task output - # ------------- - # before: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # commands: - # - "no ip prefix-list AllowPrefix" - # - # after: - # - afi: ipv4 - # prefix_lists: - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - # Using deleted to delete all prefix-lists from the device - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Delete all prefix-lists - cisco.nxos.nxos_prefix_lists: - state: deleted - - # Task output - # ------------- - # before: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # commands: - # - "no ip prefix-list AllowPrefix" - # - "no ip prefix-list DenyPrefix" - # - "no ipv6 prefix-list AllowIPv6Prefix" - # - # after: [] - # - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # nxos-9k-rdo# - - # Using rendered - - - name: Render platform specific configuration lines with state rendered (without connecting to the device) - cisco.nxos.nxos_prefix_lists: &id001 - config: - - afi: ipv4 - prefix_lists: - - name: AllowPrefix - description: allows engineering IPv4 networks - entries: - - sequence: 10 - action: permit - prefix: 192.0.2.0/23 - eq: 24 - - sequence: 20 - action: permit - prefix: 198.51.100.128/26 - - name: DenyPrefix - description: denies lab IPv4 networks - entries: - - sequence: 20 - action: deny - prefix: 203.0.113.0/24 - le: 25 - - - afi: ipv6 - prefix_lists: - - name: AllowIPv6Prefix - description: allows engineering IPv6 networks - entries: - - sequence: 8 - action: permit - prefix: "2001:db8:400::/38" - - sequence: 20 - action: permit - prefix: "2001:db8:8000::/35" - le: 37 - state: rendered - - # Task Output (redacted) - # ----------------------- - # rendered: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - - # Using parsed - - # parsed.cfg - # ------------ - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Parse externally provided prefix-lists configuration - register: result - cisco.nxos.nxos_prefix_lists: - running_config: "{{ lookup('file', './parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - - - - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_reboot_module.rst b/docs/cisco.nxos.nxos_reboot_module.rst deleted file mode 100644 index cc94a6762..000000000 --- a/docs/cisco.nxos.nxos_reboot_module.rst +++ /dev/null @@ -1,123 +0,0 @@ -.. _cisco.nxos.nxos_reboot_module: - - -********************** -cisco.nxos.nxos_reboot -********************** - -**Reboot a network device.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Reboot a network device. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- confirm - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Safeguard boolean. Set to true if you're sure you want to reboot.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Tested against Cisco MDS NX-OS 9.2(1) - - The module will fail due to timeout issues, but the reboot will be performed anyway. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_reboot: - confirm: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- rebooted - -
- boolean -
- 		success -
Whether the device was instructed to reboot.
-
-
Sample:
-
True
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_rollback_module.rst b/docs/cisco.nxos.nxos_rollback_module.rst deleted file mode 100644 index c948e093a..000000000 --- a/docs/cisco.nxos.nxos_rollback_module.rst +++ /dev/null @@ -1,159 +0,0 @@ -.. _cisco.nxos.nxos_rollback_module: - - -************************ -cisco.nxos.nxos_rollback -************************ - -**Set a checkpoint or rollback to a checkpoint.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module offers the ability to set a configuration checkpoint file or rollback to a configuration checkpoint file on Cisco NXOS switches. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- checkpoint_file - -
- string -
- 		- -
Name of checkpoint file to create. Mutually exclusive with rollback_to.
-
-
- rollback_to - -
- string -
- 		- -
Name of checkpoint file to rollback to. Mutually exclusive with checkpoint_file.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Sometimes ``transport=nxapi`` may cause a timeout error. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_rollback: - checkpoint_file: backup.cfg - username: '{{ un }}' - password: '{{ pwd }}' - host: '{{ inventory_hostname }}' - - cisco.nxos.nxos_rollback: - rollback_to: backup.cfg - username: '{{ un }}' - password: '{{ pwd }}' - host: '{{ inventory_hostname }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- filename - -
- string -
- 		success -
The filename of the checkpoint/rollback file.
-
-
Sample:
-
backup.cfg
-
-
- status - -
- string -
- 		success -
Which operation took place and whether it was successful.
-
-
Sample:
-
rollback executed
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_route_maps_module.rst b/docs/cisco.nxos.nxos_route_maps_module.rst deleted file mode 100644 index bcdf6a426..000000000 --- a/docs/cisco.nxos.nxos_route_maps_module.rst +++ /dev/null @@ -1,4368 +0,0 @@ -.. _cisco.nxos.nxos_route_maps_module: - - -************************** -cisco.nxos.nxos_route_maps -************************** - -**Route Maps resource module.** - - -Version added: 2.2.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages route maps configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of route-map configuration.
-
-
- entries - -
- list - / elements=dictionary -
- 		- -
List of entries (identified by sequence number) for this route-map.
-
-
- action - -
- string -
- 		-
    Choices: -
  • deny
    • -
  • permit
    • -
- 		-
Route map denies or permits set operations.
-
-
- continue_sequence - -
- integer -
- 		- -
Continue on a different entry within the route-map.
-
-
- description - -
- string -
- 		- -
Description of the route-map.
-
-
- match - -
- dictionary -
- 		- -
Match values from routing table.
-
-
- as_number - -
- dictionary -
- 		- -
Match BGP peer AS number.
-
-
- as_path_list - -
- list - / elements=string -
- 		- -
AS path access list name.
-
-
- asn - -
- list - / elements=string -
- 		- -
AS number.
-
-
- as_path - -
- list - / elements=string -
- 		- -
Match BGP AS path access-list.
-
-
- community - -
- dictionary -
- 		- -
Match BGP community list.
-
-
- community_list - -
- list - / elements=string -
- 		- -
Community list.
-
-
- exact_match - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do exact matching of communities.
-
-
- evpn - -
- dictionary -
- 		- -
Match BGP EVPN Routes.
-
-
- route_types - -
- list - / elements=string -
- 		- -
Match route type for evpn route.
-
-
- extcommunity - -
- dictionary -
- 		- -
Match BGP community list.
-
-
- exact_match - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do exact matching of extended communities.
-
-
- extcommunity_list - -
- list - / elements=string -
- 		- -
Extended Community list.
-
-
- interfaces - -
- list - / elements=string -
- 		- -
Match first hop interface of route.
-
-
- ip - -
- dictionary -
- 		- -
Configure IP specific information.
-
-
- address - -
- dictionary -
- 		- -
Match address of route or match packet.
-
-
- access_list - -
- string -
- 		- -
IP access-list name (for use in route-maps for PBR only).
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- multicast - -
- dictionary -
- 		- -
Match multicast attributes.
-
-
- group - -
- dictionary -
- 		- -
Multicast Group prefix.
-
Mutually exclusive with group_range.
-
-
- prefix - -
- string -
- 		- -
IPv4 group prefix.
-
-
- group_range - -
- dictionary -
- 		- -
Multicast Group address range.
-
Mutually exclusive with group.
-
-
- first - -
- string -
- 		- -
First Group address.
-
-
- last - -
- string -
- 		- -
Last Group address.
-
-
- rp - -
- dictionary -
- 		- -
Rendezvous point.
-
-
- prefix - -
- string -
- 		- -
IPv4 rendezvous prefix.
-
-
- rp_type - -
- string -
- 		-
    Choices: -
  • ASM
    • -
  • Bidir
    • -
- 		-
Multicast rendezvous point type.
-
-
- source - -
- string -
- 		- -
Multicast source address.
-
-
- next_hop - -
- dictionary -
- 		- -
Match next-hop address of route.
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- route_source - -
- dictionary -
- 		- -
Match advertising source address of route.
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- ipv6 - -
- dictionary -
- 		- -
Configure IPv6 specific information.
-
-
- address - -
- dictionary -
- 		- -
Match address of route or match packet.
-
-
- access_list - -
- string -
- 		- -
IP access-list name (for use in route-maps for PBR only).
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- multicast - -
- dictionary -
- 		- -
Match multicast attributes.
-
-
- group - -
- dictionary -
- 		- -
Multicast Group prefix.
-
Mutually exclusive with group_range.
-
-
- prefix - -
- string -
- 		- -
IPv4 group prefix.
-
-
- group_range - -
- dictionary -
- 		- -
Multicast Group address range.
-
Mutually exclusive with group.
-
-
- first - -
- string -
- 		- -
First Group address.
-
-
- last - -
- string -
- 		- -
Last Group address.
-
-
- rp - -
- dictionary -
- 		- -
Rendezvous point.
-
-
- prefix - -
- string -
- 		- -
IPv4 rendezvous prefix.
-
-
- rp_type - -
- string -
- 		-
    Choices: -
  • ASM
    • -
  • Bidir
    • -
- 		-
Multicast rendezvous point type.
-
-
- source - -
- string -
- 		- -
Multicast source address.
-
-
- next_hop - -
- dictionary -
- 		- -
Match next-hop address of route.
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- route_source - -
- dictionary -
- 		- -
Match advertising source address of route.
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- mac_list - -
- list - / elements=string -
- 		- -
Match entries of mac-lists.
-
-
- metric - -
- list - / elements=integer -
- 		- -
Match metric of route.
-
-
- ospf_area - -
- list - / elements=integer -
- 		- -
Match ospf area.
-
-
- route_types - -
- list - / elements=string -
- 		-
    Choices: -
  • external
    • -
  • inter-area
    • -
  • internal
    • -
  • intra-area
    • -
  • level-1
    • -
  • level-2
    • -
  • local
    • -
  • nssa-external
    • -
  • type-1
    • -
  • type-2
    • -
- 		-
Match route-type of route.
-
-
- source_protocol - -
- list - / elements=string -
- 		- -
Match source protocol.
-
-
- tags - -
- list - / elements=integer -
- 		- -
Match tag of route.
-
-
- sequence - -
- integer -
- 		- -
Sequence to insert to/delete from existing route-map entry.
-
-
- set - -
- dictionary -
- 		- -
Set values in destination routing protocol.
-
-
- as_path - -
- dictionary -
- 		- -
Prepend string for a BGP AS-path attribute.
-
-
- prepend - -
- dictionary -
- 		- -
Prepend to the AS-Path.
-
-
- as_number - -
- list - / elements=string -
- 		- -
AS number.
-
-
- last_as - -
- integer -
- 		- -
Number of last-AS prepends.
-
-
- tag - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set the tag as an AS-path attribute.
-
-
- comm_list - -
- string -
- 		- -
Set BGP community list (for deletion).
-
-
- community - -
- dictionary -
- 		- -
Set BGP community attribute.
-
-
- additive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Add to existing community.
-
-
- graceful_shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Graceful Shutdown (well-known community).
-
-
- internet - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Internet (well-known community).
-
-
- local_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send outside local AS (well-known community).
-
-
- no_advertise - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not advertise to any peer (well-known community).
-
-
- no_export - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not export to next AS (well-known community).
-
-
- number - -
- list - / elements=string -
- 		- -
Community number aa:nn format
-
-
- dampening - -
- dictionary -
- 		- -
Set BGP route flap dampening parameters.
-
-
- half_life - -
- integer -
- 		- -
Half-life time for the penalty.
-
-
- max_suppress_time - -
- integer -
- 		- -
Maximum suppress time for stable route.
-
-
- start_reuse_route - -
- integer -
- 		- -
Value to start reusing a route.
-
-
- start_suppress_route - -
- integer -
- 		- -
Value to start suppressing a route.
-
-
- distance - -
- dictionary -
- 		- -
Configure administrative distance.
-
-
- igp_ebgp_routes - -
- integer -
- 		- -
Administrative distance for IGP or EBGP routes
-
-
- internal_routes - -
- integer -
- 		- -
Distance for internal routes.
-
-
- local_routes - -
- integer -
- 		- -
Distance for local routes.
-
-
- evpn - -
- dictionary -
- 		- -
Set BGP EVPN Routes.
-
-
- gateway_ip - -
- dictionary -
- 		- -
Set gateway IP for type 5 EVPN routes.
-
Cannot set ip and use-nexthop in the same route-map sequence.
-
-
- ip - -
- string -
- 		- -
Gateway IP address.
-
-
- use_nexthop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use nexthop address as gateway IP.
-
-
- extcomm_list - -
- string -
- 		- -
Set BGP extcommunity list (for deletion).
-
-
- extcommunity - -
- dictionary -
- 		- -
Set BGP extcommunity attribute.
-
-
- rt - -
- dictionary -
- 		- -
Route-Target.
-
-
- additive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Add to existing rt extcommunity.
-
-
- extcommunity_numbers - -
- list - / elements=string -
- 		- -
Extcommunity number.
-
Supported formats are ASN2:NN, ASN4:NN, IPV4:NN.
-
-
- forwarding_address - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set the forwarding address.
-
-
- ip - -
- dictionary -
- 		- -
Configure IP features.
-
-
- address - -
- dictionary -
- 		- -
Specify IP address.
-
-
- prefix_list - -
- string -
- 		- -
Name of prefix list (Max Size 63).
-
-
- next_hop - -
- dictionary -
- 		- -
Set next-hop IP address (for policy-based routing)
-
-
- address - -
- string -
- 		- -
Set space-separated list of next-hop IP addresses. Address ordering is important. Also don`t use unnecessary spaces.
-
-
- drop_on_fail - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Drop packets instead of using default routing when the configured next hop becomes unreachable
-
-
- force_order - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Enable next-hop ordering as specified in the address parameter.
-
-
- load_share - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Enable traffic load balancing across a maximum of 32 next-hop addresses
-
-
- peer_address - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
BGP prefix next hop is set to the local address of the peer.
-
If no next hop is set in the route map, the next hop is set to the one stored in the path.
-
-
- redist_unchanged - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set for next-hop address conservation for non-local generated routes.
-
Used with redistribute command. Available to maintain BGP routing compliant with RFC 4271 on Nexus OS.
-
-
- unchanged - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set for next-hop address conservation in eBGP outgoing updates
-
-
- verify_availability - -
- list - / elements=dictionary -
- 		- -
Set next-hop ip address tracking with IP SLA
-
-
- address - -
- string - / required -
- 		- -
Set one next-hop address
-
-
- drop_on_fail - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Drop packets instead of using default routing when the configured next hop becomes unreachable
-
-
- force_order - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Enable next-hop ordering as specified in the address parameter.
-
-
- load_share - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Enable traffic load balancing across a maximum of 32 next-hop addresses
-
-
- track - -
- integer - / required -
- 		- -
Set track number
-
-
- precedence - -
- string -
- 		- -
Set precedence field.
-
-
- ipv6 - -
- dictionary -
- 		- -
Configure IPv6 features.
-
-
- address - -
- dictionary -
- 		- -
Specify IP address.
-
-
- prefix_list - -
- string -
- 		- -
Name of prefix list (Max Size 63).
-
-
- precedence - -
- string -
- 		- -
Set precedence field.
-
-
- label_index - -
- integer -
- 		- -
Set Segment Routing (SR) label index of route.
-
-
- level - -
- string -
- 		-
    Choices: -
  • level-1
    • -
  • level-1-2
    • -
  • level-2
    • -
- 		-
Where to import route.
-
-
- local_preference - -
- integer -
- 		- -
BGP local preference path attribute.
-
-
- metric - -
- dictionary -
- 		- -
Set metric for destination routing protocol.
-
-
- bandwidth - -
- integer -
- 		- -
Metric value or Bandwidth in Kbits per second (Max Size 11).
-
-
- igrp_delay_metric - -
- integer -
- 		- -
IGRP delay metric.
-
-
- igrp_effective_bandwidth_metric - -
- integer -
- 		- -
IGRP Effective bandwidth metric (Loading) 255 is 100%.
-
-
- igrp_mtu - -
- integer -
- 		- -
IGRP MTU of the path.
-
-
- igrp_reliability_metric - -
- integer -
- 		- -
IGRP reliability metric where 255 is 100 percent reliable.
-
-
- metric_type - -
- string -
- 		-
    Choices: -
  • external
    • -
  • internal
    • -
  • type-1
    • -
  • type-2
    • -
- 		-
Type of metric for destination routing protocol.
-
-
- nssa_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
OSPF NSSA Areas.
-
-
- null_interface - -
- string -
- 		- -
Output Null interface.
-
-
- origin - -
- string -
- 		-
    Choices: -
  • egp
    • -
  • igp
    • -
  • incomplete
    • -
- 		-
BGP origin code.
-
-
- path_selection - -
- string -
- 		-
    Choices: -
  • all
    • -
  • backup
    • -
  • best2
    • -
  • multipaths
    • -
- 		-
Path selection criteria for BGP.
-
-
- tag - -
- integer -
- 		- -
Tag value for destination routing protocol.
-
-
- weight - -
- integer -
- 		- -
BGP weight for routing table.
-
-
- route_map - -
- string -
- 		- -
Route-map name.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^route-map'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
With state replaced, for the listed route-maps, sequences that are in running-config but not in the task are negated.
-
With state overridden, all route-maps that are in running-config but not in the task are negated.
-
Please refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - Unsupported for Cisco MDS - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k-rdo# show running-config | section "^route-map" - # nxos-9k-rdo# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_route_maps: - config: - - route_map: rmap1 - entries: - - sequence: 10 - action: permit - description: rmap1-10-permit - match: - ip: - address: - access_list: acl_1 - as_path: Allow40 - as_number: - asn: 65564 - - - sequence: 20 - action: deny - description: rmap1-20-deny - match: - community: - community_list: - - BGPCommunity1 - - BGPCommunity2 - ip: - address: - prefix_lists: - - AllowPrefix1 - - AllowPrefix2 - set: - dampening: - half_life: 30 - start_reuse_route: 1500 - start_suppress_route: 10000 - max_suppress_time: 120 - - - route_map: rmap2 - entries: - - sequence: 20 - action: permit - description: rmap2-20-permit - continue_sequence: 40 - match: - ipv6: - address: - prefix_lists: AllowIPv6Prefix - interfaces: "{{ nxos_int1 }}" - set: - as_path: - prepend: - as_number: - - 65563 - - 65568 - - 65569 - comm_list: BGPCommunity - - - sequence: 40 - action: deny - description: rmap2-40-deny - match: - route_types: - - level-1 - - level-2 - tags: 2 - ip: - multicast: - rp: - prefix: 192.0.2.0/24 - rp_type: ASM - source: 203.0.113.0/24 - group_range: - first: 239.0.0.1 - last: 239.255.255.255 - - - route_map: rmap3 - entries: - - sequence: 10 - description: "*** first stanza ***" - action: permit - set: - ip: - next_hop: - verify_availability: - - address: 3.3.3.3 - track: 1 - - address: 4.4.4.4 - track: 3 - - - sequence: 20 - description: "*** second stanza ***" - action: permit - set: - ip: - next_hop: - address: 6.6.6.6 2.2.2.2 - load_share: true - drop_on_fail: true - - - sequence: 30 - description: "*** third stanza ***" - action: permit - set: - ip: - next_hop: - peer_address: true - - - sequence: 40 - description: "*** fourth stanza ***" - action: permit - set: - ip: - next_hop: - unchanged: true - redist_unchanged: true - state: merged - - # Task output - # ------------- - # before: [] - # - # commands: - # - "route-map rmap1 permit 10" - # - "match as-number 65564" - # - "match as-path Allow40" - # - "match ip address acl_1" - # - "description rmap1-10-permit" - # - "route-map rmap1 deny 20" - # - "match community BGPCommunity1 BGPCommunity2" - # - "match ip address prefix-list AllowPrefix1 AllowPrefix2" - # - "description rmap1-20-deny" - # - "set dampening 30 1500 10000 120" - # - "route-map rmap2 permit 20" - # - "match interface Ethernet1/1" - # - "match ipv6 address prefix-list AllowIPv6Prefix" - # - "set as-path prepend 65563 65568 65569" - # - "description rmap2-20-permit" - # - "continue 40" - # - "set comm-list BGPCommunity delete" - # - "route-map rmap2 deny 40" - # - "match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM" - # - "match route-type level-1 level-2" - # - "match tag 2" - # - "description rmap2-40-deny" - # - "route-map rmap3 permit 10" - # - "description *** first stanza ***" - # - "set ip next-hop verify-availability 3.3.3.3 track 1" - # - "set ip next-hop verify-availability 4.4.4.4 track 3" - # - "route-map rmap3 permit 20" - # - "description *** second stanza ***" - # - "set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail" - # - "route-map rmap3 permit 30" - # - "description *** third stanza ***" - # - "set ip next-hop peer-address" - # - "route-map rmap3 permit 40" - # - "description *** fourth stanza ***" - # - "set ip next-hop unchanged" - # - "set ip next-hop redist-unchanged" - # - # after: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # - route_map: rmap3 - # entries: - # - sequence: 10 - # description: "*** first stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # verify_availability: - # - address: 3.3.3.3 - # track: 1 - # - address: 4.4.4.4 - # track: 3 - # - # - sequence: 20 - # description: "*** second stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # address: 6.6.6.6 2.2.2.2 - # load_share: true - # drop_on_fail: true - # - # - sequence: 30 - # description: "*** third stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # peer_address: true - # - # - sequence: 40 - # description: "*** fourth stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # unchanged: true - # redist_unchanged: true - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - # route-map rmap3 permit 10 - # description *** first stanza *** - # set ip next-hop verify-availability 3.3.3.3 track 1 - # set ip next-hop verify-availability 4.4.4.4 track 3 - # route-map rmap3 permit 20 - # description *** second stanza *** - # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail - # route-map rmap3 permit 30 - # description *** third stanza *** - # set ip next-hop peer-address - # route-map rmap3 permit 40 - # description *** fourth stanza *** - # set ip next-hop unchanged - # set ip next-hop redist-unchanged - # - # Using replaced - # (for the listed route-map(s), sequences that are in running-config but not in the task are negated) - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - # route-map rmap3 permit 10 - # description *** first stanza *** - # set ip next-hop verify-availability 3.3.3.3 track 1 - # set ip next-hop verify-availability 4.4.4.4 track 3 - # route-map rmap3 permit 20 - # description *** second stanza *** - # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail - # route-map rmap3 permit 30 - # description *** third stanza *** - # set ip next-hop peer-address - # route-map rmap3 permit 40 - # description *** fourth stanza *** - # set ip next-hop unchanged - # set ip next-hop redist-unchanged - # - - name: Replace route-maps configurations of listed route-maps with provided configurations - cisco.nxos.nxos_route_maps: - config: - - route_map: rmap1 - entries: - - sequence: 20 - action: deny - description: rmap1-20-deny - match: - community: - community_list: - - BGPCommunity4 - - BGPCommunity5 - ip: - address: - prefix_lists: - - AllowPrefix1 - set: - community: - local_as: true - - - route_map: rmap3 - entries: - - sequence: 10 - description: "*** first stanza ***" - action: permit - set: - ip: - next_hop: - verify_availability: - - address: 3.3.3.3 - track: 1 - - sequence: 20 - description: "*** second stanza ***" - action: permit - set: - ip: - next_hop: - peer_address: true - - sequence: 30 - description: "*** third stanza ***" - action: permit - set: - ip: - next_hop: - address: 6.6.6.6 2.2.2.2 - load_share: true - drop_on_fail: true - state: replaced - - # Task output - # ------------- - # before: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # - route_map: rmap3 - # entries: - # - sequence: 10 - # description: "*** first stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # verify_availability: - # - address: 3.3.3.3 - # track: 1 - # - address: 4.4.4.4 - # track: 3 - # - # - sequence: 20 - # description: "*** second stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # address: 6.6.6.6 2.2.2.2 - # load_share: true - # drop_on_fail: true - # - # - sequence: 30 - # description: "*** third stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # peer_address: true - # - # - sequence: 40 - # description: "*** fourth stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # unchanged: true - # redist_unchanged: true - # - # commands: - # - no route-map rmap1 permit 10 - # - route-map rmap1 deny 20 - # - no match community BGPCommunity1 BGPCommunity2 - # - match community BGPCommunity4 BGPCommunity5 - # - no match ip address prefix-list AllowPrefix1 AllowPrefix2 - # - match ip address prefix-list AllowPrefix1 - # - no set dampening 30 1500 10000 120 - # - set community local-AS - # - route-map rmap3 permit 10 - # - no set ip next-hop verify-availability 4.4.4.4 track 3 - # - route-map rmap3 permit 20 - # - no set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail - # - set ip next-hop peer-address - # - route-map rmap3 permit 30 - # - no set ip next-hop peer-address - # - set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail - # - no route-map rmap3 permit 40 - # - # after: - # - route_map: rmap1 - # entries: - # - sequence: 20 - # action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity4 - # - BGPCommunity5 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # set: - # community: - # local_as: true - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # - route_map: rmap3 - # entries: - # - sequence: 10 - # description: "*** first stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # verify_availability: - # - address: 3.3.3.3 - # track: 1 - # - sequence: 20 - # description: "*** second stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # peer_address: true - # - sequence: 30 - # description: "*** third stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # address: 6.6.6.6 2.2.2.2 - # load_share: true - # drop_on_fail: true - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 deny 20 - # description rmap1-20-deny - # match community BGPCommunity4 BGPCommunity5 - # match ip address prefix-list AllowPrefix1 - # set community local-AS - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - # route-map rmap3 permit 10 - # description *** first stanza *** - # set ip next-hop verify-availability 3.3.3.3 track 1 - # route-map rmap3 permit 20 - # description *** second stanza *** - # set ip next-hop peer-address - # route-map rmap3 permit 30 - # description *** third stanza *** - # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail - - # Using overridden - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - - - name: Override all route-maps configuration with provided configuration - cisco.nxos.nxos_route_maps: - config: - - route_map: rmap1 - entries: - - sequence: 20 - action: deny - description: rmap1-20-deny - match: - community: - community_list: - - BGPCommunity4 - - BGPCommunity5 - ip: - address: - prefix_lists: - - AllowPrefix1 - set: - community: - local_as: true - state: overridden - - # Task output - # ------------- - # before: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # commands: - # - no route-map rmap1 permit 10 - # - route-map rmap1 deny 20 - # - no match community BGPCommunity1 BGPCommunity2 - # - match community BGPCommunity4 BGPCommunity5 - # - no match ip address prefix-list AllowPrefix1 AllowPrefix2 - # - match ip address prefix-list AllowPrefix1 - # - no set dampening 30 1500 10000 120 - # - set community local-AS - # - no route-map rmap2 permit 20 - # - no route-map rmap2 deny 40 - # - # after: - # - route_map: rmap1 - # entries: - # - sequence: 20 - # action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity4 - # - BGPCommunity5 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # set: - # community: - # local_as: true - # - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^route-map" - # route-map rmap1 deny 20 - # description rmap1-20-deny - # match community BGPCommunity4 BGPCommunity5 - # match ip address prefix-list AllowPrefix1 - # set community local-AS - - # Using deleted to delete a single route-map - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - - - name: Delete single route-map - cisco.nxos.nxos_route_maps: - config: - - route_map: rmap1 - state: deleted - - # Task output - # ------------- - # before: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # commands: - # - no route-map rmap1 permit 10 - # - no route-map rmap1 deny 20 - # - # after: - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^route-map" - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - - # Using deleted to delete all route-maps from the device running-config - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - - - name: Delete all route-maps - cisco.nxos.nxos_route_maps: - state: deleted - - # Task output - # ------------- - # before: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # commands: - # - no route-map rmap1 permit 10 - # - no route-map rmap1 deny 20 - # - no route-map rmap2 permit 20 - # - no route-map rmap2 deny 40 - # - # after: [] - # - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^route-map" - - - name: Render platform specific configuration lines with state rendered (without connecting to the device) - cisco.nxos.nxos_route_maps: - config: - - route_map: rmap1 - entries: - - sequence: 10 - action: permit - description: rmap1-10-permit - match: - ip: - address: - access_list: acl_1 - as_path: Allow40 - as_number: - asn: 65564 - - - sequence: 20 - action: deny - description: rmap1-20-deny - match: - community: - community_list: - - BGPCommunity1 - - BGPCommunity2 - ip: - address: - prefix_lists: - - AllowPrefix1 - - AllowPrefix2 - set: - dampening: - half_life: 30 - start_reuse_route: 1500 - start_suppress_route: 10000 - max_suppress_time: 120 - - - route_map: rmap2 - entries: - - sequence: 20 - action: permit - description: rmap2-20-permit - continue_sequence: 40 - match: - ipv6: - address: - prefix_lists: AllowIPv6Prefix - interfaces: "{{ nxos_int1 }}" - set: - as_path: - prepend: - as_number: - - 65563 - - 65568 - - 65569 - comm_list: BGPCommunity - - - sequence: 40 - action: deny - description: rmap2-40-deny - match: - route_types: - - level-1 - - level-2 - tags: 2 - ip: - multicast: - rp: - prefix: 192.0.2.0/24 - rp_type: ASM - source: 203.0.113.0/24 - group_range: - first: 239.0.0.1 - last: 239.255.255.255 - state: rendered - - # Task Output (redacted) - # ----------------------- - # rendered: - # - "route-map rmap1 permit 10" - # - "match as-number 65564" - # - "match as-path Allow40" - # - "match ip address acl_1" - # - "description rmap1-10-permit" - # - "route-map rmap1 deny 20" - # - "match community BGPCommunity1 BGPCommunity2" - # - "match ip address prefix-list AllowPrefix1 AllowPrefix2" - # - "description rmap1-20-deny" - # - "set dampening 30 1500 10000 120" - # - "route-map rmap2 permit 20" - # - "match interface Ethernet1/1" - # - "match ipv6 address prefix-list AllowIPv6Prefix" - # - "set as-path prepend 65563 65568 65569" - # - "description rmap2-20-permit" - # - "continue 40" - # - "set comm-list BGPCommunity delete" - # - "route-map rmap2 deny 40" - # - "match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM" - # - "match route-type level-1 level-2" - # - "match tag 2" - # - "description rmap2-40-deny" - - # Using parsed - - # parsed.cfg - # ------------ - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - - - name: Parse externally provided route-maps configuration - cisco.nxos.nxos_route_maps: - running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - - # Using gathered - - # Existing route-map config - # --------------------------- - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - - - name: Gather route-maps facts using gathered - cisco.nxos.nxos_route_maps: - state: gathered - - # gathered: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['route-map rmap1 permit 10', 'match as-number 65564', 'match as-path Allow40', 'match ip address acl_1', 'description rmap1-10-permit', 'route-map rmap1 deny 20', 'match community BGPCommunity1 BGPCommunity2']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_rpm_module.rst b/docs/cisco.nxos.nxos_rpm_module.rst deleted file mode 100644 index 79d616a59..000000000 --- a/docs/cisco.nxos.nxos_rpm_module.rst +++ /dev/null @@ -1,226 +0,0 @@ -.. _cisco.nxos.nxos_rpm_module: - - -******************* -cisco.nxos.nxos_rpm -******************* - -**Install patch or feature rpms on Cisco NX-OS devices.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Install software maintenance upgrade (smu) RPMS and 3rd party RPMS on Cisco NX-OS devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
List of RPM/patch definitions.
-
-
- file_system - -
- string -
- 		- -
The remote file system of the device. If omitted, devices that support a file_system parameter will use their default values.
-
-
- pkg - -
- string - / required -
- 		- -
Name of the RPM package.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
- 		-
If the state is present, the rpm will be installed, If the state is absent, it will be removed.
-
-
- file_system - -
- string -
- 		- Default:
"bootflash"
- 		-
The remote file system of the device. If omitted, devices that support a file_system parameter will use their default values.
-
-
- pkg - -
- string -
- 		- -
Name of the RPM package.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
If the state is present, the rpm will be installed, If the state is absent, it will be removed.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.0(3)I2(5), 7.0(3)I4(6), 7.0(3)I5(3), 7.0(3)I6(1), 7.0(3)I7(3) - - Unsupported for Cisco MDS - - For patches, the minimum platform version needed is 7.0(3)I2(5) - - For feature rpms, the minimum platform version needed is 7.0(3)I6(1) - - The module manages the entire RPM lifecycle (Add, activate, commit, deactivate, remove) - - For reload patches, this module is NOT idempotent until the patch is committed. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_rpm: - pkg: nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000.rpm - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['install add bootflash:nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000.rpm forced', 'install activate nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000 forced', 'install commit nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Sai Chintalapudi (@saichint) diff --git a/docs/cisco.nxos.nxos_snapshot_module.rst b/docs/cisco.nxos.nxos_snapshot_module.rst deleted file mode 100644 index fe89b5b7b..000000000 --- a/docs/cisco.nxos.nxos_snapshot_module.rst +++ /dev/null @@ -1,363 +0,0 @@ -.. _cisco.nxos.nxos_snapshot_module: - - -************************ -cisco.nxos.nxos_snapshot -************************ - -**Manage snapshots of the running states of selected features.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Create snapshots of the running states of selected features, add new show commands for snapshot creation, delete and compare existing snapshots. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- action - -
- string - / required -
- 		-
    Choices: -
  • add
    • -
  • compare
    • -
  • create
    • -
  • delete
    • -
  • delete_all
    • -
- 		-
Define what snapshot action the module would perform.
-
-
- compare_option - -
- string -
- 		-
    Choices: -
  • summary
    • -
  • ipv4routes
    • -
  • ipv6routes
    • -
- 		-
Snapshot options to be used when action=compare.
-
-
- comparison_results_file - -
- string -
- 		- -
Name of the file where snapshots comparison will be stored when action=compare.
-
-
- description - -
- string -
- 		- -
Snapshot description to be used when action=create.
-
-
- element_key1 - -
- string -
- 		- -
Specify the tags used to distinguish among row entries, to be used when action=add.
-
-
- element_key2 - -
- string -
- 		- -
Specify the tags used to distinguish among row entries, to be used when action=add.
-
-
- path - -
- string -
- 		- Default:
"./"
- 		-
Specify the path of the file where new created snapshot or snapshots comparison will be stored, to be used when action=create and save_snapshot_locally=true or action=compare.
-
-
- row_id - -
- string -
- 		- -
Specifies the tag of each row entry of the show command's XML output, to be used when action=add.
-
-
- save_snapshot_locally - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Specify to locally store a new created snapshot, to be used when action=create.
-
-
- section - -
- string -
- 		- -
Used to name the show command output, to be used when action=add.
-
-
- show_command - -
- string -
- 		- -
Specify a new show command, to be used when action=add.
-
-
- snapshot1 - -
- string -
- 		- -
First snapshot to be used when action=compare.
-
-
- snapshot2 - -
- string -
- 		- -
Second snapshot to be used when action=compare.
-
-
- snapshot_name - -
- string -
- 		- -
Snapshot name, to be used when action=create or action=delete.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - ``transport=cli`` may cause timeout errors. - - The ``element_key1`` and ``element_key2`` parameter specify the tags used to distinguish among row entries. In most cases, only the element_key1 parameter needs to specified to be able to distinguish among row entries. - - ``action=compare`` will always store a comparison report on a local file. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Create a snapshot and store it locally - - cisco.nxos.nxos_snapshot: - action: create - snapshot_name: test_snapshot - description: Done with Ansible - save_snapshot_locally: true - path: /home/user/snapshots/ - - # Delete a snapshot - - cisco.nxos.nxos_snapshot: - action: delete - snapshot_name: test_snapshot - - # Delete all existing snapshots - - cisco.nxos.nxos_snapshot: - action: delete_all - - # Add a show command for snapshots creation - - cisco.nxos.nxos_snapshot: - section: myshow - show_command: show ip interface brief - row_id: ROW_intf - element_key1: intf-name - - # Compare two snapshots - - cisco.nxos.nxos_snapshot: - action: compare - snapshot1: pre_snapshot - snapshot2: post_snapshot - comparison_results_file: compare_snapshots.txt - compare_option: summary - path: ../snapshot_reports/ - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		verbose mode -
commands sent to the device
-
-
Sample:
-
['snapshot create post_snapshot Post-snapshot']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_community_module.rst b/docs/cisco.nxos.nxos_snmp_community_module.rst deleted file mode 100644 index 584d2d772..000000000 --- a/docs/cisco.nxos.nxos_snmp_community_module.rst +++ /dev/null @@ -1,201 +0,0 @@ -.. _cisco.nxos.nxos_snmp_community_module: - - -****************************** -cisco.nxos.nxos_snmp_community -****************************** - -**(deprecated, removed after 2024-01-01) Manages SNMP community configs.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated modules released with more functionality -:Alternative: nxos_snmp_server - - - -Synopsis --------- -- Manages SNMP community configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- access - -
- string -
- 		-
    Choices: -
  • ro
    • -
  • rw
    • -
- 		-
Access type for community.
-
-
- acl - -
- string -
- 		- -
ACL name to filter snmp requests or keyword 'default'.
-
-
- community - -
- string - / required -
- 		- -
Case-sensitive community string.
-
-
- group - -
- string -
- 		- -
Group to which the community belongs.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure snmp community is configured - - cisco.nxos.nxos_snmp_community: - community: TESTING7 - group: network-operator - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['snmp-server community TESTING7 group network-operator']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_host_module.rst b/docs/cisco.nxos.nxos_snmp_host_module.rst deleted file mode 100644 index 8aef0b21d..000000000 --- a/docs/cisco.nxos.nxos_snmp_host_module.rst +++ /dev/null @@ -1,288 +0,0 @@ -.. _cisco.nxos.nxos_snmp_host_module: - - -************************* -cisco.nxos.nxos_snmp_host -************************* - -**(deprecated, removed after 2024-01-01) Manages SNMP host configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated modules released with more functionality -:Alternative: nxos_snmp_server - - - -Synopsis --------- -- Manages SNMP host configuration parameters. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- community - -
- string -
- 		- -
Community string or v3 username.
-
-
- snmp_host - -
- string - / required -
- 		- -
IP address of hostname of target host.
-
-
- snmp_type - -
- string -
- 		-
    Choices: -
  • trap
    • -
  • inform
    • -
- 		-
type of message to send to host. If this is not specified, trap type is used.
-
-
- src_intf - -
- string -
- 		- -
Source interface. Must be fully qualified interface name. If state = absent, the interface is removed.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource. If state = present, the host is added to the configuration. If only vrf and/or vrf_filter and/or src_intf are given, they will be added to the existing host configuration. If state = absent, the host is removed if community parameter is given. It is possible to remove only vrf and/or src_int and/or vrf_filter by providing only those parameters and no community parameter.
-
-
- udp - -
- string -
- 		- Default:
"162"
- 		-
UDP port number (0-65535).
-
-
- v3 - -
- string -
- 		-
    Choices: -
  • noauth
    • -
  • auth
    • -
  • priv
    • -
- 		-
Use this when verion is v3. SNMPv3 Security level.
-
-
- version - -
- string -
- 		-
    Choices: -
  • v1
    • -
  • v2c
    • -
  • v3
    • -
- 		-
SNMP version. If this is not specified, v1 is used.
-
-
- vrf - -
- string -
- 		- -
VRF to use to source traffic to source. If state = absent, the vrf is removed.
-
-
- vrf_filter - -
- string -
- 		- -
Name of VRF to filter. If state = absent, the vrf is removed from the filter.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - ``state=absent`` removes the host configuration if it is configured. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure snmp host is configured - - cisco.nxos.nxos_snmp_host: - snmp_host: 192.0.2.3 - community: TESTING - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['snmp-server host 192.0.2.3 filter-vrf another_test_vrf']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_location_module.rst b/docs/cisco.nxos.nxos_snmp_location_module.rst deleted file mode 100644 index 06f564693..000000000 --- a/docs/cisco.nxos.nxos_snmp_location_module.rst +++ /dev/null @@ -1,156 +0,0 @@ -.. _cisco.nxos.nxos_snmp_location_module: - - -***************************** -cisco.nxos.nxos_snmp_location -***************************** - -**(deprecated, removed after 2024-01-01) Manages SNMP location information.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated modules released with more functionality -:Alternative: nxos_snmp_server - - - -Synopsis --------- -- Manages SNMP location configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- location - -
- string - / required -
- 		- -
Location information.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure snmp location is configured - - cisco.nxos.nxos_snmp_location: - location: Test - state: present - - # ensure snmp location is not configured - - cisco.nxos.nxos_snmp_location: - location: Test - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['snmp-server location New_Test']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_server_module.rst b/docs/cisco.nxos.nxos_snmp_server_module.rst deleted file mode 100644 index 126e16341..000000000 --- a/docs/cisco.nxos.nxos_snmp_server_module.rst +++ /dev/null @@ -1,4474 +0,0 @@ -.. _cisco.nxos.nxos_snmp_server_module: - - -*************************** -cisco.nxos.nxos_snmp_server -*************************** - -**SNMP Server resource module.** - - -Version added: 2.8.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages SNMP server configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A dict of SNMP server configuration
-
-
- aaa_user - -
- dictionary -
- 		- -
Set duration for which aaa-cached snmp user exists.
-
-
- cache_timeout - -
- integer -
- 		- -
Timeout for which aaa-cached user exists(in secs).
-
-
- communities - -
- list - / elements=dictionary -
- 		- -
Set community string and access privs.
-
-
- group - -
- string -
- 		- -
Group to which the community belongs.
-
-
- name - -
- string -
- 		- -
SNMP community string (Max Size 32).
-

aliases: community
-
-
- ro - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Read-only access with this community string.
-
-
- rw - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Read-write access with this community string.
-
-
- use_ipv4acl - -
- string -
- 		- -
Specify IPv4 ACL, the ACL name specified must be IPv4 ACL.
-
This option is unsupported on MDS switches.
-
-
- use_ipv6acl - -
- string -
- 		- -
Specify IPv6 ACL, the ACL name specified after must be IPv6 ACL.
-
This option is unsupported on MDS switches.
-
-
- contact - -
- string -
- 		- -
Modify sysContact.
-
-
- context - -
- dictionary -
- 		- -
SNMP context to be mapped.
-
-
- instance - -
- string -
- 		- -
Name of the protocol instance (Max Size 32).
-
-
- name - -
- string -
- 		- -
Name of the SNMP context (Max Size 32).
-
-
- topology - -
- string -
- 		- -
Topology associated with the SNMP context.
-
-
- vrf - -
- string -
- 		- -
VRF associated with the SNMP context.
-
This option is unsupported on MDS switches.
-
-
- counter - -
- dictionary -
- 		- -
Configure port counter configuration.
-
This option is unsupported on MDS switches.
-
-
- cache - -
- dictionary -
- 		- -
Port stats cache.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable port stats cache.
-
-
- timeout - -
- integer -
- 		- -
Timeout for which cached port stats exists(in secs).
-
-
- drop - -
- dictionary -
- 		- -
Silently drop unknown v3 user packets.
-
This option is unsupported on MDS switches.
-
-
- unknown_engine_id - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Unknown v3 engine id.
-
-
- unknown_user - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Unknown v3 user.
-
-
- engine_id - -
- dictionary -
- 		- -
Configure a local SNMPv3 engineID.
-
This option is unsupported on MDS switches.
-
-
- local - -
- string -
- 		- -
EngineID of the local agent.
-
-
- global_enforce_priv - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Globally enforce privacy for all the users.
-
-
- hosts - -
- list - / elements=dictionary -
- 		- -
Specify hosts to receive SNMP notifications.
-
SNMP hosts config lines that appear separately in running-config must be added as individual dictionaries.
-
-
- auth - -
- string -
- 		- -
Use the SNMPv3 authNoPriv Security Level.
-
-
- community - -
- string -
- 		- -
SNMP community string or SNMPv3 user name (Max Size 32).
-
-
- filter_vrf - -
- string -
- 		- -
Filters notifications to the notification host receiver based on the configured VRF.
-
This option is unsupported on MDS switches.
-
-
- host - -
- string -
- 		- -
IPv4 or IPv6 address or DNS Name of SNMP notification host.
-
-
- informs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Inform messages to this host.
-
-
- priv - -
- string -
- 		- -
Use the SNMPv3 authPriv Security Level.
-
-
- source_interface - -
- string -
- 		- -
Source interface to be used for sending out SNMP notifications to this host.
-
-
- traps - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Traps messages to this host.
-
-
- udp_port - -
- integer -
- 		- -
The notification host's UDP port number.
-
-
- use_vrf - -
- string -
- 		- -
Configures SNMP to use the selected VRF to communicate with the host receiver.
-
This option is unsupported on MDS switches.
-
-
- version - -
- string -
- 		-
    Choices: -
  • 1
    • -
  • 2c
    • -
  • 3
    • -
- 		-
SNMP version to use for notification messages.
-
-
- location - -
- string -
- 		- -
Modify sysLocation.
-
-
- mib - -
- dictionary -
- 		- -
Mib access parameters.
-
-
- community_map - -
- dictionary -
- 		- -
SNMP community.
-
-
- community - -
- string -
- 		- -
SNMP community string (Max Size 32).
-
-
- context - -
- string -
- 		- -
Name of the SNMP context (Max Size 32).
-
-
- packetsize - -
- integer -
- 		- -
Largest SNMP packet size
-
-
- protocol - -
- dictionary -
- 		- -
Snmp protocol operations.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable snmp protocol operations.
-
-
- source_interface - -
- dictionary -
- 		- -
Source interface to be used for sending out SNMP notifications.
-
This option is unsupported on MDS switches.
-
-
- informs - -
- string -
- 		- -
SNMP Inform notifications for which this source interface needs to be used.
-
-
- traps - -
- string -
- 		- -
SNMP Trap notifications for which this source interface needs to be used.
-
-
- system_shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure snmp-server for reload(2).
-
-
- tcp_session - -
- dictionary -
- 		- -
Enable one time authentication for snmp over tcp session.
-
-
- auth - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable one time authentication for snmp over tcp session.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable tcp-session.
-
This option is unsupported on MDS switches.
-
-
- traps - -
- dictionary -
- 		- -
Enable SNMP Traps
-
-
- aaa - -
- dictionary -
- 		- -
AAA traps
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable AAA traps.
-
-
- server_state_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
AAA server state change notification.
-
-
- bgp - -
- dictionary -
- 		- -
SNMP BGP traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP BGP traps.
-
-
- bridge - -
- dictionary -
- 		- -
Bridge traps.
-
This option is unsupported on MDS switches.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable bridge traps.
-
-
- newroot - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP STP Bridge MIB newroot traps.
-
-
- topologychange - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP STP Bridge MIB topologychange traps.
-
-
- callhome - -
- dictionary -
- 		- -
Callhome traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable callhome traps.
-
This option is unsupported on MDS switches.
-
-
- event_notify - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Callhome External Event Notification.
-
-
- smtp_send_fail - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
SMTP Message Send Fail notification.
-
-
- cfs - -
- dictionary -
- 		- -
CFS traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable cfs traps.
-
This option is unsupported on MDS switches.
-
-
- merge_failure - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Merge failure notification.
-
-
- state_change_notif - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
State change notification.
-
-
- config - -
- dictionary -
- 		- -
Config traps.
-
-
- ccmCLIRunningConfigChanged - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Running config change trap.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable config traps.
-
This option is unsupported on MDS switches.
-
-
- entity - -
- dictionary -
- 		- -
Entity traps.
-
-
- cefcMIBEnableStatusNotification - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
CefcMIBEnableStatusNotification.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable entity traps.
-
-
- entity_fan_status_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Fan Status Change.
-
-
- entity_mib_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity MIB change.
-
-
- entity_module_inserted - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Module Inserted.
-
-
- entity_module_removed - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Module Removed.
-
-
- entity_module_status_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Module Status Change.
-
-
- entity_power_out_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Power Out Change.
-
-
- entity_power_status_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Power Status Change.
-
-
- entity_sensor - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity sensor.
-
-
- entity_unrecognised_module - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Unrecognised Module.
-
-
- feature_control - -
- dictionary -
- 		- -
Feature-Control traps.
-
-
- ciscoFeatOpStatusChange - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Feature operation status change Notification.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable feature-control traps.
-
This option is unsupported on MDS switches.
-
-
- featureOpStatusChange - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Feature operation status change notification.
-
-
- generic - -
- dictionary -
- 		- -
Generic traps.
-
-
- coldStart - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Generic coldStart trap.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable generic traps.
-
This option is unsupported on MDS switches.
-
-
- warmStart - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Generic warmStart trap.
-
-
- license - -
- dictionary -
- 		- -
License traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable license traps.
-
This option is unsupported on MDS switches.
-
-
- notify_license_expiry - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
License Expiry Notification.
-
-
- notify_license_expiry_warning - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
License Expiry Warning Notification.
-
-
- notify_licensefile_missing - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
License File Missing Notification.
-
-
- notify_no_license_for_feature - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
No License installed for feature Notification.
-
-
- link - -
- dictionary -
- 		- -
Link traps.
-
-
- cErrDisableInterfaceEventRev1 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Err-disable state notification.
-
This option is unsupported on MDS switches.
-
-
- cieLinkDown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Cisco extended link state down notification.
-
-
- cieLinkUp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Cisco extended link state up notification.
-
-
- cisco_xcvr_mon_status_chg - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Cisco interface transceiver monitor status change notification.
-
-
- cmn_mac_move_notification - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Mac addr move trap.
-
This option is unsupported on MDS switches.
-
-
- delayed_link_state_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Delayed link state change.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable link traps.
-
This option is unsupported on MDS switches.
-
-
- extended_linkDown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IETF extended link state down notification.
-
-
- extended_linkUp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IETF extended link state up notification.
-
-
- linkDown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IETF Link state down notification.
-
-
- linkUp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IETF Link state up notification.
-
-
- mmode - -
- dictionary -
- 		- -
MMode traps.
-
This option is unsupported on MDS switches.
-
-
- cseMaintModeChangeNotify - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Maint Mode Change Notification.
-
-
- cseNormalModeChangeNotify - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Normal Mode Change Notification.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable mmode traps.
-
-
- ospf - -
- dictionary -
- 		- -
SNMP OSPF traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP OSPF traps.
-
-
- ospfv3 - -
- dictionary -
- 		- -
SNMP OSPFv3 traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP OSPFv3 traps.
-
-
- rf - -
- dictionary -
- 		- -
RF traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable rf traps.
-
This option is unsupported on MDS switches.
-
-
- redundancy_framework - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Redundancy_Framework (RF) Sup switchover MIB.
-
-
- rmon - -
- dictionary -
- 		- -
RMON traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable rmon traps.
-
This option is unsupported on MDS switches.
-
-
- fallingAlarm - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Rmon falling alarm.
-
-
- hcFallingAlarm - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
High capacity Rmon falling alarm.
-
-
- hcRisingAlarm - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
High capacity Rmon rising alarm.
-
-
- risingAlarm - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Rmon rising alarm.
-
-
- snmp - -
- dictionary -
- 		- -
SNMP traps.
-
-
- authentication - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
SNMP authentication trap.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable snmp traps.
-
This option is unsupported on MDS switches.
-
-
- storm_control - -
- dictionary -
- 		- -
Storm-Control traps.
-
-
- cpscEventRev1 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Port-Storm-Control-Event.
-
This option is unsupported on MDS switches.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable storm-control traps.
-
This option is unsupported on MDS switches.
-
-
- trap_rate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Number of traps per minute.
-
-
- stpx - -
- dictionary -
- 		- -
Stpx traps.
-
This option is unsupported on MDS switches.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable stpx traps.
-
-
- inconsistency - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP STPX MIB InconsistencyUpdate traps.
-
-
- loop_inconsistency - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP STPX MIB LoopInconsistencyUpdate traps.
-
-
- root_inconsistency - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP STPX MIB RootInconsistencyUpdate traps.
-
-
- syslog - -
- dictionary -
- 		- -
Enable syslog traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable syslog traps.
-
This option is unsupported on MDS switches.
-
-
- message_generated - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Message Generated Notification.
-
-
- sysmgr - -
- dictionary -
- 		- -
Sysmgr traps.
-
-
- cseFailSwCoreNotifyExtended - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Software Core Notification.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable sysmgr traps.
-
This option is unsupported on MDS switches.
-
-
- system - -
- dictionary -
- 		- -
System traps.
-
-
- clock_change_notification - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Clock-change-notification traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable system traps.
-
This option is unsupported on MDS switches.
-
-
- upgrade - -
- dictionary -
- 		- -
Upgrade traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable upgrade traps.
-
This option is unsupported on MDS switches.
-
-
- upgradeJobStatusNotify - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Upgrade Job Status Notification.
-
-
- upgradeOpNotifyOnCompletion - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Upgrade Global Status Notification.
-
-
- vtp - -
- dictionary -
- 		- -
VTP traps.
-
This option is unsupported on MDS switches.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable VTP traps.
-
-
- notifs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable vtpConfigRevNumberError vtpConfigDigestEnable vtpConfigRevNumberError vtpConfigDigestError vtpServerDisabled vtpVersionOneDeviceDetected vlanTrunkPortDynamicStatusChange vtpLocalModeChanged vtpVersionInUseChanged notification.
-
-
- vlancreate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable vtpVlanCreated notification.
-
-
- vlandelete - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable vtpVlanDeleted notification.
-
-
- users - -
- dictionary -
- 		- -
Define users who can access the SNMP engine.
-
-
- auth - -
- list - / elements=dictionary -
- 		- -
SNMP User authentication related settings
-
-
- authentication - -
- dictionary -
- 		- -
Authentication parameters for the user.
-
-
- algorithm - -
- string -
- 		-
    Choices: -
  • md5
    • -
  • sha
    • -
  • sha-256
    • -
- 		-
Select algorithm for authentication.
-
-
- engine_id - -
- string -
- 		- -
EngineID for configuring notif target user (for V3 informs).
-
This value needs to be enclosed in quotes in the task.
-
-
- localized_key - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specifies whether the passwords are in localized key format.
-
-
- localizedv2_key - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specifies whether the passwords are in localized V2 key format.
-
-
- password - -
- string -
- 		- -
Authentication password for user (Max Size 127).
-
If this value is localized, it has to be enclosed in quotes in the task.
-
-
- priv - -
- dictionary -
- 		- -
Encryption parameters for the user.
-
-
- aes_128 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use 128-bit AES algorithm for privacy.
-
-
- privacy_password - -
- string -
- 		- -
Privacy password for user (Max Size 130).
-
If this value is localized, it has to be enclosed in quotes in the task.
-
-
- group - -
- string -
- 		- -
Group name (ignored for notif target user) (Max Size 28).
-
-
- user - -
- string -
- 		- -
Name of the user (Max Size 28).
-
-
- use_acls - -
- list - / elements=dictionary -
- 		- -
Set IPv4 and IPv6 ACL to use.
-
-
- ipv4 - -
- string -
- 		- -
Specify IPv4 ACL, the ACL name specified after must be IPv4 ACL.
-
-
- ipv6 - -
- string -
- 		- -
Specify IPv6 ACL, the ACL name specified after must be IPv6 ACL.
-
-
- user - -
- string -
- 		- -
Name of the user (Max Size 28).
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^snmp-server'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
The states replaced and overridden have identical behaviour for this module.
-
Please refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6 on Cisco Nexus Switches. - - This module works with connection ``network_cli`` and ``httpapi``. - - Tested against Cisco MDS NX-OS 9.2(2) with connection ``network_cli``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_snmp_server: - config: - aaa_user: - cache_timeout: 36000 - communities: - - community: public - group: network-operator - - community: private - group: network-admin - contact: nxosswitchadmin@localhost - location: serverroom-1 - traps: - aaa: - server_state_change: true - system: - clock_change_notification: true - hosts: - - host: 192.0.2.1 - traps: true - version: '1' - community: public - - host: 192.0.2.1 - source_interface: Ethernet1/1 - - host: 192.0.2.2 - informs: true - version: '3' - auth: NMS - users: - auth: - - user: snmp_user_1 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - - user: snmp_user_2 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - priv: - privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' - aes_128: true - use_acls: - - user: snmp_user_1 - ipv4: acl1 - ipv6: acl2 - - user: snmp_user_2 - ipv4: acl3 - ipv6: acl4 - - # Task output - # ------------- - # before: - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # - # commands: - # - snmp-server contact nxosswitchadmin@localhost - # - snmp-server location serverroom-1 - # - snmp-server aaa-user cache-timeout 36000 - # - snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # - snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # - snmp-server host 192.0.2.1 traps version 1 public - # - snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # - snmp-server host 192.0.2.2 informs version 3 auth NMS - # - snmp-server community private group network-admin - # - snmp-server community public group network-operator - # - snmp-server enable traps aaa server-state-change - # - snmp-server enable traps system Clock-change-notification - # - # after: - # aaa_user: - # cache_timeout: 36000 - # communities: - # - community: private - # group: network-admin - # - community: public - # group: network-operator - # contact: nxosswitchadmin@localhost - # location: serverroom-1 - # traps: - # aaa: - # server_state_change: true - # system: - # clock_change_notification: true - # hosts: - # - host: 192.0.2.1 - # traps: true - # version: "1" - # community: public - # - # - host: 192.0.2.1 - # source_interface: Ethernet1/1 - # - # - host: 192.0.2.2 - # informs: true - # version: "3" - # auth: NMS - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # - # - user: snmp_user_1 - # group: network-operator - # authentication: - # algorithm: md5 - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # localized_key: true - # - # - authentication: - # algorithm: md5 - # localized_key: true - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # priv: - # aes_128: true - # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" - # group: network-operator - # user: snmp_user_2 - # - # use_acls: - # - user: snmp_user_1 - # ipv4: acl1 - # ipv6: acl2 - # - user: snmp_user_2 - # ipv4: acl3 - # ipv6: acl4 - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server contact nxosswitchadmin@localhost - # snmp-server location serverroom-1 - # snmp-server aaa-user cache-timeout 36000 - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # snmp-server host 192.0.2.1 traps version 1 public - # snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # snmp-server host 192.0.2.2 informs version 3 auth NMS - # snmp-server community private group network-admin - # snmp-server community public group network-operator - # snmp-server enable traps aaa server-state-change - # snmp-server enable traps system Clock-change-notification - - # Using replaced - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server contact nxosswitchadmin@localhost - # snmp-server location serverroom-1 - # snmp-server aaa-user cache-timeout 36000 - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # snmp-server host 192.0.2.1 traps version 1 public - # snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # snmp-server host 192.0.2.2 informs version 3 auth NMS - # snmp-server community private group network-admin - # snmp-server community public group network-operator - # snmp-server enable traps aaa server-state-change - # snmp-server enable traps system Clock-change-notification - - - name: Replace snmp-server configurations of listed snmp-server with provided configurations - cisco.nxos.nxos_snmp_server: - config: - aaa_user: - cache_timeout: 36000 - communities: - - community: public - group: network-operator - - community: secret - group: network-operator - contact: nxosswitchadmin2@localhost - location: serverroom-2 - traps: - aaa: - server_state_change: true - hosts: - - host: 192.0.2.1 - traps: true - version: '1' - community: public - - host: 192.0.2.1 - source_interface: Ethernet1/1 - - host: 192.0.3.2 - informs: true - version: '3' - auth: NMS - users: - auth: - - user: admin - group: network-admin - authentication: - algorithm: md5 - password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - localized_key: true - priv: - privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - - - user: snmp_user_1 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - - - user: snmp_user_2 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - priv: - privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' - aes_128: true - use_acls: - - user: snmp_user_1 - ipv4: acl1 - ipv6: acl2 - state: replaced - - # Task output - # ------------- - # before: - # aaa_user: - # cache_timeout: 36000 - # communities: - # - community: private - # group: network-admin - # - community: public - # group: network-operator - # contact: nxosswitchadmin@localhost - # location: serverroom-1 - # traps: - # aaa: - # server_state_change: true - # system: - # clock_change_notification: true - # hosts: - # - host: 192.0.2.1 - # traps: true - # version: "1" - # community: public - # - # - host: 192.0.2.1 - # source_interface: Ethernet1/1 - # - # - host: 192.0.2.2 - # informs: true - # version: "3" - # auth: NMS - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # - # - user: snmp_user_1 - # group: network-operator - # authentication: - # algorithm: md5 - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # localized_key: true - # - # - authentication: - # algorithm: md5 - # localized_key: true - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # priv: - # aes_128: true - # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" - # group: network-operator - # user: snmp_user_2 - # - # use_acls: - # - user: snmp_user_1 - # ipv4: acl1 - # ipv6: acl2 - # - user: snmp_user_2 - # ipv4: acl3 - # ipv6: acl4 - # - # commands: - # - snmp-server contact nxosswitchadmin2@localhost - # - no snmp-server enable traps system Clock-change-notification - # - snmp-server location serverroom-2 - # - no snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # - no snmp-server host 192.0.2.2 informs version 3 auth NMS - # - snmp-server host 192.0.3.2 informs version 3 auth NMS - # - no snmp-server community private group network-admin - # - snmp-server community secret group network-operator - # - # after: - # aaa_user: - # cache_timeout: 36000 - # communities: - # - community: public - # group: network-operator - # - community: secret - # group: network-operator - # contact: nxosswitchadmin2@localhost - # location: serverroom-2 - # traps: - # aaa: - # server_state_change: true - # hosts: - # - host: 192.0.2.1 - # traps: true - # version: '1' - # community: public - # - host: 192.0.2.1 - # source_interface: Ethernet1/1 - # - host: 192.0.3.2 - # informs: true - # version: '3' - # auth: NMS - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # - # - user: snmp_user_1 - # group: network-operator - # authentication: - # algorithm: md5 - # password: '0x5632724fb8ac3699296af26281e1d0f1' - # localized_key: true - # - # - user: snmp_user_2 - # group: network-operator - # authentication: - # algorithm: md5 - # password: '0x5632724fb8ac3699296af26281e1d0f1' - # localized_key: true - # priv: - # privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' - # aes_128: true - # - # use_acls: - # - user: snmp_user_1 - # ipv4: acl1 - # ipv6: acl2 - # - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server contact nxosswitchadmin2@localhost - # snmp-server location serverroom-2 - # snmp-server aaa-user cache-timeout 36000 - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # snmp-server host 192.0.2.1 traps version 1 public - # snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # snmp-server host 192.0.2.2 informs version 3 auth NMS - # snmp-server community secret group network-operator - # snmp-server community public group network-operator - # snmp-server enable traps aaa server-state-change - # snmp-server enable traps system Clock-change-notification - - # Using deleted - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server contact nxosswitchadmin@localhost - # snmp-server location serverroom-1 - # snmp-server aaa-user cache-timeout 36000 - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # snmp-server host 192.0.2.1 traps version 1 public - # snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # snmp-server host 192.0.2.2 informs version 3 auth NMS - # snmp-server community private group network-admin - # snmp-server community public group network-operator - # snmp-server enable traps aaa server-state-change - # snmp-server enable traps system Clock-change-notification - - - name: Delete SNMP Server configurations from the device (admin user will not be deleted) - cisco.nxos.nxos_snmp_server: - state: deleted - - # Task output - # ------------- - # before: - # aaa_user: - # cache_timeout: 36000 - # communities: - # - community: private - # group: network-admin - # - community: public - # group: network-operator - # contact: nxosswitchadmin@localhost - # location: serverroom-1 - # traps: - # aaa: - # server_state_change: true - # system: - # clock_change_notification: true - # hosts: - # - host: 192.0.2.1 - # traps: true - # version: "1" - # community: public - # - # - host: 192.0.2.1 - # source_interface: Ethernet1/1 - # - # - host: 192.0.2.2 - # informs: true - # version: "3" - # auth: NMS - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # - # - user: snmp_user_1 - # group: network-operator - # authentication: - # algorithm: md5 - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # localized_key: true - # - # - authentication: - # algorithm: md5 - # localized_key: true - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # priv: - # aes_128: true - # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" - # group: network-operator - # user: snmp_user_2 - # - # use_acls: - # - user: snmp_user_1 - # ipv4: acl1 - # ipv6: acl2 - # - user: snmp_user_2 - # ipv4: acl3 - # ipv6: acl4 - # - # commands: - # - no snmp-server contact nxosswitchadmin@localhost - # - no snmp-server location serverroom-1 - # - no snmp-server aaa-user cache-timeout 36000 - # - no snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - # - no snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - no snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - no snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # - no snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # - no snmp-server host 192.0.2.1 traps version 1 public - # - no snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # - no snmp-server host 192.0.2.2 informs version 3 auth NMS - # - no snmp-server community private group network-admin - # - no snmp-server community public group network-operator - # - no snmp-server enable traps aaa server-state-change - # - no snmp-server enable traps system Clock-change-notification - # - # after: - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - - # Using rendered - # --------------- - - - name: Render platform specific configuration lines with state rendered (without connecting to the device) - cisco.nxos.nxos_snmp_server: - config: - aaa_user: - cache_timeout: 36000 - communities: - - community: public - group: network-operator - - community: private - group: network-admin - contact: nxosswitchadmin@localhost - location: serverroom-1 - traps: - aaa: - server_state_change: true - system: - clock_change_notification: true - hosts: - - host: 192.0.2.1 - traps: true - version: '1' - community: public - - host: 192.0.2.1 - source_interface: Ethernet1/1 - - host: 192.0.2.2 - informs: true - version: '3' - auth: NMS - users: - auth: - - user: snmp_user_1 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - - user: snmp_user_2 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - priv: - privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' - aes_128: true - use_acls: - - user: snmp_user_1 - ipv4: acl1 - ipv6: acl2 - - user: snmp_user_2 - ipv4: acl3 - ipv6: acl4 - state: rendered - - - # Task Output (redacted) - # ----------------------- - # rendered: - # - snmp-server contact nxosswitchadmin@localhost - # - snmp-server location serverroom-1 - # - snmp-server aaa-user cache-timeout 36000 - # - snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # - snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # - snmp-server host 192.0.2.1 traps version 1 public - # - snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # - snmp-server host 192.0.2.2 informs version 3 auth NMS - # - snmp-server community private group network-admin - # - snmp-server community public group network-operator - # - snmp-server enable traps aaa server-state-change - # - snmp-server enable traps system Clock-change-notification - - # Using parsed - - # parsed.cfg - # ------------ - # snmp-server contact nxosswitchadmin@localhost - # snmp-server location serverroom-1 - # snmp-server aaa-user cache-timeout 36000 - # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # snmp-server host 192.0.2.1 traps version 1 public - # snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # snmp-server host 192.0.2.2 informs version 3 auth NMS - # snmp-server community private group network-admin - # snmp-server community public group network-operator - # snmp-server enable traps aaa server-state-change - # snmp-server enable traps system Clock-change-notification - - - name: Parse externally provided snmp-server configuration - cisco.nxos.nxos_snmp_server: - running_config: "{{ lookup('file', './parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # aaa_user: - # cache_timeout: 36000 - # communities: - # - community: private - # group: network-admin - # - community: public - # group: network-operator - # contact: nxosswitchadmin@localhost - # location: serverroom-1 - # traps: - # aaa: - # server_state_change: true - # system: - # clock_change_notification: true - # hosts: - # - host: 192.0.2.1 - # traps: true - # version: "1" - # community: public - # - # - host: 192.0.2.1 - # source_interface: Ethernet1/1 - # - # - host: 192.0.2.2 - # informs: true - # version: "3" - # auth: NMS - # users: - # auth: - # - user: snmp_user_1 - # group: network-operator - # authentication: - # algorithm: md5 - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # localized_key: true - # - # - authentication: - # algorithm: md5 - # localized_key: true - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # priv: - # aes_128: true - # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" - # group: network-operator - # user: snmp_user_2 - # - # use_acls: - # - user: snmp_user_1 - # ipv4: acl1 - # ipv6: acl2 - # - user: snmp_user_2 - # ipv4: acl3 - # ipv6: acl4 - # - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['sample command 1', 'sample command 2', 'sample command 3']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['sample command 1', 'sample command 2', 'sample command 3']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_snmp_traps_module.rst b/docs/cisco.nxos.nxos_snmp_traps_module.rst deleted file mode 100644 index 726a4d5fe..000000000 --- a/docs/cisco.nxos.nxos_snmp_traps_module.rst +++ /dev/null @@ -1,189 +0,0 @@ -.. _cisco.nxos.nxos_snmp_traps_module: - - -************************** -cisco.nxos.nxos_snmp_traps -************************** - -**(deprecated, removed after 2024-01-01) Manages SNMP traps.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated modules released with more functionality -:Alternative: nxos_snmp_server - - - -Synopsis --------- -- Manages SNMP traps configurations. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- group - -
- string - / required -
- 		-
    Choices: -
  • aaa
    • -
  • bfd
    • -
  • bgp
    • -
  • bridge
    • -
  • callhome
    • -
  • cfs
    • -
  • config
    • -
  • eigrp
    • -
  • entity
    • -
  • feature-control
    • -
  • generic
    • -
  • hsrp
    • -
  • license
    • -
  • link
    • -
  • lldp
    • -
  • mmode
    • -
  • ospf
    • -
  • pim
    • -
  • rf
    • -
  • rmon
    • -
  • snmp
    • -
  • storm-control
    • -
  • stpx
    • -
  • switchfabric
    • -
  • syslog
    • -
  • sysmgr
    • -
  • system
    • -
  • upgrade
    • -
  • vtp
    • -
  • all
    • -
- 		-
Case sensitive group.
-
-
- state - -
- string -
- 		-
    Choices: -
  • enabled ←
    • -
  • disabled
    • -
- 		-
Manage the state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - This module works at the group level for traps. If you need to only enable/disable 1 specific trap within a group, use the :ref:`cisco.nxos.nxos_command ` module. - - Be aware that you can set a trap only for an enabled feature. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure lldp trap configured - - cisco.nxos.nxos_snmp_traps: - group: lldp - state: enabled - - # ensure lldp trap is not configured - - cisco.nxos.nxos_snmp_traps: - group: lldp - state: disabled - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
snmp-server enable traps lldp ;
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_snmp_user_module.rst b/docs/cisco.nxos.nxos_snmp_user_module.rst deleted file mode 100644 index 2d3f6f26c..000000000 --- a/docs/cisco.nxos.nxos_snmp_user_module.rst +++ /dev/null @@ -1,235 +0,0 @@ -.. _cisco.nxos.nxos_snmp_user_module: - - -************************* -cisco.nxos.nxos_snmp_user -************************* - -**(deprecated, removed after 2024-01-01) Manages SNMP users for monitoring.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated modules released with more functionality -:Alternative: nxos_snmp_server - - - -Synopsis --------- -- Manages SNMP user configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- authentication - -
- string -
- 		-
    Choices: -
  • md5
    • -
  • sha
    • -
- 		-
Authentication parameters for the user.
-
-
- encrypt - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables AES-128 bit encryption when using privacy password.
-
-
- group - -
- string -
- 		- -
Group to which the user will belong to. If state = present, and the user is existing, the group is added to the user. If the user is not existing, user entry is created with this group argument. If state = absent, only the group is removed from the user entry. However, to maintain backward compatibility, if the existing user belongs to only one group, and if group argument is same as the existing user's group, then the user entry also is deleted.
-
-
- privacy - -
- string -
- 		- -
Privacy password for the user. This is not idempotent
-
-
- pwd - -
- string -
- 		- -
Authentication password when using md5 or sha. This is not idempotent
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- user - -
- string - / required -
- 		- -
Name of the user.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - Authentication parameters not idempotent. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_snmp_user: - user: ntc - group: network-operator - authentication: md5 - pwd: test_password - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['snmp-server user ntc network-operator auth md5 test_password']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_spanning_tree_global_module.rst b/docs/cisco.nxos.nxos_spanning_tree_global_module.rst deleted file mode 100644 index 5b1c17af8..000000000 --- a/docs/cisco.nxos.nxos_spanning_tree_global_module.rst +++ /dev/null @@ -1,473 +0,0 @@ -.. _cisco.nxos.nxos_spanning_tree_global_module: - - -************************************ -cisco.nxos.nxos_spanning_tree_global -************************************ - -**Resource module to configure spanning tree.** - - -Version added: 6.0.3 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module configures and manages the attributes of Spanning-tree on Cisco NXOS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A dict of Spanning-tree options.
-
-
- bridge_assurance - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable bridge assurance.
-
-
- bridge_domain - -
- string -
- 		- -
-
- fcoe - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable STP for FCoE VLANs.
-
-
- lc_issu - -
- string -
- 		-
    Choices: -
  • auto
    • -
  • disruptive
    • -
  • non-disruptive
    • -
- 		-
Configure Linecard ISSU type.
-
-
- loopguard_default - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Spanning tree loopguard .
-
-
- mode - -
- string -
- 		-
    Choices: -
  • mst
    • -
  • rapid-pvst
    • -
- 		-
Spanning tree mode.
-
-
- pathcost_method - -
- string -
- 		-
    Choices: -
  • long
    • -
  • short
    • -
- 		-
Spanning tree pathcost options.
-
-
- port_type - -
- dictionary -
- 		- -
Spanning tree port type.
-
-
- default - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable default port type.
-
-
- edge - -
- string -
- 		-
    Choices: -
  • bpdufilter
    • -
  • bpduguard
    • -
  • default
    • -
- 		-
Enable edge port type.
-
-
- network - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable network port type.
-
-
- vlan - -
- string -
- 		- -
Spanning tree VLAN range.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NXOS device by executing the command show running-config | section ^spanning-tree.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • rendered
    • -
  • gathered
    • -
  • purged
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in
-
The states rendered, gathered and parsed does not perform any change on the device.
-
The state rendered will transform the configuration in config option to platform specific CLI commands which will be returned in the rendered key within the result. For state rendered active connection to remote host is not required.
-
The state gathered will fetch the running configuration from device and transform it into structured data in the format as per the resource module argspec and the value is returned in the gathered key within the result.
-
The state parsed reads the configuration from running_config option and transforms it into JSON format as per the resource module parameters and the value is returned in the parsed key within the result. The value of running_config option should be the same format as the output of command show running-config | include ip route|ipv6 route executed on device. For state parsed active connection to remote host is not required.
-
The state purged negates virtual/logical interfaces that are specified in task from running-config.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - This module works with connection ``network_cli`` and ``httpapi``. See https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html - - - - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['sample command 1', 'sample command 2', 'sample command 3']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['sample command 1', 'sample command 2', 'sample command 3']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Vinay Mulugund (@roverflow) diff --git a/docs/cisco.nxos.nxos_udld_interface_module.rst b/docs/cisco.nxos.nxos_udld_interface_module.rst deleted file mode 100644 index cba2733c0..000000000 --- a/docs/cisco.nxos.nxos_udld_interface_module.rst +++ /dev/null @@ -1,250 +0,0 @@ -.. _cisco.nxos.nxos_udld_interface_module: - - -****************************** -cisco.nxos.nxos_udld_interface -****************************** - -**Manages UDLD interface configuration params.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages UDLD interface configuration params. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- interface - -
- string - / required -
- 		- -
FULL name of the interface, i.e. Ethernet1/1-
-
-
- mode - -
- string - / required -
- 		-
    Choices: -
  • enabled
    • -
  • disabled
    • -
  • aggressive
    • -
- 		-
Manages UDLD mode for an interface.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Feature UDLD must be enabled on the device to use this module. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure Ethernet1/1 is configured to be in aggressive mode - - cisco.nxos.nxos_udld_interface: - interface: Ethernet1/1 - mode: aggressive - state: present - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - # Remove the aggressive config only if it's currently in aggressive mode and then disable udld (switch default) - - cisco.nxos.nxos_udld_interface: - interface: Ethernet1/1 - mode: aggressive - state: absent - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - # ensure Ethernet1/1 has aggressive mode enabled - - cisco.nxos.nxos_udld_interface: - interface: Ethernet1/1 - mode: enabled - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- end_state - -
- dictionary -
- 		always -
k/v pairs of configuration after module execution
-
-
Sample:
-
{'mode': 'enabled'}
-
-
- existing - -
- dictionary -
- 		always -
k/v pairs of existing configuration
-
-
Sample:
-
{'mode': 'aggressive'}
-
-
- proposed - -
- dictionary -
- 		always -
k/v pairs of parameters passed into module
-
-
Sample:
-
{'mode': 'enabled'}
-
-
- updates - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['interface ethernet1/33', 'no udld aggressive ; no udld disable']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_udld_module.rst b/docs/cisco.nxos.nxos_udld_module.rst deleted file mode 100644 index dc461bc89..000000000 --- a/docs/cisco.nxos.nxos_udld_module.rst +++ /dev/null @@ -1,256 +0,0 @@ -.. _cisco.nxos.nxos_udld_module: - - -******************** -cisco.nxos.nxos_udld -******************** - -**Manages UDLD global configuration params.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages UDLD global configuration params. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggressive - -
- string -
- 		-
    Choices: -
  • enabled
    • -
  • disabled
    • -
- 		-
Toggles aggressive mode.
-
-
- msg_time - -
- string -
- 		- -
Message time in seconds for UDLD packets or keyword 'default'.
-
-
- reset - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ability to reset all ports shut down by UDLD. 'state' parameter cannot be 'absent' when this is present.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource. When set to 'absent', aggressive and msg_time are set to their default values.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Module will fail if the udld feature has not been previously enabled. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure udld aggressive mode is globally disabled and se global message interval is 20 - - cisco.nxos.nxos_udld: - aggressive: disabled - msg_time: 20 - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - # Ensure agg mode is globally enabled and msg time is 15 - - cisco.nxos.nxos_udld: - aggressive: enabled - msg_time: 15 - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- end_state - -
- dictionary -
- 		always -
k/v pairs of udld configuration after module execution
-
-
Sample:
-
{'aggressive': 'enabled', 'msg_time': '40'}
-
-
- existing - -
- dictionary -
- 		always -
k/v pairs of existing udld configuration
-
-
Sample:
-
{'aggressive': 'disabled', 'msg_time': '15'}
-
-
- proposed - -
- dictionary -
- 		always -
k/v pairs of parameters passed into module
-
-
Sample:
-
{'aggressive': 'enabled', 'msg_time': '40'}
-
-
- updates - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['udld message-time 40', 'udld aggressive']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_user_module.rst b/docs/cisco.nxos.nxos_user_module.rst deleted file mode 100644 index a03a23a03..000000000 --- a/docs/cisco.nxos.nxos_user_module.rst +++ /dev/null @@ -1,390 +0,0 @@ -.. _cisco.nxos.nxos_user_module: - - -******************** -cisco.nxos.nxos_user -******************** - -**Manage the collection of local users on Nexus devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module provides declarative management of the local usernames configured on Cisco Nexus devices. It allows playbooks to manage either individual usernames or the collection of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
The set of username objects to be configured on the remote Cisco Nexus device. The list entries can either be the username or a hash of username and properties. This argument is mutually exclusive with the name argument.
-

aliases: users, collection
-
-
- configured_password - -
- string -
- 		- -
The password to be configured on the network device. The password needs to be provided in cleartext and it will be encrypted on the device.
-
-
- hashed_password - -
- string -
- 		- -
The hashed password to be configured on the network device. The password needs to already be encrypted.
-
-
- name - -
- string -
- 		- -
The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
-
-
- roles - -
- list - / elements=string -
- 		- -
The role argument configures the role for the username in the device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device.
-

aliases: role
-
-
- sshkey - -
- string -
- 		- -
The sshkey argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
- 		-
The state argument configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
-
-
- update_password - -
- string -
- 		-
    Choices: -
  • on_create
    • -
  • always
    • -
- 		-
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
-
-
- configured_password - -
- string -
- 		- -
The password to be configured on the network device. The password needs to be provided in cleartext and it will be encrypted on the device.
-
-
- hashed_password - -
- string -
- 		- -
The hashed password to be configured on the network device. The password needs to already be encrypted.
-
-
- name - -
- string -
- 		- -
The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
-
-
- purge - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
The purge argument instructs the module to consider the resource definition absolute. It will remove any previously configured usernames on the device with the exception of the `admin` user which cannot be deleted per nxos constraints.
-
-
- roles - -
- list - / elements=string -
- 		- -
The role argument configures the role for the username in the device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device.
-

aliases: role
-
-
- sshkey - -
- string -
- 		- -
The sshkey argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
The state argument configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
-
-
- update_password - -
- string -
- 		-
    Choices: -
  • on_create
    • -
  • always ←
    • -
- 		-
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
-
-
- - -Notes ------ - -.. note:: - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: create a new user - cisco.nxos.nxos_user: - name: ansible - sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}" - state: present - - - name: remove all users except admin - cisco.nxos.nxos_user: - purge: true - - - name: set multiple users role - cisco.nxos.nxos_user: - aggregate: - - name: netop - - name: netend - role: network-operator - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['name ansible', 'name ansible password password']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_vpc_module.rst b/docs/cisco.nxos.nxos_vpc_module.rst deleted file mode 100644 index 9e0ca3c29..000000000 --- a/docs/cisco.nxos.nxos_vpc_module.rst +++ /dev/null @@ -1,352 +0,0 @@ -.. _cisco.nxos.nxos_vpc_module: - - -******************* -cisco.nxos.nxos_vpc -******************* - -**Manages global VPC configuration** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages global VPC configuration - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- auto_recovery - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/Disables auto recovery on platforms that support disable
-
timers are not modifiable with this attribute
-
mutually exclusive with auto_recovery_reload_delay
-
-
- auto_recovery_reload_delay - -
- string -
- 		- -
Manages auto-recovery reload-delay timer in seconds
-
mutually exclusive with auto_recovery
-
-
- delay_restore - -
- string -
- 		- -
manages delay restore command and config value in seconds
-
-
- delay_restore_interface_vlan - -
- string -
- 		- -
manages delay restore interface-vlan command and config value in seconds
-
not supported on all platforms
-
-
- delay_restore_orphan_port - -
- string -
- 		- -
manages delay restore orphan-port command and config value in seconds
-
not supported on all platforms
-
-
- domain - -
- string - / required -
- 		- -
VPC domain
-
-
- peer_gw - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/Disables peer gateway
-
-
- pkl_dest - -
- string -
- 		- -
Destination (remote) IP address used for peer keepalive link
-
pkl_dest is required whenever pkl options are used.
-
-
- pkl_src - -
- string -
- 		- -
Source IP address used for peer keepalive link
-
-
- pkl_vrf - -
- string -
- 		- -
VRF used for peer keepalive link
-
The VRF must exist on the device before using pkl_vrf.
-
(Note) 'default' is an overloaded term: Default vrf context for pkl_vrf is 'management'; 'pkl_vrf: default' refers to the literal 'default' rib.
-
-
- role_priority - -
- string -
- 		- -
Role priority for device. Remember lower is better.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manages desired state of the resource
-
-
- system_priority - -
- string -
- 		- -
System priority device. Remember they must match between peers.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - The feature vpc must be enabled before this module can be used - - If not using management vrf, vrf must be globally on the device before using in the pkl config - - Although source IP isn't required on the command line it is required when using this module. The PKL VRF must also be configured prior to using this module. - - Both pkl_src and pkl_dest are needed when changing PKL VRF. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: configure a simple asn - cisco.nxos.nxos_vpc: - domain: 100 - role_priority: 1000 - system_priority: 2000 - pkl_dest: 192.168.100.4 - pkl_src: 10.1.100.20 - peer_gw: true - auto_recovery: true - - - name: configure - cisco.nxos.nxos_vpc: - domain: 100 - role_priority: 32667 - system_priority: 2000 - peer_gw: true - pkl_src: 10.1.100.2 - pkl_dest: 192.168.100.4 - auto_recovery: true - - - name: Configure VPC with delay restore and existing keepalive VRF - cisco.nxos.nxos_vpc: - domain: 10 - role_priority: 28672 - system_priority: 2000 - delay_restore: 180 - peer_gw: true - pkl_src: 1.1.1.2 - pkl_dest: 1.1.1.1 - pkl_vrf: vpckeepalive - auto_recovery: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['vpc domain 100', 'peer-keepalive destination 192.168.100.4 source 10.1.100.20 vrf management', 'auto-recovery', 'peer-gateway']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vrf_af_module.rst b/docs/cisco.nxos.nxos_vrf_af_module.rst deleted file mode 100644 index 236991587..000000000 --- a/docs/cisco.nxos.nxos_vrf_af_module.rst +++ /dev/null @@ -1,300 +0,0 @@ -.. _cisco.nxos.nxos_vrf_af_module: - - -********************** -cisco.nxos.nxos_vrf_af -********************** - -**Manages VRF AF.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages VRF AF - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
Address-Family Identifier (AFI).
-
-
- route_target_both_auto_evpn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable the EVPN route-target 'auto' setting for both import and export target communities.
-
-
- route_targets - -
- list - / elements=dictionary -
- 		- -
Specify the route-targets which should be imported and/or exported under the AF. This argument accepts a list of dicts that specify the route-target, the direction (import|export|both) and state of each route-target. Default direction is direction=both. See examples.
-
-
- direction - -
- string -
- 		-
    Choices: -
  • import
    • -
  • export
    • -
  • both ←
    • -
- 		-
Indicates the direction of the route-target (import|export|both)
-
-
- rt - -
- string - / required -
- 		- -
Defines the route-target itself
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Determines whether the route-target with the given direction should be present or not on the device.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Determines whether the config should be present or not on the device.
-
-
- vrf - -
- string - / required -
- 		- -
Name of the VRF.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Default, where supported, restores params default value. - - In case of ``state=absent`` the address-family configuration will be absent. Therefore the options ``route_target_both_auto_evpn`` and ``route_targets`` are ignored. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_target_both_auto_evpn: true - state: present - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_targets: - - rt: '65000:1000' - direction: import - - rt: '65001:1000' - direction: import - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_targets: - - rt: '65000:1000' - direction: import - - rt: '65001:1000' - state: absent - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_targets: - - rt: '65000:1000' - direction: export - - rt: '65001:1000' - direction: export - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_targets: - - rt: '65000:1000' - direction: export - state: absent - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_targets: - - rt: '65000:1000' - direction: both - state: present - - rt: '65001:1000' - direction: import - state: present - - rt: '65002:1000' - direction: both - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['vrf context ntc', 'address-family ipv4 unicast']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vrf_module.rst b/docs/cisco.nxos.nxos_vrf_module.rst deleted file mode 100644 index 6765f78b5..000000000 --- a/docs/cisco.nxos.nxos_vrf_module.rst +++ /dev/null @@ -1,494 +0,0 @@ -.. _cisco.nxos.nxos_vrf_module: - - -******************* -cisco.nxos.nxos_vrf -******************* - -**Manages global VRF configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module provides declarative management of VRFs on CISCO NXOS network devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- admin_state - -
- string -
- 		-
    Choices: -
  • up ←
    • -
  • down
    • -
- 		-
Administrative state of the VRF.
-
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
List of VRFs definitions.
-
-
- admin_state - -
- string -
- 		-
    Choices: -
  • up
    • -
  • down
    • -
- 		-
Administrative state of the VRF.
-
-
- associated_interfaces - -
- list - / elements=string -
- 		- -
This is a intent option and checks the operational state of the for given vrf name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vrf interfaces on device it will result in failure.
-
-
- delay - -
- integer -
- 		- -
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
-
-
- description - -
- string -
- 		- -
Description of the VRF or keyword 'default'.
-
-
- interfaces - -
- list - / elements=string -
- 		- -
List of interfaces to check the VRF has been configured correctly or keyword 'default'.
-
-
- name - -
- string -
- 		- -
Name of VRF to be managed.
-

aliases: vrf
-
-
- rd - -
- string -
- 		- -
VPN Route Distinguisher (RD). Valid values are a string in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword 'auto', or the keyword 'default'.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
- 		-
Manages desired state of the resource.
-
-
- vni - -
- string -
- 		- -
Specify virtual network identifier. Valid values are Integer or keyword 'default'.
-
-
- associated_interfaces - -
- list - / elements=string -
- 		- -
This is a intent option and checks the operational state of the for given vrf name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vrf interfaces on device it will result in failure.
-
-
- delay - -
- integer -
- 		- Default:
10
- 		-
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
-
-
- description - -
- string -
- 		- -
Description of the VRF or keyword 'default'.
-
-
- interfaces - -
- list - / elements=string -
- 		- -
List of interfaces to check the VRF has been configured correctly or keyword 'default'.
-
-
- name - -
- string -
- 		- -
Name of VRF to be managed.
-

aliases: vrf
-
-
- purge - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Purge VRFs not defined in the aggregate parameter.
-
-
- rd - -
- string -
- 		- -
VPN Route Distinguisher (RD). Valid values are a string in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword 'auto', or the keyword 'default'.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manages desired state of the resource.
-
-
- vni - -
- string -
- 		- -
Specify virtual network identifier. Valid values are Integer or keyword 'default'.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Cisco NX-OS creates the default VRF by itself. Therefore, you're not allowed to use default as *vrf* name in this module. - - ``vrf`` name must be shorter than 32 chars. - - VRF names are not case sensible in NX-OS. Anyway, the name is stored just like it's inserted by the user and it'll not be changed again unless the VRF is removed and re-created. i.e. ``vrf=NTC`` will create a VRF named NTC, but running it again with ``vrf=ntc`` will not cause a configuration change. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Ensure ntc VRF exists on switch - cisco.nxos.nxos_vrf: - name: ntc - description: testing - state: present - - name: Aggregate definition of VRFs - cisco.nxos.nxos_vrf: - aggregate: - - name: test1 - description: Testing - admin_state: down - - name: test2 - interfaces: Ethernet1/2 - - name: Aggregate definitions of VRFs with Purge - cisco.nxos.nxos_vrf: - aggregate: - - name: ntc1 - description: purge test1 - - name: ntc2 - description: purge test2 - state: present - purge: true - - name: Delete VRFs exist on switch - cisco.nxos.nxos_vrf: - aggregate: - - name: ntc1 - - name: ntc2 - state: absent - - name: Assign interfaces to VRF declaratively - cisco.nxos.nxos_vrf: - name: test1 - interfaces: - - Ethernet2/3 - - Ethernet2/5 - - name: Check interfaces assigned to VRF - cisco.nxos.nxos_vrf: - name: test1 - associated_interfaces: - - Ethernet2/3 - - Ethernet2/5 - - name: >- - Ensure VRF is tagged with interface Ethernet2/5 only (Removes from - Ethernet2/3) - cisco.nxos.nxos_vrf: - name: test1 - interfaces: - - Ethernet2/5 - - name: Delete VRF - cisco.nxos.nxos_vrf: - name: ntc - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['vrf context ntc', 'no shutdown', 'interface Ethernet1/2', 'no switchport', 'vrf member test2']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_vrrp_module.rst b/docs/cisco.nxos.nxos_vrrp_module.rst deleted file mode 100644 index 88183c5af..000000000 --- a/docs/cisco.nxos.nxos_vrrp_module.rst +++ /dev/null @@ -1,277 +0,0 @@ -.. _cisco.nxos.nxos_vrrp_module: - - -******************** -cisco.nxos.nxos_vrrp -******************** - -**Manages VRRP configuration on NX-OS switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages VRRP configuration on NX-OS switches. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- admin_state - -
- string -
- 		-
    Choices: -
  • shutdown ←
    • -
  • no shutdown
    • -
  • default
    • -
- 		-
Used to enable or disable the VRRP process.
-
-
- authentication - -
- string -
- 		- -
Clear text authentication string or 'default' keyword
-
-
- group - -
- string - / required -
- 		- -
VRRP group number.
-
-
- interface - -
- string - / required -
- 		- -
Full name of interface that is being managed for VRRP.
-
-
- interval - -
- string -
- 		- -
Time interval between advertisement or 'default' keyword
-
-
- preempt - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable preempt.
-
-
- priority - -
- string -
- 		- -
VRRP priority or 'default' keyword
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Specify desired state of the resource.
-
-
- vip - -
- string -
- 		- -
VRRP virtual IP address or 'default' keyword
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - VRRP feature needs to be enabled first on the system. - - SVIs must exist before using this module. - - Interface must be a L3 port before using this module. - - ``state=absent`` removes the VRRP group if it exists on the device. - - VRRP cannot be configured on loopback interfaces. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Ensure vrrp group 100 and vip 10.1.100.1 is on vlan10 - cisco.nxos.nxos_vrrp: - interface: vlan10 - group: 100 - vip: 10.1.100.1 - - - name: Ensure removal of the vrrp group config - cisco.nxos.nxos_vrrp: - interface: vlan10 - group: 100 - vip: 10.1.100.1 - state: absent - - - name: Re-config with more params - cisco.nxos.nxos_vrrp: - interface: vlan10 - group: 100 - vip: 10.1.100.1 - preempt: false - priority: 130 - authentication: AUTHKEY - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['interface vlan10', 'vrrp 150', 'address 10.1.15.1', 'authentication text testing', 'no shutdown']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vsan_module.rst b/docs/cisco.nxos.nxos_vsan_module.rst deleted file mode 100644 index 9baa64c68..000000000 --- a/docs/cisco.nxos.nxos_vsan_module.rst +++ /dev/null @@ -1,225 +0,0 @@ -.. _cisco.nxos.nxos_vsan_module: - - -******************** -cisco.nxos.nxos_vsan -******************** - -**Configuration of vsan for Cisco NXOS MDS Switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configuration of vsan for Cisco MDS NXOS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- vsan - -
- list - / elements=dictionary -
- 		- -
List of vsan details to be added or removed
-
-
- id - -
- integer - / required -
- 		- -
Vsan id
-
-
- interface - -
- list - / elements=string -
- 		- -
List of vsan's interfaces to be added
-
-
- name - -
- string -
- 		- -
Name of the vsan
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Removes the vsan if True
-
-
- suspend - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
suspend the vsan if True
-
-
- - -Notes ------ - -.. note:: - - Tested against Cisco MDS NX-OS 8.4(1) - - - -Examples --------- - -.. code-block:: yaml - - - name: Test that vsan module works - cisco.nxos.nxos_vsan: - vsan: - - id: 922 - interface: - - fc1/1 - - fc1/2 - - port-channel 1 - name: vsan-SAN-A - remove: false - suspend: false - - id: 923 - interface: - - fc1/11 - - fc1/21 - - port-channel 2 - name: vsan-SAN-B - remove: false - suspend: true - - id: 1923 - name: vsan-SAN-Old - remove: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['terminal dont-ask', 'vsan database', 'vsan 922 interface fc1/40', 'vsan 922 interface port-channel 155', 'no terminal dont-ask']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) diff --git a/docs/cisco.nxos.nxos_vxlan_vtep_module.rst b/docs/cisco.nxos.nxos_vxlan_vtep_module.rst deleted file mode 100644 index 57fdc14a3..000000000 --- a/docs/cisco.nxos.nxos_vxlan_vtep_module.rst +++ /dev/null @@ -1,332 +0,0 @@ -.. _cisco.nxos.nxos_vxlan_vtep_module: - - -************************** -cisco.nxos.nxos_vxlan_vtep -************************** - -**Manages VXLAN Network Virtualization Endpoint (NVE).** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages VXLAN Network Virtualization Endpoint (NVE) overlay interface that terminates VXLAN tunnels. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- advertise_virtual_rmac - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
The advertise_virtual_rmac parameter lets BGP to use the VMAC with VIP as next-hop when advertising type-2 routes. Should be used together with advertise_pip parameter from cisco.nxos.nxos_bgp_address_family module.
-
-
- description - -
- string -
- 		- -
Description of the NVE interface.
-
-
- global_ingress_replication_bgp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configures ingress replication protocol as bgp for all VNIs. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
-
-
- global_mcast_group_L2 - -
- string -
- 		- -
Global multicast IP prefix for L2 VNIs or the keyword 'default'. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
-
-
- global_mcast_group_L3 - -
- string -
- 		- -
Global multicast IP prefix for L3 VNIs or the keyword 'default'. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
-
-
- global_suppress_arp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables ARP suppression for all VNIs. This is available on NX-OS 9K series running 9.2.x or higher.
-
-
- host_reachability - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify mechanism for host reachability advertisement. A Boolean value of 'true' indicates that BGP will be used for host reachability advertisement. A Boolean value of 'false' indicates that no protocol is used for host reachability advertisement. Other host reachability advertisement protocols (e.g. OpenFlow, controller, etc.) are not supported.
-
-
- interface - -
- string - / required -
- 		- -
Interface name for the VXLAN Network Virtualization Endpoint.
-
-
- multisite_border_gateway_interface - -
- string -
-
added in 1.1.0
- 		- -
Specify the loopback interface whose IP address should be used for the NVE Multisite Border-gateway Interface. This is available on specific Nexus 9000 series switches running NX-OS 7.0(3)I7(x) or higher. Specify "default" to remove an existing gateway config.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively shutdown the NVE interface.
-
-
- source_interface - -
- string -
- 		- -
Specify the loopback interface whose IP address should be used for the NVE interface.
-
-
- source_interface_hold_down_time - -
- string -
- 		- -
Suppresses advertisement of the NVE loopback address until the overlay has converged.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Determines whether the config should be present or not on the device.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - The module is used to manage NVE properties, not to create NVE interfaces. Use :ref:`cisco.nxos.nxos_interfaces ` if you wish to do so. - - ``state=absent`` removes the interface. - - Default, where supported, restores params default value. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_vxlan_vtep: - interface: nve1 - description: default - host_reachability: true - source_interface: Loopback0 - source_interface_hold_down_time: 30 - shutdown: default - multisite_border_gateway_interface: Loopback0 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['interface nve1', 'source-interface loopback0', 'source-interface hold-down-time 30', 'description simple description', 'shutdown', 'host-reachability protocol bgp', 'multisite border-gateway interface loopback0']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_zone_zoneset_module.rst b/docs/cisco.nxos.nxos_zone_zoneset_module.rst deleted file mode 100644 index 95ef4972a..000000000 --- a/docs/cisco.nxos.nxos_zone_zoneset_module.rst +++ /dev/null @@ -1,537 +0,0 @@ -.. _cisco.nxos.nxos_zone_zoneset_module: - - -**************************** -cisco.nxos.nxos_zone_zoneset -**************************** - -**Configuration of zone/zoneset for Cisco NXOS MDS Switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configuration of zone/zoneset for Cisco MDS NXOS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- zone_zoneset_details - -
- list - / elements=dictionary -
- 		- -
List of zone/zoneset details to be added or removed
-
-
- default_zone - -
- string -
- 		-
    Choices: -
  • permit
    • -
  • deny
    • -
- 		-
default zone behaviour for the vsan
-
-
- mode - -
- string -
- 		-
    Choices: -
  • enhanced
    • -
  • basic
    • -
- 		-
mode of the zone for the vsan
-
-
- smart_zoning - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Removes the vsan if True
-
-
- vsan - -
- integer - / required -
- 		- -
vsan id
-
-
- zone - -
- list - / elements=dictionary -
- 		- -
List of zone options for that vsan
-
-
- members - -
- list - / elements=dictionary -
- 		- -
Members of the zone that needs to be removed or added
-
-
- devtype - -
- string -
- 		-
    Choices: -
  • initiator
    • -
  • target
    • -
  • both
    • -
- 		-
devtype of the zone member used along with Smart zoning config
-
-
- pwwn - -
- string - / required -
- 		- -
pwwn member of the zone, use alias 'device_alias' as option for device_alias member
-

aliases: device_alias
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Removes member from the zone if True
-
-
- name - -
- string - / required -
- 		- -
name of the zone
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Deletes the zone if True
-
-
- zoneset - -
- list - / elements=dictionary -
- 		- -
List of zoneset options for the vsan
-
-
- action - -
- string -
- 		-
    Choices: -
  • activate
    • -
  • deactivate
    • -
- 		-
activates/de-activates the zoneset
-
-
- members - -
- list - / elements=dictionary -
- 		- -
Members of the zoneset that needs to be removed or added
-
-
- name - -
- string - / required -
- 		- -
name of the zone that needs to be added to the zoneset or removed from the zoneset
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Removes zone member from the zoneset
-
-
- name - -
- string - / required -
- 		- -
name of the zoneset
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Removes zoneset if True
-
-
- - -Notes ------ - -.. note:: - - Tested against Cisco MDS NX-OS 8.4(1) - - - -Examples --------- - -.. code-block:: yaml - - - name: Test that zone/zoneset module works - cisco.nxos.nxos_zone_zoneset: - zone_zoneset_details: - - mode: enhanced - vsan: 22 - zone: - - members: - - pwwn: 31314874576271 - - device_alias: test123 - - pwwn: '61:61:62:62:12:12:12:12' - remove: true - name: zoneA - - members: - - pwwn: 28515514576271 - - pwwn: '62:62:62:62:21:21:21:21' - name: zoneB - - name: zoneC - remove: true - zoneset: - - action: activate - members: - - name: zoneA - - name: zoneB - - name: zoneC - remove: true - name: zsetname1 - - action: deactivate - name: zsetTestExtra - remove: true - - mode: basic - smart_zoning: true - vsan: 21 - zone: - - members: - - devtype: both - pwwn: 31314874576271 - - pwwn: '62:62:62:62:12:12:12:12' - - devtype: both - pwwn: '92:62:62:62:12:12:1a:1a' - remove: true - name: zone21A - - members: - - pwwn: 28515514576271 - - pwwn: '62:62:62:62:21:21:21:21' - name: zone21B - zoneset: - - action: activate - members: - - name: zone21A - - name: zone21B - name: zsetname212 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['terminal dont-ask', 'zone name zoneA vsan 923', 'member pwwn 11:11:11:11:11:11:11:11', 'no member device-alias test123', 'zone commit vsan 923', 'no terminal dont-ask']
-
-
- messages - -
- list -
- 		always -
debug messages
-
-
Sample:
-
['zone mode is already enhanced ,no change in zone mode configuration for vsan 922', "zone member '11:11:11:11:11:11:11:11' is already present in zone 'zoneA' in vsan 922 hence nothing to add", "zone member 'test123' is already present in zone 'zoneA' in vsan 922 hence nothing to add", "zone member '61:61:62:62:12:12:12:12' is not present in zone 'zoneA' in vsan 922 hence nothing to remove", "zone member '10:11:11:11:11:11:11:11' is already present in zone 'zoneB' in vsan 922 hence nothing to add", "zone member '62:62:62:62:21:21:21:21' is already present in zone 'zoneB' in vsan 922 hence nothing to add", "zone 'zoneC' is not present in vsan 922 , so nothing to remove"]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) From 48f471e6019a38c80225b1182dffab50f549607b Mon Sep 17 00:00:00 2001 From: Vinay Mulugund Date: Thu, 7 Mar 2024 19:45:59 +0530 Subject: [PATCH 10/30] precommit issue --- ...cisco.nxos.nxos_aaa_server_host_module.rst | 343 + docs/cisco.nxos.nxos_aaa_server_module.rst | 248 + .../cisco.nxos.nxos_acl_interfaces_module.rst | 610 ++ docs/cisco.nxos.nxos_acls_module.rst | 4086 ++++++++++++ docs/cisco.nxos.nxos_banner_module.rst | 187 + docs/cisco.nxos.nxos_bfd_global_module.rst | 326 + .../cisco.nxos.nxos_bfd_interfaces_module.rst | 394 ++ docs/cisco.nxos.nxos_bgp_global_module.rst | 5843 +++++++++++++++++ ...xos_bgp_neighbor_address_family_module.rst | 3575 ++++++++++ docs/cisco.nxos.nxos_bgp_templates_module.rst | 2841 ++++++++ docs/cisco.nxos.nxos_command_module.rst | 258 + docs/cisco.nxos.nxos_config_module.rst | 566 ++ docs/cisco.nxos.nxos_devicealias_module.rst | 273 + docs/cisco.nxos.nxos_evpn_global_module.rst | 122 + docs/cisco.nxos.nxos_evpn_vni_module.rst | 212 + docs/cisco.nxos.nxos_facts_module.rst | 553 ++ docs/cisco.nxos.nxos_feature_module.rst | 150 + docs/cisco.nxos.nxos_gir_module.rst | 302 + ...xos.nxos_gir_profile_management_module.rst | 235 + docs/cisco.nxos.nxos_hostname_module.rst | 344 + ...cisco.nxos.nxos_hsrp_interfaces_module.rst | 344 + docs/cisco.nxos.nxos_hsrp_module.rst | 305 + docs/cisco.nxos.nxos_igmp_module.rst | 191 + docs/cisco.nxos.nxos_igmp_snooping_module.rst | 225 + docs/cisco.nxos.nxos_install_os_module.rst | 183 + docs/cisco.nxos.nxos_l2_interfaces_module.rst | 648 ++ docs/cisco.nxos.nxos_l3_interfaces_module.rst | 884 +++ docs/cisco.nxos.nxos_lacp_module.rst | 402 ++ ...cisco.nxos.nxos_lldp_interfaces_module.rst | 407 ++ docs/cisco.nxos.nxos_logging_module.rst | 458 ++ docs/cisco.nxos.nxos_ntp_auth_module.rst | 224 + docs/cisco.nxos.nxos_ntp_global_module.rst | 1411 ++++ docs/cisco.nxos.nxos_ntp_module.rst | 314 + docs/cisco.nxos.nxos_ntp_options_module.rst | 192 + docs/cisco.nxos.nxos_nxapi_module.rst | 300 + ...cisco.nxos.nxos_ospf_interfaces_module.rst | 1732 +++++ docs/cisco.nxos.nxos_ospfv2_module.rst | 5458 +++++++++++++++ .../cisco.nxos.nxos_overlay_global_module.rst | 120 + docs/cisco.nxos.nxos_pim_module.rst | 148 + docs/cisco.nxos.nxos_ping_module.rst | 311 + docs/cisco.nxos.nxos_prefix_lists_module.rst | 1049 +++ docs/cisco.nxos.nxos_reboot_module.rst | 123 + docs/cisco.nxos.nxos_rollback_module.rst | 159 + docs/cisco.nxos.nxos_route_maps_module.rst | 4368 ++++++++++++ docs/cisco.nxos.nxos_rpm_module.rst | 226 + docs/cisco.nxos.nxos_snapshot_module.rst | 363 + .../cisco.nxos.nxos_snmp_community_module.rst | 201 + docs/cisco.nxos.nxos_snmp_host_module.rst | 288 + docs/cisco.nxos.nxos_snmp_location_module.rst | 156 + docs/cisco.nxos.nxos_snmp_server_module.rst | 4474 +++++++++++++ docs/cisco.nxos.nxos_snmp_traps_module.rst | 189 + docs/cisco.nxos.nxos_snmp_user_module.rst | 235 + .../cisco.nxos.nxos_udld_interface_module.rst | 250 + docs/cisco.nxos.nxos_udld_module.rst | 256 + docs/cisco.nxos.nxos_user_module.rst | 390 ++ docs/cisco.nxos.nxos_vpc_module.rst | 352 + docs/cisco.nxos.nxos_vrf_af_module.rst | 300 + docs/cisco.nxos.nxos_vrf_module.rst | 494 ++ docs/cisco.nxos.nxos_vrrp_module.rst | 277 + docs/cisco.nxos.nxos_vsan_module.rst | 225 + docs/cisco.nxos.nxos_vxlan_vtep_module.rst | 332 + docs/cisco.nxos.nxos_zone_zoneset_module.rst | 537 ++ .../spanning_tree_global.py | 6 +- plugins/modules/nxos_spanning_tree_global.py | 13 +- 64 files changed, 50979 insertions(+), 9 deletions(-) create mode 100644 docs/cisco.nxos.nxos_aaa_server_host_module.rst create mode 100644 docs/cisco.nxos.nxos_aaa_server_module.rst create mode 100644 docs/cisco.nxos.nxos_acl_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_acls_module.rst create mode 100644 docs/cisco.nxos.nxos_banner_module.rst create mode 100644 docs/cisco.nxos.nxos_bfd_global_module.rst create mode 100644 docs/cisco.nxos.nxos_bfd_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_bgp_global_module.rst create mode 100644 docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst create mode 100644 docs/cisco.nxos.nxos_bgp_templates_module.rst create mode 100644 docs/cisco.nxos.nxos_command_module.rst create mode 100644 docs/cisco.nxos.nxos_config_module.rst create mode 100644 docs/cisco.nxos.nxos_devicealias_module.rst create mode 100644 docs/cisco.nxos.nxos_evpn_global_module.rst create mode 100644 docs/cisco.nxos.nxos_evpn_vni_module.rst create mode 100644 docs/cisco.nxos.nxos_facts_module.rst create mode 100644 docs/cisco.nxos.nxos_feature_module.rst create mode 100644 docs/cisco.nxos.nxos_gir_module.rst create mode 100644 docs/cisco.nxos.nxos_gir_profile_management_module.rst create mode 100644 docs/cisco.nxos.nxos_hostname_module.rst create mode 100644 docs/cisco.nxos.nxos_hsrp_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_hsrp_module.rst create mode 100644 docs/cisco.nxos.nxos_igmp_module.rst create mode 100644 docs/cisco.nxos.nxos_igmp_snooping_module.rst create mode 100644 docs/cisco.nxos.nxos_install_os_module.rst create mode 100644 docs/cisco.nxos.nxos_l2_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_l3_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_lacp_module.rst create mode 100644 docs/cisco.nxos.nxos_lldp_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_logging_module.rst create mode 100644 docs/cisco.nxos.nxos_ntp_auth_module.rst create mode 100644 docs/cisco.nxos.nxos_ntp_global_module.rst create mode 100644 docs/cisco.nxos.nxos_ntp_module.rst create mode 100644 docs/cisco.nxos.nxos_ntp_options_module.rst create mode 100644 docs/cisco.nxos.nxos_nxapi_module.rst create mode 100644 docs/cisco.nxos.nxos_ospf_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_ospfv2_module.rst create mode 100644 docs/cisco.nxos.nxos_overlay_global_module.rst create mode 100644 docs/cisco.nxos.nxos_pim_module.rst create mode 100644 docs/cisco.nxos.nxos_ping_module.rst create mode 100644 docs/cisco.nxos.nxos_prefix_lists_module.rst create mode 100644 docs/cisco.nxos.nxos_reboot_module.rst create mode 100644 docs/cisco.nxos.nxos_rollback_module.rst create mode 100644 docs/cisco.nxos.nxos_route_maps_module.rst create mode 100644 docs/cisco.nxos.nxos_rpm_module.rst create mode 100644 docs/cisco.nxos.nxos_snapshot_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_community_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_host_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_location_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_server_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_traps_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_user_module.rst create mode 100644 docs/cisco.nxos.nxos_udld_interface_module.rst create mode 100644 docs/cisco.nxos.nxos_udld_module.rst create mode 100644 docs/cisco.nxos.nxos_user_module.rst create mode 100644 docs/cisco.nxos.nxos_vpc_module.rst create mode 100644 docs/cisco.nxos.nxos_vrf_af_module.rst create mode 100644 docs/cisco.nxos.nxos_vrf_module.rst create mode 100644 docs/cisco.nxos.nxos_vrrp_module.rst create mode 100644 docs/cisco.nxos.nxos_vsan_module.rst create mode 100644 docs/cisco.nxos.nxos_vxlan_vtep_module.rst create mode 100644 docs/cisco.nxos.nxos_zone_zoneset_module.rst diff --git a/docs/cisco.nxos.nxos_aaa_server_host_module.rst b/docs/cisco.nxos.nxos_aaa_server_host_module.rst new file mode 100644 index 000000000..5730e6359 --- /dev/null +++ b/docs/cisco.nxos.nxos_aaa_server_host_module.rst @@ -0,0 +1,343 @@ +.. _cisco.nxos.nxos_aaa_server_host_module: + + +******************************* +cisco.nxos.nxos_aaa_server_host +******************************* + +**Manages AAA server host-specific configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages AAA server host-specific configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ acct_port + +
+ string +
+ 		+ +
Alternate UDP port for RADIUS accounting or keyword 'default'.
+
+
+ address + +
+ string + / required +
+ 		+ +
Address or name of the radius or tacacs host.
+
+
+ auth_port + +
+ string +
+ 		+ +
Alternate UDP port for RADIUS authentication or keyword 'default'.
+
+
+ encrypt_type + +
+ string +
+ 		+
    Choices: +
  • 0
    • +
  • 7
    • +
+ 		+
The state of encryption applied to the entered key. O for clear text, 7 for encrypted. Type-6 encryption is not supported.
+
+
+ host_timeout + +
+ string +
+ 		+ +
Timeout period for specified host, in seconds or keyword 'default. Range is 1-60.
+
+
+ key + +
+ string +
+ 		+ +
Shared secret for the specified host or keyword 'default'.
+
+
+ server_type + +
+ string + / required +
+ 		+
    Choices: +
  • radius
    • +
  • tacacs
    • +
+ 		+
The server type is either radius or tacacs.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ tacacs_port + +
+ string +
+ 		+ +
Alternate TCP port TACACS Server or keyword 'default'.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - Changes to the host key (shared secret) are not idempotent for type 0. + - If ``state=absent`` removes the whole host configuration. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Radius Server Host Basic settings + - name: Radius Server Host Basic settings + cisco.nxos.nxos_aaa_server_host: + state: present + server_type: radius + address: 1.2.3.4 + acct_port: 2084 + host_timeout: 10 + + # Radius Server Host Key Configuration + - name: Radius Server Host Key Configuration + cisco.nxos.nxos_aaa_server_host: + state: present + server_type: radius + address: 1.2.3.4 + key: hello + encrypt_type: 7 + + # TACACS Server Host Configuration + - name: Tacacs Server Host Configuration + cisco.nxos.nxos_aaa_server_host: + state: present + server_type: tacacs + tacacs_port: 89 + host_timeout: 10 + address: 5.6.7.8 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ end_state + +
+ dictionary +
+ 		always +
k/v pairs of configuration after module execution
+
+
Sample:
+
{'address': '1.2.3.4', 'auth_port': '2084', 'host_timeout': '10', 'server_type': 'radius'}
+
+
+ existing + +
+ dictionary +
+ 		always +
k/v pairs of existing configuration
+
+
+
+ proposed + +
+ dictionary +
+ 		always +
k/v pairs of parameters passed into module
+
+
Sample:
+
{'address': '1.2.3.4', 'auth_port': '2084', 'host_timeout': '10', 'server_type': 'radius'}
+
+
+ updates + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['radius-server host 1.2.3.4 auth-port 2084 timeout 10']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_aaa_server_module.rst b/docs/cisco.nxos.nxos_aaa_server_module.rst new file mode 100644 index 000000000..1307c9033 --- /dev/null +++ b/docs/cisco.nxos.nxos_aaa_server_module.rst @@ -0,0 +1,248 @@ +.. _cisco.nxos.nxos_aaa_server_module: + + +************************** +cisco.nxos.nxos_aaa_server +************************** + +**Manages AAA server global configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages AAA server global configuration + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ deadtime + +
+ string +
+ 		+ +
Duration for which a non-reachable AAA server is skipped, in minutes or keyword 'default. Range is 1-1440. Device default is 0.
+
+
+ directed_request + +
+ string +
+ 		+
    Choices: +
  • enabled
    • +
  • disabled
    • +
  • default
    • +
+ 		+
Enables direct authentication requests to AAA server or keyword 'default' Device default is disabled.
+
+
+ encrypt_type + +
+ string +
+ 		+
    Choices: +
  • 0
    • +
  • 7
    • +
+ 		+
The state of encryption applied to the entered global key. O clear text, 7 encrypted. Type-6 encryption is not supported.
+
+
+ global_key + +
+ string +
+ 		+ +
Global AAA shared secret or keyword 'default'.
+
+
+ server_timeout + +
+ string +
+ 		+ +
Global AAA server timeout period, in seconds or keyword 'default. Range is 1-60. Device default is 5.
+
+
+ server_type + +
+ string + / required +
+ 		+
    Choices: +
  • radius
    • +
  • tacacs
    • +
+ 		+
The server type is either radius or tacacs.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • default
    • +
+ 		+
Manage the state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - The server_type parameter is always required. + - If encrypt_type is not supplied, the global AAA server key will be stored as encrypted (type 7). + - Changes to the global AAA server key with encrypt_type=0 are not idempotent. + - state=default will set the supplied parameters to their default values. The parameters that you want to default must also be set to default. If global_key=default, the global key will be removed. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Radius Server Basic settings + - name: Radius Server Basic settings + cisco.nxos.nxos_aaa_server: + server_type: radius + server_timeout: 9 + deadtime: 20 + directed_request: enabled + + # Tacacs Server Basic settings + - name: Tacacs Server Basic settings + cisco.nxos.nxos_aaa_server: + server_type: tacacs + server_timeout: 8 + deadtime: 19 + directed_request: disabled + + # Setting Global Key + - name: AAA Server Global Key + cisco.nxos.nxos_aaa_server: + server_type: radius + global_key: test_key + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['radius-server deadtime 22', 'radius-server timeout 11', 'radius-server directed-request']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_acl_interfaces_module.rst b/docs/cisco.nxos.nxos_acl_interfaces_module.rst new file mode 100644 index 000000000..a2885df02 --- /dev/null +++ b/docs/cisco.nxos.nxos_acl_interfaces_module.rst @@ -0,0 +1,610 @@ +.. _cisco.nxos.nxos_acl_interfaces_module: + + +****************************** +cisco.nxos.nxos_acl_interfaces +****************************** + +**ACL interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Add and remove Access Control Lists on interfaces in NX-OS platform + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of interfaces to be configured with ACLs
+
+
+ access_groups + +
+ list + / elements=dictionary +
+ 		+ +
List of address family indicators with ACLs to be configured on the interface
+
+
+ acls + +
+ list + / elements=dictionary +
+ 		+ +
List of Access Control Lists for the interface
+
+
+ direction + +
+ string + / required +
+ 		+
    Choices: +
  • in
    • +
  • out
    • +
+ 		+
Direction to be applied for the ACL
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the ACL to be added/removed
+
+
+ port + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use ACL as port policy.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
Address Family Indicator of the ACLs to be configured
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the interface
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • deleted
    • +
  • gathered
    • +
  • merged ←
    • +
  • overridden
    • +
  • rendered
    • +
  • replaced
    • +
  • parsed
    • +
+ 		+
The state the configuration should be left in
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------ + # + + - name: Merge ACL interfaces configuration + cisco.nxos.nxos_acl_interfaces: + config: + - name: Ethernet1/2 + access_groups: + - afi: ipv6 + acls: + - name: ACL1v6 + direction: in + + - name: Eth1/5 + access_groups: + - afi: ipv4 + acls: + - name: PortACL + direction: in + port: true + + - name: ACL1v4 + direction: out + + - afi: ipv6 + acls: + - name: ACL1v6 + direction: in + state: merged + + # After state: + # ------------ + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ip port access-group PortACL in + # ip access-group ACL1v4 out + # ipv6 traffic-filter ACL1v6 in + + # Using replaced + + # Before state: + # ------------ + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ip port access-group PortACL in + # ip access-group ACL1v4 out + # ipv6 traffic-filter ACL1v6 in + + - name: Replace interface configuration with given configuration + cisco.nxos.nxos_acl_interfaces: + config: + - name: Eth1/5 + access_groups: + - afi: ipv4 + acls: + - name: NewACLv4 + direction: out + + - name: Ethernet1/3 + access_groups: + - afi: ipv6 + acls: + - name: NewACLv6 + direction: in + port: true + state: replaced + + # After state: + # ------------ + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/3 + # ipv6 port traffic-filter NewACLv6 in + # interface Ethernet1/5 + # ip access-group NewACLv4 out + + # Using overridden + + # Before state: + # ------------ + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ip port access-group PortACL in + # ip access-group ACL1v4 out + # ipv6 traffic-filter ACL1v6 in + + - name: Override interface configuration with given configuration + cisco.nxos.nxos_acl_interfaces: + config: + - name: Ethernet1/3 + access_groups: + - afi: ipv4 + acls: + - name: ACL1v4 + direction: out + + - name: PortACL + port: true + direction: in + - afi: ipv6 + acls: + - name: NewACLv6 + direction: in + port: true + state: overridden + + # After state: + # ------------ + # interface Ethernet1/3 + # ip access-group ACL1v4 out + # ip port access-group PortACL in + # ipv6 port traffic-filter NewACLv6 in + + # Using deleted to remove ACL config from specified interfaces + + # Before state: + # ------------- + # interface Ethernet1/1 + # ip access-group ACL2v4 in + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ip port access-group PortACL in + # ip access-group ACL1v4 out + # ipv6 traffic-filter ACL1v6 in + + - name: Delete ACL configuration on interfaces + cisco.nxos.nxos_acl_interfaces: + config: + - name: Ethernet1/5 + - name: Ethernet1/2 + state: deleted + + # After state: + # ------------- + # interface Ethernet1/1 + # ip access-group ACL2v4 in + # interface Ethernet1/2 + # interface Ethernet1/5 + + # Using deleted to remove ACL config from all interfaces + + # Before state: + # ------------- + # interface Ethernet1/1 + # ip access-group ACL2v4 in + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ip port access-group PortACL in + # ip access-group ACL1v4 out + # ipv6 traffic-filter ACL1v6 in + + - name: Delete ACL configuration from all interfaces + cisco.nxos.nxos_acl_interfaces: + state: deleted + + # After state: + # ------------- + # interface Ethernet1/1 + # interface Ethernet1/2 + # interface Ethernet1/5 + + # Using parsed + + - name: Parse given configuration into structured format + cisco.nxos.nxos_acl_interfaces: + running_config: | + interface Ethernet1/2 + ipv6 traffic-filter ACL1v6 in + interface Ethernet1/5 + ipv6 traffic-filter ACL1v6 in + ip access-group ACL1v4 out + ip port access-group PortACL in + state: parsed + + # returns + # parsed: + # - name: Ethernet1/2 + # access_groups: + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # direction: in + # - name: Ethernet1/5 + # access_groups: + # - afi: ipv4 + # acls: + # - name: PortACL + # direction: in + # port: True + # - name: ACL1v4 + # direction: out + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # direction: in + + + # Using gathered: + + # Before state: + # ------------ + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ipv6 traffic-filter ACL1v6 in + # ip access-group ACL1v4 out + # ip port access-group PortACL in + + - name: Gather existing configuration from device + cisco.nxos.nxos_acl_interfaces: + config: + state: gathered + + # returns + # gathered: + # - name: Ethernet1/2 + # access_groups: + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # direction: in + # - name: Ethernet1/5 + # access_groups: + # - afi: ipv4 + # acls: + # - name: PortACL + # direction: in + # port: True + # - name: ACL1v4 + # direction: out + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # direction: in + + + # Using rendered + + - name: Render required configuration to be pushed to the device + cisco.nxos.nxos_acl_interfaces: + config: + - name: Ethernet1/2 + access_groups: + - afi: ipv6 + acls: + - name: ACL1v6 + direction: in + - name: Ethernet1/5 + access_groups: + - afi: ipv4 + acls: + - name: PortACL + direction: in + port: true + - name: ACL1v4 + direction: out + - afi: ipv6 + acls: + - name: ACL1v6 + direction: in + state: rendered + + + # returns + # rendered: + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ipv6 traffic-filter ACL1v6 in + # ip access-group ACL1v4 out + # ip port access-group PortACL in + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/2', 'ipv6 traffic-filter ACL1v6 out', 'ip port access-group PortACL in']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_acls_module.rst b/docs/cisco.nxos.nxos_acls_module.rst new file mode 100644 index 000000000..1b806511d --- /dev/null +++ b/docs/cisco.nxos.nxos_acls_module.rst @@ -0,0 +1,4086 @@ +.. _cisco.nxos.nxos_acls_module: + + +******************** +cisco.nxos.nxos_acls +******************** + +**ACLs resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manage named IP ACLs on the Cisco NX-OS platform + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary of ACL options.
+
+
+ acls + +
+ list + / elements=dictionary +
+ 		+ +
A list of the ACLs.
+
+
+ aces + +
+ list + / elements=dictionary +
+ 		+ +
The entries within the ACL.
+
+
+ destination + +
+ dictionary +
+ 		+ +
Specify the packet destination.
+
+
+ address + +
+ string +
+ 		+ +
Destination network address.
+
+
+ any + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Any destination address.
+
+
+ host + +
+ string +
+ 		+ +
Host IP address.
+
+
+ port_protocol + +
+ dictionary +
+ 		+ +
Specify the destination port or protocol (only for TCP and UDP).
+
+
+ eq + +
+ string +
+ 		+ +
Match only packets on a given port number.
+
+
+ gt + +
+ string +
+ 		+ +
Match only packets with a greater port number.
+
+
+ lt + +
+ string +
+ 		+ +
Match only packets with a lower port number.
+
+
+ neq + +
+ string +
+ 		+ +
Match only packets not on a given port number.
+
+
+ range + +
+ dictionary +
+ 		+ +
Match only packets in the range of port numbers.
+
+
+ end + +
+ string +
+ 		+ +
Specify the end of the port range.
+
+
+ start + +
+ string +
+ 		+ +
Specify the start of the port range.
+
+
+ prefix + +
+ string +
+ 		+ +
Destination network prefix. Only for prefixes of value less than 31 for ipv4 and 127 for ipv6. Prefixes of 32 (ipv4) and 128 (ipv6) should be given in the 'host' key.
+
+
+ wildcard_bits + +
+ string +
+ 		+ +
Destination wildcard bits.
+
+
+ dscp + +
+ string +
+ 		+ +
Match packets with given DSCP value.
+
+
+ fragments + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Check non-initial fragments.
+
+
+ grant + +
+ string +
+ 		+
    Choices: +
  • permit
    • +
  • deny
    • +
+ 		+
Action to be applied on the rule.
+
+
+ log + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log matches against this entry.
+
+
+ precedence + +
+ string +
+ 		+ +
Match packets with given precedence value.
+
+
+ protocol + +
+ string +
+ 		+ +
Specify the protocol.
+
+
+ protocol_options + +
+ dictionary +
+ 		+ +
All possible suboptions for the protocol chosen.
+
+
+ icmp + +
+ dictionary +
+ 		+ +
ICMP protocol options.
+
+
+ administratively_prohibited + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively prohibited
+
+
+ alternate_address + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Alternate address
+
+
+ conversion_error + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Datagram conversion
+
+
+ dod_host_prohibited + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host prohibited
+
+
+ dod_net_prohibited + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Net prohibited
+
+
+ echo + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo (ping)
+
+
+ echo_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo reply
+
+
+ echo_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo request (ping)
+
+
+ general_parameter_problem + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter problem
+
+
+ host_isolated + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host isolated
+
+
+ host_precedence_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host unreachable for precedence
+
+
+ host_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host redirect
+
+
+ host_tos_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host redirect for TOS
+
+
+ host_tos_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host unreachable for TOS
+
+
+ host_unknown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host unknown
+
+
+ host_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host unreachable
+
+
+ information_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Information replies
+
+
+ information_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Information requests
+
+
+ mask_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Mask replies
+
+
+ mask_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Mask requests
+
+
+ message_code + +
+ integer +
+ 		+ +
ICMP message code
+
+
+ message_type + +
+ integer +
+ 		+ +
ICMP message type
+
+
+ mobile_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Mobile host redirect
+
+
+ net_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Network redirect
+
+
+ net_tos_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Net redirect for TOS
+
+
+ net_tos_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Network unreachable for TOS
+
+
+ net_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Net unreachable
+
+
+ network_unknown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Network unknown
+
+
+ no_room_for_option + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter required but no room
+
+
+ option_missing + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter required but not present
+
+
+ packet_too_big + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Fragmentation needed and DF set
+
+
+ parameter_problem + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All parameter problems
+
+
+ port_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Port unreachable
+
+
+ precedence_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Precedence cutoff
+
+
+ protocol_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Protocol unreachable
+
+
+ reassembly_timeout + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Reassembly timeout
+
+
+ redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All redirects
+
+
+ router_advertisement + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router discovery advertisements
+
+
+ router_solicitation + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router discovery solicitations
+
+
+ source_quench + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Source quenches
+
+
+ source_route_failed + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Source route failed
+
+
+ time_exceeded + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All time exceeded.
+
+
+ timestamp_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Timestamp replies
+
+
+ timestamp_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Timestamp requests
+
+
+ traceroute + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Traceroute
+
+
+ ttl_exceeded + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
TTL exceeded
+
+
+ unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All unreachables
+
+
+ icmpv6 + +
+ dictionary +
+ 		+ +
ICMPv6 protocol options.
+
+
+ beyond_scope + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Destination beyond scope.
+
+
+ destination_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Destination address is unreachable.
+
+
+ echo_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo reply.
+
+
+ echo_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo request (ping).
+
+
+ fragments + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Check non-initial fragments.
+
+
+ header + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter header problem.
+
+
+ hop_limit + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Hop limit exceeded in transit.
+
+
+ mld_query + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Multicast Listener Discovery Query.
+
+
+ mld_reduction + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Multicast Listener Discovery Reduction.
+
+
+ mld_report + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Multicast Listener Discovery Report.
+
+
+ mldv2 + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Multicast Listener Discovery Protocol.
+
+
+ nd_na + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor discovery neighbor advertisements.
+
+
+ nd_ns + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor discovery neighbor solicitations.
+
+
+ next_header + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter next header problems.
+
+
+ no_admin + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administration prohibited destination.
+
+
+ no_route + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
No route to destination.
+
+
+ packet_too_big + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Packet too big.
+
+
+ parameter_option + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter option problems.
+
+
+ parameter_problem + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All parameter problems.
+
+
+ port_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Port unreachable.
+
+
+ reassembly_timeout + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Reassembly timeout.
+
+
+ renum_command + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router renumbering command.
+
+
+ renum_result + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router renumbering result.
+
+
+ renum_seq_number + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router renumbering sequence number reset.
+
+
+ router_advertisement + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor discovery router advertisements.
+
+
+ router_renumbering + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All router renumbering.
+
+
+ router_solicitation + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor discovery router solicitations.
+
+
+ telemetry_path + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
IPT enabled.
+
+
+ telemetry_queue + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Flow of interest for BDC/HDC.
+
+
+ time_exceeded + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All time exceeded.
+
+
+ unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All unreachable.
+
+
+ igmp + +
+ dictionary +
+ 		+ +
IGMP protocol options.
+
+
+ dvmrp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Distance Vector Multicast Routing Protocol
+
+
+ host_query + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host Query
+
+
+ host_report + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host Report
+
+
+ tcp + +
+ dictionary +
+ 		+ +
TCP flags.
+
+
+ ack + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the ACK bit
+
+
+ established + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match established connections
+
+
+ fin + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the FIN bit
+
+
+ psh + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the PSH bit
+
+
+ rst + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the RST bit
+
+
+ syn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the SYN bit
+
+
+ urg + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the URG bit
+
+
+ remark + +
+ string +
+ 		+ +
Access list entry comment.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence number.
+
+
+ source + +
+ dictionary +
+ 		+ +
Specify the packet source.
+
+
+ address + +
+ string +
+ 		+ +
Source network address.
+
+
+ any + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Any source address.
+
+
+ host + +
+ string +
+ 		+ +
Host IP address.
+
+
+ port_protocol + +
+ dictionary +
+ 		+ +
Specify the destination port or protocol (only for TCP and UDP).
+
+
+ eq + +
+ string +
+ 		+ +
Match only packets on a given port number.
+
+
+ gt + +
+ string +
+ 		+ +
Match only packets with a greater port number.
+
+
+ lt + +
+ string +
+ 		+ +
Match only packets with a lower port number.
+
+
+ neq + +
+ string +
+ 		+ +
Match only packets not on a given port number.
+
+
+ range + +
+ dictionary +
+ 		+ +
Match only packets in the range of port numbers.
+
+
+ end + +
+ string +
+ 		+ +
Specify the end of the port range.
+
+
+ start + +
+ string +
+ 		+ +
Specify the start of the port range.
+
+
+ prefix + +
+ string +
+ 		+ +
Source network prefix. Only for prefixes of mask value less than 31 for ipv4 and 127 for ipv6. Prefixes of mask 32 (ipv4) and 128 (ipv6) should be given in the 'host' key.
+
+
+ wildcard_bits + +
+ string +
+ 		+ +
Source wildcard bits.
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the ACL.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
The Address Family Indicator (AFI) for the ACL.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section 'ip(v6* access-list).
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • deleted
    • +
  • gathered
    • +
  • merged ←
    • +
  • overridden
    • +
  • rendered
    • +
  • replaced
    • +
  • parsed
    • +
+ 		+
The state the configuration should be left in
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - As NX-OS allows configuring a rule again with different sequence numbers, the user is expected to provide sequence numbers for the access control entries to preserve idempotency. If no sequence number is given, the rule will be added as a new rule by the device. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + + - name: Merge provided ACLs configuration with device configuration + cisco.nxos.nxos_acls: + state: merged + config: + - afi: ipv4 + acls: + - name: ACL1v4 + aces: + - grant: deny + destination: + address: 192.0.2.64 + wildcard_bits: 0.0.0.255 + source: + any: true + port_protocol: + lt: 55 + protocol: tcp + protocol_options: + tcp: + ack: true + fin: true + sequence: 50 + + - afi: ipv6 + acls: + - name: ACL1v6 + aces: + - grant: permit + sequence: 10 + source: + any: true + destination: + prefix: 2001:db8:12::/32 + protocol: sctp + + # Task Output + # ----------- + # before: [] + # + # commands: + # - ip access-list ACL1v4 + # - 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + # - ipv6 access-list ACL1v6 + # - 10 permit sctp any 2001:db8:12::/32 + # + # after: + # - acls: + # - aces: + # - destination: + # prefix: 2001:db8:12::/32 + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # name: ACL1v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # address: 192.0.2.64 + # wildcard_bits: 0.0.0.255 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # fin: true + # sequence: 50 + # source: + # any: true + # port_protocol: + # lt: '55' + # name: ACL1v4 + # afi: ipv4 + + + # After state: + # ------------ + # + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + + # Using replaced + + # Before state: + # ---------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 10 permit ip any any + # 20 deny udp any any + # ip access-list ACL2v4 + # 10 permit ahp 192.0.2.0 0.0.0.255 any + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ipv6 access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + - name: Replace existing ACL configuration with provided configuration + cisco.nxos.nxos_acls: + config: + - afi: ipv4 + - afi: ipv6 + acls: + - name: ACL1v6 + aces: + - sequence: 20 + grant: permit + source: + any: true + destination: + any: true + protocol: pim + + - remark: Replaced ACE + - name: ACL2v6 + state: replaced + + # Task Output + # ----------- + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # - ipv6 access-list ACL1v6 + # - no 10 permit sctp any any + # - no 20 remark IPv6 ACL + # - remark Replaced ACE + # - 20 permit pim any any + # - ipv6 access-list ACL2v6 + # - no 10 deny ipv6 any 2001:db8:3000::/36 + # - no 20 permit tcp host 2001:db8:2000:2::2 host 2001:db8:2000:ab::2 + # + # after: + # - acls: + # - aces: + # - remark: Replaced ACE + # sequence: 10 + # - destination: + # any: true + # grant: permit + # protocol: pim + # sequence: 20 + # source: + # any: true + # name: ACL1v6 + # - name: ACL2v6 + # afi: ipv6 + + # After state: + # --------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ipv6 access-list ACL1v6 + # 10 remark Replaced ACE + # 20 permit pim any any + # ipv6 access-list ACL2v6 + + # Using overridden + + # Before state: + # ---------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 10 permit ip any any + # 20 deny udp any any + # ip access-list ACL2v4 + # 10 permit ahp 192.0.2.0 0.0.0.255 any + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ipv6 access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + - name: Override existing configuration with provided configuration + cisco.nxos.nxos_acls: + config: + - afi: ipv4 + acls: + - name: NewACL + aces: + - grant: deny + source: + address: 192.0.2.0 + wildcard_bits: 0.0.255.255 + destination: + any: true + protocol: eigrp + - remark: Example for overridden state + state: overridden + + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ipv6 access-list ACL1v6 + # - no ipv6 access-list ACL2v6 + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # - ip access-list NewACL + # - deny eigrp 192.0.2.0 0.0.255.255 any + # - remark Example for overridden state + # + # after: + # - acls: + # - aces: + # - destination: + # any: true + # grant: deny + # protocol: eigrp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.255.255 + # - remark: Example for overridden state + # sequence: 20 + # name: NewACL + # afi: ipv4 + + # After state: + # ------------ + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list NewACL + # 10 deny eigrp 192.0.2.0 0.0.255.255 any + # 20 remark Example for overridden state + + # Using deleted - delete all + # + # Before state: + # ------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 10 permit ip any any + # 20 deny udp any any + # ip access-list ACL2v4 + # 10 permit ahp 192.0.2.0 0.0.0.255 any + # ip access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ip access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + - name: Delete all ACLs + cisco.nxos.nxos_acls: + state: deleted + + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # - no ipv6 access-list ACL1v6 + # - no ipv6 access-list ACL2v6 + # + # after: [] + + + # After state: + # ----------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # + + # Using deleted - delete AFI + + # Before state: + # ------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 10 permit ip any any + # 20 deny udp any any + # ip access-list ACL2v4 + # 10 permit ahp 192.0.2.0 0.0.0.255 any + # ip access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ip access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + - name: Delete all ACLs in given AFI + cisco.nxos.nxos_acls: + config: + - afi: ipv4 + state: deleted + + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # + # after: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + + # After state: + # ------------ + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ip access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + # Using deleted - delete ACLs + + # Before state: + # ------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 10 permit ip any any + # 20 deny udp any any + # ip access-list ACL2v4 + # 10 permit ahp 192.0.2.0 0.0.0.255 any + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ipv6 access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + - name: Delete specific ACLs + cisco.nxos.nxos_acls: + state: deleted + config: + - afi: ipv4 + acls: + - name: ACL1v4 + - name: ACL2v4 + - afi: ipv6 + acls: + - name: ACL1v6 + + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # - no ipv6 access-list ACL1v6 + # + # after: + # - acls: + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + + # After state: + # ------------ + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ipv6 access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + # Using parsed + + - name: Parse given config to structured data + cisco.nxos.nxos_acls: + running_config: | + ip access-list ACL1v4 + 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + ipv6 access-list ACL1v6 + 10 permit sctp any any + state: parsed + + # Task Output + # ------------ + # + # parsed: + # - afi: ipv4 + # acls: + # - name: ACL1v4 + # aces: + # - grant: deny + # destination: + # address: 192.0.2.64 + # wildcard_bits: 0.0.0.255 + # source: + # any: true + # port_protocol: + # lt: 55 + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # fin: true + # sequence: 50 + # + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # aces: + # - grant: permit + # sequence: 10 + # source: + # any: true + # destination: + # prefix: 2001:db8:12::/32 + # protocol: sctp + + + # Using gathered: + + # Before state: + # ------------ + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + + - name: Gather existing configuration + cisco.nxos.nxos_acls: + state: gathered + + # Task Output + # ----------- + # + # gathered: + # - afi: ipv4 + # acls: + # - name: ACL1v4 + # aces: + # - grant: deny + # destination: + # address: 192.0.2.64 + # wildcard_bits: 0.0.0.255 + # source: + # any: true + # port_protocol: + # lt: 55 + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # fin: true + # sequence: 50 + + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # aces: + # - grant: permit + # sequence: 10 + # source: + # any: true + # destination: + # prefix: 2001:db8:12::/32 + # protocol: sctp + + + # Using rendered + + - name: Render required configuration to be pushed to the device + cisco.nxos.nxos_acls: + config: + - afi: ipv4 + acls: + - name: ACL1v4 + aces: + - grant: deny + destination: + address: 192.0.2.64 + wildcard_bits: 0.0.0.255 + source: + any: true + port_protocol: + lt: 55 + protocol: tcp + protocol_options: + tcp: + ack: true + fin: true + sequence: 50 + - afi: ipv6 + acls: + - name: ACL1v6 + aces: + - grant: permit + sequence: 10 + source: + any: true + destination: + prefix: '2001:db8:12::/32' + protocol: sctp + state: rendered + + + # Task Output + # ----------- + # + # rendered: + # ip access-list ACL1v4 + # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['ip access-list ACL1v4', '10 permit ip any any precedence critical log', '20 deny tcp any lt smtp host 192.0.2.64 ack fin']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['ip access-list ACL1v4', '10 permit ip any any precedence critical log', '20 deny tcp any lt smtp host 192.0.2.64 ack fin']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_banner_module.rst b/docs/cisco.nxos.nxos_banner_module.rst new file mode 100644 index 000000000..7502173b7 --- /dev/null +++ b/docs/cisco.nxos.nxos_banner_module.rst @@ -0,0 +1,187 @@ +.. _cisco.nxos.nxos_banner_module: + + +********************** +cisco.nxos.nxos_banner +********************** + +**Manage multiline banners on Cisco NXOS devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This will configure both exec and motd banners on remote devices running Cisco NXOS. It allows playbooks to add or remove banner text from the active running configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ banner + +
+ string + / required +
+ 		+
    Choices: +
  • exec
    • +
  • motd
    • +
+ 		+
Specifies which banner that should be configured on the remote device.
+
+
+ multiline_delimiter + +
+ string +
+ 		+ Default:
"@"
+ 		+
Specify the delimiting character than will be used for configuration.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specifies whether or not the configuration is present in the current devices active running configuration.
+
+
+ text + +
+ string +
+ 		+ +
The banner text that should be present in the remote device running configuration. This argument accepts a multiline string, with no empty lines. Requires state=present.
+
+
+ + +Notes +----- + +.. note:: + - Since responses from the device are always read with surrounding whitespaces stripped, tasks that configure banners with preceeding or trailing whitespaces will not be idempotent. + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: configure the exec banner + cisco.nxos.nxos_banner: + banner: exec + text: | + this is my exec banner + that contains a multiline + string + state: present + - name: remove the motd banner + cisco.nxos.nxos_banner: + banner: motd + state: absent + - name: Configure banner from file + cisco.nxos.nxos_banner: + banner: motd + text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}" + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['banner exec', 'this is my exec banner', 'that contains a multiline', 'string']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_bfd_global_module.rst b/docs/cisco.nxos.nxos_bfd_global_module.rst new file mode 100644 index 000000000..8cd86ec48 --- /dev/null +++ b/docs/cisco.nxos.nxos_bfd_global_module.rst @@ -0,0 +1,326 @@ +.. _cisco.nxos.nxos_bfd_global_module: + + +************************** +cisco.nxos.nxos_bfd_global +************************** + +**Bidirectional Forwarding Detection (BFD) global-level configuration** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages Bidirectional Forwarding Detection (BFD) global-level configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ echo_interface + +
+ string +
+ 		+ +
Loopback interface used for echo frames.
+
Valid values are loopback interface name or 'deleted'.
+
Not supported on N5K/N6K
+
+
+ echo_rx_interval + +
+ integer +
+ 		+ +
BFD Echo receive interval in milliseconds.
+
+
+ fabricpath_interval + +
+ dictionary +
+ 		+ +
BFD fabricpath interval timer values.
+
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
+
+
+ fabricpath_slow_timer + +
+ integer +
+ 		+ +
BFD fabricpath slow rate timer in milliseconds.
+
+
+ fabricpath_vlan + +
+ integer +
+ 		+ +
BFD fabricpath control vlan.
+
+
+ interval + +
+ dictionary +
+ 		+ +
BFD interval timer values.
+
Value must be a dict defining values for keys (tx, min_rx, and multiplier)
+
+
+ ipv4_echo_rx_interval + +
+ integer +
+ 		+ +
BFD IPv4 session echo receive interval in milliseconds.
+
+
+ ipv4_interval + +
+ dictionary +
+ 		+ +
BFD IPv4 interval timer values.
+
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
+
+
+ ipv4_slow_timer + +
+ integer +
+ 		+ +
BFD IPv4 slow rate timer in milliseconds.
+
+
+ ipv6_echo_rx_interval + +
+ integer +
+ 		+ +
BFD IPv6 session echo receive interval in milliseconds.
+
+
+ ipv6_interval + +
+ dictionary +
+ 		+ +
BFD IPv6 interval timer values.
+
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
+
+
+ ipv6_slow_timer + +
+ integer +
+ 		+ +
BFD IPv6 slow rate timer in milliseconds.
+
+
+ slow_timer + +
+ integer +
+ 		+ +
BFD slow rate timer in milliseconds.
+
+
+ startup_timer + +
+ integer +
+ 		+ +
BFD delayed startup timer in seconds.
+
Not supported on N5K/N6K/N7K
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 9.2(2) + - Unsupported for Cisco MDS + - BFD global will automatically enable 'feature bfd' if it is disabled. + - BFD global does not have a 'state' parameter. All of the BFD commands are unique and are defined if 'feature bfd' is enabled. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_bfd_global: + echo_interface: Ethernet1/2 + echo_rx_interval: 50 + interval: + tx: 50 + min_rx: 50 + multiplier: 4 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ cmds + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['bfd echo-interface loopback1', 'bfd slow-timer 2000']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_bfd_interfaces_module.rst b/docs/cisco.nxos.nxos_bfd_interfaces_module.rst new file mode 100644 index 000000000..975de891c --- /dev/null +++ b/docs/cisco.nxos.nxos_bfd_interfaces_module.rst @@ -0,0 +1,394 @@ +.. _cisco.nxos.nxos_bfd_interfaces_module: + + +****************************** +cisco.nxos.nxos_bfd_interfaces +****************************** + +**BFD interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages attributes of Bidirectional Forwarding Detection (BFD) on the interface. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
The provided configuration
+
+
+ bfd + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/Disable Bidirectional Forwarding Detection (BFD) on the interface.
+
+
+ echo + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/Disable BFD Echo functionality on the interface.
+
+
+ name + +
+ string +
+ 		+ +
The name of the interface.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface|^feature bfd'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state of the configuration after module completion
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 7.0(3)I5(1). + - Unsupported for Cisco MDS + - Feature bfd should be enabled for this module. + + + +Examples +-------- + +.. code-block:: yaml + + # Using deleted + + - name: Configure interfaces + cisco.nxos.nxos_bfd_interfaces: + state: deleted + + + # Using merged + + - name: Configure interfaces + cisco.nxos.nxos_bfd_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + echo: enable + - name: Ethernet1/2 + bfd: disable + echo: disable + state: merged + + + # Using overridden + + - name: Configure interfaces + cisco.nxos.nxos_bfd_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + echo: enable + - name: Ethernet1/2 + bfd: disable + echo: disable + state: overridden + + + # Using replaced + + - name: Configure interfaces + cisco.nxos.nxos_bfd_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + echo: enable + - name: Ethernet1/2 + bfd: disable + echo: disable + state: replaced + + # Using rendered + + - name: Use rendered state to convert task input to device specific commands + cisco.nxos.nxos_bfd_interfaces: + config: + - name: Ethernet1/800 + bfd: enable + echo: enable + - name: Ethernet1/801 + bfd: disable + echo: disable + state: rendered + + # Task Output (redacted) + # ----------------------- + + # rendered: + # - "interface Ethernet1/800" + # - "bfd" + # - "bfd echo" + # - "interface Ethernet1/801" + # - "no bfd" + # - "no bfd echo" + + # Using parsed + + # parsed.cfg + # ------------ + + # feature bfd + # interface Ethernet1/800 + # no switchport + # no bfd + # no bfd echo + # interface Ethernet1/801 + # no switchport + # no bfd + # interface Ethernet1/802 + # no switchport + # no bfd echo + # interface mgmt0 + # ip address dhcp + # vrf member management + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_bfd_interfaces: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + + # parsed: + # - bfd: disable + # echo: disable + # name: Ethernet1/800 + # - bfd: disable + # echo: enable + # name: Ethernet1/801 + # - bfd: enable + # echo: disable + # name: Ethernet1/802 + # - bfd: enable + # echo: enable + # name: mgmt0 + + # Using gathered + + # Existing device config state + # ------------------------------- + + # feature bfd + # interface Ethernet1/1 + # no switchport + # no bfd + # interface Ethernet1/2 + # no switchport + # no bfd echo + # interface mgmt0 + # ip address dhcp + # vrf member management + + - name: Gather bfd_interfaces facts from the device using nxos_bfd_interfaces + cisco.nxos.nxos_bfd_interfaces: + state: gathered + + # Task output (redacted) + # ----------------------- + # gathered: + # - name: Ethernet1/1 + # bfd: disable + # echo: enable + # - name: Ethernet1/3 + # echo: disable + # bfd: enable + # - name: mgmt0 + # bfd: enable + # echo: enable + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/1', 'no bfd', 'no bfd echo']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_bgp_global_module.rst b/docs/cisco.nxos.nxos_bgp_global_module.rst new file mode 100644 index 000000000..19ee2709e --- /dev/null +++ b/docs/cisco.nxos.nxos_bgp_global_module.rst @@ -0,0 +1,5843 @@ +.. _cisco.nxos.nxos_bgp_global_module: + + +************************** +cisco.nxos.nxos_bgp_global +************************** + +**BGP Global resource module.** + + +Version added: 1.4.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages global BGP configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A list of BGP process configuration.
+
+
+ affinity_group + +
+ dictionary +
+ 		+ +
Configure an affinity group.
+
+
+ group_id + +
+ integer +
+ 		+ +
Affinity Group ID.
+
+
+ as_number + +
+ string +
+ 		+ +
Autonomous System Number of the router.
+
+
+ bestpath + +
+ dictionary +
+ 		+ +
Define the default bestpath selection algorithm.
+
+
+ always_compare_med + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare MED on paths from different AS.
+
+
+ as_path + +
+ dictionary +
+ 		+ +
AS-Path.
+
+
+ ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore AS-Path during bestpath selection.
+
+
+ multipath_relax + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Relax AS-Path restriction when choosing multipaths.
+
+
+ compare_neighborid + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
When more paths are available than max path config, use neighborid as tie-breaker.
+
+
+ compare_routerid + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare router-id for identical EBGP paths.
+
+
+ cost_community_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore cost communities in bestpath selection.
+
+
+ igp_metric_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore IGP metric for next-hop during bestpath selection.
+
+
+ med + +
+ dictionary +
+ 		+ +
MED
+
+
+ confed + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare MED only from paths originated from within a confederation.
+
+
+ missing_as_worst + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Treat missing MED as highest MED.
+
+
+ non_deterministic + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Not always pick the best-MED path among paths from same AS.
+
+
+ cluster_id + +
+ string +
+ 		+ +
Configure Route Reflector Cluster-ID.
+
+
+ confederation + +
+ dictionary +
+ 		+ +
AS confederation parameters.
+
+
+ identifier + +
+ string +
+ 		+ +
Set routing domain confederation AS.
+
+
+ peers + +
+ list + / elements=string +
+ 		+ +
Peer ASs in BGP confederation.
+
+
+ disable_policy_batching + +
+ dictionary +
+ 		+ +
Disable batching evaluation of outbound policy for a peer.
+
+
+ ipv4 + +
+ dictionary +
+ 		+ +
IPv4 address-family settings.
+
+
+ prefix_list + +
+ string +
+ 		+ +
Name of prefix-list to apply.
+
+
+ ipv6 + +
+ dictionary +
+ 		+ +
IPv6 address-family settings.
+
+
+ prefix_list + +
+ string +
+ 		+ +
Name of prefix-list to apply.
+
+
+ nexthop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Batching based on nexthop.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set policy batching.
+
+
+ dynamic_med_interval + +
+ integer +
+ 		+ +
Sets the interval for dampening of med changes.
+
+
+ enforce_first_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enforce neighbor AS is the first AS in AS-PATH attribute (EBGP).
+
+
+ enhanced_error + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable BGP Enhanced error handling.
+
+
+ fabric_soo + +
+ string +
+ 		+ +
Fabric site of origin.
+
+
+ fast_external_fallover + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Immediately reset the session if the link to a directly connected BGP peer goes down.
+
+
+ flush_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Flush routes in RIB upon controlled restart.
+
+
+ graceful_restart + +
+ dictionary +
+ 		+ +
Configure Graceful Restart functionality.
+
+
+ helper + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure Graceful Restart Helper mode functionality.
+
+
+ restart_time + +
+ integer +
+ 		+ +
Maximum time for restart advertised to peers.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable graceful-restart.
+
+
+ stalepath_time + +
+ integer +
+ 		+ +
Maximum time to keep a restarting peer's stale routes.
+
+
+ graceful_shutdown + +
+ dictionary +
+ 		+ +
Graceful-shutdown for BGP protocol.
+
+
+ activate + +
+ dictionary +
+ 		+ +
Send graceful-shutdown community on all routes.
+
+
+ route_map + +
+ string +
+ 		+ +
Apply route-map to modify attributes for outbound.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Activiate graceful-shutdown.
+
+
+ aware + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Lower preference of routes carrying graceful-shutdown community.
+
+
+ isolate + +
+ dictionary +
+ 		+ +
Isolate this router from BGP perspective.
+
+
+ include_local + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Withdraw both local and remote BGP routes.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Withdraw remote BGP routes to isolate this router.
+
+
+ log_neighbor_changes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log a message for neighbor up/down event.
+
+
+ maxas_limit + +
+ integer +
+ 		+ +
Allow AS-PATH attribute from EBGP neighbor imposing a limit on number of ASes.
+
+
+ neighbor_down + +
+ dictionary +
+ 		+ +
Handle BGP neighbor down event, due to various reasons.
+
+
+ fib_accelerate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor.
+
+
+ neighbors + +
+ list + / elements=dictionary +
+ 		+ +
Configure BGP neighbors.
+
+
+ bfd + +
+ dictionary +
+ 		+ +
Bidirectional Fast Detection for the neighbor.
+
+
+ multihop + +
+ dictionary +
+ 		+ +
Multihop session.
+
+
+ interval + +
+ dictionary +
+ 		+ +
Configure BFD session interval parameters.
+
+
+ min_rx_interval + +
+ integer +
+ 		+ +
Minimum RX interval.
+
+
+ multiplier + +
+ integer +
+ 		+ +
Detect Multiplier.
+
+
+ tx_interval + +
+ integer +
+ 		+ +
TX interval in milliseconds.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD multihop.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD for this neighbor.
+
+
+ singlehop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Single-hop session.
+
+
+ bmp_activate_server + +
+ integer +
+ 		+ +
Specify server ID for activating BMP monitoring for the peer.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Capability.
+
+
+ suppress_4_byte_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress 4-byte AS Capability.
+
+
+ description + +
+ string +
+ 		+ +
Neighbor specific descripion.
+
+
+ disable_connected_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable check for directly connected peer.
+
+
+ dont_capability_negotiate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Don't negotiate capability with this neighbor.
+
+
+ dscp + +
+ string +
+ 		+ +
Set dscp value for tcp transport.
+
+
+ dynamic_capability + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Dynamic Capability
+
+
+ ebgp_multihop + +
+ integer +
+ 		+ +
Specify multihop TTL for remote peer.
+
+
+ graceful_shutdown + +
+ dictionary +
+ 		+ +
Graceful-shutdown for this neighbor.
+
+
+ activate + +
+ dictionary +
+ 		+ +
Send graceful-shutdown community.
+
+
+ route_map + +
+ string +
+ 		+ +
Apply route-map to modify attributes for outbound.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set activate.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a template.
+
+
+ peer + +
+ string +
+ 		+ +
Peer template to inherit.
+
+
+ peer_session + +
+ string +
+ 		+ +
Peer-session template to inherit.
+
+
+ local_as + +
+ string +
+ 		+ +
Specify the local-as number for the eBGP neighbor.
+
+
+ log_neighbor_changes + +
+ dictionary +
+ 		+ +
Log message for neighbor up/down event.
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable logging of neighbor up/down event.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set log-neighbor-changes.
+
+
+ low_memory + +
+ dictionary +
+ 		+ +
Behaviour in low memory situations.
+
+
+ exempt + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not shutdown this peer when under memory pressure.
+
+
+ neighbor_address + +
+ string + / required +
+ 		+ +
IP address/Prefix of the neighbor or interface.
+
+
+ neighbor_affinity_group + +
+ dictionary +
+ 		+ +
Configure an affinity group.
+
+
+ group_id + +
+ integer +
+ 		+ +
Affinity Group ID.
+
+
+ password + +
+ dictionary +
+ 		+ +
Configure a password for neighbor.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 specifies an UNENCRYPTED neighbor password.
+
3 specifies an 3DES ENCRYPTED neighbor password will follow.
+
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
+
+
+ key + +
+ string +
+ 		+ +
Authentication password.
+
+
+ path_attribute + +
+ list + / elements=dictionary +
+ 		+ +
BGP path attribute optional filtering.
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • discard
    • +
  • treat-as-withdraw
    • +
+ 		+
Action.
+
+
+ range + +
+ dictionary +
+ 		+ +
Path attribute range.
+
+
+ end + +
+ integer +
+ 		+ +
Path attribute range end value.
+
+
+ start + +
+ integer +
+ 		+ +
Path attribute range start value.
+
+
+ type + +
+ integer +
+ 		+ +
Path attribute type
+
+
+ peer_type + +
+ string +
+ 		+
    Choices: +
  • fabric-border-leaf
    • +
  • fabric-external
    • +
+ 		+
Neighbor facing
+
+
+ remote_as + +
+ string +
+ 		+ +
Specify Autonomous System Number of the neighbor.
+
+
+ remote_as_route_map + +
+ string +
+ 		+ +
Route-map to match prefix peer AS number.
+
+
+ remove_private_as + +
+ dictionary +
+ 		+ +
Remove private AS number from outbound updates.
+
+
+ all + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All.
+
+
+ replace_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Replace.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Remove private AS.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown this neighbor.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure keepalive and hold timers.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Holdtime (seconds).
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval (seconds).
+
+
+ transport + +
+ dictionary +
+ 		+ +
BGP transport connection.
+
+
+ connection_mode + +
+ dictionary +
+ 		+ +
Specify type of connection.
+
+
+ passive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Allow passive connection setup only.
+
+
+ ttl_security + +
+ dictionary +
+ 		+ +
Enable TTL Security Mechanism.
+
+
+ hops + +
+ integer +
+ 		+ +
Specify hop count for remote peer.
+
+
+ update_source + +
+ string +
+ 		+ +
Specify source of BGP session and updates.
+
+
+ nexthop + +
+ dictionary +
+ 		+ +
Nexthop resolution options.
+
+
+ suppress_default_resolution + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Prohibit use of default route for nexthop address resolution.
+
+
+ rd + +
+ dictionary +
+ 		+ +
Secondary Route Distinguisher for vxlan multisite border gateway.
+
+
+ dual + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Generate Secondary RD for all VRFs and L2VNIs.
+
+
+ id + +
+ integer +
+ 		+ +
Specify 2 byte value for ID.
+
+
+ reconnect_interval + +
+ integer +
+ 		+ +
Configure connection reconnect interval.
+
+
+ router_id + +
+ string +
+ 		+ +
Specify the IP address to use as router-id.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown BGP protocol.
+
+
+ suppress_fib_pending + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise only routes that are programmed in hardware to peers.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure bgp related timers.
+
+
+ bestpath_limit + +
+ dictionary +
+ 		+ +
Configure timeout for first bestpath after restart.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure update-delay-always option.
+
+
+ timeout + +
+ integer +
+ 		+ +
Bestpath timeout (seconds).
+
+
+ bgp + +
+ dictionary +
+ 		+ +
Configure different bgp keepalive and holdtimes.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Holdtime (seconds).
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval (seconds).
+
+
+ prefix_peer_timeout + +
+ integer +
+ 		+ +
Prefix Peer timeout (seconds).
+
+
+ prefix_peer_wait + +
+ integer +
+ 		+ +
Configure wait timer for a prefix peer.
+
+
+ vrfs + +
+ list + / elements=dictionary +
+ 		+ +
Virtual Router Context configurations.
+
+
+ allocate_index + +
+ integer +
+ 		+ +
Configure allocate-index.
+
+
+ bestpath + +
+ dictionary +
+ 		+ +
Define the default bestpath selection algorithm.
+
+
+ always_compare_med + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare MED on paths from different AS.
+
+
+ as_path + +
+ dictionary +
+ 		+ +
AS-Path.
+
+
+ ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore AS-Path during bestpath selection.
+
+
+ multipath_relax + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Relax AS-Path restriction when choosing multipaths.
+
+
+ compare_neighborid + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
When more paths are available than max path config, use neighborid as tie-breaker.
+
+
+ compare_routerid + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare router-id for identical EBGP paths.
+
+
+ cost_community_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore cost communities in bestpath selection.
+
+
+ igp_metric_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore IGP metric for next-hop during bestpath selection.
+
+
+ med + +
+ dictionary +
+ 		+ +
MED
+
+
+ confed + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare MED only from paths originated from within a confederation.
+
+
+ missing_as_worst + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Treat missing MED as highest MED.
+
+
+ non_deterministic + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Not always pick the best-MED path among paths from same AS.
+
+
+ cluster_id + +
+ string +
+ 		+ +
Configure Route Reflector Cluster-ID.
+
+
+ confederation + +
+ dictionary +
+ 		+ +
AS confederation parameters.
+
+
+ identifier + +
+ string +
+ 		+ +
Set routing domain confederation AS.
+
+
+ peers + +
+ list + / elements=string +
+ 		+ +
Peer ASs in BGP confederation.
+
+
+ graceful_restart + +
+ dictionary +
+ 		+ +
Configure Graceful Restart functionality.
+
+
+ helper + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure Graceful Restart Helper mode functionality.
+
+
+ restart_time + +
+ integer +
+ 		+ +
Maximum time for restart advertised to peers.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable graceful-restart.
+
+
+ stalepath_time + +
+ integer +
+ 		+ +
Maximum time to keep a restarting peer's stale routes.
+
+
+ local_as + +
+ string +
+ 		+ +
Specify the local-as for this vrf.
+
+
+ log_neighbor_changes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log a message for neighbor up/down event.
+
+
+ maxas_limit + +
+ integer +
+ 		+ +
Allow AS-PATH attribute from EBGP neighbor imposing a limit on number of ASes.
+
+
+ neighbor_down + +
+ dictionary +
+ 		+ +
Handle BGP neighbor down event, due to various reasons.
+
+
+ fib_accelerate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor.
+
+
+ neighbors + +
+ list + / elements=dictionary +
+ 		+ +
Configure BGP neighbors.
+
+
+ bfd + +
+ dictionary +
+ 		+ +
Bidirectional Fast Detection for the neighbor.
+
+
+ multihop + +
+ dictionary +
+ 		+ +
Multihop session.
+
+
+ interval + +
+ dictionary +
+ 		+ +
Configure BFD session interval parameters.
+
+
+ min_rx_interval + +
+ integer +
+ 		+ +
Minimum RX interval.
+
+
+ multiplier + +
+ integer +
+ 		+ +
Detect Multiplier.
+
+
+ tx_interval + +
+ integer +
+ 		+ +
TX interval in milliseconds.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD multihop.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD for this neighbor.
+
+
+ singlehop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Single-hop session.
+
+
+ bmp_activate_server + +
+ integer +
+ 		+ +
Specify server ID for activating BMP monitoring for the peer.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Capability.
+
+
+ suppress_4_byte_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress 4-byte AS Capability.
+
+
+ description + +
+ string +
+ 		+ +
Neighbor specific descripion.
+
+
+ disable_connected_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable check for directly connected peer.
+
+
+ dont_capability_negotiate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Don't negotiate capability with this neighbor.
+
+
+ dscp + +
+ string +
+ 		+ +
Set dscp value for tcp transport.
+
+
+ dynamic_capability + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Dynamic Capability
+
+
+ ebgp_multihop + +
+ integer +
+ 		+ +
Specify multihop TTL for remote peer.
+
+
+ graceful_shutdown + +
+ dictionary +
+ 		+ +
Graceful-shutdown for this neighbor.
+
+
+ activate + +
+ dictionary +
+ 		+ +
Send graceful-shutdown community.
+
+
+ route_map + +
+ string +
+ 		+ +
Apply route-map to modify attributes for outbound.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set activate.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a template.
+
+
+ peer + +
+ string +
+ 		+ +
Peer template to inherit.
+
+
+ peer_session + +
+ string +
+ 		+ +
Peer-session template to inherit.
+
+
+ local_as + +
+ string +
+ 		+ +
Specify the local-as number for the eBGP neighbor.
+
+
+ log_neighbor_changes + +
+ dictionary +
+ 		+ +
Log message for neighbor up/down event.
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable logging of neighbor up/down event.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set log-neighbor-changes.
+
+
+ low_memory + +
+ dictionary +
+ 		+ +
Behaviour in low memory situations.
+
+
+ exempt + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not shutdown this peer when under memory pressure.
+
+
+ neighbor_address + +
+ string + / required +
+ 		+ +
IP address/Prefix of the neighbor or interface.
+
+
+ neighbor_affinity_group + +
+ dictionary +
+ 		+ +
Configure an affinity group.
+
+
+ group_id + +
+ integer +
+ 		+ +
Affinity Group ID.
+
+
+ password + +
+ dictionary +
+ 		+ +
Configure a password for neighbor.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 specifies an UNENCRYPTED neighbor password.
+
3 specifies an 3DES ENCRYPTED neighbor password will follow.
+
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
+
+
+ key + +
+ string +
+ 		+ +
Authentication password.
+
+
+ path_attribute + +
+ list + / elements=dictionary +
+ 		+ +
BGP path attribute optional filtering.
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • discard
    • +
  • treat-as-withdraw
    • +
+ 		+
Action.
+
+
+ range + +
+ dictionary +
+ 		+ +
Path attribute range.
+
+
+ end + +
+ integer +
+ 		+ +
Path attribute range end value.
+
+
+ start + +
+ integer +
+ 		+ +
Path attribute range start value.
+
+
+ type + +
+ integer +
+ 		+ +
Path attribute type
+
+
+ peer_type + +
+ string +
+ 		+
    Choices: +
  • fabric-border-leaf
    • +
  • fabric-external
    • +
+ 		+
Neighbor facing
+
+
+ remote_as + +
+ string +
+ 		+ +
Specify Autonomous System Number of the neighbor.
+
+
+ remote_as_route_map + +
+ string +
+ 		+ +
Route-map to match prefix peer AS number.
+
+
+ remove_private_as + +
+ dictionary +
+ 		+ +
Remove private AS number from outbound updates.
+
+
+ all + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All.
+
+
+ replace_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Replace.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Remove private AS.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown this neighbor.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure keepalive and hold timers.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Holdtime (seconds).
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval (seconds).
+
+
+ transport + +
+ dictionary +
+ 		+ +
BGP transport connection.
+
+
+ connection_mode + +
+ dictionary +
+ 		+ +
Specify type of connection.
+
+
+ passive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Allow passive connection setup only.
+
+
+ ttl_security + +
+ dictionary +
+ 		+ +
Enable TTL Security Mechanism.
+
+
+ hops + +
+ integer +
+ 		+ +
Specify hop count for remote peer.
+
+
+ update_source + +
+ string +
+ 		+ +
Specify source of BGP session and updates.
+
+
+ reconnect_interval + +
+ integer +
+ 		+ +
Configure connection reconnect interval.
+
+
+ router_id + +
+ string +
+ 		+ +
Specify the IP address to use as router-id.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure bgp related timers.
+
+
+ bestpath_limit + +
+ dictionary +
+ 		+ +
Configure timeout for first bestpath after restart.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure update-delay-always option.
+
+
+ timeout + +
+ integer +
+ 		+ +
Bestpath timeout (seconds).
+
+
+ bgp + +
+ dictionary +
+ 		+ +
Configure different bgp keepalive and holdtimes.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Holdtime (seconds).
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval (seconds).
+
+
+ prefix_peer_timeout + +
+ integer +
+ 		+ +
Prefix Peer timeout (seconds).
+
+
+ prefix_peer_wait + +
+ integer +
+ 		+ +
Configure wait timer for a prefix peer.
+
+
+ vrf + +
+ string +
+ 		+ +
VRF name.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^router bgp'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • purged
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
State purged removes all the BGP configurations from the target device. Use caution with this state.
+
State deleted only removes BGP attributes that this modules manages and does not negate the BGP process completely. Thereby, preserving address-family related configurations under BGP context.
+
Running states deleted and replaced will result in an error if there are address-family configuration lines present under a neighbor, or a vrf context that is to be removed. Please use the cisco.nxos.nxos_bgp_af or cisco.nxos.nxos_bgp_neighbor_af modules for prior cleanup.
+
States merged and replaced will result in a failure if BGP is already configured with a different ASN than what is provided in the task. In such cases, please use state purged to remove the existing BGP process and proceed further.
+
States replaced and overridden have the same behaviour for this module.
+
Refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # Nexus9000v# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_bgp_global: + config: + as_number: 65563 + router_id: 192.168.1.1 + bestpath: + as_path: + multipath_relax: true + compare_neighborid: true + cost_community_ignore: true + confederation: + identifier: 42 + peers: + - 65020 + - 65030 + - 65040 + log_neighbor_changes: true + maxas_limit: 20 + neighbors: + - neighbor_address: 192.168.1.100 + neighbor_affinity_group: + group_id: 160 + bmp_activate_server: 1 + remote_as: 65563 + description: NBR-1 + low_memory: + exempt: true + - neighbor_address: 192.168.1.101 + remote_as: 65563 + password: + encryption: 7 + key: 12090404011C03162E + neighbor_down: + fib_accelerate: true + vrfs: + - vrf: site-1 + allocate_index: 5000 + local_as: 200 + log_neighbor_changes: true + neighbors: + - neighbor_address: 198.51.100.1 + description: site-1-nbr-1 + password: + encryption: 3 + key: 13D4D3549493D2877B1DC116EE27A6BE + remote_as: 65562 + - neighbor_address: 198.51.100.2 + remote_as: 65562 + description: site-1-nbr-2 + - vrf: site-2 + local_as: 300 + log_neighbor_changes: true + neighbors: + - neighbor_address: 203.0.113.2 + description: site-2-nbr-1 + password: + encryption: 3 + key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + remote_as: 65568 + neighbor_down: + fib_accelerate: true + + # Task output: + # ------------ + # before: {} + # + # commands: + # - router bgp 65563 + # - bestpath as-path multipath-relax + # - bestpath compare-neighborid + # - bestpath cost-community ignore + # - confederation identifier 42 + # - log-neighbor-changes + # - maxas-limit 20 + # - neighbor-down fib-accelerate + # - router-id 192.168.1.1 + # - confederation peers 65020 65030 65040 + # - neighbor 192.168.1.100 + # - remote-as 65563 + # - affinity-group 160 + # - bmp-activate-server 1 + # - description NBR-1 + # - low-memory exempt + # - neighbor 192.168.1.101 + # - remote-as 65563 + # - password 7 12090404011C03162E + # - vrf site-1 + # - allocate-index 5000 + # - local-as 200 + # - log-neighbor-changes + # - neighbor 198.51.100.1 + # - remote-as 65562 + # - description site-1-nbr-1 + # - password 3 13D4D3549493D2877B1DC116EE27A6BE + # - neighbor 198.51.100.2 + # - remote-as 65562 + # - description site-1-nbr-2 + # - vrf site-2 + # - local-as 300 + # - log-neighbor-changes + # - neighbor-down fib-accelerate + # - neighbor 203.0.113.2 + # - remote-as 65568 + # - description site-2-nbr-1 + # - password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + # + # after: + # as_number: '65563' + # bestpath: + # as_path: + # multipath_relax: true + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65040' + # log_neighbor_changes: true + # maxas_limit: 20 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # - neighbor_address: 192.168.1.101 + # password: + # encryption: 7 + # key: 12090404011C03162E + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - allocate_index: 5000 + # local_as: '200' + # log_neighbor_changes: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 198.51.100.1 + # password: + # encryption: 3 + # key: 13D4D3549493D2877B1DC116EE27A6BE + # remote_as: '65562' + # - description: site-1-nbr-2 + # neighbor_address: 198.51.100.2 + # remote_as: '65562' + # vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - description: site-2-nbr-1 + # neighbor_address: 203.0.113.2 + # password: + # encryption: 3 + # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + # remote_as: '65568' + # vrf: site-2 + + + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65040 + # bestpath as-path multipath-relax + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 20 + # log-neighbor-changes + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # neighbor 192.168.1.101 + # remote-as 65563 + # password 7 12090404011C03162E + # vrf site-1 + # local-as 200 + # log-neighbor-changes + # allocate-index 5000 + # neighbor 198.51.100.1 + # remote-as 65562 + # description site-1-nbr-1 + # password 3 13D4D3549493D2877B1DC116EE27A6BE + # neighbor 198.51.100.2 + # remote-as 65562 + # description site-1-nbr-2 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # remote-as 65568 + # description site-2-nbr-1 + # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + # Using replaced + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65040 + # bestpath as-path multipath-relax + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 20 + # log-neighbor-changes + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # neighbor 192.168.1.101 + # remote-as 65563 + # password 7 12090404011C03162E + # vrf site-1 + # local-as 200 + # log-neighbor-changes + # allocate-index 5000 + # neighbor 198.51.100.1 + # remote-as 65562 + # description site-1-nbr-1 + # password 3 13D4D3549493D2877B1DC116EE27A6BE + # neighbor 198.51.100.2 + # remote-as 65562 + # description site-1-nbr-2 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # remote-as 65568 + # description site-2-nbr-1 + # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + - name: Replace BGP configuration with provided configuration + cisco.nxos.nxos_bgp_global: + config: + as_number: 65563 + router_id: 192.168.1.1 + bestpath: + compare_neighborid: true + cost_community_ignore: true + confederation: + identifier: 42 + peers: + - 65020 + - 65030 + - 65050 + maxas_limit: 40 + neighbors: + - neighbor_address: 192.168.1.100 + neighbor_affinity_group: + group_id: 160 + bmp_activate_server: 1 + remote_as: 65563 + description: NBR-1 + low_memory: + exempt: true + neighbor_down: + fib_accelerate: true + vrfs: + - vrf: site-2 + local_as: 300 + log_neighbor_changes: true + neighbors: + - neighbor_address: 203.0.113.2 + password: + encryption: 7 + key: 12090404011C03162E + neighbor_down: + fib_accelerate: true + state: replaced + + # Task output: + # ------------ + # before: + # as_number: '65563' + # bestpath: + # as_path: + # multipath_relax: true + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65040' + # log_neighbor_changes: true + # maxas_limit: 20 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # - neighbor_address: 192.168.1.101 + # password: + # encryption: 7 + # key: 12090404011C03162E + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - allocate_index: 5000 + # local_as: '200' + # log_neighbor_changes: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 198.51.100.1 + # password: + # encryption: 3 + # key: 13D4D3549493D2877B1DC116EE27A6BE + # remote_as: '65562' + # - description: site-1-nbr-2 + # neighbor_address: 198.51.100.2 + # remote_as: '65562' + # vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - description: site-2-nbr-1 + # neighbor_address: 203.0.113.2 + # password: + # encryption: 3 + # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + # remote_as: '65568' + # vrf: site-2 + # + # commands: + # - router bgp 65563 + # - no bestpath as-path multipath-relax + # - no log-neighbor-changes + # - maxas-limit 40 + # - no confederation peers 65020 65030 65040 + # - confederation peers 65020 65030 65050 + # - no neighbor 192.168.1.101 + # - vrf site-2 + # - neighbor 203.0.113.2 + # - no remote-as 65568 + # - no description site-2-nbr-1 + # - password 7 12090404011C03162E + # - no vrf site-1 + + # after: + # as_number: '65563' + # bestpath: + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65050' + # maxas_limit: 40 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - neighbor_address: 203.0.113.2 + # password: + # encryption: 7 + # key: 12090404011C03162E + # vrf: site-2 + # + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65050 + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 40 + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # password 7 12090404011C03162E + + # Using deleted + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65040 + # bestpath as-path multipath-relax + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 20 + # log-neighbor-changes + # address-family ipv4 unicast + # default-metric 400 + # suppress-inactive + # default-information originate + # address-family ipv6 multicast + # wait-igp-convergence + # redistribute eigrp eigrp-1 route-map site-1-rmap + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # neighbor 192.168.1.101 + # remote-as 65563 + # password 7 12090404011C03162E + # vrf site-1 + # local-as 200 + # log-neighbor-changes + # allocate-index 5000 + # address-family ipv4 multicast + # maximum-paths 40 + # dampen-igp-metric 1200 + # neighbor 198.51.100.1 + # remote-as 65562 + # description site-1-nbr-1 + # password 3 13D4D3549493D2877B1DC116EE27A6BE + # neighbor 198.51.100.2 + # remote-as 65562 + # description site-1-nbr-2 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # remote-as 65568 + # description site-1-nbr-1 + # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + - name: Delete BGP configurations handled by this module + cisco.nxos.nxos_bgp_global: + state: deleted + + # Task output: + # ------------ + + # before: + # as_number: '65563' + # bestpath: + # as_path: + # multipath_relax: true + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65040' + # log_neighbor_changes: true + # maxas_limit: 20 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # - neighbor_address: 192.168.1.101 + # password: + # encryption: 7 + # key: 12090404011C03162E + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - allocate_index: 5000 + # local_as: '200' + # log_neighbor_changes: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 198.51.100.1 + # password: + # encryption: 3 + # key: 13D4D3549493D2877B1DC116EE27A6BE + # remote_as: '65562' + # - description: site-1-nbr-2 + # neighbor_address: 198.51.100.2 + # remote_as: '65562' + # vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 203.0.113.2 + # password: + # encryption: 3 + # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + # remote_as: '65568' + # vrf: site-2 + # + # commands: + # - router bgp 65563 + # - no bestpath as-path multipath-relax + # - no bestpath compare-neighborid + # - no bestpath cost-community ignore + # - no confederation identifier 42 + # - no log-neighbor-changes + # - no maxas-limit 20 + # - no neighbor-down fib-accelerate + # - no router-id 192.168.1.1 + # - no confederation peers 65020 65030 65040 + # - no neighbor 192.168.1.100 + # - no neighbor 192.168.1.101 + # - no vrf site-1 + # - no vrf site-2 + # + # after: + # as_number: '65563' + # + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # address-family ipv4 unicast + # default-metric 400 + # suppress-inactive + # default-information originate + # address-family ipv6 multicast + # wait-igp-convergence + # redistribute eigrp eigrp-1 route-map site-1-rmap + # + + # Using purged + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65040 + # bestpath as-path multipath-relax + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 20 + # log-neighbor-changes + # address-family ipv4 unicast + # default-metric 400 + # suppress-inactive + # default-information originate + # address-family ipv6 multicast + # wait-igp-convergence + # redistribute eigrp eigrp-1 route-map site-1-rmap + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # neighbor 192.168.1.101 + # remote-as 65563 + # password 7 12090404011C03162E + # vrf site-1 + # local-as 200 + # log-neighbor-changes + # allocate-index 5000 + # address-family ipv4 multicast + # maximum-paths 40 + # dampen-igp-metric 1200 + # neighbor 198.51.100.1 + # remote-as 65562 + # description site-1-nbr-1 + # password 3 13D4D3549493D2877B1DC116EE27A6BE + # neighbor 198.51.100.2 + # remote-as 65562 + # description site-1-nbr-2 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # remote-as 65568 + # description site-1-nbr-1 + # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + - name: Purge all BGP configurations from the device + cisco.nxos.nxos_bgp_global: + state: purged + + # Task output: + # ------------ + + # before: + # as_number: '65563' + # bestpath: + # as_path: + # multipath_relax: true + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65040' + # log_neighbor_changes: true + # maxas_limit: 20 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # - neighbor_address: 192.168.1.101 + # password: + # encryption: 7 + # key: 12090404011C03162E + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - allocate_index: 5000 + # local_as: '200' + # log_neighbor_changes: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 198.51.100.1 + # password: + # encryption: 3 + # key: 13D4D3549493D2877B1DC116EE27A6BE + # remote_as: '65562' + # - description: site-1-nbr-2 + # neighbor_address: 198.51.100.2 + # remote_as: '65562' + # vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 203.0.113.2 + # password: + # encryption: 3 + # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + # remote_as: '65568' + # vrf: site-2 + # + # commands: + # - no router bgp 65563 + # + # after: {} + # + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # Nexus9000v# + + # Using rendered + + - name: Render platform specific configuration lines (without connecting to the device) + cisco.nxos.nxos_bgp_global: + config: + as_number: 65563 + router_id: 192.168.1.1 + bestpath: + as_path: + multipath_relax: true + compare_neighborid: true + cost_community_ignore: true + confederation: + identifier: 42 + peers: + - 65020 + - 65030 + - 65040 + log_neighbor_changes: true + maxas_limit: 20 + neighbors: + - neighbor_address: 192.168.1.100 + neighbor_affinity_group: + group_id: 160 + bmp_activate_server: 1 + remote_as: 65563 + description: NBR-1 + low_memory: + exempt: true + - neighbor_address: 192.168.1.101 + remote_as: 65563 + password: + encryption: 7 + key: 12090404011C03162E + neighbor_down: + fib_accelerate: true + vrfs: + - vrf: site-1 + allocate_index: 5000 + local_as: 200 + log_neighbor_changes: true + neighbors: + - neighbor_address: 198.51.100.1 + description: site-1-nbr-1 + password: + encryption: 3 + key: 13D4D3549493D2877B1DC116EE27A6BE + remote_as: 65562 + - neighbor_address: 198.51.100.2 + remote_as: 65562 + description: site-1-nbr-2 + - vrf: site-2 + local_as: 300 + log_neighbor_changes: true + neighbors: + - neighbor_address: 203.0.113.2 + description: site-1-nbr-1 + password: + encryption: 3 + key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + remote_as: 65568 + neighbor_down: + fib_accelerate: true + + # Task output: + # ------------ + # rendered: + # - router bgp 65563 + # - bestpath as-path multipath-relax + # - bestpath compare-neighborid + # - bestpath cost-community ignore + # - confederation identifier 42 + # - log-neighbor-changes + # - maxas-limit 20 + # - neighbor-down fib-accelerate + # - router-id 192.168.1.1 + # - confederation peers 65020 65030 65040 + # - neighbor 192.168.1.100 + # - remote-as 65563 + # - affinity-group 160 + # - bmp-activate-server 1 + # - description NBR-1 + # - low-memory exempt + # - neighbor 192.168.1.101 + # - remote-as 65563 + # - password 7 12090404011C03162E + # - vrf site-1 + # - allocate-index 5000 + # - local-as 200 + # - log-neighbor-changes + # - neighbor 198.51.100.1 + # - remote-as 65562 + # - description site-1-nbr-1 + # - password 3 13D4D3549493D2877B1DC116EE27A6BE + # - neighbor 198.51.100.2 + # - remote-as 65562 + # - description site-1-nbr-2 + # - vrf site-2 + # - local-as 300 + # - log-neighbor-changes + # - neighbor-down fib-accelerate + # - neighbor 203.0.113.2 + # - remote-as 65568 + # - description site-1-nbr-1 + # - password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + # Using parsed + + # parsed.cfg + # ------------ + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65040 + # bestpath as-path multipath-relax + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 20 + # log-neighbor-changes + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # neighbor 192.168.1.101 + # remote-as 65563 + # password 7 12090404011C03162E + # vrf site-1 + # local-as 200 + # log-neighbor-changes + # allocate-index 5000 + # neighbor 198.51.100.1 + # remote-as 65562 + # description site-1-nbr-1 + # password 3 13D4D3549493D2877B1DC116EE27A6BE + # neighbor 198.51.100.2 + # remote-as 65562 + # description site-1-nbr-2 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # remote-as 65568 + # description site-1-nbr-1 + # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + - name: Parse externally provided BGP config + cisco.nxos.nxos_bgp_global: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output: + # ------------ + # parsed: + # as_number: '65563' + # bestpath: + # as_path: + # multipath_relax: true + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65040' + # log_neighbor_changes: true + # maxas_limit: 20 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # - neighbor_address: 192.168.1.101 + # password: + # encryption: 7 + # key: 12090404011C03162E + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - allocate_index: 5000 + # local_as: '200' + # log_neighbor_changes: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 198.51.100.1 + # password: + # encryption: 3 + # key: 13D4D3549493D2877B1DC116EE27A6BE + # remote_as: '65562' + # - description: site-1-nbr-2 + # neighbor_address: 198.51.100.2 + # remote_as: '65562' + # vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 203.0.113.2 + # password: + # encryption: 3 + # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + # remote_as: '65568' + # vrf: site-2 + + # Using gathered + + # existing config + # + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65050 + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 40 + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # vrf site-1 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # password 7 12090404011C03162E + + - name: Gather BGP facts using gathered + cisco.nxos.nxos_bgp_global: + state: gathered + + # Task output: + # ------------ + # gathered: + # as_number: '65563' + # bestpath: + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65050' + # maxas_limit: 40 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - neighbor_address: 203.0.113.2 + # password: + # encryption: 7 + # key: 12090404011C03162E + # vrf: site-2 + + # Remove a neighbor having AF configurations with state replaced (will fail) + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # log-neighbor-changes + # maxas-limit 20 + # router-id 198.51.100.2 + # neighbor 203.0.113.2 + # address-family ipv4 unicast + # next-hop-self + # remote-as 65538 + # affinity-group 160 + # description NBR-1 + # low-memory exempt + # neighbor 192.0.2.1 + # remote-as 65537 + # password 7 12090404011C03162E + + - name: Remove a neighbor having AF configurations (should fail) + cisco.nxos.nxos_bgp_global: + config: + as_number: 65536 + router_id: 198.51.100.2 + maxas_limit: 20 + log_neighbor_changes: true + neighbors: + - neighbor_address: 192.0.2.1 + remote_as: 65537 + password: + encryption: 7 + key: 12090404011C03162E + state: replaced + + # Task output: + # ------------ + # fatal: [Nexus9000v]: FAILED! => changed=false + # msg: Neighbor 203.0.113.2 has address-family configurations. + # Please use the nxos_bgp_neighbor_af module to remove those first. + + # Remove a VRF having AF configurations with state replaced (will fail) + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # log-neighbor-changes + # maxas-limit 20 + # router-id 198.51.100.2 + # neighbor 192.0.2.1 + # remote-as 65537 + # password 7 12090404011C03162E + # vrf site-1 + # address-family ipv4 unicast + # default-information originate + # neighbor 203.0.113.2 + # remote-as 65538 + # affinity-group 160 + # description NBR-1 + # low-memory exempt + # vrf site-2 + # neighbor-down fib-accelerate + + - name: Remove a VRF having AF configurations (should fail) + cisco.nxos.nxos_bgp_global: + config: + as_number: 65536 + router_id: 198.51.100.2 + maxas_limit: 20 + log_neighbor_changes: true + neighbors: + - neighbor_address: 192.0.2.1 + remote_as: 65537 + password: + encryption: 7 + key: 12090404011C03162E + vrfs: + - vrf: site-2 + neighbor_down: + fib_accelerate: true + state: replaced + + # Task output: + # ------------ + # fatal: [Nexus9000v]: FAILED! => changed=false + # msg: VRF site-1 has address-family configurations. + # Please use the nxos_bgp_af module to remove those first. + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['router bgp 65563', 'maxas-limit 20', 'router-id 192.168.1.1', 'confederation peers 65020 65030 65040', 'neighbor 192.168.1.100', 'remote-as 65563', 'affinity-group 160', 'bmp-activate-server 1', 'description NBR-1', 'low-memory exempt', 'vrf site-1', 'log-neighbor-changes', 'neighbor 198.51.100.1', 'remote-as 65562', 'description site-1-nbr-1', 'password 3 13D4D3549493D2877B1DC116EE27A6BE']
+
+
+ gathered + +
+ dictionary +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ dictionary +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['router bgp 65563', 'maxas-limit 20', 'router-id 192.168.1.1']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst b/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst new file mode 100644 index 000000000..8668a0b9f --- /dev/null +++ b/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst @@ -0,0 +1,3575 @@ +.. _cisco.nxos.nxos_bgp_neighbor_address_family_module: + + +******************************************* +cisco.nxos.nxos_bgp_neighbor_address_family +******************************************* + +**BGP Neighbor Address Family resource module.** + + +Version added: 2.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages BGP Neighbor Address Family configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
BGP Neighbor AF configuration.
+
+
+ as_number + +
+ string +
+ 		+ +
Autonomous System Number of the router.
+
+
+ neighbors + +
+ list + / elements=dictionary +
+ 		+ +
A list of BGP Neighbor AF configuration.
+
+
+ address_family + +
+ list + / elements=dictionary +
+ 		+ +
BGP Neighbor Address Family related configurations.
+
+
+ advertise_map + +
+ dictionary +
+ 		+ +
Specify route-map for conditional advertisement.
+
+
+ exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition exists.
+
+
+ non_exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition does not exist.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
Route-map name.
+
+
+ advertisement_interval + +
+ integer +
+ 		+ +
Minimum interval between sending BGP routing updates.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
  • link-state
    • +
  • vpnv4
    • +
  • vpnv6
    • +
  • l2vpn
    • +
+ 		+
Address Family indicator.
+
+
+ allowas_in + +
+ dictionary +
+ 		+ +
Accept as-path with my AS present in it.
+
+
+ max_occurences + +
+ integer +
+ 		+ +
Number of occurrences of AS number, default is 3.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Activate allowas-in property.
+
+
+ as_override + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Override matching AS-number while sending update.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Advertise capability to the peer.
+
+
+ additional_paths + +
+ dictionary +
+ 		+ +
Additional paths capability.
+
+
+ receive + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Receive capability.
+
+
+ send + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Send capability.
+
+
+ default_originate + +
+ dictionary +
+ 		+ +
Originate a default toward this peer.
+
+
+ route_map + +
+ string +
+ 		+ +
Route-map to specify criteria for originating default.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set default-originate attribute.
+
+
+ disable_peer_as_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable checking of peer AS-number while advertising.
+
+
+ filter_list + +
+ dictionary +
+ 		+ +
Name of filter-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a template.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence number.
+
+
+ template + +
+ string +
+ 		+ +
Template name.
+
+
+ maximum_prefix + +
+ dictionary +
+ 		+ +
Maximum number of prefixes from this neighbor.
+
+
+ generate_warning_threshold + +
+ integer +
+ 		+ +
Threshold percentage at which to generate a warning.
+
+
+ max_prefix_limit + +
+ integer +
+ 		+ +
Maximum prefix limit.
+
+
+ restart_interval + +
+ integer +
+ 		+ +
Restart bgp connection after limit is exceeded.
+
+
+ warning_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Only give a warning message when limit is exceeded.
+
+
+ next_hop_self + +
+ dictionary +
+ 		+ +
Set our address as nexthop (non-reflected).
+
+
+ all_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set our address as nexthop for all routes.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set next-hop-self attribute.
+
+
+ next_hop_third_party + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compute a third-party nexthop if possible.
+
+
+ prefix_list + +
+ dictionary +
+ 		+ +
Apply prefix-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ rewrite_evpn_rt_asn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Auto generate RTs for EBGP neighbor.
+
+
+ rewrite_rt_asn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Auto generate RTs for EBGP neighbor.
+
+
+ route_map + +
+ dictionary +
+ 		+ +
Apply route-map to neighbor.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ route_reflector_client + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure a neighbor as Route reflector client.
+
+
+ safi + +
+ string +
+ 		+
    Choices: +
  • unicast
    • +
  • multicast
    • +
  • mvpn
    • +
  • evpn
    • +
+ 		+
Sub Address Family indicator.
+
+
+ send_community + +
+ dictionary +
+ 		+ +
Send Community attribute to this neighbor.
+
+
+ both + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Standard and Extended Community attributes.
+
+
+ extended + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Extended Community attribute.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set send-community attribute.
+
+
+ standard + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Standard Community attribute.
+
+
+ soft_reconfiguration_inbound + +
+ dictionary +
+ 		+ +
Soft reconfiguration.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always perform inbound soft reconfiguration.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set soft-reconfiguration inbound attribute.
+
+
+ soo + +
+ string +
+ 		+ +
Specify Site-of-origin extcommunity.
+
+
+ suppress_inactive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise only active routes to peer.
+
+
+ unsuppress_map + +
+ string +
+ 		+ +
Route-map to selectively unsuppress suppressed routes.
+
+
+ weight + +
+ integer +
+ 		+ +
Set default weight for routes from this neighbor.
+
+
+ neighbor_address + +
+ string + / required +
+ 		+ +
IP/IPv6 address of the neighbor.
+
+
+ vrfs + +
+ list + / elements=dictionary +
+ 		+ +
Virtual Router Context.
+
+
+ neighbors + +
+ list + / elements=dictionary +
+ 		+ +
A list of BGP Neighbor AF configuration.
+
+
+ address_family + +
+ list + / elements=dictionary +
+ 		+ +
BGP Neighbor Address Family related configurations.
+
+
+ advertise_map + +
+ dictionary +
+ 		+ +
Specify route-map for conditional advertisement.
+
+
+ exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition exists.
+
+
+ non_exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition does not exist.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
Route-map name.
+
+
+ advertisement_interval + +
+ integer +
+ 		+ +
Minimum interval between sending BGP routing updates.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
  • link-state
    • +
  • vpnv4
    • +
  • vpnv6
    • +
  • l2vpn
    • +
+ 		+
Address Family indicator.
+
+
+ allowas_in + +
+ dictionary +
+ 		+ +
Accept as-path with my AS present in it.
+
+
+ max_occurences + +
+ integer +
+ 		+ +
Number of occurrences of AS number, default is 3.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Activate allowas-in property.
+
+
+ as_override + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Override matching AS-number while sending update.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Advertise capability to the peer.
+
+
+ additional_paths + +
+ dictionary +
+ 		+ +
Additional paths capability.
+
+
+ receive + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Receive capability.
+
+
+ send + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Send capability.
+
+
+ default_originate + +
+ dictionary +
+ 		+ +
Originate a default toward this peer.
+
+
+ route_map + +
+ string +
+ 		+ +
Route-map to specify criteria for originating default.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set default-originate attribute.
+
+
+ disable_peer_as_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable checking of peer AS-number while advertising.
+
+
+ filter_list + +
+ dictionary +
+ 		+ +
Name of filter-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a template.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence number.
+
+
+ template + +
+ string +
+ 		+ +
Template name.
+
+
+ maximum_prefix + +
+ dictionary +
+ 		+ +
Maximum number of prefixes from this neighbor.
+
+
+ generate_warning_threshold + +
+ integer +
+ 		+ +
Threshold percentage at which to generate a warning.
+
+
+ max_prefix_limit + +
+ integer +
+ 		+ +
Maximum prefix limit.
+
+
+ restart_interval + +
+ integer +
+ 		+ +
Restart bgp connection after limit is exceeded.
+
+
+ warning_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Only give a warning message when limit is exceeded.
+
+
+ next_hop_self + +
+ dictionary +
+ 		+ +
Set our address as nexthop (non-reflected).
+
+
+ all_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set our address as nexthop for all routes.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set next-hop-self attribute.
+
+
+ next_hop_third_party + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compute a third-party nexthop if possible.
+
+
+ prefix_list + +
+ dictionary +
+ 		+ +
Apply prefix-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ rewrite_evpn_rt_asn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Auto generate RTs for EBGP neighbor.
+
+
+ rewrite_rt_asn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Auto generate RTs for EBGP neighbor.
+
+
+ route_map + +
+ dictionary +
+ 		+ +
Apply route-map to neighbor.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ route_reflector_client + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure a neighbor as Route reflector client.
+
+
+ safi + +
+ string +
+ 		+
    Choices: +
  • unicast
    • +
  • multicast
    • +
  • mvpn
    • +
  • evpn
    • +
+ 		+
Sub Address Family indicator.
+
+
+ send_community + +
+ dictionary +
+ 		+ +
Send Community attribute to this neighbor.
+
+
+ both + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Standard and Extended Community attributes.
+
+
+ extended + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Extended Community attribute.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set send-community attribute.
+
+
+ standard + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Standard Community attribute.
+
+
+ soft_reconfiguration_inbound + +
+ dictionary +
+ 		+ +
Soft reconfiguration.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always perform inbound soft reconfiguration.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set soft-reconfiguration inbound attribute.
+
+
+ soo + +
+ string +
+ 		+ +
Specify Site-of-origin extcommunity.
+
+
+ suppress_inactive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise only active routes to peer.
+
+
+ unsuppress_map + +
+ string +
+ 		+ +
Route-map to selectively unsuppress suppressed routes.
+
+
+ weight + +
+ integer +
+ 		+ +
Set default weight for routes from this neighbor.
+
+
+ neighbor_address + +
+ string + / required +
+ 		+ +
IP/IPv6 address of the neighbor.
+
+
+ vrf + +
+ string +
+ 		+ +
VRF name.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^router bgp'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
State deleted only removes BGP attributes that this modules manages and does not negate the BGP process completely.
+
Refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - For managing BGP address family configurations please use the :ref:`cisco.nxos.nxos_bgp_address_family ` module. + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # Nexus9000v# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_bgp_neighbor_address_family: &id001 + config: + as_number: 65536 + neighbors: + - neighbor_address: 192.0.2.32 + address_family: + - afi: ipv4 + safi: unicast + maximum_prefix: + max_prefix_limit: 20 + generate_warning_threshold: 75 + weight: 100 + prefix_list: + inbound: rmap1 + outbound: rmap2 + - afi: ipv6 + safi: unicast + - neighbor_address: 192.0.2.33 + address_family: + - afi: ipv4 + safi: multicast + inherit: + template: BasePolicy + sequence: 200 + vrfs: + - vrf: site-1 + neighbors: + - neighbor_address: 203.0.113.1 + address_family: + - afi: ipv4 + safi: unicast + suppress_inactive: true + next_hop_self: + set: true + - neighbor_address: 203.0.113.2 + address_family: + - afi: ipv6 + safi: unicast + - afi: ipv4 + safi: multicast + send_community: + set: true + + # Task output: + # ------------ + # before: {} + # + # commands: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - address-family ipv4 unicast + # - maximum-prefix 20 75 + # - weight 100 + # - prefix-list rmap1 in + # - prefix-list rmap2 out + # - address-family ipv6 unicast + # - neighbor 192.0.2.33 + # - address-family ipv4 multicast + # - inherit peer-policy BasePolicy 200 + # - vrf site-1 + # - neighbor 203.0.113.1 + # - address-family ipv4 unicast + # - suppress-inactive + # - next-hop-self + # - neighbor 203.0.113.2 + # - address-family ipv6 unicast + # - address-family ipv4 multicast + # - send-community + # + # after: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + # Using replaced + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + - name: Replace specified neighbor AFs with given configuration + cisco.nxos.nxos_bgp_neighbor_address_family: &replaced + config: + as_number: 65536 + neighbors: + - neighbor_address: 192.0.2.32 + address_family: + - afi: ipv4 + safi: unicast + weight: 110 + - afi: ipv6 + safi: unicast + - neighbor_address: 192.0.2.33 + address_family: + - afi: ipv4 + safi: multicast + inherit: + template: BasePolicy + sequence: 200 + vrfs: + - vrf: site-1 + neighbors: + - neighbor_address: 203.0.113.1 + address_family: + - afi: ipv4 + safi: unicast + - neighbor_address: 203.0.113.2 + address_family: + - afi: ipv6 + safi: unicast + - afi: ipv4 + safi: multicast + send_community: + set: true + state: replaced + + # Task output: + # ------------ + # before: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + # + # commands: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - address-family ipv4 unicast + # - no maximum-prefix 20 75 + # - weight 110 + # - no prefix-list rmap1 in + # - no prefix-list rmap2 out + # - vrf site-1 + # - neighbor 203.0.113.1 + # - address-family ipv4 unicast + # - no suppress-inactive + # - no next-hop-self + # + # after: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # weight: 110 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # weight 110 + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + # Using overridden + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + - name: Override all BGP AF configuration with provided configuration + cisco.nxos.nxos_bgp_neighbor_address_family: + config: + as_number: 65536 + neighbors: + - neighbor_address: 192.0.2.32 + address_family: + - afi: ipv4 + safi: unicast + vrfs: + - vrf: site-1 + neighbors: + - neighbor_address: 203.0.113.1 + address_family: + - afi: ipv4 + safi: unicast + suppress_inactive: true + next_hop_self: + set: true + state: overridden + + # Task output: + # ------------ + # before: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + # + # commands: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - address-family ipv4 unicast + # - no maximum-prefix 20 75 + # - no weight 100 + # - no prefix-list rmap1 in + # - no prefix-list rmap2 out + # - no address-family ipv6 unicast + # - neighbor 192.0.2.33 + # - no address-family ipv4 multicast + # - vrf site-1 + # - neighbor 203.0.113.2 + # - no address-family ipv4 multicast + # - no address-family ipv6 unicast + # + # after: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + + # Using deleted to remove specified neighbor AFs + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + - name: Delete BGP configs handled by this module + cisco.nxos.nxos_bgp_neighbor_address_family: + config: + as_number: 65536 + neighbors: + - neighbor_address: 192.0.2.32 + address_family: + - afi: ipv4 + safi: unicast + vrfs: + - vrf: site-1 + neighbors: + - neighbor_address: 203.0.113.2 + address_family: + - afi: ipv6 + safi: unicast + state: deleted + + # Task output: + # ------------ + # before: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + # + # commands: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - no address-family ipv4 unicast + # - vrf site-1 + # - neighbor 203.0.113.2 + # - no address-family ipv6 unicast + # + # after: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # + + # Using deleted to remove all neighbor AFs + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + - name: Delete all BGP neighbor AF configs handled by this module + cisco.nxos.nxos_bgp_neighbor_address_family: + state: deleted + + # Task output: + # ------------ + # before: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + # + # commands: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - no address-family ipv4 unicast + # - no address-family ipv6 unicast + # - neighbor 192.0.2.33 + # - no address-family ipv4 multicast + # - vrf site-1 + # - neighbor 203.0.113.1 + # - no address-family ipv4 unicast + # - neighbor 203.0.113.2 + # - no address-family ipv6 unicast + # - no address-family ipv4 multicast + # + # after: + # as_number: "65536" + # + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # neighbor 192.0.2.33 + # vrf site-1 + # neighbor 203.0.113.1 + # neighbor 203.0.113.2 + # + + # Using rendered + + - name: Render platform specific configuration lines with state rendered (without connecting to the device) + cisco.nxos.nxos_bgp_neighbor_address_family: + config: + as_number: 65536 + neighbors: + - neighbor_address: 192.0.2.32 + address_family: + - afi: ipv4 + safi: unicast + maximum_prefix: + max_prefix_limit: 20 + generate_warning_threshold: 75 + weight: 100 + prefix_list: + inbound: rmap1 + outbound: rmap2 + - afi: ipv6 + safi: unicast + - neighbor_address: 192.0.2.33 + address_family: + - afi: ipv4 + safi: multicast + inherit: + template: BasePolicy + sequence: 200 + vrfs: + - vrf: site-1 + neighbors: + - neighbor_address: 203.0.113.1 + address_family: + - afi: ipv4 + safi: unicast + suppress_inactive: true + next_hop_self: + set: true + - neighbor_address: 203.0.113.2 + address_family: + - afi: ipv6 + safi: unicast + - afi: ipv4 + safi: multicast + send_community: + set: true + state: rendered + + # Task output: + # ------------ + # rendered: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - address-family ipv4 unicast + # - maximum-prefix 20 75 + # - weight 100 + # - prefix-list rmap1 in + # - prefix-list rmap2 out + # - address-family ipv6 unicast + # - neighbor 192.0.2.33 + # - address-family ipv4 multicast + # - inherit peer-policy BasePolicy 200 + # - vrf site-1 + # - neighbor 203.0.113.1 + # - address-family ipv4 unicast + # - suppress-inactive + # - next-hop-self + # - neighbor 203.0.113.2 + # - address-family ipv6 unicast + # - address-family ipv4 multicast + # - send-community + + # Using parsed + + # parsed.cfg + # ------------ + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + + - name: Parse externally provided BGP neighbor AF config + register: result + cisco.nxos.nxos_bgp_neighbor_address_family: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output: + # ------------ + # parsed: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['router bgp 65536', 'neighbor 192.0.2.32', 'address-family ipv4 unicast']
+
+
+ gathered + +
+ dictionary +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ dictionary +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['router bgp 65536', 'neighbor 192.0.2.32', 'address-family ipv4 unicast']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_bgp_templates_module.rst b/docs/cisco.nxos.nxos_bgp_templates_module.rst new file mode 100644 index 000000000..9287d7a60 --- /dev/null +++ b/docs/cisco.nxos.nxos_bgp_templates_module.rst @@ -0,0 +1,2841 @@ +.. _cisco.nxos.nxos_bgp_templates_module: + + +***************************** +cisco.nxos.nxos_bgp_templates +***************************** + +**BGP Templates resource module.** + + +Version added: 4.2.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages BGP templates on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A list of BGP templates.
+
+
+ as_number + +
+ string +
+ 		+ +
Autonomous System Number of the router.
+
+
+ neighbor + +
+ list + / elements=dictionary +
+ 		+ +
Configure BGP peer templates.
+
+
+ address_family + +
+ list + / elements=dictionary +
+ 		+ +
Configure an address-family for peer.
+
+
+ advertise_map + +
+ dictionary +
+ 		+ +
Specify route-map for conditional advertisement.
+
+
+ exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition exists.
+
+
+ non_exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition does not exist.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
Route-map name.
+
+
+ advertisement_interval + +
+ integer +
+ 		+ +
Minimum interval between sending BGP routing updates.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
  • link-state
    • +
  • l2vpn
    • +
+ 		+
Address Family indicator.
+
+
+ allowas_in + +
+ dictionary +
+ 		+ +
Accept as-path with my AS present in it.
+
+
+ max_occurences + +
+ integer +
+ 		+ +
Number of occurrences of AS number, default is 3.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Activate allowas-in property.
+
+
+ as_override + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Override matching AS-number while sending update.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Advertise capability to the peer.
+
+
+ additional_paths + +
+ dictionary +
+ 		+ +
Additional paths capability.
+
+
+ receive + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Receive capability.
+
+
+ send + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Send capability.
+
+
+ default_originate + +
+ dictionary +
+ 		+ +
Originate a default toward this peer.
+
+
+ route_map + +
+ string +
+ 		+ +
Route-map to specify criteria for originating default.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set default-originate attribute.
+
+
+ disable_peer_as_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable checking of peer AS-number while advertising.
+
+
+ filter_list + +
+ dictionary +
+ 		+ +
Name of filter-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a peer-policy template.
+
+
+ peer_policy + +
+ string +
+ 		+ +
Peer-policy template to inherit.
+
+
+ maximum_prefix + +
+ dictionary +
+ 		+ +
Maximum number of prefixes from this neighbor.
+
+
+ generate_warning_threshold + +
+ integer +
+ 		+ +
Threshold percentage at which to generate a warning.
+
+
+ max_prefix_limit + +
+ integer +
+ 		+ +
Maximum prefix limit.
+
+
+ restart_interval + +
+ integer +
+ 		+ +
Restart bgp connection after limit is exceeded.
+
+
+ warning_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Only give a warning message when limit is exceeded.
+
+
+ next_hop_self + +
+ dictionary +
+ 		+ +
Set our address as nexthop (non-reflected).
+
+
+ all_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set our address as nexthop for all routes.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set next-hop-self attribute.
+
+
+ next_hop_third_party + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compute a third-party nexthop if possible.
+
+
+ prefix_list + +
+ dictionary +
+ 		+ +
Apply prefix-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ route_map + +
+ dictionary +
+ 		+ +
Apply route-map to neighbor.
+
+
+ inbound + +
+ string +
+ 		+ +
Name of policy to apply to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Name of policy to apply to outgoing routes.
+
+
+ route_reflector_client + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure a neighbor as Route reflector client.
+
+
+ safi + +
+ string +
+ 		+
    Choices: +
  • unicast
    • +
  • multicast
    • +
  • mvpn
    • +
  • evpn
    • +
+ 		+
Sub Address Family indicator.
+
+
+ send_community + +
+ string +
+ 		+
    Choices: +
  • standard
    • +
  • extended
    • +
  • both
    • +
+ 		+
Send Community attribute to this neighbor.
+
+
+ soft_reconfiguration_inbound + +
+ dictionary +
+ 		+ +
Soft reconfiguration.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always perform inbound soft reconfiguration.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set soft-reconfiguration inbound attribute.
+
+
+ soo + +
+ string +
+ 		+ +
Specify Site-of-origin extcommunity.
+
+
+ suppress_inactive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise only active routes to peer.
+
+
+ unsuppress_map + +
+ string +
+ 		+ +
Route-map to selectively unsuppress suppressed routes.
+
+
+ weight + +
+ integer +
+ 		+ +
Set default weight for routes from this neighbor.
+
+
+ bfd + +
+ dictionary +
+ 		+ +
Bidirectional Fast Detection for the neighbor.
+
+
+ multihop + +
+ dictionary +
+ 		+ +
Multihop session.
+
+
+ interval + +
+ dictionary +
+ 		+ +
Configure BFD session interval parameters.
+
+
+ min_rx_interval + +
+ integer + / required +
+ 		+ +
Minimum RX interval.
+
+
+ multiplier + +
+ integer + / required +
+ 		+ +
Detect Multiplier.
+
+
+ tx_interval + +
+ integer + / required +
+ 		+ +
TX interval in milliseconds.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD multihop.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD for this neighbor.
+
+
+ singlehop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Single-hop session.
+
+
+ bmp_activate_server + +
+ integer +
+ 		+ +
Specify server ID for activating BMP monitoring for the peer.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Capability.
+
+
+ suppress_4_byte_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress 4-byte AS Capability.
+
+
+ description + +
+ string +
+ 		+ +
Neighbor specific descripion.
+
+
+ disable_connected_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable check for directly connected peer.
+
+
+ dont_capability_negotiate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Don't negotiate capability with this neighbor.
+
+
+ dscp + +
+ string +
+ 		+ +
Set dscp value for tcp transport.
+
+
+ dynamic_capability + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Dynamic Capability
+
+
+ ebgp_multihop + +
+ integer +
+ 		+ +
Specify multihop TTL for remote peer.
+
+
+ graceful_shutdown + +
+ dictionary +
+ 		+ +
Graceful-shutdown for this neighbor.
+
+
+ activate + +
+ dictionary +
+ 		+ +
Send graceful-shutdown community.
+
+
+ route_map + +
+ string +
+ 		+ +
Apply route-map to modify attributes for outbound.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set activate.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a template.
+
+
+ peer_session + +
+ string +
+ 		+ +
Peer-session template to inherit.
+
+
+ local_as + +
+ string +
+ 		+ +
Specify the local-as number for the eBGP neighbor.
+
+
+ log_neighbor_changes + +
+ dictionary +
+ 		+ +
Log message for neighbor up/down event.
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable logging of neighbor up/down event.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set log-neighbor-changes.
+
+
+ low_memory + +
+ dictionary +
+ 		+ +
Behaviour in low memory situations.
+
+
+ exempt + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not shutdown this peer when under memory pressure.
+
+
+ name + +
+ string +
+ 		+ +
Name of the BGP peer template.
+
+
+ password + +
+ dictionary +
+ 		+ +
Configure a password for neighbor.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 specifies an UNENCRYPTED neighbor password.
+
3 specifies an 3DES ENCRYPTED neighbor password will follow.
+
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
+
+
+ key + +
+ string +
+ 		+ +
Authentication password.
+
+
+ path_attribute + +
+ list + / elements=dictionary +
+ 		+ +
BGP path attribute optional filtering.
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • discard
    • +
  • treat-as-withdraw
    • +
+ 		+
Action.
+
+
+ range + +
+ dictionary +
+ 		+ +
Path attribute range.
+
+
+ end + +
+ integer +
+ 		+ +
Path attribute range end value.
+
+
+ start + +
+ integer +
+ 		+ +
Path attribute range start value.
+
+
+ type + +
+ integer +
+ 		+ +
Path attribute type
+
+
+ remote_as + +
+ string +
+ 		+ +
Specify Autonomous System Number of the neighbor.
+
+
+ remove_private_as + +
+ dictionary +
+ 		+ +
Remove private AS number from outbound updates.
+
+
+ all + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All.
+
+
+ replace_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Replace.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Remove private AS.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown this neighbor.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure keepalive and hold timers.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Holdtime (seconds).
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval (seconds).
+
+
+ transport + +
+ dictionary +
+ 		+ +
BGP transport connection.
+
+
+ connection_mode + +
+ dictionary +
+ 		+ +
Specify type of connection.
+
+
+ passive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Allow passive connection setup only.
+
+
+ ttl_security + +
+ dictionary +
+ 		+ +
Enable TTL Security Mechanism.
+
+
+ hops + +
+ integer +
+ 		+ +
Specify hop count for remote peer.
+
+
+ update_source + +
+ string +
+ 		+ +
Specify source of BGP session and updates.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config bgp | section 'template'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
Refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # -------------- + # + # nxos9k# show running-config | section "^router bgp" + # nxos9k# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_bgp_templates: + config: + as_number: 65536 + neighbor: + - name: neighbor_tmplt_1 + address_family: + - afi: ipv4 + safi: unicast + advertise_map: + route_map: rmap1 + non_exist_map: nemap1 + advertisement_interval: 60 + disable_peer_as_check: true + bmp_activate_server: 2 + capability: + suppress_4_byte_as: true + description: Test_BGP_PEER_TEMPLATE_1 + local_as: 65536 + remote_as: 65001 + + - name: neighbor_tmplt_2 + description: Test_BGP_PEER_TEMPLATE_2 + address_family: + - afi: ipv4 + safi: multicast + advertise_map: + route_map: rmap1 + exist_map: emap1 + as_override: true + filter_list: + inbound: flist1 + outbound: flist2 + inherit: + peer_session: psession1 + timers: + holdtime: 100 + keepalive: 45 + # Task Output: + # ------------ + # before: {} + # + # commands: + # - router bgp 65536 + # - template peer neighbor_tmplt_1 + # - bmp-activate-server 2 + # - capability suppress 4-byte-as + # - description Test_BGP_PEER_TEMPLATE_1 + # - local-as 65536 + # - remote-as 65001 + # - address-family ipv4 unicast + # - advertise-map rmap1 non-exist-map nemap1 + # - advertisement-interval 60 + # - disable-peer-as-check + # - template peer neighbor_tmplt_2 + # - description Test_BGP_PEER_TEMPLATE_2 + # - inherit peer-session psession1 + # - timers 45 100 + # - address-family ipv4 multicast + # - advertise-map rmap1 exist-map emap1 + # - as-override + # - filter-list flist1 in + # - filter-list flist2 out + # + # after: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # bmp_activate_server: 2 + # capability: + # suppress_4_byte_as: true + # description: Test_BGP_PEER_TEMPLATE_1 + # local_as: "65536" + # remote_as: "65001" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + + # After state: + # -------------- + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # capability suppress 4-byte-as + # bmp-activate-server 2 + # description Test_BGP_PEER_TEMPLATE_1 + # local-as 65536 + # remote-as 65001 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + # Using replaced + + # Before state: + # ------------- + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # capability suppress 4-byte-as + # description Test_BGP_PEER_TEMPLATE_1 + # bmp-activate-server 2 + # local-as 65536 + # remote-as 65001 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + - name: Replace BGP templates configuration with provided configuration + cisco.nxos.nxos_bgp_templates: + config: + as_number: 65536 + neighbor: + - name: neighbor_tmplt_1 + address_family: + - afi: ipv4 + safi: unicast + advertise_map: + route_map: rmap1 + non_exist_map: nemap1 + advertisement_interval: 60 + disable_peer_as_check: true + inherit: + peer_session: psession1 + description: Test_BGP_PEER_TEMPLATE_1 + local_as: 65537 + state: replaced + + # Task output: + # ------------ + # + # before: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # bmp_activate_server: 2 + # capability: + # suppress_4_byte_as: true + # description: Test_BGP_PEER_TEMPLATE_1 + # local_as: "65536" + # remote_as: "65001" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + # + # commands: + # - router bgp 65536 + # - template peer neighbor_tmplt_1 + # - no bmp-activate-server 2 + # - no capability suppress 4-byte-as + # - inherit peer-session psession1 + # - local-as 65537 + # - no remote-as 65001 + # + # after: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # description: Test_BGP_PEER_TEMPLATE_1 + # inherit: + # peer_session: psession1 + # local_as: "65537" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + + # After state: + # ------------ + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # inherit peer-session psession1 + # description Test_BGP_PEER_TEMPLATE_1 + # local-as 65537 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # bmp-activate-server 2 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + # Using overridden + # + # Before state: + # ------------- + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # capability suppress 4-byte-as + # description Test_BGP_PEER_TEMPLATE_1 + # bmp-activate-server 2 + # local-as 65536 + # remote-as 65001 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + - name: Override BGP templates configuration with provided configuration + cisco.nxos.nxos_bgp_templates: + config: + as_number: 65536 + neighbor: + - name: neighbor_tmplt_1 + address_family: + - afi: ipv4 + safi: unicast + advertise_map: + route_map: rmap1 + non_exist_map: nemap1 + advertisement_interval: 60 + disable_peer_as_check: true + inherit: + peer_session: psession1 + description: Test_BGP_PEER_TEMPLATE_1 + local_as: 65537 + state: overridden + + # Task output: + # ------------ + # + # before: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # bmp_activate_server: 2 + # capability: + # suppress_4_byte_as: true + # description: Test_BGP_PEER_TEMPLATE_1 + # local_as: "65536" + # remote_as: "65001" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + # + # commands: + # - router bgp 65536 + # - template peer neighbor_tmplt_1 + # - no bmp-activate-server 2 + # - no capability suppress 4-byte-as + # - inherit peer-session psession1 + # - local-as 65537 + # - no remote-as 65001 + # - no template peer neighbor_tmplt_2 + # + # after: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # description: Test_BGP_PEER_TEMPLATE_1 + # inherit: + # peer_session: psession1 + # local_as: "65537" + + # After state: + # ------------ + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # inherit peer-session psession1 + # description Test_BGP_PEER_TEMPLATE_1 + # local-as 65537 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + + # Using deleted + + # Before state: + # -------------- + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # capability suppress 4-byte-as + # description Test_BGP_PEER_TEMPLATE_1 + # bmp-activate-server 2 + # local-as 65536 + # remote-as 65001 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + - name: Delete BGP configs handled by this module + cisco.nxos.nxos_bgp_templates: + state: deleted + + # Task output: + # ------------ + # + # before: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # bmp_activate_server: 2 + # capability: + # suppress_4_byte_as: true + # description: Test_BGP_PEER_TEMPLATE_1 + # local_as: "65536" + # remote_as: "65001" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + # + # commands: + # - router bgp 65536 + # - no template peer neighbor_tmplt_1 + # - no template peer neighbor_tmplt_2 + # + # after: {} + + # After state: + # ------------- + # nxos9k# show running-config | section "^router bgp" + # nxos9k# + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['router bgp 65536', 'template peer neighbor_tmplt_1', 'no bmp-activate-server 2', 'no capability suppress 4-byte-as', 'inherit peer-session psession1', 'local-as 65537', 'no remote-as 65001', 'no template peer neighbor_tmplt_2']
+
+
+ gathered + +
+ dictionary +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ dictionary +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['router bgp 65536', 'template peer neighbor_tmplt_1', 'bmp-activate-server 2', 'no capability suppress 4-byte-as', 'no template peer neighbor_tmplt_2']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_command_module.rst b/docs/cisco.nxos.nxos_command_module.rst new file mode 100644 index 000000000..4308a6582 --- /dev/null +++ b/docs/cisco.nxos.nxos_command_module.rst @@ -0,0 +1,258 @@ +.. _cisco.nxos.nxos_command_module: + + +*********************** +cisco.nxos.nxos_command +*********************** + +**Run arbitrary command on Cisco NXOS devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Sends an arbitrary command to an NXOS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ commands + +
+ list + / elements=raw + / required +
+ 		+ +
The commands to send to the remote NXOS device. The resulting output from the command is returned. If the wait_for argument is provided, the module is not returned until the condition is satisfied or the number of retires as expired.
+
The commands argument also accepts an alternative form that allows for complex values that specify the command to run and the output format to return. This can be done on a command by command basis. The complex argument supports the keywords command and output where command is the command to run and output is one of 'text' or 'json'.
+
If a command sent to the device requires answering a prompt, it is possible to pass a dict containing command, answer and prompt. Common answers are 'y' or "\r" (carriage return, must be double quotes). See examples.
+
+
+ interval + +
+ integer +
+ 		+ Default:
1
+ 		+
Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditional, the interval indicates how to long to wait before trying the command again.
+
+
+ match + +
+ string +
+ 		+
    Choices: +
  • any
    • +
  • all ←
    • +
+ 		+
The match argument is used in conjunction with the wait_for argument to specify the match policy. Valid values are all or any. If the value is set to all then all conditionals in the wait_for must be satisfied. If the value is set to any then only one of the values must be satisfied.
+
+
+ retries + +
+ integer +
+ 		+ Default:
9
+ 		+
Specifies the number of retries a command should by tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait_for conditionals.
+
The commands are run once when retries is set to 0.
+
+
+ wait_for + +
+ list + / elements=string +
+ 		+ +
Specifies what to evaluate from the output of the command and what conditionals to apply. This argument will cause the task to wait for a particular conditional to be true before moving forward. If the conditional is not true by the configured retries, the task fails. See examples.
+

aliases: waitfor
+
+
+ + +Notes +----- + +.. note:: + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: run show version on remote devices + cisco.nxos.nxos_command: + commands: show version + + - name: run show version and check to see if output contains Cisco + cisco.nxos.nxos_command: + commands: show version + wait_for: result[0] contains Cisco + + - name: run multiple commands on remote nodes + cisco.nxos.nxos_command: + commands: + - show version + - show interfaces + + - name: run multiple commands and evaluate the output + cisco.nxos.nxos_command: + commands: + - show version + - show interfaces + wait_for: + - result[0] contains Cisco + - result[1] contains loopback0 + + - name: run commands and specify the output format + cisco.nxos.nxos_command: + commands: + - command: show version + output: json + + - name: run commands that require answering a prompt + cisco.nxos.nxos_command: + commands: + - configure terminal + - command: no feature npv + prompt: Do you want to continue + answer: y + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ failed_conditions + +
+ list +
+ 		failed +
The list of conditionals that have failed
+
+
Sample:
+
['...', '...']
+
+
+ stdout + +
+ list +
+ 		always apart from low level errors (such as action plugin) +
The set of responses from the commands
+
+
Sample:
+
['...', '...']
+
+
+ stdout_lines + +
+ list +
+ 		always apart from low level errors (such as action plugin) +
The value of stdout split into a list
+
+
Sample:
+
[['...', '...'], ['...'], ['...']]
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_config_module.rst b/docs/cisco.nxos.nxos_config_module.rst new file mode 100644 index 000000000..3ead5ab50 --- /dev/null +++ b/docs/cisco.nxos.nxos_config_module.rst @@ -0,0 +1,566 @@ +.. _cisco.nxos.nxos_config_module: + + +********************** +cisco.nxos.nxos_config +********************** + +**Manage Cisco NXOS configuration sections** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- 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. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ after + +
+ list + / elements=string +
+ 		+ +
The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with before this allows the playbook designer to append a set of commands to be executed after the command set.
+
+
+ backup + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
This argument will cause the module to create a full backup of the current running-config from the remote device before any changes are made. If the backup_options value is not given, the backup file is written to the backup folder in the playbook root directory or role root directory, if playbook is part of an ansible role. If the directory does not exist, it is created.
+
+
+ backup_options + +
+ dictionary +
+ 		+ +
This is a dict object containing configurable options related to backup file path. The value of this option is read only when backup is set to True, if backup is set to false this option will be silently ignored.
+
+
+ dir_path + +
+ path +
+ 		+ +
This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be created and the filename is either the value of filename or default filename as described in filename options description. If the path value is not given in that case a backup directory will be created in the current working directory and backup configuration will be copied in filename within backup directory.
+
+
+ filename + +
+ string +
+ 		+ +
The filename to be used to store the backup configuration. If the filename is not given it will be generated based on the hostname, current time and date in format defined by <hostname>_config.<current-date>@<current-time>
+
+
+ before + +
+ list + / elements=string +
+ 		+ +
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.
+
+
+ defaults + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
The 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
+
+
+ diff_against + +
+ string +
+ 		+
    Choices: +
  • startup
    • +
  • intended
    • +
  • running
    • +
+ 		+
When using the ansible-playbook --diff command line argument the module can generate diffs against different sources.
+
When this option is configure as startup, the module will return the diff of the running-config against the startup-config.
+
When this option is configured as intended, the module will return the diff of the running-config against the configuration provided in the intended_config argument.
+
When this option is configured as running, the module will return the before and after diff of the running-config with respect to any changes made to the device configuration.
+
+
+ diff_ignore_lines + +
+ list + / elements=string +
+ 		+ +
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.
+
+
+ intended_config + +
+ string +
+ 		+ +
The 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 diff_against value and set it to intended. The configuration lines for this value should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure correct diff.
+
+
+ lines + +
+ list + / elements=string +
+ 		+ +
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 to ensure idempotency and correct diff. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser.
+

aliases: commands
+
+
+ match + +
+ string +
+ 		+
    Choices: +
  • line ←
    • +
  • strict
    • +
  • exact
    • +
  • none
    • +
+ 		+
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 line, commands are matched line by line. If match is set to strict, command lines are matched with respect to position. If match is set to exact, command lines must be an equal match. Finally, if match is set to none, the module will not attempt to compare the source configuration with the running configuration on the remote device.
+
+
+ parents + +
+ list + / elements=string +
+ 		+ +
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.
+
+
+ replace + +
+ string +
+ 		+
    Choices: +
  • line ←
    • +
  • block
    • +
  • config
    • +
+ 		+
Instructs the module on the way to perform the configuration on the device. If the replace argument is set to line then the modified lines are pushed to the device in configuration mode. If the replace argument is set to block then the entire command block is pushed to the device in configuration mode if any line is not correct. replace config will only work for NX-OS versions that support `config replace`.
+
+
+ replace_src + +
+ string +
+ 		+ +
The 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 replace with value config. This is mutually exclusive with the lines and src arguments. This argument will only work for NX-OS versions that support `config replace`. Use nxos_file_copy module to copy the flat file to remote device and then use the path with this argument. The configuration lines in the file should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure idempotency and correct diff.
+
+
+ running_config + +
+ string +
+ 		+ +
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 running_config argument allows the implementer to pass in the configuration to use as the base config for comparison. The configuration lines for this option should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure idempotency and correct diff.
+

aliases: config
+
+
+ save_when + +
+ string +
+ 		+
    Choices: +
  • always
    • +
  • never ←
    • +
  • modified
    • +
  • changed
    • +
+ 		+
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 always, then the running-config will always be copied to the startup-config and the modified flag will always be set to True. If the argument is set to 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 never, the running-config will never be copied to the startup-config. If the argument is set to changed, then the running-config will only be copied to the startup-config if the task has made a change. changed was added in Ansible 2.6.
+
+
+ src + +
+ path +
+ 		+ +
The 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 lines and parents arguments. The configuration lines in the source file should be similar to how it will appear if present in the running-configuration of the device including indentation to ensure idempotency and correct diff.
+
+
+ + +Notes +----- + +.. note:: + - Unsupported for Cisco MDS + - Abbreviated commands are NOT idempotent, see https://docs.ansible.com/ansible/latest/network/user_guide/faq.html#why-do-the-config-modules-always-return-changed-true-with-abbreviated-commands. + - To ensure idempotency and correct diff the configuration lines in the relevant module options should be similar to how they appear if present in the running configuration on device including the indentation. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: configure top level configuration and save it + cisco.nxos.nxos_config: + lines: hostname {{ inventory_hostname }} + save_when: modified + + - name: diff the running-config against a provided config + cisco.nxos.nxos_config: + diff_against: intended + intended_config: "{{ lookup('file', 'master.cfg') }}" + + - cisco.nxos.nxos_config: + lines: + - 10 permit ip 192.0.2.1/32 any log + - 20 permit ip 192.0.2.2/32 any log + - 30 permit ip 192.0.2.3/32 any log + - 40 permit ip 192.0.2.4/32 any log + - 50 permit ip 192.0.2.5/32 any log + parents: ip access-list test + before: no ip access-list test + match: exact + + - cisco.nxos.nxos_config: + lines: + - 10 permit ip 192.0.2.1/32 any log + - 20 permit ip 192.0.2.2/32 any log + - 30 permit ip 192.0.2.3/32 any log + - 40 permit ip 192.0.2.4/32 any log + parents: ip access-list test + before: no ip access-list test + replace: block + + - name: replace config with flat file + cisco.nxos.nxos_config: + replace_src: config.txt + replace: config + + - name: for idempotency, use full-form commands + cisco.nxos.nxos_config: + lines: + # - shut + - shutdown + # parents: int eth1/1 + parents: interface Ethernet1/1 + + - name: configurable backup path + cisco.nxos.nxos_config: + backup: true + backup_options: + filename: backup.cfg + dir_path: /home/user + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ backup_path + +
+ string +
+ 		when backup is yes +
The full path to the backup file
+
+
Sample:
+
/playbooks/ansible/backup/nxos_config.2016-07-16@22:28:34
+
+
+ commands + +
+ list +
+ 		always +
The set of commands that will be pushed to the remote device
+
+
Sample:
+
['hostname foo', 'vlan 1', 'name default']
+
+
+ date + +
+ string +
+ 		when backup is yes +
The date extracted from the backup file name
+
+
Sample:
+
2016-07-16
+
+
+ filename + +
+ string +
+ 		when backup is yes and filename is not specified in backup options +
The name of the backup file
+
+
Sample:
+
nxos_config.2016-07-16@22:28:34
+
+
+ shortname + +
+ string +
+ 		when backup is yes and filename is not specified in backup options +
The full path to the backup file excluding the timestamp
+
+
Sample:
+
/playbooks/ansible/backup/nxos_config
+
+
+ time + +
+ string +
+ 		when backup is yes +
The time extracted from the backup file name
+
+
Sample:
+
22:28:34
+
+
+ updates + +
+ list +
+ 		always +
The set of commands that will be pushed to the remote device
+
+
Sample:
+
['hostname foo', 'vlan 1', 'name default']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_devicealias_module.rst b/docs/cisco.nxos.nxos_devicealias_module.rst new file mode 100644 index 000000000..081c8759f --- /dev/null +++ b/docs/cisco.nxos.nxos_devicealias_module.rst @@ -0,0 +1,273 @@ +.. _cisco.nxos.nxos_devicealias_module: + + +*************************** +cisco.nxos.nxos_devicealias +*************************** + +**Configuration of device alias for Cisco NXOS MDS Switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Configuration of device alias for Cisco MDS NXOS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ da + +
+ list + / elements=dictionary +
+ 		+ +
List of device-alias to be added or removed
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the device-alias to be added or removed
+
+
+ pwwn + +
+ string +
+ 		+ +
pwwn to which the name needs to be associated with
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Removes the device-alias if set to True
+
+
+ distribute + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable device-alias distribution
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • basic
    • +
  • enhanced
    • +
+ 		+
Mode of devices-alias, basic or enhanced
+
+
+ rename + +
+ list + / elements=dictionary +
+ 		+ +
List of device-alias to be renamed
+
+
+ new_name + +
+ string + / required +
+ 		+ +
New name of the device-alias
+
+
+ old_name + +
+ string + / required +
+ 		+ +
Old name of the device-alias that needs to be renamed
+
+
+ + +Notes +----- + +.. note:: + - Tested against Cisco MDS NX-OS 8.4(1) + + + +Examples +-------- + +.. code-block:: yaml + + - name: Test that device alias module works + cisco.nxos.nxos_devicealias: + da: + - name: test1_add + pwwn: 56:2:22:11:22:88:11:67 + - name: test2_add + pwwn: 65:22:22:11:22:22:11:d + - name: dev1 + remove: true + - name: dev2 + remove: true + distribute: true + mode: enhanced + rename: + - new_name: bcd + old_name: abc + - new_name: bcd1 + old_name: abc1 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['terminal dont-ask', 'device-alias database', 'device-alias name somename pwwn 10:00:00:00:89:a1:01:03', 'device-alias name somename1 pwwn 10:00:00:00:89:a1:02:03', 'device-alias commit', 'no terminal dont-ask']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) diff --git a/docs/cisco.nxos.nxos_evpn_global_module.rst b/docs/cisco.nxos.nxos_evpn_global_module.rst new file mode 100644 index 000000000..d1b2a8241 --- /dev/null +++ b/docs/cisco.nxos.nxos_evpn_global_module.rst @@ -0,0 +1,122 @@ +.. _cisco.nxos.nxos_evpn_global_module: + + +*************************** +cisco.nxos.nxos_evpn_global +*************************** + +**Handles the EVPN control plane for VXLAN.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Handles the EVPN control plane for VXLAN. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ nv_overlay_evpn + +
+ boolean + / required +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
EVPN control plane.
+
+
+ + +Notes +----- + +.. note:: + - This module is not supported on Nexus 3000 series of switches. + - Unsupported for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_evpn_global: + nv_overlay_evpn: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The set of commands to be sent to the remote device
+
+
Sample:
+
['nv overlay evpn']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_evpn_vni_module.rst b/docs/cisco.nxos.nxos_evpn_vni_module.rst new file mode 100644 index 000000000..530a9ff18 --- /dev/null +++ b/docs/cisco.nxos.nxos_evpn_vni_module.rst @@ -0,0 +1,212 @@ +.. _cisco.nxos.nxos_evpn_vni_module: + + +************************ +cisco.nxos.nxos_evpn_vni +************************ + +**Manages Cisco EVPN VXLAN Network Identifier (VNI).** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages Cisco Ethernet Virtual Private Network (EVPN) VXLAN Network Identifier (VNI) configurations of a Nexus device. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ route_distinguisher + +
+ string +
+ 		+ +
The VPN Route Distinguisher (RD). The RD is combined with the IPv4 or IPv6 prefix learned by the PE router to create a globally unique address.
+
+
+ route_target_both + +
+ list + / elements=string +
+ 		+ +
Enables/Disables route-target settings for both import and export target communities using a single property.
+
+
+ route_target_export + +
+ list + / elements=string +
+ 		+ +
Sets the route-target 'export' extended communities.
+
+
+ route_target_import + +
+ list + / elements=string +
+ 		+ +
Sets the route-target 'import' extended communities.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Determines whether the config should be present or not on the device.
+
+
+ vni + +
+ string + / required +
+ 		+ +
The EVPN VXLAN Network Identifier.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - default, where supported, restores params default value. + - RD override is not permitted. You should set it to the default values first and then reconfigure it. + - ``route_target_both``, ``route_target_import`` and ``route_target_export valid`` values are a list of extended communities, (i.e. ['1.2.3.4:5', '33:55']) or the keywords 'auto' or 'default'. + - The ``route_target_both`` property is discouraged due to the inconsistent behavior of the property across Nexus platforms and image versions. For this reason it is recommended to use explicit ``route_target_export`` and ``route_target_import`` properties instead of ``route_target_both``. + - RD valid values are a string in one of the route-distinguisher formats, the keyword 'auto', or the keyword 'default'. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: vni configuration + cisco.nxos.nxos_evpn_vni: + vni: 6000 + route_distinguisher: 60:10 + route_target_import: + - "5000:10" + - "4100:100" + route_target_export: auto + route_target_both: default + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['evpn', 'vni 6000 l2', 'route-target import 5001:10']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_facts_module.rst b/docs/cisco.nxos.nxos_facts_module.rst new file mode 100644 index 000000000..3ce96abea --- /dev/null +++ b/docs/cisco.nxos.nxos_facts_module.rst @@ -0,0 +1,553 @@ +.. _cisco.nxos.nxos_facts_module: + + +********************* +cisco.nxos.nxos_facts +********************* + +**Gets facts about NX-OS switches** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Collects facts from Cisco Nexus devices running the NX-OS operating system. Fact collection is supported over both ``network_cli`` and ``httpapi``. This module prepends all of the base network fact keys with ``ansible_net_``. The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ available_network_resources + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
When set to true a list of network resources for which resource modules are available will be provided.
+
+
+ gather_network_resources + +
+ list + / elements=string +
+ 		+ +
When supplied, this argument will gather configuration facts only for the given subset. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
+
Valid subsets are all, bfd_interfaces, lag_interfaces, telemetry, vlans, lacp, lacp_interfaces, interfaces, l3_interfaces, l2_interfaces, lldp_global, acls, acl_interfaces, ospfv2, ospfv3, ospf_interfaces, bgp_global, bgp_address_family, route_maps, prefix_lists, logging_global, ntp_global, snmp_server, hostname.
+
+
+ gather_subset + +
+ list + / elements=string +
+ 		+ Default:
"min"
+ 		+
When supplied, this argument will gather operational facts only for the given subset. Possible values for this argument include all, hardware, config, legacy, interfaces, and min. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Gather all legacy facts + cisco.nxos.nxos_facts: + gather_subset: all + - name: Gather only the config and default facts + cisco.nxos.nxos_facts: + gather_subset: + - config + - name: Do not gather hardware facts + cisco.nxos.nxos_facts: + gather_subset: + - '!hardware' + - name: Gather legacy and resource facts + cisco.nxos.nxos_facts: + gather_subset: all + gather_network_resources: all + - name: Gather only the interfaces resource facts and no legacy facts + cisco.nxos.nxos_facts: + gather_subset: + - '!all' + - '!min' + gather_network_resources: + - interfaces + - name: Gather interfaces resource and minimal legacy facts + cisco.nxos.nxos_facts: + gather_subset: min + gather_network_resources: interfaces + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ ansible_net_all_ipv4_addresses + +
+ list +
+ 		when interfaces is configured +
All IPv4 addresses configured on the device
+
+
+
+ ansible_net_all_ipv6_addresses + +
+ list +
+ 		when interfaces is configured +
All IPv6 addresses configured on the device
+
+
+
+ ansible_net_api + +
+ string +
+ 		always +
The name of the transport
+
+
+
+ ansible_net_config + +
+ string +
+ 		when config is configured +
The current active config from the device
+
+
+
+ ansible_net_filesystems + +
+ list +
+ 		when hardware is configured +
All file system names available on the device
+
+
+
+ ansible_net_gather_network_resources + +
+ list +
+ 		when the resource is configured +
The list of fact for network resource subsets collected from the device
+
+
+
+ ansible_net_gather_subset + +
+ list +
+ 		always +
The list of fact subsets collected from the device
+
+
+
+ ansible_net_hostname + +
+ string +
+ 		always +
The configured hostname of the device
+
+
+
+ ansible_net_image + +
+ string +
+ 		always +
The image file the device is running
+
+
+
+ ansible_net_interfaces + +
+ dictionary +
+ 		when interfaces is configured +
A hash of all interfaces running on the system
+
+
+
+ ansible_net_license_hostid + +
+ string +
+ 		always +
The License host id of the device
+
+
+
+ ansible_net_memfree_mb + +
+ integer +
+ 		when hardware is configured +
The available free memory on the remote device in Mb
+
+
+
+ ansible_net_memtotal_mb + +
+ integer +
+ 		when hardware is configured +
The total memory on the remote device in Mb
+
+
+
+ ansible_net_model + +
+ string +
+ 		always +
The model name returned from the device
+
+
+
+ ansible_net_neighbors + +
+ dictionary +
+ 		when interfaces is configured +
The list of LLDP and CDP neighbors from the device. If both, CDP and LLDP neighbor data is present on one port, CDP is preferred.
+
+
+
+ ansible_net_python_version + +
+ string +
+ 		always +
The Python version Ansible controller is using
+
+
+
+ ansible_net_serialnum + +
+ string +
+ 		always +
The serial number of the remote device
+
+
+
+ ansible_net_version + +
+ string +
+ 		always +
The operating system version running on the remote device
+
+
+
+ fan_info + +
+ dictionary +
+ 		when legacy is configured +
A hash of facts about fans in the remote device
+
+
+
+ hostname + +
+ dictionary +
+ 		when legacy is configured +
The configured hostname of the remote device
+
+
+
+ interfaces_list + +
+ dictionary +
+ 		when legacy is configured +
The list of interface names on the remote device
+
+
+
+ kickstart + +
+ string +
+ 		when legacy is configured +
The software version used to boot the system
+
+
+
+ module + +
+ dictionary +
+ 		when legacy is configured +
A hash of facts about the modules in a remote device
+
+
+
+ platform + +
+ string +
+ 		when legacy is configured +
The hardware platform reported by the remote device
+
+
+
+ power_supply_info + +
+ string +
+ 		when legacy is configured +
A hash of facts about the power supplies in the remote device
+
+
+
+ vlan_list + +
+ list +
+ 		when legacy is configured +
The list of VLAN IDs configured on the remote device
+
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_feature_module.rst b/docs/cisco.nxos.nxos_feature_module.rst new file mode 100644 index 000000000..ee2539180 --- /dev/null +++ b/docs/cisco.nxos.nxos_feature_module.rst @@ -0,0 +1,150 @@ +.. _cisco.nxos.nxos_feature_module: + + +*********************** +cisco.nxos.nxos_feature +*********************** + +**Manage features in NX-OS switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Offers ability to enable and disable features in NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ feature + +
+ string + / required +
+ 		+ +
Name of feature.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • enabled ←
    • +
  • disabled
    • +
+ 		+
Desired state of the feature.
+
+
+ + +Notes +----- + +.. note:: + - Tested against Cisco MDS NX-OS 9.2(2) + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - 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 Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The set of commands to be sent to the remote device
+
+
Sample:
+
['nv overlay evpn']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) +- Suhas Bharadwaj (@srbharadwaj) diff --git a/docs/cisco.nxos.nxos_gir_module.rst b/docs/cisco.nxos.nxos_gir_module.rst new file mode 100644 index 000000000..61c809ea0 --- /dev/null +++ b/docs/cisco.nxos.nxos_gir_module.rst @@ -0,0 +1,302 @@ +.. _cisco.nxos.nxos_gir_module: + + +******************* +cisco.nxos.nxos_gir +******************* + +**Trigger a graceful removal or insertion (GIR) of the switch.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Trigger a graceful removal or insertion (GIR) of the switch. +- GIR processing may take more than 2 minutes. Timeout settings are automatically extended to 200s when user timeout settings are insufficient. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specify desired state of the resource.
+
+
+ system_mode_maintenance + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
When system_mode_maintenance=true it puts all enabled protocols in maintenance mode (using the isolate command). When system_mode_maintenance=false it puts all enabled protocols in normal mode (using the no isolate command).
+
+
+ system_mode_maintenance_dont_generate_profile + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
When system_mode_maintenance_dont_generate_profile=true it prevents the dynamic searching of enabled protocols and executes commands configured in a maintenance-mode profile. Use this option if you want the system to use a maintenance-mode profile that you have created. When system_mode_maintenance_dont_generate_profile=false it prevents the dynamic searching of enabled protocols and executes commands configured in a normal-mode profile. Use this option if you want the system to use a normal-mode profile that you have created.
+
+
+ system_mode_maintenance_on_reload_reset_reason + +
+ string +
+ 		+
    Choices: +
  • hw_error
    • +
  • svc_failure
    • +
  • kern_failure
    • +
  • wdog_timeout
    • +
  • fatal_error
    • +
  • lc_failure
    • +
  • match_any
    • +
  • manual_reload
    • +
  • any_other
    • +
  • maintenance
    • +
+ 		+
Boots the switch into maintenance mode automatically in the event of a specified system crash. Note that not all reset reasons are applicable for all platforms. Also if reset reason is set to match_any, it is not idempotent as it turns on all reset reasons. If reset reason is match_any and state is absent, it turns off all the reset reasons.
+
+
+ system_mode_maintenance_shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Shuts down all protocols, vPC domains, and interfaces except the management interface (using the shutdown command). This option is disruptive while system_mode_maintenance (which uses the isolate command) is not.
+
+
+ system_mode_maintenance_timeout + +
+ string +
+ 		+ +
Keeps the switch in maintenance mode for a specified number of minutes. Range is 5-65535.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - ``state`` has effect only in combination with ``system_mode_maintenance_timeout`` or ``system_mode_maintenance_on_reload_reset_reason``. + - Using ``system_mode_maintenance`` and ``system_mode_maintenance_dont_generate_profile`` would make the module fail, but the system mode will be triggered anyway. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Trigger system maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance: true + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Trigger system normal mode + - cisco.nxos.nxos_gir: + system_mode_maintenance: false + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Configure on-reload reset-reason for maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance_on_reload_reset_reason: manual_reload + state: present + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Add on-reload reset-reason for maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance_on_reload_reset_reason: hw_error + state: present + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Remove on-reload reset-reason for maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance_on_reload_reset_reason: manual_reload + state: absent + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Set timeout for maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance_timeout: 30 + state: present + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Remove timeout for maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance_timeout: 30 + state: absent + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ final_system_mode + +
+ string +
+ 		verbose mode +
describe the last system mode
+
+
Sample:
+
normal
+
+
+ updates + +
+ list +
+ 		verbose mode +
commands sent to the device
+
+
Sample:
+
['terminal dont-ask', 'system mode maintenance timeout 10']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_gir_profile_management_module.rst b/docs/cisco.nxos.nxos_gir_profile_management_module.rst new file mode 100644 index 000000000..95d85ae9b --- /dev/null +++ b/docs/cisco.nxos.nxos_gir_profile_management_module.rst @@ -0,0 +1,235 @@ +.. _cisco.nxos.nxos_gir_profile_management_module: + + +************************************** +cisco.nxos.nxos_gir_profile_management +************************************** + +**Create a maintenance-mode or normal-mode profile for GIR.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manage a maintenance-mode or normal-mode profile with configuration commands that can be applied during graceful removal or graceful insertion. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ commands + +
+ list + / elements=string +
+ 		+ +
List of commands to be included into the profile.
+
+
+ mode + +
+ string + / required +
+ 		+
    Choices: +
  • maintenance
    • +
  • normal
    • +
+ 		+
Configure the profile as Maintenance or Normal mode.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specify desired state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - ``state=absent`` removes the whole profile. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Create a maintenance-mode profile + - cisco.nxos.nxos_gir_profile_management: + mode: maintenance + commands: + - router eigrp 11 + - isolate + + # Remove the maintenance-mode profile + - cisco.nxos.nxos_gir_profile_management: + mode: maintenance + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ end_state + +
+ list +
+ 		verbose mode +
list of profile entries after module execution.
+
+
Sample:
+
['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete', 'router eigrp 11', 'isolate']
+
+
+ existing + +
+ list +
+ 		verbose mode +
list of existing profile commands.
+
+
Sample:
+
['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete']
+
+
+ proposed + +
+ list +
+ 		verbose mode +
list of commands passed into module.
+
+
Sample:
+
['router eigrp 11', 'isolate']
+
+
+ updates + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['configure maintenance profile maintenance-mode', 'router eigrp 11', 'isolate']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_hostname_module.rst b/docs/cisco.nxos.nxos_hostname_module.rst new file mode 100644 index 000000000..c8a9ee45d --- /dev/null +++ b/docs/cisco.nxos.nxos_hostname_module.rst @@ -0,0 +1,344 @@ +.. _cisco.nxos.nxos_hostname_module: + + +************************ +cisco.nxos.nxos_hostname +************************ + +**Hostname resource module.** + + +Version added: 2.9.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages hostname configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A dictionary of hostname configuration.
+
+
+ hostname + +
+ string +
+ 		+ +
Hostname of the device.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section hostname.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
The states merged, replaced and overridden have identical behaviour for this module.
+
Refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged (replaced, overridden has the same behaviour) + + # Before state: + # ------------- + # nxos-9k-rdo# show running-config | section ^hostname + # nxos-9k-rdo# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_hostname: + config: + hostname: NXOSv-9k + + # Task output + # ------------- + # before: {} + # + # commands: + # - hostname NXOSv-9k + # + # after: + # hostname: NXOSv-9k + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section ^hostname + # hostname NXOSv-9k + # + + # Using deleted + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section ^hostname + # hostname NXOSv-9k + + - name: Delete hostname from running-config + cisco.nxos.nxos_hostname: + state: deleted + + # Task output + # ------------- + # before: + # hostname: NXOSv-9k + # + # commands: + # - no hostname NXOSv-9k + # + # after: {} + + # Using gathered + + - name: Gather hostname facts using gathered + cisco.nxos.nxos_hostname: + state: gathered + + # Task output (redacted) + # ----------------------- + # gathered: + # hostname: NXOSv-9k + + # Using rendered + + - name: Render platform specific configuration lines (without connecting to the device) + cisco.nxos.nxos_hostname: + config: + hostname: NXOSv-9k + + # Task Output (redacted) + # ----------------------- + # rendered: + # - hostname NXOSv-9k + + # Using parsed + + # parsed.cfg + # ------------ + # hostname NXOSv-9k + + - name: Parse externally provided hostname config + cisco.nxos.nxos_hostname: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # hostname: NXOSv-9k + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['hostname switch01']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['hostname switch01']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst b/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst new file mode 100644 index 000000000..163612413 --- /dev/null +++ b/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst @@ -0,0 +1,344 @@ +.. _cisco.nxos.nxos_hsrp_interfaces_module: + + +******************************* +cisco.nxos.nxos_hsrp_interfaces +******************************* + +**HSRP interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages Hot Standby Router Protocol (HSRP) interface attributes. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
The provided configuration
+
+
+ bfd + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/Disable HSRP Bidirectional Forwarding Detection (BFD) on the interface.
+
+
+ name + +
+ string +
+ 		+ +
The name of the interface.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state the configuration should be left in
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 7.0(3)I5(1). + - Feature bfd should be enabled for this module. + - Unsupported for Cisco MDS + + + +Examples +-------- + +.. code-block:: yaml + + # Using deleted + + - name: Configure hsrp attributes on interfaces + cisco.nxos.nxos_hsrp_interfaces: + config: + - name: Ethernet1/1 + - name: Ethernet1/2 + operation: deleted + + + # Using merged + + - name: Configure hsrp attributes on interfaces + cisco.nxos.nxos_hsrp_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + - name: Ethernet1/2 + bfd: disable + operation: merged + + + # Using overridden + + - name: Configure hsrp attributes on interfaces + cisco.nxos.nxos_hsrp_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + - name: Ethernet1/2 + bfd: disable + operation: overridden + + + # Using replaced + + - name: Configure hsrp attributes on interfaces + cisco.nxos.nxos_hsrp_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + - name: Ethernet1/2 + bfd: disable + operation: replaced + + # Using rendered + + - name: Use rendered state to convert task input to device specific commands + cisco.nxos.nxos_hsrp_interfaces: + config: + - name: Ethernet1/800 + bfd: enable + - name: Ethernet1/801 + bfd: enable + state: rendered + + # Task Output (redacted) + # ----------------------- + + # rendered: + # - "interface Ethernet1/800" + # - "hsrp bfd" + # - "interface Ethernet1/801" + # - "hsrp bfd" + + # Using parsed + + # parsed.cfg + # ------------ + # interface Ethernet1/800 + # no switchport + # hsrp bfd + # interface Ethernet1/801 + # no switchport + # hsrp bfd + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_hsrp_interfaces: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + + # parsed: + # - name: Ethernet1/800 + # bfd: enable + # - name: Ethernet1/801 + # bfd: enable + + # Using gathered + + # Existing device config state + # ------------------------------- + + # interface Ethernet1/1 + # no switchport + # hsrp bfd + # interface Ethernet1/2 + # no switchport + # hsrp bfd + # interface Ethernet1/3 + # no switchport + + - name: Gather hsrp_interfaces facts from the device using nxos_hsrp_interfaces + cisco.nxos.nxos_hsrp_interfaces: + state: gathered + + # Task output (redacted) + # ----------------------- + + # gathered: + # - name: Ethernet1/1 + # bfd: enable + # - name: Ethernet1/2 + # bfd: enable + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/1', 'hsrp bfd']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_hsrp_module.rst b/docs/cisco.nxos.nxos_hsrp_module.rst new file mode 100644 index 000000000..0a55a4423 --- /dev/null +++ b/docs/cisco.nxos.nxos_hsrp_module.rst @@ -0,0 +1,305 @@ +.. _cisco.nxos.nxos_hsrp_module: + + +******************** +cisco.nxos.nxos_hsrp +******************** + +**Manages HSRP configuration on NX-OS switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages HSRP configuration on NX-OS switches. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ auth_string + +
+ string +
+ 		+ +
Authentication string. If this needs to be hidden(for md5 type), the string should be 7 followed by the key string. Otherwise, it can be 0 followed by key string or just key string (for backward compatibility). For text type, this should be just be a key string. if this is 'default', authentication is removed.
+
+
+ auth_type + +
+ string +
+ 		+
    Choices: +
  • text
    • +
  • md5
    • +
+ 		+
Authentication type.
+
+
+ group + +
+ string + / required +
+ 		+ +
HSRP group number.
+
+
+ interface + +
+ string + / required +
+ 		+ +
Full name of interface that is being managed for HSRP.
+
+
+ preempt + +
+ string +
+ 		+
    Choices: +
  • enabled
    • +
  • disabled
    • +
+ 		+
Enable/Disable preempt.
+
+
+ priority + +
+ string +
+ 		+ +
HSRP priority or keyword 'default'.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specify desired state of the resource.
+
+
+ version + +
+ string +
+ 		+
    Choices: +
  • 1 ←
    • +
  • 2
    • +
+ 		+
HSRP version.
+
+
+ vip + +
+ string +
+ 		+ +
HSRP virtual IP address or keyword 'default'
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - HSRP feature needs to be enabled first on the system. + - SVIs must exist before using this module. + - Interface must be a L3 port before using this module. + - HSRP cannot be configured on loopback interfaces. + - MD5 authentication is only possible with HSRPv2 while it is ignored if HSRPv1 is used instead, while it will not raise any error. Here we allow MD5 authentication only with HSRPv2 in order to enforce better practice. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Ensure HSRP is configured with following params on a SVI + cisco.nxos.nxos_hsrp: + group: 10 + vip: 10.1.1.1 + priority: 150 + interface: vlan10 + preempt: enabled + + - name: Ensure HSRP is configured with following params on a SVI with clear text authentication + cisco.nxos.nxos_hsrp: + group: 10 + vip: 10.1.1.1 + priority: 150 + interface: vlan10 + preempt: enabled + auth_type: text + auth_string: CISCO + + - name: Ensure HSRP is configured with md5 authentication and clear authentication + string + cisco.nxos.nxos_hsrp: + group: 10 + vip: 10.1.1.1 + priority: 150 + interface: vlan10 + preempt: enabled + auth_type: md5 + auth_string: 0 1234 + + - name: Ensure HSRP is configured with md5 authentication and hidden authentication + string + cisco.nxos.nxos_hsrp: + group: 10 + vip: 10.1.1.1 + priority: 150 + interface: vlan10 + preempt: enabled + auth_type: md5 + auth_string: 7 1234 + + - name: Remove HSRP config for given interface, group, and VIP + cisco.nxos.nxos_hsrp: + group: 10 + interface: vlan10 + vip: 10.1.1.1 + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['interface vlan10', 'hsrp version 2', 'hsrp 30', 'ip 10.30.1.1']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_igmp_module.rst b/docs/cisco.nxos.nxos_igmp_module.rst new file mode 100644 index 000000000..dbb46206f --- /dev/null +++ b/docs/cisco.nxos.nxos_igmp_module.rst @@ -0,0 +1,191 @@ +.. _cisco.nxos.nxos_igmp_module: + + +******************** +cisco.nxos.nxos_igmp +******************** + +**Manages IGMP global configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages IGMP global configuration configuration settings. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ enforce_rtr_alert + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables or disables the enforce router alert option check for IGMPv2 and IGMPv3 packets.
+
+
+ flush_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Removes routes when the IGMP process is restarted. By default, routes are not flushed.
+
+
+ restart + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Restarts the igmp process (using an exec config command).
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • default
    • +
+ 		+
Manages desired state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - When ``state=default``, all supported params will be reset to a default state. + - If restart is set to true with other params set, the restart will happen last, i.e. after the configuration takes place. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Default igmp global params (all params except restart) + cisco.nxos.nxos_igmp: + state: default + + - name: Ensure the following igmp global config exists on the device + cisco.nxos.nxos_igmp: + flush_routes: true + enforce_rtr_alert: true + + - name: Restart the igmp process + cisco.nxos.nxos_igmp: + restart: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ updates + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['ip igmp flush-routes']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_igmp_snooping_module.rst b/docs/cisco.nxos.nxos_igmp_snooping_module.rst new file mode 100644 index 000000000..31af97509 --- /dev/null +++ b/docs/cisco.nxos.nxos_igmp_snooping_module.rst @@ -0,0 +1,225 @@ +.. _cisco.nxos.nxos_igmp_snooping_module: + + +***************************** +cisco.nxos.nxos_igmp_snooping +***************************** + +**Manages IGMP snooping global configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages IGMP snooping global configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ group_timeout + +
+ string +
+ 		+ +
Group membership timeout value for all VLANs on the device. Accepted values are integer in range 1-10080, never and default.
+
+
+ link_local_grp_supp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Global link-local groups suppression.
+
+
+ report_supp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Global IGMPv1/IGMPv2 Report Suppression.
+
+
+ snooping + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/disables IGMP snooping on the switch.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • default
    • +
+ 		+
Manage the state of the resource.
+
+
+ v3_report_supp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Global IGMPv3 Report Suppression and Proxy Reporting.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - When ``state=default``, params will be reset to a default state. + - ``group_timeout`` also accepts *never* as an input. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure igmp snooping params supported in this module are in there default state + - cisco.nxos.nxos_igmp_snooping: + state: default + + # ensure following igmp snooping params are in the desired state + - cisco.nxos.nxos_igmp_snooping: + group_timeout: never + snooping: true + link_local_grp_supp: false + optimize_mcast_flood: false + report_supp: true + v3_report_supp: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['ip igmp snooping link-local-groups-suppression', 'ip igmp snooping group-timeout 50', 'no ip igmp snooping report-suppression', 'no ip igmp snooping v3-report-suppression', 'no ip igmp snooping']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_install_os_module.rst b/docs/cisco.nxos.nxos_install_os_module.rst new file mode 100644 index 000000000..ddd630d01 --- /dev/null +++ b/docs/cisco.nxos.nxos_install_os_module.rst @@ -0,0 +1,183 @@ +.. _cisco.nxos.nxos_install_os_module: + + +************************** +cisco.nxos.nxos_install_os +************************** + +**Set boot options like boot, kickstart image and issu.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Install an operating system by setting the boot options like boot image and kickstart image and optionally select to install using ISSU (In Server Software Upgrade). + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ issu + +
+ string +
+ 		+
    Choices: +
  • required
    • +
  • desired
    • +
  • yes
    • +
  • no ←
    • +
+ 		+
Upgrade using In Service Software Upgrade (ISSU). (Supported on N5k, N7k, N9k platforms)
+
Selecting 'required' or 'yes' means that upgrades will only proceed if the switch is capable of ISSU.
+
Selecting 'desired' means that upgrades will use ISSU if possible but will fall back to disruptive upgrade if needed.
+
Selecting 'no' means do not use ISSU. Forced disruptive.
+
+
+ kickstart_image_file + +
+ string +
+ 		+ +
Name of the kickstart image file on flash. (Not required on all Nexus platforms)
+
+
+ system_image_file + +
+ string + / required +
+ 		+ +
Name of the system (or combined) image file on flash.
+
+
+ + +Notes +----- + +.. note:: + - Tested against the following platforms and images - N9k 7.0(3)I4(6), 7.0(3)I5(3), 7.0(3)I6(1), 7.0(3)I7(1), 7.0(3)F2(2), 7.0(3)F3(2) - N3k 6.0(2)A8(6), 6.0(2)A8(8), 7.0(3)I6(1), 7.0(3)I7(1) - N7k 7.3(0)D1(1), 8.0(1), 8.1(1), 8.2(1) + - Tested against Cisco MDS NX-OS 9.2(1) + - This module requires both the ANSIBLE_PERSISTENT_CONNECT_TIMEOUT and ANSIBLE_PERSISTENT_COMMAND_TIMEOUT timers to be set to 600 seconds or higher. The module will exit if the timers are not set properly. + - When using connection local, ANSIBLE_PERSISTENT_CONNECT_TIMEOUT and ANSIBLE_PERSISTENT_COMMAND_TIMEOUT can only be set using ENV variables or the ansible.cfg file. + - Do not include full file paths, just the name of the file(s) stored on the top level flash directory. + - This module attempts to install the software immediately, which may trigger a reboot. + - In check mode, the module will indicate if an upgrade is needed and whether or not the upgrade is disruptive or non-disruptive(ISSU). + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Install OS on N9k + check_mode: false + cisco.nxos.nxos_install_os: + system_image_file: nxos.7.0.3.I6.1.bin + issu: desired + + - name: Wait for device to come back up with new image + wait_for: + port: 22 + state: started + timeout: 500 + delay: 60 + host: '{{ inventory_hostname }}' + + - name: Check installed OS for newly installed version + nxos_command: + commands: [show version | json] + register: output + + - assert: + that: + - output['stdout'][0]['kickstart_ver_str'] == '7.0(3)I6(1)' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ install_state + +
+ dictionary +
+ 		always +
Boot and install information.
+
+
Sample:
+
{'install_state': ['Compatibility check is done:', 'Module bootable Impact Install-type Reason', '------ -------- -------------- ------------ ------', ' 1 yes non-disruptive reset ', 'Images will be upgraded according to following table:', 'Module Image Running-Version(pri:alt) New-Version Upg-Required', '------ ---------- ---------------------------------------- -------------------- ------------', ' 1 nxos 7.0(3)I6(1) 7.0(3)I7(1) yes', ' 1 bios v4.4.0(07/12/2017) v4.4.0(07/12/2017) no']}
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbibo (@GGabriele) diff --git a/docs/cisco.nxos.nxos_l2_interfaces_module.rst b/docs/cisco.nxos.nxos_l2_interfaces_module.rst new file mode 100644 index 000000000..bfad0cf31 --- /dev/null +++ b/docs/cisco.nxos.nxos_l2_interfaces_module.rst @@ -0,0 +1,648 @@ +.. _cisco.nxos.nxos_l2_interfaces_module: + + +***************************** +cisco.nxos.nxos_l2_interfaces +***************************** + +**L2 interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages Layer-2 interfaces attributes of NX-OS Interfaces. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary of Layer-2 interface options
+
+
+ access + +
+ dictionary +
+ 		+ +
Switchport mode access command to configure the interface as a Layer-2 access.
+
+
+ vlan + +
+ integer +
+ 		+ +
Configure given VLAN in access port. It's used as the access VLAN ID.
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • dot1q-tunnel
    • +
  • access
    • +
  • trunk
    • +
  • fex-fabric
    • +
  • fabricpath
    • +
+ 		+
Mode in which interface needs to be configured.
+
Access mode is not shown in interface facts, so idempotency will not be maintained for switchport mode access and every time the output will come as changed=True.
+
+
+ name + +
+ string + / required +
+ 		+ +
Full name of interface, i.e. Ethernet1/1.
+
+
+ trunk + +
+ dictionary +
+ 		+ +
Switchport mode trunk command to configure the interface as a Layer-2 trunk.
+
+
+ allowed_vlans + +
+ string +
+ 		+ +
List of allowed VLANs in a given trunk port. These are the only VLANs that will be configured on the trunk.
+
+
+ native_vlan + +
+ integer +
+ 		+ +
Native VLAN to be configured in trunk port. It is used as the trunk native VLAN ID.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section ^interface.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state of the configuration after module completion.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOS 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # interface Ethernet1/2 + # switchport trunk native vlan 20 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + - name: Merge provided configuration with device configuration + cisco.nxos.nxos_l2_interfaces: + config: + - name: Ethernet1/1 + trunk: + native_vlan: 10 + allowed_vlans: 2,4,15 + - name: Ethernet1/2 + access: + vlan: 30 + state: merged + + # Task Output + # ----------- + # + # before: + # - name: Loopback999 + # - name: Ethernet1/2 + # - name: mgmt0 + # - name: Ethernet1/1 + # commands: + # - interface Ethernet1/1 + # - switchport trunk allowed vlan 2,4,15 + # - switchport trunk native vlan 10 + # - interface Ethernet1/2 + # - switchport access vlan 30 + # after: + # - name: Ethernet1/1 + # trunk: + # allowed_vlans: 2,4,15 + # native_vlan: 10 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + # - name: Loopback999 + + # After state: + # ------------ + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # switchport trunk native vlan 10 + # switchport trunk allowed vlans 2,4,15 + # interface Ethernet1/2 + # switchport access vlan 30 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + # Using replaced + + # Before state: + # ------------- + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # switchport trunk native vlan 10 + # switchport trunk allowed vlans 2,4,15 + # interface Ethernet1/2 + # switchport access vlan 30 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + - name: Replace device configuration of specified L2 interfaces with provided configuration. + cisco.nxos.nxos_l2_interfaces: + config: + - name: Ethernet1/1 + trunk: + native_vlan: 20 + allowed_vlans: 5-10, 15 + state: replaced + + # Task Output + # ----------- + # + # before: + # - name: Ethernet1/1 + # trunk: + # allowed_vlans: 2,4,15 + # native_vlan: 10 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + # commands: + # - interface Ethernet1/1 + # - no switchport trunk native vlan + # - switchport trunk allowed vlan 5-10,15 + # - switchport trunk native vlan 20 + # after: + # - name: Ethernet1/1 + # trunk: + # allowed_vlans: 5-10,15 + # native_vlan: 20 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + + # After state: + # ------------ + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # switchport trunk native vlan 20 + # switchport trunk allowed vlan 5-10,15 + # interface Ethernet1/2 + # switchport trunk native vlan 20 + # switchport mode trunk + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + # Using overridden + + # Before state: + # ------------- + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # switchport trunk native vlan 20 + # switchport trunk allowed vlan 5-10,15 + # interface Ethernet1/2 + # switchport trunk native vlan 20 + # switchport mode trunk + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + - name: Override device configuration with provided configuration. + cisco.nxos.nxos_l2_interfaces: + config: + - name: Ethernet1/2 + access: + vlan: 30 + state: overridden + + # Task Output + # ----------- + # + # before: + # - name: Ethernet1/1 + # trunk: + # allowed_vlans: 5,6,7,8,9,10,15 + # native_vlan: 20 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + # commands: + # - interface Ethernet1/1 + # - no switchport trunk allowed vlan + # - no switchport trunk native vlan + # after: + # - name: Ethernet1/1 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + + # After state: + # ------------ + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # interface Ethernet1/2 + # switchport access vlan 30 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + + # Using deleted + + # Before state: + # ------------- + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # switchport trunk native vlan 10 + # switchport trunk allowed vlan 2,4,15 + # interface Ethernet1/2 + # switchport access vlan 30 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + - name: Delete L2 attributes of given interfaces (Note This won't delete the interface + itself). + cisco.nxos.nxos_l2_interfaces: + config: + - name: Ethernet1/1 + - name: Ethernet1/2 + state: deleted + + # Task Output + # ----------- + # + # before: + # - name: Ethernet1/1 + # trunk: + # allowed_vlans: 2,4,15 + # native_vlan: 10 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + # commands: + # - interface Ethernet1/1 + # - no switchport trunk allowed vlan + # - no switchport trunk native vlan + # - interface Ethernet1/2 + # - no switchport access vlan + # after: + # - name: Ethernet1/1 + # - name: Ethernet1/2 + # - name: mgmt0 + + # After state: + # ------------ + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # interface Ethernet1/2 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + # Using rendered + + - name: Render platform specific configuration lines (without connecting to the device) + cisco.nxos.nxos_l2_interfaces: + config: + - name: Ethernet1/1 + trunk: + native_vlan: 10 + allowed_vlans: 2,4,15 + - name: Ethernet1/2 + access: + vlan: 30 + - name: Ethernet1/3 + trunk: + native_vlan: 20 + allowed_vlans: 5-10, 15 + state: rendered + + # Task Output + # ----------- + # + # rendered: + # - interface Ethernet1/1 + # - switchport trunk allowed vlan 2,4,15 + # - switchport trunk native vlan 10 + # - interface Ethernet1/2 + # - switchport access vlan 30 + # - interface Ethernet1/3 + # - switchport trunk allowed vlan 5-10,15 + # - switchport trunk native vlan 20 + + # Using parsed + + # parsed.cfg + # ------------ + # + # interface Ethernet1/800 + # switchport access vlan 18 + # switchport trunk allowed vlan 210 + # interface Ethernet1/801 + # switchport trunk allowed vlan 2,4,15 + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_l2_interfaces: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output + # ----------- + # + # parsed: + # - name: Ethernet1/800 + # access: + # vlan: 18 + # trunk: + # allowed_vlans: "210" + # - name: Ethernet1/801 + # trunk: + # allowed_vlans: "2,4,15" + + # Using gathered + + # Before state: + # ------------- + # + # switch# sh running-config | section ^interface + # interface Ethernet1/1 + # switchport access vlan 6 + # switchport trunk allowed vlan 200 + # interface Ethernet1/2 + # switchport trunk native vlan 10 + + - name: Gather l2_interfaces facts from the device using nxos_l2_interfaces + cisco.nxos.nxos_l2_interfaces: + state: gathered + + # Task output + # ----------- + # + # gathered: + # - name: "Ethernet1/1" + # access: + # vlan: 6 + # trunk: + # allowed_vlans: "200" + # - name: "Ethernet1/2" + # trunk: + # native_vlan: 10 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/1', 'switchport trunk allowed vlan 2,4,15', 'switchport trunk native vlan 10', 'interface Ethernet1/2', 'switchport access vlan 30', 'interface Ethernet1/3', 'switchport trunk allowed vlan 5,6,7,8,9,10,15', 'switchport trunk native vlan 20']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_l3_interfaces_module.rst b/docs/cisco.nxos.nxos_l3_interfaces_module.rst new file mode 100644 index 000000000..28a56bdf8 --- /dev/null +++ b/docs/cisco.nxos.nxos_l3_interfaces_module.rst @@ -0,0 +1,884 @@ +.. _cisco.nxos.nxos_l3_interfaces_module: + + +***************************** +cisco.nxos.nxos_l3_interfaces +***************************** + +**L3 interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages Layer-3 interfaces attributes of NX-OS Interfaces. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary of Layer-3 interface options
+
+
+ dot1q + +
+ integer +
+ 		+ +
Configures IEEE 802.1Q VLAN encapsulation on a subinterface.
+
+
+ evpn_multisite_tracking + +
+ string +
+
added in 1.1.0
+ 		+
    Choices: +
  • fabric-tracking
    • +
  • dci-tracking
    • +
+ 		+
VxLAN evpn multisite Interface tracking. Supported only on selected model.
+
+
+ ipv4 + +
+ list + / elements=dictionary +
+ 		+ +
IPv4 address and attributes of the L3 interface.
+
+
+ address + +
+ string +
+ 		+ +
IPV4 address of the L3 interface.
+
+
+ secondary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
A boolean attribute to manage addition of secondary IP address.
+
+
+ tag + +
+ integer +
+ 		+ +
URIB route tag value for local/direct routes.
+
+
+ ipv6 + +
+ list + / elements=dictionary +
+ 		+ +
IPv6 address and attributes of the L3 interface.
+
+
+ address + +
+ string +
+ 		+ +
IPV6 address of the L3 interface.
+
+
+ tag + +
+ integer +
+ 		+ +
URIB route tag value for local/direct routes.
+
+
+ ipv6_redirects + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/disables ipv6 redirects.
+
+
+ name + +
+ string + / required +
+ 		+ +
Full name of L3 interface, i.e. Ethernet1/1.
+
+
+ redirects + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/disables ipv4 redirects.
+
+
+ unreachables + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/disables ip redirects.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state of the configuration after module completion.
+
The state overridden would override the IP address configuration of all interfaces on the device with the provided configuration in the task. Use caution with this state as you may loose access to the device.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOS 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no shutdown + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + - name: Merge provided configuration with device configuration. + cisco.nxos.nxos_l3_interfaces: + config: + - name: Ethernet1/6 + ipv4: + - address: 192.168.1.1/24 + tag: 5 + - address: 10.1.1.1/24 + secondary: true + tag: 10 + ipv6: + - address: fd5d:12c9:2201:2::1/64 + tag: 6 + - name: Ethernet1/7.42 + redirects: false + unreachables: false + state: merged + + # Task Output + # ----------- + # + # before: + # - name: Ethernet1/6 + # - name: Ethernet1/7 + # - ipv4: + # - address: dhcp + # name: mgmt0 + # commands: + # - interface Ethernet1/6 + # - ip address 192.168.1.1/24 tag 5 + # - ip address 10.1.1.1/24 secondary tag 10 + # - ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + # - interface Ethernet1/7 + # - no ip redirects + # after: + # - ipv4: + # - address: 192.168.1.1/24 + # tag: 5 + # - address: 10.1.1.1/24 + # secondary: true + # tag: 10 + # ipv6: + # - address: fd5d:12c9:2201:2::1/64 + # tag: 6 + # name: Ethernet1/6 + # redirects: false + # - name: Ethernet1/7 + # redirects: false + # - ipv4: + # - address: dhcp + # name: mgmt0 + + # After state: + # ------------ + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no ip redirects + # ip address 192.168.1.1/24 tag 5 + # ip address 10.1.1.1/24 secondary tag 10 + # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no ip redirects + # no shutdown + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + + # Using replaced + + # Before state: + # ------------- + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no ip redirects + # ip address 192.168.1.1/24 tag 5 + # ip address 10.1.1.1/24 secondary tag 10 + # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no ip redirects + # no shutdown + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + - name: Replace device configuration of specified L3 interfaces with provided configuration. + cisco.nxos.nxos_l3_interfaces: + config: + - name: Ethernet1/6 + ipv4: + - address: 192.168.22.3/24 + state: replaced + + # Task Output + # ----------- + # + # before: + # - ipv4: + # - address: 192.168.1.1/24 + # tag: 5 + # - address: 10.1.1.1/24 + # secondary: true + # tag: 10 + # ipv6: + # - address: fd5d:12c9:2201:2::1/64 + # tag: 6 + # name: Ethernet1/6 + # redirects: false + # - name: Ethernet1/7 + # redirects: false + # - ipv4: + # - address: dhcp + # name: mgmt0 + # commands: + # - interface Ethernet1/6 + # - ip address 192.168.22.3/24 + # - no ipv6 address fd5d:12c9:2201:2::1/64 + # - ip redirects + # after: + # - ipv4: + # - address: 192.168.22.3/24 + # - address: 10.1.1.1/24 + # secondary: true + # tag: 10 + # name: Ethernet1/6 + # redirects: false + # - name: Ethernet1/7 + # redirects: false + # - ipv4: + # - address: dhcp + # name: mgmt0 + + # After state: + # ------------ + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no ip redirects + # ip address 192.168.22.3/24 + # ip address 10.1.1.1/24 secondary tag 10 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no ip redirects + # no shutdown + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + # Using overridden + + # Before state: + # ------------- + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no ip redirects + # ip address 192.168.1.1/24 tag 5 + # ip address 10.1.1.1/24 secondary tag 10 + # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no ip redirects + # no shutdown + # interface Ethernet1/7.42 + # no ip redirects + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + - name: Override device configuration with provided configuration. + cisco.nxos.nxos_l3_interfaces: + config: + - ipv4: + - address: dhcp + name: mgmt0 + - name: Ethernet1/6 + ipv4: + - address: 192.168.22.3/24 + state: overridden + + # Task Output + # ----------- + # + # before: + # - ipv4: + # - address: 192.168.1.1/24 + # tag: 5 + # - address: 10.1.1.1/24 + # secondary: true + # tag: 10 + # ipv6: + # - address: fd5d:12c9:2201:2::1/64 + # tag: 6 + # name: Ethernet1/6 + # redirects: false + # - name: Ethernet1/7 + # redirects: false + # - name: Ethernet1/7.42 + # redirects: false + # - ipv4: + # - address: dhcp + # name: mgmt0 + # commands: + # - interface Ethernet1/6 + # - no ipv6 address fd5d:12c9:2201:2::1/64 + # - no ip address 10.1.1.1/24 secondary + # - ip address 192.168.22.3/24 + # - ip redirects + # - interface Ethernet1/7 + # - ip redirects + # - interface Ethernet1/7.42 + # - ip redirects + # after: + # - ipv4: + # - address: 192.168.22.3/24 + # name: Ethernet1/6 + # - name: Ethernet1/7 + # - name: Ethernet1/7.42 + # - ipv4: + # - address: dhcp + # name: mgmt0 + + # After state: + # ------------ + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # ip address 192.168.22.3/24 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no shutdown + # interface Ethernet1/7.42 + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + # Using deleted + + # Before state: + # ------------- + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # ip address 192.168.22.3/24 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no shutdown + # interface Ethernet1/7.42 + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + - name: Delete L3 attributes of given interfaces (This won't delete the interface + itself). + cisco.nxos.nxos_l3_interfaces: + config: + - name: Ethernet1/6 + - name: Ethernet1/2 + state: deleted + + # Task Output + # ----------- + # + # before: + # - name: Ethernet1/2 + # - ipv4: + # - address: 192.168.22.3/24 + # name: Ethernet1/6 + # - name: Ethernet1/7 + # - name: Ethernet1/7.42 + # - ipv4: + # - address: dhcp + # name: mgmt0 + # commands: + # - interface Ethernet1/6 + # - no ip address + # after: + # - name: Ethernet1/2 + # - name: Ethernet1/7 + # - name: Ethernet1/7.42 + # - ipv4: + # - address: dhcp + # name: mgmt0 + + # After state: + # ------------ + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no shutdown + # interface Ethernet1/7.42 + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + # Using rendered + + - name: Use rendered state to convert task input to device specific commands + cisco.nxos.nxos_l3_interfaces: + config: + - name: Ethernet1/800 + ipv4: + - address: 192.168.1.100/24 + tag: 5 + - address: 10.1.1.1/24 + secondary: true + tag: 10 + - name: Ethernet1/800 + ipv6: + - address: fd5d:12c9:2201:2::1/64 + tag: 6 + state: rendered + + # Task Output + # ----------- + # + # rendered: + # - interface Ethernet1/800 + # - ip address 192.168.1.100/24 tag 5 + # - ip address 10.1.1.1/24 secondary tag 10 + # - interface Ethernet1/800 + # - ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + + # Using parsed + + # parsed.cfg + # ---------- + # + # interface Ethernet1/800 + # ip address 192.168.1.100/24 tag 5 + # ip address 10.1.1.1/24 secondary tag 10 + # no ip redirects + # interface Ethernet1/801 + # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + # ip unreachables + # interface mgmt0 + # ip address dhcp + # vrf member management + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_l3_interfaces: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output + # ----------- + # + # parsed: + # - name: Ethernet1/800 + # ipv4: + # - address: 192.168.1.100/24 + # tag: 5 + # - address: 10.1.1.1/24 + # secondary: True + # tag: 10 + # redirects: False + # - name: Ethernet1/801 + # ipv6: + # - address: fd5d:12c9:2201:2::1/64 + # tag: 6 + # unreachables: True + + # Using gathered + + # Before state: + # ------------- + # + # interface Ethernet1/1 + # ip address 192.0.2.100/24 + # interface Ethernet1/2 + # no ip redirects + # ip address 203.0.113.10/24 + # ip unreachables + # ipv6 address 2001:db8::1/32 + + - name: Gather l3_interfaces facts from the device using nxos_l3_interfaces + cisco.nxos.nxos_l3_interfaces: + state: gathered + + # Task output + # ----------- + # + # gathered: + # - name: Ethernet1/1 + # ipv4: + # - address: 192.0.2.100/24 + # - name: Ethernet1/2 + # ipv4: + # - address: 203.0.113.10/24 + # ipv6: + # - address: 2001:db8::1/32 + # redirects: False + # unreachables: True + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/2', 'ip address 192.168.0.1/2']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_lacp_module.rst b/docs/cisco.nxos.nxos_lacp_module.rst new file mode 100644 index 000000000..b0410c783 --- /dev/null +++ b/docs/cisco.nxos.nxos_lacp_module.rst @@ -0,0 +1,402 @@ +.. _cisco.nxos.nxos_lacp_module: + + +******************** +cisco.nxos.nxos_lacp +******************** + +**LACP resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages Global Link Aggregation Control Protocol (LACP) on NX-OS devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
LACP global options.
+
+
+ system + +
+ dictionary +
+ 		+ +
LACP system options
+
+
+ mac + +
+ dictionary +
+ 		+ +
MAC address to be used for the LACP Protocol exchanges
+
+
+ address + +
+ string +
+ 		+ +
MAC-address (FORMAT :xxxx.xxxx.xxxx).
+
+
+ role + +
+ string +
+ 		+
    Choices: +
  • primary
    • +
  • secondary
    • +
+ 		+
The role for the Switch.
+
+
+ priority + +
+ integer +
+ 		+ +
The system priority to use in LACP negotiations.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | include lacp.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state of the configuration after module completion.
+
States replaced and overridden have the same behaviour for this module.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOS 7.3.(0)D1(1) on VIRL. + - Unsupported for Cisco MDS + - Feature lacp should be enabled for this module. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + + - name: Merge provided configuration with device configuration. + cisco.nxos.nxos_lacp: + config: + system: + priority: 10 + mac: + address: 00c1.4c00.bd15 + state: merged + + # After state: + # ------------ + # + # lacp system-priority 10 + # lacp system-mac 00c1.4c00.bd15 + + + # Using replaced + + # Before state: + # ------------- + # + # lacp system-priority 10 + + - name: Replace device global lacp configuration with the given configuration. + cisco.nxos.nxos_lacp: + config: + system: + mac: + address: 00c1.4c00.bd15 + state: replaced + + # After state: + # ------------ + # + # lacp system-mac 00c1.4c00.bd15 + + + # Using deleted + + # Before state: + # ------------- + # + # lacp system-priority 10 + + - name: Delete global LACP configurations. + cisco.nxos.nxos_lacp: + state: deleted + + # After state: + # ------------ + # + + # Using rendered + + - name: Render platform specific configuration lines (without connecting to the device) + cisco.nxos.nxos_lacp: + config: + system: + priority: 10 + mac: + address: 00c1.4c00.bd15 + role: secondary + state: rendered + + # Task Output (redacted) + # ----------------------- + + # rendered: + # - "lacp system-priority 10" + # - "lacp system-mac 00c1.4c00.bd15 role secondary" + + # Using parsed + + # parsed.cfg + # ------------ + # lacp system-priority 10 + # lacp system-mac 00c1.4c00.bd15 role secondary + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_lacp: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # system: + # priority: 10 + # mac: + # address: 00c1.4c00.bd15 + # role: secondary + + # Using gathered + + # Existing device config state + # ------------------------------- + # Nexus9000v# show running-config | include lacp + # lacp system-priority 11 + # lacp system-mac 00c1.4c00.bd15 role primary + + - name: Gather lacp facts from the device using nxos_lacp + cisco.nxos.nxos_lacp: + state: gathered + + # Task output (redacted) + # ----------------------- + # gathered: + # system: + # priority: 11 + # mac: + # address: 00c1.4c00.bd15 + # role: primary + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['lacp system-priority 15', 'lacp system-mac 00c1.4c00.bd15 role primary']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_lldp_interfaces_module.rst b/docs/cisco.nxos.nxos_lldp_interfaces_module.rst new file mode 100644 index 000000000..d634e9aa4 --- /dev/null +++ b/docs/cisco.nxos.nxos_lldp_interfaces_module.rst @@ -0,0 +1,407 @@ +.. _cisco.nxos.nxos_lldp_interfaces_module: + + +******************************* +cisco.nxos.nxos_lldp_interfaces +******************************* + +**LLDP interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages interfaces' configuration for Link Layer Discovery Protocol (LLDP) on NX-OS platforms. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of link layer discovery configurations for interfaces.
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the interface
+
+
+ receive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Used to enable or disable the reception of LLDP packets on that interface. By default, this is enabled after LLDP is enabled globally.
+
+
+ tlv_set + +
+ dictionary +
+ 		+ +
Used to configure TLV parameters on the interface
+
+
+ management_address + +
+ string +
+ 		+ +
Used to mention the IPv4 or IPv6 management address for the interface
+
+
+ vlan + +
+ integer +
+ 		+ +
Used to mention the VLAN for the interface
+
+
+ transmit + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Used to enable or disable the transmission of LLDP packets on that interface. By default, this is enabled after LLDP is enabled globally.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section ^interface.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state the configuration should be left in
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOS 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - The LLDP feature needs to be enabled before using this module + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + + - name: Merge provided configuration with device configuration + cisco.nxos.nxos_lldp_interfaces: + config: + - name: Ethernet1/4 + receive: false + transmit: true + tlv_set: + management_address: 192.168.122.64 + vlan: 12 + state: merged + + # After state: + # ------------- + # + # interface Ethernet1/4 + # no lldp receive + # lldp tlv-set management-address 192.168.122.64 + # lldp tlv-set vlan 12 + + + # Using replaced + + # Before state: + # ------------ + # + # interface Ethernet1/4 + # no lldp receive + # lldp tlv-set management-address 192.168.122.64 + # interface Ethernet1/5 + # no lldp transmit + # lldp tlv-set vlan 10 + + - name: Replace LLDP configuration on interfaces with given configuration + cisco.nxos.nxos_lldp_interfaces: + config: + - name: Ethernet1/4 + transmit: false + tlv_set: + vlan: 2 + state: replaced + + + # After state: + # ----------- + # + # interface Ethernet1/4 + # no lldp transmit + # lldp tlv_set vlan 2 + # interface Ethernet1/5 + # no lldp transmit + # lldp tlv-set vlan 10 + + + # Using overridden + + # Before state: + # ------------ + # + # interface Ethernet1/4 + # no lldp receive + # lldp tlv-set management-address 192.168.122.64 + # interface Ethernet1/5 + # no lldp transmit + # lldp tlv-set vlan 10 + + - name: Override LLDP configuration on all interfaces with given configuration + cisco.nxos.nxos_lldp_interfaces: + config: + - name: Ethernet1/7 + receive: false + tlv_set: + vlan: 12 + state: overridden + + + # After state: + # ----------- + # + # interface Ethernet1/7 + # no lldp receive + # lldp tlv_set vlan 12 + + + # Using deleted + + # Before state: + # ------------ + # + # interface Ethernet1/4 + # lldp tlv-set management vlan 24 + # no lldp transmit + # interface mgmt0 + # no lldp receive + + - name: Delete LLDP interfaces configuration + cisco.nxos.nxos_lldp_interfaces: + state: deleted + + # After state: + # ------------ + # + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/2', 'lldp receive', 'lldp tlv-set vlan 12']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_logging_module.rst b/docs/cisco.nxos.nxos_logging_module.rst new file mode 100644 index 000000000..9dafd8e33 --- /dev/null +++ b/docs/cisco.nxos.nxos_logging_module.rst @@ -0,0 +1,458 @@ +.. _cisco.nxos.nxos_logging_module: + + +*********************** +cisco.nxos.nxos_logging +*********************** + +**Manage logging on network devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2023-08-01 +:Why: Updated module released with more functionality. +:Alternative: nxos_logging_global + + + +Synopsis +-------- +- This module provides declarative management of logging on Cisco NX-OS devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ aggregate + +
+ list + / elements=dictionary +
+ 		+ +
List of logging definitions.
+
+
+ dest + +
+ string +
+ 		+
    Choices: +
  • console
    • +
  • logfile
    • +
  • module
    • +
  • monitor
    • +
  • server
    • +
+ 		+
Destination of the logs.
+
+
+ dest_level + +
+ integer +
+ 		+ +
Set logging severity levels.
+

aliases: level
+
+
+ event + +
+ string +
+ 		+
    Choices: +
  • link-enable
    • +
  • link-default
    • +
  • trunk-enable
    • +
  • trunk-default
    • +
+ 		+
Link/trunk enable/default interface configuration logging
+
+
+ facility + +
+ string +
+ 		+ +
Facility name for logging.
+
+
+ facility_level + +
+ integer +
+ 		+ +
Set logging severity levels for facility based log messages.
+
+
+ facility_link_status + +
+ string +
+ 		+
    Choices: +
  • link-down-notif
    • +
  • link-down-error
    • +
  • link-up-notif
    • +
  • link-up-error
    • +
+ 		+
Set logging facility ethpm link status. Not idempotent with version 6.0 images.
+
+
+ file_size + +
+ integer +
+ 		+ +
Set logfile size
+
+
+ interface + +
+ string +
+ 		+ +
Interface to be used while configuring source-interface for logging (e.g., 'Ethernet1/2', 'mgmt0')
+
+
+ interface_message + +
+ string +
+ 		+
    Choices: +
  • add-interface-description
    • +
+ 		+
Add interface description to interface syslogs. Does not work with version 6.0 images using nxapi as a transport.
+
+
+ name + +
+ string +
+ 		+ +
If value of dest is logfile it indicates file-name.
+
+
+ purge + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Remove any switch logging configuration that does not match what has been configured Not supported for ansible_connection local. All nxos_logging tasks must use the same ansible_connection type.
+
+
+ remote_server + +
+ string +
+ 		+ +
Hostname or IP Address for remote logging (when dest is 'server').
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
State of the logging configuration.
+
+
+ timestamp + +
+ string +
+ 		+
    Choices: +
  • microseconds
    • +
  • milliseconds
    • +
  • seconds
    • +
+ 		+
Set logging timestamp format
+
+
+ use_vrf + +
+ string +
+ 		+ +
VRF to be used while configuring remote logging (when dest is 'server').
+
+
+ + +Notes +----- + +.. note:: + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: configure console logging with level + cisco.nxos.nxos_logging: + dest: console + level: 2 + state: present + - name: remove console logging configuration + cisco.nxos.nxos_logging: + dest: console + level: 2 + state: absent + - name: configure file logging with level + cisco.nxos.nxos_logging: + dest: logfile + name: testfile + dest_level: 3 + state: present + - name: Configure logging logfile with size + cisco.nxos.nxos_logging: + dest: logfile + name: testfile + dest_level: 3 + file_size: 16384 + - name: configure facility level logging + cisco.nxos.nxos_logging: + facility: daemon + facility_level: 0 + state: present + - name: remove facility level logging + cisco.nxos.nxos_logging: + facility: daemon + facility_level: 0 + state: absent + - name: Configure Remote Logging + cisco.nxos.nxos_logging: + dest: server + remote_server: test-syslogserver.com + facility: auth + facility_level: 1 + use_vrf: management + state: present + - name: Configure Source Interface for Logging + cisco.nxos.nxos_logging: + interface: mgmt0 + state: present + - name: Purge nxos_logging configuration not managed by this playbook + cisco.nxos.nxos_logging: + purge: true + - name: Configure logging timestamp + cisco.nxos.nxos_logging: + timestamp: milliseconds + state: present + - name: Configure logging facility ethpm link status + cisco.nxos.nxos_logging: + facility: ethpm + facility_link_status: link-up-notif + state: present + - name: Configure logging message ethernet description + cisco.nxos.nxos_logging: + interface_message: add-interface-description + state: present + - name: Configure logging event link enable + cisco.nxos.nxos_logging: + event: link-enable + state: present + - name: Configure logging using aggregate + cisco.nxos.nxos_logging: + aggregate: + - {dest: console, dest_level: 2} + - {dest: logfile, dest_level: 2, name: testfile} + - {facility: daemon, facility_level: 0} + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['logging console 2', 'logging logfile testfile 3', 'logging level daemon 0']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2023-08-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_ntp_auth_module.rst b/docs/cisco.nxos.nxos_ntp_auth_module.rst new file mode 100644 index 000000000..c825cd017 --- /dev/null +++ b/docs/cisco.nxos.nxos_ntp_auth_module.rst @@ -0,0 +1,224 @@ +.. _cisco.nxos.nxos_ntp_auth_module: + + +************************ +cisco.nxos.nxos_ntp_auth +************************ + +**Manages NTP authentication.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated module released with more functionality. +:Alternative: nxos_ntp_global + + + +Synopsis +-------- +- Manages NTP authentication. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ auth_type + +
+ string +
+ 		+
    Choices: +
  • text ←
    • +
  • encrypt
    • +
+ 		+
Whether the given md5string is in cleartext or has been encrypted. If in cleartext, the device will encrypt it before storing it.
+
+
+ authentication + +
+ string +
+ 		+
    Choices: +
  • on
    • +
  • off
    • +
+ 		+
Turns NTP authentication on or off.
+
+
+ key_id + +
+ string +
+ 		+ +
Authentication key identifier (numeric).
+
+
+ md5string + +
+ string +
+ 		+ +
MD5 String.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ trusted_key + +
+ string +
+ 		+
    Choices: +
  • false ←
    • +
  • true
    • +
+ 		+
Whether the given key is required to be supplied by a time source for the device to synchronize to the time source.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - If ``state=absent``, the module will remove the given key configuration if it exists. + - If ``state=absent`` and ``authentication=on``, authentication will be turned off. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Basic NTP authentication configuration + - cisco.nxos.nxos_ntp_auth: + key_id: 32 + md5string: hello + auth_type: text + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['ntp authentication-key 32 md5 helloWorld 0', 'ntp trusted-key 32']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_ntp_global_module.rst b/docs/cisco.nxos.nxos_ntp_global_module.rst new file mode 100644 index 000000000..b77fc9440 --- /dev/null +++ b/docs/cisco.nxos.nxos_ntp_global_module.rst @@ -0,0 +1,1411 @@ +.. _cisco.nxos.nxos_ntp_global_module: + + +************************** +cisco.nxos.nxos_ntp_global +************************** + +**NTP Global resource module.** + + +Version added: 2.6.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages ntp configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A dict of ntp configuration.
+
+
+ access_group + +
+ dictionary +
+ 		+ +
NTP access-group.
+
This option is unsupported on MDS switches.
+
+
+ match_all + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Scan ACLs present in all ntp access groups.
+
+
+ peer + +
+ list + / elements=dictionary +
+ 		+ +
Access-group peer.
+
+
+ access_list + +
+ string +
+ 		+ +
Name of access list.
+
+
+ query_only + +
+ list + / elements=dictionary +
+ 		+ +
Access-group query-only.
+
+
+ access_list + +
+ string +
+ 		+ +
Name of access list.
+
+
+ serve + +
+ list + / elements=dictionary +
+ 		+ +
Access-group serve.
+
+
+ access_list + +
+ string +
+ 		+ +
Name of access list.
+
+
+ serve_only + +
+ list + / elements=dictionary +
+ 		+ +
Access-group serve-only.
+
+
+ access_list + +
+ string +
+ 		+ +
Name of access list.
+
+
+ allow + +
+ dictionary +
+ 		+ +
Enable/Disable the packets.
+
+
+ control + +
+ dictionary +
+ 		+ +
Control mode packets.
+
+
+ rate_limit + +
+ integer +
+ 		+ +
Rate-limit delay.
+
+
+ private + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable Private mode packets.
+
+
+ authenticate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable authentication.
+
+
+ authentication_keys + +
+ list + / elements=dictionary +
+ 		+ +
NTP authentication key.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 for Clear text
+
7 for Encrypted
+
+
+ id + +
+ integer +
+ 		+ +
Authentication key number (range 1-65535).
+
+
+ key + +
+ string +
+ 		+ +
Authentication key.
+
+
+ logging + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable logging of NTPD Events.
+
+
+ master + +
+ dictionary +
+ 		+ +
Act as NTP master clock.
+
This option is unsupported on MDS switches.
+
+
+ stratum + +
+ integer +
+ 		+ +
Stratum number.
+
+
+ passive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
NTP passive command.
+
This option is unsupported on MDS switches.
+
+
+ peers + +
+ list + / elements=dictionary +
+ 		+ +
NTP Peers.
+
+
+ key_id + +
+ integer +
+ 		+ +
Keyid to be used while communicating to this server.
+
+
+ maxpoll + +
+ integer +
+ 		+ +
Maximum interval to poll a peer.
+
Poll interval in secs to a power of 2.
+
+
+ minpoll + +
+ integer +
+ 		+ +
Minimum interval to poll a peer.
+
Poll interval in secs to a power of 2.
+
+
+ peer + +
+ string +
+ 		+ +
Hostname/IP address of the NTP Peer.
+
+
+ prefer + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Preferred Server.
+
+
+ vrf + +
+ string +
+ 		+ +
Display per-VRF information.
+
This option is unsupported on MDS switches.
+

aliases: use_vrf
+
+
+ servers + +
+ list + / elements=dictionary +
+ 		+ +
NTP servers.
+
+
+ key_id + +
+ integer +
+ 		+ +
Keyid to be used while communicating to this server.
+
+
+ maxpoll + +
+ integer +
+ 		+ +
Maximum interval to poll a peer.
+
Poll interval in secs to a power of 2.
+
+
+ minpoll + +
+ integer +
+ 		+ +
Minimum interval to poll a peer.
+
Poll interval in secs to a power of 2.
+
+
+ prefer + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Preferred Server.
+
+
+ server + +
+ string +
+ 		+ +
Hostname/IP address of the NTP Peer.
+
+
+ vrf + +
+ string +
+ 		+ +
Display per-VRF information.
+
This option is not applicable for MDS switches.
+

aliases: use_vrf
+
+
+ source + +
+ string +
+ 		+ +
Source of NTP packets.
+
This option is unsupported on MDS switches.
+
+
+ source_interface + +
+ string +
+ 		+ +
Source interface sending NTP packets.
+
+
+ trusted_keys + +
+ list + / elements=dictionary +
+ 		+ +
NTP trusted-key number.
+
+
+ key_id + +
+ integer +
+ 		+ +
Trusted-Key number.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config ntp.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
The states replaced and overridden have identical behaviour for this module.
+
Please refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6 on Cisco Nexus Switches. + - This module works with connection ``network_cli`` and ``httpapi``. + - Tested against Cisco MDS NX-OS 9.2(2) with connection ``network_cli``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k-rdo# show running-config ntp + # nxos-9k-rdo# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_ntp_global: &id001 + config: + access_group: + peer: + - access_list: PeerAcl1 + serve: + - access_list: ServeAcl1 + authenticate: true + authentication_keys: + - id: 1001 + key: vagwwtKfkv + encryption: 7 + - id: 1002 + key: vagwwtKfkvgthz + encryption: 7 + logging: true + master: + stratum: 2 + peers: + - peer: 192.0.2.1 + key_id: 1 + maxpoll: 15 + minpoll: 5 + vrf: default + - peer: 192.0.2.2 + key_id: 2 + prefer: true + vrf: siteA + servers: + - server: 198.51.100.1 + key_id: 2 + vrf: default + - server: 203.0.113.1 + key_id: 1 + vrf: siteB + + # Task output + # ------------- + # before: {} + # + # commands: + # - "ntp authenticate" + # - "ntp logging" + # - "ntp master 2" + # - "ntp authentication-keys 1001 md5 vagwwtKfkv 7" + # - "ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" + # - "ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" + # - "ntp peer 192.0.2.2 prefer use-vrf siteA key 2" + # - "ntp server 198.51.100.1 use-vrf default key 2" + # - "ntp server 203.0.113.1 use-vrf siteB key 1" + # - "ntp access-group peer PeerAcl1" + # - "ntp access-group serve ServeAcl1" + # + # after: + # access_group: + # peer: + # - access_list: PeerAcl1 + # serve: + # - access_list: ServeAcl1 + # authenticate: true + # authentication_keys: + # - id: 1001 + # key: vagwwtKfkv + # encryption: 7 + # - id: 1002 + # key: vagwwtKfkvgthz + # encryption: 7 + # logging: true + # master: + # stratum: 2 + # peers: + # - peer: 192.0.2.1 + # key_id: 1 + # maxpoll: 15 + # minpoll: 5 + # vrf: default + # - peer: 192.0.2.2 + # key_id: 2 + # prefer: true + # vrf: siteA + # servers: + # - server: 198.51.100.1 + # key_id: 2 + # vrf: default + # - server: 203.0.113.1 + # key_id: 1 + # vrf: siteB + + # After state: + # ------------ + # nxos-9k-rdo# show running-config ntp + # ntp authenticate + # ntp logging + # ntp master 2 + # ntp authentication-keys 1001 md5 vagwwtKfkv 7 + # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 + # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 + # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 + # ntp server 198.51.100.1 use-vrf default key 2 + # ntp server 203.0.113.1 use-vrf siteB key 1 + # ntp access-group peer PeerAcl1 + # ntp access-group serve ServeAcl1 + + # Using replaced + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config ntp + # ntp authenticate + # ntp logging + # ntp master 2 + # ntp authentication-keys 1001 md5 vagwwtKfkv 7 + # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 + # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 + # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 + # ntp server 198.51.100.1 use-vrf default key 2 + # ntp server 203.0.113.1 use-vrf siteB key 1 + # ntp access-group peer PeerAcl1 + # ntp access-group serve ServeAcl1 + + - name: Replace logging global configurations of listed logging global with provided configurations + cisco.nxos.nxos_ntp_global: + config: + access_group: + peer: + - access_list: PeerAcl2 + serve: + - access_list: ServeAcl2 + logging: true + master: + stratum: 2 + peers: + - peer: 192.0.2.1 + key_id: 1 + maxpoll: 15 + minpoll: 5 + vrf: default + - peer: 192.0.2.5 + key_id: 2 + prefer: true + vrf: siteA + servers: + - server: 198.51.100.1 + key_id: 2 + vrf: default + state: replaced + + # Task output + # ------------- + # before: + # access_group: + # peer: + # - access_list: PeerAcl1 + # serve: + # - access_list: ServeAcl1 + # authenticate: true + # authentication_keys: + # - id: 1001 + # key: vagwwtKfkv + # encryption: 7 + # - id: 1002 + # key: vagwwtKfkvgthz + # encryption: 7 + # logging: true + # master: + # stratum: 2 + # peers: + # - peer: 192.0.2.1 + # key_id: 1 + # maxpoll: 15 + # minpoll: 5 + # vrf: default + # - peer: 192.0.2.2 + # key_id: 2 + # prefer: true + # vrf: siteA + # servers: + # - server: 198.51.100.1 + # key_id: 2 + # vrf: default + # - server: 203.0.113.1 + # key_id: 1 + # vrf: siteB + # + # commands: + # - "no ntp authenticate" + # - "no ntp authentication-keys 1001 md5 vagwwtKfkv 7" + # - "no ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" + # - "ntp peer 192.0.2.5 prefer use-vrf siteA key 2" + # - "no ntp peer 192.0.2.2 prefer use-vrf siteA key 2" + # - "no ntp server 203.0.113.1 use-vrf siteB key 1" + # - "ntp access-group peer PeerAcl2" + # - "no ntp access-group peer PeerAcl1" + # - "ntp access-group serve ServeAcl2" + # - "no ntp access-group serve ServeAcl1" + # + # after: + # access_group: + # peer: + # - access_list: PeerAcl2 + # serve: + # - access_list: ServeAcl2 + # logging: true + # master: + # stratum: 2 + # peers: + # - peer: 192.0.2.1 + # key_id: 1 + # maxpoll: 15 + # minpoll: 5 + # vrf: default + # - peer: 192.0.2.5 + # key_id: 2 + # prefer: true + # vrf: siteA + # servers: + # - server: 198.51.100.1 + # key_id: 2 + # vrf: default + + # After state: + # ------------ + # nxos-9k-rdo# show running-config ntp + # ntp logging + # ntp master 2 + # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 + # ntp peer 192.0.2.5 prefer use-vrf siteA key 2 + # ntp server 198.51.100.1 use-vrf default key 2 + # ntp access-group peer PeerAcl2 + # ntp access-group serve ServeAcl2 + + # Using deleted to delete all logging configurations + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config ntp + + - name: Delete all logging configuration + cisco.nxos.nxos_ntp_global: + state: deleted + + # Task output + # ------------- + # before: + # access_group: + # peer: + # - access_list: PeerAcl1 + # serve: + # - access_list: ServeAcl1 + # authenticate: true + # authentication_keys: + # - id: 1001 + # key: vagwwtKfkv + # encryption: 7 + # - id: 1002 + # key: vagwwtKfkvgthz + # encryption: 7 + # logging: true + # master: + # stratum: 2 + # peers: + # - peer: 192.0.2.1 + # key_id: 1 + # maxpoll: 15 + # minpoll: 5 + # vrf: default + # - peer: 192.0.2.2 + # key_id: 2 + # prefer: true + # vrf: siteA + # servers: + # - server: 198.51.100.1 + # key_id: 2 + # vrf: default + # - server: 203.0.113.1 + # key_id: 1 + # vrf: siteB + # + # commands: + # - "no ntp authenticate" + # - "no ntp logging" + # - "no ntp master 2" + # - "no ntp authentication-keys 1001 md5 vagwwtKfkv 7" + # - "no ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" + # - "no ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" + # - "no ntp peer 192.0.2.2 prefer use-vrf siteA key 2" + # - "no ntp server 198.51.100.1 use-vrf default key 2" + # - "no ntp server 203.0.113.1 use-vrf siteB key 1" + # - "no ntp access-group peer PeerAcl1" + # - "no ntp access-group serve ServeAcl1" + # + # after: {} + + # After state: + # ------------ + # nxos-9k-rdo# show running-config ntp + # nxos-9k-rdo# + + # Using rendered + + - name: Render platform specific configuration lines with state rendered (without connecting to the device) + cisco.nxos.nxos_ntp_global: + config: + access_group: + peer: + - access_list: PeerAcl1 + serve: + - access_list: ServeAcl1 + authenticate: true + authentication_keys: + - id: 1001 + key: vagwwtKfkv + encryption: 7 + - id: 1002 + key: vagwwtKfkvgthz + encryption: 7 + logging: true + master: + stratum: 2 + peers: + - peer: 192.0.2.1 + key_id: 1 + maxpoll: 15 + minpoll: 5 + vrf: default + - peer: 192.0.2.2 + key_id: 2 + prefer: true + vrf: siteA + servers: + - server: 198.51.100.1 + key_id: 2 + vrf: default + - server: 203.0.113.1 + key_id: 1 + vrf: siteB + state: rendered + + # Task Output (redacted) + # ----------------------- + # rendered: + # - "ntp authenticate" + # - "ntp logging" + # - "ntp master 2" + # - "ntp authentication-keys 1001 md5 vagwwtKfkv 7" + # - "ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" + # - "ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" + # - "ntp peer 192.0.2.2 prefer use-vrf siteA key 2" + # - "ntp server 198.51.100.1 use-vrf default key 2" + # - "ntp server 203.0.113.1 use-vrf siteB key 1" + # - "ntp access-group peer PeerAcl1" + # - "ntp access-group serve ServeAcl1" + + # Using parsed + + # parsed.cfg + # ------------ + # ntp authenticate + # ntp logging + # ntp master 2 + # ntp authentication-keys 1001 md5 vagwwtKfkv 7 + # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 + # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 + # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 + # ntp server 198.51.100.1 use-vrf default key 2 + # ntp server 203.0.113.1 use-vrf siteB key 1 + # ntp access-group peer PeerAcl1 + # ntp access-group serve ServeAcl1 + + - name: Parse externally provided ntp configuration + cisco.nxos.nxos_ntp_global: + running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # access_group: + # peer: + # - access_list: PeerAcl1 + # serve: + # - access_list: ServeAcl1 + # authenticate: true + # authentication_keys: + # - id: 1001 + # key: vagwwtKfkv + # encryption: 7 + # - id: 1002 + # key: vagwwtKfkvgthz + # encryption: 7 + # logging: true + # master: + # stratum: 2 + # peers: + # - peer: 192.0.2.1 + # key_id: 1 + # maxpoll: 15 + # minpoll: 5 + # vrf: default + # - peer: 192.0.2.2 + # key_id: 2 + # prefer: true + # vrf: siteA + # servers: + # - server: 198.51.100.1 + # key_id: 2 + # vrf: default + # - server: 203.0.113.1 + # key_id: 1 + # vrf: siteB + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['ntp master stratum 2', 'ntp peer 198.51.100.1 use-vrf test maxpoll 7', 'ntp authentication-key 10 md5 wawyhanx2 7', 'ntp access-group peer PeerAcl1', 'ntp access-group peer PeerAcl2', 'ntp access-group query-only QueryAcl1']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['ntp master stratum 2', 'ntp peer 198.51.100.1 use-vrf test maxpoll 7', 'ntp authentication-key 10 md5 wawyhanx2 7', 'ntp access-group peer PeerAcl1', 'ntp access-group peer PeerAcl2', 'ntp access-group query-only QueryAcl1']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_ntp_module.rst b/docs/cisco.nxos.nxos_ntp_module.rst new file mode 100644 index 000000000..3fa835a96 --- /dev/null +++ b/docs/cisco.nxos.nxos_ntp_module.rst @@ -0,0 +1,314 @@ +.. _cisco.nxos.nxos_ntp_module: + + +******************* +cisco.nxos.nxos_ntp +******************* + +**Manages core NTP configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated module released with more functionality. +:Alternative: nxos_ntp_global + + + +Synopsis +-------- +- Manages core NTP configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ key_id + +
+ string +
+ 		+ +
Authentication key identifier to use with given NTP server or peer or keyword 'default'.
+
+
+ peer + +
+ string +
+ 		+ +
Network address of NTP peer.
+
+
+ prefer + +
+ string +
+ 		+
    Choices: +
  • enabled
    • +
  • disabled
    • +
+ 		+
Makes given NTP server or peer the preferred NTP server or peer for the device.
+
+
+ server + +
+ string +
+ 		+ +
Network address of NTP server.
+
+
+ source_addr + +
+ string +
+ 		+ +
Local source address from which NTP messages are sent or keyword 'default'.
+
+
+ source_int + +
+ string +
+ 		+ +
Local source interface from which NTP messages are sent. Must be fully qualified interface name or keyword 'default'
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ vrf_name + +
+ string +
+ 		+ +
Makes the device communicate with the given NTP server or peer over a specific VRF or keyword 'default'.
+
+
+ + +Notes +----- + +.. note:: + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Set NTP Server with parameters + - cisco.nxos.nxos_ntp: + server: 1.2.3.4 + key_id: 32 + prefer: enabled + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ end_state + +
+ dictionary +
+ 		always +
k/v pairs of ntp info after module execution
+
+
Sample:
+
{'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'server', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'source'}
+
+
+ existing + +
+ dictionary +
+ 		always +
k/v pairs of existing ntp server/peer
+
+
Sample:
+
{'address': '192.0.2.2', 'key_id': '32', 'peer_type': 'server', 'prefer': 'enabled', 'source': 'ethernet2/1', 'source_type': 'source-interface'}
+
+
+ proposed + +
+ dictionary +
+ 		always +
k/v pairs of parameters passed into module
+
+
Sample:
+
{'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'server', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'source'}
+
+
+ updates + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['ntp server 192.0.2.2 prefer key 48', 'no ntp source-interface ethernet2/1', 'ntp source 192.0.2.3']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_ntp_options_module.rst b/docs/cisco.nxos.nxos_ntp_options_module.rst new file mode 100644 index 000000000..e99825641 --- /dev/null +++ b/docs/cisco.nxos.nxos_ntp_options_module.rst @@ -0,0 +1,192 @@ +.. _cisco.nxos.nxos_ntp_options_module: + + +*************************** +cisco.nxos.nxos_ntp_options +*************************** + +**Manages NTP options.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated module released with more functionality. +:Alternative: nxos_ntp_global + + + +Synopsis +-------- +- Manages NTP options, e.g. authoritative server and logging. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ logging + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Sets whether NTP logging is enabled on the device.
+
+
+ master + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Sets whether the device is an authoritative NTP server.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ stratum + +
+ string +
+ 		+ +
If master=true, an optional stratum can be supplied (1-15). The device default is 8.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - When ``state=absent``, master and logging will be set to False and stratum will be removed as well + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Basic NTP options configuration + - cisco.nxos.nxos_ntp_options: + master: true + stratum: 12 + logging: false + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ updates + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['no ntp logging', 'ntp master 12']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_nxapi_module.rst b/docs/cisco.nxos.nxos_nxapi_module.rst new file mode 100644 index 000000000..182fe1516 --- /dev/null +++ b/docs/cisco.nxos.nxos_nxapi_module.rst @@ -0,0 +1,300 @@ +.. _cisco.nxos.nxos_nxapi_module: + + +********************* +cisco.nxos.nxos_nxapi +********************* + +**Manage NXAPI configuration on an NXOS device.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Configures the NXAPI feature on devices running Cisco NXOS. The NXAPI feature is absent from the configuration by default. Since this module manages the NXAPI feature it only supports the use of the ``Cli`` transport. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ http + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
Controls the operating state of the HTTP protocol as one of the underlying transports for NXAPI. By default, NXAPI will enable the HTTP transport when the feature is first configured. To disable the use of the HTTP transport, set the value of this argument to False.
+

aliases: enable_http
+
+
+ http_port + +
+ integer +
+ 		+ Default:
80
+ 		+
Configure the port with which the HTTP server will listen on for requests. By default, NXAPI will bind the HTTP service to the standard HTTP port 80. This argument accepts valid port values in the range of 1 to 65535.
+
+
+ https + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Controls the operating state of the HTTPS protocol as one of the underlying transports for NXAPI. By default, NXAPI will disable the HTTPS transport when the feature is first configured. To enable the use of the HTTPS transport, set the value of this argument to True.
+

aliases: enable_https
+
+
+ https_port + +
+ integer +
+ 		+ Default:
443
+ 		+
Configure the port with which the HTTPS server will listen on for requests. By default, NXAPI will bind the HTTPS service to the standard HTTPS port 443. This argument accepts valid port values in the range of 1 to 65535.
+
+
+ sandbox + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
The NXAPI feature provides a web base UI for developers for entering commands. This feature is initially disabled when the NXAPI feature is configured for the first time. When the sandbox argument is set to True, the developer sandbox URL will accept requests and when the value is set to False, the sandbox URL is unavailable. This is supported on NX-OS 7K series.
+

aliases: enable_sandbox
+
+
+ ssl_strong_ciphers + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Controls the use of whether strong or weak ciphers are configured. By default, this feature is disabled and weak ciphers are configured. To enable the use of strong ciphers, set the value of this argument to True.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
The state argument controls whether or not the NXAPI feature is configured on the remote device. When the value is present the NXAPI feature configuration is present in the device running-config. When the values is absent the feature configuration is removed from the running-config.
+
+
+ tlsv1_0 + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
Controls the use of the Transport Layer Security version 1.0 is configured. By default, this feature is enabled. To disable the use of TLSV1.0, set the value of this argument to True.
+
+
+ tlsv1_1 + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Controls the use of the Transport Layer Security version 1.1 is configured. By default, this feature is disabled. To enable the use of TLSV1.1, set the value of this argument to True.
+
+
+ tlsv1_2 + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Controls the use of the Transport Layer Security version 1.2 is configured. By default, this feature is disabled. To enable the use of TLSV1.2, set the value of this argument to True.
+
+
+ + +Notes +----- + +.. note:: + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Enable NXAPI access with default configuration + cisco.nxos.nxos_nxapi: + state: present + + - name: Enable NXAPI with no HTTP, HTTPS at port 9443 and sandbox disabled + cisco.nxos.nxos_nxapi: + enable_http: false + https_port: 9443 + https: true + enable_sandbox: false + + - name: remove NXAPI configuration + cisco.nxos.nxos_nxapi: + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ updates + +
+ list +
+ 		always +
Returns the list of commands that need to be pushed into the remote device to satisfy the arguments
+
+
Sample:
+
['no feature nxapi']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_ospf_interfaces_module.rst b/docs/cisco.nxos.nxos_ospf_interfaces_module.rst new file mode 100644 index 000000000..ff69b6e71 --- /dev/null +++ b/docs/cisco.nxos.nxos_ospf_interfaces_module.rst @@ -0,0 +1,1732 @@ +.. _cisco.nxos.nxos_ospf_interfaces_module: + + +******************************* +cisco.nxos.nxos_ospf_interfaces +******************************* + +**OSPF Interfaces Resource Module.** + + +Version added: 1.3.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages OSPF(v2/v3) configuration of interfaces on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of OSPF configuration for interfaces.
+
+
+ address_family + +
+ list + / elements=dictionary +
+ 		+ +
OSPF settings on the interfaces in address-family context.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
Address Family Identifier (AFI) for OSPF settings on the interfaces.
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Authentication settings on the interface.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable authentication on the interface.
+
+
+ key_chain + +
+ string +
+ 		+ +
Authentication password key-chain.
+
+
+ message_digest + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use message-digest authentication.
+
+
+ null_auth + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use null(disable) authentication.
+
+
+ authentication_key + +
+ dictionary +
+ 		+ +
Configure the authentication key for the interface.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 Specifies an UNENCRYPTED authentication key will follow.
+
3 Specifies an 3DES ENCRYPTED authentication key will follow.
+
7 Specifies a Cisco type 7 ENCRYPTED authentication key will follow.
+
+
+ key + +
+ string + / required +
+ 		+ +
Authentication key.
+
Valid values are Cisco type 7 ENCRYPTED password, 3DES ENCRYPTED password and UNENCRYPTED (cleartext) password based on the value of encryption key.
+
+
+ cost + +
+ integer +
+ 		+ +
Cost associated with interface.
+
+
+ dead_interval + +
+ integer +
+ 		+ +
Dead interval value (in seconds).
+
+
+ default_passive_interface + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set passive-interface attribute on this interface to default.
+
This option is mutually exclusive with passive_interface.
+
+
+ hello_interval + +
+ integer +
+ 		+ +
Hello interval value (in seconds).
+
+
+ instance + +
+ integer +
+ 		+ +
Instance identifier.
+
+
+ message_digest_key + +
+ dictionary +
+ 		+ +
Message digest authentication password (key) settings.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 Specifies an UNENCRYPTED ospf password (key) will follow.
+
3 Specifies an 3DES ENCRYPTED ospf password (key) will follow.
+
7 Specifies a Cisco type 7 ENCRYPTED the ospf password (key) will follow.
+
+
+ key + +
+ string + / required +
+ 		+ +
Authentication key.
+
Valid values are Cisco type 7 ENCRYPTED password, 3DES ENCRYPTED password and UNENCRYPTED (cleartext) password based on the value of encryption key.
+
+
+ key_id + +
+ integer + / required +
+ 		+ +
Key ID.
+
+
+ mtu_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable OSPF MTU mismatch detection.
+
+
+ multi_areas + +
+ list + / elements=string +
+ 		+ +
Multi-Areas associated with interface (not tied to OSPF process).
+
Valid values are Area Ids as an integer or IP address.
+
+
+ network + +
+ string +
+ 		+
    Choices: +
  • broadcast
    • +
  • point-to-point
    • +
+ 		+
Network type.
+
+
+ passive_interface + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress routing updates on the interface.
+
This option is mutually exclusive with default_passive_interface.
+
+
+ priority + +
+ integer +
+ 		+ +
Router priority.
+
+
+ processes + +
+ list + / elements=dictionary +
+ 		+ +
Interfaces configuration for an OSPF process.
+
+
+ area + +
+ dictionary +
+ 		+ +
Area associated with interface.
+
+
+ area_id + +
+ string + / required +
+ 		+ +
Area ID in IP address format.
+
+
+ secondaries + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not include secondary IPv4/IPv6 addresses.
+
+
+ multi_areas + +
+ list + / elements=string +
+ 		+ +
Multi-Areas associated with interface.
+
Valid values are Area Ids as an integer or IP address.
+
+
+ process_id + +
+ string + / required +
+ 		+ +
OSPF process tag.
+
+
+ retransmit_interval + +
+ integer +
+ 		+ +
Packet retransmission interval.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Shutdown OSPF on this interface.
+
+
+ transmit_delay + +
+ integer +
+ 		+ +
Packet transmission delay.
+
+
+ name + +
+ string + / required +
+ 		+ +
Name/Identifier of the interface.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section "^interface".
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • parsed
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
+
+ + +Notes +----- + +.. note:: + - Unsupported for Cisco MDS + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # interface Ethernet1/2 + # no switchport + # interface Ethernet1/3 + # no switchport + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_ospf_interfaces: + config: + - name: Ethernet1/1 + address_family: + - afi: ipv4 + processes: + - process_id: '100' + area: + area_id: 1.1.1.1 + secondaries: false + multi_areas: + - 11.11.11.11 + - afi: ipv6 + processes: + - process_id: '200' + area: + area_id: 2.2.2.2 + multi_areas: + - 21.0.0.0 + - process_id: '300' + multi_areas: + - 50.50.50.50 + multi_areas: + - 16.10.10.10 + - name: Ethernet1/2 + address_family: + - afi: ipv4 + authentication: + enable: true + key_chain: test-1 + message_digest_key: + key_id: 10 + encryption: 3 + key: abc01d272be25d29 + cost: 100 + - afi: ipv6 + network: broadcast + shutdown: true + - name: Ethernet1/3 + address_family: + - afi: ipv4 + authentication_key: + encryption: 7 + key: 12090404011C03162E + state: merged + + # Task output: + # ------------ + # before: + # - name: Ethernet1/1 + # - name: Ethernet1/2 + # - name: Ethernet1/3 + # + # commands: + # - interface Ethernet1/1 + # - ip router ospf multi-area 11.11.11.11 + # - ip router ospf 100 area 1.1.1.1 secondaries none + # - ipv6 router ospfv3 multi-area 16.10.10.10 + # - ipv6 router ospfv3 200 area 2.2.2.2 + # - ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - ipv6 router ospfv3 300 multi-area 50.50.50.50 + # - interface Ethernet1/2 + # - ip ospf authentication key-chain test-1 + # - ip ospf authentication + # - ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # - ip ospf cost 100 + # - ospfv3 network broadcast + # - ospfv3 shutdown + # - interface Ethernet1/3 + # - ip ospf authentication-key 7 12090404011C03162E + # + # after: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + + # After state: + # ------------ + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + + # Using replaced + + # Before state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + - name: Replace OSPF configurations of listed interfaces with provided configurations + cisco.nxos.nxos_ospf_interfaces: + config: + - name: Ethernet1/1 + address_family: + - afi: ipv4 + processes: + - process_id: "100" + area: + area_id: 1.1.1.1 + secondaries: false + multi_areas: + - 11.11.11.12 + - name: Ethernet1/3 + state: replaced + + # Task output: + # ------------ + # before: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + # + # commands: + # - interface Ethernet1/1 + # - ip router ospf multi-area 11.11.11.12 + # - no ip router ospf multi-area 11.11.11.11 + # - no ipv6 router ospfv3 multi-area 16.10.10.10 + # - no ipv6 router ospfv3 200 area 2.2.2.2 + # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 + # - interface Ethernet1/3 + # - no ip ospf authentication-key 7 12090404011C03162E + # + # after: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.12 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - name: Ethernet1/3 + # + # After state: + # ------------ + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.12 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + + + # Using overridden + + # Before state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + - name: Override all OSPF interfaces configuration with provided configuration + cisco.nxos.nxos_ospf_interfaces: + config: + - name: Ethernet1/1 + address_family: + - afi: ipv4 + processes: + - process_id: "100" + area: + area_id: 1.1.1.1 + secondaries: false + multi_areas: + - 11.11.11.12 + state: overridden + + # Task output: + # ------------ + # before: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + # + # commands: + # - interface Ethernet1/2 + # - no ip ospf authentication key-chain test-1 + # - no ip ospf authentication + # - no ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # - no ip ospf cost 100 + # - no ospfv3 network broadcast + # - no ospfv3 shutdown + # - interface Ethernet1/3 + # - no ip ospf authentication-key 7 12090404011C03162E + # - interface Ethernet1/1 + # - ip router ospf multi-area 11.11.11.12 + # - no ip router ospf multi-area 11.11.11.11 + # - no ipv6 router ospfv3 multi-area 16.10.10.10 + # - no ipv6 router ospfv3 200 area 2.2.2.2 + # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 + # + # after: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.12 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # name: Ethernet1/1 + # - name: Ethernet1/2 + # - name: Ethernet1/3 + + # After state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.12 + # interface Ethernet1/2 + # no switchport + # interface Ethernet1/3 + # no switchport + + # Using deleted to delete OSPF config of a single interface + + # Before state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + - name: Delete OSPF config from a single interface + cisco.nxos.nxos_ospf_interfaces: + config: + - name: Ethernet1/1 + state: deleted + + # Task output: + # ------------ + # before: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + # + # commands: + # - interface Ethernet1/1 + # - no ip router ospf multi-area 11.11.11.11 + # - no ip router ospf 100 area 1.1.1.1 secondaries none + # - no ipv6 router ospfv3 multi-area 16.10.10.10 + # - no ipv6 router ospfv3 200 area 2.2.2.2 + # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 + # + # after: + # - name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + + + # After state: + # ------------ + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + # Using deleted to delete OSPF config from all interfaces + + # Before state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + - name: Delete OSPF config from all interfaces + cisco.nxos.nxos_ospf_interfaces: + state: deleted + + # Task output: + # ------------ + # before: + # - name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + # + # commands: + # - interface Ethernet1/1 + # - no ip router ospf multi-area 11.11.11.11 + # - no ip router ospf 100 area 1.1.1.1 secondaries none + # - no ipv6 router ospfv3 multi-area 16.10.10.10 + # - no ipv6 router ospfv3 200 area 2.2.2.2 + # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 + # - interface Ethernet1/2 + # - no ip ospf authentication key-chain test-1 + # - no ip ospf authentication + # - no ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # - no ip ospf cost 100 + # - no ospfv3 network broadcast + # - no ospfv3 shutdown + # - interface Ethernet1/3 + # - no ip ospf authentication-key 7 12090404011C03162E + # + # after: + # - name: Ethernet1/1 + # - name: Ethernet1/2 + # - name: Ethernet1/3 + + # After state: + # ------------ + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # interface Ethernet1/2 + # no switchport + # interface Ethernet1/3 + # no switchport + + # Using rendered + + - name: >- + Render platform specific configuration lines with state rendered (without + connecting to the device) + cisco.nxos.nxos_ospf_interfaces: + config: + - name: Ethernet1/1 + address_family: + - afi: ipv4 + processes: + - process_id: '100' + area: + area_id: 1.1.1.1 + secondaries: false + multi_areas: + - 11.11.11.11 + - afi: ipv6 + processes: + - process_id: '200' + area: + area_id: 2.2.2.2 + multi_areas: + - 21.0.0.0 + - process_id: '300' + multi_areas: + - 50.50.50.50 + multi_areas: + - 16.10.10.10 + - name: Ethernet1/2 + address_family: + - afi: ipv4 + authentication: + enable: true + key_chain: test-1 + message_digest_key: + key_id: 10 + encryption: 3 + key: abc01d272be25d29 + cost: 100 + - afi: ipv6 + network: broadcast + shutdown: true + - name: Ethernet1/3 + address_family: + - afi: ipv4 + authentication_key: + encryption: 7 + key: 12090404011C03162E + state: rendered + + + # Task Output: + # ------------ + # rendered: + # - interface Ethernet1/1 + # - ip router ospf multi-area 11.11.11.11 + # - ip router ospf 100 area 1.1.1.1 secondaries none + # - ipv6 router ospfv3 multi-area 16.10.10.10 + # - ipv6 router ospfv3 200 area 2.2.2.2 + # - ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - ipv6 router ospfv3 300 multi-area 50.50.50.50 + # - interface Ethernet1/2 + # - ip ospf authentication key-chain test-1 + # - ip ospf authentication + # - ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # - ip ospf cost 100 + # - ospfv3 network broadcast + # - ospfv3 shutdown + # - interface Ethernet1/3 + # - ip ospf authentication-key 7 12090404011C03162E + + # Using parsed + + # parsed.cfg + # ------------ + # interface Ethernet1/1 + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # interface Ethernet1/2 + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # ip ospf authentication-key 7 12090404011C03162E + + - name: arse externally provided OSPF interfaces config + cisco.nxos.nxos_ospf_interfaces: + running_config: "{{ lookup('file', 'ospf_interfaces.cfg') }}" + state: parsed + + # Task output: + # ------------ + # parsed: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + + # Using gathered + + # On-box config + + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.12 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + + # Task output: + # ------------ + # gathered: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.12 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - name: Ethernet1/3 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/1', 'ip router ospf multi-area 11.11.11.11', 'ip router ospf 100 area 1.1.1.1 secondaries none', 'no ipv6 router ospfv3 multi-area 16.10.10.10', 'ipv6 router ospfv3 200 area 2.2.2.2', 'ipv6 router ospfv3 200 multi-area 21.0.0.0', 'ipv6 router ospfv3 300 multi-area 50.50.50.50', 'interface Ethernet1/2', 'no ip ospf authentication key-chain test-1', 'ip ospf authentication']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['interface Ethernet1/1', 'ip router ospf multi-area 11.11.11.11', 'ip router ospf 100 area 1.1.1.1 secondaries none']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_ospfv2_module.rst b/docs/cisco.nxos.nxos_ospfv2_module.rst new file mode 100644 index 000000000..2115d34f2 --- /dev/null +++ b/docs/cisco.nxos.nxos_ospfv2_module.rst @@ -0,0 +1,5458 @@ +.. _cisco.nxos.nxos_ospfv2_module: + + +********************** +cisco.nxos.nxos_ospfv2 +********************** + +**OSPFv2 resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages OSPFv2 configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A list of OSPF process configuration.
+
+
+ processes + +
+ list + / elements=dictionary +
+ 		+ +
A list of OSPF instances' configurations.
+
+
+ areas + +
+ list + / elements=dictionary +
+ 		+ +
Configure properties of OSPF Areas.
+
+
+ area_id + +
+ string + / required +
+ 		+ +
The Area ID in IP Address format.
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Authentication settings for the Area.
+
+
+ message_digest + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use message-digest authentication.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set authentication for the area.
+
+
+ default_cost + +
+ integer +
+ 		+ +
Specify the default cost for default summary LSA.
+
+
+ filter_list + +
+ list + / elements=dictionary +
+ 		+ +
Filter prefixes between OSPF areas.
+
+
+ direction + +
+ string + / required +
+ 		+
    Choices: +
  • in
    • +
  • out
    • +
+ 		+
The direction to apply the route map.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
The Route-map name.
+
+
+ nssa + +
+ dictionary +
+ 		+ +
NSSA settings for the area.
+
+
+ default_information_originate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Originate Type-7 default LSA into NSSA area.
+
+
+ no_redistribution + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send redistributed LSAs into NSSA area.
+
+
+ no_summary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send summary LSAs into NSSA area.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure area as NSSA.
+
+
+ translate + +
+ dictionary +
+ 		+ +
Translate LSA.
+
+
+ type7 + +
+ dictionary +
+ 		+ +
Translate from Type 7 to Type 5.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always translate LSAs
+
+
+ never + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Never translate LSAs
+
+
+ supress_fa + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress forwarding address in translated LSAs.
+
+
+ ranges + +
+ list + / elements=dictionary +
+ 		+ +
Configure an address range for the area.
+
+
+ cost + +
+ integer +
+ 		+ +
Cost to use for the range.
+
+
+ not_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress advertising the specified range.
+
+
+ prefix + +
+ string + / required +
+ 		+ +
IP in Prefix format (x.x.x.x/len)
+
+
+ stub + +
+ dictionary +
+ 		+ +
Settings for configuring the area as a stub.
+
+
+ no_summary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Prevent ABR from sending summary LSAs into stub area.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure the area as a stub.
+
+
+ auto_cost + +
+ dictionary +
+ 		+ +
Calculate OSPF cost according to bandwidth.
+
+
+ reference_bandwidth + +
+ integer + / required +
+ 		+ +
Reference bandwidth used to assign OSPF cost.
+
+
+ unit + +
+ string + / required +
+ 		+
    Choices: +
  • Gbps
    • +
  • Mbps
    • +
+ 		+
Specify in which unit the reference bandwidth is specified.
+
+
+ bfd + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable BFD on all OSPF interfaces.
+
+
+ default_information + +
+ dictionary +
+ 		+ +
Control distribution of default routes.
+
+
+ originate + +
+ dictionary +
+ 		+ +
Distribute a default route.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always advertise a default route.
+
+
+ route_map + +
+ string +
+ 		+ +
Policy to control distribution of default routes
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable distribution of default route.
+
+
+ default_metric + +
+ integer +
+ 		+ +
Specify default metric for redistributed routes.
+
+
+ distance + +
+ integer +
+ 		+ +
Configure the OSPF administrative distance.
+
+
+ flush_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Flush routes on a non-graceful controlled restart.
+
+
+ graceful_restart + +
+ dictionary +
+ 		+ +
Configure graceful restart.
+
+
+ grace_period + +
+ integer +
+ 		+ +
Configure maximum interval to restart gracefully.
+
+
+ helper_disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable helper mode.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable graceful-restart.
+
+
+ isolate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Isolate this router from OSPF perspective.
+
+
+ log_adjacency_changes + +
+ dictionary +
+ 		+ +
Log changes in adjacency state.
+
+
+ detail + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Notify all state changes.
+
+
+ log + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable logging changes in adjacency state.
+
+
+ max_lsa + +
+ dictionary +
+ 		+ +
Feature to limit the number of non-self-originated LSAs.
+
+
+ ignore_count + +
+ integer +
+ 		+ +
Set count on how many times adjacencies can be suppressed.
+
+
+ ignore_time + +
+ integer +
+ 		+ +
Set time during which all adjacencies are suppressed.
+
+
+ max_non_self_generated_lsa + +
+ integer + / required +
+ 		+ +
Set the maximum number of non self-generated LSAs.
+
+
+ reset_time + +
+ integer +
+ 		+ +
Set number of minutes after which ignore-count is reset to zero.
+
+
+ threshold + +
+ integer +
+ 		+ +
Threshold value (%) at which to generate a warning message.
+
+
+ warning_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log a warning message when limit is exceeded.
+
+
+ max_metric + +
+ dictionary +
+ 		+ +
Maximize the cost metric.
+
+
+ router_lsa + +
+ dictionary +
+ 		+ +
Router LSA configuration.
+
+
+ external_lsa + +
+ dictionary +
+ 		+ +
External LSA configuration.
+
+
+ max_metric_value + +
+ integer +
+ 		+ +
Set max metric value for external LSAs.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set external-lsa attribute.
+
+
+ include_stub + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise Max metric for Stub links as well.
+
+
+ on_startup + +
+ dictionary +
+ 		+ +
Effective only at startup.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set on-startup attribute.
+
+
+ wait_for_bgp_asn + +
+ integer +
+ 		+ +
ASN of BGP to wait for.
+
+
+ wait_period + +
+ integer +
+ 		+ +
Wait period in seconds after startup.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set router-lsa attribute.
+
+
+ summary_lsa + +
+ dictionary +
+ 		+ +
Summary LSAs configuration.
+
+
+ max_metric_value + +
+ integer +
+ 		+ +
Max metric value for summary LSAs.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set summary-lsa attribute.
+
+
+ maximum_paths + +
+ integer +
+ 		+ +
Maximum paths per destination.
+
+
+ mpls + +
+ dictionary +
+ 		+ +
OSPF MPLS configuration settings.
+
+
+ traffic_eng + +
+ dictionary +
+ 		+ +
OSPF MPLS Traffic Engineering commands.
+
+
+ areas + +
+ list + / elements=dictionary +
+ 		+ +
List of Area IDs.
+
+
+ area_id + +
+ string +
+ 		+ +
Area Id in ip address format.
+
+
+ multicast_intact + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
MPLS TE multicast support.
+
+
+ router_id + +
+ string +
+ 		+ +
Router ID associated with TE.
+
+
+ name_lookup + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Display OSPF router ids as DNS names.
+
+
+ passive_interface + +
+ dictionary +
+ 		+ +
Suppress routing updates on the interface.
+
+
+ default + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Interfaces passive by default.
+
+
+ process_id + +
+ string + / required +
+ 		+ +
The OSPF process tag.
+
+
+ redistribute + +
+ list + / elements=dictionary +
+ 		+ +
Redistribute information from another routing protocol.
+
+
+ id + +
+ string +
+ 		+ +
The identifier for the protocol specified.
+
+
+ protocol + +
+ string + / required +
+ 		+
    Choices: +
  • bgp
    • +
  • direct
    • +
  • eigrp
    • +
  • isis
    • +
  • lisp
    • +
  • ospf
    • +
  • rip
    • +
  • static
    • +
+ 		+
The name of the protocol.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
The route map policy to constrain redistribution.
+
+
+ rfc1583compatibility + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure 1583 compatibility for external path preferences.
+
+
+ router_id + +
+ string +
+ 		+ +
Set OSPF process router-id.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Shutdown the OSPF protocol instance.
+
+
+ summary_address + +
+ list + / elements=dictionary +
+ 		+ +
Configure route summarization for redistribution.
+
+
+ not_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress advertising the specified summary.
+
+
+ prefix + +
+ string + / required +
+ 		+ +
IP prefix in format x.x.x.x/ml.
+
+
+ tag + +
+ integer +
+ 		+ +
A 32-bit tag value.
+
+
+ table_map + +
+ dictionary +
+ 		+ +
Policy for filtering/modifying OSPF routes before sending them to RIB.
+
+
+ filter + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Block the OSPF routes from being sent to RIB.
+
+
+ name + +
+ string + / required +
+ 		+ +
The Route Map name.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure timer related constants.
+
+
+ lsa_arrival + +
+ integer +
+ 		+ +
Mimimum interval between arrival of a LSA.
+
+
+ lsa_group_pacing + +
+ integer +
+ 		+ +
LSA group refresh/maxage interval.
+
+
+ throttle + +
+ dictionary +
+ 		+ +
Configure throttle related constants.
+
+
+ lsa + +
+ dictionary +
+ 		+ +
Set rate-limiting for LSA generation.
+
+
+ hold_interval + +
+ integer +
+ 		+ +
The hold interval.
+
+
+ max_interval + +
+ integer +
+ 		+ +
The max interval.
+
+
+ start_interval + +
+ integer +
+ 		+ +
The start interval.
+
+
+ spf + +
+ dictionary +
+ 		+ +
Set OSPF SPF timers.
+
+
+ initial_spf_delay + +
+ integer +
+ 		+ +
Initial SPF schedule delay in milliseconds.
+
+
+ max_wait_time + +
+ integer +
+ 		+ +
Maximum wait time between SPF calculations.
+
+
+ min_hold_time + +
+ integer +
+ 		+ +
Minimum hold time between SPF calculations.
+
+
+ vrfs + +
+ list + / elements=dictionary +
+ 		+ +
Configure VRF specific OSPF settings.
+
+
+ areas + +
+ list + / elements=dictionary +
+ 		+ +
Configure properties of OSPF Areas.
+
+
+ area_id + +
+ string + / required +
+ 		+ +
The Area ID in IP Address format.
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Authentication settings for the Area.
+
+
+ message_digest + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use message-digest authentication.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set authentication for the area.
+
+
+ default_cost + +
+ integer +
+ 		+ +
Specify the default cost for default summary LSA.
+
+
+ filter_list + +
+ list + / elements=dictionary +
+ 		+ +
Filter prefixes between OSPF areas.
+
+
+ direction + +
+ string + / required +
+ 		+
    Choices: +
  • in
    • +
  • out
    • +
+ 		+
The direction to apply the route map.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
The Route-map name.
+
+
+ nssa + +
+ dictionary +
+ 		+ +
NSSA settings for the area.
+
+
+ default_information_originate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Originate Type-7 default LSA into NSSA area.
+
+
+ no_redistribution + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send redistributed LSAs into NSSA area.
+
+
+ no_summary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send summary LSAs into NSSA area.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure area as NSSA.
+
+
+ translate + +
+ dictionary +
+ 		+ +
Translate LSA.
+
+
+ type7 + +
+ dictionary +
+ 		+ +
Translate from Type 7 to Type 5.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always translate LSAs
+
+
+ never + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Never translate LSAs
+
+
+ supress_fa + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress forwarding address in translated LSAs.
+
+
+ ranges + +
+ list + / elements=dictionary +
+ 		+ +
Configure an address range for the area.
+
+
+ cost + +
+ integer +
+ 		+ +
Cost to use for the range.
+
+
+ not_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress advertising the specified range.
+
+
+ prefix + +
+ string + / required +
+ 		+ +
IP in Prefix format (x.x.x.x/len)
+
+
+ stub + +
+ dictionary +
+ 		+ +
Settings for configuring the area as a stub.
+
+
+ no_summary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Prevent ABR from sending summary LSAs into stub area.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure the area as a stub.
+
+
+ auto_cost + +
+ dictionary +
+ 		+ +
Calculate OSPF cost according to bandwidth.
+
+
+ reference_bandwidth + +
+ integer + / required +
+ 		+ +
Reference bandwidth used to assign OSPF cost.
+
+
+ unit + +
+ string + / required +
+ 		+
    Choices: +
  • Gbps
    • +
  • Mbps
    • +
+ 		+
Specify in which unit the reference bandwidth is specified.
+
+
+ bfd + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable BFD on all OSPF interfaces.
+
+
+ capability + +
+ dictionary +
+ 		+ +
OSPF capability settings.
+
+
+ vrf_lite + +
+ dictionary +
+ 		+ +
Enable VRF-lite capability settings.
+
+
+ evpn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ethernet VPN.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable VRF-lite support.
+
+
+ default_information + +
+ dictionary +
+ 		+ +
Control distribution of default routes.
+
+
+ originate + +
+ dictionary +
+ 		+ +
Distribute a default route.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always advertise a default route.
+
+
+ route_map + +
+ string +
+ 		+ +
Policy to control distribution of default routes
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable distribution of default route.
+
+
+ default_metric + +
+ integer +
+ 		+ +
Specify default metric for redistributed routes.
+
+
+ distance + +
+ integer +
+ 		+ +
Configure the OSPF administrative distance.
+
+
+ down_bit_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure a PE router to ignore the DN bit for network summary, external and NSSA external LSA.
+
+
+ graceful_restart + +
+ dictionary +
+ 		+ +
Configure graceful restart.
+
+
+ grace_period + +
+ integer +
+ 		+ +
Configure maximum interval to restart gracefully.
+
+
+ helper_disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable helper mode.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable graceful-restart.
+
+
+ log_adjacency_changes + +
+ dictionary +
+ 		+ +
Log changes in adjacency state.
+
+
+ detail + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Notify all state changes.
+
+
+ log + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable logging changes in adjacency state.
+
+
+ max_lsa + +
+ dictionary +
+ 		+ +
Feature to limit the number of non-self-originated LSAs.
+
+
+ ignore_count + +
+ integer +
+ 		+ +
Set count on how many times adjacencies can be suppressed.
+
+
+ ignore_time + +
+ integer +
+ 		+ +
Set time during which all adjacencies are suppressed.
+
+
+ max_non_self_generated_lsa + +
+ integer + / required +
+ 		+ +
Set the maximum number of non self-generated LSAs.
+
+
+ reset_time + +
+ integer +
+ 		+ +
Set number of minutes after which ignore-count is reset to zero.
+
+
+ threshold + +
+ integer +
+ 		+ +
Threshold value (%) at which to generate a warning message.
+
+
+ warning_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log a warning message when limit is exceeded.
+
+
+ max_metric + +
+ dictionary +
+ 		+ +
Maximize the cost metric.
+
+
+ router_lsa + +
+ dictionary +
+ 		+ +
Router LSA configuration.
+
+
+ external_lsa + +
+ dictionary +
+ 		+ +
External LSA configuration.
+
+
+ max_metric_value + +
+ integer +
+ 		+ +
Set max metric value for external LSAs.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set external-lsa attribute.
+
+
+ include_stub + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise Max metric for Stub links as well.
+
+
+ on_startup + +
+ dictionary +
+ 		+ +
Effective only at startup.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set on-startup attribute.
+
+
+ wait_for_bgp_asn + +
+ integer +
+ 		+ +
ASN of BGP to wait for.
+
+
+ wait_period + +
+ integer +
+ 		+ +
Wait period in seconds after startup.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set router-lsa attribute.
+
+
+ summary_lsa + +
+ dictionary +
+ 		+ +
Summary LSAs configuration.
+
+
+ max_metric_value + +
+ integer +
+ 		+ +
Max metric value for summary LSAs.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set summary-lsa attribute.
+
+
+ maximum_paths + +
+ integer +
+ 		+ +
Maximum paths per destination.
+
+
+ name_lookup + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Display OSPF router ids as DNS names.
+
+
+ passive_interface + +
+ dictionary +
+ 		+ +
Suppress routing updates on the interface.
+
+
+ default + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Interfaces passive by default.
+
+
+ redistribute + +
+ list + / elements=dictionary +
+ 		+ +
Redistribute information from another routing protocol.
+
+
+ id + +
+ string +
+ 		+ +
The identifier for the protocol specified.
+
+
+ protocol + +
+ string + / required +
+ 		+
    Choices: +
  • bgp
    • +
  • direct
    • +
  • eigrp
    • +
  • isis
    • +
  • lisp
    • +
  • ospf
    • +
  • rip
    • +
  • static
    • +
+ 		+
The name of the protocol.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
The route map policy to constrain redistribution.
+
+
+ rfc1583compatibility + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure 1583 compatibility for external path preferences.
+
+
+ router_id + +
+ string +
+ 		+ +
Set OSPF process router-id.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Shutdown the OSPF protocol instance.
+
+
+ summary_address + +
+ list + / elements=dictionary +
+ 		+ +
Configure route summarization for redistribution.
+
+
+ not_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress advertising the specified summary.
+
+
+ prefix + +
+ string + / required +
+ 		+ +
IP prefix in format x.x.x.x/ml.
+
+
+ tag + +
+ integer +
+ 		+ +
A 32-bit tag value.
+
+
+ table_map + +
+ dictionary +
+ 		+ +
Policy for filtering/modifying OSPF routes before sending them to RIB.
+
+
+ filter + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Block the OSPF routes from being sent to RIB.
+
+
+ name + +
+ string + / required +
+ 		+ +
The Route Map name.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure timer related constants.
+
+
+ lsa_arrival + +
+ integer +
+ 		+ +
Mimimum interval between arrival of a LSA.
+
+
+ lsa_group_pacing + +
+ integer +
+ 		+ +
LSA group refresh/maxage interval.
+
+
+ throttle + +
+ dictionary +
+ 		+ +
Configure throttle related constants.
+
+
+ lsa + +
+ dictionary +
+ 		+ +
Set rate-limiting for LSA generation.
+
+
+ hold_interval + +
+ integer +
+ 		+ +
The hold interval.
+
+
+ max_interval + +
+ integer +
+ 		+ +
The max interval.
+
+
+ start_interval + +
+ integer +
+ 		+ +
The start interval.
+
+
+ spf + +
+ dictionary +
+ 		+ +
Set OSPF SPF timers.
+
+
+ initial_spf_delay + +
+ integer +
+ 		+ +
Initial SPF schedule delay in milliseconds.
+
+
+ max_wait_time + +
+ integer +
+ 		+ +
Maximum wait time between SPF calculations.
+
+
+ min_hold_time + +
+ integer +
+ 		+ +
Minimum hold time between SPF calculations.
+
+
+ vrf + +
+ string + / required +
+ 		+ +
Name/Identifier of the VRF.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section "^router ospf .*".
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • parsed
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 7.0(3)I5(1). + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # nxos-9k-rdo# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_ospfv2: + config: + processes: + - process_id: 100 + router_id: 203.0.113.20 + - process_id: 102 + router_id: 198.51.100.1 + areas: + - area_id: 0.0.0.100 + filter_list: + - route_map: rmap_1 + direction: in + - route_map: rmap_2 + direction: out + ranges: + - prefix: 198.51.100.64/27 + not_advertise: true + - prefix: 198.51.100.96/27 + cost: 120 + - area_id: 0.0.0.101 + authentication: + message_digest: true + redistribute: + - protocol: eigrp + id: 120 + route_map: rmap_1 + - protocol: direct + route_map: ospf102-direct-connect + vrfs: + - vrf: zone1 + router_id: 198.51.100.129 + redistribute: + - protocol: static + route_map: zone1-static-connect + summary_address: + - prefix: 198.51.100.128/27 + tag: 121 + - prefix: 198.51.100.160/27 + areas: + - area_id: 0.0.0.102 + nssa: + default_information_originate: true + no_summary: true + - area_id: 0.0.0.103 + nssa: + no_summary: true + translate: + type7: + always: true + - vrf: zone2 + auto_cost: + reference_bandwidth: 45 + unit: Gbps + state: merged + + # Task output: + # ------------ + # before: {} + # + # commands: + # - router ospf 102 + # - router-id 198.51.100.1 + # - redistribute eigrp 120 route-map rmap_1 + # - redistribute direct route-map ospf102-direct-connect + # - area 0.0.0.100 filter-list route-map rmap_1 in + # - area 0.0.0.100 filter-list route-map rmap_2 out + # - area 0.0.0.100 range 198.51.100.64/27 not-advertise + # - area 0.0.0.100 range 198.51.100.96/27 cost 120 + # - area 0.0.0.101 authentication message-digest + # - vrf zone1 + # - router-id 198.51.100.129 + # - summary-address 198.51.100.128/27 tag 121 + # - summary-address 198.51.100.160/27 + # - redistribute static route-map zone1-static-connect + # - area 0.0.0.102 nssa no-summary default-information-originate + # - area 0.0.0.103 nssa no-summary + # - area 0.0.0.103 nssa translate type7 always + # - vrf zone2 + # - auto-cost reference-bandwidth 45 Gbps + # - router ospf 100 + # - router-id 203.0.113.20 + # + # after: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.100 + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # - cost: 120 + # prefix: 198.51.100.96/27 + # - area_id: 0.0.0.101 + # authentication: + # message_digest: true + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # - area_id: 0.0.0.103 + # nssa: + # no_summary: true + # translate: + # type7: + # always: true + # redistribute: + # - protocol: static + # route_map: zone1-static-connect + # router_id: 198.51.100.129 + # vrf: zone1 + # - auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # vrf: zone2 + # + + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # area 0.0.0.100 range 198.51.100.96/27 cost 120 + # area 0.0.0.101 authentication message-digest + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # area 0.0.0.103 nssa no-summary + # area 0.0.0.103 nssa translate type7 always + # redistribute static route-map zone1-static-connect + # summary-address 198.51.100.128/27 tag 121 + # summary-address 198.51.100.160/27 + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + + # Using replaced + + # Before state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # area 0.0.0.100 range 198.51.100.96/27 cost 120 + # area 0.0.0.101 authentication message-digest + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # area 0.0.0.103 nssa no-summary + # area 0.0.0.103 nssa translate type7 always + # redistribute static route-map zone1-static-connect + # summary-address 198.51.100.128/27 tag 121 + # summary-address 198.51.100.160/27 + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + + - name: >- + Replace device configurations of listed OSPF processes with provided + configurations + cisco.nxos.nxos_ospfv2: + config: + processes: + - process_id: 102 + router_id: 198.51.100.1 + areas: + - area_id: 0.0.0.100 + filter_list: + - route_map: rmap_8 + direction: in + ranges: + - prefix: 198.51.100.64/27 + not_advertise: true + - area_id: 0.0.0.101 + stub: + no_summary: true + redistribute: + - protocol: eigrp + id: 130 + route_map: rmap_1 + - protocol: direct + route_map: ospf102-direct-connect + vrfs: + - vrf: zone1 + router_id: 198.51.100.129 + redistribute: + - protocol: bgp + id: 65563 + route_map: zone1-bgp-connect + areas: + - area_id: 0.0.0.102 + nssa: + default_information_originate: true + no_summary: true + state: replaced + + + # Task output: + # ------------ + # before: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.100 + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # - cost: 120 + # prefix: 198.51.100.96/27 + # - area_id: 0.0.0.101 + # authentication: + # message_digest: true + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # - area_id: 0.0.0.103 + # nssa: + # no_summary: true + # translate: + # type7: + # always: true + # redistribute: + # - protocol: static + # route_map: zone1-static-connect + # router_id: 198.51.100.129 + # vrf: zone1 + # - auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # vrf: zone2 + # + # commands: + # - router ospf 102 + # - redistribute eigrp 130 route-map rmap_1 + # - no redistribute eigrp 120 route-map rmap_1 + # - area 0.0.0.100 filter-list route-map rmap_8 in + # - no area 0.0.0.100 filter-list route-map rmap_2 out + # - no area 0.0.0.100 range 198.51.100.96/27 + # - no area 0.0.0.101 authentication + # - area 0.0.0.101 stub no-summary + # - vrf zone1 + # - no summary-address 198.51.100.128/27 tag 121 + # - no summary-address 198.51.100.160/27 + # - redistribute bgp 65563 route-map zone1-bgp-connect + # - no redistribute static route-map zone1-static-connect + # - no area 0.0.0.103 nssa + # - no area 0.0.0.103 nssa translate type7 always + # - no vrf zone2 + # + # after: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.101 + # stub: + # no_summary: true + # - area_id: 0.0.0.100 + # filter_list: + # - direction: in + # route_map: rmap_8 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "130" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # redistribute: + # - id: "65563" + # protocol: bgp + # route_map: zone1-bgp-connect + # router_id: 198.51.100.129 + # vrf: zone1 + + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # area 0.0.0.101 stub no-summary + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 130 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_8 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # redistribute bgp 65563 route-map zone1-bgp-connect + + # Using overridden + + # Before state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # area 0.0.0.100 range 198.51.100.96/27 cost 120 + # area 0.0.0.101 authentication message-digest + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # area 0.0.0.103 nssa no-summary + # area 0.0.0.103 nssa translate type7 always + # redistribute static route-map zone1-static-connect + # summary-address 198.51.100.128/27 tag 121 + # summary-address 198.51.100.160/27 + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + + - name: Override all OSPF configuration with provided configuration + cisco.nxos.nxos_ospfv2: + config: + processes: + - process_id: 104 + router_id: 203.0.113.20 + - process_id: 102 + router_id: 198.51.100.1 + shutdown: true + state: overridden + + # Task output: + # ------------ + # before: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.100 + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # - cost: 120 + # prefix: 198.51.100.96/27 + # - area_id: 0.0.0.101 + # authentication: + # message_digest: true + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # - area_id: 0.0.0.103 + # nssa: + # no_summary: true + # translate: + # type7: + # always: true + # redistribute: + # - protocol: static + # route_map: zone1-static-connect + # router_id: 198.51.100.129 + # vrf: zone1 + # - auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # vrf: zone2 + # + # commands: + # - no router ospf 100 + # - router ospf 104 + # - router-id 203.0.113.20 + # - router ospf 102 + # - shutdown + # - no redistribute direct route-map ospf102-direct-connect + # - no redistribute eigrp 120 route-map rmap_1 + # - no area 0.0.0.100 filter-list route-map rmap_2 out + # - no area 0.0.0.100 filter-list route-map rmap_1 in + # - no area 0.0.0.100 range 198.51.100.64/27 + # - no area 0.0.0.100 range 198.51.100.96/27 + # - no area 0.0.0.101 authentication + # - no vrf zone1 + # - no vrf zone2 + # + # after: + # processes: + # - process_id: "102" + # router_id: 198.51.100.1 + # shutdown: true + # - process_id: "104" + # router_id: 203.0.113.20 + + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 102 + # router-id 198.51.100.1 + # shutdown + # router ospf 104 + # router-id 203.0.113.20 + + # Using deleted to delete a single OSPF process + + # Before state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # area 0.0.0.100 range 198.51.100.96/27 cost 120 + # area 0.0.0.101 authentication message-digest + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # area 0.0.0.103 nssa no-summary + # area 0.0.0.103 nssa translate type7 always + # redistribute static route-map zone1-static-connect + # summary-address 198.51.100.128/27 tag 121 + # summary-address 198.51.100.160/27 + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + + - name: Delete a single OSPF process + cisco.nxos.nxos_ospfv2: + config: + processes: + - process_id: 102 + state: deleted + + # Task output: + # ------------ + # before: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.100 + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # - cost: 120 + # prefix: 198.51.100.96/27 + # - area_id: 0.0.0.101 + # authentication: + # message_digest: true + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # - area_id: 0.0.0.103 + # nssa: + # no_summary: true + # translate: + # type7: + # always: true + # redistribute: + # - protocol: static + # route_map: zone1-static-connect + # router_id: 198.51.100.129 + # vrf: zone1 + # - auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # vrf: zone2 + # + # commands: + # - no router ospf 102 + # + # after: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + + # Using deleted all OSPF processes from the device + + # Before state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # area 0.0.0.100 range 198.51.100.96/27 cost 120 + # area 0.0.0.101 authentication message-digest + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # area 0.0.0.103 nssa no-summary + # area 0.0.0.103 nssa translate type7 always + # redistribute static route-map zone1-static-connect + # summary-address 198.51.100.128/27 tag 121 + # summary-address 198.51.100.160/27 + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + + - name: Delete all OSPF processes from the device + cisco.nxos.nxos_ospfv2: + state: deleted + + # Task output: + # ------------ + # before: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.100 + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # - cost: 120 + # prefix: 198.51.100.96/27 + # - area_id: 0.0.0.101 + # authentication: + # message_digest: true + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # - area_id: 0.0.0.103 + # nssa: + # no_summary: true + # translate: + # type7: + # always: true + # redistribute: + # - protocol: static + # route_map: zone1-static-connect + # router_id: 198.51.100.129 + # vrf: zone1 + # - auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # vrf: zone2 + # + # commands: + # - no router ospf 100 + # - no router ospf 102 + # + # after: {} + + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # nxos-9k-rdo# + + # Using rendered + + - name: >- + Render platform specific configuration lines (without connecting to the + device) + cisco.nxos.nxos_ospfv2: + config: + processes: + - process_id: 100 + router_id: 203.0.113.20 + - process_id: 102 + router_id: 198.51.100.1 + areas: + - area_id: 0.0.0.100 + filter_list: + - route_map: rmap_1 + direction: in + - route_map: rmap_2 + direction: out + ranges: + - prefix: 198.51.100.64/27 + not_advertise: true + - prefix: 198.51.100.96/27 + cost: 120 + - area_id: 0.0.0.101 + authentication: + message_digest: true + redistribute: + - protocol: eigrp + id: 120 + route_map: rmap_1 + - protocol: direct + route_map: ospf102-direct-connect + vrfs: + - vrf: zone1 + router_id: 198.51.100.129 + redistribute: + - protocol: static + route_map: zone1-static-connect + summary_address: + - prefix: 198.51.100.128/27 + tag: 121 + - prefix: 198.51.100.160/27 + areas: + - area_id: 0.0.0.102 + nssa: + default_information_originate: true + no_summary: true + - area_id: 0.0.0.103 + nssa: + no_summary: true + translate: + type7: + always: true + - vrf: zone2 + auto_cost: + reference_bandwidth: 45 + unit: Gbps + state: rendered + + + # Task output: + # ------------ + # rendered: + # - router ospf 100 + # - router-id 203.0.113.20 + # - router ospf 102 + # - router-id 198.51.100.1 + # - redistribute eigrp 120 route-map rmap_1 + # - redistribute direct route-map ospf102-direct-connect + # - area 0.0.0.100 filter-list route-map rmap_1 in + # - area 0.0.0.100 filter-list route-map rmap_2 out + # - area 0.0.0.100 range 198.51.100.64/27 not-advertise + # - area 0.0.0.100 range 198.51.100.96/27 cost 120 + # - area 0.0.0.101 authentication message-digest + # - vrf zone1 + # - router-id 198.51.100.129 + # - summary-address 198.51.100.128/27 tag 121 + # - summary-address 198.51.100.160/27 + # - redistribute static route-map zone1-static-connect + # - area 0.0.0.102 nssa no-summary default-information-originate + # - area 0.0.0.103 nssa no-summary + # - area 0.0.0.103 nssa translate type7 always + # - vrf zone2 + # - auto-cost reference-bandwidth 45 Gbps + + # Using parsed + + # parsed.cfg + # ------------ + # router ospf 100 + # router-id 192.0.100.1 + # area 0.0.0.101 nssa no-summary no-redistribution + # area 0.0.0.102 stub no-summary + # redistribute direct route-map ospf-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 192.0.2.0/24 not-advertise + # area 0.0.0.100 range 192.0.3.0/24 cost 120 + # area 0.0.0.100 authentication message-digest + # vrf zone1 + # router-id 192.0.100.2 + # area 0.0.100.1 nssa no-summary no-redistribution + # redistribute static route-map zone1-direct-connect + # summary-address 10.0.0.0/24 tag 120 + # summary-address 11.0.0.0/24 not-advertise + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + # down-bit-ignore + # capability vrf-lite evpn + # shutdown + # router ospf 102 + # router-id 198.54.100.1 + # shutdown + # vrf zone2 + # summary-address 192.0.8.0/24 tag 120 + # vrf zone4 + # shutdown + + - name: Parse externally provided OSPFv2 config + cisco.nxos.nxos_ospfv2: + running_config: "{{ lookup('file', 'ospfv2.cfg') }}" + state: parsed + + # Task output: + # ------------ + # parsed: + # processes: + # - process_id: "100" + # areas: + # - area_id: 0.0.0.101 + # nssa: + # no_redistribution: true + # no_summary: true + # - area_id: 0.0.0.102 + # stub: + # no_summary: true + # - area_id: 0.0.0.100 + # authentication: + # message_digest: true + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 192.0.2.0/24 + # - cost: 120 + # prefix: 192.0.3.0/24 + # redistribute: + # - protocol: direct + # route_map: ospf-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 192.0.100.1 + # vrfs: + # - vrf: zone1 + # areas: + # - area_id: 0.0.100.1 + # nssa: + # no_redistribution: true + # no_summary: true + # redistribute: + # - protocol: static + # route_map: zone1-direct-connect + # router_id: 192.0.100.2 + # summary_address: + # - prefix: 10.0.0.0/24 + # tag: 120 + # - not_advertise: true + # prefix: 11.0.0.0/24 + # - vrf: zone2 + # auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # capability: + # vrf_lite: + # evpn: true + # down_bit_ignore: true + # shutdown: true + # - process_id: "102" + # router_id: 198.54.100.1 + # shutdown: true + # vrfs: + # - vrf: zone2 + # summary_address: + # - prefix: 192.0.8.0/24 + # tag: 120 + # - vrf: zone4 + # shutdown: true + + # Using gathered + + - name: Gather OSPFv2 facts using gathered + cisco.nxos.nxos_ospfv2: + state: gathered + + # Task output: + # ------------ + # gathered: + # processes: + # - process_id: "102" + # areas: + # - area_id: 0.0.0.101 + # stub: + # no_summary: true + # - area_id: 0.0.0.100 + # filter_list: + # - direction: in + # route_map: rmap_8 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "130" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - vrf: zone1 + # areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # redistribute: + # - id: "65563" + # protocol: bgp + # route_map: zone1-bgp-connect + # router_id: 198.51.100.129 + # + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['router ospf 102', 'router-id 198.54.100.1', 'router ospf 100', 'router-id 192.0.100.1', 'redistribute eigrp 120 route-map rmap_1', 'redistribute direct route-map ospf-direct-connect', 'area 0.0.0.100 filter-list route-map rmap_1 in', 'area 0.0.0.100 filter-list route-map rmap_2 out', 'area 0.0.0.100 range 192.0.2.0/24 not-advertise', 'area 0.0.0.100 range 192.0.3.0/24 cost 120', 'vrf zone1', 'router-id 192.0.100.2', 'summary-address 10.0.0.0/24 tag 121', 'summary-address 11.0.0.0/24', 'redistribute static route-map zone1-direct-connect', 'vrf zone2', 'auto-cost reference-bandwidth 45 Gbps', 'capability vrf-lite evpn']
+
+
+ gathered + +
+ dictionary +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ dictionary +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['router ospf 102', 'router-id 198.54.100.1', 'router ospf 100']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_overlay_global_module.rst b/docs/cisco.nxos.nxos_overlay_global_module.rst new file mode 100644 index 000000000..1a1b8d975 --- /dev/null +++ b/docs/cisco.nxos.nxos_overlay_global_module.rst @@ -0,0 +1,120 @@ +.. _cisco.nxos.nxos_overlay_global_module: + + +****************************** +cisco.nxos.nxos_overlay_global +****************************** + +**Configures anycast gateway MAC of the switch.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Configures anycast gateway MAC of the switch. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ anycast_gateway_mac + +
+ string + / required +
+ 		+ +
Anycast gateway mac of the switch.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Default restores params default value + - Supported MAC address format are "E.E.E", "EE-EE-EE-EE-EE-EE", "EE:EE:EE:EE:EE:EE" and "EEEE.EEEE.EEEE" + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_overlay_global: + anycast_gateway_mac: b.b.b + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['fabric forwarding anycast-gateway-mac 000B.000B.000B']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_pim_module.rst b/docs/cisco.nxos.nxos_pim_module.rst new file mode 100644 index 000000000..e19eee567 --- /dev/null +++ b/docs/cisco.nxos.nxos_pim_module.rst @@ -0,0 +1,148 @@ +.. _cisco.nxos.nxos_pim_module: + + +******************* +cisco.nxos.nxos_pim +******************* + +**Manages configuration of a PIM instance.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages configuration of a Protocol Independent Multicast (PIM) instance. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ bfd + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enables BFD on all PIM interfaces.
+
Dependency: ''feature bfd''
+
+
+ ssm_range + +
+ list + / elements=string +
+ 		+ Default:
[]
+ 		+
Configure group ranges for Source Specific Multicast (SSM). Valid values are multicast addresses or the keyword none or keyword default. none removes all SSM group ranges. 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 default, otherwise use the default option.
+
+
+ + +Notes +----- + +.. note:: + - Unsupported for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - 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 Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['ip pim bfd', 'ip pim ssm range 224.0.0.0/8']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_ping_module.rst b/docs/cisco.nxos.nxos_ping_module.rst new file mode 100644 index 000000000..d0d805868 --- /dev/null +++ b/docs/cisco.nxos.nxos_ping_module.rst @@ -0,0 +1,311 @@ +.. _cisco.nxos.nxos_ping_module: + + +******************** +cisco.nxos.nxos_ping +******************** + +**Tests reachability using ping from Nexus switch.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Tests reachability using ping from switch to a remote destination. +- For a general purpose network module, see the :ref:`ansible.netcommon.net_ping ` module. +- For Windows targets, use the :ref:`ansible.windows.win_ping ` module instead. +- For targets running Python, use the :ref:`ansible.builtin.ping ` module instead. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ count + +
+ integer +
+ 		+ Default:
5
+ 		+
Number of packets to send.
+
+
+ dest + +
+ string + / required +
+ 		+ +
IP address or hostname (resolvable by switch) of remote node.
+
+
+ df_bit + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Set the DF bit.
+
+
+ size + +
+ integer +
+ 		+ +
Size of packets to send.
+
+
+ source + +
+ string +
+ 		+ +
Source IP Address or hostname (resolvable by switch)
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • absent
    • +
  • present ←
    • +
+ 		+
Determines if the expected result is success or fail.
+
+
+ vrf + +
+ string +
+ 		+ +
Outgoing VRF.
+
+
+ + +Notes +----- + +.. note:: + - Unsupported for Cisco MDS + - For a general purpose network module, see the :ref:`ansible.netcommon.net_ping ` module. + - For Windows targets, use the :ref:`ansible.windows.win_ping ` module instead. + - For targets running Python, use the :ref:`ansible.builtin.ping ` module instead. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Test reachability to 8.8.8.8 using mgmt vrf + cisco.nxos.nxos_ping: + dest: 8.8.8.8 + vrf: management + host: 68.170.147.165 + + - name: Test reachability to a few different public IPs using mgmt vrf + cisco.nxos.nxos_ping: + dest: "{{ item }}" + vrf: management + host: 68.170.147.165 + with_items: + - 8.8.8.8 + - 4.4.4.4 + - 198.6.1.4 + + - name: Test reachability to 8.8.8.8 using mgmt vrf, size and df-bit + cisco.nxos.nxos_ping: + dest: 8.8.8.8 + df_bit: true + size: 1400 + vrf: management + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
Show the command sent
+
+
Sample:
+
['ping 8.8.8.8 count 2 vrf management']
+
+
+ packet_loss + +
+ string +
+ 		always +
Percentage of packets lost
+
+
Sample:
+
0.00%
+
+
+ packets_rx + +
+ integer +
+ 		always +
Packets successfully received
+
+
Sample:
+
2
+
+
+ packets_tx + +
+ integer +
+ 		always +
Packets successfully transmitted
+
+
Sample:
+
2
+
+
+ rtt + +
+ dictionary +
+ 		always +
Show RTT stats
+
+
Sample:
+
{'avg': 6.264, 'max': 6.564, 'min': 5.978}
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_prefix_lists_module.rst b/docs/cisco.nxos.nxos_prefix_lists_module.rst new file mode 100644 index 000000000..25f343132 --- /dev/null +++ b/docs/cisco.nxos.nxos_prefix_lists_module.rst @@ -0,0 +1,1049 @@ +.. _cisco.nxos.nxos_prefix_lists_module: + + +**************************** +cisco.nxos.nxos_prefix_lists +**************************** + +**Prefix-Lists resource module.** + + +Version added: 2.4.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages prefix-lists configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of prefix-list configuration.
+
+
+ afi + +
+ string +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
The Address Family Identifier (AFI) for the prefix-lists.
+
+
+ prefix_lists + +
+ list + / elements=dictionary +
+ 		+ +
List of prefix-list configurations.
+
+
+ description + +
+ string +
+ 		+ +
Description of the prefix list
+
+
+ entries + +
+ list + / elements=dictionary +
+ 		+ +
List of configurations for the specified prefix-list
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • permit
    • +
  • deny
    • +
+ 		+
Prefix-List permit or deny.
+
+
+ eq + +
+ integer +
+ 		+ +
Exact prefix length to be matched.
+
+
+ ge + +
+ integer +
+ 		+ +
Minimum prefix length to be matched.
+
+
+ le + +
+ integer +
+ 		+ +
Maximum prefix length to be matched.
+
+
+ mask + +
+ string +
+ 		+ +
Explicit match mask.
+
+
+ prefix + +
+ string +
+ 		+ +
IP or IPv6 prefix in A.B.C.D/LEN or A:B::C:D/LEN format.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence Number.
+
+
+ name + +
+ string +
+ 		+ +
Name of the prefix-list.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^ip(.* prefix-list').
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
Refer to examples for more details.
+
With state replaced, for the listed prefix-lists, sequences that are in running-config but not in the task are negated.
+
With state overridden, all prefix-lists that are in running-config but not in the task are negated.
+
Please refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # nxos-9k-rdo# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_prefix_lists: + config: + - afi: ipv4 + prefix_lists: + - name: AllowPrefix + description: allows engineering IPv4 networks + entries: + - sequence: 10 + action: permit + prefix: 192.0.2.0/23 + eq: 24 + - sequence: 20 + action: permit + prefix: 198.51.100.128/26 + - name: DenyPrefix + description: denies lab IPv4 networks + entries: + - sequence: 20 + action: deny + prefix: 203.0.113.0/24 + le: 25 + + - afi: ipv6 + prefix_lists: + - name: AllowIPv6Prefix + description: allows engineering IPv6 networks + entries: + - sequence: 8 + action: permit + prefix: "2001:db8:400::/38" + - sequence: 20 + action: permit + prefix: "2001:db8:8000::/35" + le: 37 + + # Task output + # ------------- + # before: [] + # + # commands: + # - "ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks" + # - "ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38" + # - "ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37" + # - "ip prefix-list AllowPrefix description allows engineering IPv4 networks" + # - "ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" + # - "ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" + # - "ip prefix-list DenyPrefix description denies lab IPv4 networks" + # - "ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25" + # + # after: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + # Using replaced + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Replace prefix-lists configurations of listed prefix-lists with provided configurations + cisco.nxos.nxos_prefix_lists: + config: + - afi: ipv4 + prefix_lists: + - name: AllowPrefix + description: allows engineering IPv4 networks + entries: + - sequence: 10 + action: permit + prefix: 203.0.113.64/27 + + - sequence: 30 + action: permit + prefix: 203.0.113.96/27 + - name: AllowPrefix2Stub + description: allow other engineering IPv4 network + state: replaced + + # Task output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # commands: + # - "no ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" + # - "ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27" + # - "ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27" + # - "no ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" + # - "ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network" + # + # after: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 203.0.113.64/27 + # - sequence: 30 + # action: permit + # prefix: 203.0.113.96/27 + # name: AllowPrefix + # - description: allow other engineering IPv4 network + # name: AllowPrefix2Stub + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27 + # ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27 + # ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + # Using overridden + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Override all prefix-lists configuration with provided configuration + cisco.nxos.nxos_prefix_lists: &id003 + config: + - afi: ipv4 + prefix_lists: + - name: AllowPrefix + description: allows engineering IPv4 networks + entries: + - sequence: 10 + action: permit + prefix: 203.0.113.64/27 + + - sequence: 30 + action: permit + prefix: 203.0.113.96/27 + - name: AllowPrefix2Stub + description: allow other engineering IPv4 network + state: overridden + + # Task output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # commands: + # - "no ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" + # - "ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27" + # - "ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27" + # - "no ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" + # - "ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network" + # - "no ip prefix-list DenyPrefix" + # - "no ipv6 prefix-list AllowIPv6Prefix" + # + # after: + # - afi: ipv4 + # prefix_lists: + # - name: AllowPrefix + # description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 203.0.113.64/27 + # + # - sequence: 30 + # action: permit + # prefix: 203.0.113.96/27 + # - name: AllowPrefix2Stub + # description: allow other engineering IPv4 network + # + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27 + # ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27 + # ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network + + # Using deleted to delete a all prefix lists for an AFI + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Delete all prefix-lists for an AFI + cisco.nxos.nxos_prefix_lists: + config: + - afi: ipv4 + state: deleted + register: result + + # Task output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # commands: + # - "no ip prefix-list AllowPrefix" + # - "no ip prefix-list DenyPrefix" + # + # after: + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + # Using deleted to delete a single prefix-list + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Delete a single prefix-list + cisco.nxos.nxos_prefix_lists: + config: + - afi: ipv4 + prefix_lists: + - name: AllowPrefix + state: deleted + + # Task output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # commands: + # - "no ip prefix-list AllowPrefix" + # + # after: + # - afi: ipv4 + # prefix_lists: + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + # Using deleted to delete all prefix-lists from the device + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Delete all prefix-lists + cisco.nxos.nxos_prefix_lists: + state: deleted + + # Task output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # commands: + # - "no ip prefix-list AllowPrefix" + # - "no ip prefix-list DenyPrefix" + # - "no ipv6 prefix-list AllowIPv6Prefix" + # + # after: [] + # + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # nxos-9k-rdo# + + # Using rendered + + - name: Render platform specific configuration lines with state rendered (without connecting to the device) + cisco.nxos.nxos_prefix_lists: &id001 + config: + - afi: ipv4 + prefix_lists: + - name: AllowPrefix + description: allows engineering IPv4 networks + entries: + - sequence: 10 + action: permit + prefix: 192.0.2.0/23 + eq: 24 + - sequence: 20 + action: permit + prefix: 198.51.100.128/26 + - name: DenyPrefix + description: denies lab IPv4 networks + entries: + - sequence: 20 + action: deny + prefix: 203.0.113.0/24 + le: 25 + + - afi: ipv6 + prefix_lists: + - name: AllowIPv6Prefix + description: allows engineering IPv6 networks + entries: + - sequence: 8 + action: permit + prefix: "2001:db8:400::/38" + - sequence: 20 + action: permit + prefix: "2001:db8:8000::/35" + le: 37 + state: rendered + + # Task Output (redacted) + # ----------------------- + # rendered: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + + # Using parsed + + # parsed.cfg + # ------------ + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Parse externally provided prefix-lists configuration + register: result + cisco.nxos.nxos_prefix_lists: + running_config: "{{ lookup('file', './parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + + + + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_reboot_module.rst b/docs/cisco.nxos.nxos_reboot_module.rst new file mode 100644 index 000000000..cc94a6762 --- /dev/null +++ b/docs/cisco.nxos.nxos_reboot_module.rst @@ -0,0 +1,123 @@ +.. _cisco.nxos.nxos_reboot_module: + + +********************** +cisco.nxos.nxos_reboot +********************** + +**Reboot a network device.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Reboot a network device. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ confirm + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Safeguard boolean. Set to true if you're sure you want to reboot.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Tested against Cisco MDS NX-OS 9.2(1) + - The module will fail due to timeout issues, but the reboot will be performed anyway. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_reboot: + confirm: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ rebooted + +
+ boolean +
+ 		success +
Whether the device was instructed to reboot.
+
+
Sample:
+
True
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_rollback_module.rst b/docs/cisco.nxos.nxos_rollback_module.rst new file mode 100644 index 000000000..c948e093a --- /dev/null +++ b/docs/cisco.nxos.nxos_rollback_module.rst @@ -0,0 +1,159 @@ +.. _cisco.nxos.nxos_rollback_module: + + +************************ +cisco.nxos.nxos_rollback +************************ + +**Set a checkpoint or rollback to a checkpoint.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module offers the ability to set a configuration checkpoint file or rollback to a configuration checkpoint file on Cisco NXOS switches. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ checkpoint_file + +
+ string +
+ 		+ +
Name of checkpoint file to create. Mutually exclusive with rollback_to.
+
+
+ rollback_to + +
+ string +
+ 		+ +
Name of checkpoint file to rollback to. Mutually exclusive with checkpoint_file.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Sometimes ``transport=nxapi`` may cause a timeout error. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_rollback: + checkpoint_file: backup.cfg + username: '{{ un }}' + password: '{{ pwd }}' + host: '{{ inventory_hostname }}' + - cisco.nxos.nxos_rollback: + rollback_to: backup.cfg + username: '{{ un }}' + password: '{{ pwd }}' + host: '{{ inventory_hostname }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ filename + +
+ string +
+ 		success +
The filename of the checkpoint/rollback file.
+
+
Sample:
+
backup.cfg
+
+
+ status + +
+ string +
+ 		success +
Which operation took place and whether it was successful.
+
+
Sample:
+
rollback executed
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_route_maps_module.rst b/docs/cisco.nxos.nxos_route_maps_module.rst new file mode 100644 index 000000000..bcdf6a426 --- /dev/null +++ b/docs/cisco.nxos.nxos_route_maps_module.rst @@ -0,0 +1,4368 @@ +.. _cisco.nxos.nxos_route_maps_module: + + +************************** +cisco.nxos.nxos_route_maps +************************** + +**Route Maps resource module.** + + +Version added: 2.2.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages route maps configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of route-map configuration.
+
+
+ entries + +
+ list + / elements=dictionary +
+ 		+ +
List of entries (identified by sequence number) for this route-map.
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • deny
    • +
  • permit
    • +
+ 		+
Route map denies or permits set operations.
+
+
+ continue_sequence + +
+ integer +
+ 		+ +
Continue on a different entry within the route-map.
+
+
+ description + +
+ string +
+ 		+ +
Description of the route-map.
+
+
+ match + +
+ dictionary +
+ 		+ +
Match values from routing table.
+
+
+ as_number + +
+ dictionary +
+ 		+ +
Match BGP peer AS number.
+
+
+ as_path_list + +
+ list + / elements=string +
+ 		+ +
AS path access list name.
+
+
+ asn + +
+ list + / elements=string +
+ 		+ +
AS number.
+
+
+ as_path + +
+ list + / elements=string +
+ 		+ +
Match BGP AS path access-list.
+
+
+ community + +
+ dictionary +
+ 		+ +
Match BGP community list.
+
+
+ community_list + +
+ list + / elements=string +
+ 		+ +
Community list.
+
+
+ exact_match + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do exact matching of communities.
+
+
+ evpn + +
+ dictionary +
+ 		+ +
Match BGP EVPN Routes.
+
+
+ route_types + +
+ list + / elements=string +
+ 		+ +
Match route type for evpn route.
+
+
+ extcommunity + +
+ dictionary +
+ 		+ +
Match BGP community list.
+
+
+ exact_match + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do exact matching of extended communities.
+
+
+ extcommunity_list + +
+ list + / elements=string +
+ 		+ +
Extended Community list.
+
+
+ interfaces + +
+ list + / elements=string +
+ 		+ +
Match first hop interface of route.
+
+
+ ip + +
+ dictionary +
+ 		+ +
Configure IP specific information.
+
+
+ address + +
+ dictionary +
+ 		+ +
Match address of route or match packet.
+
+
+ access_list + +
+ string +
+ 		+ +
IP access-list name (for use in route-maps for PBR only).
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ multicast + +
+ dictionary +
+ 		+ +
Match multicast attributes.
+
+
+ group + +
+ dictionary +
+ 		+ +
Multicast Group prefix.
+
Mutually exclusive with group_range.
+
+
+ prefix + +
+ string +
+ 		+ +
IPv4 group prefix.
+
+
+ group_range + +
+ dictionary +
+ 		+ +
Multicast Group address range.
+
Mutually exclusive with group.
+
+
+ first + +
+ string +
+ 		+ +
First Group address.
+
+
+ last + +
+ string +
+ 		+ +
Last Group address.
+
+
+ rp + +
+ dictionary +
+ 		+ +
Rendezvous point.
+
+
+ prefix + +
+ string +
+ 		+ +
IPv4 rendezvous prefix.
+
+
+ rp_type + +
+ string +
+ 		+
    Choices: +
  • ASM
    • +
  • Bidir
    • +
+ 		+
Multicast rendezvous point type.
+
+
+ source + +
+ string +
+ 		+ +
Multicast source address.
+
+
+ next_hop + +
+ dictionary +
+ 		+ +
Match next-hop address of route.
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ route_source + +
+ dictionary +
+ 		+ +
Match advertising source address of route.
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ ipv6 + +
+ dictionary +
+ 		+ +
Configure IPv6 specific information.
+
+
+ address + +
+ dictionary +
+ 		+ +
Match address of route or match packet.
+
+
+ access_list + +
+ string +
+ 		+ +
IP access-list name (for use in route-maps for PBR only).
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ multicast + +
+ dictionary +
+ 		+ +
Match multicast attributes.
+
+
+ group + +
+ dictionary +
+ 		+ +
Multicast Group prefix.
+
Mutually exclusive with group_range.
+
+
+ prefix + +
+ string +
+ 		+ +
IPv4 group prefix.
+
+
+ group_range + +
+ dictionary +
+ 		+ +
Multicast Group address range.
+
Mutually exclusive with group.
+
+
+ first + +
+ string +
+ 		+ +
First Group address.
+
+
+ last + +
+ string +
+ 		+ +
Last Group address.
+
+
+ rp + +
+ dictionary +
+ 		+ +
Rendezvous point.
+
+
+ prefix + +
+ string +
+ 		+ +
IPv4 rendezvous prefix.
+
+
+ rp_type + +
+ string +
+ 		+
    Choices: +
  • ASM
    • +
  • Bidir
    • +
+ 		+
Multicast rendezvous point type.
+
+
+ source + +
+ string +
+ 		+ +
Multicast source address.
+
+
+ next_hop + +
+ dictionary +
+ 		+ +
Match next-hop address of route.
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ route_source + +
+ dictionary +
+ 		+ +
Match advertising source address of route.
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ mac_list + +
+ list + / elements=string +
+ 		+ +
Match entries of mac-lists.
+
+
+ metric + +
+ list + / elements=integer +
+ 		+ +
Match metric of route.
+
+
+ ospf_area + +
+ list + / elements=integer +
+ 		+ +
Match ospf area.
+
+
+ route_types + +
+ list + / elements=string +
+ 		+
    Choices: +
  • external
    • +
  • inter-area
    • +
  • internal
    • +
  • intra-area
    • +
  • level-1
    • +
  • level-2
    • +
  • local
    • +
  • nssa-external
    • +
  • type-1
    • +
  • type-2
    • +
+ 		+
Match route-type of route.
+
+
+ source_protocol + +
+ list + / elements=string +
+ 		+ +
Match source protocol.
+
+
+ tags + +
+ list + / elements=integer +
+ 		+ +
Match tag of route.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence to insert to/delete from existing route-map entry.
+
+
+ set + +
+ dictionary +
+ 		+ +
Set values in destination routing protocol.
+
+
+ as_path + +
+ dictionary +
+ 		+ +
Prepend string for a BGP AS-path attribute.
+
+
+ prepend + +
+ dictionary +
+ 		+ +
Prepend to the AS-Path.
+
+
+ as_number + +
+ list + / elements=string +
+ 		+ +
AS number.
+
+
+ last_as + +
+ integer +
+ 		+ +
Number of last-AS prepends.
+
+
+ tag + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set the tag as an AS-path attribute.
+
+
+ comm_list + +
+ string +
+ 		+ +
Set BGP community list (for deletion).
+
+
+ community + +
+ dictionary +
+ 		+ +
Set BGP community attribute.
+
+
+ additive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Add to existing community.
+
+
+ graceful_shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Graceful Shutdown (well-known community).
+
+
+ internet + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Internet (well-known community).
+
+
+ local_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send outside local AS (well-known community).
+
+
+ no_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not advertise to any peer (well-known community).
+
+
+ no_export + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not export to next AS (well-known community).
+
+
+ number + +
+ list + / elements=string +
+ 		+ +
Community number aa:nn format
+
+
+ dampening + +
+ dictionary +
+ 		+ +
Set BGP route flap dampening parameters.
+
+
+ half_life + +
+ integer +
+ 		+ +
Half-life time for the penalty.
+
+
+ max_suppress_time + +
+ integer +
+ 		+ +
Maximum suppress time for stable route.
+
+
+ start_reuse_route + +
+ integer +
+ 		+ +
Value to start reusing a route.
+
+
+ start_suppress_route + +
+ integer +
+ 		+ +
Value to start suppressing a route.
+
+
+ distance + +
+ dictionary +
+ 		+ +
Configure administrative distance.
+
+
+ igp_ebgp_routes + +
+ integer +
+ 		+ +
Administrative distance for IGP or EBGP routes
+
+
+ internal_routes + +
+ integer +
+ 		+ +
Distance for internal routes.
+
+
+ local_routes + +
+ integer +
+ 		+ +
Distance for local routes.
+
+
+ evpn + +
+ dictionary +
+ 		+ +
Set BGP EVPN Routes.
+
+
+ gateway_ip + +
+ dictionary +
+ 		+ +
Set gateway IP for type 5 EVPN routes.
+
Cannot set ip and use-nexthop in the same route-map sequence.
+
+
+ ip + +
+ string +
+ 		+ +
Gateway IP address.
+
+
+ use_nexthop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use nexthop address as gateway IP.
+
+
+ extcomm_list + +
+ string +
+ 		+ +
Set BGP extcommunity list (for deletion).
+
+
+ extcommunity + +
+ dictionary +
+ 		+ +
Set BGP extcommunity attribute.
+
+
+ rt + +
+ dictionary +
+ 		+ +
Route-Target.
+
+
+ additive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Add to existing rt extcommunity.
+
+
+ extcommunity_numbers + +
+ list + / elements=string +
+ 		+ +
Extcommunity number.
+
Supported formats are ASN2:NN, ASN4:NN, IPV4:NN.
+
+
+ forwarding_address + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set the forwarding address.
+
+
+ ip + +
+ dictionary +
+ 		+ +
Configure IP features.
+
+
+ address + +
+ dictionary +
+ 		+ +
Specify IP address.
+
+
+ prefix_list + +
+ string +
+ 		+ +
Name of prefix list (Max Size 63).
+
+
+ next_hop + +
+ dictionary +
+ 		+ +
Set next-hop IP address (for policy-based routing)
+
+
+ address + +
+ string +
+ 		+ +
Set space-separated list of next-hop IP addresses. Address ordering is important. Also don`t use unnecessary spaces.
+
+
+ drop_on_fail + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Drop packets instead of using default routing when the configured next hop becomes unreachable
+
+
+ force_order + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Enable next-hop ordering as specified in the address parameter.
+
+
+ load_share + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Enable traffic load balancing across a maximum of 32 next-hop addresses
+
+
+ peer_address + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
BGP prefix next hop is set to the local address of the peer.
+
If no next hop is set in the route map, the next hop is set to the one stored in the path.
+
+
+ redist_unchanged + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set for next-hop address conservation for non-local generated routes.
+
Used with redistribute command. Available to maintain BGP routing compliant with RFC 4271 on Nexus OS.
+
+
+ unchanged + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set for next-hop address conservation in eBGP outgoing updates
+
+
+ verify_availability + +
+ list + / elements=dictionary +
+ 		+ +
Set next-hop ip address tracking with IP SLA
+
+
+ address + +
+ string + / required +
+ 		+ +
Set one next-hop address
+
+
+ drop_on_fail + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Drop packets instead of using default routing when the configured next hop becomes unreachable
+
+
+ force_order + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Enable next-hop ordering as specified in the address parameter.
+
+
+ load_share + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Enable traffic load balancing across a maximum of 32 next-hop addresses
+
+
+ track + +
+ integer + / required +
+ 		+ +
Set track number
+
+
+ precedence + +
+ string +
+ 		+ +
Set precedence field.
+
+
+ ipv6 + +
+ dictionary +
+ 		+ +
Configure IPv6 features.
+
+
+ address + +
+ dictionary +
+ 		+ +
Specify IP address.
+
+
+ prefix_list + +
+ string +
+ 		+ +
Name of prefix list (Max Size 63).
+
+
+ precedence + +
+ string +
+ 		+ +
Set precedence field.
+
+
+ label_index + +
+ integer +
+ 		+ +
Set Segment Routing (SR) label index of route.
+
+
+ level + +
+ string +
+ 		+
    Choices: +
  • level-1
    • +
  • level-1-2
    • +
  • level-2
    • +
+ 		+
Where to import route.
+
+
+ local_preference + +
+ integer +
+ 		+ +
BGP local preference path attribute.
+
+
+ metric + +
+ dictionary +
+ 		+ +
Set metric for destination routing protocol.
+
+
+ bandwidth + +
+ integer +
+ 		+ +
Metric value or Bandwidth in Kbits per second (Max Size 11).
+
+
+ igrp_delay_metric + +
+ integer +
+ 		+ +
IGRP delay metric.
+
+
+ igrp_effective_bandwidth_metric + +
+ integer +
+ 		+ +
IGRP Effective bandwidth metric (Loading) 255 is 100%.
+
+
+ igrp_mtu + +
+ integer +
+ 		+ +
IGRP MTU of the path.
+
+
+ igrp_reliability_metric + +
+ integer +
+ 		+ +
IGRP reliability metric where 255 is 100 percent reliable.
+
+
+ metric_type + +
+ string +
+ 		+
    Choices: +
  • external
    • +
  • internal
    • +
  • type-1
    • +
  • type-2
    • +
+ 		+
Type of metric for destination routing protocol.
+
+
+ nssa_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
OSPF NSSA Areas.
+
+
+ null_interface + +
+ string +
+ 		+ +
Output Null interface.
+
+
+ origin + +
+ string +
+ 		+
    Choices: +
  • egp
    • +
  • igp
    • +
  • incomplete
    • +
+ 		+
BGP origin code.
+
+
+ path_selection + +
+ string +
+ 		+
    Choices: +
  • all
    • +
  • backup
    • +
  • best2
    • +
  • multipaths
    • +
+ 		+
Path selection criteria for BGP.
+
+
+ tag + +
+ integer +
+ 		+ +
Tag value for destination routing protocol.
+
+
+ weight + +
+ integer +
+ 		+ +
BGP weight for routing table.
+
+
+ route_map + +
+ string +
+ 		+ +
Route-map name.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^route-map'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
With state replaced, for the listed route-maps, sequences that are in running-config but not in the task are negated.
+
With state overridden, all route-maps that are in running-config but not in the task are negated.
+
Please refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k-rdo# show running-config | section "^route-map" + # nxos-9k-rdo# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_route_maps: + config: + - route_map: rmap1 + entries: + - sequence: 10 + action: permit + description: rmap1-10-permit + match: + ip: + address: + access_list: acl_1 + as_path: Allow40 + as_number: + asn: 65564 + + - sequence: 20 + action: deny + description: rmap1-20-deny + match: + community: + community_list: + - BGPCommunity1 + - BGPCommunity2 + ip: + address: + prefix_lists: + - AllowPrefix1 + - AllowPrefix2 + set: + dampening: + half_life: 30 + start_reuse_route: 1500 + start_suppress_route: 10000 + max_suppress_time: 120 + + - route_map: rmap2 + entries: + - sequence: 20 + action: permit + description: rmap2-20-permit + continue_sequence: 40 + match: + ipv6: + address: + prefix_lists: AllowIPv6Prefix + interfaces: "{{ nxos_int1 }}" + set: + as_path: + prepend: + as_number: + - 65563 + - 65568 + - 65569 + comm_list: BGPCommunity + + - sequence: 40 + action: deny + description: rmap2-40-deny + match: + route_types: + - level-1 + - level-2 + tags: 2 + ip: + multicast: + rp: + prefix: 192.0.2.0/24 + rp_type: ASM + source: 203.0.113.0/24 + group_range: + first: 239.0.0.1 + last: 239.255.255.255 + + - route_map: rmap3 + entries: + - sequence: 10 + description: "*** first stanza ***" + action: permit + set: + ip: + next_hop: + verify_availability: + - address: 3.3.3.3 + track: 1 + - address: 4.4.4.4 + track: 3 + + - sequence: 20 + description: "*** second stanza ***" + action: permit + set: + ip: + next_hop: + address: 6.6.6.6 2.2.2.2 + load_share: true + drop_on_fail: true + + - sequence: 30 + description: "*** third stanza ***" + action: permit + set: + ip: + next_hop: + peer_address: true + + - sequence: 40 + description: "*** fourth stanza ***" + action: permit + set: + ip: + next_hop: + unchanged: true + redist_unchanged: true + state: merged + + # Task output + # ------------- + # before: [] + # + # commands: + # - "route-map rmap1 permit 10" + # - "match as-number 65564" + # - "match as-path Allow40" + # - "match ip address acl_1" + # - "description rmap1-10-permit" + # - "route-map rmap1 deny 20" + # - "match community BGPCommunity1 BGPCommunity2" + # - "match ip address prefix-list AllowPrefix1 AllowPrefix2" + # - "description rmap1-20-deny" + # - "set dampening 30 1500 10000 120" + # - "route-map rmap2 permit 20" + # - "match interface Ethernet1/1" + # - "match ipv6 address prefix-list AllowIPv6Prefix" + # - "set as-path prepend 65563 65568 65569" + # - "description rmap2-20-permit" + # - "continue 40" + # - "set comm-list BGPCommunity delete" + # - "route-map rmap2 deny 40" + # - "match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM" + # - "match route-type level-1 level-2" + # - "match tag 2" + # - "description rmap2-40-deny" + # - "route-map rmap3 permit 10" + # - "description *** first stanza ***" + # - "set ip next-hop verify-availability 3.3.3.3 track 1" + # - "set ip next-hop verify-availability 4.4.4.4 track 3" + # - "route-map rmap3 permit 20" + # - "description *** second stanza ***" + # - "set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail" + # - "route-map rmap3 permit 30" + # - "description *** third stanza ***" + # - "set ip next-hop peer-address" + # - "route-map rmap3 permit 40" + # - "description *** fourth stanza ***" + # - "set ip next-hop unchanged" + # - "set ip next-hop redist-unchanged" + # + # after: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # - route_map: rmap3 + # entries: + # - sequence: 10 + # description: "*** first stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # verify_availability: + # - address: 3.3.3.3 + # track: 1 + # - address: 4.4.4.4 + # track: 3 + # + # - sequence: 20 + # description: "*** second stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # address: 6.6.6.6 2.2.2.2 + # load_share: true + # drop_on_fail: true + # + # - sequence: 30 + # description: "*** third stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # peer_address: true + # + # - sequence: 40 + # description: "*** fourth stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # unchanged: true + # redist_unchanged: true + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + # route-map rmap3 permit 10 + # description *** first stanza *** + # set ip next-hop verify-availability 3.3.3.3 track 1 + # set ip next-hop verify-availability 4.4.4.4 track 3 + # route-map rmap3 permit 20 + # description *** second stanza *** + # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail + # route-map rmap3 permit 30 + # description *** third stanza *** + # set ip next-hop peer-address + # route-map rmap3 permit 40 + # description *** fourth stanza *** + # set ip next-hop unchanged + # set ip next-hop redist-unchanged + # + # Using replaced + # (for the listed route-map(s), sequences that are in running-config but not in the task are negated) + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + # route-map rmap3 permit 10 + # description *** first stanza *** + # set ip next-hop verify-availability 3.3.3.3 track 1 + # set ip next-hop verify-availability 4.4.4.4 track 3 + # route-map rmap3 permit 20 + # description *** second stanza *** + # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail + # route-map rmap3 permit 30 + # description *** third stanza *** + # set ip next-hop peer-address + # route-map rmap3 permit 40 + # description *** fourth stanza *** + # set ip next-hop unchanged + # set ip next-hop redist-unchanged + # + - name: Replace route-maps configurations of listed route-maps with provided configurations + cisco.nxos.nxos_route_maps: + config: + - route_map: rmap1 + entries: + - sequence: 20 + action: deny + description: rmap1-20-deny + match: + community: + community_list: + - BGPCommunity4 + - BGPCommunity5 + ip: + address: + prefix_lists: + - AllowPrefix1 + set: + community: + local_as: true + + - route_map: rmap3 + entries: + - sequence: 10 + description: "*** first stanza ***" + action: permit + set: + ip: + next_hop: + verify_availability: + - address: 3.3.3.3 + track: 1 + - sequence: 20 + description: "*** second stanza ***" + action: permit + set: + ip: + next_hop: + peer_address: true + - sequence: 30 + description: "*** third stanza ***" + action: permit + set: + ip: + next_hop: + address: 6.6.6.6 2.2.2.2 + load_share: true + drop_on_fail: true + state: replaced + + # Task output + # ------------- + # before: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # - route_map: rmap3 + # entries: + # - sequence: 10 + # description: "*** first stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # verify_availability: + # - address: 3.3.3.3 + # track: 1 + # - address: 4.4.4.4 + # track: 3 + # + # - sequence: 20 + # description: "*** second stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # address: 6.6.6.6 2.2.2.2 + # load_share: true + # drop_on_fail: true + # + # - sequence: 30 + # description: "*** third stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # peer_address: true + # + # - sequence: 40 + # description: "*** fourth stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # unchanged: true + # redist_unchanged: true + # + # commands: + # - no route-map rmap1 permit 10 + # - route-map rmap1 deny 20 + # - no match community BGPCommunity1 BGPCommunity2 + # - match community BGPCommunity4 BGPCommunity5 + # - no match ip address prefix-list AllowPrefix1 AllowPrefix2 + # - match ip address prefix-list AllowPrefix1 + # - no set dampening 30 1500 10000 120 + # - set community local-AS + # - route-map rmap3 permit 10 + # - no set ip next-hop verify-availability 4.4.4.4 track 3 + # - route-map rmap3 permit 20 + # - no set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail + # - set ip next-hop peer-address + # - route-map rmap3 permit 30 + # - no set ip next-hop peer-address + # - set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail + # - no route-map rmap3 permit 40 + # + # after: + # - route_map: rmap1 + # entries: + # - sequence: 20 + # action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity4 + # - BGPCommunity5 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # set: + # community: + # local_as: true + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # - route_map: rmap3 + # entries: + # - sequence: 10 + # description: "*** first stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # verify_availability: + # - address: 3.3.3.3 + # track: 1 + # - sequence: 20 + # description: "*** second stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # peer_address: true + # - sequence: 30 + # description: "*** third stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # address: 6.6.6.6 2.2.2.2 + # load_share: true + # drop_on_fail: true + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 deny 20 + # description rmap1-20-deny + # match community BGPCommunity4 BGPCommunity5 + # match ip address prefix-list AllowPrefix1 + # set community local-AS + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + # route-map rmap3 permit 10 + # description *** first stanza *** + # set ip next-hop verify-availability 3.3.3.3 track 1 + # route-map rmap3 permit 20 + # description *** second stanza *** + # set ip next-hop peer-address + # route-map rmap3 permit 30 + # description *** third stanza *** + # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail + + # Using overridden + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + + - name: Override all route-maps configuration with provided configuration + cisco.nxos.nxos_route_maps: + config: + - route_map: rmap1 + entries: + - sequence: 20 + action: deny + description: rmap1-20-deny + match: + community: + community_list: + - BGPCommunity4 + - BGPCommunity5 + ip: + address: + prefix_lists: + - AllowPrefix1 + set: + community: + local_as: true + state: overridden + + # Task output + # ------------- + # before: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # commands: + # - no route-map rmap1 permit 10 + # - route-map rmap1 deny 20 + # - no match community BGPCommunity1 BGPCommunity2 + # - match community BGPCommunity4 BGPCommunity5 + # - no match ip address prefix-list AllowPrefix1 AllowPrefix2 + # - match ip address prefix-list AllowPrefix1 + # - no set dampening 30 1500 10000 120 + # - set community local-AS + # - no route-map rmap2 permit 20 + # - no route-map rmap2 deny 40 + # + # after: + # - route_map: rmap1 + # entries: + # - sequence: 20 + # action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity4 + # - BGPCommunity5 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # set: + # community: + # local_as: true + # + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^route-map" + # route-map rmap1 deny 20 + # description rmap1-20-deny + # match community BGPCommunity4 BGPCommunity5 + # match ip address prefix-list AllowPrefix1 + # set community local-AS + + # Using deleted to delete a single route-map + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + + - name: Delete single route-map + cisco.nxos.nxos_route_maps: + config: + - route_map: rmap1 + state: deleted + + # Task output + # ------------- + # before: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # commands: + # - no route-map rmap1 permit 10 + # - no route-map rmap1 deny 20 + # + # after: + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^route-map" + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + + # Using deleted to delete all route-maps from the device running-config + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + + - name: Delete all route-maps + cisco.nxos.nxos_route_maps: + state: deleted + + # Task output + # ------------- + # before: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # commands: + # - no route-map rmap1 permit 10 + # - no route-map rmap1 deny 20 + # - no route-map rmap2 permit 20 + # - no route-map rmap2 deny 40 + # + # after: [] + # + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^route-map" + + - name: Render platform specific configuration lines with state rendered (without connecting to the device) + cisco.nxos.nxos_route_maps: + config: + - route_map: rmap1 + entries: + - sequence: 10 + action: permit + description: rmap1-10-permit + match: + ip: + address: + access_list: acl_1 + as_path: Allow40 + as_number: + asn: 65564 + + - sequence: 20 + action: deny + description: rmap1-20-deny + match: + community: + community_list: + - BGPCommunity1 + - BGPCommunity2 + ip: + address: + prefix_lists: + - AllowPrefix1 + - AllowPrefix2 + set: + dampening: + half_life: 30 + start_reuse_route: 1500 + start_suppress_route: 10000 + max_suppress_time: 120 + + - route_map: rmap2 + entries: + - sequence: 20 + action: permit + description: rmap2-20-permit + continue_sequence: 40 + match: + ipv6: + address: + prefix_lists: AllowIPv6Prefix + interfaces: "{{ nxos_int1 }}" + set: + as_path: + prepend: + as_number: + - 65563 + - 65568 + - 65569 + comm_list: BGPCommunity + + - sequence: 40 + action: deny + description: rmap2-40-deny + match: + route_types: + - level-1 + - level-2 + tags: 2 + ip: + multicast: + rp: + prefix: 192.0.2.0/24 + rp_type: ASM + source: 203.0.113.0/24 + group_range: + first: 239.0.0.1 + last: 239.255.255.255 + state: rendered + + # Task Output (redacted) + # ----------------------- + # rendered: + # - "route-map rmap1 permit 10" + # - "match as-number 65564" + # - "match as-path Allow40" + # - "match ip address acl_1" + # - "description rmap1-10-permit" + # - "route-map rmap1 deny 20" + # - "match community BGPCommunity1 BGPCommunity2" + # - "match ip address prefix-list AllowPrefix1 AllowPrefix2" + # - "description rmap1-20-deny" + # - "set dampening 30 1500 10000 120" + # - "route-map rmap2 permit 20" + # - "match interface Ethernet1/1" + # - "match ipv6 address prefix-list AllowIPv6Prefix" + # - "set as-path prepend 65563 65568 65569" + # - "description rmap2-20-permit" + # - "continue 40" + # - "set comm-list BGPCommunity delete" + # - "route-map rmap2 deny 40" + # - "match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM" + # - "match route-type level-1 level-2" + # - "match tag 2" + # - "description rmap2-40-deny" + + # Using parsed + + # parsed.cfg + # ------------ + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + + - name: Parse externally provided route-maps configuration + cisco.nxos.nxos_route_maps: + running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + + # Using gathered + + # Existing route-map config + # --------------------------- + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + + - name: Gather route-maps facts using gathered + cisco.nxos.nxos_route_maps: + state: gathered + + # gathered: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['route-map rmap1 permit 10', 'match as-number 65564', 'match as-path Allow40', 'match ip address acl_1', 'description rmap1-10-permit', 'route-map rmap1 deny 20', 'match community BGPCommunity1 BGPCommunity2']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_rpm_module.rst b/docs/cisco.nxos.nxos_rpm_module.rst new file mode 100644 index 000000000..79d616a59 --- /dev/null +++ b/docs/cisco.nxos.nxos_rpm_module.rst @@ -0,0 +1,226 @@ +.. _cisco.nxos.nxos_rpm_module: + + +******************* +cisco.nxos.nxos_rpm +******************* + +**Install patch or feature rpms on Cisco NX-OS devices.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Install software maintenance upgrade (smu) RPMS and 3rd party RPMS on Cisco NX-OS devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ aggregate + +
+ list + / elements=dictionary +
+ 		+ +
List of RPM/patch definitions.
+
+
+ file_system + +
+ string +
+ 		+ +
The remote file system of the device. If omitted, devices that support a file_system parameter will use their default values.
+
+
+ pkg + +
+ string + / required +
+ 		+ +
Name of the RPM package.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
If the state is present, the rpm will be installed, If the state is absent, it will be removed.
+
+
+ file_system + +
+ string +
+ 		+ Default:
"bootflash"
+ 		+
The remote file system of the device. If omitted, devices that support a file_system parameter will use their default values.
+
+
+ pkg + +
+ string +
+ 		+ +
Name of the RPM package.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
If the state is present, the rpm will be installed, If the state is absent, it will be removed.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.0(3)I2(5), 7.0(3)I4(6), 7.0(3)I5(3), 7.0(3)I6(1), 7.0(3)I7(3) + - Unsupported for Cisco MDS + - For patches, the minimum platform version needed is 7.0(3)I2(5) + - For feature rpms, the minimum platform version needed is 7.0(3)I6(1) + - The module manages the entire RPM lifecycle (Add, activate, commit, deactivate, remove) + - For reload patches, this module is NOT idempotent until the patch is committed. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_rpm: + pkg: nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000.rpm + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['install add bootflash:nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000.rpm forced', 'install activate nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000 forced', 'install commit nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Sai Chintalapudi (@saichint) diff --git a/docs/cisco.nxos.nxos_snapshot_module.rst b/docs/cisco.nxos.nxos_snapshot_module.rst new file mode 100644 index 000000000..fe89b5b7b --- /dev/null +++ b/docs/cisco.nxos.nxos_snapshot_module.rst @@ -0,0 +1,363 @@ +.. _cisco.nxos.nxos_snapshot_module: + + +************************ +cisco.nxos.nxos_snapshot +************************ + +**Manage snapshots of the running states of selected features.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Create snapshots of the running states of selected features, add new show commands for snapshot creation, delete and compare existing snapshots. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ action + +
+ string + / required +
+ 		+
    Choices: +
  • add
    • +
  • compare
    • +
  • create
    • +
  • delete
    • +
  • delete_all
    • +
+ 		+
Define what snapshot action the module would perform.
+
+
+ compare_option + +
+ string +
+ 		+
    Choices: +
  • summary
    • +
  • ipv4routes
    • +
  • ipv6routes
    • +
+ 		+
Snapshot options to be used when action=compare.
+
+
+ comparison_results_file + +
+ string +
+ 		+ +
Name of the file where snapshots comparison will be stored when action=compare.
+
+
+ description + +
+ string +
+ 		+ +
Snapshot description to be used when action=create.
+
+
+ element_key1 + +
+ string +
+ 		+ +
Specify the tags used to distinguish among row entries, to be used when action=add.
+
+
+ element_key2 + +
+ string +
+ 		+ +
Specify the tags used to distinguish among row entries, to be used when action=add.
+
+
+ path + +
+ string +
+ 		+ Default:
"./"
+ 		+
Specify the path of the file where new created snapshot or snapshots comparison will be stored, to be used when action=create and save_snapshot_locally=true or action=compare.
+
+
+ row_id + +
+ string +
+ 		+ +
Specifies the tag of each row entry of the show command's XML output, to be used when action=add.
+
+
+ save_snapshot_locally + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Specify to locally store a new created snapshot, to be used when action=create.
+
+
+ section + +
+ string +
+ 		+ +
Used to name the show command output, to be used when action=add.
+
+
+ show_command + +
+ string +
+ 		+ +
Specify a new show command, to be used when action=add.
+
+
+ snapshot1 + +
+ string +
+ 		+ +
First snapshot to be used when action=compare.
+
+
+ snapshot2 + +
+ string +
+ 		+ +
Second snapshot to be used when action=compare.
+
+
+ snapshot_name + +
+ string +
+ 		+ +
Snapshot name, to be used when action=create or action=delete.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - ``transport=cli`` may cause timeout errors. + - The ``element_key1`` and ``element_key2`` parameter specify the tags used to distinguish among row entries. In most cases, only the element_key1 parameter needs to specified to be able to distinguish among row entries. + - ``action=compare`` will always store a comparison report on a local file. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Create a snapshot and store it locally + - cisco.nxos.nxos_snapshot: + action: create + snapshot_name: test_snapshot + description: Done with Ansible + save_snapshot_locally: true + path: /home/user/snapshots/ + + # Delete a snapshot + - cisco.nxos.nxos_snapshot: + action: delete + snapshot_name: test_snapshot + + # Delete all existing snapshots + - cisco.nxos.nxos_snapshot: + action: delete_all + + # Add a show command for snapshots creation + - cisco.nxos.nxos_snapshot: + section: myshow + show_command: show ip interface brief + row_id: ROW_intf + element_key1: intf-name + + # Compare two snapshots + - cisco.nxos.nxos_snapshot: + action: compare + snapshot1: pre_snapshot + snapshot2: post_snapshot + comparison_results_file: compare_snapshots.txt + compare_option: summary + path: ../snapshot_reports/ + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		verbose mode +
commands sent to the device
+
+
Sample:
+
['snapshot create post_snapshot Post-snapshot']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_community_module.rst b/docs/cisco.nxos.nxos_snmp_community_module.rst new file mode 100644 index 000000000..584d2d772 --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_community_module.rst @@ -0,0 +1,201 @@ +.. _cisco.nxos.nxos_snmp_community_module: + + +****************************** +cisco.nxos.nxos_snmp_community +****************************** + +**(deprecated, removed after 2024-01-01) Manages SNMP community configs.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated modules released with more functionality +:Alternative: nxos_snmp_server + + + +Synopsis +-------- +- Manages SNMP community configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ access + +
+ string +
+ 		+
    Choices: +
  • ro
    • +
  • rw
    • +
+ 		+
Access type for community.
+
+
+ acl + +
+ string +
+ 		+ +
ACL name to filter snmp requests or keyword 'default'.
+
+
+ community + +
+ string + / required +
+ 		+ +
Case-sensitive community string.
+
+
+ group + +
+ string +
+ 		+ +
Group to which the community belongs.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure snmp community is configured + - cisco.nxos.nxos_snmp_community: + community: TESTING7 + group: network-operator + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['snmp-server community TESTING7 group network-operator']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_host_module.rst b/docs/cisco.nxos.nxos_snmp_host_module.rst new file mode 100644 index 000000000..8aef0b21d --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_host_module.rst @@ -0,0 +1,288 @@ +.. _cisco.nxos.nxos_snmp_host_module: + + +************************* +cisco.nxos.nxos_snmp_host +************************* + +**(deprecated, removed after 2024-01-01) Manages SNMP host configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated modules released with more functionality +:Alternative: nxos_snmp_server + + + +Synopsis +-------- +- Manages SNMP host configuration parameters. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ community + +
+ string +
+ 		+ +
Community string or v3 username.
+
+
+ snmp_host + +
+ string + / required +
+ 		+ +
IP address of hostname of target host.
+
+
+ snmp_type + +
+ string +
+ 		+
    Choices: +
  • trap
    • +
  • inform
    • +
+ 		+
type of message to send to host. If this is not specified, trap type is used.
+
+
+ src_intf + +
+ string +
+ 		+ +
Source interface. Must be fully qualified interface name. If state = absent, the interface is removed.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource. If state = present, the host is added to the configuration. If only vrf and/or vrf_filter and/or src_intf are given, they will be added to the existing host configuration. If state = absent, the host is removed if community parameter is given. It is possible to remove only vrf and/or src_int and/or vrf_filter by providing only those parameters and no community parameter.
+
+
+ udp + +
+ string +
+ 		+ Default:
"162"
+ 		+
UDP port number (0-65535).
+
+
+ v3 + +
+ string +
+ 		+
    Choices: +
  • noauth
    • +
  • auth
    • +
  • priv
    • +
+ 		+
Use this when verion is v3. SNMPv3 Security level.
+
+
+ version + +
+ string +
+ 		+
    Choices: +
  • v1
    • +
  • v2c
    • +
  • v3
    • +
+ 		+
SNMP version. If this is not specified, v1 is used.
+
+
+ vrf + +
+ string +
+ 		+ +
VRF to use to source traffic to source. If state = absent, the vrf is removed.
+
+
+ vrf_filter + +
+ string +
+ 		+ +
Name of VRF to filter. If state = absent, the vrf is removed from the filter.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - ``state=absent`` removes the host configuration if it is configured. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure snmp host is configured + - cisco.nxos.nxos_snmp_host: + snmp_host: 192.0.2.3 + community: TESTING + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['snmp-server host 192.0.2.3 filter-vrf another_test_vrf']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_location_module.rst b/docs/cisco.nxos.nxos_snmp_location_module.rst new file mode 100644 index 000000000..06f564693 --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_location_module.rst @@ -0,0 +1,156 @@ +.. _cisco.nxos.nxos_snmp_location_module: + + +***************************** +cisco.nxos.nxos_snmp_location +***************************** + +**(deprecated, removed after 2024-01-01) Manages SNMP location information.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated modules released with more functionality +:Alternative: nxos_snmp_server + + + +Synopsis +-------- +- Manages SNMP location configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ location + +
+ string + / required +
+ 		+ +
Location information.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure snmp location is configured + - cisco.nxos.nxos_snmp_location: + location: Test + state: present + + # ensure snmp location is not configured + - cisco.nxos.nxos_snmp_location: + location: Test + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['snmp-server location New_Test']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_server_module.rst b/docs/cisco.nxos.nxos_snmp_server_module.rst new file mode 100644 index 000000000..126e16341 --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_server_module.rst @@ -0,0 +1,4474 @@ +.. _cisco.nxos.nxos_snmp_server_module: + + +*************************** +cisco.nxos.nxos_snmp_server +*************************** + +**SNMP Server resource module.** + + +Version added: 2.8.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages SNMP server configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A dict of SNMP server configuration
+
+
+ aaa_user + +
+ dictionary +
+ 		+ +
Set duration for which aaa-cached snmp user exists.
+
+
+ cache_timeout + +
+ integer +
+ 		+ +
Timeout for which aaa-cached user exists(in secs).
+
+
+ communities + +
+ list + / elements=dictionary +
+ 		+ +
Set community string and access privs.
+
+
+ group + +
+ string +
+ 		+ +
Group to which the community belongs.
+
+
+ name + +
+ string +
+ 		+ +
SNMP community string (Max Size 32).
+

aliases: community
+
+
+ ro + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Read-only access with this community string.
+
+
+ rw + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Read-write access with this community string.
+
+
+ use_ipv4acl + +
+ string +
+ 		+ +
Specify IPv4 ACL, the ACL name specified must be IPv4 ACL.
+
This option is unsupported on MDS switches.
+
+
+ use_ipv6acl + +
+ string +
+ 		+ +
Specify IPv6 ACL, the ACL name specified after must be IPv6 ACL.
+
This option is unsupported on MDS switches.
+
+
+ contact + +
+ string +
+ 		+ +
Modify sysContact.
+
+
+ context + +
+ dictionary +
+ 		+ +
SNMP context to be mapped.
+
+
+ instance + +
+ string +
+ 		+ +
Name of the protocol instance (Max Size 32).
+
+
+ name + +
+ string +
+ 		+ +
Name of the SNMP context (Max Size 32).
+
+
+ topology + +
+ string +
+ 		+ +
Topology associated with the SNMP context.
+
+
+ vrf + +
+ string +
+ 		+ +
VRF associated with the SNMP context.
+
This option is unsupported on MDS switches.
+
+
+ counter + +
+ dictionary +
+ 		+ +
Configure port counter configuration.
+
This option is unsupported on MDS switches.
+
+
+ cache + +
+ dictionary +
+ 		+ +
Port stats cache.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable port stats cache.
+
+
+ timeout + +
+ integer +
+ 		+ +
Timeout for which cached port stats exists(in secs).
+
+
+ drop + +
+ dictionary +
+ 		+ +
Silently drop unknown v3 user packets.
+
This option is unsupported on MDS switches.
+
+
+ unknown_engine_id + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Unknown v3 engine id.
+
+
+ unknown_user + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Unknown v3 user.
+
+
+ engine_id + +
+ dictionary +
+ 		+ +
Configure a local SNMPv3 engineID.
+
This option is unsupported on MDS switches.
+
+
+ local + +
+ string +
+ 		+ +
EngineID of the local agent.
+
+
+ global_enforce_priv + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Globally enforce privacy for all the users.
+
+
+ hosts + +
+ list + / elements=dictionary +
+ 		+ +
Specify hosts to receive SNMP notifications.
+
SNMP hosts config lines that appear separately in running-config must be added as individual dictionaries.
+
+
+ auth + +
+ string +
+ 		+ +
Use the SNMPv3 authNoPriv Security Level.
+
+
+ community + +
+ string +
+ 		+ +
SNMP community string or SNMPv3 user name (Max Size 32).
+
+
+ filter_vrf + +
+ string +
+ 		+ +
Filters notifications to the notification host receiver based on the configured VRF.
+
This option is unsupported on MDS switches.
+
+
+ host + +
+ string +
+ 		+ +
IPv4 or IPv6 address or DNS Name of SNMP notification host.
+
+
+ informs + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Inform messages to this host.
+
+
+ priv + +
+ string +
+ 		+ +
Use the SNMPv3 authPriv Security Level.
+
+
+ source_interface + +
+ string +
+ 		+ +
Source interface to be used for sending out SNMP notifications to this host.
+
+
+ traps + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Traps messages to this host.
+
+
+ udp_port + +
+ integer +
+ 		+ +
The notification host's UDP port number.
+
+
+ use_vrf + +
+ string +
+ 		+ +
Configures SNMP to use the selected VRF to communicate with the host receiver.
+
This option is unsupported on MDS switches.
+
+
+ version + +
+ string +
+ 		+
    Choices: +
  • 1
    • +
  • 2c
    • +
  • 3
    • +
+ 		+
SNMP version to use for notification messages.
+
+
+ location + +
+ string +
+ 		+ +
Modify sysLocation.
+
+
+ mib + +
+ dictionary +
+ 		+ +
Mib access parameters.
+
+
+ community_map + +
+ dictionary +
+ 		+ +
SNMP community.
+
+
+ community + +
+ string +
+ 		+ +
SNMP community string (Max Size 32).
+
+
+ context + +
+ string +
+ 		+ +
Name of the SNMP context (Max Size 32).
+
+
+ packetsize + +
+ integer +
+ 		+ +
Largest SNMP packet size
+
+
+ protocol + +
+ dictionary +
+ 		+ +
Snmp protocol operations.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable snmp protocol operations.
+
+
+ source_interface + +
+ dictionary +
+ 		+ +
Source interface to be used for sending out SNMP notifications.
+
This option is unsupported on MDS switches.
+
+
+ informs + +
+ string +
+ 		+ +
SNMP Inform notifications for which this source interface needs to be used.
+
+
+ traps + +
+ string +
+ 		+ +
SNMP Trap notifications for which this source interface needs to be used.
+
+
+ system_shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure snmp-server for reload(2).
+
+
+ tcp_session + +
+ dictionary +
+ 		+ +
Enable one time authentication for snmp over tcp session.
+
+
+ auth + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable one time authentication for snmp over tcp session.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable tcp-session.
+
This option is unsupported on MDS switches.
+
+
+ traps + +
+ dictionary +
+ 		+ +
Enable SNMP Traps
+
+
+ aaa + +
+ dictionary +
+ 		+ +
AAA traps
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable AAA traps.
+
+
+ server_state_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
AAA server state change notification.
+
+
+ bgp + +
+ dictionary +
+ 		+ +
SNMP BGP traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP BGP traps.
+
+
+ bridge + +
+ dictionary +
+ 		+ +
Bridge traps.
+
This option is unsupported on MDS switches.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable bridge traps.
+
+
+ newroot + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP STP Bridge MIB newroot traps.
+
+
+ topologychange + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP STP Bridge MIB topologychange traps.
+
+
+ callhome + +
+ dictionary +
+ 		+ +
Callhome traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable callhome traps.
+
This option is unsupported on MDS switches.
+
+
+ event_notify + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Callhome External Event Notification.
+
+
+ smtp_send_fail + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
SMTP Message Send Fail notification.
+
+
+ cfs + +
+ dictionary +
+ 		+ +
CFS traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable cfs traps.
+
This option is unsupported on MDS switches.
+
+
+ merge_failure + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Merge failure notification.
+
+
+ state_change_notif + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
State change notification.
+
+
+ config + +
+ dictionary +
+ 		+ +
Config traps.
+
+
+ ccmCLIRunningConfigChanged + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Running config change trap.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable config traps.
+
This option is unsupported on MDS switches.
+
+
+ entity + +
+ dictionary +
+ 		+ +
Entity traps.
+
+
+ cefcMIBEnableStatusNotification + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
CefcMIBEnableStatusNotification.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable entity traps.
+
+
+ entity_fan_status_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Fan Status Change.
+
+
+ entity_mib_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity MIB change.
+
+
+ entity_module_inserted + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Module Inserted.
+
+
+ entity_module_removed + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Module Removed.
+
+
+ entity_module_status_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Module Status Change.
+
+
+ entity_power_out_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Power Out Change.
+
+
+ entity_power_status_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Power Status Change.
+
+
+ entity_sensor + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity sensor.
+
+
+ entity_unrecognised_module + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Unrecognised Module.
+
+
+ feature_control + +
+ dictionary +
+ 		+ +
Feature-Control traps.
+
+
+ ciscoFeatOpStatusChange + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Feature operation status change Notification.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable feature-control traps.
+
This option is unsupported on MDS switches.
+
+
+ featureOpStatusChange + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Feature operation status change notification.
+
+
+ generic + +
+ dictionary +
+ 		+ +
Generic traps.
+
+
+ coldStart + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Generic coldStart trap.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable generic traps.
+
This option is unsupported on MDS switches.
+
+
+ warmStart + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Generic warmStart trap.
+
+
+ license + +
+ dictionary +
+ 		+ +
License traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable license traps.
+
This option is unsupported on MDS switches.
+
+
+ notify_license_expiry + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
License Expiry Notification.
+
+
+ notify_license_expiry_warning + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
License Expiry Warning Notification.
+
+
+ notify_licensefile_missing + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
License File Missing Notification.
+
+
+ notify_no_license_for_feature + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
No License installed for feature Notification.
+
+
+ link + +
+ dictionary +
+ 		+ +
Link traps.
+
+
+ cErrDisableInterfaceEventRev1 + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Err-disable state notification.
+
This option is unsupported on MDS switches.
+
+
+ cieLinkDown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Cisco extended link state down notification.
+
+
+ cieLinkUp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Cisco extended link state up notification.
+
+
+ cisco_xcvr_mon_status_chg + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Cisco interface transceiver monitor status change notification.
+
+
+ cmn_mac_move_notification + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Mac addr move trap.
+
This option is unsupported on MDS switches.
+
+
+ delayed_link_state_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Delayed link state change.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable link traps.
+
This option is unsupported on MDS switches.
+
+
+ extended_linkDown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
IETF extended link state down notification.
+
+
+ extended_linkUp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
IETF extended link state up notification.
+
+
+ linkDown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
IETF Link state down notification.
+
+
+ linkUp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
IETF Link state up notification.
+
+
+ mmode + +
+ dictionary +
+ 		+ +
MMode traps.
+
This option is unsupported on MDS switches.
+
+
+ cseMaintModeChangeNotify + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Maint Mode Change Notification.
+
+
+ cseNormalModeChangeNotify + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Normal Mode Change Notification.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable mmode traps.
+
+
+ ospf + +
+ dictionary +
+ 		+ +
SNMP OSPF traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP OSPF traps.
+
+
+ ospfv3 + +
+ dictionary +
+ 		+ +
SNMP OSPFv3 traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP OSPFv3 traps.
+
+
+ rf + +
+ dictionary +
+ 		+ +
RF traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable rf traps.
+
This option is unsupported on MDS switches.
+
+
+ redundancy_framework + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Redundancy_Framework (RF) Sup switchover MIB.
+
+
+ rmon + +
+ dictionary +
+ 		+ +
RMON traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable rmon traps.
+
This option is unsupported on MDS switches.
+
+
+ fallingAlarm + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Rmon falling alarm.
+
+
+ hcFallingAlarm + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
High capacity Rmon falling alarm.
+
+
+ hcRisingAlarm + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
High capacity Rmon rising alarm.
+
+
+ risingAlarm + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Rmon rising alarm.
+
+
+ snmp + +
+ dictionary +
+ 		+ +
SNMP traps.
+
+
+ authentication + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
SNMP authentication trap.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable snmp traps.
+
This option is unsupported on MDS switches.
+
+
+ storm_control + +
+ dictionary +
+ 		+ +
Storm-Control traps.
+
+
+ cpscEventRev1 + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Port-Storm-Control-Event.
+
This option is unsupported on MDS switches.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable storm-control traps.
+
This option is unsupported on MDS switches.
+
+
+ trap_rate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Number of traps per minute.
+
+
+ stpx + +
+ dictionary +
+ 		+ +
Stpx traps.
+
This option is unsupported on MDS switches.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable stpx traps.
+
+
+ inconsistency + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP STPX MIB InconsistencyUpdate traps.
+
+
+ loop_inconsistency + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP STPX MIB LoopInconsistencyUpdate traps.
+
+
+ root_inconsistency + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP STPX MIB RootInconsistencyUpdate traps.
+
+
+ syslog + +
+ dictionary +
+ 		+ +
Enable syslog traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable syslog traps.
+
This option is unsupported on MDS switches.
+
+
+ message_generated + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Message Generated Notification.
+
+
+ sysmgr + +
+ dictionary +
+ 		+ +
Sysmgr traps.
+
+
+ cseFailSwCoreNotifyExtended + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Software Core Notification.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable sysmgr traps.
+
This option is unsupported on MDS switches.
+
+
+ system + +
+ dictionary +
+ 		+ +
System traps.
+
+
+ clock_change_notification + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Clock-change-notification traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable system traps.
+
This option is unsupported on MDS switches.
+
+
+ upgrade + +
+ dictionary +
+ 		+ +
Upgrade traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable upgrade traps.
+
This option is unsupported on MDS switches.
+
+
+ upgradeJobStatusNotify + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Upgrade Job Status Notification.
+
+
+ upgradeOpNotifyOnCompletion + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Upgrade Global Status Notification.
+
+
+ vtp + +
+ dictionary +
+ 		+ +
VTP traps.
+
This option is unsupported on MDS switches.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable VTP traps.
+
+
+ notifs + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable vtpConfigRevNumberError vtpConfigDigestEnable vtpConfigRevNumberError vtpConfigDigestError vtpServerDisabled vtpVersionOneDeviceDetected vlanTrunkPortDynamicStatusChange vtpLocalModeChanged vtpVersionInUseChanged notification.
+
+
+ vlancreate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable vtpVlanCreated notification.
+
+
+ vlandelete + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable vtpVlanDeleted notification.
+
+
+ users + +
+ dictionary +
+ 		+ +
Define users who can access the SNMP engine.
+
+
+ auth + +
+ list + / elements=dictionary +
+ 		+ +
SNMP User authentication related settings
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Authentication parameters for the user.
+
+
+ algorithm + +
+ string +
+ 		+
    Choices: +
  • md5
    • +
  • sha
    • +
  • sha-256
    • +
+ 		+
Select algorithm for authentication.
+
+
+ engine_id + +
+ string +
+ 		+ +
EngineID for configuring notif target user (for V3 informs).
+
This value needs to be enclosed in quotes in the task.
+
+
+ localized_key + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specifies whether the passwords are in localized key format.
+
+
+ localizedv2_key + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specifies whether the passwords are in localized V2 key format.
+
+
+ password + +
+ string +
+ 		+ +
Authentication password for user (Max Size 127).
+
If this value is localized, it has to be enclosed in quotes in the task.
+
+
+ priv + +
+ dictionary +
+ 		+ +
Encryption parameters for the user.
+
+
+ aes_128 + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use 128-bit AES algorithm for privacy.
+
+
+ privacy_password + +
+ string +
+ 		+ +
Privacy password for user (Max Size 130).
+
If this value is localized, it has to be enclosed in quotes in the task.
+
+
+ group + +
+ string +
+ 		+ +
Group name (ignored for notif target user) (Max Size 28).
+
+
+ user + +
+ string +
+ 		+ +
Name of the user (Max Size 28).
+
+
+ use_acls + +
+ list + / elements=dictionary +
+ 		+ +
Set IPv4 and IPv6 ACL to use.
+
+
+ ipv4 + +
+ string +
+ 		+ +
Specify IPv4 ACL, the ACL name specified after must be IPv4 ACL.
+
+
+ ipv6 + +
+ string +
+ 		+ +
Specify IPv6 ACL, the ACL name specified after must be IPv6 ACL.
+
+
+ user + +
+ string +
+ 		+ +
Name of the user (Max Size 28).
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^snmp-server'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
The states replaced and overridden have identical behaviour for this module.
+
Please refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6 on Cisco Nexus Switches. + - This module works with connection ``network_cli`` and ``httpapi``. + - Tested against Cisco MDS NX-OS 9.2(2) with connection ``network_cli``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_snmp_server: + config: + aaa_user: + cache_timeout: 36000 + communities: + - community: public + group: network-operator + - community: private + group: network-admin + contact: nxosswitchadmin@localhost + location: serverroom-1 + traps: + aaa: + server_state_change: true + system: + clock_change_notification: true + hosts: + - host: 192.0.2.1 + traps: true + version: '1' + community: public + - host: 192.0.2.1 + source_interface: Ethernet1/1 + - host: 192.0.2.2 + informs: true + version: '3' + auth: NMS + users: + auth: + - user: snmp_user_1 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + - user: snmp_user_2 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + priv: + privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' + aes_128: true + use_acls: + - user: snmp_user_1 + ipv4: acl1 + ipv6: acl2 + - user: snmp_user_2 + ipv4: acl3 + ipv6: acl4 + + # Task output + # ------------- + # before: + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # + # commands: + # - snmp-server contact nxosswitchadmin@localhost + # - snmp-server location serverroom-1 + # - snmp-server aaa-user cache-timeout 36000 + # - snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # - snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # - snmp-server host 192.0.2.1 traps version 1 public + # - snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # - snmp-server host 192.0.2.2 informs version 3 auth NMS + # - snmp-server community private group network-admin + # - snmp-server community public group network-operator + # - snmp-server enable traps aaa server-state-change + # - snmp-server enable traps system Clock-change-notification + # + # after: + # aaa_user: + # cache_timeout: 36000 + # communities: + # - community: private + # group: network-admin + # - community: public + # group: network-operator + # contact: nxosswitchadmin@localhost + # location: serverroom-1 + # traps: + # aaa: + # server_state_change: true + # system: + # clock_change_notification: true + # hosts: + # - host: 192.0.2.1 + # traps: true + # version: "1" + # community: public + # + # - host: 192.0.2.1 + # source_interface: Ethernet1/1 + # + # - host: 192.0.2.2 + # informs: true + # version: "3" + # auth: NMS + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # + # - user: snmp_user_1 + # group: network-operator + # authentication: + # algorithm: md5 + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # localized_key: true + # + # - authentication: + # algorithm: md5 + # localized_key: true + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # priv: + # aes_128: true + # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" + # group: network-operator + # user: snmp_user_2 + # + # use_acls: + # - user: snmp_user_1 + # ipv4: acl1 + # ipv6: acl2 + # - user: snmp_user_2 + # ipv4: acl3 + # ipv6: acl4 + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server contact nxosswitchadmin@localhost + # snmp-server location serverroom-1 + # snmp-server aaa-user cache-timeout 36000 + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # snmp-server host 192.0.2.1 traps version 1 public + # snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # snmp-server host 192.0.2.2 informs version 3 auth NMS + # snmp-server community private group network-admin + # snmp-server community public group network-operator + # snmp-server enable traps aaa server-state-change + # snmp-server enable traps system Clock-change-notification + + # Using replaced + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server contact nxosswitchadmin@localhost + # snmp-server location serverroom-1 + # snmp-server aaa-user cache-timeout 36000 + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # snmp-server host 192.0.2.1 traps version 1 public + # snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # snmp-server host 192.0.2.2 informs version 3 auth NMS + # snmp-server community private group network-admin + # snmp-server community public group network-operator + # snmp-server enable traps aaa server-state-change + # snmp-server enable traps system Clock-change-notification + + - name: Replace snmp-server configurations of listed snmp-server with provided configurations + cisco.nxos.nxos_snmp_server: + config: + aaa_user: + cache_timeout: 36000 + communities: + - community: public + group: network-operator + - community: secret + group: network-operator + contact: nxosswitchadmin2@localhost + location: serverroom-2 + traps: + aaa: + server_state_change: true + hosts: + - host: 192.0.2.1 + traps: true + version: '1' + community: public + - host: 192.0.2.1 + source_interface: Ethernet1/1 + - host: 192.0.3.2 + informs: true + version: '3' + auth: NMS + users: + auth: + - user: admin + group: network-admin + authentication: + algorithm: md5 + password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + localized_key: true + priv: + privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + + - user: snmp_user_1 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + + - user: snmp_user_2 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + priv: + privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' + aes_128: true + use_acls: + - user: snmp_user_1 + ipv4: acl1 + ipv6: acl2 + state: replaced + + # Task output + # ------------- + # before: + # aaa_user: + # cache_timeout: 36000 + # communities: + # - community: private + # group: network-admin + # - community: public + # group: network-operator + # contact: nxosswitchadmin@localhost + # location: serverroom-1 + # traps: + # aaa: + # server_state_change: true + # system: + # clock_change_notification: true + # hosts: + # - host: 192.0.2.1 + # traps: true + # version: "1" + # community: public + # + # - host: 192.0.2.1 + # source_interface: Ethernet1/1 + # + # - host: 192.0.2.2 + # informs: true + # version: "3" + # auth: NMS + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # + # - user: snmp_user_1 + # group: network-operator + # authentication: + # algorithm: md5 + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # localized_key: true + # + # - authentication: + # algorithm: md5 + # localized_key: true + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # priv: + # aes_128: true + # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" + # group: network-operator + # user: snmp_user_2 + # + # use_acls: + # - user: snmp_user_1 + # ipv4: acl1 + # ipv6: acl2 + # - user: snmp_user_2 + # ipv4: acl3 + # ipv6: acl4 + # + # commands: + # - snmp-server contact nxosswitchadmin2@localhost + # - no snmp-server enable traps system Clock-change-notification + # - snmp-server location serverroom-2 + # - no snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # - no snmp-server host 192.0.2.2 informs version 3 auth NMS + # - snmp-server host 192.0.3.2 informs version 3 auth NMS + # - no snmp-server community private group network-admin + # - snmp-server community secret group network-operator + # + # after: + # aaa_user: + # cache_timeout: 36000 + # communities: + # - community: public + # group: network-operator + # - community: secret + # group: network-operator + # contact: nxosswitchadmin2@localhost + # location: serverroom-2 + # traps: + # aaa: + # server_state_change: true + # hosts: + # - host: 192.0.2.1 + # traps: true + # version: '1' + # community: public + # - host: 192.0.2.1 + # source_interface: Ethernet1/1 + # - host: 192.0.3.2 + # informs: true + # version: '3' + # auth: NMS + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # + # - user: snmp_user_1 + # group: network-operator + # authentication: + # algorithm: md5 + # password: '0x5632724fb8ac3699296af26281e1d0f1' + # localized_key: true + # + # - user: snmp_user_2 + # group: network-operator + # authentication: + # algorithm: md5 + # password: '0x5632724fb8ac3699296af26281e1d0f1' + # localized_key: true + # priv: + # privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' + # aes_128: true + # + # use_acls: + # - user: snmp_user_1 + # ipv4: acl1 + # ipv6: acl2 + # + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server contact nxosswitchadmin2@localhost + # snmp-server location serverroom-2 + # snmp-server aaa-user cache-timeout 36000 + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # snmp-server host 192.0.2.1 traps version 1 public + # snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # snmp-server host 192.0.2.2 informs version 3 auth NMS + # snmp-server community secret group network-operator + # snmp-server community public group network-operator + # snmp-server enable traps aaa server-state-change + # snmp-server enable traps system Clock-change-notification + + # Using deleted + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server contact nxosswitchadmin@localhost + # snmp-server location serverroom-1 + # snmp-server aaa-user cache-timeout 36000 + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # snmp-server host 192.0.2.1 traps version 1 public + # snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # snmp-server host 192.0.2.2 informs version 3 auth NMS + # snmp-server community private group network-admin + # snmp-server community public group network-operator + # snmp-server enable traps aaa server-state-change + # snmp-server enable traps system Clock-change-notification + + - name: Delete SNMP Server configurations from the device (admin user will not be deleted) + cisco.nxos.nxos_snmp_server: + state: deleted + + # Task output + # ------------- + # before: + # aaa_user: + # cache_timeout: 36000 + # communities: + # - community: private + # group: network-admin + # - community: public + # group: network-operator + # contact: nxosswitchadmin@localhost + # location: serverroom-1 + # traps: + # aaa: + # server_state_change: true + # system: + # clock_change_notification: true + # hosts: + # - host: 192.0.2.1 + # traps: true + # version: "1" + # community: public + # + # - host: 192.0.2.1 + # source_interface: Ethernet1/1 + # + # - host: 192.0.2.2 + # informs: true + # version: "3" + # auth: NMS + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # + # - user: snmp_user_1 + # group: network-operator + # authentication: + # algorithm: md5 + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # localized_key: true + # + # - authentication: + # algorithm: md5 + # localized_key: true + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # priv: + # aes_128: true + # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" + # group: network-operator + # user: snmp_user_2 + # + # use_acls: + # - user: snmp_user_1 + # ipv4: acl1 + # ipv6: acl2 + # - user: snmp_user_2 + # ipv4: acl3 + # ipv6: acl4 + # + # commands: + # - no snmp-server contact nxosswitchadmin@localhost + # - no snmp-server location serverroom-1 + # - no snmp-server aaa-user cache-timeout 36000 + # - no snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + # - no snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - no snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - no snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # - no snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # - no snmp-server host 192.0.2.1 traps version 1 public + # - no snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # - no snmp-server host 192.0.2.2 informs version 3 auth NMS + # - no snmp-server community private group network-admin + # - no snmp-server community public group network-operator + # - no snmp-server enable traps aaa server-state-change + # - no snmp-server enable traps system Clock-change-notification + # + # after: + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + + # Using rendered + # --------------- + + - name: Render platform specific configuration lines with state rendered (without connecting to the device) + cisco.nxos.nxos_snmp_server: + config: + aaa_user: + cache_timeout: 36000 + communities: + - community: public + group: network-operator + - community: private + group: network-admin + contact: nxosswitchadmin@localhost + location: serverroom-1 + traps: + aaa: + server_state_change: true + system: + clock_change_notification: true + hosts: + - host: 192.0.2.1 + traps: true + version: '1' + community: public + - host: 192.0.2.1 + source_interface: Ethernet1/1 + - host: 192.0.2.2 + informs: true + version: '3' + auth: NMS + users: + auth: + - user: snmp_user_1 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + - user: snmp_user_2 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + priv: + privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' + aes_128: true + use_acls: + - user: snmp_user_1 + ipv4: acl1 + ipv6: acl2 + - user: snmp_user_2 + ipv4: acl3 + ipv6: acl4 + state: rendered + + + # Task Output (redacted) + # ----------------------- + # rendered: + # - snmp-server contact nxosswitchadmin@localhost + # - snmp-server location serverroom-1 + # - snmp-server aaa-user cache-timeout 36000 + # - snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # - snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # - snmp-server host 192.0.2.1 traps version 1 public + # - snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # - snmp-server host 192.0.2.2 informs version 3 auth NMS + # - snmp-server community private group network-admin + # - snmp-server community public group network-operator + # - snmp-server enable traps aaa server-state-change + # - snmp-server enable traps system Clock-change-notification + + # Using parsed + + # parsed.cfg + # ------------ + # snmp-server contact nxosswitchadmin@localhost + # snmp-server location serverroom-1 + # snmp-server aaa-user cache-timeout 36000 + # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # snmp-server host 192.0.2.1 traps version 1 public + # snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # snmp-server host 192.0.2.2 informs version 3 auth NMS + # snmp-server community private group network-admin + # snmp-server community public group network-operator + # snmp-server enable traps aaa server-state-change + # snmp-server enable traps system Clock-change-notification + + - name: Parse externally provided snmp-server configuration + cisco.nxos.nxos_snmp_server: + running_config: "{{ lookup('file', './parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # aaa_user: + # cache_timeout: 36000 + # communities: + # - community: private + # group: network-admin + # - community: public + # group: network-operator + # contact: nxosswitchadmin@localhost + # location: serverroom-1 + # traps: + # aaa: + # server_state_change: true + # system: + # clock_change_notification: true + # hosts: + # - host: 192.0.2.1 + # traps: true + # version: "1" + # community: public + # + # - host: 192.0.2.1 + # source_interface: Ethernet1/1 + # + # - host: 192.0.2.2 + # informs: true + # version: "3" + # auth: NMS + # users: + # auth: + # - user: snmp_user_1 + # group: network-operator + # authentication: + # algorithm: md5 + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # localized_key: true + # + # - authentication: + # algorithm: md5 + # localized_key: true + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # priv: + # aes_128: true + # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" + # group: network-operator + # user: snmp_user_2 + # + # use_acls: + # - user: snmp_user_1 + # ipv4: acl1 + # ipv6: acl2 + # - user: snmp_user_2 + # ipv4: acl3 + # ipv6: acl4 + # + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['sample command 1', 'sample command 2', 'sample command 3']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['sample command 1', 'sample command 2', 'sample command 3']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_snmp_traps_module.rst b/docs/cisco.nxos.nxos_snmp_traps_module.rst new file mode 100644 index 000000000..726a4d5fe --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_traps_module.rst @@ -0,0 +1,189 @@ +.. _cisco.nxos.nxos_snmp_traps_module: + + +************************** +cisco.nxos.nxos_snmp_traps +************************** + +**(deprecated, removed after 2024-01-01) Manages SNMP traps.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated modules released with more functionality +:Alternative: nxos_snmp_server + + + +Synopsis +-------- +- Manages SNMP traps configurations. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ group + +
+ string + / required +
+ 		+
    Choices: +
  • aaa
    • +
  • bfd
    • +
  • bgp
    • +
  • bridge
    • +
  • callhome
    • +
  • cfs
    • +
  • config
    • +
  • eigrp
    • +
  • entity
    • +
  • feature-control
    • +
  • generic
    • +
  • hsrp
    • +
  • license
    • +
  • link
    • +
  • lldp
    • +
  • mmode
    • +
  • ospf
    • +
  • pim
    • +
  • rf
    • +
  • rmon
    • +
  • snmp
    • +
  • storm-control
    • +
  • stpx
    • +
  • switchfabric
    • +
  • syslog
    • +
  • sysmgr
    • +
  • system
    • +
  • upgrade
    • +
  • vtp
    • +
  • all
    • +
+ 		+
Case sensitive group.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • enabled ←
    • +
  • disabled
    • +
+ 		+
Manage the state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - This module works at the group level for traps. If you need to only enable/disable 1 specific trap within a group, use the :ref:`cisco.nxos.nxos_command ` module. + - Be aware that you can set a trap only for an enabled feature. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure lldp trap configured + - cisco.nxos.nxos_snmp_traps: + group: lldp + state: enabled + + # ensure lldp trap is not configured + - cisco.nxos.nxos_snmp_traps: + group: lldp + state: disabled + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
snmp-server enable traps lldp ;
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_snmp_user_module.rst b/docs/cisco.nxos.nxos_snmp_user_module.rst new file mode 100644 index 000000000..2d3f6f26c --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_user_module.rst @@ -0,0 +1,235 @@ +.. _cisco.nxos.nxos_snmp_user_module: + + +************************* +cisco.nxos.nxos_snmp_user +************************* + +**(deprecated, removed after 2024-01-01) Manages SNMP users for monitoring.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated modules released with more functionality +:Alternative: nxos_snmp_server + + + +Synopsis +-------- +- Manages SNMP user configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ authentication + +
+ string +
+ 		+
    Choices: +
  • md5
    • +
  • sha
    • +
+ 		+
Authentication parameters for the user.
+
+
+ encrypt + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables AES-128 bit encryption when using privacy password.
+
+
+ group + +
+ string +
+ 		+ +
Group to which the user will belong to. If state = present, and the user is existing, the group is added to the user. If the user is not existing, user entry is created with this group argument. If state = absent, only the group is removed from the user entry. However, to maintain backward compatibility, if the existing user belongs to only one group, and if group argument is same as the existing user's group, then the user entry also is deleted.
+
+
+ privacy + +
+ string +
+ 		+ +
Privacy password for the user. This is not idempotent
+
+
+ pwd + +
+ string +
+ 		+ +
Authentication password when using md5 or sha. This is not idempotent
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ user + +
+ string + / required +
+ 		+ +
Name of the user.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - Authentication parameters not idempotent. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_snmp_user: + user: ntc + group: network-operator + authentication: md5 + pwd: test_password + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['snmp-server user ntc network-operator auth md5 test_password']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_udld_interface_module.rst b/docs/cisco.nxos.nxos_udld_interface_module.rst new file mode 100644 index 000000000..cba2733c0 --- /dev/null +++ b/docs/cisco.nxos.nxos_udld_interface_module.rst @@ -0,0 +1,250 @@ +.. _cisco.nxos.nxos_udld_interface_module: + + +****************************** +cisco.nxos.nxos_udld_interface +****************************** + +**Manages UDLD interface configuration params.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages UDLD interface configuration params. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ interface + +
+ string + / required +
+ 		+ +
FULL name of the interface, i.e. Ethernet1/1-
+
+
+ mode + +
+ string + / required +
+ 		+
    Choices: +
  • enabled
    • +
  • disabled
    • +
  • aggressive
    • +
+ 		+
Manages UDLD mode for an interface.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Feature UDLD must be enabled on the device to use this module. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure Ethernet1/1 is configured to be in aggressive mode + - cisco.nxos.nxos_udld_interface: + interface: Ethernet1/1 + mode: aggressive + state: present + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + # Remove the aggressive config only if it's currently in aggressive mode and then disable udld (switch default) + - cisco.nxos.nxos_udld_interface: + interface: Ethernet1/1 + mode: aggressive + state: absent + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + # ensure Ethernet1/1 has aggressive mode enabled + - cisco.nxos.nxos_udld_interface: + interface: Ethernet1/1 + mode: enabled + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ end_state + +
+ dictionary +
+ 		always +
k/v pairs of configuration after module execution
+
+
Sample:
+
{'mode': 'enabled'}
+
+
+ existing + +
+ dictionary +
+ 		always +
k/v pairs of existing configuration
+
+
Sample:
+
{'mode': 'aggressive'}
+
+
+ proposed + +
+ dictionary +
+ 		always +
k/v pairs of parameters passed into module
+
+
Sample:
+
{'mode': 'enabled'}
+
+
+ updates + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['interface ethernet1/33', 'no udld aggressive ; no udld disable']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_udld_module.rst b/docs/cisco.nxos.nxos_udld_module.rst new file mode 100644 index 000000000..dc461bc89 --- /dev/null +++ b/docs/cisco.nxos.nxos_udld_module.rst @@ -0,0 +1,256 @@ +.. _cisco.nxos.nxos_udld_module: + + +******************** +cisco.nxos.nxos_udld +******************** + +**Manages UDLD global configuration params.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages UDLD global configuration params. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ aggressive + +
+ string +
+ 		+
    Choices: +
  • enabled
    • +
  • disabled
    • +
+ 		+
Toggles aggressive mode.
+
+
+ msg_time + +
+ string +
+ 		+ +
Message time in seconds for UDLD packets or keyword 'default'.
+
+
+ reset + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ability to reset all ports shut down by UDLD. 'state' parameter cannot be 'absent' when this is present.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource. When set to 'absent', aggressive and msg_time are set to their default values.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Module will fail if the udld feature has not been previously enabled. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure udld aggressive mode is globally disabled and se global message interval is 20 + - cisco.nxos.nxos_udld: + aggressive: disabled + msg_time: 20 + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + # Ensure agg mode is globally enabled and msg time is 15 + - cisco.nxos.nxos_udld: + aggressive: enabled + msg_time: 15 + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ end_state + +
+ dictionary +
+ 		always +
k/v pairs of udld configuration after module execution
+
+
Sample:
+
{'aggressive': 'enabled', 'msg_time': '40'}
+
+
+ existing + +
+ dictionary +
+ 		always +
k/v pairs of existing udld configuration
+
+
Sample:
+
{'aggressive': 'disabled', 'msg_time': '15'}
+
+
+ proposed + +
+ dictionary +
+ 		always +
k/v pairs of parameters passed into module
+
+
Sample:
+
{'aggressive': 'enabled', 'msg_time': '40'}
+
+
+ updates + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['udld message-time 40', 'udld aggressive']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_user_module.rst b/docs/cisco.nxos.nxos_user_module.rst new file mode 100644 index 000000000..a03a23a03 --- /dev/null +++ b/docs/cisco.nxos.nxos_user_module.rst @@ -0,0 +1,390 @@ +.. _cisco.nxos.nxos_user_module: + + +******************** +cisco.nxos.nxos_user +******************** + +**Manage the collection of local users on Nexus devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module provides declarative management of the local usernames configured on Cisco Nexus devices. It allows playbooks to manage either individual usernames or the collection of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ aggregate + +
+ list + / elements=dictionary +
+ 		+ +
The set of username objects to be configured on the remote Cisco Nexus device. The list entries can either be the username or a hash of username and properties. This argument is mutually exclusive with the name argument.
+

aliases: users, collection
+
+
+ configured_password + +
+ string +
+ 		+ +
The password to be configured on the network device. The password needs to be provided in cleartext and it will be encrypted on the device.
+
+
+ hashed_password + +
+ string +
+ 		+ +
The hashed password to be configured on the network device. The password needs to already be encrypted.
+
+
+ name + +
+ string +
+ 		+ +
The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
+
+
+ roles + +
+ list + / elements=string +
+ 		+ +
The role argument configures the role for the username in the device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device.
+

aliases: role
+
+
+ sshkey + +
+ string +
+ 		+ +
The sshkey argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
The state argument configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
+
+
+ update_password + +
+ string +
+ 		+
    Choices: +
  • on_create
    • +
  • always
    • +
+ 		+
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
+
+
+ configured_password + +
+ string +
+ 		+ +
The password to be configured on the network device. The password needs to be provided in cleartext and it will be encrypted on the device.
+
+
+ hashed_password + +
+ string +
+ 		+ +
The hashed password to be configured on the network device. The password needs to already be encrypted.
+
+
+ name + +
+ string +
+ 		+ +
The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
+
+
+ purge + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
The purge argument instructs the module to consider the resource definition absolute. It will remove any previously configured usernames on the device with the exception of the `admin` user which cannot be deleted per nxos constraints.
+
+
+ roles + +
+ list + / elements=string +
+ 		+ +
The role argument configures the role for the username in the device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device.
+

aliases: role
+
+
+ sshkey + +
+ string +
+ 		+ +
The sshkey argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
The state argument configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
+
+
+ update_password + +
+ string +
+ 		+
    Choices: +
  • on_create
    • +
  • always ←
    • +
+ 		+
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
+
+
+ + +Notes +----- + +.. note:: + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: create a new user + cisco.nxos.nxos_user: + name: ansible + sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}" + state: present + + - name: remove all users except admin + cisco.nxos.nxos_user: + purge: true + + - name: set multiple users role + cisco.nxos.nxos_user: + aggregate: + - name: netop + - name: netend + role: network-operator + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['name ansible', 'name ansible password password']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_vpc_module.rst b/docs/cisco.nxos.nxos_vpc_module.rst new file mode 100644 index 000000000..9e0ca3c29 --- /dev/null +++ b/docs/cisco.nxos.nxos_vpc_module.rst @@ -0,0 +1,352 @@ +.. _cisco.nxos.nxos_vpc_module: + + +******************* +cisco.nxos.nxos_vpc +******************* + +**Manages global VPC configuration** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages global VPC configuration + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ auto_recovery + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/Disables auto recovery on platforms that support disable
+
timers are not modifiable with this attribute
+
mutually exclusive with auto_recovery_reload_delay
+
+
+ auto_recovery_reload_delay + +
+ string +
+ 		+ +
Manages auto-recovery reload-delay timer in seconds
+
mutually exclusive with auto_recovery
+
+
+ delay_restore + +
+ string +
+ 		+ +
manages delay restore command and config value in seconds
+
+
+ delay_restore_interface_vlan + +
+ string +
+ 		+ +
manages delay restore interface-vlan command and config value in seconds
+
not supported on all platforms
+
+
+ delay_restore_orphan_port + +
+ string +
+ 		+ +
manages delay restore orphan-port command and config value in seconds
+
not supported on all platforms
+
+
+ domain + +
+ string + / required +
+ 		+ +
VPC domain
+
+
+ peer_gw + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/Disables peer gateway
+
+
+ pkl_dest + +
+ string +
+ 		+ +
Destination (remote) IP address used for peer keepalive link
+
pkl_dest is required whenever pkl options are used.
+
+
+ pkl_src + +
+ string +
+ 		+ +
Source IP address used for peer keepalive link
+
+
+ pkl_vrf + +
+ string +
+ 		+ +
VRF used for peer keepalive link
+
The VRF must exist on the device before using pkl_vrf.
+
(Note) 'default' is an overloaded term: Default vrf context for pkl_vrf is 'management'; 'pkl_vrf: default' refers to the literal 'default' rib.
+
+
+ role_priority + +
+ string +
+ 		+ +
Role priority for device. Remember lower is better.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manages desired state of the resource
+
+
+ system_priority + +
+ string +
+ 		+ +
System priority device. Remember they must match between peers.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - The feature vpc must be enabled before this module can be used + - If not using management vrf, vrf must be globally on the device before using in the pkl config + - Although source IP isn't required on the command line it is required when using this module. The PKL VRF must also be configured prior to using this module. + - Both pkl_src and pkl_dest are needed when changing PKL VRF. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: configure a simple asn + cisco.nxos.nxos_vpc: + domain: 100 + role_priority: 1000 + system_priority: 2000 + pkl_dest: 192.168.100.4 + pkl_src: 10.1.100.20 + peer_gw: true + auto_recovery: true + + - name: configure + cisco.nxos.nxos_vpc: + domain: 100 + role_priority: 32667 + system_priority: 2000 + peer_gw: true + pkl_src: 10.1.100.2 + pkl_dest: 192.168.100.4 + auto_recovery: true + + - name: Configure VPC with delay restore and existing keepalive VRF + cisco.nxos.nxos_vpc: + domain: 10 + role_priority: 28672 + system_priority: 2000 + delay_restore: 180 + peer_gw: true + pkl_src: 1.1.1.2 + pkl_dest: 1.1.1.1 + pkl_vrf: vpckeepalive + auto_recovery: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['vpc domain 100', 'peer-keepalive destination 192.168.100.4 source 10.1.100.20 vrf management', 'auto-recovery', 'peer-gateway']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vrf_af_module.rst b/docs/cisco.nxos.nxos_vrf_af_module.rst new file mode 100644 index 000000000..236991587 --- /dev/null +++ b/docs/cisco.nxos.nxos_vrf_af_module.rst @@ -0,0 +1,300 @@ +.. _cisco.nxos.nxos_vrf_af_module: + + +********************** +cisco.nxos.nxos_vrf_af +********************** + +**Manages VRF AF.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages VRF AF + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
Address-Family Identifier (AFI).
+
+
+ route_target_both_auto_evpn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable the EVPN route-target 'auto' setting for both import and export target communities.
+
+
+ route_targets + +
+ list + / elements=dictionary +
+ 		+ +
Specify the route-targets which should be imported and/or exported under the AF. This argument accepts a list of dicts that specify the route-target, the direction (import|export|both) and state of each route-target. Default direction is direction=both. See examples.
+
+
+ direction + +
+ string +
+ 		+
    Choices: +
  • import
    • +
  • export
    • +
  • both ←
    • +
+ 		+
Indicates the direction of the route-target (import|export|both)
+
+
+ rt + +
+ string + / required +
+ 		+ +
Defines the route-target itself
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Determines whether the route-target with the given direction should be present or not on the device.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Determines whether the config should be present or not on the device.
+
+
+ vrf + +
+ string + / required +
+ 		+ +
Name of the VRF.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Default, where supported, restores params default value. + - In case of ``state=absent`` the address-family configuration will be absent. Therefore the options ``route_target_both_auto_evpn`` and ``route_targets`` are ignored. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_target_both_auto_evpn: true + state: present + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_targets: + - rt: '65000:1000' + direction: import + - rt: '65001:1000' + direction: import + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_targets: + - rt: '65000:1000' + direction: import + - rt: '65001:1000' + state: absent + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_targets: + - rt: '65000:1000' + direction: export + - rt: '65001:1000' + direction: export + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_targets: + - rt: '65000:1000' + direction: export + state: absent + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_targets: + - rt: '65000:1000' + direction: both + state: present + - rt: '65001:1000' + direction: import + state: present + - rt: '65002:1000' + direction: both + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['vrf context ntc', 'address-family ipv4 unicast']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vrf_module.rst b/docs/cisco.nxos.nxos_vrf_module.rst new file mode 100644 index 000000000..6765f78b5 --- /dev/null +++ b/docs/cisco.nxos.nxos_vrf_module.rst @@ -0,0 +1,494 @@ +.. _cisco.nxos.nxos_vrf_module: + + +******************* +cisco.nxos.nxos_vrf +******************* + +**Manages global VRF configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module provides declarative management of VRFs on CISCO NXOS network devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ admin_state + +
+ string +
+ 		+
    Choices: +
  • up ←
    • +
  • down
    • +
+ 		+
Administrative state of the VRF.
+
+
+ aggregate + +
+ list + / elements=dictionary +
+ 		+ +
List of VRFs definitions.
+
+
+ admin_state + +
+ string +
+ 		+
    Choices: +
  • up
    • +
  • down
    • +
+ 		+
Administrative state of the VRF.
+
+
+ associated_interfaces + +
+ list + / elements=string +
+ 		+ +
This is a intent option and checks the operational state of the for given vrf name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vrf interfaces on device it will result in failure.
+
+
+ delay + +
+ integer +
+ 		+ +
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
+
+
+ description + +
+ string +
+ 		+ +
Description of the VRF or keyword 'default'.
+
+
+ interfaces + +
+ list + / elements=string +
+ 		+ +
List of interfaces to check the VRF has been configured correctly or keyword 'default'.
+
+
+ name + +
+ string +
+ 		+ +
Name of VRF to be managed.
+

aliases: vrf
+
+
+ rd + +
+ string +
+ 		+ +
VPN Route Distinguisher (RD). Valid values are a string in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword 'auto', or the keyword 'default'.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
Manages desired state of the resource.
+
+
+ vni + +
+ string +
+ 		+ +
Specify virtual network identifier. Valid values are Integer or keyword 'default'.
+
+
+ associated_interfaces + +
+ list + / elements=string +
+ 		+ +
This is a intent option and checks the operational state of the for given vrf name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vrf interfaces on device it will result in failure.
+
+
+ delay + +
+ integer +
+ 		+ Default:
10
+ 		+
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
+
+
+ description + +
+ string +
+ 		+ +
Description of the VRF or keyword 'default'.
+
+
+ interfaces + +
+ list + / elements=string +
+ 		+ +
List of interfaces to check the VRF has been configured correctly or keyword 'default'.
+
+
+ name + +
+ string +
+ 		+ +
Name of VRF to be managed.
+

aliases: vrf
+
+
+ purge + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Purge VRFs not defined in the aggregate parameter.
+
+
+ rd + +
+ string +
+ 		+ +
VPN Route Distinguisher (RD). Valid values are a string in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword 'auto', or the keyword 'default'.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manages desired state of the resource.
+
+
+ vni + +
+ string +
+ 		+ +
Specify virtual network identifier. Valid values are Integer or keyword 'default'.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Cisco NX-OS creates the default VRF by itself. Therefore, you're not allowed to use default as *vrf* name in this module. + - ``vrf`` name must be shorter than 32 chars. + - VRF names are not case sensible in NX-OS. Anyway, the name is stored just like it's inserted by the user and it'll not be changed again unless the VRF is removed and re-created. i.e. ``vrf=NTC`` will create a VRF named NTC, but running it again with ``vrf=ntc`` will not cause a configuration change. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Ensure ntc VRF exists on switch + cisco.nxos.nxos_vrf: + name: ntc + description: testing + state: present + - name: Aggregate definition of VRFs + cisco.nxos.nxos_vrf: + aggregate: + - name: test1 + description: Testing + admin_state: down + - name: test2 + interfaces: Ethernet1/2 + - name: Aggregate definitions of VRFs with Purge + cisco.nxos.nxos_vrf: + aggregate: + - name: ntc1 + description: purge test1 + - name: ntc2 + description: purge test2 + state: present + purge: true + - name: Delete VRFs exist on switch + cisco.nxos.nxos_vrf: + aggregate: + - name: ntc1 + - name: ntc2 + state: absent + - name: Assign interfaces to VRF declaratively + cisco.nxos.nxos_vrf: + name: test1 + interfaces: + - Ethernet2/3 + - Ethernet2/5 + - name: Check interfaces assigned to VRF + cisco.nxos.nxos_vrf: + name: test1 + associated_interfaces: + - Ethernet2/3 + - Ethernet2/5 + - name: >- + Ensure VRF is tagged with interface Ethernet2/5 only (Removes from + Ethernet2/3) + cisco.nxos.nxos_vrf: + name: test1 + interfaces: + - Ethernet2/5 + - name: Delete VRF + cisco.nxos.nxos_vrf: + name: ntc + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['vrf context ntc', 'no shutdown', 'interface Ethernet1/2', 'no switchport', 'vrf member test2']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_vrrp_module.rst b/docs/cisco.nxos.nxos_vrrp_module.rst new file mode 100644 index 000000000..88183c5af --- /dev/null +++ b/docs/cisco.nxos.nxos_vrrp_module.rst @@ -0,0 +1,277 @@ +.. _cisco.nxos.nxos_vrrp_module: + + +******************** +cisco.nxos.nxos_vrrp +******************** + +**Manages VRRP configuration on NX-OS switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages VRRP configuration on NX-OS switches. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ admin_state + +
+ string +
+ 		+
    Choices: +
  • shutdown ←
    • +
  • no shutdown
    • +
  • default
    • +
+ 		+
Used to enable or disable the VRRP process.
+
+
+ authentication + +
+ string +
+ 		+ +
Clear text authentication string or 'default' keyword
+
+
+ group + +
+ string + / required +
+ 		+ +
VRRP group number.
+
+
+ interface + +
+ string + / required +
+ 		+ +
Full name of interface that is being managed for VRRP.
+
+
+ interval + +
+ string +
+ 		+ +
Time interval between advertisement or 'default' keyword
+
+
+ preempt + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable preempt.
+
+
+ priority + +
+ string +
+ 		+ +
VRRP priority or 'default' keyword
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specify desired state of the resource.
+
+
+ vip + +
+ string +
+ 		+ +
VRRP virtual IP address or 'default' keyword
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - VRRP feature needs to be enabled first on the system. + - SVIs must exist before using this module. + - Interface must be a L3 port before using this module. + - ``state=absent`` removes the VRRP group if it exists on the device. + - VRRP cannot be configured on loopback interfaces. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Ensure vrrp group 100 and vip 10.1.100.1 is on vlan10 + cisco.nxos.nxos_vrrp: + interface: vlan10 + group: 100 + vip: 10.1.100.1 + + - name: Ensure removal of the vrrp group config + cisco.nxos.nxos_vrrp: + interface: vlan10 + group: 100 + vip: 10.1.100.1 + state: absent + + - name: Re-config with more params + cisco.nxos.nxos_vrrp: + interface: vlan10 + group: 100 + vip: 10.1.100.1 + preempt: false + priority: 130 + authentication: AUTHKEY + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['interface vlan10', 'vrrp 150', 'address 10.1.15.1', 'authentication text testing', 'no shutdown']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vsan_module.rst b/docs/cisco.nxos.nxos_vsan_module.rst new file mode 100644 index 000000000..9baa64c68 --- /dev/null +++ b/docs/cisco.nxos.nxos_vsan_module.rst @@ -0,0 +1,225 @@ +.. _cisco.nxos.nxos_vsan_module: + + +******************** +cisco.nxos.nxos_vsan +******************** + +**Configuration of vsan for Cisco NXOS MDS Switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Configuration of vsan for Cisco MDS NXOS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ vsan + +
+ list + / elements=dictionary +
+ 		+ +
List of vsan details to be added or removed
+
+
+ id + +
+ integer + / required +
+ 		+ +
Vsan id
+
+
+ interface + +
+ list + / elements=string +
+ 		+ +
List of vsan's interfaces to be added
+
+
+ name + +
+ string +
+ 		+ +
Name of the vsan
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Removes the vsan if True
+
+
+ suspend + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
suspend the vsan if True
+
+
+ + +Notes +----- + +.. note:: + - Tested against Cisco MDS NX-OS 8.4(1) + + + +Examples +-------- + +.. code-block:: yaml + + - name: Test that vsan module works + cisco.nxos.nxos_vsan: + vsan: + - id: 922 + interface: + - fc1/1 + - fc1/2 + - port-channel 1 + name: vsan-SAN-A + remove: false + suspend: false + - id: 923 + interface: + - fc1/11 + - fc1/21 + - port-channel 2 + name: vsan-SAN-B + remove: false + suspend: true + - id: 1923 + name: vsan-SAN-Old + remove: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['terminal dont-ask', 'vsan database', 'vsan 922 interface fc1/40', 'vsan 922 interface port-channel 155', 'no terminal dont-ask']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) diff --git a/docs/cisco.nxos.nxos_vxlan_vtep_module.rst b/docs/cisco.nxos.nxos_vxlan_vtep_module.rst new file mode 100644 index 000000000..57fdc14a3 --- /dev/null +++ b/docs/cisco.nxos.nxos_vxlan_vtep_module.rst @@ -0,0 +1,332 @@ +.. _cisco.nxos.nxos_vxlan_vtep_module: + + +************************** +cisco.nxos.nxos_vxlan_vtep +************************** + +**Manages VXLAN Network Virtualization Endpoint (NVE).** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages VXLAN Network Virtualization Endpoint (NVE) overlay interface that terminates VXLAN tunnels. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ advertise_virtual_rmac + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
The advertise_virtual_rmac parameter lets BGP to use the VMAC with VIP as next-hop when advertising type-2 routes. Should be used together with advertise_pip parameter from cisco.nxos.nxos_bgp_address_family module.
+
+
+ description + +
+ string +
+ 		+ +
Description of the NVE interface.
+
+
+ global_ingress_replication_bgp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configures ingress replication protocol as bgp for all VNIs. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
+
+
+ global_mcast_group_L2 + +
+ string +
+ 		+ +
Global multicast IP prefix for L2 VNIs or the keyword 'default'. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
+
+
+ global_mcast_group_L3 + +
+ string +
+ 		+ +
Global multicast IP prefix for L3 VNIs or the keyword 'default'. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
+
+
+ global_suppress_arp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables ARP suppression for all VNIs. This is available on NX-OS 9K series running 9.2.x or higher.
+
+
+ host_reachability + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specify mechanism for host reachability advertisement. A Boolean value of 'true' indicates that BGP will be used for host reachability advertisement. A Boolean value of 'false' indicates that no protocol is used for host reachability advertisement. Other host reachability advertisement protocols (e.g. OpenFlow, controller, etc.) are not supported.
+
+
+ interface + +
+ string + / required +
+ 		+ +
Interface name for the VXLAN Network Virtualization Endpoint.
+
+
+ multisite_border_gateway_interface + +
+ string +
+
added in 1.1.0
+ 		+ +
Specify the loopback interface whose IP address should be used for the NVE Multisite Border-gateway Interface. This is available on specific Nexus 9000 series switches running NX-OS 7.0(3)I7(x) or higher. Specify "default" to remove an existing gateway config.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown the NVE interface.
+
+
+ source_interface + +
+ string +
+ 		+ +
Specify the loopback interface whose IP address should be used for the NVE interface.
+
+
+ source_interface_hold_down_time + +
+ string +
+ 		+ +
Suppresses advertisement of the NVE loopback address until the overlay has converged.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Determines whether the config should be present or not on the device.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - The module is used to manage NVE properties, not to create NVE interfaces. Use :ref:`cisco.nxos.nxos_interfaces ` if you wish to do so. + - ``state=absent`` removes the interface. + - Default, where supported, restores params default value. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_vxlan_vtep: + interface: nve1 + description: default + host_reachability: true + source_interface: Loopback0 + source_interface_hold_down_time: 30 + shutdown: default + multisite_border_gateway_interface: Loopback0 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['interface nve1', 'source-interface loopback0', 'source-interface hold-down-time 30', 'description simple description', 'shutdown', 'host-reachability protocol bgp', 'multisite border-gateway interface loopback0']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_zone_zoneset_module.rst b/docs/cisco.nxos.nxos_zone_zoneset_module.rst new file mode 100644 index 000000000..95ef4972a --- /dev/null +++ b/docs/cisco.nxos.nxos_zone_zoneset_module.rst @@ -0,0 +1,537 @@ +.. _cisco.nxos.nxos_zone_zoneset_module: + + +**************************** +cisco.nxos.nxos_zone_zoneset +**************************** + +**Configuration of zone/zoneset for Cisco NXOS MDS Switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Configuration of zone/zoneset for Cisco MDS NXOS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ zone_zoneset_details + +
+ list + / elements=dictionary +
+ 		+ +
List of zone/zoneset details to be added or removed
+
+
+ default_zone + +
+ string +
+ 		+
    Choices: +
  • permit
    • +
  • deny
    • +
+ 		+
default zone behaviour for the vsan
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • enhanced
    • +
  • basic
    • +
+ 		+
mode of the zone for the vsan
+
+
+ smart_zoning + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Removes the vsan if True
+
+
+ vsan + +
+ integer + / required +
+ 		+ +
vsan id
+
+
+ zone + +
+ list + / elements=dictionary +
+ 		+ +
List of zone options for that vsan
+
+
+ members + +
+ list + / elements=dictionary +
+ 		+ +
Members of the zone that needs to be removed or added
+
+
+ devtype + +
+ string +
+ 		+
    Choices: +
  • initiator
    • +
  • target
    • +
  • both
    • +
+ 		+
devtype of the zone member used along with Smart zoning config
+
+
+ pwwn + +
+ string + / required +
+ 		+ +
pwwn member of the zone, use alias 'device_alias' as option for device_alias member
+

aliases: device_alias
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Removes member from the zone if True
+
+
+ name + +
+ string + / required +
+ 		+ +
name of the zone
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Deletes the zone if True
+
+
+ zoneset + +
+ list + / elements=dictionary +
+ 		+ +
List of zoneset options for the vsan
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • activate
    • +
  • deactivate
    • +
+ 		+
activates/de-activates the zoneset
+
+
+ members + +
+ list + / elements=dictionary +
+ 		+ +
Members of the zoneset that needs to be removed or added
+
+
+ name + +
+ string + / required +
+ 		+ +
name of the zone that needs to be added to the zoneset or removed from the zoneset
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Removes zone member from the zoneset
+
+
+ name + +
+ string + / required +
+ 		+ +
name of the zoneset
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Removes zoneset if True
+
+
+ + +Notes +----- + +.. note:: + - Tested against Cisco MDS NX-OS 8.4(1) + + + +Examples +-------- + +.. code-block:: yaml + + - name: Test that zone/zoneset module works + cisco.nxos.nxos_zone_zoneset: + zone_zoneset_details: + - mode: enhanced + vsan: 22 + zone: + - members: + - pwwn: 31314874576271 + - device_alias: test123 + - pwwn: '61:61:62:62:12:12:12:12' + remove: true + name: zoneA + - members: + - pwwn: 28515514576271 + - pwwn: '62:62:62:62:21:21:21:21' + name: zoneB + - name: zoneC + remove: true + zoneset: + - action: activate + members: + - name: zoneA + - name: zoneB + - name: zoneC + remove: true + name: zsetname1 + - action: deactivate + name: zsetTestExtra + remove: true + - mode: basic + smart_zoning: true + vsan: 21 + zone: + - members: + - devtype: both + pwwn: 31314874576271 + - pwwn: '62:62:62:62:12:12:12:12' + - devtype: both + pwwn: '92:62:62:62:12:12:1a:1a' + remove: true + name: zone21A + - members: + - pwwn: 28515514576271 + - pwwn: '62:62:62:62:21:21:21:21' + name: zone21B + zoneset: + - action: activate + members: + - name: zone21A + - name: zone21B + name: zsetname212 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['terminal dont-ask', 'zone name zoneA vsan 923', 'member pwwn 11:11:11:11:11:11:11:11', 'no member device-alias test123', 'zone commit vsan 923', 'no terminal dont-ask']
+
+
+ messages + +
+ list +
+ 		always +
debug messages
+
+
Sample:
+
['zone mode is already enhanced ,no change in zone mode configuration for vsan 922', "zone member '11:11:11:11:11:11:11:11' is already present in zone 'zoneA' in vsan 922 hence nothing to add", "zone member 'test123' is already present in zone 'zoneA' in vsan 922 hence nothing to add", "zone member '61:61:62:62:12:12:12:12' is not present in zone 'zoneA' in vsan 922 hence nothing to remove", "zone member '10:11:11:11:11:11:11:11' is already present in zone 'zoneB' in vsan 922 hence nothing to add", "zone member '62:62:62:62:21:21:21:21' is already present in zone 'zoneB' in vsan 922 hence nothing to add", "zone 'zoneC' is not present in vsan 922 , so nothing to remove"]
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) diff --git a/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py index 602d5a6f4..0c8604dd0 100644 --- a/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py @@ -5,6 +5,7 @@ from __future__ import absolute_import, division, print_function + __metaclass__ = type ############################################# @@ -29,8 +30,7 @@ class Spanning_tree_globalArgs(object): # pylint: disable=R0903 - """The arg spec for the nxos_spanning_tree_global module - """ + """The arg spec for the nxos_spanning_tree_global module""" argument_spec = { "config": { @@ -51,7 +51,7 @@ class Spanning_tree_globalArgs(object): # pylint: disable=R0903 "root": { "type": "dict", "mutually_exclusive": [ - ["primary", "secondary"] + ["primary", "secondary"], ], "options": { "primary": { diff --git a/plugins/modules/nxos_spanning_tree_global.py b/plugins/modules/nxos_spanning_tree_global.py index fc4066fc6..f8297eca1 100644 --- a/plugins/modules/nxos_spanning_tree_global.py +++ b/plugins/modules/nxos_spanning_tree_global.py @@ -10,20 +10,20 @@ from __future__ import absolute_import, division, print_function + __metaclass__ = type DOCUMENTATION = """ module: nxos_spanning_tree_global -short_description: - - Resource module to configure spanning tree. +short_description: Resource module to configure spanning tree. description: - - This module configures and manages the attributes of Spanning-tree on Cisco NXOS. +- This module configures and manages the attributes of Spanning-tree on Cisco NXOS. version_added: 6.0.3 author: Vinay Mulugund (@roverflow) notes: - - Tested against NX-OS 9.3.6. - - This module works with connection C(network_cli) and C(httpapi). - See U(https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html) +- Tested against NX-OS 9.3.6 on Cisco Nexus Switches. +- This module works with connection C(network_cli) and C(httpapi). +- Tested against Cisco MDS NX-OS 9.2(2) with connection C(network_cli). options: config: description: A dict of Spanning-tree options. @@ -379,6 +379,7 @@ """ from ansible.module_utils.basic import AnsibleModule + from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.argspec.spanning_tree_global.spanning_tree_global import ( Spanning_tree_globalArgs, ) From 7018345fdfa405957b0ae3ba4fd129d97a5973c2 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 7 Mar 2024 14:16:25 +0000 Subject: [PATCH 11/30] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- ...cisco.nxos.nxos_aaa_server_host_module.rst | 343 - docs/cisco.nxos.nxos_aaa_server_module.rst | 248 - .../cisco.nxos.nxos_acl_interfaces_module.rst | 610 -- docs/cisco.nxos.nxos_acls_module.rst | 4086 ------------ docs/cisco.nxos.nxos_banner_module.rst | 187 - docs/cisco.nxos.nxos_bfd_global_module.rst | 326 - .../cisco.nxos.nxos_bfd_interfaces_module.rst | 394 -- docs/cisco.nxos.nxos_bgp_global_module.rst | 5843 ----------------- ...xos_bgp_neighbor_address_family_module.rst | 3575 ---------- docs/cisco.nxos.nxos_bgp_templates_module.rst | 2841 -------- docs/cisco.nxos.nxos_command_module.rst | 258 - docs/cisco.nxos.nxos_config_module.rst | 566 -- docs/cisco.nxos.nxos_devicealias_module.rst | 273 - docs/cisco.nxos.nxos_evpn_global_module.rst | 122 - docs/cisco.nxos.nxos_evpn_vni_module.rst | 212 - docs/cisco.nxos.nxos_facts_module.rst | 553 -- docs/cisco.nxos.nxos_feature_module.rst | 150 - docs/cisco.nxos.nxos_gir_module.rst | 302 - ...xos.nxos_gir_profile_management_module.rst | 235 - docs/cisco.nxos.nxos_hostname_module.rst | 344 - ...cisco.nxos.nxos_hsrp_interfaces_module.rst | 344 - docs/cisco.nxos.nxos_hsrp_module.rst | 305 - docs/cisco.nxos.nxos_igmp_module.rst | 191 - docs/cisco.nxos.nxos_igmp_snooping_module.rst | 225 - docs/cisco.nxos.nxos_install_os_module.rst | 183 - docs/cisco.nxos.nxos_l2_interfaces_module.rst | 648 -- docs/cisco.nxos.nxos_l3_interfaces_module.rst | 884 --- docs/cisco.nxos.nxos_lacp_module.rst | 402 -- ...cisco.nxos.nxos_lldp_interfaces_module.rst | 407 -- docs/cisco.nxos.nxos_logging_module.rst | 458 -- docs/cisco.nxos.nxos_ntp_auth_module.rst | 224 - docs/cisco.nxos.nxos_ntp_global_module.rst | 1411 ---- docs/cisco.nxos.nxos_ntp_module.rst | 314 - docs/cisco.nxos.nxos_ntp_options_module.rst | 192 - docs/cisco.nxos.nxos_nxapi_module.rst | 300 - ...cisco.nxos.nxos_ospf_interfaces_module.rst | 1732 ----- docs/cisco.nxos.nxos_ospfv2_module.rst | 5458 --------------- .../cisco.nxos.nxos_overlay_global_module.rst | 120 - docs/cisco.nxos.nxos_pim_module.rst | 148 - docs/cisco.nxos.nxos_ping_module.rst | 311 - docs/cisco.nxos.nxos_prefix_lists_module.rst | 1049 --- docs/cisco.nxos.nxos_reboot_module.rst | 123 - docs/cisco.nxos.nxos_rollback_module.rst | 159 - docs/cisco.nxos.nxos_route_maps_module.rst | 4368 ------------ docs/cisco.nxos.nxos_rpm_module.rst | 226 - docs/cisco.nxos.nxos_snapshot_module.rst | 363 - .../cisco.nxos.nxos_snmp_community_module.rst | 201 - docs/cisco.nxos.nxos_snmp_host_module.rst | 288 - docs/cisco.nxos.nxos_snmp_location_module.rst | 156 - docs/cisco.nxos.nxos_snmp_server_module.rst | 4474 ------------- docs/cisco.nxos.nxos_snmp_traps_module.rst | 189 - docs/cisco.nxos.nxos_snmp_user_module.rst | 235 - .../cisco.nxos.nxos_udld_interface_module.rst | 250 - docs/cisco.nxos.nxos_udld_module.rst | 256 - docs/cisco.nxos.nxos_user_module.rst | 390 -- docs/cisco.nxos.nxos_vpc_module.rst | 352 - docs/cisco.nxos.nxos_vrf_af_module.rst | 300 - docs/cisco.nxos.nxos_vrf_module.rst | 494 -- docs/cisco.nxos.nxos_vrrp_module.rst | 277 - docs/cisco.nxos.nxos_vsan_module.rst | 225 - docs/cisco.nxos.nxos_vxlan_vtep_module.rst | 332 - docs/cisco.nxos.nxos_zone_zoneset_module.rst | 537 -- 62 files changed, 50969 deletions(-) delete mode 100644 docs/cisco.nxos.nxos_aaa_server_host_module.rst delete mode 100644 docs/cisco.nxos.nxos_aaa_server_module.rst delete mode 100644 docs/cisco.nxos.nxos_acl_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_acls_module.rst delete mode 100644 docs/cisco.nxos.nxos_banner_module.rst delete mode 100644 docs/cisco.nxos.nxos_bfd_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_bfd_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_bgp_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst delete mode 100644 docs/cisco.nxos.nxos_bgp_templates_module.rst delete mode 100644 docs/cisco.nxos.nxos_command_module.rst delete mode 100644 docs/cisco.nxos.nxos_config_module.rst delete mode 100644 docs/cisco.nxos.nxos_devicealias_module.rst delete mode 100644 docs/cisco.nxos.nxos_evpn_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_evpn_vni_module.rst delete mode 100644 docs/cisco.nxos.nxos_facts_module.rst delete mode 100644 docs/cisco.nxos.nxos_feature_module.rst delete mode 100644 docs/cisco.nxos.nxos_gir_module.rst delete mode 100644 docs/cisco.nxos.nxos_gir_profile_management_module.rst delete mode 100644 docs/cisco.nxos.nxos_hostname_module.rst delete mode 100644 docs/cisco.nxos.nxos_hsrp_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_hsrp_module.rst delete mode 100644 docs/cisco.nxos.nxos_igmp_module.rst delete mode 100644 docs/cisco.nxos.nxos_igmp_snooping_module.rst delete mode 100644 docs/cisco.nxos.nxos_install_os_module.rst delete mode 100644 docs/cisco.nxos.nxos_l2_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_l3_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_lacp_module.rst delete mode 100644 docs/cisco.nxos.nxos_lldp_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_logging_module.rst delete mode 100644 docs/cisco.nxos.nxos_ntp_auth_module.rst delete mode 100644 docs/cisco.nxos.nxos_ntp_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_ntp_module.rst delete mode 100644 docs/cisco.nxos.nxos_ntp_options_module.rst delete mode 100644 docs/cisco.nxos.nxos_nxapi_module.rst delete mode 100644 docs/cisco.nxos.nxos_ospf_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_ospfv2_module.rst delete mode 100644 docs/cisco.nxos.nxos_overlay_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_pim_module.rst delete mode 100644 docs/cisco.nxos.nxos_ping_module.rst delete mode 100644 docs/cisco.nxos.nxos_prefix_lists_module.rst delete mode 100644 docs/cisco.nxos.nxos_reboot_module.rst delete mode 100644 docs/cisco.nxos.nxos_rollback_module.rst delete mode 100644 docs/cisco.nxos.nxos_route_maps_module.rst delete mode 100644 docs/cisco.nxos.nxos_rpm_module.rst delete mode 100644 docs/cisco.nxos.nxos_snapshot_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_community_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_host_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_location_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_server_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_traps_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_user_module.rst delete mode 100644 docs/cisco.nxos.nxos_udld_interface_module.rst delete mode 100644 docs/cisco.nxos.nxos_udld_module.rst delete mode 100644 docs/cisco.nxos.nxos_user_module.rst delete mode 100644 docs/cisco.nxos.nxos_vpc_module.rst delete mode 100644 docs/cisco.nxos.nxos_vrf_af_module.rst delete mode 100644 docs/cisco.nxos.nxos_vrf_module.rst delete mode 100644 docs/cisco.nxos.nxos_vrrp_module.rst delete mode 100644 docs/cisco.nxos.nxos_vsan_module.rst delete mode 100644 docs/cisco.nxos.nxos_vxlan_vtep_module.rst delete mode 100644 docs/cisco.nxos.nxos_zone_zoneset_module.rst diff --git a/docs/cisco.nxos.nxos_aaa_server_host_module.rst b/docs/cisco.nxos.nxos_aaa_server_host_module.rst deleted file mode 100644 index 5730e6359..000000000 --- a/docs/cisco.nxos.nxos_aaa_server_host_module.rst +++ /dev/null @@ -1,343 +0,0 @@ -.. _cisco.nxos.nxos_aaa_server_host_module: - - -******************************* -cisco.nxos.nxos_aaa_server_host -******************************* - -**Manages AAA server host-specific configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages AAA server host-specific configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- acct_port - -
- string -
- 		- -
Alternate UDP port for RADIUS accounting or keyword 'default'.
-
-
- address - -
- string - / required -
- 		- -
Address or name of the radius or tacacs host.
-
-
- auth_port - -
- string -
- 		- -
Alternate UDP port for RADIUS authentication or keyword 'default'.
-
-
- encrypt_type - -
- string -
- 		-
    Choices: -
  • 0
    • -
  • 7
    • -
- 		-
The state of encryption applied to the entered key. O for clear text, 7 for encrypted. Type-6 encryption is not supported.
-
-
- host_timeout - -
- string -
- 		- -
Timeout period for specified host, in seconds or keyword 'default. Range is 1-60.
-
-
- key - -
- string -
- 		- -
Shared secret for the specified host or keyword 'default'.
-
-
- server_type - -
- string - / required -
- 		-
    Choices: -
  • radius
    • -
  • tacacs
    • -
- 		-
The server type is either radius or tacacs.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- tacacs_port - -
- string -
- 		- -
Alternate TCP port TACACS Server or keyword 'default'.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - Changes to the host key (shared secret) are not idempotent for type 0. - - If ``state=absent`` removes the whole host configuration. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Radius Server Host Basic settings - - name: Radius Server Host Basic settings - cisco.nxos.nxos_aaa_server_host: - state: present - server_type: radius - address: 1.2.3.4 - acct_port: 2084 - host_timeout: 10 - - # Radius Server Host Key Configuration - - name: Radius Server Host Key Configuration - cisco.nxos.nxos_aaa_server_host: - state: present - server_type: radius - address: 1.2.3.4 - key: hello - encrypt_type: 7 - - # TACACS Server Host Configuration - - name: Tacacs Server Host Configuration - cisco.nxos.nxos_aaa_server_host: - state: present - server_type: tacacs - tacacs_port: 89 - host_timeout: 10 - address: 5.6.7.8 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- end_state - -
- dictionary -
- 		always -
k/v pairs of configuration after module execution
-
-
Sample:
-
{'address': '1.2.3.4', 'auth_port': '2084', 'host_timeout': '10', 'server_type': 'radius'}
-
-
- existing - -
- dictionary -
- 		always -
k/v pairs of existing configuration
-
-
-
- proposed - -
- dictionary -
- 		always -
k/v pairs of parameters passed into module
-
-
Sample:
-
{'address': '1.2.3.4', 'auth_port': '2084', 'host_timeout': '10', 'server_type': 'radius'}
-
-
- updates - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['radius-server host 1.2.3.4 auth-port 2084 timeout 10']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_aaa_server_module.rst b/docs/cisco.nxos.nxos_aaa_server_module.rst deleted file mode 100644 index 1307c9033..000000000 --- a/docs/cisco.nxos.nxos_aaa_server_module.rst +++ /dev/null @@ -1,248 +0,0 @@ -.. _cisco.nxos.nxos_aaa_server_module: - - -************************** -cisco.nxos.nxos_aaa_server -************************** - -**Manages AAA server global configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages AAA server global configuration - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- deadtime - -
- string -
- 		- -
Duration for which a non-reachable AAA server is skipped, in minutes or keyword 'default. Range is 1-1440. Device default is 0.
-
-
- directed_request - -
- string -
- 		-
    Choices: -
  • enabled
    • -
  • disabled
    • -
  • default
    • -
- 		-
Enables direct authentication requests to AAA server or keyword 'default' Device default is disabled.
-
-
- encrypt_type - -
- string -
- 		-
    Choices: -
  • 0
    • -
  • 7
    • -
- 		-
The state of encryption applied to the entered global key. O clear text, 7 encrypted. Type-6 encryption is not supported.
-
-
- global_key - -
- string -
- 		- -
Global AAA shared secret or keyword 'default'.
-
-
- server_timeout - -
- string -
- 		- -
Global AAA server timeout period, in seconds or keyword 'default. Range is 1-60. Device default is 5.
-
-
- server_type - -
- string - / required -
- 		-
    Choices: -
  • radius
    • -
  • tacacs
    • -
- 		-
The server type is either radius or tacacs.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • default
    • -
- 		-
Manage the state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - The server_type parameter is always required. - - If encrypt_type is not supplied, the global AAA server key will be stored as encrypted (type 7). - - Changes to the global AAA server key with encrypt_type=0 are not idempotent. - - state=default will set the supplied parameters to their default values. The parameters that you want to default must also be set to default. If global_key=default, the global key will be removed. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Radius Server Basic settings - - name: Radius Server Basic settings - cisco.nxos.nxos_aaa_server: - server_type: radius - server_timeout: 9 - deadtime: 20 - directed_request: enabled - - # Tacacs Server Basic settings - - name: Tacacs Server Basic settings - cisco.nxos.nxos_aaa_server: - server_type: tacacs - server_timeout: 8 - deadtime: 19 - directed_request: disabled - - # Setting Global Key - - name: AAA Server Global Key - cisco.nxos.nxos_aaa_server: - server_type: radius - global_key: test_key - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['radius-server deadtime 22', 'radius-server timeout 11', 'radius-server directed-request']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_acl_interfaces_module.rst b/docs/cisco.nxos.nxos_acl_interfaces_module.rst deleted file mode 100644 index a2885df02..000000000 --- a/docs/cisco.nxos.nxos_acl_interfaces_module.rst +++ /dev/null @@ -1,610 +0,0 @@ -.. _cisco.nxos.nxos_acl_interfaces_module: - - -****************************** -cisco.nxos.nxos_acl_interfaces -****************************** - -**ACL interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Add and remove Access Control Lists on interfaces in NX-OS platform - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of interfaces to be configured with ACLs
-
-
- access_groups - -
- list - / elements=dictionary -
- 		- -
List of address family indicators with ACLs to be configured on the interface
-
-
- acls - -
- list - / elements=dictionary -
- 		- -
List of Access Control Lists for the interface
-
-
- direction - -
- string - / required -
- 		-
    Choices: -
  • in
    • -
  • out
    • -
- 		-
Direction to be applied for the ACL
-
-
- name - -
- string - / required -
- 		- -
Name of the ACL to be added/removed
-
-
- port - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use ACL as port policy.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
Address Family Indicator of the ACLs to be configured
-
-
- name - -
- string - / required -
- 		- -
Name of the interface
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • deleted
    • -
  • gathered
    • -
  • merged ←
    • -
  • overridden
    • -
  • rendered
    • -
  • replaced
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------ - # - - - name: Merge ACL interfaces configuration - cisco.nxos.nxos_acl_interfaces: - config: - - name: Ethernet1/2 - access_groups: - - afi: ipv6 - acls: - - name: ACL1v6 - direction: in - - - name: Eth1/5 - access_groups: - - afi: ipv4 - acls: - - name: PortACL - direction: in - port: true - - - name: ACL1v4 - direction: out - - - afi: ipv6 - acls: - - name: ACL1v6 - direction: in - state: merged - - # After state: - # ------------ - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ip port access-group PortACL in - # ip access-group ACL1v4 out - # ipv6 traffic-filter ACL1v6 in - - # Using replaced - - # Before state: - # ------------ - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ip port access-group PortACL in - # ip access-group ACL1v4 out - # ipv6 traffic-filter ACL1v6 in - - - name: Replace interface configuration with given configuration - cisco.nxos.nxos_acl_interfaces: - config: - - name: Eth1/5 - access_groups: - - afi: ipv4 - acls: - - name: NewACLv4 - direction: out - - - name: Ethernet1/3 - access_groups: - - afi: ipv6 - acls: - - name: NewACLv6 - direction: in - port: true - state: replaced - - # After state: - # ------------ - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/3 - # ipv6 port traffic-filter NewACLv6 in - # interface Ethernet1/5 - # ip access-group NewACLv4 out - - # Using overridden - - # Before state: - # ------------ - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ip port access-group PortACL in - # ip access-group ACL1v4 out - # ipv6 traffic-filter ACL1v6 in - - - name: Override interface configuration with given configuration - cisco.nxos.nxos_acl_interfaces: - config: - - name: Ethernet1/3 - access_groups: - - afi: ipv4 - acls: - - name: ACL1v4 - direction: out - - - name: PortACL - port: true - direction: in - - afi: ipv6 - acls: - - name: NewACLv6 - direction: in - port: true - state: overridden - - # After state: - # ------------ - # interface Ethernet1/3 - # ip access-group ACL1v4 out - # ip port access-group PortACL in - # ipv6 port traffic-filter NewACLv6 in - - # Using deleted to remove ACL config from specified interfaces - - # Before state: - # ------------- - # interface Ethernet1/1 - # ip access-group ACL2v4 in - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ip port access-group PortACL in - # ip access-group ACL1v4 out - # ipv6 traffic-filter ACL1v6 in - - - name: Delete ACL configuration on interfaces - cisco.nxos.nxos_acl_interfaces: - config: - - name: Ethernet1/5 - - name: Ethernet1/2 - state: deleted - - # After state: - # ------------- - # interface Ethernet1/1 - # ip access-group ACL2v4 in - # interface Ethernet1/2 - # interface Ethernet1/5 - - # Using deleted to remove ACL config from all interfaces - - # Before state: - # ------------- - # interface Ethernet1/1 - # ip access-group ACL2v4 in - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ip port access-group PortACL in - # ip access-group ACL1v4 out - # ipv6 traffic-filter ACL1v6 in - - - name: Delete ACL configuration from all interfaces - cisco.nxos.nxos_acl_interfaces: - state: deleted - - # After state: - # ------------- - # interface Ethernet1/1 - # interface Ethernet1/2 - # interface Ethernet1/5 - - # Using parsed - - - name: Parse given configuration into structured format - cisco.nxos.nxos_acl_interfaces: - running_config: | - interface Ethernet1/2 - ipv6 traffic-filter ACL1v6 in - interface Ethernet1/5 - ipv6 traffic-filter ACL1v6 in - ip access-group ACL1v4 out - ip port access-group PortACL in - state: parsed - - # returns - # parsed: - # - name: Ethernet1/2 - # access_groups: - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # direction: in - # - name: Ethernet1/5 - # access_groups: - # - afi: ipv4 - # acls: - # - name: PortACL - # direction: in - # port: True - # - name: ACL1v4 - # direction: out - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # direction: in - - - # Using gathered: - - # Before state: - # ------------ - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ipv6 traffic-filter ACL1v6 in - # ip access-group ACL1v4 out - # ip port access-group PortACL in - - - name: Gather existing configuration from device - cisco.nxos.nxos_acl_interfaces: - config: - state: gathered - - # returns - # gathered: - # - name: Ethernet1/2 - # access_groups: - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # direction: in - # - name: Ethernet1/5 - # access_groups: - # - afi: ipv4 - # acls: - # - name: PortACL - # direction: in - # port: True - # - name: ACL1v4 - # direction: out - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # direction: in - - - # Using rendered - - - name: Render required configuration to be pushed to the device - cisco.nxos.nxos_acl_interfaces: - config: - - name: Ethernet1/2 - access_groups: - - afi: ipv6 - acls: - - name: ACL1v6 - direction: in - - name: Ethernet1/5 - access_groups: - - afi: ipv4 - acls: - - name: PortACL - direction: in - port: true - - name: ACL1v4 - direction: out - - afi: ipv6 - acls: - - name: ACL1v6 - direction: in - state: rendered - - - # returns - # rendered: - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ipv6 traffic-filter ACL1v6 in - # ip access-group ACL1v4 out - # ip port access-group PortACL in - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/2', 'ipv6 traffic-filter ACL1v6 out', 'ip port access-group PortACL in']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_acls_module.rst b/docs/cisco.nxos.nxos_acls_module.rst deleted file mode 100644 index 1b806511d..000000000 --- a/docs/cisco.nxos.nxos_acls_module.rst +++ /dev/null @@ -1,4086 +0,0 @@ -.. _cisco.nxos.nxos_acls_module: - - -******************** -cisco.nxos.nxos_acls -******************** - -**ACLs resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manage named IP ACLs on the Cisco NX-OS platform - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A dictionary of ACL options.
-
-
- acls - -
- list - / elements=dictionary -
- 		- -
A list of the ACLs.
-
-
- aces - -
- list - / elements=dictionary -
- 		- -
The entries within the ACL.
-
-
- destination - -
- dictionary -
- 		- -
Specify the packet destination.
-
-
- address - -
- string -
- 		- -
Destination network address.
-
-
- any - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Any destination address.
-
-
- host - -
- string -
- 		- -
Host IP address.
-
-
- port_protocol - -
- dictionary -
- 		- -
Specify the destination port or protocol (only for TCP and UDP).
-
-
- eq - -
- string -
- 		- -
Match only packets on a given port number.
-
-
- gt - -
- string -
- 		- -
Match only packets with a greater port number.
-
-
- lt - -
- string -
- 		- -
Match only packets with a lower port number.
-
-
- neq - -
- string -
- 		- -
Match only packets not on a given port number.
-
-
- range - -
- dictionary -
- 		- -
Match only packets in the range of port numbers.
-
-
- end - -
- string -
- 		- -
Specify the end of the port range.
-
-
- start - -
- string -
- 		- -
Specify the start of the port range.
-
-
- prefix - -
- string -
- 		- -
Destination network prefix. Only for prefixes of value less than 31 for ipv4 and 127 for ipv6. Prefixes of 32 (ipv4) and 128 (ipv6) should be given in the 'host' key.
-
-
- wildcard_bits - -
- string -
- 		- -
Destination wildcard bits.
-
-
- dscp - -
- string -
- 		- -
Match packets with given DSCP value.
-
-
- fragments - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Check non-initial fragments.
-
-
- grant - -
- string -
- 		-
    Choices: -
  • permit
    • -
  • deny
    • -
- 		-
Action to be applied on the rule.
-
-
- log - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Log matches against this entry.
-
-
- precedence - -
- string -
- 		- -
Match packets with given precedence value.
-
-
- protocol - -
- string -
- 		- -
Specify the protocol.
-
-
- protocol_options - -
- dictionary -
- 		- -
All possible suboptions for the protocol chosen.
-
-
- icmp - -
- dictionary -
- 		- -
ICMP protocol options.
-
-
- administratively_prohibited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively prohibited
-
-
- alternate_address - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Alternate address
-
-
- conversion_error - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Datagram conversion
-
-
- dod_host_prohibited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host prohibited
-
-
- dod_net_prohibited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Net prohibited
-
-
- echo - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo (ping)
-
-
- echo_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo reply
-
-
- echo_request - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo request (ping)
-
-
- general_parameter_problem - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter problem
-
-
- host_isolated - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host isolated
-
-
- host_precedence_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host unreachable for precedence
-
-
- host_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host redirect
-
-
- host_tos_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host redirect for TOS
-
-
- host_tos_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host unreachable for TOS
-
-
- host_unknown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host unknown
-
-
- host_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host unreachable
-
-
- information_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Information replies
-
-
- information_request - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Information requests
-
-
- mask_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Mask replies
-
-
- mask_request - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Mask requests
-
-
- message_code - -
- integer -
- 		- -
ICMP message code
-
-
- message_type - -
- integer -
- 		- -
ICMP message type
-
-
- mobile_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Mobile host redirect
-
-
- net_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Network redirect
-
-
- net_tos_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Net redirect for TOS
-
-
- net_tos_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Network unreachable for TOS
-
-
- net_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Net unreachable
-
-
- network_unknown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Network unknown
-
-
- no_room_for_option - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter required but no room
-
-
- option_missing - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter required but not present
-
-
- packet_too_big - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Fragmentation needed and DF set
-
-
- parameter_problem - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All parameter problems
-
-
- port_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Port unreachable
-
-
- precedence_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Precedence cutoff
-
-
- protocol_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Protocol unreachable
-
-
- reassembly_timeout - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Reassembly timeout
-
-
- redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All redirects
-
-
- router_advertisement - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router discovery advertisements
-
-
- router_solicitation - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router discovery solicitations
-
-
- source_quench - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Source quenches
-
-
- source_route_failed - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Source route failed
-
-
- time_exceeded - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All time exceeded.
-
-
- timestamp_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Timestamp replies
-
-
- timestamp_request - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Timestamp requests
-
-
- traceroute - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Traceroute
-
-
- ttl_exceeded - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
TTL exceeded
-
-
- unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All unreachables
-
-
- icmpv6 - -
- dictionary -
- 		- -
ICMPv6 protocol options.
-
-
- beyond_scope - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Destination beyond scope.
-
-
- destination_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Destination address is unreachable.
-
-
- echo_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo reply.
-
-
- echo_request - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo request (ping).
-
-
- fragments - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Check non-initial fragments.
-
-
- header - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter header problem.
-
-
- hop_limit - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Hop limit exceeded in transit.
-
-
- mld_query - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Multicast Listener Discovery Query.
-
-
- mld_reduction - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Multicast Listener Discovery Reduction.
-
-
- mld_report - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Multicast Listener Discovery Report.
-
-
- mldv2 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Multicast Listener Discovery Protocol.
-
-
- nd_na - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Neighbor discovery neighbor advertisements.
-
-
- nd_ns - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Neighbor discovery neighbor solicitations.
-
-
- next_header - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter next header problems.
-
-
- no_admin - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administration prohibited destination.
-
-
- no_route - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
No route to destination.
-
-
- packet_too_big - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Packet too big.
-
-
- parameter_option - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter option problems.
-
-
- parameter_problem - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All parameter problems.
-
-
- port_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Port unreachable.
-
-
- reassembly_timeout - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Reassembly timeout.
-
-
- renum_command - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router renumbering command.
-
-
- renum_result - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router renumbering result.
-
-
- renum_seq_number - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router renumbering sequence number reset.
-
-
- router_advertisement - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Neighbor discovery router advertisements.
-
-
- router_renumbering - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All router renumbering.
-
-
- router_solicitation - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Neighbor discovery router solicitations.
-
-
- telemetry_path - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IPT enabled.
-
-
- telemetry_queue - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flow of interest for BDC/HDC.
-
-
- time_exceeded - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All time exceeded.
-
-
- unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All unreachable.
-
-
- igmp - -
- dictionary -
- 		- -
IGMP protocol options.
-
-
- dvmrp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Distance Vector Multicast Routing Protocol
-
-
- host_query - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host Query
-
-
- host_report - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host Report
-
-
- tcp - -
- dictionary -
- 		- -
TCP flags.
-
-
- ack - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the ACK bit
-
-
- established - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match established connections
-
-
- fin - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the FIN bit
-
-
- psh - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the PSH bit
-
-
- rst - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the RST bit
-
-
- syn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the SYN bit
-
-
- urg - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the URG bit
-
-
- remark - -
- string -
- 		- -
Access list entry comment.
-
-
- sequence - -
- integer -
- 		- -
Sequence number.
-
-
- source - -
- dictionary -
- 		- -
Specify the packet source.
-
-
- address - -
- string -
- 		- -
Source network address.
-
-
- any - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Any source address.
-
-
- host - -
- string -
- 		- -
Host IP address.
-
-
- port_protocol - -
- dictionary -
- 		- -
Specify the destination port or protocol (only for TCP and UDP).
-
-
- eq - -
- string -
- 		- -
Match only packets on a given port number.
-
-
- gt - -
- string -
- 		- -
Match only packets with a greater port number.
-
-
- lt - -
- string -
- 		- -
Match only packets with a lower port number.
-
-
- neq - -
- string -
- 		- -
Match only packets not on a given port number.
-
-
- range - -
- dictionary -
- 		- -
Match only packets in the range of port numbers.
-
-
- end - -
- string -
- 		- -
Specify the end of the port range.
-
-
- start - -
- string -
- 		- -
Specify the start of the port range.
-
-
- prefix - -
- string -
- 		- -
Source network prefix. Only for prefixes of mask value less than 31 for ipv4 and 127 for ipv6. Prefixes of mask 32 (ipv4) and 128 (ipv6) should be given in the 'host' key.
-
-
- wildcard_bits - -
- string -
- 		- -
Source wildcard bits.
-
-
- name - -
- string - / required -
- 		- -
Name of the ACL.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
The Address Family Indicator (AFI) for the ACL.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section 'ip(v6* access-list).
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • deleted
    • -
  • gathered
    • -
  • merged ←
    • -
  • overridden
    • -
  • rendered
    • -
  • replaced
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - As NX-OS allows configuring a rule again with different sequence numbers, the user is expected to provide sequence numbers for the access control entries to preserve idempotency. If no sequence number is given, the rule will be added as a new rule by the device. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - - - name: Merge provided ACLs configuration with device configuration - cisco.nxos.nxos_acls: - state: merged - config: - - afi: ipv4 - acls: - - name: ACL1v4 - aces: - - grant: deny - destination: - address: 192.0.2.64 - wildcard_bits: 0.0.0.255 - source: - any: true - port_protocol: - lt: 55 - protocol: tcp - protocol_options: - tcp: - ack: true - fin: true - sequence: 50 - - - afi: ipv6 - acls: - - name: ACL1v6 - aces: - - grant: permit - sequence: 10 - source: - any: true - destination: - prefix: 2001:db8:12::/32 - protocol: sctp - - # Task Output - # ----------- - # before: [] - # - # commands: - # - ip access-list ACL1v4 - # - 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin - # - ipv6 access-list ACL1v6 - # - 10 permit sctp any 2001:db8:12::/32 - # - # after: - # - acls: - # - aces: - # - destination: - # prefix: 2001:db8:12::/32 - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # name: ACL1v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # address: 192.0.2.64 - # wildcard_bits: 0.0.0.255 - # grant: deny - # protocol: tcp - # protocol_options: - # tcp: - # ack: true - # fin: true - # sequence: 50 - # source: - # any: true - # port_protocol: - # lt: '55' - # name: ACL1v4 - # afi: ipv4 - - - # After state: - # ------------ - # - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - - # Using replaced - - # Before state: - # ---------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 10 permit ip any any - # 20 deny udp any any - # ip access-list ACL2v4 - # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ipv6 access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - - name: Replace existing ACL configuration with provided configuration - cisco.nxos.nxos_acls: - config: - - afi: ipv4 - - afi: ipv6 - acls: - - name: ACL1v6 - aces: - - sequence: 20 - grant: permit - source: - any: true - destination: - any: true - protocol: pim - - - remark: Replaced ACE - - name: ACL2v6 - state: replaced - - # Task Output - # ----------- - # before: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ip - # sequence: 10 - # source: - # any: true - # - destination: - # any: true - # grant: deny - # protocol: udp - # sequence: 20 - # source: - # any: true - # name: ACL1v4 - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ahp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.0.255 - # name: ACL2v4 - # afi: ipv4 - # - # commands: - # - no ip access-list ACL1v4 - # - no ip access-list ACL2v4 - # - ipv6 access-list ACL1v6 - # - no 10 permit sctp any any - # - no 20 remark IPv6 ACL - # - remark Replaced ACE - # - 20 permit pim any any - # - ipv6 access-list ACL2v6 - # - no 10 deny ipv6 any 2001:db8:3000::/36 - # - no 20 permit tcp host 2001:db8:2000:2::2 host 2001:db8:2000:ab::2 - # - # after: - # - acls: - # - aces: - # - remark: Replaced ACE - # sequence: 10 - # - destination: - # any: true - # grant: permit - # protocol: pim - # sequence: 20 - # source: - # any: true - # name: ACL1v6 - # - name: ACL2v6 - # afi: ipv6 - - # After state: - # --------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ipv6 access-list ACL1v6 - # 10 remark Replaced ACE - # 20 permit pim any any - # ipv6 access-list ACL2v6 - - # Using overridden - - # Before state: - # ---------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 10 permit ip any any - # 20 deny udp any any - # ip access-list ACL2v4 - # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ipv6 access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - - name: Override existing configuration with provided configuration - cisco.nxos.nxos_acls: - config: - - afi: ipv4 - acls: - - name: NewACL - aces: - - grant: deny - source: - address: 192.0.2.0 - wildcard_bits: 0.0.255.255 - destination: - any: true - protocol: eigrp - - remark: Example for overridden state - state: overridden - - # Task Output - # ----------- - # - # before: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ip - # sequence: 10 - # source: - # any: true - # - destination: - # any: true - # grant: deny - # protocol: udp - # sequence: 20 - # source: - # any: true - # name: ACL1v4 - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ahp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.0.255 - # name: ACL2v4 - # afi: ipv4 - # - # commands: - # - no ipv6 access-list ACL1v6 - # - no ipv6 access-list ACL2v6 - # - no ip access-list ACL1v4 - # - no ip access-list ACL2v4 - # - ip access-list NewACL - # - deny eigrp 192.0.2.0 0.0.255.255 any - # - remark Example for overridden state - # - # after: - # - acls: - # - aces: - # - destination: - # any: true - # grant: deny - # protocol: eigrp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.255.255 - # - remark: Example for overridden state - # sequence: 20 - # name: NewACL - # afi: ipv4 - - # After state: - # ------------ - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list NewACL - # 10 deny eigrp 192.0.2.0 0.0.255.255 any - # 20 remark Example for overridden state - - # Using deleted - delete all - # - # Before state: - # ------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 10 permit ip any any - # 20 deny udp any any - # ip access-list ACL2v4 - # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ip access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ip access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - - name: Delete all ACLs - cisco.nxos.nxos_acls: - state: deleted - - # Task Output - # ----------- - # - # before: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ip - # sequence: 10 - # source: - # any: true - # - destination: - # any: true - # grant: deny - # protocol: udp - # sequence: 20 - # source: - # any: true - # name: ACL1v4 - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ahp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.0.255 - # name: ACL2v4 - # afi: ipv4 - # - # commands: - # - no ip access-list ACL1v4 - # - no ip access-list ACL2v4 - # - no ipv6 access-list ACL1v6 - # - no ipv6 access-list ACL2v6 - # - # after: [] - - - # After state: - # ----------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # - - # Using deleted - delete AFI - - # Before state: - # ------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 10 permit ip any any - # 20 deny udp any any - # ip access-list ACL2v4 - # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ip access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ip access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - - name: Delete all ACLs in given AFI - cisco.nxos.nxos_acls: - config: - - afi: ipv4 - state: deleted - - # Task Output - # ----------- - # - # before: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ip - # sequence: 10 - # source: - # any: true - # - destination: - # any: true - # grant: deny - # protocol: udp - # sequence: 20 - # source: - # any: true - # name: ACL1v4 - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ahp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.0.255 - # name: ACL2v4 - # afi: ipv4 - # - # commands: - # - no ip access-list ACL1v4 - # - no ip access-list ACL2v4 - # - # after: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - - # After state: - # ------------ - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ip access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - # Using deleted - delete ACLs - - # Before state: - # ------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 10 permit ip any any - # 20 deny udp any any - # ip access-list ACL2v4 - # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ipv6 access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - - name: Delete specific ACLs - cisco.nxos.nxos_acls: - state: deleted - config: - - afi: ipv4 - acls: - - name: ACL1v4 - - name: ACL2v4 - - afi: ipv6 - acls: - - name: ACL1v6 - - # Task Output - # ----------- - # - # before: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ip - # sequence: 10 - # source: - # any: true - # - destination: - # any: true - # grant: deny - # protocol: udp - # sequence: 20 - # source: - # any: true - # name: ACL1v4 - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ahp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.0.255 - # name: ACL2v4 - # afi: ipv4 - # - # commands: - # - no ip access-list ACL1v4 - # - no ip access-list ACL2v4 - # - no ipv6 access-list ACL1v6 - # - # after: - # - acls: - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - - # After state: - # ------------ - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ipv6 access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - # Using parsed - - - name: Parse given config to structured data - cisco.nxos.nxos_acls: - running_config: | - ip access-list ACL1v4 - 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin - ipv6 access-list ACL1v6 - 10 permit sctp any any - state: parsed - - # Task Output - # ------------ - # - # parsed: - # - afi: ipv4 - # acls: - # - name: ACL1v4 - # aces: - # - grant: deny - # destination: - # address: 192.0.2.64 - # wildcard_bits: 0.0.0.255 - # source: - # any: true - # port_protocol: - # lt: 55 - # protocol: tcp - # protocol_options: - # tcp: - # ack: true - # fin: true - # sequence: 50 - # - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # aces: - # - grant: permit - # sequence: 10 - # source: - # any: true - # destination: - # prefix: 2001:db8:12::/32 - # protocol: sctp - - - # Using gathered: - - # Before state: - # ------------ - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - - - name: Gather existing configuration - cisco.nxos.nxos_acls: - state: gathered - - # Task Output - # ----------- - # - # gathered: - # - afi: ipv4 - # acls: - # - name: ACL1v4 - # aces: - # - grant: deny - # destination: - # address: 192.0.2.64 - # wildcard_bits: 0.0.0.255 - # source: - # any: true - # port_protocol: - # lt: 55 - # protocol: tcp - # protocol_options: - # tcp: - # ack: true - # fin: true - # sequence: 50 - - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # aces: - # - grant: permit - # sequence: 10 - # source: - # any: true - # destination: - # prefix: 2001:db8:12::/32 - # protocol: sctp - - - # Using rendered - - - name: Render required configuration to be pushed to the device - cisco.nxos.nxos_acls: - config: - - afi: ipv4 - acls: - - name: ACL1v4 - aces: - - grant: deny - destination: - address: 192.0.2.64 - wildcard_bits: 0.0.0.255 - source: - any: true - port_protocol: - lt: 55 - protocol: tcp - protocol_options: - tcp: - ack: true - fin: true - sequence: 50 - - afi: ipv6 - acls: - - name: ACL1v6 - aces: - - grant: permit - sequence: 10 - source: - any: true - destination: - prefix: '2001:db8:12::/32' - protocol: sctp - state: rendered - - - # Task Output - # ----------- - # - # rendered: - # ip access-list ACL1v4 - # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['ip access-list ACL1v4', '10 permit ip any any precedence critical log', '20 deny tcp any lt smtp host 192.0.2.64 ack fin']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['ip access-list ACL1v4', '10 permit ip any any precedence critical log', '20 deny tcp any lt smtp host 192.0.2.64 ack fin']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_banner_module.rst b/docs/cisco.nxos.nxos_banner_module.rst deleted file mode 100644 index 7502173b7..000000000 --- a/docs/cisco.nxos.nxos_banner_module.rst +++ /dev/null @@ -1,187 +0,0 @@ -.. _cisco.nxos.nxos_banner_module: - - -********************** -cisco.nxos.nxos_banner -********************** - -**Manage multiline banners on Cisco NXOS devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This will configure both exec and motd banners on remote devices running Cisco NXOS. It allows playbooks to add or remove banner text from the active running configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- banner - -
- string - / required -
- 		-
    Choices: -
  • exec
    • -
  • motd
    • -
- 		-
Specifies which banner that should be configured on the remote device.
-
-
- multiline_delimiter - -
- string -
- 		- Default:
"@"
- 		-
Specify the delimiting character than will be used for configuration.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Specifies whether or not the configuration is present in the current devices active running configuration.
-
-
- text - -
- string -
- 		- -
The banner text that should be present in the remote device running configuration. This argument accepts a multiline string, with no empty lines. Requires state=present.
-
-
- - -Notes ------ - -.. note:: - - Since responses from the device are always read with surrounding whitespaces stripped, tasks that configure banners with preceeding or trailing whitespaces will not be idempotent. - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: configure the exec banner - cisco.nxos.nxos_banner: - banner: exec - text: | - this is my exec banner - that contains a multiline - string - state: present - - name: remove the motd banner - cisco.nxos.nxos_banner: - banner: motd - state: absent - - name: Configure banner from file - cisco.nxos.nxos_banner: - banner: motd - text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}" - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['banner exec', 'this is my exec banner', 'that contains a multiline', 'string']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_bfd_global_module.rst b/docs/cisco.nxos.nxos_bfd_global_module.rst deleted file mode 100644 index 8cd86ec48..000000000 --- a/docs/cisco.nxos.nxos_bfd_global_module.rst +++ /dev/null @@ -1,326 +0,0 @@ -.. _cisco.nxos.nxos_bfd_global_module: - - -************************** -cisco.nxos.nxos_bfd_global -************************** - -**Bidirectional Forwarding Detection (BFD) global-level configuration** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages Bidirectional Forwarding Detection (BFD) global-level configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- echo_interface - -
- string -
- 		- -
Loopback interface used for echo frames.
-
Valid values are loopback interface name or 'deleted'.
-
Not supported on N5K/N6K
-
-
- echo_rx_interval - -
- integer -
- 		- -
BFD Echo receive interval in milliseconds.
-
-
- fabricpath_interval - -
- dictionary -
- 		- -
BFD fabricpath interval timer values.
-
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
-
-
- fabricpath_slow_timer - -
- integer -
- 		- -
BFD fabricpath slow rate timer in milliseconds.
-
-
- fabricpath_vlan - -
- integer -
- 		- -
BFD fabricpath control vlan.
-
-
- interval - -
- dictionary -
- 		- -
BFD interval timer values.
-
Value must be a dict defining values for keys (tx, min_rx, and multiplier)
-
-
- ipv4_echo_rx_interval - -
- integer -
- 		- -
BFD IPv4 session echo receive interval in milliseconds.
-
-
- ipv4_interval - -
- dictionary -
- 		- -
BFD IPv4 interval timer values.
-
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
-
-
- ipv4_slow_timer - -
- integer -
- 		- -
BFD IPv4 slow rate timer in milliseconds.
-
-
- ipv6_echo_rx_interval - -
- integer -
- 		- -
BFD IPv6 session echo receive interval in milliseconds.
-
-
- ipv6_interval - -
- dictionary -
- 		- -
BFD IPv6 interval timer values.
-
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
-
-
- ipv6_slow_timer - -
- integer -
- 		- -
BFD IPv6 slow rate timer in milliseconds.
-
-
- slow_timer - -
- integer -
- 		- -
BFD slow rate timer in milliseconds.
-
-
- startup_timer - -
- integer -
- 		- -
BFD delayed startup timer in seconds.
-
Not supported on N5K/N6K/N7K
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 9.2(2) - - Unsupported for Cisco MDS - - BFD global will automatically enable 'feature bfd' if it is disabled. - - BFD global does not have a 'state' parameter. All of the BFD commands are unique and are defined if 'feature bfd' is enabled. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_bfd_global: - echo_interface: Ethernet1/2 - echo_rx_interval: 50 - interval: - tx: 50 - min_rx: 50 - multiplier: 4 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- cmds - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['bfd echo-interface loopback1', 'bfd slow-timer 2000']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_bfd_interfaces_module.rst b/docs/cisco.nxos.nxos_bfd_interfaces_module.rst deleted file mode 100644 index 975de891c..000000000 --- a/docs/cisco.nxos.nxos_bfd_interfaces_module.rst +++ /dev/null @@ -1,394 +0,0 @@ -.. _cisco.nxos.nxos_bfd_interfaces_module: - - -****************************** -cisco.nxos.nxos_bfd_interfaces -****************************** - -**BFD interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages attributes of Bidirectional Forwarding Detection (BFD) on the interface. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
The provided configuration
-
-
- bfd - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Enable/Disable Bidirectional Forwarding Detection (BFD) on the interface.
-
-
- echo - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Enable/Disable BFD Echo functionality on the interface.
-
-
- name - -
- string -
- 		- -
The name of the interface.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface|^feature bfd'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state of the configuration after module completion
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 7.0(3)I5(1). - - Unsupported for Cisco MDS - - Feature bfd should be enabled for this module. - - - -Examples --------- - -.. code-block:: yaml - - # Using deleted - - - name: Configure interfaces - cisco.nxos.nxos_bfd_interfaces: - state: deleted - - - # Using merged - - - name: Configure interfaces - cisco.nxos.nxos_bfd_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - echo: enable - - name: Ethernet1/2 - bfd: disable - echo: disable - state: merged - - - # Using overridden - - - name: Configure interfaces - cisco.nxos.nxos_bfd_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - echo: enable - - name: Ethernet1/2 - bfd: disable - echo: disable - state: overridden - - - # Using replaced - - - name: Configure interfaces - cisco.nxos.nxos_bfd_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - echo: enable - - name: Ethernet1/2 - bfd: disable - echo: disable - state: replaced - - # Using rendered - - - name: Use rendered state to convert task input to device specific commands - cisco.nxos.nxos_bfd_interfaces: - config: - - name: Ethernet1/800 - bfd: enable - echo: enable - - name: Ethernet1/801 - bfd: disable - echo: disable - state: rendered - - # Task Output (redacted) - # ----------------------- - - # rendered: - # - "interface Ethernet1/800" - # - "bfd" - # - "bfd echo" - # - "interface Ethernet1/801" - # - "no bfd" - # - "no bfd echo" - - # Using parsed - - # parsed.cfg - # ------------ - - # feature bfd - # interface Ethernet1/800 - # no switchport - # no bfd - # no bfd echo - # interface Ethernet1/801 - # no switchport - # no bfd - # interface Ethernet1/802 - # no switchport - # no bfd echo - # interface mgmt0 - # ip address dhcp - # vrf member management - - - name: Use parsed state to convert externally supplied config to structured format - cisco.nxos.nxos_bfd_interfaces: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - - # parsed: - # - bfd: disable - # echo: disable - # name: Ethernet1/800 - # - bfd: disable - # echo: enable - # name: Ethernet1/801 - # - bfd: enable - # echo: disable - # name: Ethernet1/802 - # - bfd: enable - # echo: enable - # name: mgmt0 - - # Using gathered - - # Existing device config state - # ------------------------------- - - # feature bfd - # interface Ethernet1/1 - # no switchport - # no bfd - # interface Ethernet1/2 - # no switchport - # no bfd echo - # interface mgmt0 - # ip address dhcp - # vrf member management - - - name: Gather bfd_interfaces facts from the device using nxos_bfd_interfaces - cisco.nxos.nxos_bfd_interfaces: - state: gathered - - # Task output (redacted) - # ----------------------- - # gathered: - # - name: Ethernet1/1 - # bfd: disable - # echo: enable - # - name: Ethernet1/3 - # echo: disable - # bfd: enable - # - name: mgmt0 - # bfd: enable - # echo: enable - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/1', 'no bfd', 'no bfd echo']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_bgp_global_module.rst b/docs/cisco.nxos.nxos_bgp_global_module.rst deleted file mode 100644 index 19ee2709e..000000000 --- a/docs/cisco.nxos.nxos_bgp_global_module.rst +++ /dev/null @@ -1,5843 +0,0 @@ -.. _cisco.nxos.nxos_bgp_global_module: - - -************************** -cisco.nxos.nxos_bgp_global -************************** - -**BGP Global resource module.** - - -Version added: 1.4.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages global BGP configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A list of BGP process configuration.
-
-
- affinity_group - -
- dictionary -
- 		- -
Configure an affinity group.
-
-
- group_id - -
- integer -
- 		- -
Affinity Group ID.
-
-
- as_number - -
- string -
- 		- -
Autonomous System Number of the router.
-
-
- bestpath - -
- dictionary -
- 		- -
Define the default bestpath selection algorithm.
-
-
- always_compare_med - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare MED on paths from different AS.
-
-
- as_path - -
- dictionary -
- 		- -
AS-Path.
-
-
- ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore AS-Path during bestpath selection.
-
-
- multipath_relax - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Relax AS-Path restriction when choosing multipaths.
-
-
- compare_neighborid - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
When more paths are available than max path config, use neighborid as tie-breaker.
-
-
- compare_routerid - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare router-id for identical EBGP paths.
-
-
- cost_community_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore cost communities in bestpath selection.
-
-
- igp_metric_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore IGP metric for next-hop during bestpath selection.
-
-
- med - -
- dictionary -
- 		- -
MED
-
-
- confed - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare MED only from paths originated from within a confederation.
-
-
- missing_as_worst - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Treat missing MED as highest MED.
-
-
- non_deterministic - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Not always pick the best-MED path among paths from same AS.
-
-
- cluster_id - -
- string -
- 		- -
Configure Route Reflector Cluster-ID.
-
-
- confederation - -
- dictionary -
- 		- -
AS confederation parameters.
-
-
- identifier - -
- string -
- 		- -
Set routing domain confederation AS.
-
-
- peers - -
- list - / elements=string -
- 		- -
Peer ASs in BGP confederation.
-
-
- disable_policy_batching - -
- dictionary -
- 		- -
Disable batching evaluation of outbound policy for a peer.
-
-
- ipv4 - -
- dictionary -
- 		- -
IPv4 address-family settings.
-
-
- prefix_list - -
- string -
- 		- -
Name of prefix-list to apply.
-
-
- ipv6 - -
- dictionary -
- 		- -
IPv6 address-family settings.
-
-
- prefix_list - -
- string -
- 		- -
Name of prefix-list to apply.
-
-
- nexthop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Batching based on nexthop.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set policy batching.
-
-
- dynamic_med_interval - -
- integer -
- 		- -
Sets the interval for dampening of med changes.
-
-
- enforce_first_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enforce neighbor AS is the first AS in AS-PATH attribute (EBGP).
-
-
- enhanced_error - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable BGP Enhanced error handling.
-
-
- fabric_soo - -
- string -
- 		- -
Fabric site of origin.
-
-
- fast_external_fallover - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Immediately reset the session if the link to a directly connected BGP peer goes down.
-
-
- flush_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flush routes in RIB upon controlled restart.
-
-
- graceful_restart - -
- dictionary -
- 		- -
Configure Graceful Restart functionality.
-
-
- helper - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure Graceful Restart Helper mode functionality.
-
-
- restart_time - -
- integer -
- 		- -
Maximum time for restart advertised to peers.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable graceful-restart.
-
-
- stalepath_time - -
- integer -
- 		- -
Maximum time to keep a restarting peer's stale routes.
-
-
- graceful_shutdown - -
- dictionary -
- 		- -
Graceful-shutdown for BGP protocol.
-
-
- activate - -
- dictionary -
- 		- -
Send graceful-shutdown community on all routes.
-
-
- route_map - -
- string -
- 		- -
Apply route-map to modify attributes for outbound.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Activiate graceful-shutdown.
-
-
- aware - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Lower preference of routes carrying graceful-shutdown community.
-
-
- isolate - -
- dictionary -
- 		- -
Isolate this router from BGP perspective.
-
-
- include_local - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Withdraw both local and remote BGP routes.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Withdraw remote BGP routes to isolate this router.
-
-
- log_neighbor_changes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Log a message for neighbor up/down event.
-
-
- maxas_limit - -
- integer -
- 		- -
Allow AS-PATH attribute from EBGP neighbor imposing a limit on number of ASes.
-
-
- neighbor_down - -
- dictionary -
- 		- -
Handle BGP neighbor down event, due to various reasons.
-
-
- fib_accelerate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor.
-
-
- neighbors - -
- list - / elements=dictionary -
- 		- -
Configure BGP neighbors.
-
-
- bfd - -
- dictionary -
- 		- -
Bidirectional Fast Detection for the neighbor.
-
-
- multihop - -
- dictionary -
- 		- -
Multihop session.
-
-
- interval - -
- dictionary -
- 		- -
Configure BFD session interval parameters.
-
-
- min_rx_interval - -
- integer -
- 		- -
Minimum RX interval.
-
-
- multiplier - -
- integer -
- 		- -
Detect Multiplier.
-
-
- tx_interval - -
- integer -
- 		- -
TX interval in milliseconds.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD multihop.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD for this neighbor.
-
-
- singlehop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Single-hop session.
-
-
- bmp_activate_server - -
- integer -
- 		- -
Specify server ID for activating BMP monitoring for the peer.
-
-
- capability - -
- dictionary -
- 		- -
Capability.
-
-
- suppress_4_byte_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress 4-byte AS Capability.
-
-
- description - -
- string -
- 		- -
Neighbor specific descripion.
-
-
- disable_connected_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable check for directly connected peer.
-
-
- dont_capability_negotiate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't negotiate capability with this neighbor.
-
-
- dscp - -
- string -
- 		- -
Set dscp value for tcp transport.
-
-
- dynamic_capability - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Dynamic Capability
-
-
- ebgp_multihop - -
- integer -
- 		- -
Specify multihop TTL for remote peer.
-
-
- graceful_shutdown - -
- dictionary -
- 		- -
Graceful-shutdown for this neighbor.
-
-
- activate - -
- dictionary -
- 		- -
Send graceful-shutdown community.
-
-
- route_map - -
- string -
- 		- -
Apply route-map to modify attributes for outbound.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set activate.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a template.
-
-
- peer - -
- string -
- 		- -
Peer template to inherit.
-
-
- peer_session - -
- string -
- 		- -
Peer-session template to inherit.
-
-
- local_as - -
- string -
- 		- -
Specify the local-as number for the eBGP neighbor.
-
-
- log_neighbor_changes - -
- dictionary -
- 		- -
Log message for neighbor up/down event.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable logging of neighbor up/down event.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set log-neighbor-changes.
-
-
- low_memory - -
- dictionary -
- 		- -
Behaviour in low memory situations.
-
-
- exempt - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not shutdown this peer when under memory pressure.
-
-
- neighbor_address - -
- string - / required -
- 		- -
IP address/Prefix of the neighbor or interface.
-
-
- neighbor_affinity_group - -
- dictionary -
- 		- -
Configure an affinity group.
-
-
- group_id - -
- integer -
- 		- -
Affinity Group ID.
-
-
- password - -
- dictionary -
- 		- -
Configure a password for neighbor.
-
-
- encryption - -
- integer -
- 		- -
0 specifies an UNENCRYPTED neighbor password.
-
3 specifies an 3DES ENCRYPTED neighbor password will follow.
-
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
-
-
- key - -
- string -
- 		- -
Authentication password.
-
-
- path_attribute - -
- list - / elements=dictionary -
- 		- -
BGP path attribute optional filtering.
-
-
- action - -
- string -
- 		-
    Choices: -
  • discard
    • -
  • treat-as-withdraw
    • -
- 		-
Action.
-
-
- range - -
- dictionary -
- 		- -
Path attribute range.
-
-
- end - -
- integer -
- 		- -
Path attribute range end value.
-
-
- start - -
- integer -
- 		- -
Path attribute range start value.
-
-
- type - -
- integer -
- 		- -
Path attribute type
-
-
- peer_type - -
- string -
- 		-
    Choices: -
  • fabric-border-leaf
    • -
  • fabric-external
    • -
- 		-
Neighbor facing
-
-
- remote_as - -
- string -
- 		- -
Specify Autonomous System Number of the neighbor.
-
-
- remote_as_route_map - -
- string -
- 		- -
Route-map to match prefix peer AS number.
-
-
- remove_private_as - -
- dictionary -
- 		- -
Remove private AS number from outbound updates.
-
-
- all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All.
-
-
- replace_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Replace.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove private AS.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively shutdown this neighbor.
-
-
- timers - -
- dictionary -
- 		- -
Configure keepalive and hold timers.
-
-
- holdtime - -
- integer -
- 		- -
Holdtime (seconds).
-
-
- keepalive - -
- integer -
- 		- -
Keepalive interval (seconds).
-
-
- transport - -
- dictionary -
- 		- -
BGP transport connection.
-
-
- connection_mode - -
- dictionary -
- 		- -
Specify type of connection.
-
-
- passive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow passive connection setup only.
-
-
- ttl_security - -
- dictionary -
- 		- -
Enable TTL Security Mechanism.
-
-
- hops - -
- integer -
- 		- -
Specify hop count for remote peer.
-
-
- update_source - -
- string -
- 		- -
Specify source of BGP session and updates.
-
-
- nexthop - -
- dictionary -
- 		- -
Nexthop resolution options.
-
-
- suppress_default_resolution - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Prohibit use of default route for nexthop address resolution.
-
-
- rd - -
- dictionary -
- 		- -
Secondary Route Distinguisher for vxlan multisite border gateway.
-
-
- dual - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Generate Secondary RD for all VRFs and L2VNIs.
-
-
- id - -
- integer -
- 		- -
Specify 2 byte value for ID.
-
-
- reconnect_interval - -
- integer -
- 		- -
Configure connection reconnect interval.
-
-
- router_id - -
- string -
- 		- -
Specify the IP address to use as router-id.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively shutdown BGP protocol.
-
-
- suppress_fib_pending - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise only routes that are programmed in hardware to peers.
-
-
- timers - -
- dictionary -
- 		- -
Configure bgp related timers.
-
-
- bestpath_limit - -
- dictionary -
- 		- -
Configure timeout for first bestpath after restart.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure update-delay-always option.
-
-
- timeout - -
- integer -
- 		- -
Bestpath timeout (seconds).
-
-
- bgp - -
- dictionary -
- 		- -
Configure different bgp keepalive and holdtimes.
-
-
- holdtime - -
- integer -
- 		- -
Holdtime (seconds).
-
-
- keepalive - -
- integer -
- 		- -
Keepalive interval (seconds).
-
-
- prefix_peer_timeout - -
- integer -
- 		- -
Prefix Peer timeout (seconds).
-
-
- prefix_peer_wait - -
- integer -
- 		- -
Configure wait timer for a prefix peer.
-
-
- vrfs - -
- list - / elements=dictionary -
- 		- -
Virtual Router Context configurations.
-
-
- allocate_index - -
- integer -
- 		- -
Configure allocate-index.
-
-
- bestpath - -
- dictionary -
- 		- -
Define the default bestpath selection algorithm.
-
-
- always_compare_med - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare MED on paths from different AS.
-
-
- as_path - -
- dictionary -
- 		- -
AS-Path.
-
-
- ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore AS-Path during bestpath selection.
-
-
- multipath_relax - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Relax AS-Path restriction when choosing multipaths.
-
-
- compare_neighborid - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
When more paths are available than max path config, use neighborid as tie-breaker.
-
-
- compare_routerid - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare router-id for identical EBGP paths.
-
-
- cost_community_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore cost communities in bestpath selection.
-
-
- igp_metric_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore IGP metric for next-hop during bestpath selection.
-
-
- med - -
- dictionary -
- 		- -
MED
-
-
- confed - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare MED only from paths originated from within a confederation.
-
-
- missing_as_worst - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Treat missing MED as highest MED.
-
-
- non_deterministic - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Not always pick the best-MED path among paths from same AS.
-
-
- cluster_id - -
- string -
- 		- -
Configure Route Reflector Cluster-ID.
-
-
- confederation - -
- dictionary -
- 		- -
AS confederation parameters.
-
-
- identifier - -
- string -
- 		- -
Set routing domain confederation AS.
-
-
- peers - -
- list - / elements=string -
- 		- -
Peer ASs in BGP confederation.
-
-
- graceful_restart - -
- dictionary -
- 		- -
Configure Graceful Restart functionality.
-
-
- helper - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure Graceful Restart Helper mode functionality.
-
-
- restart_time - -
- integer -
- 		- -
Maximum time for restart advertised to peers.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable graceful-restart.
-
-
- stalepath_time - -
- integer -
- 		- -
Maximum time to keep a restarting peer's stale routes.
-
-
- local_as - -
- string -
- 		- -
Specify the local-as for this vrf.
-
-
- log_neighbor_changes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Log a message for neighbor up/down event.
-
-
- maxas_limit - -
- integer -
- 		- -
Allow AS-PATH attribute from EBGP neighbor imposing a limit on number of ASes.
-
-
- neighbor_down - -
- dictionary -
- 		- -
Handle BGP neighbor down event, due to various reasons.
-
-
- fib_accelerate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor.
-
-
- neighbors - -
- list - / elements=dictionary -
- 		- -
Configure BGP neighbors.
-
-
- bfd - -
- dictionary -
- 		- -
Bidirectional Fast Detection for the neighbor.
-
-
- multihop - -
- dictionary -
- 		- -
Multihop session.
-
-
- interval - -
- dictionary -
- 		- -
Configure BFD session interval parameters.
-
-
- min_rx_interval - -
- integer -
- 		- -
Minimum RX interval.
-
-
- multiplier - -
- integer -
- 		- -
Detect Multiplier.
-
-
- tx_interval - -
- integer -
- 		- -
TX interval in milliseconds.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD multihop.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD for this neighbor.
-
-
- singlehop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Single-hop session.
-
-
- bmp_activate_server - -
- integer -
- 		- -
Specify server ID for activating BMP monitoring for the peer.
-
-
- capability - -
- dictionary -
- 		- -
Capability.
-
-
- suppress_4_byte_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress 4-byte AS Capability.
-
-
- description - -
- string -
- 		- -
Neighbor specific descripion.
-
-
- disable_connected_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable check for directly connected peer.
-
-
- dont_capability_negotiate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't negotiate capability with this neighbor.
-
-
- dscp - -
- string -
- 		- -
Set dscp value for tcp transport.
-
-
- dynamic_capability - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Dynamic Capability
-
-
- ebgp_multihop - -
- integer -
- 		- -
Specify multihop TTL for remote peer.
-
-
- graceful_shutdown - -
- dictionary -
- 		- -
Graceful-shutdown for this neighbor.
-
-
- activate - -
- dictionary -
- 		- -
Send graceful-shutdown community.
-
-
- route_map - -
- string -
- 		- -
Apply route-map to modify attributes for outbound.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set activate.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a template.
-
-
- peer - -
- string -
- 		- -
Peer template to inherit.
-
-
- peer_session - -
- string -
- 		- -
Peer-session template to inherit.
-
-
- local_as - -
- string -
- 		- -
Specify the local-as number for the eBGP neighbor.
-
-
- log_neighbor_changes - -
- dictionary -
- 		- -
Log message for neighbor up/down event.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable logging of neighbor up/down event.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set log-neighbor-changes.
-
-
- low_memory - -
- dictionary -
- 		- -
Behaviour in low memory situations.
-
-
- exempt - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not shutdown this peer when under memory pressure.
-
-
- neighbor_address - -
- string - / required -
- 		- -
IP address/Prefix of the neighbor or interface.
-
-
- neighbor_affinity_group - -
- dictionary -
- 		- -
Configure an affinity group.
-
-
- group_id - -
- integer -
- 		- -
Affinity Group ID.
-
-
- password - -
- dictionary -
- 		- -
Configure a password for neighbor.
-
-
- encryption - -
- integer -
- 		- -
0 specifies an UNENCRYPTED neighbor password.
-
3 specifies an 3DES ENCRYPTED neighbor password will follow.
-
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
-
-
- key - -
- string -
- 		- -
Authentication password.
-
-
- path_attribute - -
- list - / elements=dictionary -
- 		- -
BGP path attribute optional filtering.
-
-
- action - -
- string -
- 		-
    Choices: -
  • discard
    • -
  • treat-as-withdraw
    • -
- 		-
Action.
-
-
- range - -
- dictionary -
- 		- -
Path attribute range.
-
-
- end - -
- integer -
- 		- -
Path attribute range end value.
-
-
- start - -
- integer -
- 		- -
Path attribute range start value.
-
-
- type - -
- integer -
- 		- -
Path attribute type
-
-
- peer_type - -
- string -
- 		-
    Choices: -
  • fabric-border-leaf
    • -
  • fabric-external
    • -
- 		-
Neighbor facing
-
-
- remote_as - -
- string -
- 		- -
Specify Autonomous System Number of the neighbor.
-
-
- remote_as_route_map - -
- string -
- 		- -
Route-map to match prefix peer AS number.
-
-
- remove_private_as - -
- dictionary -
- 		- -
Remove private AS number from outbound updates.
-
-
- all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All.
-
-
- replace_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Replace.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove private AS.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively shutdown this neighbor.
-
-
- timers - -
- dictionary -
- 		- -
Configure keepalive and hold timers.
-
-
- holdtime - -
- integer -
- 		- -
Holdtime (seconds).
-
-
- keepalive - -
- integer -
- 		- -
Keepalive interval (seconds).
-
-
- transport - -
- dictionary -
- 		- -
BGP transport connection.
-
-
- connection_mode - -
- dictionary -
- 		- -
Specify type of connection.
-
-
- passive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow passive connection setup only.
-
-
- ttl_security - -
- dictionary -
- 		- -
Enable TTL Security Mechanism.
-
-
- hops - -
- integer -
- 		- -
Specify hop count for remote peer.
-
-
- update_source - -
- string -
- 		- -
Specify source of BGP session and updates.
-
-
- reconnect_interval - -
- integer -
- 		- -
Configure connection reconnect interval.
-
-
- router_id - -
- string -
- 		- -
Specify the IP address to use as router-id.
-
-
- timers - -
- dictionary -
- 		- -
Configure bgp related timers.
-
-
- bestpath_limit - -
- dictionary -
- 		- -
Configure timeout for first bestpath after restart.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure update-delay-always option.
-
-
- timeout - -
- integer -
- 		- -
Bestpath timeout (seconds).
-
-
- bgp - -
- dictionary -
- 		- -
Configure different bgp keepalive and holdtimes.
-
-
- holdtime - -
- integer -
- 		- -
Holdtime (seconds).
-
-
- keepalive - -
- integer -
- 		- -
Keepalive interval (seconds).
-
-
- prefix_peer_timeout - -
- integer -
- 		- -
Prefix Peer timeout (seconds).
-
-
- prefix_peer_wait - -
- integer -
- 		- -
Configure wait timer for a prefix peer.
-
-
- vrf - -
- string -
- 		- -
VRF name.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^router bgp'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • purged
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
State purged removes all the BGP configurations from the target device. Use caution with this state.
-
State deleted only removes BGP attributes that this modules manages and does not negate the BGP process completely. Thereby, preserving address-family related configurations under BGP context.
-
Running states deleted and replaced will result in an error if there are address-family configuration lines present under a neighbor, or a vrf context that is to be removed. Please use the cisco.nxos.nxos_bgp_af or cisco.nxos.nxos_bgp_neighbor_af modules for prior cleanup.
-
States merged and replaced will result in a failure if BGP is already configured with a different ASN than what is provided in the task. In such cases, please use state purged to remove the existing BGP process and proceed further.
-
States replaced and overridden have the same behaviour for this module.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - Unsupported for Cisco MDS - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # Nexus9000v# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_bgp_global: - config: - as_number: 65563 - router_id: 192.168.1.1 - bestpath: - as_path: - multipath_relax: true - compare_neighborid: true - cost_community_ignore: true - confederation: - identifier: 42 - peers: - - 65020 - - 65030 - - 65040 - log_neighbor_changes: true - maxas_limit: 20 - neighbors: - - neighbor_address: 192.168.1.100 - neighbor_affinity_group: - group_id: 160 - bmp_activate_server: 1 - remote_as: 65563 - description: NBR-1 - low_memory: - exempt: true - - neighbor_address: 192.168.1.101 - remote_as: 65563 - password: - encryption: 7 - key: 12090404011C03162E - neighbor_down: - fib_accelerate: true - vrfs: - - vrf: site-1 - allocate_index: 5000 - local_as: 200 - log_neighbor_changes: true - neighbors: - - neighbor_address: 198.51.100.1 - description: site-1-nbr-1 - password: - encryption: 3 - key: 13D4D3549493D2877B1DC116EE27A6BE - remote_as: 65562 - - neighbor_address: 198.51.100.2 - remote_as: 65562 - description: site-1-nbr-2 - - vrf: site-2 - local_as: 300 - log_neighbor_changes: true - neighbors: - - neighbor_address: 203.0.113.2 - description: site-2-nbr-1 - password: - encryption: 3 - key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - remote_as: 65568 - neighbor_down: - fib_accelerate: true - - # Task output: - # ------------ - # before: {} - # - # commands: - # - router bgp 65563 - # - bestpath as-path multipath-relax - # - bestpath compare-neighborid - # - bestpath cost-community ignore - # - confederation identifier 42 - # - log-neighbor-changes - # - maxas-limit 20 - # - neighbor-down fib-accelerate - # - router-id 192.168.1.1 - # - confederation peers 65020 65030 65040 - # - neighbor 192.168.1.100 - # - remote-as 65563 - # - affinity-group 160 - # - bmp-activate-server 1 - # - description NBR-1 - # - low-memory exempt - # - neighbor 192.168.1.101 - # - remote-as 65563 - # - password 7 12090404011C03162E - # - vrf site-1 - # - allocate-index 5000 - # - local-as 200 - # - log-neighbor-changes - # - neighbor 198.51.100.1 - # - remote-as 65562 - # - description site-1-nbr-1 - # - password 3 13D4D3549493D2877B1DC116EE27A6BE - # - neighbor 198.51.100.2 - # - remote-as 65562 - # - description site-1-nbr-2 - # - vrf site-2 - # - local-as 300 - # - log-neighbor-changes - # - neighbor-down fib-accelerate - # - neighbor 203.0.113.2 - # - remote-as 65568 - # - description site-2-nbr-1 - # - password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - # - # after: - # as_number: '65563' - # bestpath: - # as_path: - # multipath_relax: true - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65040' - # log_neighbor_changes: true - # maxas_limit: 20 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # - neighbor_address: 192.168.1.101 - # password: - # encryption: 7 - # key: 12090404011C03162E - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - allocate_index: 5000 - # local_as: '200' - # log_neighbor_changes: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 198.51.100.1 - # password: - # encryption: 3 - # key: 13D4D3549493D2877B1DC116EE27A6BE - # remote_as: '65562' - # - description: site-1-nbr-2 - # neighbor_address: 198.51.100.2 - # remote_as: '65562' - # vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - description: site-2-nbr-1 - # neighbor_address: 203.0.113.2 - # password: - # encryption: 3 - # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - # remote_as: '65568' - # vrf: site-2 - - - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65040 - # bestpath as-path multipath-relax - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 20 - # log-neighbor-changes - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # neighbor 192.168.1.101 - # remote-as 65563 - # password 7 12090404011C03162E - # vrf site-1 - # local-as 200 - # log-neighbor-changes - # allocate-index 5000 - # neighbor 198.51.100.1 - # remote-as 65562 - # description site-1-nbr-1 - # password 3 13D4D3549493D2877B1DC116EE27A6BE - # neighbor 198.51.100.2 - # remote-as 65562 - # description site-1-nbr-2 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # remote-as 65568 - # description site-2-nbr-1 - # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - # Using replaced - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65040 - # bestpath as-path multipath-relax - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 20 - # log-neighbor-changes - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # neighbor 192.168.1.101 - # remote-as 65563 - # password 7 12090404011C03162E - # vrf site-1 - # local-as 200 - # log-neighbor-changes - # allocate-index 5000 - # neighbor 198.51.100.1 - # remote-as 65562 - # description site-1-nbr-1 - # password 3 13D4D3549493D2877B1DC116EE27A6BE - # neighbor 198.51.100.2 - # remote-as 65562 - # description site-1-nbr-2 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # remote-as 65568 - # description site-2-nbr-1 - # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - - name: Replace BGP configuration with provided configuration - cisco.nxos.nxos_bgp_global: - config: - as_number: 65563 - router_id: 192.168.1.1 - bestpath: - compare_neighborid: true - cost_community_ignore: true - confederation: - identifier: 42 - peers: - - 65020 - - 65030 - - 65050 - maxas_limit: 40 - neighbors: - - neighbor_address: 192.168.1.100 - neighbor_affinity_group: - group_id: 160 - bmp_activate_server: 1 - remote_as: 65563 - description: NBR-1 - low_memory: - exempt: true - neighbor_down: - fib_accelerate: true - vrfs: - - vrf: site-2 - local_as: 300 - log_neighbor_changes: true - neighbors: - - neighbor_address: 203.0.113.2 - password: - encryption: 7 - key: 12090404011C03162E - neighbor_down: - fib_accelerate: true - state: replaced - - # Task output: - # ------------ - # before: - # as_number: '65563' - # bestpath: - # as_path: - # multipath_relax: true - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65040' - # log_neighbor_changes: true - # maxas_limit: 20 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # - neighbor_address: 192.168.1.101 - # password: - # encryption: 7 - # key: 12090404011C03162E - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - allocate_index: 5000 - # local_as: '200' - # log_neighbor_changes: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 198.51.100.1 - # password: - # encryption: 3 - # key: 13D4D3549493D2877B1DC116EE27A6BE - # remote_as: '65562' - # - description: site-1-nbr-2 - # neighbor_address: 198.51.100.2 - # remote_as: '65562' - # vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - description: site-2-nbr-1 - # neighbor_address: 203.0.113.2 - # password: - # encryption: 3 - # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - # remote_as: '65568' - # vrf: site-2 - # - # commands: - # - router bgp 65563 - # - no bestpath as-path multipath-relax - # - no log-neighbor-changes - # - maxas-limit 40 - # - no confederation peers 65020 65030 65040 - # - confederation peers 65020 65030 65050 - # - no neighbor 192.168.1.101 - # - vrf site-2 - # - neighbor 203.0.113.2 - # - no remote-as 65568 - # - no description site-2-nbr-1 - # - password 7 12090404011C03162E - # - no vrf site-1 - - # after: - # as_number: '65563' - # bestpath: - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65050' - # maxas_limit: 40 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - neighbor_address: 203.0.113.2 - # password: - # encryption: 7 - # key: 12090404011C03162E - # vrf: site-2 - # - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65050 - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 40 - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # password 7 12090404011C03162E - - # Using deleted - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65040 - # bestpath as-path multipath-relax - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 20 - # log-neighbor-changes - # address-family ipv4 unicast - # default-metric 400 - # suppress-inactive - # default-information originate - # address-family ipv6 multicast - # wait-igp-convergence - # redistribute eigrp eigrp-1 route-map site-1-rmap - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # neighbor 192.168.1.101 - # remote-as 65563 - # password 7 12090404011C03162E - # vrf site-1 - # local-as 200 - # log-neighbor-changes - # allocate-index 5000 - # address-family ipv4 multicast - # maximum-paths 40 - # dampen-igp-metric 1200 - # neighbor 198.51.100.1 - # remote-as 65562 - # description site-1-nbr-1 - # password 3 13D4D3549493D2877B1DC116EE27A6BE - # neighbor 198.51.100.2 - # remote-as 65562 - # description site-1-nbr-2 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # remote-as 65568 - # description site-1-nbr-1 - # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - - name: Delete BGP configurations handled by this module - cisco.nxos.nxos_bgp_global: - state: deleted - - # Task output: - # ------------ - - # before: - # as_number: '65563' - # bestpath: - # as_path: - # multipath_relax: true - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65040' - # log_neighbor_changes: true - # maxas_limit: 20 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # - neighbor_address: 192.168.1.101 - # password: - # encryption: 7 - # key: 12090404011C03162E - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - allocate_index: 5000 - # local_as: '200' - # log_neighbor_changes: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 198.51.100.1 - # password: - # encryption: 3 - # key: 13D4D3549493D2877B1DC116EE27A6BE - # remote_as: '65562' - # - description: site-1-nbr-2 - # neighbor_address: 198.51.100.2 - # remote_as: '65562' - # vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 203.0.113.2 - # password: - # encryption: 3 - # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - # remote_as: '65568' - # vrf: site-2 - # - # commands: - # - router bgp 65563 - # - no bestpath as-path multipath-relax - # - no bestpath compare-neighborid - # - no bestpath cost-community ignore - # - no confederation identifier 42 - # - no log-neighbor-changes - # - no maxas-limit 20 - # - no neighbor-down fib-accelerate - # - no router-id 192.168.1.1 - # - no confederation peers 65020 65030 65040 - # - no neighbor 192.168.1.100 - # - no neighbor 192.168.1.101 - # - no vrf site-1 - # - no vrf site-2 - # - # after: - # as_number: '65563' - # - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # address-family ipv4 unicast - # default-metric 400 - # suppress-inactive - # default-information originate - # address-family ipv6 multicast - # wait-igp-convergence - # redistribute eigrp eigrp-1 route-map site-1-rmap - # - - # Using purged - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65040 - # bestpath as-path multipath-relax - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 20 - # log-neighbor-changes - # address-family ipv4 unicast - # default-metric 400 - # suppress-inactive - # default-information originate - # address-family ipv6 multicast - # wait-igp-convergence - # redistribute eigrp eigrp-1 route-map site-1-rmap - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # neighbor 192.168.1.101 - # remote-as 65563 - # password 7 12090404011C03162E - # vrf site-1 - # local-as 200 - # log-neighbor-changes - # allocate-index 5000 - # address-family ipv4 multicast - # maximum-paths 40 - # dampen-igp-metric 1200 - # neighbor 198.51.100.1 - # remote-as 65562 - # description site-1-nbr-1 - # password 3 13D4D3549493D2877B1DC116EE27A6BE - # neighbor 198.51.100.2 - # remote-as 65562 - # description site-1-nbr-2 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # remote-as 65568 - # description site-1-nbr-1 - # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - - name: Purge all BGP configurations from the device - cisco.nxos.nxos_bgp_global: - state: purged - - # Task output: - # ------------ - - # before: - # as_number: '65563' - # bestpath: - # as_path: - # multipath_relax: true - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65040' - # log_neighbor_changes: true - # maxas_limit: 20 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # - neighbor_address: 192.168.1.101 - # password: - # encryption: 7 - # key: 12090404011C03162E - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - allocate_index: 5000 - # local_as: '200' - # log_neighbor_changes: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 198.51.100.1 - # password: - # encryption: 3 - # key: 13D4D3549493D2877B1DC116EE27A6BE - # remote_as: '65562' - # - description: site-1-nbr-2 - # neighbor_address: 198.51.100.2 - # remote_as: '65562' - # vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 203.0.113.2 - # password: - # encryption: 3 - # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - # remote_as: '65568' - # vrf: site-2 - # - # commands: - # - no router bgp 65563 - # - # after: {} - # - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # Nexus9000v# - - # Using rendered - - - name: Render platform specific configuration lines (without connecting to the device) - cisco.nxos.nxos_bgp_global: - config: - as_number: 65563 - router_id: 192.168.1.1 - bestpath: - as_path: - multipath_relax: true - compare_neighborid: true - cost_community_ignore: true - confederation: - identifier: 42 - peers: - - 65020 - - 65030 - - 65040 - log_neighbor_changes: true - maxas_limit: 20 - neighbors: - - neighbor_address: 192.168.1.100 - neighbor_affinity_group: - group_id: 160 - bmp_activate_server: 1 - remote_as: 65563 - description: NBR-1 - low_memory: - exempt: true - - neighbor_address: 192.168.1.101 - remote_as: 65563 - password: - encryption: 7 - key: 12090404011C03162E - neighbor_down: - fib_accelerate: true - vrfs: - - vrf: site-1 - allocate_index: 5000 - local_as: 200 - log_neighbor_changes: true - neighbors: - - neighbor_address: 198.51.100.1 - description: site-1-nbr-1 - password: - encryption: 3 - key: 13D4D3549493D2877B1DC116EE27A6BE - remote_as: 65562 - - neighbor_address: 198.51.100.2 - remote_as: 65562 - description: site-1-nbr-2 - - vrf: site-2 - local_as: 300 - log_neighbor_changes: true - neighbors: - - neighbor_address: 203.0.113.2 - description: site-1-nbr-1 - password: - encryption: 3 - key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - remote_as: 65568 - neighbor_down: - fib_accelerate: true - - # Task output: - # ------------ - # rendered: - # - router bgp 65563 - # - bestpath as-path multipath-relax - # - bestpath compare-neighborid - # - bestpath cost-community ignore - # - confederation identifier 42 - # - log-neighbor-changes - # - maxas-limit 20 - # - neighbor-down fib-accelerate - # - router-id 192.168.1.1 - # - confederation peers 65020 65030 65040 - # - neighbor 192.168.1.100 - # - remote-as 65563 - # - affinity-group 160 - # - bmp-activate-server 1 - # - description NBR-1 - # - low-memory exempt - # - neighbor 192.168.1.101 - # - remote-as 65563 - # - password 7 12090404011C03162E - # - vrf site-1 - # - allocate-index 5000 - # - local-as 200 - # - log-neighbor-changes - # - neighbor 198.51.100.1 - # - remote-as 65562 - # - description site-1-nbr-1 - # - password 3 13D4D3549493D2877B1DC116EE27A6BE - # - neighbor 198.51.100.2 - # - remote-as 65562 - # - description site-1-nbr-2 - # - vrf site-2 - # - local-as 300 - # - log-neighbor-changes - # - neighbor-down fib-accelerate - # - neighbor 203.0.113.2 - # - remote-as 65568 - # - description site-1-nbr-1 - # - password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - # Using parsed - - # parsed.cfg - # ------------ - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65040 - # bestpath as-path multipath-relax - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 20 - # log-neighbor-changes - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # neighbor 192.168.1.101 - # remote-as 65563 - # password 7 12090404011C03162E - # vrf site-1 - # local-as 200 - # log-neighbor-changes - # allocate-index 5000 - # neighbor 198.51.100.1 - # remote-as 65562 - # description site-1-nbr-1 - # password 3 13D4D3549493D2877B1DC116EE27A6BE - # neighbor 198.51.100.2 - # remote-as 65562 - # description site-1-nbr-2 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # remote-as 65568 - # description site-1-nbr-1 - # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - - name: Parse externally provided BGP config - cisco.nxos.nxos_bgp_global: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output: - # ------------ - # parsed: - # as_number: '65563' - # bestpath: - # as_path: - # multipath_relax: true - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65040' - # log_neighbor_changes: true - # maxas_limit: 20 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # - neighbor_address: 192.168.1.101 - # password: - # encryption: 7 - # key: 12090404011C03162E - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - allocate_index: 5000 - # local_as: '200' - # log_neighbor_changes: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 198.51.100.1 - # password: - # encryption: 3 - # key: 13D4D3549493D2877B1DC116EE27A6BE - # remote_as: '65562' - # - description: site-1-nbr-2 - # neighbor_address: 198.51.100.2 - # remote_as: '65562' - # vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 203.0.113.2 - # password: - # encryption: 3 - # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - # remote_as: '65568' - # vrf: site-2 - - # Using gathered - - # existing config - # - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65050 - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 40 - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # vrf site-1 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # password 7 12090404011C03162E - - - name: Gather BGP facts using gathered - cisco.nxos.nxos_bgp_global: - state: gathered - - # Task output: - # ------------ - # gathered: - # as_number: '65563' - # bestpath: - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65050' - # maxas_limit: 40 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - neighbor_address: 203.0.113.2 - # password: - # encryption: 7 - # key: 12090404011C03162E - # vrf: site-2 - - # Remove a neighbor having AF configurations with state replaced (will fail) - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # log-neighbor-changes - # maxas-limit 20 - # router-id 198.51.100.2 - # neighbor 203.0.113.2 - # address-family ipv4 unicast - # next-hop-self - # remote-as 65538 - # affinity-group 160 - # description NBR-1 - # low-memory exempt - # neighbor 192.0.2.1 - # remote-as 65537 - # password 7 12090404011C03162E - - - name: Remove a neighbor having AF configurations (should fail) - cisco.nxos.nxos_bgp_global: - config: - as_number: 65536 - router_id: 198.51.100.2 - maxas_limit: 20 - log_neighbor_changes: true - neighbors: - - neighbor_address: 192.0.2.1 - remote_as: 65537 - password: - encryption: 7 - key: 12090404011C03162E - state: replaced - - # Task output: - # ------------ - # fatal: [Nexus9000v]: FAILED! => changed=false - # msg: Neighbor 203.0.113.2 has address-family configurations. - # Please use the nxos_bgp_neighbor_af module to remove those first. - - # Remove a VRF having AF configurations with state replaced (will fail) - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # log-neighbor-changes - # maxas-limit 20 - # router-id 198.51.100.2 - # neighbor 192.0.2.1 - # remote-as 65537 - # password 7 12090404011C03162E - # vrf site-1 - # address-family ipv4 unicast - # default-information originate - # neighbor 203.0.113.2 - # remote-as 65538 - # affinity-group 160 - # description NBR-1 - # low-memory exempt - # vrf site-2 - # neighbor-down fib-accelerate - - - name: Remove a VRF having AF configurations (should fail) - cisco.nxos.nxos_bgp_global: - config: - as_number: 65536 - router_id: 198.51.100.2 - maxas_limit: 20 - log_neighbor_changes: true - neighbors: - - neighbor_address: 192.0.2.1 - remote_as: 65537 - password: - encryption: 7 - key: 12090404011C03162E - vrfs: - - vrf: site-2 - neighbor_down: - fib_accelerate: true - state: replaced - - # Task output: - # ------------ - # fatal: [Nexus9000v]: FAILED! => changed=false - # msg: VRF site-1 has address-family configurations. - # Please use the nxos_bgp_af module to remove those first. - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['router bgp 65563', 'maxas-limit 20', 'router-id 192.168.1.1', 'confederation peers 65020 65030 65040', 'neighbor 192.168.1.100', 'remote-as 65563', 'affinity-group 160', 'bmp-activate-server 1', 'description NBR-1', 'low-memory exempt', 'vrf site-1', 'log-neighbor-changes', 'neighbor 198.51.100.1', 'remote-as 65562', 'description site-1-nbr-1', 'password 3 13D4D3549493D2877B1DC116EE27A6BE']
-
-
- gathered - -
- dictionary -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- dictionary -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['router bgp 65563', 'maxas-limit 20', 'router-id 192.168.1.1']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst b/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst deleted file mode 100644 index 8668a0b9f..000000000 --- a/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst +++ /dev/null @@ -1,3575 +0,0 @@ -.. _cisco.nxos.nxos_bgp_neighbor_address_family_module: - - -******************************************* -cisco.nxos.nxos_bgp_neighbor_address_family -******************************************* - -**BGP Neighbor Address Family resource module.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages BGP Neighbor Address Family configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
BGP Neighbor AF configuration.
-
-
- as_number - -
- string -
- 		- -
Autonomous System Number of the router.
-
-
- neighbors - -
- list - / elements=dictionary -
- 		- -
A list of BGP Neighbor AF configuration.
-
-
- address_family - -
- list - / elements=dictionary -
- 		- -
BGP Neighbor Address Family related configurations.
-
-
- advertise_map - -
- dictionary -
- 		- -
Specify route-map for conditional advertisement.
-
-
- exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition exists.
-
-
- non_exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition does not exist.
-
-
- route_map - -
- string - / required -
- 		- -
Route-map name.
-
-
- advertisement_interval - -
- integer -
- 		- -
Minimum interval between sending BGP routing updates.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
  • link-state
    • -
  • vpnv4
    • -
  • vpnv6
    • -
  • l2vpn
    • -
- 		-
Address Family indicator.
-
-
- allowas_in - -
- dictionary -
- 		- -
Accept as-path with my AS present in it.
-
-
- max_occurences - -
- integer -
- 		- -
Number of occurrences of AS number, default is 3.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Activate allowas-in property.
-
-
- as_override - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Override matching AS-number while sending update.
-
-
- capability - -
- dictionary -
- 		- -
Advertise capability to the peer.
-
-
- additional_paths - -
- dictionary -
- 		- -
Additional paths capability.
-
-
- receive - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Receive capability.
-
-
- send - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Send capability.
-
-
- default_originate - -
- dictionary -
- 		- -
Originate a default toward this peer.
-
-
- route_map - -
- string -
- 		- -
Route-map to specify criteria for originating default.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set default-originate attribute.
-
-
- disable_peer_as_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable checking of peer AS-number while advertising.
-
-
- filter_list - -
- dictionary -
- 		- -
Name of filter-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a template.
-
-
- sequence - -
- integer -
- 		- -
Sequence number.
-
-
- template - -
- string -
- 		- -
Template name.
-
-
- maximum_prefix - -
- dictionary -
- 		- -
Maximum number of prefixes from this neighbor.
-
-
- generate_warning_threshold - -
- integer -
- 		- -
Threshold percentage at which to generate a warning.
-
-
- max_prefix_limit - -
- integer -
- 		- -
Maximum prefix limit.
-
-
- restart_interval - -
- integer -
- 		- -
Restart bgp connection after limit is exceeded.
-
-
- warning_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Only give a warning message when limit is exceeded.
-
-
- next_hop_self - -
- dictionary -
- 		- -
Set our address as nexthop (non-reflected).
-
-
- all_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set our address as nexthop for all routes.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set next-hop-self attribute.
-
-
- next_hop_third_party - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compute a third-party nexthop if possible.
-
-
- prefix_list - -
- dictionary -
- 		- -
Apply prefix-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- rewrite_evpn_rt_asn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Auto generate RTs for EBGP neighbor.
-
-
- rewrite_rt_asn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Auto generate RTs for EBGP neighbor.
-
-
- route_map - -
- dictionary -
- 		- -
Apply route-map to neighbor.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- route_reflector_client - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure a neighbor as Route reflector client.
-
-
- safi - -
- string -
- 		-
    Choices: -
  • unicast
    • -
  • multicast
    • -
  • mvpn
    • -
  • evpn
    • -
- 		-
Sub Address Family indicator.
-
-
- send_community - -
- dictionary -
- 		- -
Send Community attribute to this neighbor.
-
-
- both - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Standard and Extended Community attributes.
-
-
- extended - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Extended Community attribute.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set send-community attribute.
-
-
- standard - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Standard Community attribute.
-
-
- soft_reconfiguration_inbound - -
- dictionary -
- 		- -
Soft reconfiguration.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always perform inbound soft reconfiguration.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set soft-reconfiguration inbound attribute.
-
-
- soo - -
- string -
- 		- -
Specify Site-of-origin extcommunity.
-
-
- suppress_inactive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise only active routes to peer.
-
-
- unsuppress_map - -
- string -
- 		- -
Route-map to selectively unsuppress suppressed routes.
-
-
- weight - -
- integer -
- 		- -
Set default weight for routes from this neighbor.
-
-
- neighbor_address - -
- string - / required -
- 		- -
IP/IPv6 address of the neighbor.
-
-
- vrfs - -
- list - / elements=dictionary -
- 		- -
Virtual Router Context.
-
-
- neighbors - -
- list - / elements=dictionary -
- 		- -
A list of BGP Neighbor AF configuration.
-
-
- address_family - -
- list - / elements=dictionary -
- 		- -
BGP Neighbor Address Family related configurations.
-
-
- advertise_map - -
- dictionary -
- 		- -
Specify route-map for conditional advertisement.
-
-
- exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition exists.
-
-
- non_exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition does not exist.
-
-
- route_map - -
- string - / required -
- 		- -
Route-map name.
-
-
- advertisement_interval - -
- integer -
- 		- -
Minimum interval between sending BGP routing updates.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
  • link-state
    • -
  • vpnv4
    • -
  • vpnv6
    • -
  • l2vpn
    • -
- 		-
Address Family indicator.
-
-
- allowas_in - -
- dictionary -
- 		- -
Accept as-path with my AS present in it.
-
-
- max_occurences - -
- integer -
- 		- -
Number of occurrences of AS number, default is 3.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Activate allowas-in property.
-
-
- as_override - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Override matching AS-number while sending update.
-
-
- capability - -
- dictionary -
- 		- -
Advertise capability to the peer.
-
-
- additional_paths - -
- dictionary -
- 		- -
Additional paths capability.
-
-
- receive - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Receive capability.
-
-
- send - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Send capability.
-
-
- default_originate - -
- dictionary -
- 		- -
Originate a default toward this peer.
-
-
- route_map - -
- string -
- 		- -
Route-map to specify criteria for originating default.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set default-originate attribute.
-
-
- disable_peer_as_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable checking of peer AS-number while advertising.
-
-
- filter_list - -
- dictionary -
- 		- -
Name of filter-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a template.
-
-
- sequence - -
- integer -
- 		- -
Sequence number.
-
-
- template - -
- string -
- 		- -
Template name.
-
-
- maximum_prefix - -
- dictionary -
- 		- -
Maximum number of prefixes from this neighbor.
-
-
- generate_warning_threshold - -
- integer -
- 		- -
Threshold percentage at which to generate a warning.
-
-
- max_prefix_limit - -
- integer -
- 		- -
Maximum prefix limit.
-
-
- restart_interval - -
- integer -
- 		- -
Restart bgp connection after limit is exceeded.
-
-
- warning_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Only give a warning message when limit is exceeded.
-
-
- next_hop_self - -
- dictionary -
- 		- -
Set our address as nexthop (non-reflected).
-
-
- all_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set our address as nexthop for all routes.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set next-hop-self attribute.
-
-
- next_hop_third_party - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compute a third-party nexthop if possible.
-
-
- prefix_list - -
- dictionary -
- 		- -
Apply prefix-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- rewrite_evpn_rt_asn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Auto generate RTs for EBGP neighbor.
-
-
- rewrite_rt_asn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Auto generate RTs for EBGP neighbor.
-
-
- route_map - -
- dictionary -
- 		- -
Apply route-map to neighbor.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- route_reflector_client - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure a neighbor as Route reflector client.
-
-
- safi - -
- string -
- 		-
    Choices: -
  • unicast
    • -
  • multicast
    • -
  • mvpn
    • -
  • evpn
    • -
- 		-
Sub Address Family indicator.
-
-
- send_community - -
- dictionary -
- 		- -
Send Community attribute to this neighbor.
-
-
- both - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Standard and Extended Community attributes.
-
-
- extended - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Extended Community attribute.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set send-community attribute.
-
-
- standard - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Standard Community attribute.
-
-
- soft_reconfiguration_inbound - -
- dictionary -
- 		- -
Soft reconfiguration.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always perform inbound soft reconfiguration.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set soft-reconfiguration inbound attribute.
-
-
- soo - -
- string -
- 		- -
Specify Site-of-origin extcommunity.
-
-
- suppress_inactive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise only active routes to peer.
-
-
- unsuppress_map - -
- string -
- 		- -
Route-map to selectively unsuppress suppressed routes.
-
-
- weight - -
- integer -
- 		- -
Set default weight for routes from this neighbor.
-
-
- neighbor_address - -
- string - / required -
- 		- -
IP/IPv6 address of the neighbor.
-
-
- vrf - -
- string -
- 		- -
VRF name.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^router bgp'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
State deleted only removes BGP attributes that this modules manages and does not negate the BGP process completely.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - Unsupported for Cisco MDS - - For managing BGP address family configurations please use the :ref:`cisco.nxos.nxos_bgp_address_family ` module. - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # Nexus9000v# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_bgp_neighbor_address_family: &id001 - config: - as_number: 65536 - neighbors: - - neighbor_address: 192.0.2.32 - address_family: - - afi: ipv4 - safi: unicast - maximum_prefix: - max_prefix_limit: 20 - generate_warning_threshold: 75 - weight: 100 - prefix_list: - inbound: rmap1 - outbound: rmap2 - - afi: ipv6 - safi: unicast - - neighbor_address: 192.0.2.33 - address_family: - - afi: ipv4 - safi: multicast - inherit: - template: BasePolicy - sequence: 200 - vrfs: - - vrf: site-1 - neighbors: - - neighbor_address: 203.0.113.1 - address_family: - - afi: ipv4 - safi: unicast - suppress_inactive: true - next_hop_self: - set: true - - neighbor_address: 203.0.113.2 - address_family: - - afi: ipv6 - safi: unicast - - afi: ipv4 - safi: multicast - send_community: - set: true - - # Task output: - # ------------ - # before: {} - # - # commands: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - address-family ipv4 unicast - # - maximum-prefix 20 75 - # - weight 100 - # - prefix-list rmap1 in - # - prefix-list rmap2 out - # - address-family ipv6 unicast - # - neighbor 192.0.2.33 - # - address-family ipv4 multicast - # - inherit peer-policy BasePolicy 200 - # - vrf site-1 - # - neighbor 203.0.113.1 - # - address-family ipv4 unicast - # - suppress-inactive - # - next-hop-self - # - neighbor 203.0.113.2 - # - address-family ipv6 unicast - # - address-family ipv4 multicast - # - send-community - # - # after: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - # Using replaced - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - - name: Replace specified neighbor AFs with given configuration - cisco.nxos.nxos_bgp_neighbor_address_family: &replaced - config: - as_number: 65536 - neighbors: - - neighbor_address: 192.0.2.32 - address_family: - - afi: ipv4 - safi: unicast - weight: 110 - - afi: ipv6 - safi: unicast - - neighbor_address: 192.0.2.33 - address_family: - - afi: ipv4 - safi: multicast - inherit: - template: BasePolicy - sequence: 200 - vrfs: - - vrf: site-1 - neighbors: - - neighbor_address: 203.0.113.1 - address_family: - - afi: ipv4 - safi: unicast - - neighbor_address: 203.0.113.2 - address_family: - - afi: ipv6 - safi: unicast - - afi: ipv4 - safi: multicast - send_community: - set: true - state: replaced - - # Task output: - # ------------ - # before: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - # - # commands: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - address-family ipv4 unicast - # - no maximum-prefix 20 75 - # - weight 110 - # - no prefix-list rmap1 in - # - no prefix-list rmap2 out - # - vrf site-1 - # - neighbor 203.0.113.1 - # - address-family ipv4 unicast - # - no suppress-inactive - # - no next-hop-self - # - # after: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # weight: 110 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # weight 110 - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - # Using overridden - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - - name: Override all BGP AF configuration with provided configuration - cisco.nxos.nxos_bgp_neighbor_address_family: - config: - as_number: 65536 - neighbors: - - neighbor_address: 192.0.2.32 - address_family: - - afi: ipv4 - safi: unicast - vrfs: - - vrf: site-1 - neighbors: - - neighbor_address: 203.0.113.1 - address_family: - - afi: ipv4 - safi: unicast - suppress_inactive: true - next_hop_self: - set: true - state: overridden - - # Task output: - # ------------ - # before: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - # - # commands: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - address-family ipv4 unicast - # - no maximum-prefix 20 75 - # - no weight 100 - # - no prefix-list rmap1 in - # - no prefix-list rmap2 out - # - no address-family ipv6 unicast - # - neighbor 192.0.2.33 - # - no address-family ipv4 multicast - # - vrf site-1 - # - neighbor 203.0.113.2 - # - no address-family ipv4 multicast - # - no address-family ipv6 unicast - # - # after: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - - # Using deleted to remove specified neighbor AFs - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - - name: Delete BGP configs handled by this module - cisco.nxos.nxos_bgp_neighbor_address_family: - config: - as_number: 65536 - neighbors: - - neighbor_address: 192.0.2.32 - address_family: - - afi: ipv4 - safi: unicast - vrfs: - - vrf: site-1 - neighbors: - - neighbor_address: 203.0.113.2 - address_family: - - afi: ipv6 - safi: unicast - state: deleted - - # Task output: - # ------------ - # before: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - # - # commands: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - no address-family ipv4 unicast - # - vrf site-1 - # - neighbor 203.0.113.2 - # - no address-family ipv6 unicast - # - # after: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # - - # Using deleted to remove all neighbor AFs - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - - name: Delete all BGP neighbor AF configs handled by this module - cisco.nxos.nxos_bgp_neighbor_address_family: - state: deleted - - # Task output: - # ------------ - # before: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - # - # commands: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - no address-family ipv4 unicast - # - no address-family ipv6 unicast - # - neighbor 192.0.2.33 - # - no address-family ipv4 multicast - # - vrf site-1 - # - neighbor 203.0.113.1 - # - no address-family ipv4 unicast - # - neighbor 203.0.113.2 - # - no address-family ipv6 unicast - # - no address-family ipv4 multicast - # - # after: - # as_number: "65536" - # - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # neighbor 192.0.2.33 - # vrf site-1 - # neighbor 203.0.113.1 - # neighbor 203.0.113.2 - # - - # Using rendered - - - name: Render platform specific configuration lines with state rendered (without connecting to the device) - cisco.nxos.nxos_bgp_neighbor_address_family: - config: - as_number: 65536 - neighbors: - - neighbor_address: 192.0.2.32 - address_family: - - afi: ipv4 - safi: unicast - maximum_prefix: - max_prefix_limit: 20 - generate_warning_threshold: 75 - weight: 100 - prefix_list: - inbound: rmap1 - outbound: rmap2 - - afi: ipv6 - safi: unicast - - neighbor_address: 192.0.2.33 - address_family: - - afi: ipv4 - safi: multicast - inherit: - template: BasePolicy - sequence: 200 - vrfs: - - vrf: site-1 - neighbors: - - neighbor_address: 203.0.113.1 - address_family: - - afi: ipv4 - safi: unicast - suppress_inactive: true - next_hop_self: - set: true - - neighbor_address: 203.0.113.2 - address_family: - - afi: ipv6 - safi: unicast - - afi: ipv4 - safi: multicast - send_community: - set: true - state: rendered - - # Task output: - # ------------ - # rendered: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - address-family ipv4 unicast - # - maximum-prefix 20 75 - # - weight 100 - # - prefix-list rmap1 in - # - prefix-list rmap2 out - # - address-family ipv6 unicast - # - neighbor 192.0.2.33 - # - address-family ipv4 multicast - # - inherit peer-policy BasePolicy 200 - # - vrf site-1 - # - neighbor 203.0.113.1 - # - address-family ipv4 unicast - # - suppress-inactive - # - next-hop-self - # - neighbor 203.0.113.2 - # - address-family ipv6 unicast - # - address-family ipv4 multicast - # - send-community - - # Using parsed - - # parsed.cfg - # ------------ - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - - - name: Parse externally provided BGP neighbor AF config - register: result - cisco.nxos.nxos_bgp_neighbor_address_family: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output: - # ------------ - # parsed: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['router bgp 65536', 'neighbor 192.0.2.32', 'address-family ipv4 unicast']
-
-
- gathered - -
- dictionary -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- dictionary -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['router bgp 65536', 'neighbor 192.0.2.32', 'address-family ipv4 unicast']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_bgp_templates_module.rst b/docs/cisco.nxos.nxos_bgp_templates_module.rst deleted file mode 100644 index 9287d7a60..000000000 --- a/docs/cisco.nxos.nxos_bgp_templates_module.rst +++ /dev/null @@ -1,2841 +0,0 @@ -.. _cisco.nxos.nxos_bgp_templates_module: - - -***************************** -cisco.nxos.nxos_bgp_templates -***************************** - -**BGP Templates resource module.** - - -Version added: 4.2.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages BGP templates on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A list of BGP templates.
-
-
- as_number - -
- string -
- 		- -
Autonomous System Number of the router.
-
-
- neighbor - -
- list - / elements=dictionary -
- 		- -
Configure BGP peer templates.
-
-
- address_family - -
- list - / elements=dictionary -
- 		- -
Configure an address-family for peer.
-
-
- advertise_map - -
- dictionary -
- 		- -
Specify route-map for conditional advertisement.
-
-
- exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition exists.
-
-
- non_exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition does not exist.
-
-
- route_map - -
- string - / required -
- 		- -
Route-map name.
-
-
- advertisement_interval - -
- integer -
- 		- -
Minimum interval between sending BGP routing updates.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
  • link-state
    • -
  • l2vpn
    • -
- 		-
Address Family indicator.
-
-
- allowas_in - -
- dictionary -
- 		- -
Accept as-path with my AS present in it.
-
-
- max_occurences - -
- integer -
- 		- -
Number of occurrences of AS number, default is 3.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Activate allowas-in property.
-
-
- as_override - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Override matching AS-number while sending update.
-
-
- capability - -
- dictionary -
- 		- -
Advertise capability to the peer.
-
-
- additional_paths - -
- dictionary -
- 		- -
Additional paths capability.
-
-
- receive - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Receive capability.
-
-
- send - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Send capability.
-
-
- default_originate - -
- dictionary -
- 		- -
Originate a default toward this peer.
-
-
- route_map - -
- string -
- 		- -
Route-map to specify criteria for originating default.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set default-originate attribute.
-
-
- disable_peer_as_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable checking of peer AS-number while advertising.
-
-
- filter_list - -
- dictionary -
- 		- -
Name of filter-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a peer-policy template.
-
-
- peer_policy - -
- string -
- 		- -
Peer-policy template to inherit.
-
-
- maximum_prefix - -
- dictionary -
- 		- -
Maximum number of prefixes from this neighbor.
-
-
- generate_warning_threshold - -
- integer -
- 		- -
Threshold percentage at which to generate a warning.
-
-
- max_prefix_limit - -
- integer -
- 		- -
Maximum prefix limit.
-
-
- restart_interval - -
- integer -
- 		- -
Restart bgp connection after limit is exceeded.
-
-
- warning_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Only give a warning message when limit is exceeded.
-
-
- next_hop_self - -
- dictionary -
- 		- -
Set our address as nexthop (non-reflected).
-
-
- all_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set our address as nexthop for all routes.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set next-hop-self attribute.
-
-
- next_hop_third_party - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compute a third-party nexthop if possible.
-
-
- prefix_list - -
- dictionary -
- 		- -
Apply prefix-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- route_map - -
- dictionary -
- 		- -
Apply route-map to neighbor.
-
-
- inbound - -
- string -
- 		- -
Name of policy to apply to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Name of policy to apply to outgoing routes.
-
-
- route_reflector_client - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure a neighbor as Route reflector client.
-
-
- safi - -
- string -
- 		-
    Choices: -
  • unicast
    • -
  • multicast
    • -
  • mvpn
    • -
  • evpn
    • -
- 		-
Sub Address Family indicator.
-
-
- send_community - -
- string -
- 		-
    Choices: -
  • standard
    • -
  • extended
    • -
  • both
    • -
- 		-
Send Community attribute to this neighbor.
-
-
- soft_reconfiguration_inbound - -
- dictionary -
- 		- -
Soft reconfiguration.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always perform inbound soft reconfiguration.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set soft-reconfiguration inbound attribute.
-
-
- soo - -
- string -
- 		- -
Specify Site-of-origin extcommunity.
-
-
- suppress_inactive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise only active routes to peer.
-
-
- unsuppress_map - -
- string -
- 		- -
Route-map to selectively unsuppress suppressed routes.
-
-
- weight - -
- integer -
- 		- -
Set default weight for routes from this neighbor.
-
-
- bfd - -
- dictionary -
- 		- -
Bidirectional Fast Detection for the neighbor.
-
-
- multihop - -
- dictionary -
- 		- -
Multihop session.
-
-
- interval - -
- dictionary -
- 		- -
Configure BFD session interval parameters.
-
-
- min_rx_interval - -
- integer - / required -
- 		- -
Minimum RX interval.
-
-
- multiplier - -
- integer - / required -
- 		- -
Detect Multiplier.
-
-
- tx_interval - -
- integer - / required -
- 		- -
TX interval in milliseconds.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD multihop.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD for this neighbor.
-
-
- singlehop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Single-hop session.
-
-
- bmp_activate_server - -
- integer -
- 		- -
Specify server ID for activating BMP monitoring for the peer.
-
-
- capability - -
- dictionary -
- 		- -
Capability.
-
-
- suppress_4_byte_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress 4-byte AS Capability.
-
-
- description - -
- string -
- 		- -
Neighbor specific descripion.
-
-
- disable_connected_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable check for directly connected peer.
-
-
- dont_capability_negotiate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't negotiate capability with this neighbor.
-
-
- dscp - -
- string -
- 		- -
Set dscp value for tcp transport.
-
-
- dynamic_capability - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Dynamic Capability
-
-
- ebgp_multihop - -
- integer -
- 		- -
Specify multihop TTL for remote peer.
-
-
- graceful_shutdown - -
- dictionary -
- 		- -
Graceful-shutdown for this neighbor.
-
-
- activate - -
- dictionary -
- 		- -
Send graceful-shutdown community.
-
-
- route_map - -
- string -
- 		- -
Apply route-map to modify attributes for outbound.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set activate.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a template.
-
-
- peer_session - -
- string -
- 		- -
Peer-session template to inherit.
-
-
- local_as - -
- string -
- 		- -
Specify the local-as number for the eBGP neighbor.
-
-
- log_neighbor_changes - -
- dictionary -
- 		- -
Log message for neighbor up/down event.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable logging of neighbor up/down event.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set log-neighbor-changes.
-
-
- low_memory - -
- dictionary -
- 		- -
Behaviour in low memory situations.
-
-
- exempt - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not shutdown this peer when under memory pressure.
-
-
- name - -
- string -
- 		- -
Name of the BGP peer template.
-
-
- password - -
- dictionary -
- 		- -
Configure a password for neighbor.
-
-
- encryption - -
- integer -
- 		- -
0 specifies an UNENCRYPTED neighbor password.
-
3 specifies an 3DES ENCRYPTED neighbor password will follow.
-
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
-
-
- key - -
- string -
- 		- -
Authentication password.
-
-
- path_attribute - -
- list - / elements=dictionary -
- 		- -
BGP path attribute optional filtering.
-
-
- action - -
- string -
- 		-
    Choices: -
  • discard
    • -
  • treat-as-withdraw
    • -
- 		-
Action.
-
-
- range - -
- dictionary -
- 		- -
Path attribute range.
-
-
- end - -
- integer -
- 		- -
Path attribute range end value.
-
-
- start - -
- integer -
- 		- -
Path attribute range start value.
-
-
- type - -
- integer -
- 		- -
Path attribute type
-
-
- remote_as - -
- string -
- 		- -
Specify Autonomous System Number of the neighbor.
-
-
- remove_private_as - -
- dictionary -
- 		- -
Remove private AS number from outbound updates.
-
-
- all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All.
-
-
- replace_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Replace.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove private AS.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively shutdown this neighbor.
-
-
- timers - -
- dictionary -
- 		- -
Configure keepalive and hold timers.
-
-
- holdtime - -
- integer -
- 		- -
Holdtime (seconds).
-
-
- keepalive - -
- integer -
- 		- -
Keepalive interval (seconds).
-
-
- transport - -
- dictionary -
- 		- -
BGP transport connection.
-
-
- connection_mode - -
- dictionary -
- 		- -
Specify type of connection.
-
-
- passive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow passive connection setup only.
-
-
- ttl_security - -
- dictionary -
- 		- -
Enable TTL Security Mechanism.
-
-
- hops - -
- integer -
- 		- -
Specify hop count for remote peer.
-
-
- update_source - -
- string -
- 		- -
Specify source of BGP session and updates.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config bgp | section 'template'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - Unsupported for Cisco MDS - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # -------------- - # - # nxos9k# show running-config | section "^router bgp" - # nxos9k# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_bgp_templates: - config: - as_number: 65536 - neighbor: - - name: neighbor_tmplt_1 - address_family: - - afi: ipv4 - safi: unicast - advertise_map: - route_map: rmap1 - non_exist_map: nemap1 - advertisement_interval: 60 - disable_peer_as_check: true - bmp_activate_server: 2 - capability: - suppress_4_byte_as: true - description: Test_BGP_PEER_TEMPLATE_1 - local_as: 65536 - remote_as: 65001 - - - name: neighbor_tmplt_2 - description: Test_BGP_PEER_TEMPLATE_2 - address_family: - - afi: ipv4 - safi: multicast - advertise_map: - route_map: rmap1 - exist_map: emap1 - as_override: true - filter_list: - inbound: flist1 - outbound: flist2 - inherit: - peer_session: psession1 - timers: - holdtime: 100 - keepalive: 45 - # Task Output: - # ------------ - # before: {} - # - # commands: - # - router bgp 65536 - # - template peer neighbor_tmplt_1 - # - bmp-activate-server 2 - # - capability suppress 4-byte-as - # - description Test_BGP_PEER_TEMPLATE_1 - # - local-as 65536 - # - remote-as 65001 - # - address-family ipv4 unicast - # - advertise-map rmap1 non-exist-map nemap1 - # - advertisement-interval 60 - # - disable-peer-as-check - # - template peer neighbor_tmplt_2 - # - description Test_BGP_PEER_TEMPLATE_2 - # - inherit peer-session psession1 - # - timers 45 100 - # - address-family ipv4 multicast - # - advertise-map rmap1 exist-map emap1 - # - as-override - # - filter-list flist1 in - # - filter-list flist2 out - # - # after: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # bmp_activate_server: 2 - # capability: - # suppress_4_byte_as: true - # description: Test_BGP_PEER_TEMPLATE_1 - # local_as: "65536" - # remote_as: "65001" - # - # - name: neighbor_tmplt_2 - # description: Test_BGP_PEER_TEMPLATE_2 - # address_family: - # - afi: ipv4 - # safi: multicast - # advertise_map: - # exist_map: emap1 - # route_map: rmap1 - # as_override: true - # filter_list: - # inbound: flist1 - # outbound: flist2 - # inherit: - # peer_session: psession1 - # timers: - # holdtime: 100 - # keepalive: 45 - - # After state: - # -------------- - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # capability suppress 4-byte-as - # bmp-activate-server 2 - # description Test_BGP_PEER_TEMPLATE_1 - # local-as 65536 - # remote-as 65001 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - # template peer neighbor_tmplt_2 - # description Test_BGP_PEER_TEMPLATE_2 - # inherit peer-session psession1 - # timers 45 100 - # address-family ipv4 multicast - # advertise-map rmap1 exist-map emap1 - # as-override - # filter-list flist1 in - # filter-list flist2 out - - # Using replaced - - # Before state: - # ------------- - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # capability suppress 4-byte-as - # description Test_BGP_PEER_TEMPLATE_1 - # bmp-activate-server 2 - # local-as 65536 - # remote-as 65001 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - # template peer neighbor_tmplt_2 - # description Test_BGP_PEER_TEMPLATE_2 - # inherit peer-session psession1 - # timers 45 100 - # address-family ipv4 multicast - # advertise-map rmap1 exist-map emap1 - # as-override - # filter-list flist1 in - # filter-list flist2 out - - - name: Replace BGP templates configuration with provided configuration - cisco.nxos.nxos_bgp_templates: - config: - as_number: 65536 - neighbor: - - name: neighbor_tmplt_1 - address_family: - - afi: ipv4 - safi: unicast - advertise_map: - route_map: rmap1 - non_exist_map: nemap1 - advertisement_interval: 60 - disable_peer_as_check: true - inherit: - peer_session: psession1 - description: Test_BGP_PEER_TEMPLATE_1 - local_as: 65537 - state: replaced - - # Task output: - # ------------ - # - # before: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # bmp_activate_server: 2 - # capability: - # suppress_4_byte_as: true - # description: Test_BGP_PEER_TEMPLATE_1 - # local_as: "65536" - # remote_as: "65001" - # - # - name: neighbor_tmplt_2 - # description: Test_BGP_PEER_TEMPLATE_2 - # address_family: - # - afi: ipv4 - # safi: multicast - # advertise_map: - # exist_map: emap1 - # route_map: rmap1 - # as_override: true - # filter_list: - # inbound: flist1 - # outbound: flist2 - # inherit: - # peer_session: psession1 - # timers: - # holdtime: 100 - # keepalive: 45 - # - # commands: - # - router bgp 65536 - # - template peer neighbor_tmplt_1 - # - no bmp-activate-server 2 - # - no capability suppress 4-byte-as - # - inherit peer-session psession1 - # - local-as 65537 - # - no remote-as 65001 - # - # after: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # description: Test_BGP_PEER_TEMPLATE_1 - # inherit: - # peer_session: psession1 - # local_as: "65537" - # - # - name: neighbor_tmplt_2 - # description: Test_BGP_PEER_TEMPLATE_2 - # address_family: - # - afi: ipv4 - # safi: multicast - # advertise_map: - # exist_map: emap1 - # route_map: rmap1 - # as_override: true - # filter_list: - # inbound: flist1 - # outbound: flist2 - # inherit: - # peer_session: psession1 - # timers: - # holdtime: 100 - # keepalive: 45 - - # After state: - # ------------ - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # inherit peer-session psession1 - # description Test_BGP_PEER_TEMPLATE_1 - # local-as 65537 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - # template peer neighbor_tmplt_2 - # description Test_BGP_PEER_TEMPLATE_2 - # inherit peer-session psession1 - # bmp-activate-server 2 - # timers 45 100 - # address-family ipv4 multicast - # advertise-map rmap1 exist-map emap1 - # as-override - # filter-list flist1 in - # filter-list flist2 out - - # Using overridden - # - # Before state: - # ------------- - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # capability suppress 4-byte-as - # description Test_BGP_PEER_TEMPLATE_1 - # bmp-activate-server 2 - # local-as 65536 - # remote-as 65001 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - # template peer neighbor_tmplt_2 - # description Test_BGP_PEER_TEMPLATE_2 - # inherit peer-session psession1 - # timers 45 100 - # address-family ipv4 multicast - # advertise-map rmap1 exist-map emap1 - # as-override - # filter-list flist1 in - # filter-list flist2 out - - - name: Override BGP templates configuration with provided configuration - cisco.nxos.nxos_bgp_templates: - config: - as_number: 65536 - neighbor: - - name: neighbor_tmplt_1 - address_family: - - afi: ipv4 - safi: unicast - advertise_map: - route_map: rmap1 - non_exist_map: nemap1 - advertisement_interval: 60 - disable_peer_as_check: true - inherit: - peer_session: psession1 - description: Test_BGP_PEER_TEMPLATE_1 - local_as: 65537 - state: overridden - - # Task output: - # ------------ - # - # before: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # bmp_activate_server: 2 - # capability: - # suppress_4_byte_as: true - # description: Test_BGP_PEER_TEMPLATE_1 - # local_as: "65536" - # remote_as: "65001" - # - # - name: neighbor_tmplt_2 - # description: Test_BGP_PEER_TEMPLATE_2 - # address_family: - # - afi: ipv4 - # safi: multicast - # advertise_map: - # exist_map: emap1 - # route_map: rmap1 - # as_override: true - # filter_list: - # inbound: flist1 - # outbound: flist2 - # inherit: - # peer_session: psession1 - # timers: - # holdtime: 100 - # keepalive: 45 - # - # commands: - # - router bgp 65536 - # - template peer neighbor_tmplt_1 - # - no bmp-activate-server 2 - # - no capability suppress 4-byte-as - # - inherit peer-session psession1 - # - local-as 65537 - # - no remote-as 65001 - # - no template peer neighbor_tmplt_2 - # - # after: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # description: Test_BGP_PEER_TEMPLATE_1 - # inherit: - # peer_session: psession1 - # local_as: "65537" - - # After state: - # ------------ - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # inherit peer-session psession1 - # description Test_BGP_PEER_TEMPLATE_1 - # local-as 65537 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - - # Using deleted - - # Before state: - # -------------- - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # capability suppress 4-byte-as - # description Test_BGP_PEER_TEMPLATE_1 - # bmp-activate-server 2 - # local-as 65536 - # remote-as 65001 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - # template peer neighbor_tmplt_2 - # description Test_BGP_PEER_TEMPLATE_2 - # inherit peer-session psession1 - # timers 45 100 - # address-family ipv4 multicast - # advertise-map rmap1 exist-map emap1 - # as-override - # filter-list flist1 in - # filter-list flist2 out - - - name: Delete BGP configs handled by this module - cisco.nxos.nxos_bgp_templates: - state: deleted - - # Task output: - # ------------ - # - # before: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # bmp_activate_server: 2 - # capability: - # suppress_4_byte_as: true - # description: Test_BGP_PEER_TEMPLATE_1 - # local_as: "65536" - # remote_as: "65001" - # - # - name: neighbor_tmplt_2 - # description: Test_BGP_PEER_TEMPLATE_2 - # address_family: - # - afi: ipv4 - # safi: multicast - # advertise_map: - # exist_map: emap1 - # route_map: rmap1 - # as_override: true - # filter_list: - # inbound: flist1 - # outbound: flist2 - # inherit: - # peer_session: psession1 - # timers: - # holdtime: 100 - # keepalive: 45 - # - # commands: - # - router bgp 65536 - # - no template peer neighbor_tmplt_1 - # - no template peer neighbor_tmplt_2 - # - # after: {} - - # After state: - # ------------- - # nxos9k# show running-config | section "^router bgp" - # nxos9k# - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['router bgp 65536', 'template peer neighbor_tmplt_1', 'no bmp-activate-server 2', 'no capability suppress 4-byte-as', 'inherit peer-session psession1', 'local-as 65537', 'no remote-as 65001', 'no template peer neighbor_tmplt_2']
-
-
- gathered - -
- dictionary -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- dictionary -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['router bgp 65536', 'template peer neighbor_tmplt_1', 'bmp-activate-server 2', 'no capability suppress 4-byte-as', 'no template peer neighbor_tmplt_2']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_command_module.rst b/docs/cisco.nxos.nxos_command_module.rst deleted file mode 100644 index 4308a6582..000000000 --- a/docs/cisco.nxos.nxos_command_module.rst +++ /dev/null @@ -1,258 +0,0 @@ -.. _cisco.nxos.nxos_command_module: - - -*********************** -cisco.nxos.nxos_command -*********************** - -**Run arbitrary command on Cisco NXOS devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Sends an arbitrary command to an NXOS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- commands - -
- list - / elements=raw - / required -
- 		- -
The commands to send to the remote NXOS device. The resulting output from the command is returned. If the wait_for argument is provided, the module is not returned until the condition is satisfied or the number of retires as expired.
-
The commands argument also accepts an alternative form that allows for complex values that specify the command to run and the output format to return. This can be done on a command by command basis. The complex argument supports the keywords command and output where command is the command to run and output is one of 'text' or 'json'.
-
If a command sent to the device requires answering a prompt, it is possible to pass a dict containing command, answer and prompt. Common answers are 'y' or "\r" (carriage return, must be double quotes). See examples.
-
-
- interval - -
- integer -
- 		- Default:
1
- 		-
Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditional, the interval indicates how to long to wait before trying the command again.
-
-
- match - -
- string -
- 		-
    Choices: -
  • any
    • -
  • all ←
    • -
- 		-
The match argument is used in conjunction with the wait_for argument to specify the match policy. Valid values are all or any. If the value is set to all then all conditionals in the wait_for must be satisfied. If the value is set to any then only one of the values must be satisfied.
-
-
- retries - -
- integer -
- 		- Default:
9
- 		-
Specifies the number of retries a command should by tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait_for conditionals.
-
The commands are run once when retries is set to 0.
-
-
- wait_for - -
- list - / elements=string -
- 		- -
Specifies what to evaluate from the output of the command and what conditionals to apply. This argument will cause the task to wait for a particular conditional to be true before moving forward. If the conditional is not true by the configured retries, the task fails. See examples.
-

aliases: waitfor
-
-
- - -Notes ------ - -.. note:: - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: run show version on remote devices - cisco.nxos.nxos_command: - commands: show version - - - name: run show version and check to see if output contains Cisco - cisco.nxos.nxos_command: - commands: show version - wait_for: result[0] contains Cisco - - - name: run multiple commands on remote nodes - cisco.nxos.nxos_command: - commands: - - show version - - show interfaces - - - name: run multiple commands and evaluate the output - cisco.nxos.nxos_command: - commands: - - show version - - show interfaces - wait_for: - - result[0] contains Cisco - - result[1] contains loopback0 - - - name: run commands and specify the output format - cisco.nxos.nxos_command: - commands: - - command: show version - output: json - - - name: run commands that require answering a prompt - cisco.nxos.nxos_command: - commands: - - configure terminal - - command: no feature npv - prompt: Do you want to continue - answer: y - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- failed_conditions - -
- list -
- 		failed -
The list of conditionals that have failed
-
-
Sample:
-
['...', '...']
-
-
- stdout - -
- list -
- 		always apart from low level errors (such as action plugin) -
The set of responses from the commands
-
-
Sample:
-
['...', '...']
-
-
- stdout_lines - -
- list -
- 		always apart from low level errors (such as action plugin) -
The value of stdout split into a list
-
-
Sample:
-
[['...', '...'], ['...'], ['...']]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_config_module.rst b/docs/cisco.nxos.nxos_config_module.rst deleted file mode 100644 index 3ead5ab50..000000000 --- a/docs/cisco.nxos.nxos_config_module.rst +++ /dev/null @@ -1,566 +0,0 @@ -.. _cisco.nxos.nxos_config_module: - - -********************** -cisco.nxos.nxos_config -********************** - -**Manage Cisco NXOS configuration sections** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- 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. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- after - -
- list - / elements=string -
- 		- -
The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with before this allows the playbook designer to append a set of commands to be executed after the command set.
-
-
- backup - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
This argument will cause the module to create a full backup of the current running-config from the remote device before any changes are made. If the backup_options value is not given, the backup file is written to the backup folder in the playbook root directory or role root directory, if playbook is part of an ansible role. If the directory does not exist, it is created.
-
-
- backup_options - -
- dictionary -
- 		- -
This is a dict object containing configurable options related to backup file path. The value of this option is read only when backup is set to True, if backup is set to false this option will be silently ignored.
-
-
- dir_path - -
- path -
- 		- -
This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be created and the filename is either the value of filename or default filename as described in filename options description. If the path value is not given in that case a backup directory will be created in the current working directory and backup configuration will be copied in filename within backup directory.
-
-
- filename - -
- string -
- 		- -
The filename to be used to store the backup configuration. If the filename is not given it will be generated based on the hostname, current time and date in format defined by <hostname>_config.<current-date>@<current-time>
-
-
- before - -
- list - / elements=string -
- 		- -
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.
-
-
- defaults - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
The 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
-
-
- diff_against - -
- string -
- 		-
    Choices: -
  • startup
    • -
  • intended
    • -
  • running
    • -
- 		-
When using the ansible-playbook --diff command line argument the module can generate diffs against different sources.
-
When this option is configure as startup, the module will return the diff of the running-config against the startup-config.
-
When this option is configured as intended, the module will return the diff of the running-config against the configuration provided in the intended_config argument.
-
When this option is configured as running, the module will return the before and after diff of the running-config with respect to any changes made to the device configuration.
-
-
- diff_ignore_lines - -
- list - / elements=string -
- 		- -
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.
-
-
- intended_config - -
- string -
- 		- -
The 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 diff_against value and set it to intended. The configuration lines for this value should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure correct diff.
-
-
- lines - -
- list - / elements=string -
- 		- -
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 to ensure idempotency and correct diff. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser.
-

aliases: commands
-
-
- match - -
- string -
- 		-
    Choices: -
  • line ←
    • -
  • strict
    • -
  • exact
    • -
  • none
    • -
- 		-
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 line, commands are matched line by line. If match is set to strict, command lines are matched with respect to position. If match is set to exact, command lines must be an equal match. Finally, if match is set to none, the module will not attempt to compare the source configuration with the running configuration on the remote device.
-
-
- parents - -
- list - / elements=string -
- 		- -
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.
-
-
- replace - -
- string -
- 		-
    Choices: -
  • line ←
    • -
  • block
    • -
  • config
    • -
- 		-
Instructs the module on the way to perform the configuration on the device. If the replace argument is set to line then the modified lines are pushed to the device in configuration mode. If the replace argument is set to block then the entire command block is pushed to the device in configuration mode if any line is not correct. replace config will only work for NX-OS versions that support `config replace`.
-
-
- replace_src - -
- string -
- 		- -
The 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 replace with value config. This is mutually exclusive with the lines and src arguments. This argument will only work for NX-OS versions that support `config replace`. Use nxos_file_copy module to copy the flat file to remote device and then use the path with this argument. The configuration lines in the file should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure idempotency and correct diff.
-
-
- running_config - -
- string -
- 		- -
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 running_config argument allows the implementer to pass in the configuration to use as the base config for comparison. The configuration lines for this option should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure idempotency and correct diff.
-

aliases: config
-
-
- save_when - -
- string -
- 		-
    Choices: -
  • always
    • -
  • never ←
    • -
  • modified
    • -
  • changed
    • -
- 		-
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 always, then the running-config will always be copied to the startup-config and the modified flag will always be set to True. If the argument is set to 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 never, the running-config will never be copied to the startup-config. If the argument is set to changed, then the running-config will only be copied to the startup-config if the task has made a change. changed was added in Ansible 2.6.
-
-
- src - -
- path -
- 		- -
The 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 lines and parents arguments. The configuration lines in the source file should be similar to how it will appear if present in the running-configuration of the device including indentation to ensure idempotency and correct diff.
-
-
- - -Notes ------ - -.. note:: - - Unsupported for Cisco MDS - - Abbreviated commands are NOT idempotent, see https://docs.ansible.com/ansible/latest/network/user_guide/faq.html#why-do-the-config-modules-always-return-changed-true-with-abbreviated-commands. - - To ensure idempotency and correct diff the configuration lines in the relevant module options should be similar to how they appear if present in the running configuration on device including the indentation. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: configure top level configuration and save it - cisco.nxos.nxos_config: - lines: hostname {{ inventory_hostname }} - save_when: modified - - - name: diff the running-config against a provided config - cisco.nxos.nxos_config: - diff_against: intended - intended_config: "{{ lookup('file', 'master.cfg') }}" - - - cisco.nxos.nxos_config: - lines: - - 10 permit ip 192.0.2.1/32 any log - - 20 permit ip 192.0.2.2/32 any log - - 30 permit ip 192.0.2.3/32 any log - - 40 permit ip 192.0.2.4/32 any log - - 50 permit ip 192.0.2.5/32 any log - parents: ip access-list test - before: no ip access-list test - match: exact - - - cisco.nxos.nxos_config: - lines: - - 10 permit ip 192.0.2.1/32 any log - - 20 permit ip 192.0.2.2/32 any log - - 30 permit ip 192.0.2.3/32 any log - - 40 permit ip 192.0.2.4/32 any log - parents: ip access-list test - before: no ip access-list test - replace: block - - - name: replace config with flat file - cisco.nxos.nxos_config: - replace_src: config.txt - replace: config - - - name: for idempotency, use full-form commands - cisco.nxos.nxos_config: - lines: - # - shut - - shutdown - # parents: int eth1/1 - parents: interface Ethernet1/1 - - - name: configurable backup path - cisco.nxos.nxos_config: - backup: true - backup_options: - filename: backup.cfg - dir_path: /home/user - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- backup_path - -
- string -
- 		when backup is yes -
The full path to the backup file
-
-
Sample:
-
/playbooks/ansible/backup/nxos_config.2016-07-16@22:28:34
-
-
- commands - -
- list -
- 		always -
The set of commands that will be pushed to the remote device
-
-
Sample:
-
['hostname foo', 'vlan 1', 'name default']
-
-
- date - -
- string -
- 		when backup is yes -
The date extracted from the backup file name
-
-
Sample:
-
2016-07-16
-
-
- filename - -
- string -
- 		when backup is yes and filename is not specified in backup options -
The name of the backup file
-
-
Sample:
-
nxos_config.2016-07-16@22:28:34
-
-
- shortname - -
- string -
- 		when backup is yes and filename is not specified in backup options -
The full path to the backup file excluding the timestamp
-
-
Sample:
-
/playbooks/ansible/backup/nxos_config
-
-
- time - -
- string -
- 		when backup is yes -
The time extracted from the backup file name
-
-
Sample:
-
22:28:34
-
-
- updates - -
- list -
- 		always -
The set of commands that will be pushed to the remote device
-
-
Sample:
-
['hostname foo', 'vlan 1', 'name default']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_devicealias_module.rst b/docs/cisco.nxos.nxos_devicealias_module.rst deleted file mode 100644 index 081c8759f..000000000 --- a/docs/cisco.nxos.nxos_devicealias_module.rst +++ /dev/null @@ -1,273 +0,0 @@ -.. _cisco.nxos.nxos_devicealias_module: - - -*************************** -cisco.nxos.nxos_devicealias -*************************** - -**Configuration of device alias for Cisco NXOS MDS Switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configuration of device alias for Cisco MDS NXOS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- da - -
- list - / elements=dictionary -
- 		- -
List of device-alias to be added or removed
-
-
- name - -
- string - / required -
- 		- -
Name of the device-alias to be added or removed
-
-
- pwwn - -
- string -
- 		- -
pwwn to which the name needs to be associated with
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Removes the device-alias if set to True
-
-
- distribute - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable device-alias distribution
-
-
- mode - -
- string -
- 		-
    Choices: -
  • basic
    • -
  • enhanced
    • -
- 		-
Mode of devices-alias, basic or enhanced
-
-
- rename - -
- list - / elements=dictionary -
- 		- -
List of device-alias to be renamed
-
-
- new_name - -
- string - / required -
- 		- -
New name of the device-alias
-
-
- old_name - -
- string - / required -
- 		- -
Old name of the device-alias that needs to be renamed
-
-
- - -Notes ------ - -.. note:: - - Tested against Cisco MDS NX-OS 8.4(1) - - - -Examples --------- - -.. code-block:: yaml - - - name: Test that device alias module works - cisco.nxos.nxos_devicealias: - da: - - name: test1_add - pwwn: 56:2:22:11:22:88:11:67 - - name: test2_add - pwwn: 65:22:22:11:22:22:11:d - - name: dev1 - remove: true - - name: dev2 - remove: true - distribute: true - mode: enhanced - rename: - - new_name: bcd - old_name: abc - - new_name: bcd1 - old_name: abc1 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['terminal dont-ask', 'device-alias database', 'device-alias name somename pwwn 10:00:00:00:89:a1:01:03', 'device-alias name somename1 pwwn 10:00:00:00:89:a1:02:03', 'device-alias commit', 'no terminal dont-ask']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) diff --git a/docs/cisco.nxos.nxos_evpn_global_module.rst b/docs/cisco.nxos.nxos_evpn_global_module.rst deleted file mode 100644 index d1b2a8241..000000000 --- a/docs/cisco.nxos.nxos_evpn_global_module.rst +++ /dev/null @@ -1,122 +0,0 @@ -.. _cisco.nxos.nxos_evpn_global_module: - - -*************************** -cisco.nxos.nxos_evpn_global -*************************** - -**Handles the EVPN control plane for VXLAN.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Handles the EVPN control plane for VXLAN. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- nv_overlay_evpn - -
- boolean - / required -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
EVPN control plane.
-
-
- - -Notes ------ - -.. note:: - - This module is not supported on Nexus 3000 series of switches. - - Unsupported for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_evpn_global: - nv_overlay_evpn: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The set of commands to be sent to the remote device
-
-
Sample:
-
['nv overlay evpn']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_evpn_vni_module.rst b/docs/cisco.nxos.nxos_evpn_vni_module.rst deleted file mode 100644 index 530a9ff18..000000000 --- a/docs/cisco.nxos.nxos_evpn_vni_module.rst +++ /dev/null @@ -1,212 +0,0 @@ -.. _cisco.nxos.nxos_evpn_vni_module: - - -************************ -cisco.nxos.nxos_evpn_vni -************************ - -**Manages Cisco EVPN VXLAN Network Identifier (VNI).** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages Cisco Ethernet Virtual Private Network (EVPN) VXLAN Network Identifier (VNI) configurations of a Nexus device. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- route_distinguisher - -
- string -
- 		- -
The VPN Route Distinguisher (RD). The RD is combined with the IPv4 or IPv6 prefix learned by the PE router to create a globally unique address.
-
-
- route_target_both - -
- list - / elements=string -
- 		- -
Enables/Disables route-target settings for both import and export target communities using a single property.
-
-
- route_target_export - -
- list - / elements=string -
- 		- -
Sets the route-target 'export' extended communities.
-
-
- route_target_import - -
- list - / elements=string -
- 		- -
Sets the route-target 'import' extended communities.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Determines whether the config should be present or not on the device.
-
-
- vni - -
- string - / required -
- 		- -
The EVPN VXLAN Network Identifier.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - default, where supported, restores params default value. - - RD override is not permitted. You should set it to the default values first and then reconfigure it. - - ``route_target_both``, ``route_target_import`` and ``route_target_export valid`` values are a list of extended communities, (i.e. ['1.2.3.4:5', '33:55']) or the keywords 'auto' or 'default'. - - The ``route_target_both`` property is discouraged due to the inconsistent behavior of the property across Nexus platforms and image versions. For this reason it is recommended to use explicit ``route_target_export`` and ``route_target_import`` properties instead of ``route_target_both``. - - RD valid values are a string in one of the route-distinguisher formats, the keyword 'auto', or the keyword 'default'. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: vni configuration - cisco.nxos.nxos_evpn_vni: - vni: 6000 - route_distinguisher: 60:10 - route_target_import: - - "5000:10" - - "4100:100" - route_target_export: auto - route_target_both: default - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['evpn', 'vni 6000 l2', 'route-target import 5001:10']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_facts_module.rst b/docs/cisco.nxos.nxos_facts_module.rst deleted file mode 100644 index 3ce96abea..000000000 --- a/docs/cisco.nxos.nxos_facts_module.rst +++ /dev/null @@ -1,553 +0,0 @@ -.. _cisco.nxos.nxos_facts_module: - - -********************* -cisco.nxos.nxos_facts -********************* - -**Gets facts about NX-OS switches** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Collects facts from Cisco Nexus devices running the NX-OS operating system. Fact collection is supported over both ``network_cli`` and ``httpapi``. This module prepends all of the base network fact keys with ``ansible_net_``. The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- available_network_resources - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
When set to true a list of network resources for which resource modules are available will be provided.
-
-
- gather_network_resources - -
- list - / elements=string -
- 		- -
When supplied, this argument will gather configuration facts only for the given subset. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
-
Valid subsets are all, bfd_interfaces, lag_interfaces, telemetry, vlans, lacp, lacp_interfaces, interfaces, l3_interfaces, l2_interfaces, lldp_global, acls, acl_interfaces, ospfv2, ospfv3, ospf_interfaces, bgp_global, bgp_address_family, route_maps, prefix_lists, logging_global, ntp_global, snmp_server, hostname.
-
-
- gather_subset - -
- list - / elements=string -
- 		- Default:
"min"
- 		-
When supplied, this argument will gather operational facts only for the given subset. Possible values for this argument include all, hardware, config, legacy, interfaces, and min. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Gather all legacy facts - cisco.nxos.nxos_facts: - gather_subset: all - - name: Gather only the config and default facts - cisco.nxos.nxos_facts: - gather_subset: - - config - - name: Do not gather hardware facts - cisco.nxos.nxos_facts: - gather_subset: - - '!hardware' - - name: Gather legacy and resource facts - cisco.nxos.nxos_facts: - gather_subset: all - gather_network_resources: all - - name: Gather only the interfaces resource facts and no legacy facts - cisco.nxos.nxos_facts: - gather_subset: - - '!all' - - '!min' - gather_network_resources: - - interfaces - - name: Gather interfaces resource and minimal legacy facts - cisco.nxos.nxos_facts: - gather_subset: min - gather_network_resources: interfaces - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- ansible_net_all_ipv4_addresses - -
- list -
- 		when interfaces is configured -
All IPv4 addresses configured on the device
-
-
-
- ansible_net_all_ipv6_addresses - -
- list -
- 		when interfaces is configured -
All IPv6 addresses configured on the device
-
-
-
- ansible_net_api - -
- string -
- 		always -
The name of the transport
-
-
-
- ansible_net_config - -
- string -
- 		when config is configured -
The current active config from the device
-
-
-
- ansible_net_filesystems - -
- list -
- 		when hardware is configured -
All file system names available on the device
-
-
-
- ansible_net_gather_network_resources - -
- list -
- 		when the resource is configured -
The list of fact for network resource subsets collected from the device
-
-
-
- ansible_net_gather_subset - -
- list -
- 		always -
The list of fact subsets collected from the device
-
-
-
- ansible_net_hostname - -
- string -
- 		always -
The configured hostname of the device
-
-
-
- ansible_net_image - -
- string -
- 		always -
The image file the device is running
-
-
-
- ansible_net_interfaces - -
- dictionary -
- 		when interfaces is configured -
A hash of all interfaces running on the system
-
-
-
- ansible_net_license_hostid - -
- string -
- 		always -
The License host id of the device
-
-
-
- ansible_net_memfree_mb - -
- integer -
- 		when hardware is configured -
The available free memory on the remote device in Mb
-
-
-
- ansible_net_memtotal_mb - -
- integer -
- 		when hardware is configured -
The total memory on the remote device in Mb
-
-
-
- ansible_net_model - -
- string -
- 		always -
The model name returned from the device
-
-
-
- ansible_net_neighbors - -
- dictionary -
- 		when interfaces is configured -
The list of LLDP and CDP neighbors from the device. If both, CDP and LLDP neighbor data is present on one port, CDP is preferred.
-
-
-
- ansible_net_python_version - -
- string -
- 		always -
The Python version Ansible controller is using
-
-
-
- ansible_net_serialnum - -
- string -
- 		always -
The serial number of the remote device
-
-
-
- ansible_net_version - -
- string -
- 		always -
The operating system version running on the remote device
-
-
-
- fan_info - -
- dictionary -
- 		when legacy is configured -
A hash of facts about fans in the remote device
-
-
-
- hostname - -
- dictionary -
- 		when legacy is configured -
The configured hostname of the remote device
-
-
-
- interfaces_list - -
- dictionary -
- 		when legacy is configured -
The list of interface names on the remote device
-
-
-
- kickstart - -
- string -
- 		when legacy is configured -
The software version used to boot the system
-
-
-
- module - -
- dictionary -
- 		when legacy is configured -
A hash of facts about the modules in a remote device
-
-
-
- platform - -
- string -
- 		when legacy is configured -
The hardware platform reported by the remote device
-
-
-
- power_supply_info - -
- string -
- 		when legacy is configured -
A hash of facts about the power supplies in the remote device
-
-
-
- vlan_list - -
- list -
- 		when legacy is configured -
The list of VLAN IDs configured on the remote device
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_feature_module.rst b/docs/cisco.nxos.nxos_feature_module.rst deleted file mode 100644 index ee2539180..000000000 --- a/docs/cisco.nxos.nxos_feature_module.rst +++ /dev/null @@ -1,150 +0,0 @@ -.. _cisco.nxos.nxos_feature_module: - - -*********************** -cisco.nxos.nxos_feature -*********************** - -**Manage features in NX-OS switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Offers ability to enable and disable features in NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- feature - -
- string - / required -
- 		- -
Name of feature.
-
-
- state - -
- string -
- 		-
    Choices: -
  • enabled ←
    • -
  • disabled
    • -
- 		-
Desired state of the feature.
-
-
- - -Notes ------ - -.. note:: - - Tested against Cisco MDS NX-OS 9.2(2) - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - 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 Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The set of commands to be sent to the remote device
-
-
Sample:
-
['nv overlay evpn']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) -- Suhas Bharadwaj (@srbharadwaj) diff --git a/docs/cisco.nxos.nxos_gir_module.rst b/docs/cisco.nxos.nxos_gir_module.rst deleted file mode 100644 index 61c809ea0..000000000 --- a/docs/cisco.nxos.nxos_gir_module.rst +++ /dev/null @@ -1,302 +0,0 @@ -.. _cisco.nxos.nxos_gir_module: - - -******************* -cisco.nxos.nxos_gir -******************* - -**Trigger a graceful removal or insertion (GIR) of the switch.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Trigger a graceful removal or insertion (GIR) of the switch. -- GIR processing may take more than 2 minutes. Timeout settings are automatically extended to 200s when user timeout settings are insufficient. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Specify desired state of the resource.
-
-
- system_mode_maintenance - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
When system_mode_maintenance=true it puts all enabled protocols in maintenance mode (using the isolate command). When system_mode_maintenance=false it puts all enabled protocols in normal mode (using the no isolate command).
-
-
- system_mode_maintenance_dont_generate_profile - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
When system_mode_maintenance_dont_generate_profile=true it prevents the dynamic searching of enabled protocols and executes commands configured in a maintenance-mode profile. Use this option if you want the system to use a maintenance-mode profile that you have created. When system_mode_maintenance_dont_generate_profile=false it prevents the dynamic searching of enabled protocols and executes commands configured in a normal-mode profile. Use this option if you want the system to use a normal-mode profile that you have created.
-
-
- system_mode_maintenance_on_reload_reset_reason - -
- string -
- 		-
    Choices: -
  • hw_error
    • -
  • svc_failure
    • -
  • kern_failure
    • -
  • wdog_timeout
    • -
  • fatal_error
    • -
  • lc_failure
    • -
  • match_any
    • -
  • manual_reload
    • -
  • any_other
    • -
  • maintenance
    • -
- 		-
Boots the switch into maintenance mode automatically in the event of a specified system crash. Note that not all reset reasons are applicable for all platforms. Also if reset reason is set to match_any, it is not idempotent as it turns on all reset reasons. If reset reason is match_any and state is absent, it turns off all the reset reasons.
-
-
- system_mode_maintenance_shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Shuts down all protocols, vPC domains, and interfaces except the management interface (using the shutdown command). This option is disruptive while system_mode_maintenance (which uses the isolate command) is not.
-
-
- system_mode_maintenance_timeout - -
- string -
- 		- -
Keeps the switch in maintenance mode for a specified number of minutes. Range is 5-65535.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - ``state`` has effect only in combination with ``system_mode_maintenance_timeout`` or ``system_mode_maintenance_on_reload_reset_reason``. - - Using ``system_mode_maintenance`` and ``system_mode_maintenance_dont_generate_profile`` would make the module fail, but the system mode will be triggered anyway. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Trigger system maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance: true - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Trigger system normal mode - - cisco.nxos.nxos_gir: - system_mode_maintenance: false - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Configure on-reload reset-reason for maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance_on_reload_reset_reason: manual_reload - state: present - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Add on-reload reset-reason for maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance_on_reload_reset_reason: hw_error - state: present - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Remove on-reload reset-reason for maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance_on_reload_reset_reason: manual_reload - state: absent - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Set timeout for maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance_timeout: 30 - state: present - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Remove timeout for maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance_timeout: 30 - state: absent - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- final_system_mode - -
- string -
- 		verbose mode -
describe the last system mode
-
-
Sample:
-
normal
-
-
- updates - -
- list -
- 		verbose mode -
commands sent to the device
-
-
Sample:
-
['terminal dont-ask', 'system mode maintenance timeout 10']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_gir_profile_management_module.rst b/docs/cisco.nxos.nxos_gir_profile_management_module.rst deleted file mode 100644 index 95d85ae9b..000000000 --- a/docs/cisco.nxos.nxos_gir_profile_management_module.rst +++ /dev/null @@ -1,235 +0,0 @@ -.. _cisco.nxos.nxos_gir_profile_management_module: - - -************************************** -cisco.nxos.nxos_gir_profile_management -************************************** - -**Create a maintenance-mode or normal-mode profile for GIR.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manage a maintenance-mode or normal-mode profile with configuration commands that can be applied during graceful removal or graceful insertion. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- commands - -
- list - / elements=string -
- 		- -
List of commands to be included into the profile.
-
-
- mode - -
- string - / required -
- 		-
    Choices: -
  • maintenance
    • -
  • normal
    • -
- 		-
Configure the profile as Maintenance or Normal mode.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Specify desired state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - ``state=absent`` removes the whole profile. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Create a maintenance-mode profile - - cisco.nxos.nxos_gir_profile_management: - mode: maintenance - commands: - - router eigrp 11 - - isolate - - # Remove the maintenance-mode profile - - cisco.nxos.nxos_gir_profile_management: - mode: maintenance - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- end_state - -
- list -
- 		verbose mode -
list of profile entries after module execution.
-
-
Sample:
-
['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete', 'router eigrp 11', 'isolate']
-
-
- existing - -
- list -
- 		verbose mode -
list of existing profile commands.
-
-
Sample:
-
['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete']
-
-
- proposed - -
- list -
- 		verbose mode -
list of commands passed into module.
-
-
Sample:
-
['router eigrp 11', 'isolate']
-
-
- updates - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['configure maintenance profile maintenance-mode', 'router eigrp 11', 'isolate']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_hostname_module.rst b/docs/cisco.nxos.nxos_hostname_module.rst deleted file mode 100644 index c8a9ee45d..000000000 --- a/docs/cisco.nxos.nxos_hostname_module.rst +++ /dev/null @@ -1,344 +0,0 @@ -.. _cisco.nxos.nxos_hostname_module: - - -************************ -cisco.nxos.nxos_hostname -************************ - -**Hostname resource module.** - - -Version added: 2.9.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages hostname configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A dictionary of hostname configuration.
-
-
- hostname - -
- string -
- 		- -
Hostname of the device.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section hostname.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
The states merged, replaced and overridden have identical behaviour for this module.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged (replaced, overridden has the same behaviour) - - # Before state: - # ------------- - # nxos-9k-rdo# show running-config | section ^hostname - # nxos-9k-rdo# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_hostname: - config: - hostname: NXOSv-9k - - # Task output - # ------------- - # before: {} - # - # commands: - # - hostname NXOSv-9k - # - # after: - # hostname: NXOSv-9k - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section ^hostname - # hostname NXOSv-9k - # - - # Using deleted - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section ^hostname - # hostname NXOSv-9k - - - name: Delete hostname from running-config - cisco.nxos.nxos_hostname: - state: deleted - - # Task output - # ------------- - # before: - # hostname: NXOSv-9k - # - # commands: - # - no hostname NXOSv-9k - # - # after: {} - - # Using gathered - - - name: Gather hostname facts using gathered - cisco.nxos.nxos_hostname: - state: gathered - - # Task output (redacted) - # ----------------------- - # gathered: - # hostname: NXOSv-9k - - # Using rendered - - - name: Render platform specific configuration lines (without connecting to the device) - cisco.nxos.nxos_hostname: - config: - hostname: NXOSv-9k - - # Task Output (redacted) - # ----------------------- - # rendered: - # - hostname NXOSv-9k - - # Using parsed - - # parsed.cfg - # ------------ - # hostname NXOSv-9k - - - name: Parse externally provided hostname config - cisco.nxos.nxos_hostname: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # hostname: NXOSv-9k - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['hostname switch01']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['hostname switch01']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst b/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst deleted file mode 100644 index 163612413..000000000 --- a/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst +++ /dev/null @@ -1,344 +0,0 @@ -.. _cisco.nxos.nxos_hsrp_interfaces_module: - - -******************************* -cisco.nxos.nxos_hsrp_interfaces -******************************* - -**HSRP interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages Hot Standby Router Protocol (HSRP) interface attributes. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
The provided configuration
-
-
- bfd - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Enable/Disable HSRP Bidirectional Forwarding Detection (BFD) on the interface.
-
-
- name - -
- string -
- 		- -
The name of the interface.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 7.0(3)I5(1). - - Feature bfd should be enabled for this module. - - Unsupported for Cisco MDS - - - -Examples --------- - -.. code-block:: yaml - - # Using deleted - - - name: Configure hsrp attributes on interfaces - cisco.nxos.nxos_hsrp_interfaces: - config: - - name: Ethernet1/1 - - name: Ethernet1/2 - operation: deleted - - - # Using merged - - - name: Configure hsrp attributes on interfaces - cisco.nxos.nxos_hsrp_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - - name: Ethernet1/2 - bfd: disable - operation: merged - - - # Using overridden - - - name: Configure hsrp attributes on interfaces - cisco.nxos.nxos_hsrp_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - - name: Ethernet1/2 - bfd: disable - operation: overridden - - - # Using replaced - - - name: Configure hsrp attributes on interfaces - cisco.nxos.nxos_hsrp_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - - name: Ethernet1/2 - bfd: disable - operation: replaced - - # Using rendered - - - name: Use rendered state to convert task input to device specific commands - cisco.nxos.nxos_hsrp_interfaces: - config: - - name: Ethernet1/800 - bfd: enable - - name: Ethernet1/801 - bfd: enable - state: rendered - - # Task Output (redacted) - # ----------------------- - - # rendered: - # - "interface Ethernet1/800" - # - "hsrp bfd" - # - "interface Ethernet1/801" - # - "hsrp bfd" - - # Using parsed - - # parsed.cfg - # ------------ - # interface Ethernet1/800 - # no switchport - # hsrp bfd - # interface Ethernet1/801 - # no switchport - # hsrp bfd - - - name: Use parsed state to convert externally supplied config to structured format - cisco.nxos.nxos_hsrp_interfaces: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - - # parsed: - # - name: Ethernet1/800 - # bfd: enable - # - name: Ethernet1/801 - # bfd: enable - - # Using gathered - - # Existing device config state - # ------------------------------- - - # interface Ethernet1/1 - # no switchport - # hsrp bfd - # interface Ethernet1/2 - # no switchport - # hsrp bfd - # interface Ethernet1/3 - # no switchport - - - name: Gather hsrp_interfaces facts from the device using nxos_hsrp_interfaces - cisco.nxos.nxos_hsrp_interfaces: - state: gathered - - # Task output (redacted) - # ----------------------- - - # gathered: - # - name: Ethernet1/1 - # bfd: enable - # - name: Ethernet1/2 - # bfd: enable - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/1', 'hsrp bfd']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_hsrp_module.rst b/docs/cisco.nxos.nxos_hsrp_module.rst deleted file mode 100644 index 0a55a4423..000000000 --- a/docs/cisco.nxos.nxos_hsrp_module.rst +++ /dev/null @@ -1,305 +0,0 @@ -.. _cisco.nxos.nxos_hsrp_module: - - -******************** -cisco.nxos.nxos_hsrp -******************** - -**Manages HSRP configuration on NX-OS switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages HSRP configuration on NX-OS switches. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- auth_string - -
- string -
- 		- -
Authentication string. If this needs to be hidden(for md5 type), the string should be 7 followed by the key string. Otherwise, it can be 0 followed by key string or just key string (for backward compatibility). For text type, this should be just be a key string. if this is 'default', authentication is removed.
-
-
- auth_type - -
- string -
- 		-
    Choices: -
  • text
    • -
  • md5
    • -
- 		-
Authentication type.
-
-
- group - -
- string - / required -
- 		- -
HSRP group number.
-
-
- interface - -
- string - / required -
- 		- -
Full name of interface that is being managed for HSRP.
-
-
- preempt - -
- string -
- 		-
    Choices: -
  • enabled
    • -
  • disabled
    • -
- 		-
Enable/Disable preempt.
-
-
- priority - -
- string -
- 		- -
HSRP priority or keyword 'default'.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Specify desired state of the resource.
-
-
- version - -
- string -
- 		-
    Choices: -
  • 1 ←
    • -
  • 2
    • -
- 		-
HSRP version.
-
-
- vip - -
- string -
- 		- -
HSRP virtual IP address or keyword 'default'
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - HSRP feature needs to be enabled first on the system. - - SVIs must exist before using this module. - - Interface must be a L3 port before using this module. - - HSRP cannot be configured on loopback interfaces. - - MD5 authentication is only possible with HSRPv2 while it is ignored if HSRPv1 is used instead, while it will not raise any error. Here we allow MD5 authentication only with HSRPv2 in order to enforce better practice. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Ensure HSRP is configured with following params on a SVI - cisco.nxos.nxos_hsrp: - group: 10 - vip: 10.1.1.1 - priority: 150 - interface: vlan10 - preempt: enabled - - - name: Ensure HSRP is configured with following params on a SVI with clear text authentication - cisco.nxos.nxos_hsrp: - group: 10 - vip: 10.1.1.1 - priority: 150 - interface: vlan10 - preempt: enabled - auth_type: text - auth_string: CISCO - - - name: Ensure HSRP is configured with md5 authentication and clear authentication - string - cisco.nxos.nxos_hsrp: - group: 10 - vip: 10.1.1.1 - priority: 150 - interface: vlan10 - preempt: enabled - auth_type: md5 - auth_string: 0 1234 - - - name: Ensure HSRP is configured with md5 authentication and hidden authentication - string - cisco.nxos.nxos_hsrp: - group: 10 - vip: 10.1.1.1 - priority: 150 - interface: vlan10 - preempt: enabled - auth_type: md5 - auth_string: 7 1234 - - - name: Remove HSRP config for given interface, group, and VIP - cisco.nxos.nxos_hsrp: - group: 10 - interface: vlan10 - vip: 10.1.1.1 - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['interface vlan10', 'hsrp version 2', 'hsrp 30', 'ip 10.30.1.1']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_igmp_module.rst b/docs/cisco.nxos.nxos_igmp_module.rst deleted file mode 100644 index dbb46206f..000000000 --- a/docs/cisco.nxos.nxos_igmp_module.rst +++ /dev/null @@ -1,191 +0,0 @@ -.. _cisco.nxos.nxos_igmp_module: - - -******************** -cisco.nxos.nxos_igmp -******************** - -**Manages IGMP global configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages IGMP global configuration configuration settings. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- enforce_rtr_alert - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables or disables the enforce router alert option check for IGMPv2 and IGMPv3 packets.
-
-
- flush_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Removes routes when the IGMP process is restarted. By default, routes are not flushed.
-
-
- restart - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Restarts the igmp process (using an exec config command).
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • default
    • -
- 		-
Manages desired state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - When ``state=default``, all supported params will be reset to a default state. - - If restart is set to true with other params set, the restart will happen last, i.e. after the configuration takes place. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Default igmp global params (all params except restart) - cisco.nxos.nxos_igmp: - state: default - - - name: Ensure the following igmp global config exists on the device - cisco.nxos.nxos_igmp: - flush_routes: true - enforce_rtr_alert: true - - - name: Restart the igmp process - cisco.nxos.nxos_igmp: - restart: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- updates - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['ip igmp flush-routes']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_igmp_snooping_module.rst b/docs/cisco.nxos.nxos_igmp_snooping_module.rst deleted file mode 100644 index 31af97509..000000000 --- a/docs/cisco.nxos.nxos_igmp_snooping_module.rst +++ /dev/null @@ -1,225 +0,0 @@ -.. _cisco.nxos.nxos_igmp_snooping_module: - - -***************************** -cisco.nxos.nxos_igmp_snooping -***************************** - -**Manages IGMP snooping global configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages IGMP snooping global configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- group_timeout - -
- string -
- 		- -
Group membership timeout value for all VLANs on the device. Accepted values are integer in range 1-10080, never and default.
-
-
- link_local_grp_supp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Global link-local groups suppression.
-
-
- report_supp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Global IGMPv1/IGMPv2 Report Suppression.
-
-
- snooping - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/disables IGMP snooping on the switch.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • default
    • -
- 		-
Manage the state of the resource.
-
-
- v3_report_supp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Global IGMPv3 Report Suppression and Proxy Reporting.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - When ``state=default``, params will be reset to a default state. - - ``group_timeout`` also accepts *never* as an input. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure igmp snooping params supported in this module are in there default state - - cisco.nxos.nxos_igmp_snooping: - state: default - - # ensure following igmp snooping params are in the desired state - - cisco.nxos.nxos_igmp_snooping: - group_timeout: never - snooping: true - link_local_grp_supp: false - optimize_mcast_flood: false - report_supp: true - v3_report_supp: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['ip igmp snooping link-local-groups-suppression', 'ip igmp snooping group-timeout 50', 'no ip igmp snooping report-suppression', 'no ip igmp snooping v3-report-suppression', 'no ip igmp snooping']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_install_os_module.rst b/docs/cisco.nxos.nxos_install_os_module.rst deleted file mode 100644 index ddd630d01..000000000 --- a/docs/cisco.nxos.nxos_install_os_module.rst +++ /dev/null @@ -1,183 +0,0 @@ -.. _cisco.nxos.nxos_install_os_module: - - -************************** -cisco.nxos.nxos_install_os -************************** - -**Set boot options like boot, kickstart image and issu.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Install an operating system by setting the boot options like boot image and kickstart image and optionally select to install using ISSU (In Server Software Upgrade). - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- issu - -
- string -
- 		-
    Choices: -
  • required
    • -
  • desired
    • -
  • yes
    • -
  • no ←
    • -
- 		-
Upgrade using In Service Software Upgrade (ISSU). (Supported on N5k, N7k, N9k platforms)
-
Selecting 'required' or 'yes' means that upgrades will only proceed if the switch is capable of ISSU.
-
Selecting 'desired' means that upgrades will use ISSU if possible but will fall back to disruptive upgrade if needed.
-
Selecting 'no' means do not use ISSU. Forced disruptive.
-
-
- kickstart_image_file - -
- string -
- 		- -
Name of the kickstart image file on flash. (Not required on all Nexus platforms)
-
-
- system_image_file - -
- string - / required -
- 		- -
Name of the system (or combined) image file on flash.
-
-
- - -Notes ------ - -.. note:: - - Tested against the following platforms and images - N9k 7.0(3)I4(6), 7.0(3)I5(3), 7.0(3)I6(1), 7.0(3)I7(1), 7.0(3)F2(2), 7.0(3)F3(2) - N3k 6.0(2)A8(6), 6.0(2)A8(8), 7.0(3)I6(1), 7.0(3)I7(1) - N7k 7.3(0)D1(1), 8.0(1), 8.1(1), 8.2(1) - - Tested against Cisco MDS NX-OS 9.2(1) - - This module requires both the ANSIBLE_PERSISTENT_CONNECT_TIMEOUT and ANSIBLE_PERSISTENT_COMMAND_TIMEOUT timers to be set to 600 seconds or higher. The module will exit if the timers are not set properly. - - When using connection local, ANSIBLE_PERSISTENT_CONNECT_TIMEOUT and ANSIBLE_PERSISTENT_COMMAND_TIMEOUT can only be set using ENV variables or the ansible.cfg file. - - Do not include full file paths, just the name of the file(s) stored on the top level flash directory. - - This module attempts to install the software immediately, which may trigger a reboot. - - In check mode, the module will indicate if an upgrade is needed and whether or not the upgrade is disruptive or non-disruptive(ISSU). - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Install OS on N9k - check_mode: false - cisco.nxos.nxos_install_os: - system_image_file: nxos.7.0.3.I6.1.bin - issu: desired - - - name: Wait for device to come back up with new image - wait_for: - port: 22 - state: started - timeout: 500 - delay: 60 - host: '{{ inventory_hostname }}' - - - name: Check installed OS for newly installed version - nxos_command: - commands: [show version | json] - register: output - - - assert: - that: - - output['stdout'][0]['kickstart_ver_str'] == '7.0(3)I6(1)' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- install_state - -
- dictionary -
- 		always -
Boot and install information.
-
-
Sample:
-
{'install_state': ['Compatibility check is done:', 'Module bootable Impact Install-type Reason', '------ -------- -------------- ------------ ------', ' 1 yes non-disruptive reset ', 'Images will be upgraded according to following table:', 'Module Image Running-Version(pri:alt) New-Version Upg-Required', '------ ---------- ---------------------------------------- -------------------- ------------', ' 1 nxos 7.0(3)I6(1) 7.0(3)I7(1) yes', ' 1 bios v4.4.0(07/12/2017) v4.4.0(07/12/2017) no']}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbibo (@GGabriele) diff --git a/docs/cisco.nxos.nxos_l2_interfaces_module.rst b/docs/cisco.nxos.nxos_l2_interfaces_module.rst deleted file mode 100644 index bfad0cf31..000000000 --- a/docs/cisco.nxos.nxos_l2_interfaces_module.rst +++ /dev/null @@ -1,648 +0,0 @@ -.. _cisco.nxos.nxos_l2_interfaces_module: - - -***************************** -cisco.nxos.nxos_l2_interfaces -***************************** - -**L2 interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages Layer-2 interfaces attributes of NX-OS Interfaces. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A dictionary of Layer-2 interface options
-
-
- access - -
- dictionary -
- 		- -
Switchport mode access command to configure the interface as a Layer-2 access.
-
-
- vlan - -
- integer -
- 		- -
Configure given VLAN in access port. It's used as the access VLAN ID.
-
-
- mode - -
- string -
- 		-
    Choices: -
  • dot1q-tunnel
    • -
  • access
    • -
  • trunk
    • -
  • fex-fabric
    • -
  • fabricpath
    • -
- 		-
Mode in which interface needs to be configured.
-
Access mode is not shown in interface facts, so idempotency will not be maintained for switchport mode access and every time the output will come as changed=True.
-
-
- name - -
- string - / required -
- 		- -
Full name of interface, i.e. Ethernet1/1.
-
-
- trunk - -
- dictionary -
- 		- -
Switchport mode trunk command to configure the interface as a Layer-2 trunk.
-
-
- allowed_vlans - -
- string -
- 		- -
List of allowed VLANs in a given trunk port. These are the only VLANs that will be configured on the trunk.
-
-
- native_vlan - -
- integer -
- 		- -
Native VLAN to be configured in trunk port. It is used as the trunk native VLAN ID.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section ^interface.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state of the configuration after module completion.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOS 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # interface Ethernet1/2 - # switchport trunk native vlan 20 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - - name: Merge provided configuration with device configuration - cisco.nxos.nxos_l2_interfaces: - config: - - name: Ethernet1/1 - trunk: - native_vlan: 10 - allowed_vlans: 2,4,15 - - name: Ethernet1/2 - access: - vlan: 30 - state: merged - - # Task Output - # ----------- - # - # before: - # - name: Loopback999 - # - name: Ethernet1/2 - # - name: mgmt0 - # - name: Ethernet1/1 - # commands: - # - interface Ethernet1/1 - # - switchport trunk allowed vlan 2,4,15 - # - switchport trunk native vlan 10 - # - interface Ethernet1/2 - # - switchport access vlan 30 - # after: - # - name: Ethernet1/1 - # trunk: - # allowed_vlans: 2,4,15 - # native_vlan: 10 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - # - name: Loopback999 - - # After state: - # ------------ - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # switchport trunk native vlan 10 - # switchport trunk allowed vlans 2,4,15 - # interface Ethernet1/2 - # switchport access vlan 30 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - # Using replaced - - # Before state: - # ------------- - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # switchport trunk native vlan 10 - # switchport trunk allowed vlans 2,4,15 - # interface Ethernet1/2 - # switchport access vlan 30 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - - name: Replace device configuration of specified L2 interfaces with provided configuration. - cisco.nxos.nxos_l2_interfaces: - config: - - name: Ethernet1/1 - trunk: - native_vlan: 20 - allowed_vlans: 5-10, 15 - state: replaced - - # Task Output - # ----------- - # - # before: - # - name: Ethernet1/1 - # trunk: - # allowed_vlans: 2,4,15 - # native_vlan: 10 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - # commands: - # - interface Ethernet1/1 - # - no switchport trunk native vlan - # - switchport trunk allowed vlan 5-10,15 - # - switchport trunk native vlan 20 - # after: - # - name: Ethernet1/1 - # trunk: - # allowed_vlans: 5-10,15 - # native_vlan: 20 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - - # After state: - # ------------ - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # switchport trunk native vlan 20 - # switchport trunk allowed vlan 5-10,15 - # interface Ethernet1/2 - # switchport trunk native vlan 20 - # switchport mode trunk - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - # Using overridden - - # Before state: - # ------------- - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # switchport trunk native vlan 20 - # switchport trunk allowed vlan 5-10,15 - # interface Ethernet1/2 - # switchport trunk native vlan 20 - # switchport mode trunk - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - - name: Override device configuration with provided configuration. - cisco.nxos.nxos_l2_interfaces: - config: - - name: Ethernet1/2 - access: - vlan: 30 - state: overridden - - # Task Output - # ----------- - # - # before: - # - name: Ethernet1/1 - # trunk: - # allowed_vlans: 5,6,7,8,9,10,15 - # native_vlan: 20 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - # commands: - # - interface Ethernet1/1 - # - no switchport trunk allowed vlan - # - no switchport trunk native vlan - # after: - # - name: Ethernet1/1 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - - # After state: - # ------------ - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # interface Ethernet1/2 - # switchport access vlan 30 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - - # Using deleted - - # Before state: - # ------------- - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # switchport trunk native vlan 10 - # switchport trunk allowed vlan 2,4,15 - # interface Ethernet1/2 - # switchport access vlan 30 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - - name: Delete L2 attributes of given interfaces (Note This won't delete the interface - itself). - cisco.nxos.nxos_l2_interfaces: - config: - - name: Ethernet1/1 - - name: Ethernet1/2 - state: deleted - - # Task Output - # ----------- - # - # before: - # - name: Ethernet1/1 - # trunk: - # allowed_vlans: 2,4,15 - # native_vlan: 10 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - # commands: - # - interface Ethernet1/1 - # - no switchport trunk allowed vlan - # - no switchport trunk native vlan - # - interface Ethernet1/2 - # - no switchport access vlan - # after: - # - name: Ethernet1/1 - # - name: Ethernet1/2 - # - name: mgmt0 - - # After state: - # ------------ - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # interface Ethernet1/2 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - # Using rendered - - - name: Render platform specific configuration lines (without connecting to the device) - cisco.nxos.nxos_l2_interfaces: - config: - - name: Ethernet1/1 - trunk: - native_vlan: 10 - allowed_vlans: 2,4,15 - - name: Ethernet1/2 - access: - vlan: 30 - - name: Ethernet1/3 - trunk: - native_vlan: 20 - allowed_vlans: 5-10, 15 - state: rendered - - # Task Output - # ----------- - # - # rendered: - # - interface Ethernet1/1 - # - switchport trunk allowed vlan 2,4,15 - # - switchport trunk native vlan 10 - # - interface Ethernet1/2 - # - switchport access vlan 30 - # - interface Ethernet1/3 - # - switchport trunk allowed vlan 5-10,15 - # - switchport trunk native vlan 20 - - # Using parsed - - # parsed.cfg - # ------------ - # - # interface Ethernet1/800 - # switchport access vlan 18 - # switchport trunk allowed vlan 210 - # interface Ethernet1/801 - # switchport trunk allowed vlan 2,4,15 - - - name: Use parsed state to convert externally supplied config to structured format - cisco.nxos.nxos_l2_interfaces: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output - # ----------- - # - # parsed: - # - name: Ethernet1/800 - # access: - # vlan: 18 - # trunk: - # allowed_vlans: "210" - # - name: Ethernet1/801 - # trunk: - # allowed_vlans: "2,4,15" - - # Using gathered - - # Before state: - # ------------- - # - # switch# sh running-config | section ^interface - # interface Ethernet1/1 - # switchport access vlan 6 - # switchport trunk allowed vlan 200 - # interface Ethernet1/2 - # switchport trunk native vlan 10 - - - name: Gather l2_interfaces facts from the device using nxos_l2_interfaces - cisco.nxos.nxos_l2_interfaces: - state: gathered - - # Task output - # ----------- - # - # gathered: - # - name: "Ethernet1/1" - # access: - # vlan: 6 - # trunk: - # allowed_vlans: "200" - # - name: "Ethernet1/2" - # trunk: - # native_vlan: 10 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/1', 'switchport trunk allowed vlan 2,4,15', 'switchport trunk native vlan 10', 'interface Ethernet1/2', 'switchport access vlan 30', 'interface Ethernet1/3', 'switchport trunk allowed vlan 5,6,7,8,9,10,15', 'switchport trunk native vlan 20']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_l3_interfaces_module.rst b/docs/cisco.nxos.nxos_l3_interfaces_module.rst deleted file mode 100644 index 28a56bdf8..000000000 --- a/docs/cisco.nxos.nxos_l3_interfaces_module.rst +++ /dev/null @@ -1,884 +0,0 @@ -.. _cisco.nxos.nxos_l3_interfaces_module: - - -***************************** -cisco.nxos.nxos_l3_interfaces -***************************** - -**L3 interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages Layer-3 interfaces attributes of NX-OS Interfaces. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A dictionary of Layer-3 interface options
-
-
- dot1q - -
- integer -
- 		- -
Configures IEEE 802.1Q VLAN encapsulation on a subinterface.
-
-
- evpn_multisite_tracking - -
- string -
-
added in 1.1.0
- 		-
    Choices: -
  • fabric-tracking
    • -
  • dci-tracking
    • -
- 		-
VxLAN evpn multisite Interface tracking. Supported only on selected model.
-
-
- ipv4 - -
- list - / elements=dictionary -
- 		- -
IPv4 address and attributes of the L3 interface.
-
-
- address - -
- string -
- 		- -
IPV4 address of the L3 interface.
-
-
- secondary - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
A boolean attribute to manage addition of secondary IP address.
-
-
- tag - -
- integer -
- 		- -
URIB route tag value for local/direct routes.
-
-
- ipv6 - -
- list - / elements=dictionary -
- 		- -
IPv6 address and attributes of the L3 interface.
-
-
- address - -
- string -
- 		- -
IPV6 address of the L3 interface.
-
-
- tag - -
- integer -
- 		- -
URIB route tag value for local/direct routes.
-
-
- ipv6_redirects - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/disables ipv6 redirects.
-
-
- name - -
- string - / required -
- 		- -
Full name of L3 interface, i.e. Ethernet1/1.
-
-
- redirects - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/disables ipv4 redirects.
-
-
- unreachables - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/disables ip redirects.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state of the configuration after module completion.
-
The state overridden would override the IP address configuration of all interfaces on the device with the provided configuration in the task. Use caution with this state as you may loose access to the device.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOS 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no shutdown - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - - name: Merge provided configuration with device configuration. - cisco.nxos.nxos_l3_interfaces: - config: - - name: Ethernet1/6 - ipv4: - - address: 192.168.1.1/24 - tag: 5 - - address: 10.1.1.1/24 - secondary: true - tag: 10 - ipv6: - - address: fd5d:12c9:2201:2::1/64 - tag: 6 - - name: Ethernet1/7.42 - redirects: false - unreachables: false - state: merged - - # Task Output - # ----------- - # - # before: - # - name: Ethernet1/6 - # - name: Ethernet1/7 - # - ipv4: - # - address: dhcp - # name: mgmt0 - # commands: - # - interface Ethernet1/6 - # - ip address 192.168.1.1/24 tag 5 - # - ip address 10.1.1.1/24 secondary tag 10 - # - ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - # - interface Ethernet1/7 - # - no ip redirects - # after: - # - ipv4: - # - address: 192.168.1.1/24 - # tag: 5 - # - address: 10.1.1.1/24 - # secondary: true - # tag: 10 - # ipv6: - # - address: fd5d:12c9:2201:2::1/64 - # tag: 6 - # name: Ethernet1/6 - # redirects: false - # - name: Ethernet1/7 - # redirects: false - # - ipv4: - # - address: dhcp - # name: mgmt0 - - # After state: - # ------------ - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no ip redirects - # ip address 192.168.1.1/24 tag 5 - # ip address 10.1.1.1/24 secondary tag 10 - # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no ip redirects - # no shutdown - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - - # Using replaced - - # Before state: - # ------------- - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no ip redirects - # ip address 192.168.1.1/24 tag 5 - # ip address 10.1.1.1/24 secondary tag 10 - # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no ip redirects - # no shutdown - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - - name: Replace device configuration of specified L3 interfaces with provided configuration. - cisco.nxos.nxos_l3_interfaces: - config: - - name: Ethernet1/6 - ipv4: - - address: 192.168.22.3/24 - state: replaced - - # Task Output - # ----------- - # - # before: - # - ipv4: - # - address: 192.168.1.1/24 - # tag: 5 - # - address: 10.1.1.1/24 - # secondary: true - # tag: 10 - # ipv6: - # - address: fd5d:12c9:2201:2::1/64 - # tag: 6 - # name: Ethernet1/6 - # redirects: false - # - name: Ethernet1/7 - # redirects: false - # - ipv4: - # - address: dhcp - # name: mgmt0 - # commands: - # - interface Ethernet1/6 - # - ip address 192.168.22.3/24 - # - no ipv6 address fd5d:12c9:2201:2::1/64 - # - ip redirects - # after: - # - ipv4: - # - address: 192.168.22.3/24 - # - address: 10.1.1.1/24 - # secondary: true - # tag: 10 - # name: Ethernet1/6 - # redirects: false - # - name: Ethernet1/7 - # redirects: false - # - ipv4: - # - address: dhcp - # name: mgmt0 - - # After state: - # ------------ - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no ip redirects - # ip address 192.168.22.3/24 - # ip address 10.1.1.1/24 secondary tag 10 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no ip redirects - # no shutdown - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - # Using overridden - - # Before state: - # ------------- - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no ip redirects - # ip address 192.168.1.1/24 tag 5 - # ip address 10.1.1.1/24 secondary tag 10 - # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no ip redirects - # no shutdown - # interface Ethernet1/7.42 - # no ip redirects - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - - name: Override device configuration with provided configuration. - cisco.nxos.nxos_l3_interfaces: - config: - - ipv4: - - address: dhcp - name: mgmt0 - - name: Ethernet1/6 - ipv4: - - address: 192.168.22.3/24 - state: overridden - - # Task Output - # ----------- - # - # before: - # - ipv4: - # - address: 192.168.1.1/24 - # tag: 5 - # - address: 10.1.1.1/24 - # secondary: true - # tag: 10 - # ipv6: - # - address: fd5d:12c9:2201:2::1/64 - # tag: 6 - # name: Ethernet1/6 - # redirects: false - # - name: Ethernet1/7 - # redirects: false - # - name: Ethernet1/7.42 - # redirects: false - # - ipv4: - # - address: dhcp - # name: mgmt0 - # commands: - # - interface Ethernet1/6 - # - no ipv6 address fd5d:12c9:2201:2::1/64 - # - no ip address 10.1.1.1/24 secondary - # - ip address 192.168.22.3/24 - # - ip redirects - # - interface Ethernet1/7 - # - ip redirects - # - interface Ethernet1/7.42 - # - ip redirects - # after: - # - ipv4: - # - address: 192.168.22.3/24 - # name: Ethernet1/6 - # - name: Ethernet1/7 - # - name: Ethernet1/7.42 - # - ipv4: - # - address: dhcp - # name: mgmt0 - - # After state: - # ------------ - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # ip address 192.168.22.3/24 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no shutdown - # interface Ethernet1/7.42 - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - # Using deleted - - # Before state: - # ------------- - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # ip address 192.168.22.3/24 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no shutdown - # interface Ethernet1/7.42 - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - - name: Delete L3 attributes of given interfaces (This won't delete the interface - itself). - cisco.nxos.nxos_l3_interfaces: - config: - - name: Ethernet1/6 - - name: Ethernet1/2 - state: deleted - - # Task Output - # ----------- - # - # before: - # - name: Ethernet1/2 - # - ipv4: - # - address: 192.168.22.3/24 - # name: Ethernet1/6 - # - name: Ethernet1/7 - # - name: Ethernet1/7.42 - # - ipv4: - # - address: dhcp - # name: mgmt0 - # commands: - # - interface Ethernet1/6 - # - no ip address - # after: - # - name: Ethernet1/2 - # - name: Ethernet1/7 - # - name: Ethernet1/7.42 - # - ipv4: - # - address: dhcp - # name: mgmt0 - - # After state: - # ------------ - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no shutdown - # interface Ethernet1/7.42 - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - # Using rendered - - - name: Use rendered state to convert task input to device specific commands - cisco.nxos.nxos_l3_interfaces: - config: - - name: Ethernet1/800 - ipv4: - - address: 192.168.1.100/24 - tag: 5 - - address: 10.1.1.1/24 - secondary: true - tag: 10 - - name: Ethernet1/800 - ipv6: - - address: fd5d:12c9:2201:2::1/64 - tag: 6 - state: rendered - - # Task Output - # ----------- - # - # rendered: - # - interface Ethernet1/800 - # - ip address 192.168.1.100/24 tag 5 - # - ip address 10.1.1.1/24 secondary tag 10 - # - interface Ethernet1/800 - # - ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - - # Using parsed - - # parsed.cfg - # ---------- - # - # interface Ethernet1/800 - # ip address 192.168.1.100/24 tag 5 - # ip address 10.1.1.1/24 secondary tag 10 - # no ip redirects - # interface Ethernet1/801 - # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - # ip unreachables - # interface mgmt0 - # ip address dhcp - # vrf member management - - - name: Use parsed state to convert externally supplied config to structured format - cisco.nxos.nxos_l3_interfaces: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output - # ----------- - # - # parsed: - # - name: Ethernet1/800 - # ipv4: - # - address: 192.168.1.100/24 - # tag: 5 - # - address: 10.1.1.1/24 - # secondary: True - # tag: 10 - # redirects: False - # - name: Ethernet1/801 - # ipv6: - # - address: fd5d:12c9:2201:2::1/64 - # tag: 6 - # unreachables: True - - # Using gathered - - # Before state: - # ------------- - # - # interface Ethernet1/1 - # ip address 192.0.2.100/24 - # interface Ethernet1/2 - # no ip redirects - # ip address 203.0.113.10/24 - # ip unreachables - # ipv6 address 2001:db8::1/32 - - - name: Gather l3_interfaces facts from the device using nxos_l3_interfaces - cisco.nxos.nxos_l3_interfaces: - state: gathered - - # Task output - # ----------- - # - # gathered: - # - name: Ethernet1/1 - # ipv4: - # - address: 192.0.2.100/24 - # - name: Ethernet1/2 - # ipv4: - # - address: 203.0.113.10/24 - # ipv6: - # - address: 2001:db8::1/32 - # redirects: False - # unreachables: True - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/2', 'ip address 192.168.0.1/2']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_lacp_module.rst b/docs/cisco.nxos.nxos_lacp_module.rst deleted file mode 100644 index b0410c783..000000000 --- a/docs/cisco.nxos.nxos_lacp_module.rst +++ /dev/null @@ -1,402 +0,0 @@ -.. _cisco.nxos.nxos_lacp_module: - - -******************** -cisco.nxos.nxos_lacp -******************** - -**LACP resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages Global Link Aggregation Control Protocol (LACP) on NX-OS devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
LACP global options.
-
-
- system - -
- dictionary -
- 		- -
LACP system options
-
-
- mac - -
- dictionary -
- 		- -
MAC address to be used for the LACP Protocol exchanges
-
-
- address - -
- string -
- 		- -
MAC-address (FORMAT :xxxx.xxxx.xxxx).
-
-
- role - -
- string -
- 		-
    Choices: -
  • primary
    • -
  • secondary
    • -
- 		-
The role for the Switch.
-
-
- priority - -
- integer -
- 		- -
The system priority to use in LACP negotiations.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | include lacp.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state of the configuration after module completion.
-
States replaced and overridden have the same behaviour for this module.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOS 7.3.(0)D1(1) on VIRL. - - Unsupported for Cisco MDS - - Feature lacp should be enabled for this module. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # - - - name: Merge provided configuration with device configuration. - cisco.nxos.nxos_lacp: - config: - system: - priority: 10 - mac: - address: 00c1.4c00.bd15 - state: merged - - # After state: - # ------------ - # - # lacp system-priority 10 - # lacp system-mac 00c1.4c00.bd15 - - - # Using replaced - - # Before state: - # ------------- - # - # lacp system-priority 10 - - - name: Replace device global lacp configuration with the given configuration. - cisco.nxos.nxos_lacp: - config: - system: - mac: - address: 00c1.4c00.bd15 - state: replaced - - # After state: - # ------------ - # - # lacp system-mac 00c1.4c00.bd15 - - - # Using deleted - - # Before state: - # ------------- - # - # lacp system-priority 10 - - - name: Delete global LACP configurations. - cisco.nxos.nxos_lacp: - state: deleted - - # After state: - # ------------ - # - - # Using rendered - - - name: Render platform specific configuration lines (without connecting to the device) - cisco.nxos.nxos_lacp: - config: - system: - priority: 10 - mac: - address: 00c1.4c00.bd15 - role: secondary - state: rendered - - # Task Output (redacted) - # ----------------------- - - # rendered: - # - "lacp system-priority 10" - # - "lacp system-mac 00c1.4c00.bd15 role secondary" - - # Using parsed - - # parsed.cfg - # ------------ - # lacp system-priority 10 - # lacp system-mac 00c1.4c00.bd15 role secondary - - - name: Use parsed state to convert externally supplied config to structured format - cisco.nxos.nxos_lacp: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # system: - # priority: 10 - # mac: - # address: 00c1.4c00.bd15 - # role: secondary - - # Using gathered - - # Existing device config state - # ------------------------------- - # Nexus9000v# show running-config | include lacp - # lacp system-priority 11 - # lacp system-mac 00c1.4c00.bd15 role primary - - - name: Gather lacp facts from the device using nxos_lacp - cisco.nxos.nxos_lacp: - state: gathered - - # Task output (redacted) - # ----------------------- - # gathered: - # system: - # priority: 11 - # mac: - # address: 00c1.4c00.bd15 - # role: primary - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['lacp system-priority 15', 'lacp system-mac 00c1.4c00.bd15 role primary']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_lldp_interfaces_module.rst b/docs/cisco.nxos.nxos_lldp_interfaces_module.rst deleted file mode 100644 index d634e9aa4..000000000 --- a/docs/cisco.nxos.nxos_lldp_interfaces_module.rst +++ /dev/null @@ -1,407 +0,0 @@ -.. _cisco.nxos.nxos_lldp_interfaces_module: - - -******************************* -cisco.nxos.nxos_lldp_interfaces -******************************* - -**LLDP interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages interfaces' configuration for Link Layer Discovery Protocol (LLDP) on NX-OS platforms. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of link layer discovery configurations for interfaces.
-
-
- name - -
- string - / required -
- 		- -
Name of the interface
-
-
- receive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Used to enable or disable the reception of LLDP packets on that interface. By default, this is enabled after LLDP is enabled globally.
-
-
- tlv_set - -
- dictionary -
- 		- -
Used to configure TLV parameters on the interface
-
-
- management_address - -
- string -
- 		- -
Used to mention the IPv4 or IPv6 management address for the interface
-
-
- vlan - -
- integer -
- 		- -
Used to mention the VLAN for the interface
-
-
- transmit - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Used to enable or disable the transmission of LLDP packets on that interface. By default, this is enabled after LLDP is enabled globally.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section ^interface.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOS 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - The LLDP feature needs to be enabled before using this module - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # - - - name: Merge provided configuration with device configuration - cisco.nxos.nxos_lldp_interfaces: - config: - - name: Ethernet1/4 - receive: false - transmit: true - tlv_set: - management_address: 192.168.122.64 - vlan: 12 - state: merged - - # After state: - # ------------- - # - # interface Ethernet1/4 - # no lldp receive - # lldp tlv-set management-address 192.168.122.64 - # lldp tlv-set vlan 12 - - - # Using replaced - - # Before state: - # ------------ - # - # interface Ethernet1/4 - # no lldp receive - # lldp tlv-set management-address 192.168.122.64 - # interface Ethernet1/5 - # no lldp transmit - # lldp tlv-set vlan 10 - - - name: Replace LLDP configuration on interfaces with given configuration - cisco.nxos.nxos_lldp_interfaces: - config: - - name: Ethernet1/4 - transmit: false - tlv_set: - vlan: 2 - state: replaced - - - # After state: - # ----------- - # - # interface Ethernet1/4 - # no lldp transmit - # lldp tlv_set vlan 2 - # interface Ethernet1/5 - # no lldp transmit - # lldp tlv-set vlan 10 - - - # Using overridden - - # Before state: - # ------------ - # - # interface Ethernet1/4 - # no lldp receive - # lldp tlv-set management-address 192.168.122.64 - # interface Ethernet1/5 - # no lldp transmit - # lldp tlv-set vlan 10 - - - name: Override LLDP configuration on all interfaces with given configuration - cisco.nxos.nxos_lldp_interfaces: - config: - - name: Ethernet1/7 - receive: false - tlv_set: - vlan: 12 - state: overridden - - - # After state: - # ----------- - # - # interface Ethernet1/7 - # no lldp receive - # lldp tlv_set vlan 12 - - - # Using deleted - - # Before state: - # ------------ - # - # interface Ethernet1/4 - # lldp tlv-set management vlan 24 - # no lldp transmit - # interface mgmt0 - # no lldp receive - - - name: Delete LLDP interfaces configuration - cisco.nxos.nxos_lldp_interfaces: - state: deleted - - # After state: - # ------------ - # - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/2', 'lldp receive', 'lldp tlv-set vlan 12']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_logging_module.rst b/docs/cisco.nxos.nxos_logging_module.rst deleted file mode 100644 index 9dafd8e33..000000000 --- a/docs/cisco.nxos.nxos_logging_module.rst +++ /dev/null @@ -1,458 +0,0 @@ -.. _cisco.nxos.nxos_logging_module: - - -*********************** -cisco.nxos.nxos_logging -*********************** - -**Manage logging on network devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2023-08-01 -:Why: Updated module released with more functionality. -:Alternative: nxos_logging_global - - - -Synopsis --------- -- This module provides declarative management of logging on Cisco NX-OS devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
List of logging definitions.
-
-
- dest - -
- string -
- 		-
    Choices: -
  • console
    • -
  • logfile
    • -
  • module
    • -
  • monitor
    • -
  • server
    • -
- 		-
Destination of the logs.
-
-
- dest_level - -
- integer -
- 		- -
Set logging severity levels.
-

aliases: level
-
-
- event - -
- string -
- 		-
    Choices: -
  • link-enable
    • -
  • link-default
    • -
  • trunk-enable
    • -
  • trunk-default
    • -
- 		-
Link/trunk enable/default interface configuration logging
-
-
- facility - -
- string -
- 		- -
Facility name for logging.
-
-
- facility_level - -
- integer -
- 		- -
Set logging severity levels for facility based log messages.
-
-
- facility_link_status - -
- string -
- 		-
    Choices: -
  • link-down-notif
    • -
  • link-down-error
    • -
  • link-up-notif
    • -
  • link-up-error
    • -
- 		-
Set logging facility ethpm link status. Not idempotent with version 6.0 images.
-
-
- file_size - -
- integer -
- 		- -
Set logfile size
-
-
- interface - -
- string -
- 		- -
Interface to be used while configuring source-interface for logging (e.g., 'Ethernet1/2', 'mgmt0')
-
-
- interface_message - -
- string -
- 		-
    Choices: -
  • add-interface-description
    • -
- 		-
Add interface description to interface syslogs. Does not work with version 6.0 images using nxapi as a transport.
-
-
- name - -
- string -
- 		- -
If value of dest is logfile it indicates file-name.
-
-
- purge - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Remove any switch logging configuration that does not match what has been configured Not supported for ansible_connection local. All nxos_logging tasks must use the same ansible_connection type.
-
-
- remote_server - -
- string -
- 		- -
Hostname or IP Address for remote logging (when dest is 'server').
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
State of the logging configuration.
-
-
- timestamp - -
- string -
- 		-
    Choices: -
  • microseconds
    • -
  • milliseconds
    • -
  • seconds
    • -
- 		-
Set logging timestamp format
-
-
- use_vrf - -
- string -
- 		- -
VRF to be used while configuring remote logging (when dest is 'server').
-
-
- - -Notes ------ - -.. note:: - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: configure console logging with level - cisco.nxos.nxos_logging: - dest: console - level: 2 - state: present - - name: remove console logging configuration - cisco.nxos.nxos_logging: - dest: console - level: 2 - state: absent - - name: configure file logging with level - cisco.nxos.nxos_logging: - dest: logfile - name: testfile - dest_level: 3 - state: present - - name: Configure logging logfile with size - cisco.nxos.nxos_logging: - dest: logfile - name: testfile - dest_level: 3 - file_size: 16384 - - name: configure facility level logging - cisco.nxos.nxos_logging: - facility: daemon - facility_level: 0 - state: present - - name: remove facility level logging - cisco.nxos.nxos_logging: - facility: daemon - facility_level: 0 - state: absent - - name: Configure Remote Logging - cisco.nxos.nxos_logging: - dest: server - remote_server: test-syslogserver.com - facility: auth - facility_level: 1 - use_vrf: management - state: present - - name: Configure Source Interface for Logging - cisco.nxos.nxos_logging: - interface: mgmt0 - state: present - - name: Purge nxos_logging configuration not managed by this playbook - cisco.nxos.nxos_logging: - purge: true - - name: Configure logging timestamp - cisco.nxos.nxos_logging: - timestamp: milliseconds - state: present - - name: Configure logging facility ethpm link status - cisco.nxos.nxos_logging: - facility: ethpm - facility_link_status: link-up-notif - state: present - - name: Configure logging message ethernet description - cisco.nxos.nxos_logging: - interface_message: add-interface-description - state: present - - name: Configure logging event link enable - cisco.nxos.nxos_logging: - event: link-enable - state: present - - name: Configure logging using aggregate - cisco.nxos.nxos_logging: - aggregate: - - {dest: console, dest_level: 2} - - {dest: logfile, dest_level: 2, name: testfile} - - {facility: daemon, facility_level: 0} - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['logging console 2', 'logging logfile testfile 3', 'logging level daemon 0']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2023-08-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_ntp_auth_module.rst b/docs/cisco.nxos.nxos_ntp_auth_module.rst deleted file mode 100644 index c825cd017..000000000 --- a/docs/cisco.nxos.nxos_ntp_auth_module.rst +++ /dev/null @@ -1,224 +0,0 @@ -.. _cisco.nxos.nxos_ntp_auth_module: - - -************************ -cisco.nxos.nxos_ntp_auth -************************ - -**Manages NTP authentication.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated module released with more functionality. -:Alternative: nxos_ntp_global - - - -Synopsis --------- -- Manages NTP authentication. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- auth_type - -
- string -
- 		-
    Choices: -
  • text ←
    • -
  • encrypt
    • -
- 		-
Whether the given md5string is in cleartext or has been encrypted. If in cleartext, the device will encrypt it before storing it.
-
-
- authentication - -
- string -
- 		-
    Choices: -
  • on
    • -
  • off
    • -
- 		-
Turns NTP authentication on or off.
-
-
- key_id - -
- string -
- 		- -
Authentication key identifier (numeric).
-
-
- md5string - -
- string -
- 		- -
MD5 String.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- trusted_key - -
- string -
- 		-
    Choices: -
  • false ←
    • -
  • true
    • -
- 		-
Whether the given key is required to be supplied by a time source for the device to synchronize to the time source.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - If ``state=absent``, the module will remove the given key configuration if it exists. - - If ``state=absent`` and ``authentication=on``, authentication will be turned off. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Basic NTP authentication configuration - - cisco.nxos.nxos_ntp_auth: - key_id: 32 - md5string: hello - auth_type: text - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['ntp authentication-key 32 md5 helloWorld 0', 'ntp trusted-key 32']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_ntp_global_module.rst b/docs/cisco.nxos.nxos_ntp_global_module.rst deleted file mode 100644 index b77fc9440..000000000 --- a/docs/cisco.nxos.nxos_ntp_global_module.rst +++ /dev/null @@ -1,1411 +0,0 @@ -.. _cisco.nxos.nxos_ntp_global_module: - - -************************** -cisco.nxos.nxos_ntp_global -************************** - -**NTP Global resource module.** - - -Version added: 2.6.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages ntp configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A dict of ntp configuration.
-
-
- access_group - -
- dictionary -
- 		- -
NTP access-group.
-
This option is unsupported on MDS switches.
-
-
- match_all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Scan ACLs present in all ntp access groups.
-
-
- peer - -
- list - / elements=dictionary -
- 		- -
Access-group peer.
-
-
- access_list - -
- string -
- 		- -
Name of access list.
-
-
- query_only - -
- list - / elements=dictionary -
- 		- -
Access-group query-only.
-
-
- access_list - -
- string -
- 		- -
Name of access list.
-
-
- serve - -
- list - / elements=dictionary -
- 		- -
Access-group serve.
-
-
- access_list - -
- string -
- 		- -
Name of access list.
-
-
- serve_only - -
- list - / elements=dictionary -
- 		- -
Access-group serve-only.
-
-
- access_list - -
- string -
- 		- -
Name of access list.
-
-
- allow - -
- dictionary -
- 		- -
Enable/Disable the packets.
-
-
- control - -
- dictionary -
- 		- -
Control mode packets.
-
-
- rate_limit - -
- integer -
- 		- -
Rate-limit delay.
-
-
- private - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable Private mode packets.
-
-
- authenticate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable authentication.
-
-
- authentication_keys - -
- list - / elements=dictionary -
- 		- -
NTP authentication key.
-
-
- encryption - -
- integer -
- 		- -
0 for Clear text
-
7 for Encrypted
-
-
- id - -
- integer -
- 		- -
Authentication key number (range 1-65535).
-
-
- key - -
- string -
- 		- -
Authentication key.
-
-
- logging - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable logging of NTPD Events.
-
-
- master - -
- dictionary -
- 		- -
Act as NTP master clock.
-
This option is unsupported on MDS switches.
-
-
- stratum - -
- integer -
- 		- -
Stratum number.
-
-
- passive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
NTP passive command.
-
This option is unsupported on MDS switches.
-
-
- peers - -
- list - / elements=dictionary -
- 		- -
NTP Peers.
-
-
- key_id - -
- integer -
- 		- -
Keyid to be used while communicating to this server.
-
-
- maxpoll - -
- integer -
- 		- -
Maximum interval to poll a peer.
-
Poll interval in secs to a power of 2.
-
-
- minpoll - -
- integer -
- 		- -
Minimum interval to poll a peer.
-
Poll interval in secs to a power of 2.
-
-
- peer - -
- string -
- 		- -
Hostname/IP address of the NTP Peer.
-
-
- prefer - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Preferred Server.
-
-
- vrf - -
- string -
- 		- -
Display per-VRF information.
-
This option is unsupported on MDS switches.
-

aliases: use_vrf
-
-
- servers - -
- list - / elements=dictionary -
- 		- -
NTP servers.
-
-
- key_id - -
- integer -
- 		- -
Keyid to be used while communicating to this server.
-
-
- maxpoll - -
- integer -
- 		- -
Maximum interval to poll a peer.
-
Poll interval in secs to a power of 2.
-
-
- minpoll - -
- integer -
- 		- -
Minimum interval to poll a peer.
-
Poll interval in secs to a power of 2.
-
-
- prefer - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Preferred Server.
-
-
- server - -
- string -
- 		- -
Hostname/IP address of the NTP Peer.
-
-
- vrf - -
- string -
- 		- -
Display per-VRF information.
-
This option is not applicable for MDS switches.
-

aliases: use_vrf
-
-
- source - -
- string -
- 		- -
Source of NTP packets.
-
This option is unsupported on MDS switches.
-
-
- source_interface - -
- string -
- 		- -
Source interface sending NTP packets.
-
-
- trusted_keys - -
- list - / elements=dictionary -
- 		- -
NTP trusted-key number.
-
-
- key_id - -
- integer -
- 		- -
Trusted-Key number.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config ntp.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
The states replaced and overridden have identical behaviour for this module.
-
Please refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6 on Cisco Nexus Switches. - - This module works with connection ``network_cli`` and ``httpapi``. - - Tested against Cisco MDS NX-OS 9.2(2) with connection ``network_cli``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k-rdo# show running-config ntp - # nxos-9k-rdo# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_ntp_global: &id001 - config: - access_group: - peer: - - access_list: PeerAcl1 - serve: - - access_list: ServeAcl1 - authenticate: true - authentication_keys: - - id: 1001 - key: vagwwtKfkv - encryption: 7 - - id: 1002 - key: vagwwtKfkvgthz - encryption: 7 - logging: true - master: - stratum: 2 - peers: - - peer: 192.0.2.1 - key_id: 1 - maxpoll: 15 - minpoll: 5 - vrf: default - - peer: 192.0.2.2 - key_id: 2 - prefer: true - vrf: siteA - servers: - - server: 198.51.100.1 - key_id: 2 - vrf: default - - server: 203.0.113.1 - key_id: 1 - vrf: siteB - - # Task output - # ------------- - # before: {} - # - # commands: - # - "ntp authenticate" - # - "ntp logging" - # - "ntp master 2" - # - "ntp authentication-keys 1001 md5 vagwwtKfkv 7" - # - "ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" - # - "ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" - # - "ntp peer 192.0.2.2 prefer use-vrf siteA key 2" - # - "ntp server 198.51.100.1 use-vrf default key 2" - # - "ntp server 203.0.113.1 use-vrf siteB key 1" - # - "ntp access-group peer PeerAcl1" - # - "ntp access-group serve ServeAcl1" - # - # after: - # access_group: - # peer: - # - access_list: PeerAcl1 - # serve: - # - access_list: ServeAcl1 - # authenticate: true - # authentication_keys: - # - id: 1001 - # key: vagwwtKfkv - # encryption: 7 - # - id: 1002 - # key: vagwwtKfkvgthz - # encryption: 7 - # logging: true - # master: - # stratum: 2 - # peers: - # - peer: 192.0.2.1 - # key_id: 1 - # maxpoll: 15 - # minpoll: 5 - # vrf: default - # - peer: 192.0.2.2 - # key_id: 2 - # prefer: true - # vrf: siteA - # servers: - # - server: 198.51.100.1 - # key_id: 2 - # vrf: default - # - server: 203.0.113.1 - # key_id: 1 - # vrf: siteB - - # After state: - # ------------ - # nxos-9k-rdo# show running-config ntp - # ntp authenticate - # ntp logging - # ntp master 2 - # ntp authentication-keys 1001 md5 vagwwtKfkv 7 - # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 - # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 - # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 - # ntp server 198.51.100.1 use-vrf default key 2 - # ntp server 203.0.113.1 use-vrf siteB key 1 - # ntp access-group peer PeerAcl1 - # ntp access-group serve ServeAcl1 - - # Using replaced - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config ntp - # ntp authenticate - # ntp logging - # ntp master 2 - # ntp authentication-keys 1001 md5 vagwwtKfkv 7 - # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 - # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 - # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 - # ntp server 198.51.100.1 use-vrf default key 2 - # ntp server 203.0.113.1 use-vrf siteB key 1 - # ntp access-group peer PeerAcl1 - # ntp access-group serve ServeAcl1 - - - name: Replace logging global configurations of listed logging global with provided configurations - cisco.nxos.nxos_ntp_global: - config: - access_group: - peer: - - access_list: PeerAcl2 - serve: - - access_list: ServeAcl2 - logging: true - master: - stratum: 2 - peers: - - peer: 192.0.2.1 - key_id: 1 - maxpoll: 15 - minpoll: 5 - vrf: default - - peer: 192.0.2.5 - key_id: 2 - prefer: true - vrf: siteA - servers: - - server: 198.51.100.1 - key_id: 2 - vrf: default - state: replaced - - # Task output - # ------------- - # before: - # access_group: - # peer: - # - access_list: PeerAcl1 - # serve: - # - access_list: ServeAcl1 - # authenticate: true - # authentication_keys: - # - id: 1001 - # key: vagwwtKfkv - # encryption: 7 - # - id: 1002 - # key: vagwwtKfkvgthz - # encryption: 7 - # logging: true - # master: - # stratum: 2 - # peers: - # - peer: 192.0.2.1 - # key_id: 1 - # maxpoll: 15 - # minpoll: 5 - # vrf: default - # - peer: 192.0.2.2 - # key_id: 2 - # prefer: true - # vrf: siteA - # servers: - # - server: 198.51.100.1 - # key_id: 2 - # vrf: default - # - server: 203.0.113.1 - # key_id: 1 - # vrf: siteB - # - # commands: - # - "no ntp authenticate" - # - "no ntp authentication-keys 1001 md5 vagwwtKfkv 7" - # - "no ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" - # - "ntp peer 192.0.2.5 prefer use-vrf siteA key 2" - # - "no ntp peer 192.0.2.2 prefer use-vrf siteA key 2" - # - "no ntp server 203.0.113.1 use-vrf siteB key 1" - # - "ntp access-group peer PeerAcl2" - # - "no ntp access-group peer PeerAcl1" - # - "ntp access-group serve ServeAcl2" - # - "no ntp access-group serve ServeAcl1" - # - # after: - # access_group: - # peer: - # - access_list: PeerAcl2 - # serve: - # - access_list: ServeAcl2 - # logging: true - # master: - # stratum: 2 - # peers: - # - peer: 192.0.2.1 - # key_id: 1 - # maxpoll: 15 - # minpoll: 5 - # vrf: default - # - peer: 192.0.2.5 - # key_id: 2 - # prefer: true - # vrf: siteA - # servers: - # - server: 198.51.100.1 - # key_id: 2 - # vrf: default - - # After state: - # ------------ - # nxos-9k-rdo# show running-config ntp - # ntp logging - # ntp master 2 - # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 - # ntp peer 192.0.2.5 prefer use-vrf siteA key 2 - # ntp server 198.51.100.1 use-vrf default key 2 - # ntp access-group peer PeerAcl2 - # ntp access-group serve ServeAcl2 - - # Using deleted to delete all logging configurations - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config ntp - - - name: Delete all logging configuration - cisco.nxos.nxos_ntp_global: - state: deleted - - # Task output - # ------------- - # before: - # access_group: - # peer: - # - access_list: PeerAcl1 - # serve: - # - access_list: ServeAcl1 - # authenticate: true - # authentication_keys: - # - id: 1001 - # key: vagwwtKfkv - # encryption: 7 - # - id: 1002 - # key: vagwwtKfkvgthz - # encryption: 7 - # logging: true - # master: - # stratum: 2 - # peers: - # - peer: 192.0.2.1 - # key_id: 1 - # maxpoll: 15 - # minpoll: 5 - # vrf: default - # - peer: 192.0.2.2 - # key_id: 2 - # prefer: true - # vrf: siteA - # servers: - # - server: 198.51.100.1 - # key_id: 2 - # vrf: default - # - server: 203.0.113.1 - # key_id: 1 - # vrf: siteB - # - # commands: - # - "no ntp authenticate" - # - "no ntp logging" - # - "no ntp master 2" - # - "no ntp authentication-keys 1001 md5 vagwwtKfkv 7" - # - "no ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" - # - "no ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" - # - "no ntp peer 192.0.2.2 prefer use-vrf siteA key 2" - # - "no ntp server 198.51.100.1 use-vrf default key 2" - # - "no ntp server 203.0.113.1 use-vrf siteB key 1" - # - "no ntp access-group peer PeerAcl1" - # - "no ntp access-group serve ServeAcl1" - # - # after: {} - - # After state: - # ------------ - # nxos-9k-rdo# show running-config ntp - # nxos-9k-rdo# - - # Using rendered - - - name: Render platform specific configuration lines with state rendered (without connecting to the device) - cisco.nxos.nxos_ntp_global: - config: - access_group: - peer: - - access_list: PeerAcl1 - serve: - - access_list: ServeAcl1 - authenticate: true - authentication_keys: - - id: 1001 - key: vagwwtKfkv - encryption: 7 - - id: 1002 - key: vagwwtKfkvgthz - encryption: 7 - logging: true - master: - stratum: 2 - peers: - - peer: 192.0.2.1 - key_id: 1 - maxpoll: 15 - minpoll: 5 - vrf: default - - peer: 192.0.2.2 - key_id: 2 - prefer: true - vrf: siteA - servers: - - server: 198.51.100.1 - key_id: 2 - vrf: default - - server: 203.0.113.1 - key_id: 1 - vrf: siteB - state: rendered - - # Task Output (redacted) - # ----------------------- - # rendered: - # - "ntp authenticate" - # - "ntp logging" - # - "ntp master 2" - # - "ntp authentication-keys 1001 md5 vagwwtKfkv 7" - # - "ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" - # - "ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" - # - "ntp peer 192.0.2.2 prefer use-vrf siteA key 2" - # - "ntp server 198.51.100.1 use-vrf default key 2" - # - "ntp server 203.0.113.1 use-vrf siteB key 1" - # - "ntp access-group peer PeerAcl1" - # - "ntp access-group serve ServeAcl1" - - # Using parsed - - # parsed.cfg - # ------------ - # ntp authenticate - # ntp logging - # ntp master 2 - # ntp authentication-keys 1001 md5 vagwwtKfkv 7 - # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 - # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 - # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 - # ntp server 198.51.100.1 use-vrf default key 2 - # ntp server 203.0.113.1 use-vrf siteB key 1 - # ntp access-group peer PeerAcl1 - # ntp access-group serve ServeAcl1 - - - name: Parse externally provided ntp configuration - cisco.nxos.nxos_ntp_global: - running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # access_group: - # peer: - # - access_list: PeerAcl1 - # serve: - # - access_list: ServeAcl1 - # authenticate: true - # authentication_keys: - # - id: 1001 - # key: vagwwtKfkv - # encryption: 7 - # - id: 1002 - # key: vagwwtKfkvgthz - # encryption: 7 - # logging: true - # master: - # stratum: 2 - # peers: - # - peer: 192.0.2.1 - # key_id: 1 - # maxpoll: 15 - # minpoll: 5 - # vrf: default - # - peer: 192.0.2.2 - # key_id: 2 - # prefer: true - # vrf: siteA - # servers: - # - server: 198.51.100.1 - # key_id: 2 - # vrf: default - # - server: 203.0.113.1 - # key_id: 1 - # vrf: siteB - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['ntp master stratum 2', 'ntp peer 198.51.100.1 use-vrf test maxpoll 7', 'ntp authentication-key 10 md5 wawyhanx2 7', 'ntp access-group peer PeerAcl1', 'ntp access-group peer PeerAcl2', 'ntp access-group query-only QueryAcl1']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['ntp master stratum 2', 'ntp peer 198.51.100.1 use-vrf test maxpoll 7', 'ntp authentication-key 10 md5 wawyhanx2 7', 'ntp access-group peer PeerAcl1', 'ntp access-group peer PeerAcl2', 'ntp access-group query-only QueryAcl1']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_ntp_module.rst b/docs/cisco.nxos.nxos_ntp_module.rst deleted file mode 100644 index 3fa835a96..000000000 --- a/docs/cisco.nxos.nxos_ntp_module.rst +++ /dev/null @@ -1,314 +0,0 @@ -.. _cisco.nxos.nxos_ntp_module: - - -******************* -cisco.nxos.nxos_ntp -******************* - -**Manages core NTP configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated module released with more functionality. -:Alternative: nxos_ntp_global - - - -Synopsis --------- -- Manages core NTP configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- key_id - -
- string -
- 		- -
Authentication key identifier to use with given NTP server or peer or keyword 'default'.
-
-
- peer - -
- string -
- 		- -
Network address of NTP peer.
-
-
- prefer - -
- string -
- 		-
    Choices: -
  • enabled
    • -
  • disabled
    • -
- 		-
Makes given NTP server or peer the preferred NTP server or peer for the device.
-
-
- server - -
- string -
- 		- -
Network address of NTP server.
-
-
- source_addr - -
- string -
- 		- -
Local source address from which NTP messages are sent or keyword 'default'.
-
-
- source_int - -
- string -
- 		- -
Local source interface from which NTP messages are sent. Must be fully qualified interface name or keyword 'default'
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- vrf_name - -
- string -
- 		- -
Makes the device communicate with the given NTP server or peer over a specific VRF or keyword 'default'.
-
-
- - -Notes ------ - -.. note:: - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Set NTP Server with parameters - - cisco.nxos.nxos_ntp: - server: 1.2.3.4 - key_id: 32 - prefer: enabled - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- end_state - -
- dictionary -
- 		always -
k/v pairs of ntp info after module execution
-
-
Sample:
-
{'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'server', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'source'}
-
-
- existing - -
- dictionary -
- 		always -
k/v pairs of existing ntp server/peer
-
-
Sample:
-
{'address': '192.0.2.2', 'key_id': '32', 'peer_type': 'server', 'prefer': 'enabled', 'source': 'ethernet2/1', 'source_type': 'source-interface'}
-
-
- proposed - -
- dictionary -
- 		always -
k/v pairs of parameters passed into module
-
-
Sample:
-
{'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'server', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'source'}
-
-
- updates - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['ntp server 192.0.2.2 prefer key 48', 'no ntp source-interface ethernet2/1', 'ntp source 192.0.2.3']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_ntp_options_module.rst b/docs/cisco.nxos.nxos_ntp_options_module.rst deleted file mode 100644 index e99825641..000000000 --- a/docs/cisco.nxos.nxos_ntp_options_module.rst +++ /dev/null @@ -1,192 +0,0 @@ -.. _cisco.nxos.nxos_ntp_options_module: - - -*************************** -cisco.nxos.nxos_ntp_options -*************************** - -**Manages NTP options.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated module released with more functionality. -:Alternative: nxos_ntp_global - - - -Synopsis --------- -- Manages NTP options, e.g. authoritative server and logging. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- logging - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Sets whether NTP logging is enabled on the device.
-
-
- master - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Sets whether the device is an authoritative NTP server.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- stratum - -
- string -
- 		- -
If master=true, an optional stratum can be supplied (1-15). The device default is 8.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - When ``state=absent``, master and logging will be set to False and stratum will be removed as well - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Basic NTP options configuration - - cisco.nxos.nxos_ntp_options: - master: true - stratum: 12 - logging: false - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- updates - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['no ntp logging', 'ntp master 12']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_nxapi_module.rst b/docs/cisco.nxos.nxos_nxapi_module.rst deleted file mode 100644 index 182fe1516..000000000 --- a/docs/cisco.nxos.nxos_nxapi_module.rst +++ /dev/null @@ -1,300 +0,0 @@ -.. _cisco.nxos.nxos_nxapi_module: - - -********************* -cisco.nxos.nxos_nxapi -********************* - -**Manage NXAPI configuration on an NXOS device.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configures the NXAPI feature on devices running Cisco NXOS. The NXAPI feature is absent from the configuration by default. Since this module manages the NXAPI feature it only supports the use of the ``Cli`` transport. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- http - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Controls the operating state of the HTTP protocol as one of the underlying transports for NXAPI. By default, NXAPI will enable the HTTP transport when the feature is first configured. To disable the use of the HTTP transport, set the value of this argument to False.
-

aliases: enable_http
-
-
- http_port - -
- integer -
- 		- Default:
80
- 		-
Configure the port with which the HTTP server will listen on for requests. By default, NXAPI will bind the HTTP service to the standard HTTP port 80. This argument accepts valid port values in the range of 1 to 65535.
-
-
- https - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Controls the operating state of the HTTPS protocol as one of the underlying transports for NXAPI. By default, NXAPI will disable the HTTPS transport when the feature is first configured. To enable the use of the HTTPS transport, set the value of this argument to True.
-

aliases: enable_https
-
-
- https_port - -
- integer -
- 		- Default:
443
- 		-
Configure the port with which the HTTPS server will listen on for requests. By default, NXAPI will bind the HTTPS service to the standard HTTPS port 443. This argument accepts valid port values in the range of 1 to 65535.
-
-
- sandbox - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
The NXAPI feature provides a web base UI for developers for entering commands. This feature is initially disabled when the NXAPI feature is configured for the first time. When the sandbox argument is set to True, the developer sandbox URL will accept requests and when the value is set to False, the sandbox URL is unavailable. This is supported on NX-OS 7K series.
-

aliases: enable_sandbox
-
-
- ssl_strong_ciphers - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Controls the use of whether strong or weak ciphers are configured. By default, this feature is disabled and weak ciphers are configured. To enable the use of strong ciphers, set the value of this argument to True.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
The state argument controls whether or not the NXAPI feature is configured on the remote device. When the value is present the NXAPI feature configuration is present in the device running-config. When the values is absent the feature configuration is removed from the running-config.
-
-
- tlsv1_0 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Controls the use of the Transport Layer Security version 1.0 is configured. By default, this feature is enabled. To disable the use of TLSV1.0, set the value of this argument to True.
-
-
- tlsv1_1 - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Controls the use of the Transport Layer Security version 1.1 is configured. By default, this feature is disabled. To enable the use of TLSV1.1, set the value of this argument to True.
-
-
- tlsv1_2 - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Controls the use of the Transport Layer Security version 1.2 is configured. By default, this feature is disabled. To enable the use of TLSV1.2, set the value of this argument to True.
-
-
- - -Notes ------ - -.. note:: - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Enable NXAPI access with default configuration - cisco.nxos.nxos_nxapi: - state: present - - - name: Enable NXAPI with no HTTP, HTTPS at port 9443 and sandbox disabled - cisco.nxos.nxos_nxapi: - enable_http: false - https_port: 9443 - https: true - enable_sandbox: false - - - name: remove NXAPI configuration - cisco.nxos.nxos_nxapi: - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- updates - -
- list -
- 		always -
Returns the list of commands that need to be pushed into the remote device to satisfy the arguments
-
-
Sample:
-
['no feature nxapi']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_ospf_interfaces_module.rst b/docs/cisco.nxos.nxos_ospf_interfaces_module.rst deleted file mode 100644 index ff69b6e71..000000000 --- a/docs/cisco.nxos.nxos_ospf_interfaces_module.rst +++ /dev/null @@ -1,1732 +0,0 @@ -.. _cisco.nxos.nxos_ospf_interfaces_module: - - -******************************* -cisco.nxos.nxos_ospf_interfaces -******************************* - -**OSPF Interfaces Resource Module.** - - -Version added: 1.3.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages OSPF(v2/v3) configuration of interfaces on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of OSPF configuration for interfaces.
-
-
- address_family - -
- list - / elements=dictionary -
- 		- -
OSPF settings on the interfaces in address-family context.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
Address Family Identifier (AFI) for OSPF settings on the interfaces.
-
-
- authentication - -
- dictionary -
- 		- -
Authentication settings on the interface.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/disable authentication on the interface.
-
-
- key_chain - -
- string -
- 		- -
Authentication password key-chain.
-
-
- message_digest - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use message-digest authentication.
-
-
- null_auth - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use null(disable) authentication.
-
-
- authentication_key - -
- dictionary -
- 		- -
Configure the authentication key for the interface.
-
-
- encryption - -
- integer -
- 		- -
0 Specifies an UNENCRYPTED authentication key will follow.
-
3 Specifies an 3DES ENCRYPTED authentication key will follow.
-
7 Specifies a Cisco type 7 ENCRYPTED authentication key will follow.
-
-
- key - -
- string - / required -
- 		- -
Authentication key.
-
Valid values are Cisco type 7 ENCRYPTED password, 3DES ENCRYPTED password and UNENCRYPTED (cleartext) password based on the value of encryption key.
-
-
- cost - -
- integer -
- 		- -
Cost associated with interface.
-
-
- dead_interval - -
- integer -
- 		- -
Dead interval value (in seconds).
-
-
- default_passive_interface - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set passive-interface attribute on this interface to default.
-
This option is mutually exclusive with passive_interface.
-
-
- hello_interval - -
- integer -
- 		- -
Hello interval value (in seconds).
-
-
- instance - -
- integer -
- 		- -
Instance identifier.
-
-
- message_digest_key - -
- dictionary -
- 		- -
Message digest authentication password (key) settings.
-
-
- encryption - -
- integer -
- 		- -
0 Specifies an UNENCRYPTED ospf password (key) will follow.
-
3 Specifies an 3DES ENCRYPTED ospf password (key) will follow.
-
7 Specifies a Cisco type 7 ENCRYPTED the ospf password (key) will follow.
-
-
- key - -
- string - / required -
- 		- -
Authentication key.
-
Valid values are Cisco type 7 ENCRYPTED password, 3DES ENCRYPTED password and UNENCRYPTED (cleartext) password based on the value of encryption key.
-
-
- key_id - -
- integer - / required -
- 		- -
Key ID.
-
-
- mtu_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/disable OSPF MTU mismatch detection.
-
-
- multi_areas - -
- list - / elements=string -
- 		- -
Multi-Areas associated with interface (not tied to OSPF process).
-
Valid values are Area Ids as an integer or IP address.
-
-
- network - -
- string -
- 		-
    Choices: -
  • broadcast
    • -
  • point-to-point
    • -
- 		-
Network type.
-
-
- passive_interface - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress routing updates on the interface.
-
This option is mutually exclusive with default_passive_interface.
-
-
- priority - -
- integer -
- 		- -
Router priority.
-
-
- processes - -
- list - / elements=dictionary -
- 		- -
Interfaces configuration for an OSPF process.
-
-
- area - -
- dictionary -
- 		- -
Area associated with interface.
-
-
- area_id - -
- string - / required -
- 		- -
Area ID in IP address format.
-
-
- secondaries - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not include secondary IPv4/IPv6 addresses.
-
-
- multi_areas - -
- list - / elements=string -
- 		- -
Multi-Areas associated with interface.
-
Valid values are Area Ids as an integer or IP address.
-
-
- process_id - -
- string - / required -
- 		- -
OSPF process tag.
-
-
- retransmit_interval - -
- integer -
- 		- -
Packet retransmission interval.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Shutdown OSPF on this interface.
-
-
- transmit_delay - -
- integer -
- 		- -
Packet transmission delay.
-
-
- name - -
- string - / required -
- 		- -
Name/Identifier of the interface.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section "^interface".
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • parsed
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
-
- - -Notes ------ - -.. note:: - - Unsupported for Cisco MDS - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # interface Ethernet1/2 - # no switchport - # interface Ethernet1/3 - # no switchport - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_ospf_interfaces: - config: - - name: Ethernet1/1 - address_family: - - afi: ipv4 - processes: - - process_id: '100' - area: - area_id: 1.1.1.1 - secondaries: false - multi_areas: - - 11.11.11.11 - - afi: ipv6 - processes: - - process_id: '200' - area: - area_id: 2.2.2.2 - multi_areas: - - 21.0.0.0 - - process_id: '300' - multi_areas: - - 50.50.50.50 - multi_areas: - - 16.10.10.10 - - name: Ethernet1/2 - address_family: - - afi: ipv4 - authentication: - enable: true - key_chain: test-1 - message_digest_key: - key_id: 10 - encryption: 3 - key: abc01d272be25d29 - cost: 100 - - afi: ipv6 - network: broadcast - shutdown: true - - name: Ethernet1/3 - address_family: - - afi: ipv4 - authentication_key: - encryption: 7 - key: 12090404011C03162E - state: merged - - # Task output: - # ------------ - # before: - # - name: Ethernet1/1 - # - name: Ethernet1/2 - # - name: Ethernet1/3 - # - # commands: - # - interface Ethernet1/1 - # - ip router ospf multi-area 11.11.11.11 - # - ip router ospf 100 area 1.1.1.1 secondaries none - # - ipv6 router ospfv3 multi-area 16.10.10.10 - # - ipv6 router ospfv3 200 area 2.2.2.2 - # - ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - interface Ethernet1/2 - # - ip ospf authentication key-chain test-1 - # - ip ospf authentication - # - ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # - ip ospf cost 100 - # - ospfv3 network broadcast - # - ospfv3 shutdown - # - interface Ethernet1/3 - # - ip ospf authentication-key 7 12090404011C03162E - # - # after: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.11 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # - afi: ipv6 - # multi_areas: - # - 16.10.10.10 - # processes: - # - area: - # area_id: 2.2.2.2 - # multi_areas: - # - 21.0.0.0 - # process_id: '200' - # - multi_areas: - # - 50.50.50.50 - # process_id: '300' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - - # After state: - # ------------ - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - - # Using replaced - - # Before state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - - name: Replace OSPF configurations of listed interfaces with provided configurations - cisco.nxos.nxos_ospf_interfaces: - config: - - name: Ethernet1/1 - address_family: - - afi: ipv4 - processes: - - process_id: "100" - area: - area_id: 1.1.1.1 - secondaries: false - multi_areas: - - 11.11.11.12 - - name: Ethernet1/3 - state: replaced - - # Task output: - # ------------ - # before: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.11 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # - afi: ipv6 - # multi_areas: - # - 16.10.10.10 - # processes: - # - area: - # area_id: 2.2.2.2 - # multi_areas: - # - 21.0.0.0 - # process_id: '200' - # - multi_areas: - # - 50.50.50.50 - # process_id: '300' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - # - # commands: - # - interface Ethernet1/1 - # - ip router ospf multi-area 11.11.11.12 - # - no ip router ospf multi-area 11.11.11.11 - # - no ipv6 router ospfv3 multi-area 16.10.10.10 - # - no ipv6 router ospfv3 200 area 2.2.2.2 - # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - interface Ethernet1/3 - # - no ip ospf authentication-key 7 12090404011C03162E - # - # after: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.12 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - name: Ethernet1/3 - # - # After state: - # ------------ - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.12 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - - - # Using overridden - - # Before state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - - name: Override all OSPF interfaces configuration with provided configuration - cisco.nxos.nxos_ospf_interfaces: - config: - - name: Ethernet1/1 - address_family: - - afi: ipv4 - processes: - - process_id: "100" - area: - area_id: 1.1.1.1 - secondaries: false - multi_areas: - - 11.11.11.12 - state: overridden - - # Task output: - # ------------ - # before: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.11 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # - afi: ipv6 - # multi_areas: - # - 16.10.10.10 - # processes: - # - area: - # area_id: 2.2.2.2 - # multi_areas: - # - 21.0.0.0 - # process_id: '200' - # - multi_areas: - # - 50.50.50.50 - # process_id: '300' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - # - # commands: - # - interface Ethernet1/2 - # - no ip ospf authentication key-chain test-1 - # - no ip ospf authentication - # - no ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # - no ip ospf cost 100 - # - no ospfv3 network broadcast - # - no ospfv3 shutdown - # - interface Ethernet1/3 - # - no ip ospf authentication-key 7 12090404011C03162E - # - interface Ethernet1/1 - # - ip router ospf multi-area 11.11.11.12 - # - no ip router ospf multi-area 11.11.11.11 - # - no ipv6 router ospfv3 multi-area 16.10.10.10 - # - no ipv6 router ospfv3 200 area 2.2.2.2 - # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - # after: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.12 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # name: Ethernet1/1 - # - name: Ethernet1/2 - # - name: Ethernet1/3 - - # After state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.12 - # interface Ethernet1/2 - # no switchport - # interface Ethernet1/3 - # no switchport - - # Using deleted to delete OSPF config of a single interface - - # Before state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - - name: Delete OSPF config from a single interface - cisco.nxos.nxos_ospf_interfaces: - config: - - name: Ethernet1/1 - state: deleted - - # Task output: - # ------------ - # before: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.11 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # - afi: ipv6 - # multi_areas: - # - 16.10.10.10 - # processes: - # - area: - # area_id: 2.2.2.2 - # multi_areas: - # - 21.0.0.0 - # process_id: '200' - # - multi_areas: - # - 50.50.50.50 - # process_id: '300' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - # - # commands: - # - interface Ethernet1/1 - # - no ip router ospf multi-area 11.11.11.11 - # - no ip router ospf 100 area 1.1.1.1 secondaries none - # - no ipv6 router ospfv3 multi-area 16.10.10.10 - # - no ipv6 router ospfv3 200 area 2.2.2.2 - # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - # after: - # - name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - - - # After state: - # ------------ - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - # Using deleted to delete OSPF config from all interfaces - - # Before state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - - name: Delete OSPF config from all interfaces - cisco.nxos.nxos_ospf_interfaces: - state: deleted - - # Task output: - # ------------ - # before: - # - name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - # - # commands: - # - interface Ethernet1/1 - # - no ip router ospf multi-area 11.11.11.11 - # - no ip router ospf 100 area 1.1.1.1 secondaries none - # - no ipv6 router ospfv3 multi-area 16.10.10.10 - # - no ipv6 router ospfv3 200 area 2.2.2.2 - # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - interface Ethernet1/2 - # - no ip ospf authentication key-chain test-1 - # - no ip ospf authentication - # - no ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # - no ip ospf cost 100 - # - no ospfv3 network broadcast - # - no ospfv3 shutdown - # - interface Ethernet1/3 - # - no ip ospf authentication-key 7 12090404011C03162E - # - # after: - # - name: Ethernet1/1 - # - name: Ethernet1/2 - # - name: Ethernet1/3 - - # After state: - # ------------ - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # interface Ethernet1/2 - # no switchport - # interface Ethernet1/3 - # no switchport - - # Using rendered - - - name: >- - Render platform specific configuration lines with state rendered (without - connecting to the device) - cisco.nxos.nxos_ospf_interfaces: - config: - - name: Ethernet1/1 - address_family: - - afi: ipv4 - processes: - - process_id: '100' - area: - area_id: 1.1.1.1 - secondaries: false - multi_areas: - - 11.11.11.11 - - afi: ipv6 - processes: - - process_id: '200' - area: - area_id: 2.2.2.2 - multi_areas: - - 21.0.0.0 - - process_id: '300' - multi_areas: - - 50.50.50.50 - multi_areas: - - 16.10.10.10 - - name: Ethernet1/2 - address_family: - - afi: ipv4 - authentication: - enable: true - key_chain: test-1 - message_digest_key: - key_id: 10 - encryption: 3 - key: abc01d272be25d29 - cost: 100 - - afi: ipv6 - network: broadcast - shutdown: true - - name: Ethernet1/3 - address_family: - - afi: ipv4 - authentication_key: - encryption: 7 - key: 12090404011C03162E - state: rendered - - - # Task Output: - # ------------ - # rendered: - # - interface Ethernet1/1 - # - ip router ospf multi-area 11.11.11.11 - # - ip router ospf 100 area 1.1.1.1 secondaries none - # - ipv6 router ospfv3 multi-area 16.10.10.10 - # - ipv6 router ospfv3 200 area 2.2.2.2 - # - ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - interface Ethernet1/2 - # - ip ospf authentication key-chain test-1 - # - ip ospf authentication - # - ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # - ip ospf cost 100 - # - ospfv3 network broadcast - # - ospfv3 shutdown - # - interface Ethernet1/3 - # - ip ospf authentication-key 7 12090404011C03162E - - # Using parsed - - # parsed.cfg - # ------------ - # interface Ethernet1/1 - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # interface Ethernet1/2 - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # ip ospf authentication-key 7 12090404011C03162E - - - name: arse externally provided OSPF interfaces config - cisco.nxos.nxos_ospf_interfaces: - running_config: "{{ lookup('file', 'ospf_interfaces.cfg') }}" - state: parsed - - # Task output: - # ------------ - # parsed: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.11 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # - afi: ipv6 - # multi_areas: - # - 16.10.10.10 - # processes: - # - area: - # area_id: 2.2.2.2 - # multi_areas: - # - 21.0.0.0 - # process_id: '200' - # - multi_areas: - # - 50.50.50.50 - # process_id: '300' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - - # Using gathered - - # On-box config - - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.12 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - - # Task output: - # ------------ - # gathered: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.12 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - name: Ethernet1/3 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/1', 'ip router ospf multi-area 11.11.11.11', 'ip router ospf 100 area 1.1.1.1 secondaries none', 'no ipv6 router ospfv3 multi-area 16.10.10.10', 'ipv6 router ospfv3 200 area 2.2.2.2', 'ipv6 router ospfv3 200 multi-area 21.0.0.0', 'ipv6 router ospfv3 300 multi-area 50.50.50.50', 'interface Ethernet1/2', 'no ip ospf authentication key-chain test-1', 'ip ospf authentication']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['interface Ethernet1/1', 'ip router ospf multi-area 11.11.11.11', 'ip router ospf 100 area 1.1.1.1 secondaries none']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_ospfv2_module.rst b/docs/cisco.nxos.nxos_ospfv2_module.rst deleted file mode 100644 index 2115d34f2..000000000 --- a/docs/cisco.nxos.nxos_ospfv2_module.rst +++ /dev/null @@ -1,5458 +0,0 @@ -.. _cisco.nxos.nxos_ospfv2_module: - - -********************** -cisco.nxos.nxos_ospfv2 -********************** - -**OSPFv2 resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages OSPFv2 configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A list of OSPF process configuration.
-
-
- processes - -
- list - / elements=dictionary -
- 		- -
A list of OSPF instances' configurations.
-
-
- areas - -
- list - / elements=dictionary -
- 		- -
Configure properties of OSPF Areas.
-
-
- area_id - -
- string - / required -
- 		- -
The Area ID in IP Address format.
-
-
- authentication - -
- dictionary -
- 		- -
Authentication settings for the Area.
-
-
- message_digest - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use message-digest authentication.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set authentication for the area.
-
-
- default_cost - -
- integer -
- 		- -
Specify the default cost for default summary LSA.
-
-
- filter_list - -
- list - / elements=dictionary -
- 		- -
Filter prefixes between OSPF areas.
-
-
- direction - -
- string - / required -
- 		-
    Choices: -
  • in
    • -
  • out
    • -
- 		-
The direction to apply the route map.
-
-
- route_map - -
- string - / required -
- 		- -
The Route-map name.
-
-
- nssa - -
- dictionary -
- 		- -
NSSA settings for the area.
-
-
- default_information_originate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Originate Type-7 default LSA into NSSA area.
-
-
- no_redistribution - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send redistributed LSAs into NSSA area.
-
-
- no_summary - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send summary LSAs into NSSA area.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure area as NSSA.
-
-
- translate - -
- dictionary -
- 		- -
Translate LSA.
-
-
- type7 - -
- dictionary -
- 		- -
Translate from Type 7 to Type 5.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always translate LSAs
-
-
- never - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Never translate LSAs
-
-
- supress_fa - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress forwarding address in translated LSAs.
-
-
- ranges - -
- list - / elements=dictionary -
- 		- -
Configure an address range for the area.
-
-
- cost - -
- integer -
- 		- -
Cost to use for the range.
-
-
- not_advertise - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress advertising the specified range.
-
-
- prefix - -
- string - / required -
- 		- -
IP in Prefix format (x.x.x.x/len)
-
-
- stub - -
- dictionary -
- 		- -
Settings for configuring the area as a stub.
-
-
- no_summary - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Prevent ABR from sending summary LSAs into stub area.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure the area as a stub.
-
-
- auto_cost - -
- dictionary -
- 		- -
Calculate OSPF cost according to bandwidth.
-
-
- reference_bandwidth - -
- integer - / required -
- 		- -
Reference bandwidth used to assign OSPF cost.
-
-
- unit - -
- string - / required -
- 		-
    Choices: -
  • Gbps
    • -
  • Mbps
    • -
- 		-
Specify in which unit the reference bandwidth is specified.
-
-
- bfd - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable BFD on all OSPF interfaces.
-
-
- default_information - -
- dictionary -
- 		- -
Control distribution of default routes.
-
-
- originate - -
- dictionary -
- 		- -
Distribute a default route.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always advertise a default route.
-
-
- route_map - -
- string -
- 		- -
Policy to control distribution of default routes
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable distribution of default route.
-
-
- default_metric - -
- integer -
- 		- -
Specify default metric for redistributed routes.
-
-
- distance - -
- integer -
- 		- -
Configure the OSPF administrative distance.
-
-
- flush_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flush routes on a non-graceful controlled restart.
-
-
- graceful_restart - -
- dictionary -
- 		- -
Configure graceful restart.
-
-
- grace_period - -
- integer -
- 		- -
Configure maximum interval to restart gracefully.
-
-
- helper_disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable helper mode.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable graceful-restart.
-
-
- isolate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Isolate this router from OSPF perspective.
-
-
- log_adjacency_changes - -
- dictionary -
- 		- -
Log changes in adjacency state.
-
-
- detail - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Notify all state changes.
-
-
- log - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/disable logging changes in adjacency state.
-
-
- max_lsa - -
- dictionary -
- 		- -
Feature to limit the number of non-self-originated LSAs.
-
-
- ignore_count - -
- integer -
- 		- -
Set count on how many times adjacencies can be suppressed.
-
-
- ignore_time - -
- integer -
- 		- -
Set time during which all adjacencies are suppressed.
-
-
- max_non_self_generated_lsa - -
- integer - / required -
- 		- -
Set the maximum number of non self-generated LSAs.
-
-
- reset_time - -
- integer -
- 		- -
Set number of minutes after which ignore-count is reset to zero.
-
-
- threshold - -
- integer -
- 		- -
Threshold value (%) at which to generate a warning message.
-
-
- warning_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Log a warning message when limit is exceeded.
-
-
- max_metric - -
- dictionary -
- 		- -
Maximize the cost metric.
-
-
- router_lsa - -
- dictionary -
- 		- -
Router LSA configuration.
-
-
- external_lsa - -
- dictionary -
- 		- -
External LSA configuration.
-
-
- max_metric_value - -
- integer -
- 		- -
Set max metric value for external LSAs.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set external-lsa attribute.
-
-
- include_stub - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise Max metric for Stub links as well.
-
-
- on_startup - -
- dictionary -
- 		- -
Effective only at startup.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set on-startup attribute.
-
-
- wait_for_bgp_asn - -
- integer -
- 		- -
ASN of BGP to wait for.
-
-
- wait_period - -
- integer -
- 		- -
Wait period in seconds after startup.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set router-lsa attribute.
-
-
- summary_lsa - -
- dictionary -
- 		- -
Summary LSAs configuration.
-
-
- max_metric_value - -
- integer -
- 		- -
Max metric value for summary LSAs.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set summary-lsa attribute.
-
-
- maximum_paths - -
- integer -
- 		- -
Maximum paths per destination.
-
-
- mpls - -
- dictionary -
- 		- -
OSPF MPLS configuration settings.
-
-
- traffic_eng - -
- dictionary -
- 		- -
OSPF MPLS Traffic Engineering commands.
-
-
- areas - -
- list - / elements=dictionary -
- 		- -
List of Area IDs.
-
-
- area_id - -
- string -
- 		- -
Area Id in ip address format.
-
-
- multicast_intact - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
MPLS TE multicast support.
-
-
- router_id - -
- string -
- 		- -
Router ID associated with TE.
-
-
- name_lookup - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Display OSPF router ids as DNS names.
-
-
- passive_interface - -
- dictionary -
- 		- -
Suppress routing updates on the interface.
-
-
- default - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Interfaces passive by default.
-
-
- process_id - -
- string - / required -
- 		- -
The OSPF process tag.
-
-
- redistribute - -
- list - / elements=dictionary -
- 		- -
Redistribute information from another routing protocol.
-
-
- id - -
- string -
- 		- -
The identifier for the protocol specified.
-
-
- protocol - -
- string - / required -
- 		-
    Choices: -
  • bgp
    • -
  • direct
    • -
  • eigrp
    • -
  • isis
    • -
  • lisp
    • -
  • ospf
    • -
  • rip
    • -
  • static
    • -
- 		-
The name of the protocol.
-
-
- route_map - -
- string - / required -
- 		- -
The route map policy to constrain redistribution.
-
-
- rfc1583compatibility - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure 1583 compatibility for external path preferences.
-
-
- router_id - -
- string -
- 		- -
Set OSPF process router-id.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Shutdown the OSPF protocol instance.
-
-
- summary_address - -
- list - / elements=dictionary -
- 		- -
Configure route summarization for redistribution.
-
-
- not_advertise - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress advertising the specified summary.
-
-
- prefix - -
- string - / required -
- 		- -
IP prefix in format x.x.x.x/ml.
-
-
- tag - -
- integer -
- 		- -
A 32-bit tag value.
-
-
- table_map - -
- dictionary -
- 		- -
Policy for filtering/modifying OSPF routes before sending them to RIB.
-
-
- filter - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Block the OSPF routes from being sent to RIB.
-
-
- name - -
- string - / required -
- 		- -
The Route Map name.
-
-
- timers - -
- dictionary -
- 		- -
Configure timer related constants.
-
-
- lsa_arrival - -
- integer -
- 		- -
Mimimum interval between arrival of a LSA.
-
-
- lsa_group_pacing - -
- integer -
- 		- -
LSA group refresh/maxage interval.
-
-
- throttle - -
- dictionary -
- 		- -
Configure throttle related constants.
-
-
- lsa - -
- dictionary -
- 		- -
Set rate-limiting for LSA generation.
-
-
- hold_interval - -
- integer -
- 		- -
The hold interval.
-
-
- max_interval - -
- integer -
- 		- -
The max interval.
-
-
- start_interval - -
- integer -
- 		- -
The start interval.
-
-
- spf - -
- dictionary -
- 		- -
Set OSPF SPF timers.
-
-
- initial_spf_delay - -
- integer -
- 		- -
Initial SPF schedule delay in milliseconds.
-
-
- max_wait_time - -
- integer -
- 		- -
Maximum wait time between SPF calculations.
-
-
- min_hold_time - -
- integer -
- 		- -
Minimum hold time between SPF calculations.
-
-
- vrfs - -
- list - / elements=dictionary -
- 		- -
Configure VRF specific OSPF settings.
-
-
- areas - -
- list - / elements=dictionary -
- 		- -
Configure properties of OSPF Areas.
-
-
- area_id - -
- string - / required -
- 		- -
The Area ID in IP Address format.
-
-
- authentication - -
- dictionary -
- 		- -
Authentication settings for the Area.
-
-
- message_digest - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use message-digest authentication.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set authentication for the area.
-
-
- default_cost - -
- integer -
- 		- -
Specify the default cost for default summary LSA.
-
-
- filter_list - -
- list - / elements=dictionary -
- 		- -
Filter prefixes between OSPF areas.
-
-
- direction - -
- string - / required -
- 		-
    Choices: -
  • in
    • -
  • out
    • -
- 		-
The direction to apply the route map.
-
-
- route_map - -
- string - / required -
- 		- -
The Route-map name.
-
-
- nssa - -
- dictionary -
- 		- -
NSSA settings for the area.
-
-
- default_information_originate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Originate Type-7 default LSA into NSSA area.
-
-
- no_redistribution - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send redistributed LSAs into NSSA area.
-
-
- no_summary - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send summary LSAs into NSSA area.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure area as NSSA.
-
-
- translate - -
- dictionary -
- 		- -
Translate LSA.
-
-
- type7 - -
- dictionary -
- 		- -
Translate from Type 7 to Type 5.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always translate LSAs
-
-
- never - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Never translate LSAs
-
-
- supress_fa - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress forwarding address in translated LSAs.
-
-
- ranges - -
- list - / elements=dictionary -
- 		- -
Configure an address range for the area.
-
-
- cost - -
- integer -
- 		- -
Cost to use for the range.
-
-
- not_advertise - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress advertising the specified range.
-
-
- prefix - -
- string - / required -
- 		- -
IP in Prefix format (x.x.x.x/len)
-
-
- stub - -
- dictionary -
- 		- -
Settings for configuring the area as a stub.
-
-
- no_summary - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Prevent ABR from sending summary LSAs into stub area.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure the area as a stub.
-
-
- auto_cost - -
- dictionary -
- 		- -
Calculate OSPF cost according to bandwidth.
-
-
- reference_bandwidth - -
- integer - / required -
- 		- -
Reference bandwidth used to assign OSPF cost.
-
-
- unit - -
- string - / required -
- 		-
    Choices: -
  • Gbps
    • -
  • Mbps
    • -
- 		-
Specify in which unit the reference bandwidth is specified.
-
-
- bfd - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable BFD on all OSPF interfaces.
-
-
- capability - -
- dictionary -
- 		- -
OSPF capability settings.
-
-
- vrf_lite - -
- dictionary -
- 		- -
Enable VRF-lite capability settings.
-
-
- evpn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ethernet VPN.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable VRF-lite support.
-
-
- default_information - -
- dictionary -
- 		- -
Control distribution of default routes.
-
-
- originate - -
- dictionary -
- 		- -
Distribute a default route.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always advertise a default route.
-
-
- route_map - -
- string -
- 		- -
Policy to control distribution of default routes
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable distribution of default route.
-
-
- default_metric - -
- integer -
- 		- -
Specify default metric for redistributed routes.
-
-
- distance - -
- integer -
- 		- -
Configure the OSPF administrative distance.
-
-
- down_bit_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure a PE router to ignore the DN bit for network summary, external and NSSA external LSA.
-
-
- graceful_restart - -
- dictionary -
- 		- -
Configure graceful restart.
-
-
- grace_period - -
- integer -
- 		- -
Configure maximum interval to restart gracefully.
-
-
- helper_disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable helper mode.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable graceful-restart.
-
-
- log_adjacency_changes - -
- dictionary -
- 		- -
Log changes in adjacency state.
-
-
- detail - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Notify all state changes.
-
-
- log - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/disable logging changes in adjacency state.
-
-
- max_lsa - -
- dictionary -
- 		- -
Feature to limit the number of non-self-originated LSAs.
-
-
- ignore_count - -
- integer -
- 		- -
Set count on how many times adjacencies can be suppressed.
-
-
- ignore_time - -
- integer -
- 		- -
Set time during which all adjacencies are suppressed.
-
-
- max_non_self_generated_lsa - -
- integer - / required -
- 		- -
Set the maximum number of non self-generated LSAs.
-
-
- reset_time - -
- integer -
- 		- -
Set number of minutes after which ignore-count is reset to zero.
-
-
- threshold - -
- integer -
- 		- -
Threshold value (%) at which to generate a warning message.
-
-
- warning_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Log a warning message when limit is exceeded.
-
-
- max_metric - -
- dictionary -
- 		- -
Maximize the cost metric.
-
-
- router_lsa - -
- dictionary -
- 		- -
Router LSA configuration.
-
-
- external_lsa - -
- dictionary -
- 		- -
External LSA configuration.
-
-
- max_metric_value - -
- integer -
- 		- -
Set max metric value for external LSAs.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set external-lsa attribute.
-
-
- include_stub - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise Max metric for Stub links as well.
-
-
- on_startup - -
- dictionary -
- 		- -
Effective only at startup.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set on-startup attribute.
-
-
- wait_for_bgp_asn - -
- integer -
- 		- -
ASN of BGP to wait for.
-
-
- wait_period - -
- integer -
- 		- -
Wait period in seconds after startup.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set router-lsa attribute.
-
-
- summary_lsa - -
- dictionary -
- 		- -
Summary LSAs configuration.
-
-
- max_metric_value - -
- integer -
- 		- -
Max metric value for summary LSAs.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set summary-lsa attribute.
-
-
- maximum_paths - -
- integer -
- 		- -
Maximum paths per destination.
-
-
- name_lookup - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Display OSPF router ids as DNS names.
-
-
- passive_interface - -
- dictionary -
- 		- -
Suppress routing updates on the interface.
-
-
- default - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Interfaces passive by default.
-
-
- redistribute - -
- list - / elements=dictionary -
- 		- -
Redistribute information from another routing protocol.
-
-
- id - -
- string -
- 		- -
The identifier for the protocol specified.
-
-
- protocol - -
- string - / required -
- 		-
    Choices: -
  • bgp
    • -
  • direct
    • -
  • eigrp
    • -
  • isis
    • -
  • lisp
    • -
  • ospf
    • -
  • rip
    • -
  • static
    • -
- 		-
The name of the protocol.
-
-
- route_map - -
- string - / required -
- 		- -
The route map policy to constrain redistribution.
-
-
- rfc1583compatibility - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure 1583 compatibility for external path preferences.
-
-
- router_id - -
- string -
- 		- -
Set OSPF process router-id.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Shutdown the OSPF protocol instance.
-
-
- summary_address - -
- list - / elements=dictionary -
- 		- -
Configure route summarization for redistribution.
-
-
- not_advertise - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress advertising the specified summary.
-
-
- prefix - -
- string - / required -
- 		- -
IP prefix in format x.x.x.x/ml.
-
-
- tag - -
- integer -
- 		- -
A 32-bit tag value.
-
-
- table_map - -
- dictionary -
- 		- -
Policy for filtering/modifying OSPF routes before sending them to RIB.
-
-
- filter - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Block the OSPF routes from being sent to RIB.
-
-
- name - -
- string - / required -
- 		- -
The Route Map name.
-
-
- timers - -
- dictionary -
- 		- -
Configure timer related constants.
-
-
- lsa_arrival - -
- integer -
- 		- -
Mimimum interval between arrival of a LSA.
-
-
- lsa_group_pacing - -
- integer -
- 		- -
LSA group refresh/maxage interval.
-
-
- throttle - -
- dictionary -
- 		- -
Configure throttle related constants.
-
-
- lsa - -
- dictionary -
- 		- -
Set rate-limiting for LSA generation.
-
-
- hold_interval - -
- integer -
- 		- -
The hold interval.
-
-
- max_interval - -
- integer -
- 		- -
The max interval.
-
-
- start_interval - -
- integer -
- 		- -
The start interval.
-
-
- spf - -
- dictionary -
- 		- -
Set OSPF SPF timers.
-
-
- initial_spf_delay - -
- integer -
- 		- -
Initial SPF schedule delay in milliseconds.
-
-
- max_wait_time - -
- integer -
- 		- -
Maximum wait time between SPF calculations.
-
-
- min_hold_time - -
- integer -
- 		- -
Minimum hold time between SPF calculations.
-
-
- vrf - -
- string - / required -
- 		- -
Name/Identifier of the VRF.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section "^router ospf .*".
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • parsed
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 7.0(3)I5(1). - - Unsupported for Cisco MDS - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # nxos-9k-rdo# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_ospfv2: - config: - processes: - - process_id: 100 - router_id: 203.0.113.20 - - process_id: 102 - router_id: 198.51.100.1 - areas: - - area_id: 0.0.0.100 - filter_list: - - route_map: rmap_1 - direction: in - - route_map: rmap_2 - direction: out - ranges: - - prefix: 198.51.100.64/27 - not_advertise: true - - prefix: 198.51.100.96/27 - cost: 120 - - area_id: 0.0.0.101 - authentication: - message_digest: true - redistribute: - - protocol: eigrp - id: 120 - route_map: rmap_1 - - protocol: direct - route_map: ospf102-direct-connect - vrfs: - - vrf: zone1 - router_id: 198.51.100.129 - redistribute: - - protocol: static - route_map: zone1-static-connect - summary_address: - - prefix: 198.51.100.128/27 - tag: 121 - - prefix: 198.51.100.160/27 - areas: - - area_id: 0.0.0.102 - nssa: - default_information_originate: true - no_summary: true - - area_id: 0.0.0.103 - nssa: - no_summary: true - translate: - type7: - always: true - - vrf: zone2 - auto_cost: - reference_bandwidth: 45 - unit: Gbps - state: merged - - # Task output: - # ------------ - # before: {} - # - # commands: - # - router ospf 102 - # - router-id 198.51.100.1 - # - redistribute eigrp 120 route-map rmap_1 - # - redistribute direct route-map ospf102-direct-connect - # - area 0.0.0.100 filter-list route-map rmap_1 in - # - area 0.0.0.100 filter-list route-map rmap_2 out - # - area 0.0.0.100 range 198.51.100.64/27 not-advertise - # - area 0.0.0.100 range 198.51.100.96/27 cost 120 - # - area 0.0.0.101 authentication message-digest - # - vrf zone1 - # - router-id 198.51.100.129 - # - summary-address 198.51.100.128/27 tag 121 - # - summary-address 198.51.100.160/27 - # - redistribute static route-map zone1-static-connect - # - area 0.0.0.102 nssa no-summary default-information-originate - # - area 0.0.0.103 nssa no-summary - # - area 0.0.0.103 nssa translate type7 always - # - vrf zone2 - # - auto-cost reference-bandwidth 45 Gbps - # - router ospf 100 - # - router-id 203.0.113.20 - # - # after: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.100 - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # - cost: 120 - # prefix: 198.51.100.96/27 - # - area_id: 0.0.0.101 - # authentication: - # message_digest: true - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # - area_id: 0.0.0.103 - # nssa: - # no_summary: true - # translate: - # type7: - # always: true - # redistribute: - # - protocol: static - # route_map: zone1-static-connect - # router_id: 198.51.100.129 - # vrf: zone1 - # - auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # vrf: zone2 - # - - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # area 0.0.0.100 range 198.51.100.96/27 cost 120 - # area 0.0.0.101 authentication message-digest - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # area 0.0.0.103 nssa no-summary - # area 0.0.0.103 nssa translate type7 always - # redistribute static route-map zone1-static-connect - # summary-address 198.51.100.128/27 tag 121 - # summary-address 198.51.100.160/27 - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - - # Using replaced - - # Before state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # area 0.0.0.100 range 198.51.100.96/27 cost 120 - # area 0.0.0.101 authentication message-digest - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # area 0.0.0.103 nssa no-summary - # area 0.0.0.103 nssa translate type7 always - # redistribute static route-map zone1-static-connect - # summary-address 198.51.100.128/27 tag 121 - # summary-address 198.51.100.160/27 - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - - - name: >- - Replace device configurations of listed OSPF processes with provided - configurations - cisco.nxos.nxos_ospfv2: - config: - processes: - - process_id: 102 - router_id: 198.51.100.1 - areas: - - area_id: 0.0.0.100 - filter_list: - - route_map: rmap_8 - direction: in - ranges: - - prefix: 198.51.100.64/27 - not_advertise: true - - area_id: 0.0.0.101 - stub: - no_summary: true - redistribute: - - protocol: eigrp - id: 130 - route_map: rmap_1 - - protocol: direct - route_map: ospf102-direct-connect - vrfs: - - vrf: zone1 - router_id: 198.51.100.129 - redistribute: - - protocol: bgp - id: 65563 - route_map: zone1-bgp-connect - areas: - - area_id: 0.0.0.102 - nssa: - default_information_originate: true - no_summary: true - state: replaced - - - # Task output: - # ------------ - # before: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.100 - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # - cost: 120 - # prefix: 198.51.100.96/27 - # - area_id: 0.0.0.101 - # authentication: - # message_digest: true - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # - area_id: 0.0.0.103 - # nssa: - # no_summary: true - # translate: - # type7: - # always: true - # redistribute: - # - protocol: static - # route_map: zone1-static-connect - # router_id: 198.51.100.129 - # vrf: zone1 - # - auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # vrf: zone2 - # - # commands: - # - router ospf 102 - # - redistribute eigrp 130 route-map rmap_1 - # - no redistribute eigrp 120 route-map rmap_1 - # - area 0.0.0.100 filter-list route-map rmap_8 in - # - no area 0.0.0.100 filter-list route-map rmap_2 out - # - no area 0.0.0.100 range 198.51.100.96/27 - # - no area 0.0.0.101 authentication - # - area 0.0.0.101 stub no-summary - # - vrf zone1 - # - no summary-address 198.51.100.128/27 tag 121 - # - no summary-address 198.51.100.160/27 - # - redistribute bgp 65563 route-map zone1-bgp-connect - # - no redistribute static route-map zone1-static-connect - # - no area 0.0.0.103 nssa - # - no area 0.0.0.103 nssa translate type7 always - # - no vrf zone2 - # - # after: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.101 - # stub: - # no_summary: true - # - area_id: 0.0.0.100 - # filter_list: - # - direction: in - # route_map: rmap_8 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "130" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # redistribute: - # - id: "65563" - # protocol: bgp - # route_map: zone1-bgp-connect - # router_id: 198.51.100.129 - # vrf: zone1 - - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # area 0.0.0.101 stub no-summary - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 130 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_8 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # redistribute bgp 65563 route-map zone1-bgp-connect - - # Using overridden - - # Before state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # area 0.0.0.100 range 198.51.100.96/27 cost 120 - # area 0.0.0.101 authentication message-digest - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # area 0.0.0.103 nssa no-summary - # area 0.0.0.103 nssa translate type7 always - # redistribute static route-map zone1-static-connect - # summary-address 198.51.100.128/27 tag 121 - # summary-address 198.51.100.160/27 - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - - - name: Override all OSPF configuration with provided configuration - cisco.nxos.nxos_ospfv2: - config: - processes: - - process_id: 104 - router_id: 203.0.113.20 - - process_id: 102 - router_id: 198.51.100.1 - shutdown: true - state: overridden - - # Task output: - # ------------ - # before: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.100 - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # - cost: 120 - # prefix: 198.51.100.96/27 - # - area_id: 0.0.0.101 - # authentication: - # message_digest: true - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # - area_id: 0.0.0.103 - # nssa: - # no_summary: true - # translate: - # type7: - # always: true - # redistribute: - # - protocol: static - # route_map: zone1-static-connect - # router_id: 198.51.100.129 - # vrf: zone1 - # - auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # vrf: zone2 - # - # commands: - # - no router ospf 100 - # - router ospf 104 - # - router-id 203.0.113.20 - # - router ospf 102 - # - shutdown - # - no redistribute direct route-map ospf102-direct-connect - # - no redistribute eigrp 120 route-map rmap_1 - # - no area 0.0.0.100 filter-list route-map rmap_2 out - # - no area 0.0.0.100 filter-list route-map rmap_1 in - # - no area 0.0.0.100 range 198.51.100.64/27 - # - no area 0.0.0.100 range 198.51.100.96/27 - # - no area 0.0.0.101 authentication - # - no vrf zone1 - # - no vrf zone2 - # - # after: - # processes: - # - process_id: "102" - # router_id: 198.51.100.1 - # shutdown: true - # - process_id: "104" - # router_id: 203.0.113.20 - - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 102 - # router-id 198.51.100.1 - # shutdown - # router ospf 104 - # router-id 203.0.113.20 - - # Using deleted to delete a single OSPF process - - # Before state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # area 0.0.0.100 range 198.51.100.96/27 cost 120 - # area 0.0.0.101 authentication message-digest - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # area 0.0.0.103 nssa no-summary - # area 0.0.0.103 nssa translate type7 always - # redistribute static route-map zone1-static-connect - # summary-address 198.51.100.128/27 tag 121 - # summary-address 198.51.100.160/27 - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - - - name: Delete a single OSPF process - cisco.nxos.nxos_ospfv2: - config: - processes: - - process_id: 102 - state: deleted - - # Task output: - # ------------ - # before: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.100 - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # - cost: 120 - # prefix: 198.51.100.96/27 - # - area_id: 0.0.0.101 - # authentication: - # message_digest: true - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # - area_id: 0.0.0.103 - # nssa: - # no_summary: true - # translate: - # type7: - # always: true - # redistribute: - # - protocol: static - # route_map: zone1-static-connect - # router_id: 198.51.100.129 - # vrf: zone1 - # - auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # vrf: zone2 - # - # commands: - # - no router ospf 102 - # - # after: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - - # Using deleted all OSPF processes from the device - - # Before state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # area 0.0.0.100 range 198.51.100.96/27 cost 120 - # area 0.0.0.101 authentication message-digest - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # area 0.0.0.103 nssa no-summary - # area 0.0.0.103 nssa translate type7 always - # redistribute static route-map zone1-static-connect - # summary-address 198.51.100.128/27 tag 121 - # summary-address 198.51.100.160/27 - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - - - name: Delete all OSPF processes from the device - cisco.nxos.nxos_ospfv2: - state: deleted - - # Task output: - # ------------ - # before: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.100 - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # - cost: 120 - # prefix: 198.51.100.96/27 - # - area_id: 0.0.0.101 - # authentication: - # message_digest: true - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # - area_id: 0.0.0.103 - # nssa: - # no_summary: true - # translate: - # type7: - # always: true - # redistribute: - # - protocol: static - # route_map: zone1-static-connect - # router_id: 198.51.100.129 - # vrf: zone1 - # - auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # vrf: zone2 - # - # commands: - # - no router ospf 100 - # - no router ospf 102 - # - # after: {} - - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # nxos-9k-rdo# - - # Using rendered - - - name: >- - Render platform specific configuration lines (without connecting to the - device) - cisco.nxos.nxos_ospfv2: - config: - processes: - - process_id: 100 - router_id: 203.0.113.20 - - process_id: 102 - router_id: 198.51.100.1 - areas: - - area_id: 0.0.0.100 - filter_list: - - route_map: rmap_1 - direction: in - - route_map: rmap_2 - direction: out - ranges: - - prefix: 198.51.100.64/27 - not_advertise: true - - prefix: 198.51.100.96/27 - cost: 120 - - area_id: 0.0.0.101 - authentication: - message_digest: true - redistribute: - - protocol: eigrp - id: 120 - route_map: rmap_1 - - protocol: direct - route_map: ospf102-direct-connect - vrfs: - - vrf: zone1 - router_id: 198.51.100.129 - redistribute: - - protocol: static - route_map: zone1-static-connect - summary_address: - - prefix: 198.51.100.128/27 - tag: 121 - - prefix: 198.51.100.160/27 - areas: - - area_id: 0.0.0.102 - nssa: - default_information_originate: true - no_summary: true - - area_id: 0.0.0.103 - nssa: - no_summary: true - translate: - type7: - always: true - - vrf: zone2 - auto_cost: - reference_bandwidth: 45 - unit: Gbps - state: rendered - - - # Task output: - # ------------ - # rendered: - # - router ospf 100 - # - router-id 203.0.113.20 - # - router ospf 102 - # - router-id 198.51.100.1 - # - redistribute eigrp 120 route-map rmap_1 - # - redistribute direct route-map ospf102-direct-connect - # - area 0.0.0.100 filter-list route-map rmap_1 in - # - area 0.0.0.100 filter-list route-map rmap_2 out - # - area 0.0.0.100 range 198.51.100.64/27 not-advertise - # - area 0.0.0.100 range 198.51.100.96/27 cost 120 - # - area 0.0.0.101 authentication message-digest - # - vrf zone1 - # - router-id 198.51.100.129 - # - summary-address 198.51.100.128/27 tag 121 - # - summary-address 198.51.100.160/27 - # - redistribute static route-map zone1-static-connect - # - area 0.0.0.102 nssa no-summary default-information-originate - # - area 0.0.0.103 nssa no-summary - # - area 0.0.0.103 nssa translate type7 always - # - vrf zone2 - # - auto-cost reference-bandwidth 45 Gbps - - # Using parsed - - # parsed.cfg - # ------------ - # router ospf 100 - # router-id 192.0.100.1 - # area 0.0.0.101 nssa no-summary no-redistribution - # area 0.0.0.102 stub no-summary - # redistribute direct route-map ospf-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 192.0.2.0/24 not-advertise - # area 0.0.0.100 range 192.0.3.0/24 cost 120 - # area 0.0.0.100 authentication message-digest - # vrf zone1 - # router-id 192.0.100.2 - # area 0.0.100.1 nssa no-summary no-redistribution - # redistribute static route-map zone1-direct-connect - # summary-address 10.0.0.0/24 tag 120 - # summary-address 11.0.0.0/24 not-advertise - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - # down-bit-ignore - # capability vrf-lite evpn - # shutdown - # router ospf 102 - # router-id 198.54.100.1 - # shutdown - # vrf zone2 - # summary-address 192.0.8.0/24 tag 120 - # vrf zone4 - # shutdown - - - name: Parse externally provided OSPFv2 config - cisco.nxos.nxos_ospfv2: - running_config: "{{ lookup('file', 'ospfv2.cfg') }}" - state: parsed - - # Task output: - # ------------ - # parsed: - # processes: - # - process_id: "100" - # areas: - # - area_id: 0.0.0.101 - # nssa: - # no_redistribution: true - # no_summary: true - # - area_id: 0.0.0.102 - # stub: - # no_summary: true - # - area_id: 0.0.0.100 - # authentication: - # message_digest: true - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 192.0.2.0/24 - # - cost: 120 - # prefix: 192.0.3.0/24 - # redistribute: - # - protocol: direct - # route_map: ospf-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 192.0.100.1 - # vrfs: - # - vrf: zone1 - # areas: - # - area_id: 0.0.100.1 - # nssa: - # no_redistribution: true - # no_summary: true - # redistribute: - # - protocol: static - # route_map: zone1-direct-connect - # router_id: 192.0.100.2 - # summary_address: - # - prefix: 10.0.0.0/24 - # tag: 120 - # - not_advertise: true - # prefix: 11.0.0.0/24 - # - vrf: zone2 - # auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # capability: - # vrf_lite: - # evpn: true - # down_bit_ignore: true - # shutdown: true - # - process_id: "102" - # router_id: 198.54.100.1 - # shutdown: true - # vrfs: - # - vrf: zone2 - # summary_address: - # - prefix: 192.0.8.0/24 - # tag: 120 - # - vrf: zone4 - # shutdown: true - - # Using gathered - - - name: Gather OSPFv2 facts using gathered - cisco.nxos.nxos_ospfv2: - state: gathered - - # Task output: - # ------------ - # gathered: - # processes: - # - process_id: "102" - # areas: - # - area_id: 0.0.0.101 - # stub: - # no_summary: true - # - area_id: 0.0.0.100 - # filter_list: - # - direction: in - # route_map: rmap_8 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "130" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - vrf: zone1 - # areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # redistribute: - # - id: "65563" - # protocol: bgp - # route_map: zone1-bgp-connect - # router_id: 198.51.100.129 - # - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['router ospf 102', 'router-id 198.54.100.1', 'router ospf 100', 'router-id 192.0.100.1', 'redistribute eigrp 120 route-map rmap_1', 'redistribute direct route-map ospf-direct-connect', 'area 0.0.0.100 filter-list route-map rmap_1 in', 'area 0.0.0.100 filter-list route-map rmap_2 out', 'area 0.0.0.100 range 192.0.2.0/24 not-advertise', 'area 0.0.0.100 range 192.0.3.0/24 cost 120', 'vrf zone1', 'router-id 192.0.100.2', 'summary-address 10.0.0.0/24 tag 121', 'summary-address 11.0.0.0/24', 'redistribute static route-map zone1-direct-connect', 'vrf zone2', 'auto-cost reference-bandwidth 45 Gbps', 'capability vrf-lite evpn']
-
-
- gathered - -
- dictionary -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- dictionary -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['router ospf 102', 'router-id 198.54.100.1', 'router ospf 100']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_overlay_global_module.rst b/docs/cisco.nxos.nxos_overlay_global_module.rst deleted file mode 100644 index 1a1b8d975..000000000 --- a/docs/cisco.nxos.nxos_overlay_global_module.rst +++ /dev/null @@ -1,120 +0,0 @@ -.. _cisco.nxos.nxos_overlay_global_module: - - -****************************** -cisco.nxos.nxos_overlay_global -****************************** - -**Configures anycast gateway MAC of the switch.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configures anycast gateway MAC of the switch. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- anycast_gateway_mac - -
- string - / required -
- 		- -
Anycast gateway mac of the switch.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Default restores params default value - - Supported MAC address format are "E.E.E", "EE-EE-EE-EE-EE-EE", "EE:EE:EE:EE:EE:EE" and "EEEE.EEEE.EEEE" - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_overlay_global: - anycast_gateway_mac: b.b.b - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['fabric forwarding anycast-gateway-mac 000B.000B.000B']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_pim_module.rst b/docs/cisco.nxos.nxos_pim_module.rst deleted file mode 100644 index e19eee567..000000000 --- a/docs/cisco.nxos.nxos_pim_module.rst +++ /dev/null @@ -1,148 +0,0 @@ -.. _cisco.nxos.nxos_pim_module: - - -******************* -cisco.nxos.nxos_pim -******************* - -**Manages configuration of a PIM instance.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages configuration of a Protocol Independent Multicast (PIM) instance. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- bfd - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Enables BFD on all PIM interfaces.
-
Dependency: ''feature bfd''
-
-
- ssm_range - -
- list - / elements=string -
- 		- Default:
[]
- 		-
Configure group ranges for Source Specific Multicast (SSM). Valid values are multicast addresses or the keyword none or keyword default. none removes all SSM group ranges. 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 default, otherwise use the default option.
-
-
- - -Notes ------ - -.. note:: - - Unsupported for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - 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 Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['ip pim bfd', 'ip pim ssm range 224.0.0.0/8']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_ping_module.rst b/docs/cisco.nxos.nxos_ping_module.rst deleted file mode 100644 index d0d805868..000000000 --- a/docs/cisco.nxos.nxos_ping_module.rst +++ /dev/null @@ -1,311 +0,0 @@ -.. _cisco.nxos.nxos_ping_module: - - -******************** -cisco.nxos.nxos_ping -******************** - -**Tests reachability using ping from Nexus switch.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Tests reachability using ping from switch to a remote destination. -- For a general purpose network module, see the :ref:`ansible.netcommon.net_ping ` module. -- For Windows targets, use the :ref:`ansible.windows.win_ping ` module instead. -- For targets running Python, use the :ref:`ansible.builtin.ping ` module instead. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- count - -
- integer -
- 		- Default:
5
- 		-
Number of packets to send.
-
-
- dest - -
- string - / required -
- 		- -
IP address or hostname (resolvable by switch) of remote node.
-
-
- df_bit - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Set the DF bit.
-
-
- size - -
- integer -
- 		- -
Size of packets to send.
-
-
- source - -
- string -
- 		- -
Source IP Address or hostname (resolvable by switch)
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Determines if the expected result is success or fail.
-
-
- vrf - -
- string -
- 		- -
Outgoing VRF.
-
-
- - -Notes ------ - -.. note:: - - Unsupported for Cisco MDS - - For a general purpose network module, see the :ref:`ansible.netcommon.net_ping ` module. - - For Windows targets, use the :ref:`ansible.windows.win_ping ` module instead. - - For targets running Python, use the :ref:`ansible.builtin.ping ` module instead. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Test reachability to 8.8.8.8 using mgmt vrf - cisco.nxos.nxos_ping: - dest: 8.8.8.8 - vrf: management - host: 68.170.147.165 - - - name: Test reachability to a few different public IPs using mgmt vrf - cisco.nxos.nxos_ping: - dest: "{{ item }}" - vrf: management - host: 68.170.147.165 - with_items: - - 8.8.8.8 - - 4.4.4.4 - - 198.6.1.4 - - - name: Test reachability to 8.8.8.8 using mgmt vrf, size and df-bit - cisco.nxos.nxos_ping: - dest: 8.8.8.8 - df_bit: true - size: 1400 - vrf: management - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
Show the command sent
-
-
Sample:
-
['ping 8.8.8.8 count 2 vrf management']
-
-
- packet_loss - -
- string -
- 		always -
Percentage of packets lost
-
-
Sample:
-
0.00%
-
-
- packets_rx - -
- integer -
- 		always -
Packets successfully received
-
-
Sample:
-
2
-
-
- packets_tx - -
- integer -
- 		always -
Packets successfully transmitted
-
-
Sample:
-
2
-
-
- rtt - -
- dictionary -
- 		always -
Show RTT stats
-
-
Sample:
-
{'avg': 6.264, 'max': 6.564, 'min': 5.978}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_prefix_lists_module.rst b/docs/cisco.nxos.nxos_prefix_lists_module.rst deleted file mode 100644 index 25f343132..000000000 --- a/docs/cisco.nxos.nxos_prefix_lists_module.rst +++ /dev/null @@ -1,1049 +0,0 @@ -.. _cisco.nxos.nxos_prefix_lists_module: - - -**************************** -cisco.nxos.nxos_prefix_lists -**************************** - -**Prefix-Lists resource module.** - - -Version added: 2.4.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages prefix-lists configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of prefix-list configuration.
-
-
- afi - -
- string -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
The Address Family Identifier (AFI) for the prefix-lists.
-
-
- prefix_lists - -
- list - / elements=dictionary -
- 		- -
List of prefix-list configurations.
-
-
- description - -
- string -
- 		- -
Description of the prefix list
-
-
- entries - -
- list - / elements=dictionary -
- 		- -
List of configurations for the specified prefix-list
-
-
- action - -
- string -
- 		-
    Choices: -
  • permit
    • -
  • deny
    • -
- 		-
Prefix-List permit or deny.
-
-
- eq - -
- integer -
- 		- -
Exact prefix length to be matched.
-
-
- ge - -
- integer -
- 		- -
Minimum prefix length to be matched.
-
-
- le - -
- integer -
- 		- -
Maximum prefix length to be matched.
-
-
- mask - -
- string -
- 		- -
Explicit match mask.
-
-
- prefix - -
- string -
- 		- -
IP or IPv6 prefix in A.B.C.D/LEN or A:B::C:D/LEN format.
-
-
- sequence - -
- integer -
- 		- -
Sequence Number.
-
-
- name - -
- string -
- 		- -
Name of the prefix-list.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^ip(.* prefix-list').
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
Refer to examples for more details.
-
With state replaced, for the listed prefix-lists, sequences that are in running-config but not in the task are negated.
-
With state overridden, all prefix-lists that are in running-config but not in the task are negated.
-
Please refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - Unsupported for Cisco MDS - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # nxos-9k-rdo# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_prefix_lists: - config: - - afi: ipv4 - prefix_lists: - - name: AllowPrefix - description: allows engineering IPv4 networks - entries: - - sequence: 10 - action: permit - prefix: 192.0.2.0/23 - eq: 24 - - sequence: 20 - action: permit - prefix: 198.51.100.128/26 - - name: DenyPrefix - description: denies lab IPv4 networks - entries: - - sequence: 20 - action: deny - prefix: 203.0.113.0/24 - le: 25 - - - afi: ipv6 - prefix_lists: - - name: AllowIPv6Prefix - description: allows engineering IPv6 networks - entries: - - sequence: 8 - action: permit - prefix: "2001:db8:400::/38" - - sequence: 20 - action: permit - prefix: "2001:db8:8000::/35" - le: 37 - - # Task output - # ------------- - # before: [] - # - # commands: - # - "ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks" - # - "ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38" - # - "ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37" - # - "ip prefix-list AllowPrefix description allows engineering IPv4 networks" - # - "ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" - # - "ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" - # - "ip prefix-list DenyPrefix description denies lab IPv4 networks" - # - "ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25" - # - # after: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - # Using replaced - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Replace prefix-lists configurations of listed prefix-lists with provided configurations - cisco.nxos.nxos_prefix_lists: - config: - - afi: ipv4 - prefix_lists: - - name: AllowPrefix - description: allows engineering IPv4 networks - entries: - - sequence: 10 - action: permit - prefix: 203.0.113.64/27 - - - sequence: 30 - action: permit - prefix: 203.0.113.96/27 - - name: AllowPrefix2Stub - description: allow other engineering IPv4 network - state: replaced - - # Task output - # ------------- - # before: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # commands: - # - "no ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" - # - "ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27" - # - "ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27" - # - "no ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" - # - "ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network" - # - # after: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 203.0.113.64/27 - # - sequence: 30 - # action: permit - # prefix: 203.0.113.96/27 - # name: AllowPrefix - # - description: allow other engineering IPv4 network - # name: AllowPrefix2Stub - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27 - # ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27 - # ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - # Using overridden - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Override all prefix-lists configuration with provided configuration - cisco.nxos.nxos_prefix_lists: &id003 - config: - - afi: ipv4 - prefix_lists: - - name: AllowPrefix - description: allows engineering IPv4 networks - entries: - - sequence: 10 - action: permit - prefix: 203.0.113.64/27 - - - sequence: 30 - action: permit - prefix: 203.0.113.96/27 - - name: AllowPrefix2Stub - description: allow other engineering IPv4 network - state: overridden - - # Task output - # ------------- - # before: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # commands: - # - "no ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" - # - "ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27" - # - "ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27" - # - "no ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" - # - "ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network" - # - "no ip prefix-list DenyPrefix" - # - "no ipv6 prefix-list AllowIPv6Prefix" - # - # after: - # - afi: ipv4 - # prefix_lists: - # - name: AllowPrefix - # description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 203.0.113.64/27 - # - # - sequence: 30 - # action: permit - # prefix: 203.0.113.96/27 - # - name: AllowPrefix2Stub - # description: allow other engineering IPv4 network - # - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27 - # ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27 - # ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network - - # Using deleted to delete a all prefix lists for an AFI - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Delete all prefix-lists for an AFI - cisco.nxos.nxos_prefix_lists: - config: - - afi: ipv4 - state: deleted - register: result - - # Task output - # ------------- - # before: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # commands: - # - "no ip prefix-list AllowPrefix" - # - "no ip prefix-list DenyPrefix" - # - # after: - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - # Using deleted to delete a single prefix-list - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Delete a single prefix-list - cisco.nxos.nxos_prefix_lists: - config: - - afi: ipv4 - prefix_lists: - - name: AllowPrefix - state: deleted - - # Task output - # ------------- - # before: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # commands: - # - "no ip prefix-list AllowPrefix" - # - # after: - # - afi: ipv4 - # prefix_lists: - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - # Using deleted to delete all prefix-lists from the device - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Delete all prefix-lists - cisco.nxos.nxos_prefix_lists: - state: deleted - - # Task output - # ------------- - # before: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # commands: - # - "no ip prefix-list AllowPrefix" - # - "no ip prefix-list DenyPrefix" - # - "no ipv6 prefix-list AllowIPv6Prefix" - # - # after: [] - # - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # nxos-9k-rdo# - - # Using rendered - - - name: Render platform specific configuration lines with state rendered (without connecting to the device) - cisco.nxos.nxos_prefix_lists: &id001 - config: - - afi: ipv4 - prefix_lists: - - name: AllowPrefix - description: allows engineering IPv4 networks - entries: - - sequence: 10 - action: permit - prefix: 192.0.2.0/23 - eq: 24 - - sequence: 20 - action: permit - prefix: 198.51.100.128/26 - - name: DenyPrefix - description: denies lab IPv4 networks - entries: - - sequence: 20 - action: deny - prefix: 203.0.113.0/24 - le: 25 - - - afi: ipv6 - prefix_lists: - - name: AllowIPv6Prefix - description: allows engineering IPv6 networks - entries: - - sequence: 8 - action: permit - prefix: "2001:db8:400::/38" - - sequence: 20 - action: permit - prefix: "2001:db8:8000::/35" - le: 37 - state: rendered - - # Task Output (redacted) - # ----------------------- - # rendered: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - - # Using parsed - - # parsed.cfg - # ------------ - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Parse externally provided prefix-lists configuration - register: result - cisco.nxos.nxos_prefix_lists: - running_config: "{{ lookup('file', './parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - - - - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_reboot_module.rst b/docs/cisco.nxos.nxos_reboot_module.rst deleted file mode 100644 index cc94a6762..000000000 --- a/docs/cisco.nxos.nxos_reboot_module.rst +++ /dev/null @@ -1,123 +0,0 @@ -.. _cisco.nxos.nxos_reboot_module: - - -********************** -cisco.nxos.nxos_reboot -********************** - -**Reboot a network device.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Reboot a network device. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- confirm - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Safeguard boolean. Set to true if you're sure you want to reboot.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Tested against Cisco MDS NX-OS 9.2(1) - - The module will fail due to timeout issues, but the reboot will be performed anyway. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_reboot: - confirm: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- rebooted - -
- boolean -
- 		success -
Whether the device was instructed to reboot.
-
-
Sample:
-
True
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_rollback_module.rst b/docs/cisco.nxos.nxos_rollback_module.rst deleted file mode 100644 index c948e093a..000000000 --- a/docs/cisco.nxos.nxos_rollback_module.rst +++ /dev/null @@ -1,159 +0,0 @@ -.. _cisco.nxos.nxos_rollback_module: - - -************************ -cisco.nxos.nxos_rollback -************************ - -**Set a checkpoint or rollback to a checkpoint.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module offers the ability to set a configuration checkpoint file or rollback to a configuration checkpoint file on Cisco NXOS switches. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- checkpoint_file - -
- string -
- 		- -
Name of checkpoint file to create. Mutually exclusive with rollback_to.
-
-
- rollback_to - -
- string -
- 		- -
Name of checkpoint file to rollback to. Mutually exclusive with checkpoint_file.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Sometimes ``transport=nxapi`` may cause a timeout error. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_rollback: - checkpoint_file: backup.cfg - username: '{{ un }}' - password: '{{ pwd }}' - host: '{{ inventory_hostname }}' - - cisco.nxos.nxos_rollback: - rollback_to: backup.cfg - username: '{{ un }}' - password: '{{ pwd }}' - host: '{{ inventory_hostname }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- filename - -
- string -
- 		success -
The filename of the checkpoint/rollback file.
-
-
Sample:
-
backup.cfg
-
-
- status - -
- string -
- 		success -
Which operation took place and whether it was successful.
-
-
Sample:
-
rollback executed
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_route_maps_module.rst b/docs/cisco.nxos.nxos_route_maps_module.rst deleted file mode 100644 index bcdf6a426..000000000 --- a/docs/cisco.nxos.nxos_route_maps_module.rst +++ /dev/null @@ -1,4368 +0,0 @@ -.. _cisco.nxos.nxos_route_maps_module: - - -************************** -cisco.nxos.nxos_route_maps -************************** - -**Route Maps resource module.** - - -Version added: 2.2.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages route maps configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of route-map configuration.
-
-
- entries - -
- list - / elements=dictionary -
- 		- -
List of entries (identified by sequence number) for this route-map.
-
-
- action - -
- string -
- 		-
    Choices: -
  • deny
    • -
  • permit
    • -
- 		-
Route map denies or permits set operations.
-
-
- continue_sequence - -
- integer -
- 		- -
Continue on a different entry within the route-map.
-
-
- description - -
- string -
- 		- -
Description of the route-map.
-
-
- match - -
- dictionary -
- 		- -
Match values from routing table.
-
-
- as_number - -
- dictionary -
- 		- -
Match BGP peer AS number.
-
-
- as_path_list - -
- list - / elements=string -
- 		- -
AS path access list name.
-
-
- asn - -
- list - / elements=string -
- 		- -
AS number.
-
-
- as_path - -
- list - / elements=string -
- 		- -
Match BGP AS path access-list.
-
-
- community - -
- dictionary -
- 		- -
Match BGP community list.
-
-
- community_list - -
- list - / elements=string -
- 		- -
Community list.
-
-
- exact_match - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do exact matching of communities.
-
-
- evpn - -
- dictionary -
- 		- -
Match BGP EVPN Routes.
-
-
- route_types - -
- list - / elements=string -
- 		- -
Match route type for evpn route.
-
-
- extcommunity - -
- dictionary -
- 		- -
Match BGP community list.
-
-
- exact_match - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do exact matching of extended communities.
-
-
- extcommunity_list - -
- list - / elements=string -
- 		- -
Extended Community list.
-
-
- interfaces - -
- list - / elements=string -
- 		- -
Match first hop interface of route.
-
-
- ip - -
- dictionary -
- 		- -
Configure IP specific information.
-
-
- address - -
- dictionary -
- 		- -
Match address of route or match packet.
-
-
- access_list - -
- string -
- 		- -
IP access-list name (for use in route-maps for PBR only).
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- multicast - -
- dictionary -
- 		- -
Match multicast attributes.
-
-
- group - -
- dictionary -
- 		- -
Multicast Group prefix.
-
Mutually exclusive with group_range.
-
-
- prefix - -
- string -
- 		- -
IPv4 group prefix.
-
-
- group_range - -
- dictionary -
- 		- -
Multicast Group address range.
-
Mutually exclusive with group.
-
-
- first - -
- string -
- 		- -
First Group address.
-
-
- last - -
- string -
- 		- -
Last Group address.
-
-
- rp - -
- dictionary -
- 		- -
Rendezvous point.
-
-
- prefix - -
- string -
- 		- -
IPv4 rendezvous prefix.
-
-
- rp_type - -
- string -
- 		-
    Choices: -
  • ASM
    • -
  • Bidir
    • -
- 		-
Multicast rendezvous point type.
-
-
- source - -
- string -
- 		- -
Multicast source address.
-
-
- next_hop - -
- dictionary -
- 		- -
Match next-hop address of route.
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- route_source - -
- dictionary -
- 		- -
Match advertising source address of route.
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- ipv6 - -
- dictionary -
- 		- -
Configure IPv6 specific information.
-
-
- address - -
- dictionary -
- 		- -
Match address of route or match packet.
-
-
- access_list - -
- string -
- 		- -
IP access-list name (for use in route-maps for PBR only).
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- multicast - -
- dictionary -
- 		- -
Match multicast attributes.
-
-
- group - -
- dictionary -
- 		- -
Multicast Group prefix.
-
Mutually exclusive with group_range.
-
-
- prefix - -
- string -
- 		- -
IPv4 group prefix.
-
-
- group_range - -
- dictionary -
- 		- -
Multicast Group address range.
-
Mutually exclusive with group.
-
-
- first - -
- string -
- 		- -
First Group address.
-
-
- last - -
- string -
- 		- -
Last Group address.
-
-
- rp - -
- dictionary -
- 		- -
Rendezvous point.
-
-
- prefix - -
- string -
- 		- -
IPv4 rendezvous prefix.
-
-
- rp_type - -
- string -
- 		-
    Choices: -
  • ASM
    • -
  • Bidir
    • -
- 		-
Multicast rendezvous point type.
-
-
- source - -
- string -
- 		- -
Multicast source address.
-
-
- next_hop - -
- dictionary -
- 		- -
Match next-hop address of route.
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- route_source - -
- dictionary -
- 		- -
Match advertising source address of route.
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- mac_list - -
- list - / elements=string -
- 		- -
Match entries of mac-lists.
-
-
- metric - -
- list - / elements=integer -
- 		- -
Match metric of route.
-
-
- ospf_area - -
- list - / elements=integer -
- 		- -
Match ospf area.
-
-
- route_types - -
- list - / elements=string -
- 		-
    Choices: -
  • external
    • -
  • inter-area
    • -
  • internal
    • -
  • intra-area
    • -
  • level-1
    • -
  • level-2
    • -
  • local
    • -
  • nssa-external
    • -
  • type-1
    • -
  • type-2
    • -
- 		-
Match route-type of route.
-
-
- source_protocol - -
- list - / elements=string -
- 		- -
Match source protocol.
-
-
- tags - -
- list - / elements=integer -
- 		- -
Match tag of route.
-
-
- sequence - -
- integer -
- 		- -
Sequence to insert to/delete from existing route-map entry.
-
-
- set - -
- dictionary -
- 		- -
Set values in destination routing protocol.
-
-
- as_path - -
- dictionary -
- 		- -
Prepend string for a BGP AS-path attribute.
-
-
- prepend - -
- dictionary -
- 		- -
Prepend to the AS-Path.
-
-
- as_number - -
- list - / elements=string -
- 		- -
AS number.
-
-
- last_as - -
- integer -
- 		- -
Number of last-AS prepends.
-
-
- tag - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set the tag as an AS-path attribute.
-
-
- comm_list - -
- string -
- 		- -
Set BGP community list (for deletion).
-
-
- community - -
- dictionary -
- 		- -
Set BGP community attribute.
-
-
- additive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Add to existing community.
-
-
- graceful_shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Graceful Shutdown (well-known community).
-
-
- internet - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Internet (well-known community).
-
-
- local_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send outside local AS (well-known community).
-
-
- no_advertise - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not advertise to any peer (well-known community).
-
-
- no_export - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not export to next AS (well-known community).
-
-
- number - -
- list - / elements=string -
- 		- -
Community number aa:nn format
-
-
- dampening - -
- dictionary -
- 		- -
Set BGP route flap dampening parameters.
-
-
- half_life - -
- integer -
- 		- -
Half-life time for the penalty.
-
-
- max_suppress_time - -
- integer -
- 		- -
Maximum suppress time for stable route.
-
-
- start_reuse_route - -
- integer -
- 		- -
Value to start reusing a route.
-
-
- start_suppress_route - -
- integer -
- 		- -
Value to start suppressing a route.
-
-
- distance - -
- dictionary -
- 		- -
Configure administrative distance.
-
-
- igp_ebgp_routes - -
- integer -
- 		- -
Administrative distance for IGP or EBGP routes
-
-
- internal_routes - -
- integer -
- 		- -
Distance for internal routes.
-
-
- local_routes - -
- integer -
- 		- -
Distance for local routes.
-
-
- evpn - -
- dictionary -
- 		- -
Set BGP EVPN Routes.
-
-
- gateway_ip - -
- dictionary -
- 		- -
Set gateway IP for type 5 EVPN routes.
-
Cannot set ip and use-nexthop in the same route-map sequence.
-
-
- ip - -
- string -
- 		- -
Gateway IP address.
-
-
- use_nexthop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use nexthop address as gateway IP.
-
-
- extcomm_list - -
- string -
- 		- -
Set BGP extcommunity list (for deletion).
-
-
- extcommunity - -
- dictionary -
- 		- -
Set BGP extcommunity attribute.
-
-
- rt - -
- dictionary -
- 		- -
Route-Target.
-
-
- additive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Add to existing rt extcommunity.
-
-
- extcommunity_numbers - -
- list - / elements=string -
- 		- -
Extcommunity number.
-
Supported formats are ASN2:NN, ASN4:NN, IPV4:NN.
-
-
- forwarding_address - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set the forwarding address.
-
-
- ip - -
- dictionary -
- 		- -
Configure IP features.
-
-
- address - -
- dictionary -
- 		- -
Specify IP address.
-
-
- prefix_list - -
- string -
- 		- -
Name of prefix list (Max Size 63).
-
-
- next_hop - -
- dictionary -
- 		- -
Set next-hop IP address (for policy-based routing)
-
-
- address - -
- string -
- 		- -
Set space-separated list of next-hop IP addresses. Address ordering is important. Also don`t use unnecessary spaces.
-
-
- drop_on_fail - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Drop packets instead of using default routing when the configured next hop becomes unreachable
-
-
- force_order - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Enable next-hop ordering as specified in the address parameter.
-
-
- load_share - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Enable traffic load balancing across a maximum of 32 next-hop addresses
-
-
- peer_address - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
BGP prefix next hop is set to the local address of the peer.
-
If no next hop is set in the route map, the next hop is set to the one stored in the path.
-
-
- redist_unchanged - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set for next-hop address conservation for non-local generated routes.
-
Used with redistribute command. Available to maintain BGP routing compliant with RFC 4271 on Nexus OS.
-
-
- unchanged - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set for next-hop address conservation in eBGP outgoing updates
-
-
- verify_availability - -
- list - / elements=dictionary -
- 		- -
Set next-hop ip address tracking with IP SLA
-
-
- address - -
- string - / required -
- 		- -
Set one next-hop address
-
-
- drop_on_fail - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Drop packets instead of using default routing when the configured next hop becomes unreachable
-
-
- force_order - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Enable next-hop ordering as specified in the address parameter.
-
-
- load_share - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Enable traffic load balancing across a maximum of 32 next-hop addresses
-
-
- track - -
- integer - / required -
- 		- -
Set track number
-
-
- precedence - -
- string -
- 		- -
Set precedence field.
-
-
- ipv6 - -
- dictionary -
- 		- -
Configure IPv6 features.
-
-
- address - -
- dictionary -
- 		- -
Specify IP address.
-
-
- prefix_list - -
- string -
- 		- -
Name of prefix list (Max Size 63).
-
-
- precedence - -
- string -
- 		- -
Set precedence field.
-
-
- label_index - -
- integer -
- 		- -
Set Segment Routing (SR) label index of route.
-
-
- level - -
- string -
- 		-
    Choices: -
  • level-1
    • -
  • level-1-2
    • -
  • level-2
    • -
- 		-
Where to import route.
-
-
- local_preference - -
- integer -
- 		- -
BGP local preference path attribute.
-
-
- metric - -
- dictionary -
- 		- -
Set metric for destination routing protocol.
-
-
- bandwidth - -
- integer -
- 		- -
Metric value or Bandwidth in Kbits per second (Max Size 11).
-
-
- igrp_delay_metric - -
- integer -
- 		- -
IGRP delay metric.
-
-
- igrp_effective_bandwidth_metric - -
- integer -
- 		- -
IGRP Effective bandwidth metric (Loading) 255 is 100%.
-
-
- igrp_mtu - -
- integer -
- 		- -
IGRP MTU of the path.
-
-
- igrp_reliability_metric - -
- integer -
- 		- -
IGRP reliability metric where 255 is 100 percent reliable.
-
-
- metric_type - -
- string -
- 		-
    Choices: -
  • external
    • -
  • internal
    • -
  • type-1
    • -
  • type-2
    • -
- 		-
Type of metric for destination routing protocol.
-
-
- nssa_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
OSPF NSSA Areas.
-
-
- null_interface - -
- string -
- 		- -
Output Null interface.
-
-
- origin - -
- string -
- 		-
    Choices: -
  • egp
    • -
  • igp
    • -
  • incomplete
    • -
- 		-
BGP origin code.
-
-
- path_selection - -
- string -
- 		-
    Choices: -
  • all
    • -
  • backup
    • -
  • best2
    • -
  • multipaths
    • -
- 		-
Path selection criteria for BGP.
-
-
- tag - -
- integer -
- 		- -
Tag value for destination routing protocol.
-
-
- weight - -
- integer -
- 		- -
BGP weight for routing table.
-
-
- route_map - -
- string -
- 		- -
Route-map name.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^route-map'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
With state replaced, for the listed route-maps, sequences that are in running-config but not in the task are negated.
-
With state overridden, all route-maps that are in running-config but not in the task are negated.
-
Please refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - Unsupported for Cisco MDS - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k-rdo# show running-config | section "^route-map" - # nxos-9k-rdo# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_route_maps: - config: - - route_map: rmap1 - entries: - - sequence: 10 - action: permit - description: rmap1-10-permit - match: - ip: - address: - access_list: acl_1 - as_path: Allow40 - as_number: - asn: 65564 - - - sequence: 20 - action: deny - description: rmap1-20-deny - match: - community: - community_list: - - BGPCommunity1 - - BGPCommunity2 - ip: - address: - prefix_lists: - - AllowPrefix1 - - AllowPrefix2 - set: - dampening: - half_life: 30 - start_reuse_route: 1500 - start_suppress_route: 10000 - max_suppress_time: 120 - - - route_map: rmap2 - entries: - - sequence: 20 - action: permit - description: rmap2-20-permit - continue_sequence: 40 - match: - ipv6: - address: - prefix_lists: AllowIPv6Prefix - interfaces: "{{ nxos_int1 }}" - set: - as_path: - prepend: - as_number: - - 65563 - - 65568 - - 65569 - comm_list: BGPCommunity - - - sequence: 40 - action: deny - description: rmap2-40-deny - match: - route_types: - - level-1 - - level-2 - tags: 2 - ip: - multicast: - rp: - prefix: 192.0.2.0/24 - rp_type: ASM - source: 203.0.113.0/24 - group_range: - first: 239.0.0.1 - last: 239.255.255.255 - - - route_map: rmap3 - entries: - - sequence: 10 - description: "*** first stanza ***" - action: permit - set: - ip: - next_hop: - verify_availability: - - address: 3.3.3.3 - track: 1 - - address: 4.4.4.4 - track: 3 - - - sequence: 20 - description: "*** second stanza ***" - action: permit - set: - ip: - next_hop: - address: 6.6.6.6 2.2.2.2 - load_share: true - drop_on_fail: true - - - sequence: 30 - description: "*** third stanza ***" - action: permit - set: - ip: - next_hop: - peer_address: true - - - sequence: 40 - description: "*** fourth stanza ***" - action: permit - set: - ip: - next_hop: - unchanged: true - redist_unchanged: true - state: merged - - # Task output - # ------------- - # before: [] - # - # commands: - # - "route-map rmap1 permit 10" - # - "match as-number 65564" - # - "match as-path Allow40" - # - "match ip address acl_1" - # - "description rmap1-10-permit" - # - "route-map rmap1 deny 20" - # - "match community BGPCommunity1 BGPCommunity2" - # - "match ip address prefix-list AllowPrefix1 AllowPrefix2" - # - "description rmap1-20-deny" - # - "set dampening 30 1500 10000 120" - # - "route-map rmap2 permit 20" - # - "match interface Ethernet1/1" - # - "match ipv6 address prefix-list AllowIPv6Prefix" - # - "set as-path prepend 65563 65568 65569" - # - "description rmap2-20-permit" - # - "continue 40" - # - "set comm-list BGPCommunity delete" - # - "route-map rmap2 deny 40" - # - "match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM" - # - "match route-type level-1 level-2" - # - "match tag 2" - # - "description rmap2-40-deny" - # - "route-map rmap3 permit 10" - # - "description *** first stanza ***" - # - "set ip next-hop verify-availability 3.3.3.3 track 1" - # - "set ip next-hop verify-availability 4.4.4.4 track 3" - # - "route-map rmap3 permit 20" - # - "description *** second stanza ***" - # - "set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail" - # - "route-map rmap3 permit 30" - # - "description *** third stanza ***" - # - "set ip next-hop peer-address" - # - "route-map rmap3 permit 40" - # - "description *** fourth stanza ***" - # - "set ip next-hop unchanged" - # - "set ip next-hop redist-unchanged" - # - # after: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # - route_map: rmap3 - # entries: - # - sequence: 10 - # description: "*** first stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # verify_availability: - # - address: 3.3.3.3 - # track: 1 - # - address: 4.4.4.4 - # track: 3 - # - # - sequence: 20 - # description: "*** second stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # address: 6.6.6.6 2.2.2.2 - # load_share: true - # drop_on_fail: true - # - # - sequence: 30 - # description: "*** third stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # peer_address: true - # - # - sequence: 40 - # description: "*** fourth stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # unchanged: true - # redist_unchanged: true - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - # route-map rmap3 permit 10 - # description *** first stanza *** - # set ip next-hop verify-availability 3.3.3.3 track 1 - # set ip next-hop verify-availability 4.4.4.4 track 3 - # route-map rmap3 permit 20 - # description *** second stanza *** - # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail - # route-map rmap3 permit 30 - # description *** third stanza *** - # set ip next-hop peer-address - # route-map rmap3 permit 40 - # description *** fourth stanza *** - # set ip next-hop unchanged - # set ip next-hop redist-unchanged - # - # Using replaced - # (for the listed route-map(s), sequences that are in running-config but not in the task are negated) - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - # route-map rmap3 permit 10 - # description *** first stanza *** - # set ip next-hop verify-availability 3.3.3.3 track 1 - # set ip next-hop verify-availability 4.4.4.4 track 3 - # route-map rmap3 permit 20 - # description *** second stanza *** - # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail - # route-map rmap3 permit 30 - # description *** third stanza *** - # set ip next-hop peer-address - # route-map rmap3 permit 40 - # description *** fourth stanza *** - # set ip next-hop unchanged - # set ip next-hop redist-unchanged - # - - name: Replace route-maps configurations of listed route-maps with provided configurations - cisco.nxos.nxos_route_maps: - config: - - route_map: rmap1 - entries: - - sequence: 20 - action: deny - description: rmap1-20-deny - match: - community: - community_list: - - BGPCommunity4 - - BGPCommunity5 - ip: - address: - prefix_lists: - - AllowPrefix1 - set: - community: - local_as: true - - - route_map: rmap3 - entries: - - sequence: 10 - description: "*** first stanza ***" - action: permit - set: - ip: - next_hop: - verify_availability: - - address: 3.3.3.3 - track: 1 - - sequence: 20 - description: "*** second stanza ***" - action: permit - set: - ip: - next_hop: - peer_address: true - - sequence: 30 - description: "*** third stanza ***" - action: permit - set: - ip: - next_hop: - address: 6.6.6.6 2.2.2.2 - load_share: true - drop_on_fail: true - state: replaced - - # Task output - # ------------- - # before: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # - route_map: rmap3 - # entries: - # - sequence: 10 - # description: "*** first stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # verify_availability: - # - address: 3.3.3.3 - # track: 1 - # - address: 4.4.4.4 - # track: 3 - # - # - sequence: 20 - # description: "*** second stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # address: 6.6.6.6 2.2.2.2 - # load_share: true - # drop_on_fail: true - # - # - sequence: 30 - # description: "*** third stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # peer_address: true - # - # - sequence: 40 - # description: "*** fourth stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # unchanged: true - # redist_unchanged: true - # - # commands: - # - no route-map rmap1 permit 10 - # - route-map rmap1 deny 20 - # - no match community BGPCommunity1 BGPCommunity2 - # - match community BGPCommunity4 BGPCommunity5 - # - no match ip address prefix-list AllowPrefix1 AllowPrefix2 - # - match ip address prefix-list AllowPrefix1 - # - no set dampening 30 1500 10000 120 - # - set community local-AS - # - route-map rmap3 permit 10 - # - no set ip next-hop verify-availability 4.4.4.4 track 3 - # - route-map rmap3 permit 20 - # - no set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail - # - set ip next-hop peer-address - # - route-map rmap3 permit 30 - # - no set ip next-hop peer-address - # - set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail - # - no route-map rmap3 permit 40 - # - # after: - # - route_map: rmap1 - # entries: - # - sequence: 20 - # action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity4 - # - BGPCommunity5 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # set: - # community: - # local_as: true - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # - route_map: rmap3 - # entries: - # - sequence: 10 - # description: "*** first stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # verify_availability: - # - address: 3.3.3.3 - # track: 1 - # - sequence: 20 - # description: "*** second stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # peer_address: true - # - sequence: 30 - # description: "*** third stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # address: 6.6.6.6 2.2.2.2 - # load_share: true - # drop_on_fail: true - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 deny 20 - # description rmap1-20-deny - # match community BGPCommunity4 BGPCommunity5 - # match ip address prefix-list AllowPrefix1 - # set community local-AS - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - # route-map rmap3 permit 10 - # description *** first stanza *** - # set ip next-hop verify-availability 3.3.3.3 track 1 - # route-map rmap3 permit 20 - # description *** second stanza *** - # set ip next-hop peer-address - # route-map rmap3 permit 30 - # description *** third stanza *** - # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail - - # Using overridden - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - - - name: Override all route-maps configuration with provided configuration - cisco.nxos.nxos_route_maps: - config: - - route_map: rmap1 - entries: - - sequence: 20 - action: deny - description: rmap1-20-deny - match: - community: - community_list: - - BGPCommunity4 - - BGPCommunity5 - ip: - address: - prefix_lists: - - AllowPrefix1 - set: - community: - local_as: true - state: overridden - - # Task output - # ------------- - # before: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # commands: - # - no route-map rmap1 permit 10 - # - route-map rmap1 deny 20 - # - no match community BGPCommunity1 BGPCommunity2 - # - match community BGPCommunity4 BGPCommunity5 - # - no match ip address prefix-list AllowPrefix1 AllowPrefix2 - # - match ip address prefix-list AllowPrefix1 - # - no set dampening 30 1500 10000 120 - # - set community local-AS - # - no route-map rmap2 permit 20 - # - no route-map rmap2 deny 40 - # - # after: - # - route_map: rmap1 - # entries: - # - sequence: 20 - # action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity4 - # - BGPCommunity5 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # set: - # community: - # local_as: true - # - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^route-map" - # route-map rmap1 deny 20 - # description rmap1-20-deny - # match community BGPCommunity4 BGPCommunity5 - # match ip address prefix-list AllowPrefix1 - # set community local-AS - - # Using deleted to delete a single route-map - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - - - name: Delete single route-map - cisco.nxos.nxos_route_maps: - config: - - route_map: rmap1 - state: deleted - - # Task output - # ------------- - # before: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # commands: - # - no route-map rmap1 permit 10 - # - no route-map rmap1 deny 20 - # - # after: - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^route-map" - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - - # Using deleted to delete all route-maps from the device running-config - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - - - name: Delete all route-maps - cisco.nxos.nxos_route_maps: - state: deleted - - # Task output - # ------------- - # before: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # commands: - # - no route-map rmap1 permit 10 - # - no route-map rmap1 deny 20 - # - no route-map rmap2 permit 20 - # - no route-map rmap2 deny 40 - # - # after: [] - # - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^route-map" - - - name: Render platform specific configuration lines with state rendered (without connecting to the device) - cisco.nxos.nxos_route_maps: - config: - - route_map: rmap1 - entries: - - sequence: 10 - action: permit - description: rmap1-10-permit - match: - ip: - address: - access_list: acl_1 - as_path: Allow40 - as_number: - asn: 65564 - - - sequence: 20 - action: deny - description: rmap1-20-deny - match: - community: - community_list: - - BGPCommunity1 - - BGPCommunity2 - ip: - address: - prefix_lists: - - AllowPrefix1 - - AllowPrefix2 - set: - dampening: - half_life: 30 - start_reuse_route: 1500 - start_suppress_route: 10000 - max_suppress_time: 120 - - - route_map: rmap2 - entries: - - sequence: 20 - action: permit - description: rmap2-20-permit - continue_sequence: 40 - match: - ipv6: - address: - prefix_lists: AllowIPv6Prefix - interfaces: "{{ nxos_int1 }}" - set: - as_path: - prepend: - as_number: - - 65563 - - 65568 - - 65569 - comm_list: BGPCommunity - - - sequence: 40 - action: deny - description: rmap2-40-deny - match: - route_types: - - level-1 - - level-2 - tags: 2 - ip: - multicast: - rp: - prefix: 192.0.2.0/24 - rp_type: ASM - source: 203.0.113.0/24 - group_range: - first: 239.0.0.1 - last: 239.255.255.255 - state: rendered - - # Task Output (redacted) - # ----------------------- - # rendered: - # - "route-map rmap1 permit 10" - # - "match as-number 65564" - # - "match as-path Allow40" - # - "match ip address acl_1" - # - "description rmap1-10-permit" - # - "route-map rmap1 deny 20" - # - "match community BGPCommunity1 BGPCommunity2" - # - "match ip address prefix-list AllowPrefix1 AllowPrefix2" - # - "description rmap1-20-deny" - # - "set dampening 30 1500 10000 120" - # - "route-map rmap2 permit 20" - # - "match interface Ethernet1/1" - # - "match ipv6 address prefix-list AllowIPv6Prefix" - # - "set as-path prepend 65563 65568 65569" - # - "description rmap2-20-permit" - # - "continue 40" - # - "set comm-list BGPCommunity delete" - # - "route-map rmap2 deny 40" - # - "match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM" - # - "match route-type level-1 level-2" - # - "match tag 2" - # - "description rmap2-40-deny" - - # Using parsed - - # parsed.cfg - # ------------ - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - - - name: Parse externally provided route-maps configuration - cisco.nxos.nxos_route_maps: - running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - - # Using gathered - - # Existing route-map config - # --------------------------- - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - - - name: Gather route-maps facts using gathered - cisco.nxos.nxos_route_maps: - state: gathered - - # gathered: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['route-map rmap1 permit 10', 'match as-number 65564', 'match as-path Allow40', 'match ip address acl_1', 'description rmap1-10-permit', 'route-map rmap1 deny 20', 'match community BGPCommunity1 BGPCommunity2']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_rpm_module.rst b/docs/cisco.nxos.nxos_rpm_module.rst deleted file mode 100644 index 79d616a59..000000000 --- a/docs/cisco.nxos.nxos_rpm_module.rst +++ /dev/null @@ -1,226 +0,0 @@ -.. _cisco.nxos.nxos_rpm_module: - - -******************* -cisco.nxos.nxos_rpm -******************* - -**Install patch or feature rpms on Cisco NX-OS devices.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Install software maintenance upgrade (smu) RPMS and 3rd party RPMS on Cisco NX-OS devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
List of RPM/patch definitions.
-
-
- file_system - -
- string -
- 		- -
The remote file system of the device. If omitted, devices that support a file_system parameter will use their default values.
-
-
- pkg - -
- string - / required -
- 		- -
Name of the RPM package.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
- 		-
If the state is present, the rpm will be installed, If the state is absent, it will be removed.
-
-
- file_system - -
- string -
- 		- Default:
"bootflash"
- 		-
The remote file system of the device. If omitted, devices that support a file_system parameter will use their default values.
-
-
- pkg - -
- string -
- 		- -
Name of the RPM package.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
If the state is present, the rpm will be installed, If the state is absent, it will be removed.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.0(3)I2(5), 7.0(3)I4(6), 7.0(3)I5(3), 7.0(3)I6(1), 7.0(3)I7(3) - - Unsupported for Cisco MDS - - For patches, the minimum platform version needed is 7.0(3)I2(5) - - For feature rpms, the minimum platform version needed is 7.0(3)I6(1) - - The module manages the entire RPM lifecycle (Add, activate, commit, deactivate, remove) - - For reload patches, this module is NOT idempotent until the patch is committed. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_rpm: - pkg: nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000.rpm - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['install add bootflash:nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000.rpm forced', 'install activate nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000 forced', 'install commit nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Sai Chintalapudi (@saichint) diff --git a/docs/cisco.nxos.nxos_snapshot_module.rst b/docs/cisco.nxos.nxos_snapshot_module.rst deleted file mode 100644 index fe89b5b7b..000000000 --- a/docs/cisco.nxos.nxos_snapshot_module.rst +++ /dev/null @@ -1,363 +0,0 @@ -.. _cisco.nxos.nxos_snapshot_module: - - -************************ -cisco.nxos.nxos_snapshot -************************ - -**Manage snapshots of the running states of selected features.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Create snapshots of the running states of selected features, add new show commands for snapshot creation, delete and compare existing snapshots. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- action - -
- string - / required -
- 		-
    Choices: -
  • add
    • -
  • compare
    • -
  • create
    • -
  • delete
    • -
  • delete_all
    • -
- 		-
Define what snapshot action the module would perform.
-
-
- compare_option - -
- string -
- 		-
    Choices: -
  • summary
    • -
  • ipv4routes
    • -
  • ipv6routes
    • -
- 		-
Snapshot options to be used when action=compare.
-
-
- comparison_results_file - -
- string -
- 		- -
Name of the file where snapshots comparison will be stored when action=compare.
-
-
- description - -
- string -
- 		- -
Snapshot description to be used when action=create.
-
-
- element_key1 - -
- string -
- 		- -
Specify the tags used to distinguish among row entries, to be used when action=add.
-
-
- element_key2 - -
- string -
- 		- -
Specify the tags used to distinguish among row entries, to be used when action=add.
-
-
- path - -
- string -
- 		- Default:
"./"
- 		-
Specify the path of the file where new created snapshot or snapshots comparison will be stored, to be used when action=create and save_snapshot_locally=true or action=compare.
-
-
- row_id - -
- string -
- 		- -
Specifies the tag of each row entry of the show command's XML output, to be used when action=add.
-
-
- save_snapshot_locally - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Specify to locally store a new created snapshot, to be used when action=create.
-
-
- section - -
- string -
- 		- -
Used to name the show command output, to be used when action=add.
-
-
- show_command - -
- string -
- 		- -
Specify a new show command, to be used when action=add.
-
-
- snapshot1 - -
- string -
- 		- -
First snapshot to be used when action=compare.
-
-
- snapshot2 - -
- string -
- 		- -
Second snapshot to be used when action=compare.
-
-
- snapshot_name - -
- string -
- 		- -
Snapshot name, to be used when action=create or action=delete.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - ``transport=cli`` may cause timeout errors. - - The ``element_key1`` and ``element_key2`` parameter specify the tags used to distinguish among row entries. In most cases, only the element_key1 parameter needs to specified to be able to distinguish among row entries. - - ``action=compare`` will always store a comparison report on a local file. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Create a snapshot and store it locally - - cisco.nxos.nxos_snapshot: - action: create - snapshot_name: test_snapshot - description: Done with Ansible - save_snapshot_locally: true - path: /home/user/snapshots/ - - # Delete a snapshot - - cisco.nxos.nxos_snapshot: - action: delete - snapshot_name: test_snapshot - - # Delete all existing snapshots - - cisco.nxos.nxos_snapshot: - action: delete_all - - # Add a show command for snapshots creation - - cisco.nxos.nxos_snapshot: - section: myshow - show_command: show ip interface brief - row_id: ROW_intf - element_key1: intf-name - - # Compare two snapshots - - cisco.nxos.nxos_snapshot: - action: compare - snapshot1: pre_snapshot - snapshot2: post_snapshot - comparison_results_file: compare_snapshots.txt - compare_option: summary - path: ../snapshot_reports/ - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		verbose mode -
commands sent to the device
-
-
Sample:
-
['snapshot create post_snapshot Post-snapshot']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_community_module.rst b/docs/cisco.nxos.nxos_snmp_community_module.rst deleted file mode 100644 index 584d2d772..000000000 --- a/docs/cisco.nxos.nxos_snmp_community_module.rst +++ /dev/null @@ -1,201 +0,0 @@ -.. _cisco.nxos.nxos_snmp_community_module: - - -****************************** -cisco.nxos.nxos_snmp_community -****************************** - -**(deprecated, removed after 2024-01-01) Manages SNMP community configs.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated modules released with more functionality -:Alternative: nxos_snmp_server - - - -Synopsis --------- -- Manages SNMP community configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- access - -
- string -
- 		-
    Choices: -
  • ro
    • -
  • rw
    • -
- 		-
Access type for community.
-
-
- acl - -
- string -
- 		- -
ACL name to filter snmp requests or keyword 'default'.
-
-
- community - -
- string - / required -
- 		- -
Case-sensitive community string.
-
-
- group - -
- string -
- 		- -
Group to which the community belongs.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure snmp community is configured - - cisco.nxos.nxos_snmp_community: - community: TESTING7 - group: network-operator - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['snmp-server community TESTING7 group network-operator']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_host_module.rst b/docs/cisco.nxos.nxos_snmp_host_module.rst deleted file mode 100644 index 8aef0b21d..000000000 --- a/docs/cisco.nxos.nxos_snmp_host_module.rst +++ /dev/null @@ -1,288 +0,0 @@ -.. _cisco.nxos.nxos_snmp_host_module: - - -************************* -cisco.nxos.nxos_snmp_host -************************* - -**(deprecated, removed after 2024-01-01) Manages SNMP host configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated modules released with more functionality -:Alternative: nxos_snmp_server - - - -Synopsis --------- -- Manages SNMP host configuration parameters. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- community - -
- string -
- 		- -
Community string or v3 username.
-
-
- snmp_host - -
- string - / required -
- 		- -
IP address of hostname of target host.
-
-
- snmp_type - -
- string -
- 		-
    Choices: -
  • trap
    • -
  • inform
    • -
- 		-
type of message to send to host. If this is not specified, trap type is used.
-
-
- src_intf - -
- string -
- 		- -
Source interface. Must be fully qualified interface name. If state = absent, the interface is removed.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource. If state = present, the host is added to the configuration. If only vrf and/or vrf_filter and/or src_intf are given, they will be added to the existing host configuration. If state = absent, the host is removed if community parameter is given. It is possible to remove only vrf and/or src_int and/or vrf_filter by providing only those parameters and no community parameter.
-
-
- udp - -
- string -
- 		- Default:
"162"
- 		-
UDP port number (0-65535).
-
-
- v3 - -
- string -
- 		-
    Choices: -
  • noauth
    • -
  • auth
    • -
  • priv
    • -
- 		-
Use this when verion is v3. SNMPv3 Security level.
-
-
- version - -
- string -
- 		-
    Choices: -
  • v1
    • -
  • v2c
    • -
  • v3
    • -
- 		-
SNMP version. If this is not specified, v1 is used.
-
-
- vrf - -
- string -
- 		- -
VRF to use to source traffic to source. If state = absent, the vrf is removed.
-
-
- vrf_filter - -
- string -
- 		- -
Name of VRF to filter. If state = absent, the vrf is removed from the filter.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - ``state=absent`` removes the host configuration if it is configured. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure snmp host is configured - - cisco.nxos.nxos_snmp_host: - snmp_host: 192.0.2.3 - community: TESTING - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['snmp-server host 192.0.2.3 filter-vrf another_test_vrf']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_location_module.rst b/docs/cisco.nxos.nxos_snmp_location_module.rst deleted file mode 100644 index 06f564693..000000000 --- a/docs/cisco.nxos.nxos_snmp_location_module.rst +++ /dev/null @@ -1,156 +0,0 @@ -.. _cisco.nxos.nxos_snmp_location_module: - - -***************************** -cisco.nxos.nxos_snmp_location -***************************** - -**(deprecated, removed after 2024-01-01) Manages SNMP location information.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated modules released with more functionality -:Alternative: nxos_snmp_server - - - -Synopsis --------- -- Manages SNMP location configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- location - -
- string - / required -
- 		- -
Location information.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure snmp location is configured - - cisco.nxos.nxos_snmp_location: - location: Test - state: present - - # ensure snmp location is not configured - - cisco.nxos.nxos_snmp_location: - location: Test - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['snmp-server location New_Test']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_server_module.rst b/docs/cisco.nxos.nxos_snmp_server_module.rst deleted file mode 100644 index 126e16341..000000000 --- a/docs/cisco.nxos.nxos_snmp_server_module.rst +++ /dev/null @@ -1,4474 +0,0 @@ -.. _cisco.nxos.nxos_snmp_server_module: - - -*************************** -cisco.nxos.nxos_snmp_server -*************************** - -**SNMP Server resource module.** - - -Version added: 2.8.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages SNMP server configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A dict of SNMP server configuration
-
-
- aaa_user - -
- dictionary -
- 		- -
Set duration for which aaa-cached snmp user exists.
-
-
- cache_timeout - -
- integer -
- 		- -
Timeout for which aaa-cached user exists(in secs).
-
-
- communities - -
- list - / elements=dictionary -
- 		- -
Set community string and access privs.
-
-
- group - -
- string -
- 		- -
Group to which the community belongs.
-
-
- name - -
- string -
- 		- -
SNMP community string (Max Size 32).
-

aliases: community
-
-
- ro - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Read-only access with this community string.
-
-
- rw - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Read-write access with this community string.
-
-
- use_ipv4acl - -
- string -
- 		- -
Specify IPv4 ACL, the ACL name specified must be IPv4 ACL.
-
This option is unsupported on MDS switches.
-
-
- use_ipv6acl - -
- string -
- 		- -
Specify IPv6 ACL, the ACL name specified after must be IPv6 ACL.
-
This option is unsupported on MDS switches.
-
-
- contact - -
- string -
- 		- -
Modify sysContact.
-
-
- context - -
- dictionary -
- 		- -
SNMP context to be mapped.
-
-
- instance - -
- string -
- 		- -
Name of the protocol instance (Max Size 32).
-
-
- name - -
- string -
- 		- -
Name of the SNMP context (Max Size 32).
-
-
- topology - -
- string -
- 		- -
Topology associated with the SNMP context.
-
-
- vrf - -
- string -
- 		- -
VRF associated with the SNMP context.
-
This option is unsupported on MDS switches.
-
-
- counter - -
- dictionary -
- 		- -
Configure port counter configuration.
-
This option is unsupported on MDS switches.
-
-
- cache - -
- dictionary -
- 		- -
Port stats cache.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable port stats cache.
-
-
- timeout - -
- integer -
- 		- -
Timeout for which cached port stats exists(in secs).
-
-
- drop - -
- dictionary -
- 		- -
Silently drop unknown v3 user packets.
-
This option is unsupported on MDS switches.
-
-
- unknown_engine_id - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Unknown v3 engine id.
-
-
- unknown_user - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Unknown v3 user.
-
-
- engine_id - -
- dictionary -
- 		- -
Configure a local SNMPv3 engineID.
-
This option is unsupported on MDS switches.
-
-
- local - -
- string -
- 		- -
EngineID of the local agent.
-
-
- global_enforce_priv - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Globally enforce privacy for all the users.
-
-
- hosts - -
- list - / elements=dictionary -
- 		- -
Specify hosts to receive SNMP notifications.
-
SNMP hosts config lines that appear separately in running-config must be added as individual dictionaries.
-
-
- auth - -
- string -
- 		- -
Use the SNMPv3 authNoPriv Security Level.
-
-
- community - -
- string -
- 		- -
SNMP community string or SNMPv3 user name (Max Size 32).
-
-
- filter_vrf - -
- string -
- 		- -
Filters notifications to the notification host receiver based on the configured VRF.
-
This option is unsupported on MDS switches.
-
-
- host - -
- string -
- 		- -
IPv4 or IPv6 address or DNS Name of SNMP notification host.
-
-
- informs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Inform messages to this host.
-
-
- priv - -
- string -
- 		- -
Use the SNMPv3 authPriv Security Level.
-
-
- source_interface - -
- string -
- 		- -
Source interface to be used for sending out SNMP notifications to this host.
-
-
- traps - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Traps messages to this host.
-
-
- udp_port - -
- integer -
- 		- -
The notification host's UDP port number.
-
-
- use_vrf - -
- string -
- 		- -
Configures SNMP to use the selected VRF to communicate with the host receiver.
-
This option is unsupported on MDS switches.
-
-
- version - -
- string -
- 		-
    Choices: -
  • 1
    • -
  • 2c
    • -
  • 3
    • -
- 		-
SNMP version to use for notification messages.
-
-
- location - -
- string -
- 		- -
Modify sysLocation.
-
-
- mib - -
- dictionary -
- 		- -
Mib access parameters.
-
-
- community_map - -
- dictionary -
- 		- -
SNMP community.
-
-
- community - -
- string -
- 		- -
SNMP community string (Max Size 32).
-
-
- context - -
- string -
- 		- -
Name of the SNMP context (Max Size 32).
-
-
- packetsize - -
- integer -
- 		- -
Largest SNMP packet size
-
-
- protocol - -
- dictionary -
- 		- -
Snmp protocol operations.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable snmp protocol operations.
-
-
- source_interface - -
- dictionary -
- 		- -
Source interface to be used for sending out SNMP notifications.
-
This option is unsupported on MDS switches.
-
-
- informs - -
- string -
- 		- -
SNMP Inform notifications for which this source interface needs to be used.
-
-
- traps - -
- string -
- 		- -
SNMP Trap notifications for which this source interface needs to be used.
-
-
- system_shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure snmp-server for reload(2).
-
-
- tcp_session - -
- dictionary -
- 		- -
Enable one time authentication for snmp over tcp session.
-
-
- auth - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable one time authentication for snmp over tcp session.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable tcp-session.
-
This option is unsupported on MDS switches.
-
-
- traps - -
- dictionary -
- 		- -
Enable SNMP Traps
-
-
- aaa - -
- dictionary -
- 		- -
AAA traps
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable AAA traps.
-
-
- server_state_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
AAA server state change notification.
-
-
- bgp - -
- dictionary -
- 		- -
SNMP BGP traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP BGP traps.
-
-
- bridge - -
- dictionary -
- 		- -
Bridge traps.
-
This option is unsupported on MDS switches.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable bridge traps.
-
-
- newroot - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP STP Bridge MIB newroot traps.
-
-
- topologychange - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP STP Bridge MIB topologychange traps.
-
-
- callhome - -
- dictionary -
- 		- -
Callhome traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable callhome traps.
-
This option is unsupported on MDS switches.
-
-
- event_notify - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Callhome External Event Notification.
-
-
- smtp_send_fail - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
SMTP Message Send Fail notification.
-
-
- cfs - -
- dictionary -
- 		- -
CFS traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable cfs traps.
-
This option is unsupported on MDS switches.
-
-
- merge_failure - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Merge failure notification.
-
-
- state_change_notif - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
State change notification.
-
-
- config - -
- dictionary -
- 		- -
Config traps.
-
-
- ccmCLIRunningConfigChanged - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Running config change trap.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable config traps.
-
This option is unsupported on MDS switches.
-
-
- entity - -
- dictionary -
- 		- -
Entity traps.
-
-
- cefcMIBEnableStatusNotification - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
CefcMIBEnableStatusNotification.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable entity traps.
-
-
- entity_fan_status_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Fan Status Change.
-
-
- entity_mib_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity MIB change.
-
-
- entity_module_inserted - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Module Inserted.
-
-
- entity_module_removed - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Module Removed.
-
-
- entity_module_status_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Module Status Change.
-
-
- entity_power_out_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Power Out Change.
-
-
- entity_power_status_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Power Status Change.
-
-
- entity_sensor - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity sensor.
-
-
- entity_unrecognised_module - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Unrecognised Module.
-
-
- feature_control - -
- dictionary -
- 		- -
Feature-Control traps.
-
-
- ciscoFeatOpStatusChange - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Feature operation status change Notification.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable feature-control traps.
-
This option is unsupported on MDS switches.
-
-
- featureOpStatusChange - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Feature operation status change notification.
-
-
- generic - -
- dictionary -
- 		- -
Generic traps.
-
-
- coldStart - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Generic coldStart trap.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable generic traps.
-
This option is unsupported on MDS switches.
-
-
- warmStart - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Generic warmStart trap.
-
-
- license - -
- dictionary -
- 		- -
License traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable license traps.
-
This option is unsupported on MDS switches.
-
-
- notify_license_expiry - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
License Expiry Notification.
-
-
- notify_license_expiry_warning - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
License Expiry Warning Notification.
-
-
- notify_licensefile_missing - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
License File Missing Notification.
-
-
- notify_no_license_for_feature - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
No License installed for feature Notification.
-
-
- link - -
- dictionary -
- 		- -
Link traps.
-
-
- cErrDisableInterfaceEventRev1 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Err-disable state notification.
-
This option is unsupported on MDS switches.
-
-
- cieLinkDown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Cisco extended link state down notification.
-
-
- cieLinkUp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Cisco extended link state up notification.
-
-
- cisco_xcvr_mon_status_chg - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Cisco interface transceiver monitor status change notification.
-
-
- cmn_mac_move_notification - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Mac addr move trap.
-
This option is unsupported on MDS switches.
-
-
- delayed_link_state_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Delayed link state change.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable link traps.
-
This option is unsupported on MDS switches.
-
-
- extended_linkDown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IETF extended link state down notification.
-
-
- extended_linkUp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IETF extended link state up notification.
-
-
- linkDown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IETF Link state down notification.
-
-
- linkUp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IETF Link state up notification.
-
-
- mmode - -
- dictionary -
- 		- -
MMode traps.
-
This option is unsupported on MDS switches.
-
-
- cseMaintModeChangeNotify - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Maint Mode Change Notification.
-
-
- cseNormalModeChangeNotify - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Normal Mode Change Notification.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable mmode traps.
-
-
- ospf - -
- dictionary -
- 		- -
SNMP OSPF traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP OSPF traps.
-
-
- ospfv3 - -
- dictionary -
- 		- -
SNMP OSPFv3 traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP OSPFv3 traps.
-
-
- rf - -
- dictionary -
- 		- -
RF traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable rf traps.
-
This option is unsupported on MDS switches.
-
-
- redundancy_framework - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Redundancy_Framework (RF) Sup switchover MIB.
-
-
- rmon - -
- dictionary -
- 		- -
RMON traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable rmon traps.
-
This option is unsupported on MDS switches.
-
-
- fallingAlarm - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Rmon falling alarm.
-
-
- hcFallingAlarm - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
High capacity Rmon falling alarm.
-
-
- hcRisingAlarm - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
High capacity Rmon rising alarm.
-
-
- risingAlarm - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Rmon rising alarm.
-
-
- snmp - -
- dictionary -
- 		- -
SNMP traps.
-
-
- authentication - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
SNMP authentication trap.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable snmp traps.
-
This option is unsupported on MDS switches.
-
-
- storm_control - -
- dictionary -
- 		- -
Storm-Control traps.
-
-
- cpscEventRev1 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Port-Storm-Control-Event.
-
This option is unsupported on MDS switches.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable storm-control traps.
-
This option is unsupported on MDS switches.
-
-
- trap_rate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Number of traps per minute.
-
-
- stpx - -
- dictionary -
- 		- -
Stpx traps.
-
This option is unsupported on MDS switches.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable stpx traps.
-
-
- inconsistency - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP STPX MIB InconsistencyUpdate traps.
-
-
- loop_inconsistency - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP STPX MIB LoopInconsistencyUpdate traps.
-
-
- root_inconsistency - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP STPX MIB RootInconsistencyUpdate traps.
-
-
- syslog - -
- dictionary -
- 		- -
Enable syslog traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable syslog traps.
-
This option is unsupported on MDS switches.
-
-
- message_generated - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Message Generated Notification.
-
-
- sysmgr - -
- dictionary -
- 		- -
Sysmgr traps.
-
-
- cseFailSwCoreNotifyExtended - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Software Core Notification.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable sysmgr traps.
-
This option is unsupported on MDS switches.
-
-
- system - -
- dictionary -
- 		- -
System traps.
-
-
- clock_change_notification - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Clock-change-notification traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable system traps.
-
This option is unsupported on MDS switches.
-
-
- upgrade - -
- dictionary -
- 		- -
Upgrade traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable upgrade traps.
-
This option is unsupported on MDS switches.
-
-
- upgradeJobStatusNotify - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Upgrade Job Status Notification.
-
-
- upgradeOpNotifyOnCompletion - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Upgrade Global Status Notification.
-
-
- vtp - -
- dictionary -
- 		- -
VTP traps.
-
This option is unsupported on MDS switches.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable VTP traps.
-
-
- notifs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable vtpConfigRevNumberError vtpConfigDigestEnable vtpConfigRevNumberError vtpConfigDigestError vtpServerDisabled vtpVersionOneDeviceDetected vlanTrunkPortDynamicStatusChange vtpLocalModeChanged vtpVersionInUseChanged notification.
-
-
- vlancreate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable vtpVlanCreated notification.
-
-
- vlandelete - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable vtpVlanDeleted notification.
-
-
- users - -
- dictionary -
- 		- -
Define users who can access the SNMP engine.
-
-
- auth - -
- list - / elements=dictionary -
- 		- -
SNMP User authentication related settings
-
-
- authentication - -
- dictionary -
- 		- -
Authentication parameters for the user.
-
-
- algorithm - -
- string -
- 		-
    Choices: -
  • md5
    • -
  • sha
    • -
  • sha-256
    • -
- 		-
Select algorithm for authentication.
-
-
- engine_id - -
- string -
- 		- -
EngineID for configuring notif target user (for V3 informs).
-
This value needs to be enclosed in quotes in the task.
-
-
- localized_key - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specifies whether the passwords are in localized key format.
-
-
- localizedv2_key - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specifies whether the passwords are in localized V2 key format.
-
-
- password - -
- string -
- 		- -
Authentication password for user (Max Size 127).
-
If this value is localized, it has to be enclosed in quotes in the task.
-
-
- priv - -
- dictionary -
- 		- -
Encryption parameters for the user.
-
-
- aes_128 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use 128-bit AES algorithm for privacy.
-
-
- privacy_password - -
- string -
- 		- -
Privacy password for user (Max Size 130).
-
If this value is localized, it has to be enclosed in quotes in the task.
-
-
- group - -
- string -
- 		- -
Group name (ignored for notif target user) (Max Size 28).
-
-
- user - -
- string -
- 		- -
Name of the user (Max Size 28).
-
-
- use_acls - -
- list - / elements=dictionary -
- 		- -
Set IPv4 and IPv6 ACL to use.
-
-
- ipv4 - -
- string -
- 		- -
Specify IPv4 ACL, the ACL name specified after must be IPv4 ACL.
-
-
- ipv6 - -
- string -
- 		- -
Specify IPv6 ACL, the ACL name specified after must be IPv6 ACL.
-
-
- user - -
- string -
- 		- -
Name of the user (Max Size 28).
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^snmp-server'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
The states replaced and overridden have identical behaviour for this module.
-
Please refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6 on Cisco Nexus Switches. - - This module works with connection ``network_cli`` and ``httpapi``. - - Tested against Cisco MDS NX-OS 9.2(2) with connection ``network_cli``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_snmp_server: - config: - aaa_user: - cache_timeout: 36000 - communities: - - community: public - group: network-operator - - community: private - group: network-admin - contact: nxosswitchadmin@localhost - location: serverroom-1 - traps: - aaa: - server_state_change: true - system: - clock_change_notification: true - hosts: - - host: 192.0.2.1 - traps: true - version: '1' - community: public - - host: 192.0.2.1 - source_interface: Ethernet1/1 - - host: 192.0.2.2 - informs: true - version: '3' - auth: NMS - users: - auth: - - user: snmp_user_1 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - - user: snmp_user_2 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - priv: - privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' - aes_128: true - use_acls: - - user: snmp_user_1 - ipv4: acl1 - ipv6: acl2 - - user: snmp_user_2 - ipv4: acl3 - ipv6: acl4 - - # Task output - # ------------- - # before: - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # - # commands: - # - snmp-server contact nxosswitchadmin@localhost - # - snmp-server location serverroom-1 - # - snmp-server aaa-user cache-timeout 36000 - # - snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # - snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # - snmp-server host 192.0.2.1 traps version 1 public - # - snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # - snmp-server host 192.0.2.2 informs version 3 auth NMS - # - snmp-server community private group network-admin - # - snmp-server community public group network-operator - # - snmp-server enable traps aaa server-state-change - # - snmp-server enable traps system Clock-change-notification - # - # after: - # aaa_user: - # cache_timeout: 36000 - # communities: - # - community: private - # group: network-admin - # - community: public - # group: network-operator - # contact: nxosswitchadmin@localhost - # location: serverroom-1 - # traps: - # aaa: - # server_state_change: true - # system: - # clock_change_notification: true - # hosts: - # - host: 192.0.2.1 - # traps: true - # version: "1" - # community: public - # - # - host: 192.0.2.1 - # source_interface: Ethernet1/1 - # - # - host: 192.0.2.2 - # informs: true - # version: "3" - # auth: NMS - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # - # - user: snmp_user_1 - # group: network-operator - # authentication: - # algorithm: md5 - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # localized_key: true - # - # - authentication: - # algorithm: md5 - # localized_key: true - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # priv: - # aes_128: true - # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" - # group: network-operator - # user: snmp_user_2 - # - # use_acls: - # - user: snmp_user_1 - # ipv4: acl1 - # ipv6: acl2 - # - user: snmp_user_2 - # ipv4: acl3 - # ipv6: acl4 - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server contact nxosswitchadmin@localhost - # snmp-server location serverroom-1 - # snmp-server aaa-user cache-timeout 36000 - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # snmp-server host 192.0.2.1 traps version 1 public - # snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # snmp-server host 192.0.2.2 informs version 3 auth NMS - # snmp-server community private group network-admin - # snmp-server community public group network-operator - # snmp-server enable traps aaa server-state-change - # snmp-server enable traps system Clock-change-notification - - # Using replaced - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server contact nxosswitchadmin@localhost - # snmp-server location serverroom-1 - # snmp-server aaa-user cache-timeout 36000 - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # snmp-server host 192.0.2.1 traps version 1 public - # snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # snmp-server host 192.0.2.2 informs version 3 auth NMS - # snmp-server community private group network-admin - # snmp-server community public group network-operator - # snmp-server enable traps aaa server-state-change - # snmp-server enable traps system Clock-change-notification - - - name: Replace snmp-server configurations of listed snmp-server with provided configurations - cisco.nxos.nxos_snmp_server: - config: - aaa_user: - cache_timeout: 36000 - communities: - - community: public - group: network-operator - - community: secret - group: network-operator - contact: nxosswitchadmin2@localhost - location: serverroom-2 - traps: - aaa: - server_state_change: true - hosts: - - host: 192.0.2.1 - traps: true - version: '1' - community: public - - host: 192.0.2.1 - source_interface: Ethernet1/1 - - host: 192.0.3.2 - informs: true - version: '3' - auth: NMS - users: - auth: - - user: admin - group: network-admin - authentication: - algorithm: md5 - password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - localized_key: true - priv: - privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - - - user: snmp_user_1 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - - - user: snmp_user_2 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - priv: - privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' - aes_128: true - use_acls: - - user: snmp_user_1 - ipv4: acl1 - ipv6: acl2 - state: replaced - - # Task output - # ------------- - # before: - # aaa_user: - # cache_timeout: 36000 - # communities: - # - community: private - # group: network-admin - # - community: public - # group: network-operator - # contact: nxosswitchadmin@localhost - # location: serverroom-1 - # traps: - # aaa: - # server_state_change: true - # system: - # clock_change_notification: true - # hosts: - # - host: 192.0.2.1 - # traps: true - # version: "1" - # community: public - # - # - host: 192.0.2.1 - # source_interface: Ethernet1/1 - # - # - host: 192.0.2.2 - # informs: true - # version: "3" - # auth: NMS - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # - # - user: snmp_user_1 - # group: network-operator - # authentication: - # algorithm: md5 - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # localized_key: true - # - # - authentication: - # algorithm: md5 - # localized_key: true - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # priv: - # aes_128: true - # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" - # group: network-operator - # user: snmp_user_2 - # - # use_acls: - # - user: snmp_user_1 - # ipv4: acl1 - # ipv6: acl2 - # - user: snmp_user_2 - # ipv4: acl3 - # ipv6: acl4 - # - # commands: - # - snmp-server contact nxosswitchadmin2@localhost - # - no snmp-server enable traps system Clock-change-notification - # - snmp-server location serverroom-2 - # - no snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # - no snmp-server host 192.0.2.2 informs version 3 auth NMS - # - snmp-server host 192.0.3.2 informs version 3 auth NMS - # - no snmp-server community private group network-admin - # - snmp-server community secret group network-operator - # - # after: - # aaa_user: - # cache_timeout: 36000 - # communities: - # - community: public - # group: network-operator - # - community: secret - # group: network-operator - # contact: nxosswitchadmin2@localhost - # location: serverroom-2 - # traps: - # aaa: - # server_state_change: true - # hosts: - # - host: 192.0.2.1 - # traps: true - # version: '1' - # community: public - # - host: 192.0.2.1 - # source_interface: Ethernet1/1 - # - host: 192.0.3.2 - # informs: true - # version: '3' - # auth: NMS - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # - # - user: snmp_user_1 - # group: network-operator - # authentication: - # algorithm: md5 - # password: '0x5632724fb8ac3699296af26281e1d0f1' - # localized_key: true - # - # - user: snmp_user_2 - # group: network-operator - # authentication: - # algorithm: md5 - # password: '0x5632724fb8ac3699296af26281e1d0f1' - # localized_key: true - # priv: - # privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' - # aes_128: true - # - # use_acls: - # - user: snmp_user_1 - # ipv4: acl1 - # ipv6: acl2 - # - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server contact nxosswitchadmin2@localhost - # snmp-server location serverroom-2 - # snmp-server aaa-user cache-timeout 36000 - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # snmp-server host 192.0.2.1 traps version 1 public - # snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # snmp-server host 192.0.2.2 informs version 3 auth NMS - # snmp-server community secret group network-operator - # snmp-server community public group network-operator - # snmp-server enable traps aaa server-state-change - # snmp-server enable traps system Clock-change-notification - - # Using deleted - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server contact nxosswitchadmin@localhost - # snmp-server location serverroom-1 - # snmp-server aaa-user cache-timeout 36000 - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # snmp-server host 192.0.2.1 traps version 1 public - # snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # snmp-server host 192.0.2.2 informs version 3 auth NMS - # snmp-server community private group network-admin - # snmp-server community public group network-operator - # snmp-server enable traps aaa server-state-change - # snmp-server enable traps system Clock-change-notification - - - name: Delete SNMP Server configurations from the device (admin user will not be deleted) - cisco.nxos.nxos_snmp_server: - state: deleted - - # Task output - # ------------- - # before: - # aaa_user: - # cache_timeout: 36000 - # communities: - # - community: private - # group: network-admin - # - community: public - # group: network-operator - # contact: nxosswitchadmin@localhost - # location: serverroom-1 - # traps: - # aaa: - # server_state_change: true - # system: - # clock_change_notification: true - # hosts: - # - host: 192.0.2.1 - # traps: true - # version: "1" - # community: public - # - # - host: 192.0.2.1 - # source_interface: Ethernet1/1 - # - # - host: 192.0.2.2 - # informs: true - # version: "3" - # auth: NMS - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # - # - user: snmp_user_1 - # group: network-operator - # authentication: - # algorithm: md5 - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # localized_key: true - # - # - authentication: - # algorithm: md5 - # localized_key: true - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # priv: - # aes_128: true - # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" - # group: network-operator - # user: snmp_user_2 - # - # use_acls: - # - user: snmp_user_1 - # ipv4: acl1 - # ipv6: acl2 - # - user: snmp_user_2 - # ipv4: acl3 - # ipv6: acl4 - # - # commands: - # - no snmp-server contact nxosswitchadmin@localhost - # - no snmp-server location serverroom-1 - # - no snmp-server aaa-user cache-timeout 36000 - # - no snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - # - no snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - no snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - no snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # - no snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # - no snmp-server host 192.0.2.1 traps version 1 public - # - no snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # - no snmp-server host 192.0.2.2 informs version 3 auth NMS - # - no snmp-server community private group network-admin - # - no snmp-server community public group network-operator - # - no snmp-server enable traps aaa server-state-change - # - no snmp-server enable traps system Clock-change-notification - # - # after: - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - - # Using rendered - # --------------- - - - name: Render platform specific configuration lines with state rendered (without connecting to the device) - cisco.nxos.nxos_snmp_server: - config: - aaa_user: - cache_timeout: 36000 - communities: - - community: public - group: network-operator - - community: private - group: network-admin - contact: nxosswitchadmin@localhost - location: serverroom-1 - traps: - aaa: - server_state_change: true - system: - clock_change_notification: true - hosts: - - host: 192.0.2.1 - traps: true - version: '1' - community: public - - host: 192.0.2.1 - source_interface: Ethernet1/1 - - host: 192.0.2.2 - informs: true - version: '3' - auth: NMS - users: - auth: - - user: snmp_user_1 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - - user: snmp_user_2 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - priv: - privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' - aes_128: true - use_acls: - - user: snmp_user_1 - ipv4: acl1 - ipv6: acl2 - - user: snmp_user_2 - ipv4: acl3 - ipv6: acl4 - state: rendered - - - # Task Output (redacted) - # ----------------------- - # rendered: - # - snmp-server contact nxosswitchadmin@localhost - # - snmp-server location serverroom-1 - # - snmp-server aaa-user cache-timeout 36000 - # - snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # - snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # - snmp-server host 192.0.2.1 traps version 1 public - # - snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # - snmp-server host 192.0.2.2 informs version 3 auth NMS - # - snmp-server community private group network-admin - # - snmp-server community public group network-operator - # - snmp-server enable traps aaa server-state-change - # - snmp-server enable traps system Clock-change-notification - - # Using parsed - - # parsed.cfg - # ------------ - # snmp-server contact nxosswitchadmin@localhost - # snmp-server location serverroom-1 - # snmp-server aaa-user cache-timeout 36000 - # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # snmp-server host 192.0.2.1 traps version 1 public - # snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # snmp-server host 192.0.2.2 informs version 3 auth NMS - # snmp-server community private group network-admin - # snmp-server community public group network-operator - # snmp-server enable traps aaa server-state-change - # snmp-server enable traps system Clock-change-notification - - - name: Parse externally provided snmp-server configuration - cisco.nxos.nxos_snmp_server: - running_config: "{{ lookup('file', './parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # aaa_user: - # cache_timeout: 36000 - # communities: - # - community: private - # group: network-admin - # - community: public - # group: network-operator - # contact: nxosswitchadmin@localhost - # location: serverroom-1 - # traps: - # aaa: - # server_state_change: true - # system: - # clock_change_notification: true - # hosts: - # - host: 192.0.2.1 - # traps: true - # version: "1" - # community: public - # - # - host: 192.0.2.1 - # source_interface: Ethernet1/1 - # - # - host: 192.0.2.2 - # informs: true - # version: "3" - # auth: NMS - # users: - # auth: - # - user: snmp_user_1 - # group: network-operator - # authentication: - # algorithm: md5 - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # localized_key: true - # - # - authentication: - # algorithm: md5 - # localized_key: true - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # priv: - # aes_128: true - # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" - # group: network-operator - # user: snmp_user_2 - # - # use_acls: - # - user: snmp_user_1 - # ipv4: acl1 - # ipv6: acl2 - # - user: snmp_user_2 - # ipv4: acl3 - # ipv6: acl4 - # - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['sample command 1', 'sample command 2', 'sample command 3']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['sample command 1', 'sample command 2', 'sample command 3']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_snmp_traps_module.rst b/docs/cisco.nxos.nxos_snmp_traps_module.rst deleted file mode 100644 index 726a4d5fe..000000000 --- a/docs/cisco.nxos.nxos_snmp_traps_module.rst +++ /dev/null @@ -1,189 +0,0 @@ -.. _cisco.nxos.nxos_snmp_traps_module: - - -************************** -cisco.nxos.nxos_snmp_traps -************************** - -**(deprecated, removed after 2024-01-01) Manages SNMP traps.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated modules released with more functionality -:Alternative: nxos_snmp_server - - - -Synopsis --------- -- Manages SNMP traps configurations. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- group - -
- string - / required -
- 		-
    Choices: -
  • aaa
    • -
  • bfd
    • -
  • bgp
    • -
  • bridge
    • -
  • callhome
    • -
  • cfs
    • -
  • config
    • -
  • eigrp
    • -
  • entity
    • -
  • feature-control
    • -
  • generic
    • -
  • hsrp
    • -
  • license
    • -
  • link
    • -
  • lldp
    • -
  • mmode
    • -
  • ospf
    • -
  • pim
    • -
  • rf
    • -
  • rmon
    • -
  • snmp
    • -
  • storm-control
    • -
  • stpx
    • -
  • switchfabric
    • -
  • syslog
    • -
  • sysmgr
    • -
  • system
    • -
  • upgrade
    • -
  • vtp
    • -
  • all
    • -
- 		-
Case sensitive group.
-
-
- state - -
- string -
- 		-
    Choices: -
  • enabled ←
    • -
  • disabled
    • -
- 		-
Manage the state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - This module works at the group level for traps. If you need to only enable/disable 1 specific trap within a group, use the :ref:`cisco.nxos.nxos_command ` module. - - Be aware that you can set a trap only for an enabled feature. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure lldp trap configured - - cisco.nxos.nxos_snmp_traps: - group: lldp - state: enabled - - # ensure lldp trap is not configured - - cisco.nxos.nxos_snmp_traps: - group: lldp - state: disabled - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
snmp-server enable traps lldp ;
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_snmp_user_module.rst b/docs/cisco.nxos.nxos_snmp_user_module.rst deleted file mode 100644 index 2d3f6f26c..000000000 --- a/docs/cisco.nxos.nxos_snmp_user_module.rst +++ /dev/null @@ -1,235 +0,0 @@ -.. _cisco.nxos.nxos_snmp_user_module: - - -************************* -cisco.nxos.nxos_snmp_user -************************* - -**(deprecated, removed after 2024-01-01) Manages SNMP users for monitoring.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated modules released with more functionality -:Alternative: nxos_snmp_server - - - -Synopsis --------- -- Manages SNMP user configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- authentication - -
- string -
- 		-
    Choices: -
  • md5
    • -
  • sha
    • -
- 		-
Authentication parameters for the user.
-
-
- encrypt - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables AES-128 bit encryption when using privacy password.
-
-
- group - -
- string -
- 		- -
Group to which the user will belong to. If state = present, and the user is existing, the group is added to the user. If the user is not existing, user entry is created with this group argument. If state = absent, only the group is removed from the user entry. However, to maintain backward compatibility, if the existing user belongs to only one group, and if group argument is same as the existing user's group, then the user entry also is deleted.
-
-
- privacy - -
- string -
- 		- -
Privacy password for the user. This is not idempotent
-
-
- pwd - -
- string -
- 		- -
Authentication password when using md5 or sha. This is not idempotent
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- user - -
- string - / required -
- 		- -
Name of the user.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - Authentication parameters not idempotent. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_snmp_user: - user: ntc - group: network-operator - authentication: md5 - pwd: test_password - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['snmp-server user ntc network-operator auth md5 test_password']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_udld_interface_module.rst b/docs/cisco.nxos.nxos_udld_interface_module.rst deleted file mode 100644 index cba2733c0..000000000 --- a/docs/cisco.nxos.nxos_udld_interface_module.rst +++ /dev/null @@ -1,250 +0,0 @@ -.. _cisco.nxos.nxos_udld_interface_module: - - -****************************** -cisco.nxos.nxos_udld_interface -****************************** - -**Manages UDLD interface configuration params.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages UDLD interface configuration params. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- interface - -
- string - / required -
- 		- -
FULL name of the interface, i.e. Ethernet1/1-
-
-
- mode - -
- string - / required -
- 		-
    Choices: -
  • enabled
    • -
  • disabled
    • -
  • aggressive
    • -
- 		-
Manages UDLD mode for an interface.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Feature UDLD must be enabled on the device to use this module. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure Ethernet1/1 is configured to be in aggressive mode - - cisco.nxos.nxos_udld_interface: - interface: Ethernet1/1 - mode: aggressive - state: present - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - # Remove the aggressive config only if it's currently in aggressive mode and then disable udld (switch default) - - cisco.nxos.nxos_udld_interface: - interface: Ethernet1/1 - mode: aggressive - state: absent - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - # ensure Ethernet1/1 has aggressive mode enabled - - cisco.nxos.nxos_udld_interface: - interface: Ethernet1/1 - mode: enabled - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- end_state - -
- dictionary -
- 		always -
k/v pairs of configuration after module execution
-
-
Sample:
-
{'mode': 'enabled'}
-
-
- existing - -
- dictionary -
- 		always -
k/v pairs of existing configuration
-
-
Sample:
-
{'mode': 'aggressive'}
-
-
- proposed - -
- dictionary -
- 		always -
k/v pairs of parameters passed into module
-
-
Sample:
-
{'mode': 'enabled'}
-
-
- updates - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['interface ethernet1/33', 'no udld aggressive ; no udld disable']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_udld_module.rst b/docs/cisco.nxos.nxos_udld_module.rst deleted file mode 100644 index dc461bc89..000000000 --- a/docs/cisco.nxos.nxos_udld_module.rst +++ /dev/null @@ -1,256 +0,0 @@ -.. _cisco.nxos.nxos_udld_module: - - -******************** -cisco.nxos.nxos_udld -******************** - -**Manages UDLD global configuration params.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages UDLD global configuration params. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggressive - -
- string -
- 		-
    Choices: -
  • enabled
    • -
  • disabled
    • -
- 		-
Toggles aggressive mode.
-
-
- msg_time - -
- string -
- 		- -
Message time in seconds for UDLD packets or keyword 'default'.
-
-
- reset - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ability to reset all ports shut down by UDLD. 'state' parameter cannot be 'absent' when this is present.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource. When set to 'absent', aggressive and msg_time are set to their default values.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Module will fail if the udld feature has not been previously enabled. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure udld aggressive mode is globally disabled and se global message interval is 20 - - cisco.nxos.nxos_udld: - aggressive: disabled - msg_time: 20 - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - # Ensure agg mode is globally enabled and msg time is 15 - - cisco.nxos.nxos_udld: - aggressive: enabled - msg_time: 15 - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- end_state - -
- dictionary -
- 		always -
k/v pairs of udld configuration after module execution
-
-
Sample:
-
{'aggressive': 'enabled', 'msg_time': '40'}
-
-
- existing - -
- dictionary -
- 		always -
k/v pairs of existing udld configuration
-
-
Sample:
-
{'aggressive': 'disabled', 'msg_time': '15'}
-
-
- proposed - -
- dictionary -
- 		always -
k/v pairs of parameters passed into module
-
-
Sample:
-
{'aggressive': 'enabled', 'msg_time': '40'}
-
-
- updates - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['udld message-time 40', 'udld aggressive']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_user_module.rst b/docs/cisco.nxos.nxos_user_module.rst deleted file mode 100644 index a03a23a03..000000000 --- a/docs/cisco.nxos.nxos_user_module.rst +++ /dev/null @@ -1,390 +0,0 @@ -.. _cisco.nxos.nxos_user_module: - - -******************** -cisco.nxos.nxos_user -******************** - -**Manage the collection of local users on Nexus devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module provides declarative management of the local usernames configured on Cisco Nexus devices. It allows playbooks to manage either individual usernames or the collection of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
The set of username objects to be configured on the remote Cisco Nexus device. The list entries can either be the username or a hash of username and properties. This argument is mutually exclusive with the name argument.
-

aliases: users, collection
-
-
- configured_password - -
- string -
- 		- -
The password to be configured on the network device. The password needs to be provided in cleartext and it will be encrypted on the device.
-
-
- hashed_password - -
- string -
- 		- -
The hashed password to be configured on the network device. The password needs to already be encrypted.
-
-
- name - -
- string -
- 		- -
The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
-
-
- roles - -
- list - / elements=string -
- 		- -
The role argument configures the role for the username in the device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device.
-

aliases: role
-
-
- sshkey - -
- string -
- 		- -
The sshkey argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
- 		-
The state argument configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
-
-
- update_password - -
- string -
- 		-
    Choices: -
  • on_create
    • -
  • always
    • -
- 		-
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
-
-
- configured_password - -
- string -
- 		- -
The password to be configured on the network device. The password needs to be provided in cleartext and it will be encrypted on the device.
-
-
- hashed_password - -
- string -
- 		- -
The hashed password to be configured on the network device. The password needs to already be encrypted.
-
-
- name - -
- string -
- 		- -
The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
-
-
- purge - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
The purge argument instructs the module to consider the resource definition absolute. It will remove any previously configured usernames on the device with the exception of the `admin` user which cannot be deleted per nxos constraints.
-
-
- roles - -
- list - / elements=string -
- 		- -
The role argument configures the role for the username in the device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device.
-

aliases: role
-
-
- sshkey - -
- string -
- 		- -
The sshkey argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
The state argument configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
-
-
- update_password - -
- string -
- 		-
    Choices: -
  • on_create
    • -
  • always ←
    • -
- 		-
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
-
-
- - -Notes ------ - -.. note:: - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: create a new user - cisco.nxos.nxos_user: - name: ansible - sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}" - state: present - - - name: remove all users except admin - cisco.nxos.nxos_user: - purge: true - - - name: set multiple users role - cisco.nxos.nxos_user: - aggregate: - - name: netop - - name: netend - role: network-operator - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['name ansible', 'name ansible password password']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_vpc_module.rst b/docs/cisco.nxos.nxos_vpc_module.rst deleted file mode 100644 index 9e0ca3c29..000000000 --- a/docs/cisco.nxos.nxos_vpc_module.rst +++ /dev/null @@ -1,352 +0,0 @@ -.. _cisco.nxos.nxos_vpc_module: - - -******************* -cisco.nxos.nxos_vpc -******************* - -**Manages global VPC configuration** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages global VPC configuration - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- auto_recovery - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/Disables auto recovery on platforms that support disable
-
timers are not modifiable with this attribute
-
mutually exclusive with auto_recovery_reload_delay
-
-
- auto_recovery_reload_delay - -
- string -
- 		- -
Manages auto-recovery reload-delay timer in seconds
-
mutually exclusive with auto_recovery
-
-
- delay_restore - -
- string -
- 		- -
manages delay restore command and config value in seconds
-
-
- delay_restore_interface_vlan - -
- string -
- 		- -
manages delay restore interface-vlan command and config value in seconds
-
not supported on all platforms
-
-
- delay_restore_orphan_port - -
- string -
- 		- -
manages delay restore orphan-port command and config value in seconds
-
not supported on all platforms
-
-
- domain - -
- string - / required -
- 		- -
VPC domain
-
-
- peer_gw - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/Disables peer gateway
-
-
- pkl_dest - -
- string -
- 		- -
Destination (remote) IP address used for peer keepalive link
-
pkl_dest is required whenever pkl options are used.
-
-
- pkl_src - -
- string -
- 		- -
Source IP address used for peer keepalive link
-
-
- pkl_vrf - -
- string -
- 		- -
VRF used for peer keepalive link
-
The VRF must exist on the device before using pkl_vrf.
-
(Note) 'default' is an overloaded term: Default vrf context for pkl_vrf is 'management'; 'pkl_vrf: default' refers to the literal 'default' rib.
-
-
- role_priority - -
- string -
- 		- -
Role priority for device. Remember lower is better.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manages desired state of the resource
-
-
- system_priority - -
- string -
- 		- -
System priority device. Remember they must match between peers.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - The feature vpc must be enabled before this module can be used - - If not using management vrf, vrf must be globally on the device before using in the pkl config - - Although source IP isn't required on the command line it is required when using this module. The PKL VRF must also be configured prior to using this module. - - Both pkl_src and pkl_dest are needed when changing PKL VRF. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: configure a simple asn - cisco.nxos.nxos_vpc: - domain: 100 - role_priority: 1000 - system_priority: 2000 - pkl_dest: 192.168.100.4 - pkl_src: 10.1.100.20 - peer_gw: true - auto_recovery: true - - - name: configure - cisco.nxos.nxos_vpc: - domain: 100 - role_priority: 32667 - system_priority: 2000 - peer_gw: true - pkl_src: 10.1.100.2 - pkl_dest: 192.168.100.4 - auto_recovery: true - - - name: Configure VPC with delay restore and existing keepalive VRF - cisco.nxos.nxos_vpc: - domain: 10 - role_priority: 28672 - system_priority: 2000 - delay_restore: 180 - peer_gw: true - pkl_src: 1.1.1.2 - pkl_dest: 1.1.1.1 - pkl_vrf: vpckeepalive - auto_recovery: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['vpc domain 100', 'peer-keepalive destination 192.168.100.4 source 10.1.100.20 vrf management', 'auto-recovery', 'peer-gateway']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vrf_af_module.rst b/docs/cisco.nxos.nxos_vrf_af_module.rst deleted file mode 100644 index 236991587..000000000 --- a/docs/cisco.nxos.nxos_vrf_af_module.rst +++ /dev/null @@ -1,300 +0,0 @@ -.. _cisco.nxos.nxos_vrf_af_module: - - -********************** -cisco.nxos.nxos_vrf_af -********************** - -**Manages VRF AF.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages VRF AF - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
Address-Family Identifier (AFI).
-
-
- route_target_both_auto_evpn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable the EVPN route-target 'auto' setting for both import and export target communities.
-
-
- route_targets - -
- list - / elements=dictionary -
- 		- -
Specify the route-targets which should be imported and/or exported under the AF. This argument accepts a list of dicts that specify the route-target, the direction (import|export|both) and state of each route-target. Default direction is direction=both. See examples.
-
-
- direction - -
- string -
- 		-
    Choices: -
  • import
    • -
  • export
    • -
  • both ←
    • -
- 		-
Indicates the direction of the route-target (import|export|both)
-
-
- rt - -
- string - / required -
- 		- -
Defines the route-target itself
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Determines whether the route-target with the given direction should be present or not on the device.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Determines whether the config should be present or not on the device.
-
-
- vrf - -
- string - / required -
- 		- -
Name of the VRF.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Default, where supported, restores params default value. - - In case of ``state=absent`` the address-family configuration will be absent. Therefore the options ``route_target_both_auto_evpn`` and ``route_targets`` are ignored. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_target_both_auto_evpn: true - state: present - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_targets: - - rt: '65000:1000' - direction: import - - rt: '65001:1000' - direction: import - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_targets: - - rt: '65000:1000' - direction: import - - rt: '65001:1000' - state: absent - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_targets: - - rt: '65000:1000' - direction: export - - rt: '65001:1000' - direction: export - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_targets: - - rt: '65000:1000' - direction: export - state: absent - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_targets: - - rt: '65000:1000' - direction: both - state: present - - rt: '65001:1000' - direction: import - state: present - - rt: '65002:1000' - direction: both - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['vrf context ntc', 'address-family ipv4 unicast']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vrf_module.rst b/docs/cisco.nxos.nxos_vrf_module.rst deleted file mode 100644 index 6765f78b5..000000000 --- a/docs/cisco.nxos.nxos_vrf_module.rst +++ /dev/null @@ -1,494 +0,0 @@ -.. _cisco.nxos.nxos_vrf_module: - - -******************* -cisco.nxos.nxos_vrf -******************* - -**Manages global VRF configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module provides declarative management of VRFs on CISCO NXOS network devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- admin_state - -
- string -
- 		-
    Choices: -
  • up ←
    • -
  • down
    • -
- 		-
Administrative state of the VRF.
-
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
List of VRFs definitions.
-
-
- admin_state - -
- string -
- 		-
    Choices: -
  • up
    • -
  • down
    • -
- 		-
Administrative state of the VRF.
-
-
- associated_interfaces - -
- list - / elements=string -
- 		- -
This is a intent option and checks the operational state of the for given vrf name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vrf interfaces on device it will result in failure.
-
-
- delay - -
- integer -
- 		- -
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
-
-
- description - -
- string -
- 		- -
Description of the VRF or keyword 'default'.
-
-
- interfaces - -
- list - / elements=string -
- 		- -
List of interfaces to check the VRF has been configured correctly or keyword 'default'.
-
-
- name - -
- string -
- 		- -
Name of VRF to be managed.
-

aliases: vrf
-
-
- rd - -
- string -
- 		- -
VPN Route Distinguisher (RD). Valid values are a string in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword 'auto', or the keyword 'default'.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
- 		-
Manages desired state of the resource.
-
-
- vni - -
- string -
- 		- -
Specify virtual network identifier. Valid values are Integer or keyword 'default'.
-
-
- associated_interfaces - -
- list - / elements=string -
- 		- -
This is a intent option and checks the operational state of the for given vrf name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vrf interfaces on device it will result in failure.
-
-
- delay - -
- integer -
- 		- Default:
10
- 		-
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
-
-
- description - -
- string -
- 		- -
Description of the VRF or keyword 'default'.
-
-
- interfaces - -
- list - / elements=string -
- 		- -
List of interfaces to check the VRF has been configured correctly or keyword 'default'.
-
-
- name - -
- string -
- 		- -
Name of VRF to be managed.
-

aliases: vrf
-
-
- purge - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Purge VRFs not defined in the aggregate parameter.
-
-
- rd - -
- string -
- 		- -
VPN Route Distinguisher (RD). Valid values are a string in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword 'auto', or the keyword 'default'.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manages desired state of the resource.
-
-
- vni - -
- string -
- 		- -
Specify virtual network identifier. Valid values are Integer or keyword 'default'.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Cisco NX-OS creates the default VRF by itself. Therefore, you're not allowed to use default as *vrf* name in this module. - - ``vrf`` name must be shorter than 32 chars. - - VRF names are not case sensible in NX-OS. Anyway, the name is stored just like it's inserted by the user and it'll not be changed again unless the VRF is removed and re-created. i.e. ``vrf=NTC`` will create a VRF named NTC, but running it again with ``vrf=ntc`` will not cause a configuration change. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Ensure ntc VRF exists on switch - cisco.nxos.nxos_vrf: - name: ntc - description: testing - state: present - - name: Aggregate definition of VRFs - cisco.nxos.nxos_vrf: - aggregate: - - name: test1 - description: Testing - admin_state: down - - name: test2 - interfaces: Ethernet1/2 - - name: Aggregate definitions of VRFs with Purge - cisco.nxos.nxos_vrf: - aggregate: - - name: ntc1 - description: purge test1 - - name: ntc2 - description: purge test2 - state: present - purge: true - - name: Delete VRFs exist on switch - cisco.nxos.nxos_vrf: - aggregate: - - name: ntc1 - - name: ntc2 - state: absent - - name: Assign interfaces to VRF declaratively - cisco.nxos.nxos_vrf: - name: test1 - interfaces: - - Ethernet2/3 - - Ethernet2/5 - - name: Check interfaces assigned to VRF - cisco.nxos.nxos_vrf: - name: test1 - associated_interfaces: - - Ethernet2/3 - - Ethernet2/5 - - name: >- - Ensure VRF is tagged with interface Ethernet2/5 only (Removes from - Ethernet2/3) - cisco.nxos.nxos_vrf: - name: test1 - interfaces: - - Ethernet2/5 - - name: Delete VRF - cisco.nxos.nxos_vrf: - name: ntc - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['vrf context ntc', 'no shutdown', 'interface Ethernet1/2', 'no switchport', 'vrf member test2']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_vrrp_module.rst b/docs/cisco.nxos.nxos_vrrp_module.rst deleted file mode 100644 index 88183c5af..000000000 --- a/docs/cisco.nxos.nxos_vrrp_module.rst +++ /dev/null @@ -1,277 +0,0 @@ -.. _cisco.nxos.nxos_vrrp_module: - - -******************** -cisco.nxos.nxos_vrrp -******************** - -**Manages VRRP configuration on NX-OS switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages VRRP configuration on NX-OS switches. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- admin_state - -
- string -
- 		-
    Choices: -
  • shutdown ←
    • -
  • no shutdown
    • -
  • default
    • -
- 		-
Used to enable or disable the VRRP process.
-
-
- authentication - -
- string -
- 		- -
Clear text authentication string or 'default' keyword
-
-
- group - -
- string - / required -
- 		- -
VRRP group number.
-
-
- interface - -
- string - / required -
- 		- -
Full name of interface that is being managed for VRRP.
-
-
- interval - -
- string -
- 		- -
Time interval between advertisement or 'default' keyword
-
-
- preempt - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable preempt.
-
-
- priority - -
- string -
- 		- -
VRRP priority or 'default' keyword
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Specify desired state of the resource.
-
-
- vip - -
- string -
- 		- -
VRRP virtual IP address or 'default' keyword
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - VRRP feature needs to be enabled first on the system. - - SVIs must exist before using this module. - - Interface must be a L3 port before using this module. - - ``state=absent`` removes the VRRP group if it exists on the device. - - VRRP cannot be configured on loopback interfaces. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Ensure vrrp group 100 and vip 10.1.100.1 is on vlan10 - cisco.nxos.nxos_vrrp: - interface: vlan10 - group: 100 - vip: 10.1.100.1 - - - name: Ensure removal of the vrrp group config - cisco.nxos.nxos_vrrp: - interface: vlan10 - group: 100 - vip: 10.1.100.1 - state: absent - - - name: Re-config with more params - cisco.nxos.nxos_vrrp: - interface: vlan10 - group: 100 - vip: 10.1.100.1 - preempt: false - priority: 130 - authentication: AUTHKEY - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['interface vlan10', 'vrrp 150', 'address 10.1.15.1', 'authentication text testing', 'no shutdown']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vsan_module.rst b/docs/cisco.nxos.nxos_vsan_module.rst deleted file mode 100644 index 9baa64c68..000000000 --- a/docs/cisco.nxos.nxos_vsan_module.rst +++ /dev/null @@ -1,225 +0,0 @@ -.. _cisco.nxos.nxos_vsan_module: - - -******************** -cisco.nxos.nxos_vsan -******************** - -**Configuration of vsan for Cisco NXOS MDS Switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configuration of vsan for Cisco MDS NXOS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- vsan - -
- list - / elements=dictionary -
- 		- -
List of vsan details to be added or removed
-
-
- id - -
- integer - / required -
- 		- -
Vsan id
-
-
- interface - -
- list - / elements=string -
- 		- -
List of vsan's interfaces to be added
-
-
- name - -
- string -
- 		- -
Name of the vsan
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Removes the vsan if True
-
-
- suspend - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
suspend the vsan if True
-
-
- - -Notes ------ - -.. note:: - - Tested against Cisco MDS NX-OS 8.4(1) - - - -Examples --------- - -.. code-block:: yaml - - - name: Test that vsan module works - cisco.nxos.nxos_vsan: - vsan: - - id: 922 - interface: - - fc1/1 - - fc1/2 - - port-channel 1 - name: vsan-SAN-A - remove: false - suspend: false - - id: 923 - interface: - - fc1/11 - - fc1/21 - - port-channel 2 - name: vsan-SAN-B - remove: false - suspend: true - - id: 1923 - name: vsan-SAN-Old - remove: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['terminal dont-ask', 'vsan database', 'vsan 922 interface fc1/40', 'vsan 922 interface port-channel 155', 'no terminal dont-ask']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) diff --git a/docs/cisco.nxos.nxos_vxlan_vtep_module.rst b/docs/cisco.nxos.nxos_vxlan_vtep_module.rst deleted file mode 100644 index 57fdc14a3..000000000 --- a/docs/cisco.nxos.nxos_vxlan_vtep_module.rst +++ /dev/null @@ -1,332 +0,0 @@ -.. _cisco.nxos.nxos_vxlan_vtep_module: - - -************************** -cisco.nxos.nxos_vxlan_vtep -************************** - -**Manages VXLAN Network Virtualization Endpoint (NVE).** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages VXLAN Network Virtualization Endpoint (NVE) overlay interface that terminates VXLAN tunnels. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- advertise_virtual_rmac - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
The advertise_virtual_rmac parameter lets BGP to use the VMAC with VIP as next-hop when advertising type-2 routes. Should be used together with advertise_pip parameter from cisco.nxos.nxos_bgp_address_family module.
-
-
- description - -
- string -
- 		- -
Description of the NVE interface.
-
-
- global_ingress_replication_bgp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configures ingress replication protocol as bgp for all VNIs. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
-
-
- global_mcast_group_L2 - -
- string -
- 		- -
Global multicast IP prefix for L2 VNIs or the keyword 'default'. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
-
-
- global_mcast_group_L3 - -
- string -
- 		- -
Global multicast IP prefix for L3 VNIs or the keyword 'default'. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
-
-
- global_suppress_arp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables ARP suppression for all VNIs. This is available on NX-OS 9K series running 9.2.x or higher.
-
-
- host_reachability - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify mechanism for host reachability advertisement. A Boolean value of 'true' indicates that BGP will be used for host reachability advertisement. A Boolean value of 'false' indicates that no protocol is used for host reachability advertisement. Other host reachability advertisement protocols (e.g. OpenFlow, controller, etc.) are not supported.
-
-
- interface - -
- string - / required -
- 		- -
Interface name for the VXLAN Network Virtualization Endpoint.
-
-
- multisite_border_gateway_interface - -
- string -
-
added in 1.1.0
- 		- -
Specify the loopback interface whose IP address should be used for the NVE Multisite Border-gateway Interface. This is available on specific Nexus 9000 series switches running NX-OS 7.0(3)I7(x) or higher. Specify "default" to remove an existing gateway config.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively shutdown the NVE interface.
-
-
- source_interface - -
- string -
- 		- -
Specify the loopback interface whose IP address should be used for the NVE interface.
-
-
- source_interface_hold_down_time - -
- string -
- 		- -
Suppresses advertisement of the NVE loopback address until the overlay has converged.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Determines whether the config should be present or not on the device.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - The module is used to manage NVE properties, not to create NVE interfaces. Use :ref:`cisco.nxos.nxos_interfaces ` if you wish to do so. - - ``state=absent`` removes the interface. - - Default, where supported, restores params default value. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_vxlan_vtep: - interface: nve1 - description: default - host_reachability: true - source_interface: Loopback0 - source_interface_hold_down_time: 30 - shutdown: default - multisite_border_gateway_interface: Loopback0 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['interface nve1', 'source-interface loopback0', 'source-interface hold-down-time 30', 'description simple description', 'shutdown', 'host-reachability protocol bgp', 'multisite border-gateway interface loopback0']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_zone_zoneset_module.rst b/docs/cisco.nxos.nxos_zone_zoneset_module.rst deleted file mode 100644 index 95ef4972a..000000000 --- a/docs/cisco.nxos.nxos_zone_zoneset_module.rst +++ /dev/null @@ -1,537 +0,0 @@ -.. _cisco.nxos.nxos_zone_zoneset_module: - - -**************************** -cisco.nxos.nxos_zone_zoneset -**************************** - -**Configuration of zone/zoneset for Cisco NXOS MDS Switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configuration of zone/zoneset for Cisco MDS NXOS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- zone_zoneset_details - -
- list - / elements=dictionary -
- 		- -
List of zone/zoneset details to be added or removed
-
-
- default_zone - -
- string -
- 		-
    Choices: -
  • permit
    • -
  • deny
    • -
- 		-
default zone behaviour for the vsan
-
-
- mode - -
- string -
- 		-
    Choices: -
  • enhanced
    • -
  • basic
    • -
- 		-
mode of the zone for the vsan
-
-
- smart_zoning - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Removes the vsan if True
-
-
- vsan - -
- integer - / required -
- 		- -
vsan id
-
-
- zone - -
- list - / elements=dictionary -
- 		- -
List of zone options for that vsan
-
-
- members - -
- list - / elements=dictionary -
- 		- -
Members of the zone that needs to be removed or added
-
-
- devtype - -
- string -
- 		-
    Choices: -
  • initiator
    • -
  • target
    • -
  • both
    • -
- 		-
devtype of the zone member used along with Smart zoning config
-
-
- pwwn - -
- string - / required -
- 		- -
pwwn member of the zone, use alias 'device_alias' as option for device_alias member
-

aliases: device_alias
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Removes member from the zone if True
-
-
- name - -
- string - / required -
- 		- -
name of the zone
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Deletes the zone if True
-
-
- zoneset - -
- list - / elements=dictionary -
- 		- -
List of zoneset options for the vsan
-
-
- action - -
- string -
- 		-
    Choices: -
  • activate
    • -
  • deactivate
    • -
- 		-
activates/de-activates the zoneset
-
-
- members - -
- list - / elements=dictionary -
- 		- -
Members of the zoneset that needs to be removed or added
-
-
- name - -
- string - / required -
- 		- -
name of the zone that needs to be added to the zoneset or removed from the zoneset
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Removes zone member from the zoneset
-
-
- name - -
- string - / required -
- 		- -
name of the zoneset
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Removes zoneset if True
-
-
- - -Notes ------ - -.. note:: - - Tested against Cisco MDS NX-OS 8.4(1) - - - -Examples --------- - -.. code-block:: yaml - - - name: Test that zone/zoneset module works - cisco.nxos.nxos_zone_zoneset: - zone_zoneset_details: - - mode: enhanced - vsan: 22 - zone: - - members: - - pwwn: 31314874576271 - - device_alias: test123 - - pwwn: '61:61:62:62:12:12:12:12' - remove: true - name: zoneA - - members: - - pwwn: 28515514576271 - - pwwn: '62:62:62:62:21:21:21:21' - name: zoneB - - name: zoneC - remove: true - zoneset: - - action: activate - members: - - name: zoneA - - name: zoneB - - name: zoneC - remove: true - name: zsetname1 - - action: deactivate - name: zsetTestExtra - remove: true - - mode: basic - smart_zoning: true - vsan: 21 - zone: - - members: - - devtype: both - pwwn: 31314874576271 - - pwwn: '62:62:62:62:12:12:12:12' - - devtype: both - pwwn: '92:62:62:62:12:12:1a:1a' - remove: true - name: zone21A - - members: - - pwwn: 28515514576271 - - pwwn: '62:62:62:62:21:21:21:21' - name: zone21B - zoneset: - - action: activate - members: - - name: zone21A - - name: zone21B - name: zsetname212 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['terminal dont-ask', 'zone name zoneA vsan 923', 'member pwwn 11:11:11:11:11:11:11:11', 'no member device-alias test123', 'zone commit vsan 923', 'no terminal dont-ask']
-
-
- messages - -
- list -
- 		always -
debug messages
-
-
Sample:
-
['zone mode is already enhanced ,no change in zone mode configuration for vsan 922', "zone member '11:11:11:11:11:11:11:11' is already present in zone 'zoneA' in vsan 922 hence nothing to add", "zone member 'test123' is already present in zone 'zoneA' in vsan 922 hence nothing to add", "zone member '61:61:62:62:12:12:12:12' is not present in zone 'zoneA' in vsan 922 hence nothing to remove", "zone member '10:11:11:11:11:11:11:11' is already present in zone 'zoneB' in vsan 922 hence nothing to add", "zone member '62:62:62:62:21:21:21:21' is already present in zone 'zoneB' in vsan 922 hence nothing to add", "zone 'zoneC' is not present in vsan 922 , so nothing to remove"]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) From 5f2f884bcf173b114305044b2c96bbd3591189b6 Mon Sep 17 00:00:00 2001 From: Vinay Mulugund Date: Thu, 7 Mar 2024 19:54:08 +0530 Subject: [PATCH 12/30] precommit fix --- ...cisco.nxos.nxos_aaa_server_host_module.rst | 343 + docs/cisco.nxos.nxos_aaa_server_module.rst | 248 + .../cisco.nxos.nxos_acl_interfaces_module.rst | 610 ++ docs/cisco.nxos.nxos_acls_module.rst | 4086 ++++++++++++ docs/cisco.nxos.nxos_banner_module.rst | 187 + docs/cisco.nxos.nxos_bfd_global_module.rst | 326 + .../cisco.nxos.nxos_bfd_interfaces_module.rst | 394 ++ docs/cisco.nxos.nxos_bgp_global_module.rst | 5843 +++++++++++++++++ ...xos_bgp_neighbor_address_family_module.rst | 3575 ++++++++++ docs/cisco.nxos.nxos_bgp_templates_module.rst | 2841 ++++++++ docs/cisco.nxos.nxos_command_module.rst | 258 + docs/cisco.nxos.nxos_config_module.rst | 566 ++ docs/cisco.nxos.nxos_devicealias_module.rst | 273 + docs/cisco.nxos.nxos_evpn_global_module.rst | 122 + docs/cisco.nxos.nxos_evpn_vni_module.rst | 212 + docs/cisco.nxos.nxos_facts_module.rst | 553 ++ docs/cisco.nxos.nxos_feature_module.rst | 150 + docs/cisco.nxos.nxos_gir_module.rst | 302 + ...xos.nxos_gir_profile_management_module.rst | 235 + docs/cisco.nxos.nxos_hostname_module.rst | 344 + ...cisco.nxos.nxos_hsrp_interfaces_module.rst | 344 + docs/cisco.nxos.nxos_hsrp_module.rst | 305 + docs/cisco.nxos.nxos_igmp_module.rst | 191 + docs/cisco.nxos.nxos_igmp_snooping_module.rst | 225 + docs/cisco.nxos.nxos_install_os_module.rst | 183 + docs/cisco.nxos.nxos_l2_interfaces_module.rst | 648 ++ docs/cisco.nxos.nxos_l3_interfaces_module.rst | 884 +++ docs/cisco.nxos.nxos_lacp_module.rst | 402 ++ ...cisco.nxos.nxos_lldp_interfaces_module.rst | 407 ++ docs/cisco.nxos.nxos_logging_module.rst | 458 ++ docs/cisco.nxos.nxos_ntp_auth_module.rst | 224 + docs/cisco.nxos.nxos_ntp_global_module.rst | 1411 ++++ docs/cisco.nxos.nxos_ntp_module.rst | 314 + docs/cisco.nxos.nxos_ntp_options_module.rst | 192 + docs/cisco.nxos.nxos_nxapi_module.rst | 300 + ...cisco.nxos.nxos_ospf_interfaces_module.rst | 1732 +++++ docs/cisco.nxos.nxos_ospfv2_module.rst | 5458 +++++++++++++++ .../cisco.nxos.nxos_overlay_global_module.rst | 120 + docs/cisco.nxos.nxos_pim_module.rst | 148 + docs/cisco.nxos.nxos_ping_module.rst | 311 + docs/cisco.nxos.nxos_prefix_lists_module.rst | 1049 +++ docs/cisco.nxos.nxos_reboot_module.rst | 123 + docs/cisco.nxos.nxos_rollback_module.rst | 159 + docs/cisco.nxos.nxos_route_maps_module.rst | 4368 ++++++++++++ docs/cisco.nxos.nxos_rpm_module.rst | 226 + docs/cisco.nxos.nxos_snapshot_module.rst | 363 + .../cisco.nxos.nxos_snmp_community_module.rst | 201 + docs/cisco.nxos.nxos_snmp_host_module.rst | 288 + docs/cisco.nxos.nxos_snmp_location_module.rst | 156 + docs/cisco.nxos.nxos_snmp_server_module.rst | 4474 +++++++++++++ docs/cisco.nxos.nxos_snmp_traps_module.rst | 189 + docs/cisco.nxos.nxos_snmp_user_module.rst | 235 + .../cisco.nxos.nxos_udld_interface_module.rst | 250 + docs/cisco.nxos.nxos_udld_module.rst | 256 + docs/cisco.nxos.nxos_user_module.rst | 390 ++ docs/cisco.nxos.nxos_vpc_module.rst | 352 + docs/cisco.nxos.nxos_vrf_af_module.rst | 300 + docs/cisco.nxos.nxos_vrf_module.rst | 494 ++ docs/cisco.nxos.nxos_vrrp_module.rst | 277 + docs/cisco.nxos.nxos_vsan_module.rst | 225 + docs/cisco.nxos.nxos_vxlan_vtep_module.rst | 332 + docs/cisco.nxos.nxos_zone_zoneset_module.rst | 537 ++ plugins/modules/nxos_spanning_tree_global.py | 9 +- 63 files changed, 50973 insertions(+), 5 deletions(-) create mode 100644 docs/cisco.nxos.nxos_aaa_server_host_module.rst create mode 100644 docs/cisco.nxos.nxos_aaa_server_module.rst create mode 100644 docs/cisco.nxos.nxos_acl_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_acls_module.rst create mode 100644 docs/cisco.nxos.nxos_banner_module.rst create mode 100644 docs/cisco.nxos.nxos_bfd_global_module.rst create mode 100644 docs/cisco.nxos.nxos_bfd_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_bgp_global_module.rst create mode 100644 docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst create mode 100644 docs/cisco.nxos.nxos_bgp_templates_module.rst create mode 100644 docs/cisco.nxos.nxos_command_module.rst create mode 100644 docs/cisco.nxos.nxos_config_module.rst create mode 100644 docs/cisco.nxos.nxos_devicealias_module.rst create mode 100644 docs/cisco.nxos.nxos_evpn_global_module.rst create mode 100644 docs/cisco.nxos.nxos_evpn_vni_module.rst create mode 100644 docs/cisco.nxos.nxos_facts_module.rst create mode 100644 docs/cisco.nxos.nxos_feature_module.rst create mode 100644 docs/cisco.nxos.nxos_gir_module.rst create mode 100644 docs/cisco.nxos.nxos_gir_profile_management_module.rst create mode 100644 docs/cisco.nxos.nxos_hostname_module.rst create mode 100644 docs/cisco.nxos.nxos_hsrp_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_hsrp_module.rst create mode 100644 docs/cisco.nxos.nxos_igmp_module.rst create mode 100644 docs/cisco.nxos.nxos_igmp_snooping_module.rst create mode 100644 docs/cisco.nxos.nxos_install_os_module.rst create mode 100644 docs/cisco.nxos.nxos_l2_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_l3_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_lacp_module.rst create mode 100644 docs/cisco.nxos.nxos_lldp_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_logging_module.rst create mode 100644 docs/cisco.nxos.nxos_ntp_auth_module.rst create mode 100644 docs/cisco.nxos.nxos_ntp_global_module.rst create mode 100644 docs/cisco.nxos.nxos_ntp_module.rst create mode 100644 docs/cisco.nxos.nxos_ntp_options_module.rst create mode 100644 docs/cisco.nxos.nxos_nxapi_module.rst create mode 100644 docs/cisco.nxos.nxos_ospf_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_ospfv2_module.rst create mode 100644 docs/cisco.nxos.nxos_overlay_global_module.rst create mode 100644 docs/cisco.nxos.nxos_pim_module.rst create mode 100644 docs/cisco.nxos.nxos_ping_module.rst create mode 100644 docs/cisco.nxos.nxos_prefix_lists_module.rst create mode 100644 docs/cisco.nxos.nxos_reboot_module.rst create mode 100644 docs/cisco.nxos.nxos_rollback_module.rst create mode 100644 docs/cisco.nxos.nxos_route_maps_module.rst create mode 100644 docs/cisco.nxos.nxos_rpm_module.rst create mode 100644 docs/cisco.nxos.nxos_snapshot_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_community_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_host_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_location_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_server_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_traps_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_user_module.rst create mode 100644 docs/cisco.nxos.nxos_udld_interface_module.rst create mode 100644 docs/cisco.nxos.nxos_udld_module.rst create mode 100644 docs/cisco.nxos.nxos_user_module.rst create mode 100644 docs/cisco.nxos.nxos_vpc_module.rst create mode 100644 docs/cisco.nxos.nxos_vrf_af_module.rst create mode 100644 docs/cisco.nxos.nxos_vrf_module.rst create mode 100644 docs/cisco.nxos.nxos_vrrp_module.rst create mode 100644 docs/cisco.nxos.nxos_vsan_module.rst create mode 100644 docs/cisco.nxos.nxos_vxlan_vtep_module.rst create mode 100644 docs/cisco.nxos.nxos_zone_zoneset_module.rst diff --git a/docs/cisco.nxos.nxos_aaa_server_host_module.rst b/docs/cisco.nxos.nxos_aaa_server_host_module.rst new file mode 100644 index 000000000..5730e6359 --- /dev/null +++ b/docs/cisco.nxos.nxos_aaa_server_host_module.rst @@ -0,0 +1,343 @@ +.. _cisco.nxos.nxos_aaa_server_host_module: + + +******************************* +cisco.nxos.nxos_aaa_server_host +******************************* + +**Manages AAA server host-specific configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages AAA server host-specific configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ acct_port + +
+ string +
+ 		+ +
Alternate UDP port for RADIUS accounting or keyword 'default'.
+
+
+ address + +
+ string + / required +
+ 		+ +
Address or name of the radius or tacacs host.
+
+
+ auth_port + +
+ string +
+ 		+ +
Alternate UDP port for RADIUS authentication or keyword 'default'.
+
+
+ encrypt_type + +
+ string +
+ 		+
    Choices: +
  • 0
    • +
  • 7
    • +
+ 		+
The state of encryption applied to the entered key. O for clear text, 7 for encrypted. Type-6 encryption is not supported.
+
+
+ host_timeout + +
+ string +
+ 		+ +
Timeout period for specified host, in seconds or keyword 'default. Range is 1-60.
+
+
+ key + +
+ string +
+ 		+ +
Shared secret for the specified host or keyword 'default'.
+
+
+ server_type + +
+ string + / required +
+ 		+
    Choices: +
  • radius
    • +
  • tacacs
    • +
+ 		+
The server type is either radius or tacacs.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ tacacs_port + +
+ string +
+ 		+ +
Alternate TCP port TACACS Server or keyword 'default'.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - Changes to the host key (shared secret) are not idempotent for type 0. + - If ``state=absent`` removes the whole host configuration. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Radius Server Host Basic settings + - name: Radius Server Host Basic settings + cisco.nxos.nxos_aaa_server_host: + state: present + server_type: radius + address: 1.2.3.4 + acct_port: 2084 + host_timeout: 10 + + # Radius Server Host Key Configuration + - name: Radius Server Host Key Configuration + cisco.nxos.nxos_aaa_server_host: + state: present + server_type: radius + address: 1.2.3.4 + key: hello + encrypt_type: 7 + + # TACACS Server Host Configuration + - name: Tacacs Server Host Configuration + cisco.nxos.nxos_aaa_server_host: + state: present + server_type: tacacs + tacacs_port: 89 + host_timeout: 10 + address: 5.6.7.8 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ end_state + +
+ dictionary +
+ 		always +
k/v pairs of configuration after module execution
+
+
Sample:
+
{'address': '1.2.3.4', 'auth_port': '2084', 'host_timeout': '10', 'server_type': 'radius'}
+
+
+ existing + +
+ dictionary +
+ 		always +
k/v pairs of existing configuration
+
+
+
+ proposed + +
+ dictionary +
+ 		always +
k/v pairs of parameters passed into module
+
+
Sample:
+
{'address': '1.2.3.4', 'auth_port': '2084', 'host_timeout': '10', 'server_type': 'radius'}
+
+
+ updates + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['radius-server host 1.2.3.4 auth-port 2084 timeout 10']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_aaa_server_module.rst b/docs/cisco.nxos.nxos_aaa_server_module.rst new file mode 100644 index 000000000..1307c9033 --- /dev/null +++ b/docs/cisco.nxos.nxos_aaa_server_module.rst @@ -0,0 +1,248 @@ +.. _cisco.nxos.nxos_aaa_server_module: + + +************************** +cisco.nxos.nxos_aaa_server +************************** + +**Manages AAA server global configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages AAA server global configuration + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ deadtime + +
+ string +
+ 		+ +
Duration for which a non-reachable AAA server is skipped, in minutes or keyword 'default. Range is 1-1440. Device default is 0.
+
+
+ directed_request + +
+ string +
+ 		+
    Choices: +
  • enabled
    • +
  • disabled
    • +
  • default
    • +
+ 		+
Enables direct authentication requests to AAA server or keyword 'default' Device default is disabled.
+
+
+ encrypt_type + +
+ string +
+ 		+
    Choices: +
  • 0
    • +
  • 7
    • +
+ 		+
The state of encryption applied to the entered global key. O clear text, 7 encrypted. Type-6 encryption is not supported.
+
+
+ global_key + +
+ string +
+ 		+ +
Global AAA shared secret or keyword 'default'.
+
+
+ server_timeout + +
+ string +
+ 		+ +
Global AAA server timeout period, in seconds or keyword 'default. Range is 1-60. Device default is 5.
+
+
+ server_type + +
+ string + / required +
+ 		+
    Choices: +
  • radius
    • +
  • tacacs
    • +
+ 		+
The server type is either radius or tacacs.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • default
    • +
+ 		+
Manage the state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - The server_type parameter is always required. + - If encrypt_type is not supplied, the global AAA server key will be stored as encrypted (type 7). + - Changes to the global AAA server key with encrypt_type=0 are not idempotent. + - state=default will set the supplied parameters to their default values. The parameters that you want to default must also be set to default. If global_key=default, the global key will be removed. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Radius Server Basic settings + - name: Radius Server Basic settings + cisco.nxos.nxos_aaa_server: + server_type: radius + server_timeout: 9 + deadtime: 20 + directed_request: enabled + + # Tacacs Server Basic settings + - name: Tacacs Server Basic settings + cisco.nxos.nxos_aaa_server: + server_type: tacacs + server_timeout: 8 + deadtime: 19 + directed_request: disabled + + # Setting Global Key + - name: AAA Server Global Key + cisco.nxos.nxos_aaa_server: + server_type: radius + global_key: test_key + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['radius-server deadtime 22', 'radius-server timeout 11', 'radius-server directed-request']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_acl_interfaces_module.rst b/docs/cisco.nxos.nxos_acl_interfaces_module.rst new file mode 100644 index 000000000..a2885df02 --- /dev/null +++ b/docs/cisco.nxos.nxos_acl_interfaces_module.rst @@ -0,0 +1,610 @@ +.. _cisco.nxos.nxos_acl_interfaces_module: + + +****************************** +cisco.nxos.nxos_acl_interfaces +****************************** + +**ACL interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Add and remove Access Control Lists on interfaces in NX-OS platform + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of interfaces to be configured with ACLs
+
+
+ access_groups + +
+ list + / elements=dictionary +
+ 		+ +
List of address family indicators with ACLs to be configured on the interface
+
+
+ acls + +
+ list + / elements=dictionary +
+ 		+ +
List of Access Control Lists for the interface
+
+
+ direction + +
+ string + / required +
+ 		+
    Choices: +
  • in
    • +
  • out
    • +
+ 		+
Direction to be applied for the ACL
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the ACL to be added/removed
+
+
+ port + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use ACL as port policy.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
Address Family Indicator of the ACLs to be configured
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the interface
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • deleted
    • +
  • gathered
    • +
  • merged ←
    • +
  • overridden
    • +
  • rendered
    • +
  • replaced
    • +
  • parsed
    • +
+ 		+
The state the configuration should be left in
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------ + # + + - name: Merge ACL interfaces configuration + cisco.nxos.nxos_acl_interfaces: + config: + - name: Ethernet1/2 + access_groups: + - afi: ipv6 + acls: + - name: ACL1v6 + direction: in + + - name: Eth1/5 + access_groups: + - afi: ipv4 + acls: + - name: PortACL + direction: in + port: true + + - name: ACL1v4 + direction: out + + - afi: ipv6 + acls: + - name: ACL1v6 + direction: in + state: merged + + # After state: + # ------------ + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ip port access-group PortACL in + # ip access-group ACL1v4 out + # ipv6 traffic-filter ACL1v6 in + + # Using replaced + + # Before state: + # ------------ + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ip port access-group PortACL in + # ip access-group ACL1v4 out + # ipv6 traffic-filter ACL1v6 in + + - name: Replace interface configuration with given configuration + cisco.nxos.nxos_acl_interfaces: + config: + - name: Eth1/5 + access_groups: + - afi: ipv4 + acls: + - name: NewACLv4 + direction: out + + - name: Ethernet1/3 + access_groups: + - afi: ipv6 + acls: + - name: NewACLv6 + direction: in + port: true + state: replaced + + # After state: + # ------------ + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/3 + # ipv6 port traffic-filter NewACLv6 in + # interface Ethernet1/5 + # ip access-group NewACLv4 out + + # Using overridden + + # Before state: + # ------------ + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ip port access-group PortACL in + # ip access-group ACL1v4 out + # ipv6 traffic-filter ACL1v6 in + + - name: Override interface configuration with given configuration + cisco.nxos.nxos_acl_interfaces: + config: + - name: Ethernet1/3 + access_groups: + - afi: ipv4 + acls: + - name: ACL1v4 + direction: out + + - name: PortACL + port: true + direction: in + - afi: ipv6 + acls: + - name: NewACLv6 + direction: in + port: true + state: overridden + + # After state: + # ------------ + # interface Ethernet1/3 + # ip access-group ACL1v4 out + # ip port access-group PortACL in + # ipv6 port traffic-filter NewACLv6 in + + # Using deleted to remove ACL config from specified interfaces + + # Before state: + # ------------- + # interface Ethernet1/1 + # ip access-group ACL2v4 in + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ip port access-group PortACL in + # ip access-group ACL1v4 out + # ipv6 traffic-filter ACL1v6 in + + - name: Delete ACL configuration on interfaces + cisco.nxos.nxos_acl_interfaces: + config: + - name: Ethernet1/5 + - name: Ethernet1/2 + state: deleted + + # After state: + # ------------- + # interface Ethernet1/1 + # ip access-group ACL2v4 in + # interface Ethernet1/2 + # interface Ethernet1/5 + + # Using deleted to remove ACL config from all interfaces + + # Before state: + # ------------- + # interface Ethernet1/1 + # ip access-group ACL2v4 in + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ip port access-group PortACL in + # ip access-group ACL1v4 out + # ipv6 traffic-filter ACL1v6 in + + - name: Delete ACL configuration from all interfaces + cisco.nxos.nxos_acl_interfaces: + state: deleted + + # After state: + # ------------- + # interface Ethernet1/1 + # interface Ethernet1/2 + # interface Ethernet1/5 + + # Using parsed + + - name: Parse given configuration into structured format + cisco.nxos.nxos_acl_interfaces: + running_config: | + interface Ethernet1/2 + ipv6 traffic-filter ACL1v6 in + interface Ethernet1/5 + ipv6 traffic-filter ACL1v6 in + ip access-group ACL1v4 out + ip port access-group PortACL in + state: parsed + + # returns + # parsed: + # - name: Ethernet1/2 + # access_groups: + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # direction: in + # - name: Ethernet1/5 + # access_groups: + # - afi: ipv4 + # acls: + # - name: PortACL + # direction: in + # port: True + # - name: ACL1v4 + # direction: out + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # direction: in + + + # Using gathered: + + # Before state: + # ------------ + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ipv6 traffic-filter ACL1v6 in + # ip access-group ACL1v4 out + # ip port access-group PortACL in + + - name: Gather existing configuration from device + cisco.nxos.nxos_acl_interfaces: + config: + state: gathered + + # returns + # gathered: + # - name: Ethernet1/2 + # access_groups: + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # direction: in + # - name: Ethernet1/5 + # access_groups: + # - afi: ipv4 + # acls: + # - name: PortACL + # direction: in + # port: True + # - name: ACL1v4 + # direction: out + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # direction: in + + + # Using rendered + + - name: Render required configuration to be pushed to the device + cisco.nxos.nxos_acl_interfaces: + config: + - name: Ethernet1/2 + access_groups: + - afi: ipv6 + acls: + - name: ACL1v6 + direction: in + - name: Ethernet1/5 + access_groups: + - afi: ipv4 + acls: + - name: PortACL + direction: in + port: true + - name: ACL1v4 + direction: out + - afi: ipv6 + acls: + - name: ACL1v6 + direction: in + state: rendered + + + # returns + # rendered: + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ipv6 traffic-filter ACL1v6 in + # ip access-group ACL1v4 out + # ip port access-group PortACL in + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/2', 'ipv6 traffic-filter ACL1v6 out', 'ip port access-group PortACL in']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_acls_module.rst b/docs/cisco.nxos.nxos_acls_module.rst new file mode 100644 index 000000000..1b806511d --- /dev/null +++ b/docs/cisco.nxos.nxos_acls_module.rst @@ -0,0 +1,4086 @@ +.. _cisco.nxos.nxos_acls_module: + + +******************** +cisco.nxos.nxos_acls +******************** + +**ACLs resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manage named IP ACLs on the Cisco NX-OS platform + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary of ACL options.
+
+
+ acls + +
+ list + / elements=dictionary +
+ 		+ +
A list of the ACLs.
+
+
+ aces + +
+ list + / elements=dictionary +
+ 		+ +
The entries within the ACL.
+
+
+ destination + +
+ dictionary +
+ 		+ +
Specify the packet destination.
+
+
+ address + +
+ string +
+ 		+ +
Destination network address.
+
+
+ any + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Any destination address.
+
+
+ host + +
+ string +
+ 		+ +
Host IP address.
+
+
+ port_protocol + +
+ dictionary +
+ 		+ +
Specify the destination port or protocol (only for TCP and UDP).
+
+
+ eq + +
+ string +
+ 		+ +
Match only packets on a given port number.
+
+
+ gt + +
+ string +
+ 		+ +
Match only packets with a greater port number.
+
+
+ lt + +
+ string +
+ 		+ +
Match only packets with a lower port number.
+
+
+ neq + +
+ string +
+ 		+ +
Match only packets not on a given port number.
+
+
+ range + +
+ dictionary +
+ 		+ +
Match only packets in the range of port numbers.
+
+
+ end + +
+ string +
+ 		+ +
Specify the end of the port range.
+
+
+ start + +
+ string +
+ 		+ +
Specify the start of the port range.
+
+
+ prefix + +
+ string +
+ 		+ +
Destination network prefix. Only for prefixes of value less than 31 for ipv4 and 127 for ipv6. Prefixes of 32 (ipv4) and 128 (ipv6) should be given in the 'host' key.
+
+
+ wildcard_bits + +
+ string +
+ 		+ +
Destination wildcard bits.
+
+
+ dscp + +
+ string +
+ 		+ +
Match packets with given DSCP value.
+
+
+ fragments + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Check non-initial fragments.
+
+
+ grant + +
+ string +
+ 		+
    Choices: +
  • permit
    • +
  • deny
    • +
+ 		+
Action to be applied on the rule.
+
+
+ log + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log matches against this entry.
+
+
+ precedence + +
+ string +
+ 		+ +
Match packets with given precedence value.
+
+
+ protocol + +
+ string +
+ 		+ +
Specify the protocol.
+
+
+ protocol_options + +
+ dictionary +
+ 		+ +
All possible suboptions for the protocol chosen.
+
+
+ icmp + +
+ dictionary +
+ 		+ +
ICMP protocol options.
+
+
+ administratively_prohibited + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively prohibited
+
+
+ alternate_address + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Alternate address
+
+
+ conversion_error + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Datagram conversion
+
+
+ dod_host_prohibited + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host prohibited
+
+
+ dod_net_prohibited + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Net prohibited
+
+
+ echo + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo (ping)
+
+
+ echo_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo reply
+
+
+ echo_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo request (ping)
+
+
+ general_parameter_problem + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter problem
+
+
+ host_isolated + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host isolated
+
+
+ host_precedence_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host unreachable for precedence
+
+
+ host_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host redirect
+
+
+ host_tos_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host redirect for TOS
+
+
+ host_tos_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host unreachable for TOS
+
+
+ host_unknown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host unknown
+
+
+ host_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host unreachable
+
+
+ information_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Information replies
+
+
+ information_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Information requests
+
+
+ mask_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Mask replies
+
+
+ mask_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Mask requests
+
+
+ message_code + +
+ integer +
+ 		+ +
ICMP message code
+
+
+ message_type + +
+ integer +
+ 		+ +
ICMP message type
+
+
+ mobile_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Mobile host redirect
+
+
+ net_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Network redirect
+
+
+ net_tos_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Net redirect for TOS
+
+
+ net_tos_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Network unreachable for TOS
+
+
+ net_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Net unreachable
+
+
+ network_unknown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Network unknown
+
+
+ no_room_for_option + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter required but no room
+
+
+ option_missing + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter required but not present
+
+
+ packet_too_big + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Fragmentation needed and DF set
+
+
+ parameter_problem + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All parameter problems
+
+
+ port_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Port unreachable
+
+
+ precedence_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Precedence cutoff
+
+
+ protocol_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Protocol unreachable
+
+
+ reassembly_timeout + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Reassembly timeout
+
+
+ redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All redirects
+
+
+ router_advertisement + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router discovery advertisements
+
+
+ router_solicitation + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router discovery solicitations
+
+
+ source_quench + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Source quenches
+
+
+ source_route_failed + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Source route failed
+
+
+ time_exceeded + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All time exceeded.
+
+
+ timestamp_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Timestamp replies
+
+
+ timestamp_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Timestamp requests
+
+
+ traceroute + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Traceroute
+
+
+ ttl_exceeded + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
TTL exceeded
+
+
+ unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All unreachables
+
+
+ icmpv6 + +
+ dictionary +
+ 		+ +
ICMPv6 protocol options.
+
+
+ beyond_scope + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Destination beyond scope.
+
+
+ destination_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Destination address is unreachable.
+
+
+ echo_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo reply.
+
+
+ echo_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo request (ping).
+
+
+ fragments + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Check non-initial fragments.
+
+
+ header + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter header problem.
+
+
+ hop_limit + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Hop limit exceeded in transit.
+
+
+ mld_query + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Multicast Listener Discovery Query.
+
+
+ mld_reduction + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Multicast Listener Discovery Reduction.
+
+
+ mld_report + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Multicast Listener Discovery Report.
+
+
+ mldv2 + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Multicast Listener Discovery Protocol.
+
+
+ nd_na + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor discovery neighbor advertisements.
+
+
+ nd_ns + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor discovery neighbor solicitations.
+
+
+ next_header + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter next header problems.
+
+
+ no_admin + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administration prohibited destination.
+
+
+ no_route + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
No route to destination.
+
+
+ packet_too_big + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Packet too big.
+
+
+ parameter_option + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter option problems.
+
+
+ parameter_problem + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All parameter problems.
+
+
+ port_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Port unreachable.
+
+
+ reassembly_timeout + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Reassembly timeout.
+
+
+ renum_command + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router renumbering command.
+
+
+ renum_result + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router renumbering result.
+
+
+ renum_seq_number + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router renumbering sequence number reset.
+
+
+ router_advertisement + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor discovery router advertisements.
+
+
+ router_renumbering + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All router renumbering.
+
+
+ router_solicitation + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor discovery router solicitations.
+
+
+ telemetry_path + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
IPT enabled.
+
+
+ telemetry_queue + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Flow of interest for BDC/HDC.
+
+
+ time_exceeded + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All time exceeded.
+
+
+ unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All unreachable.
+
+
+ igmp + +
+ dictionary +
+ 		+ +
IGMP protocol options.
+
+
+ dvmrp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Distance Vector Multicast Routing Protocol
+
+
+ host_query + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host Query
+
+
+ host_report + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host Report
+
+
+ tcp + +
+ dictionary +
+ 		+ +
TCP flags.
+
+
+ ack + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the ACK bit
+
+
+ established + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match established connections
+
+
+ fin + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the FIN bit
+
+
+ psh + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the PSH bit
+
+
+ rst + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the RST bit
+
+
+ syn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the SYN bit
+
+
+ urg + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the URG bit
+
+
+ remark + +
+ string +
+ 		+ +
Access list entry comment.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence number.
+
+
+ source + +
+ dictionary +
+ 		+ +
Specify the packet source.
+
+
+ address + +
+ string +
+ 		+ +
Source network address.
+
+
+ any + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Any source address.
+
+
+ host + +
+ string +
+ 		+ +
Host IP address.
+
+
+ port_protocol + +
+ dictionary +
+ 		+ +
Specify the destination port or protocol (only for TCP and UDP).
+
+
+ eq + +
+ string +
+ 		+ +
Match only packets on a given port number.
+
+
+ gt + +
+ string +
+ 		+ +
Match only packets with a greater port number.
+
+
+ lt + +
+ string +
+ 		+ +
Match only packets with a lower port number.
+
+
+ neq + +
+ string +
+ 		+ +
Match only packets not on a given port number.
+
+
+ range + +
+ dictionary +
+ 		+ +
Match only packets in the range of port numbers.
+
+
+ end + +
+ string +
+ 		+ +
Specify the end of the port range.
+
+
+ start + +
+ string +
+ 		+ +
Specify the start of the port range.
+
+
+ prefix + +
+ string +
+ 		+ +
Source network prefix. Only for prefixes of mask value less than 31 for ipv4 and 127 for ipv6. Prefixes of mask 32 (ipv4) and 128 (ipv6) should be given in the 'host' key.
+
+
+ wildcard_bits + +
+ string +
+ 		+ +
Source wildcard bits.
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the ACL.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
The Address Family Indicator (AFI) for the ACL.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section 'ip(v6* access-list).
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • deleted
    • +
  • gathered
    • +
  • merged ←
    • +
  • overridden
    • +
  • rendered
    • +
  • replaced
    • +
  • parsed
    • +
+ 		+
The state the configuration should be left in
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - As NX-OS allows configuring a rule again with different sequence numbers, the user is expected to provide sequence numbers for the access control entries to preserve idempotency. If no sequence number is given, the rule will be added as a new rule by the device. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + + - name: Merge provided ACLs configuration with device configuration + cisco.nxos.nxos_acls: + state: merged + config: + - afi: ipv4 + acls: + - name: ACL1v4 + aces: + - grant: deny + destination: + address: 192.0.2.64 + wildcard_bits: 0.0.0.255 + source: + any: true + port_protocol: + lt: 55 + protocol: tcp + protocol_options: + tcp: + ack: true + fin: true + sequence: 50 + + - afi: ipv6 + acls: + - name: ACL1v6 + aces: + - grant: permit + sequence: 10 + source: + any: true + destination: + prefix: 2001:db8:12::/32 + protocol: sctp + + # Task Output + # ----------- + # before: [] + # + # commands: + # - ip access-list ACL1v4 + # - 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + # - ipv6 access-list ACL1v6 + # - 10 permit sctp any 2001:db8:12::/32 + # + # after: + # - acls: + # - aces: + # - destination: + # prefix: 2001:db8:12::/32 + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # name: ACL1v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # address: 192.0.2.64 + # wildcard_bits: 0.0.0.255 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # fin: true + # sequence: 50 + # source: + # any: true + # port_protocol: + # lt: '55' + # name: ACL1v4 + # afi: ipv4 + + + # After state: + # ------------ + # + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + + # Using replaced + + # Before state: + # ---------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 10 permit ip any any + # 20 deny udp any any + # ip access-list ACL2v4 + # 10 permit ahp 192.0.2.0 0.0.0.255 any + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ipv6 access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + - name: Replace existing ACL configuration with provided configuration + cisco.nxos.nxos_acls: + config: + - afi: ipv4 + - afi: ipv6 + acls: + - name: ACL1v6 + aces: + - sequence: 20 + grant: permit + source: + any: true + destination: + any: true + protocol: pim + + - remark: Replaced ACE + - name: ACL2v6 + state: replaced + + # Task Output + # ----------- + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # - ipv6 access-list ACL1v6 + # - no 10 permit sctp any any + # - no 20 remark IPv6 ACL + # - remark Replaced ACE + # - 20 permit pim any any + # - ipv6 access-list ACL2v6 + # - no 10 deny ipv6 any 2001:db8:3000::/36 + # - no 20 permit tcp host 2001:db8:2000:2::2 host 2001:db8:2000:ab::2 + # + # after: + # - acls: + # - aces: + # - remark: Replaced ACE + # sequence: 10 + # - destination: + # any: true + # grant: permit + # protocol: pim + # sequence: 20 + # source: + # any: true + # name: ACL1v6 + # - name: ACL2v6 + # afi: ipv6 + + # After state: + # --------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ipv6 access-list ACL1v6 + # 10 remark Replaced ACE + # 20 permit pim any any + # ipv6 access-list ACL2v6 + + # Using overridden + + # Before state: + # ---------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 10 permit ip any any + # 20 deny udp any any + # ip access-list ACL2v4 + # 10 permit ahp 192.0.2.0 0.0.0.255 any + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ipv6 access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + - name: Override existing configuration with provided configuration + cisco.nxos.nxos_acls: + config: + - afi: ipv4 + acls: + - name: NewACL + aces: + - grant: deny + source: + address: 192.0.2.0 + wildcard_bits: 0.0.255.255 + destination: + any: true + protocol: eigrp + - remark: Example for overridden state + state: overridden + + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ipv6 access-list ACL1v6 + # - no ipv6 access-list ACL2v6 + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # - ip access-list NewACL + # - deny eigrp 192.0.2.0 0.0.255.255 any + # - remark Example for overridden state + # + # after: + # - acls: + # - aces: + # - destination: + # any: true + # grant: deny + # protocol: eigrp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.255.255 + # - remark: Example for overridden state + # sequence: 20 + # name: NewACL + # afi: ipv4 + + # After state: + # ------------ + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list NewACL + # 10 deny eigrp 192.0.2.0 0.0.255.255 any + # 20 remark Example for overridden state + + # Using deleted - delete all + # + # Before state: + # ------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 10 permit ip any any + # 20 deny udp any any + # ip access-list ACL2v4 + # 10 permit ahp 192.0.2.0 0.0.0.255 any + # ip access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ip access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + - name: Delete all ACLs + cisco.nxos.nxos_acls: + state: deleted + + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # - no ipv6 access-list ACL1v6 + # - no ipv6 access-list ACL2v6 + # + # after: [] + + + # After state: + # ----------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # + + # Using deleted - delete AFI + + # Before state: + # ------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 10 permit ip any any + # 20 deny udp any any + # ip access-list ACL2v4 + # 10 permit ahp 192.0.2.0 0.0.0.255 any + # ip access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ip access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + - name: Delete all ACLs in given AFI + cisco.nxos.nxos_acls: + config: + - afi: ipv4 + state: deleted + + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # + # after: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + + # After state: + # ------------ + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ip access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + # Using deleted - delete ACLs + + # Before state: + # ------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 10 permit ip any any + # 20 deny udp any any + # ip access-list ACL2v4 + # 10 permit ahp 192.0.2.0 0.0.0.255 any + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ipv6 access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + - name: Delete specific ACLs + cisco.nxos.nxos_acls: + state: deleted + config: + - afi: ipv4 + acls: + - name: ACL1v4 + - name: ACL2v4 + - afi: ipv6 + acls: + - name: ACL1v6 + + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # - no ipv6 access-list ACL1v6 + # + # after: + # - acls: + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + + # After state: + # ------------ + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ipv6 access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + # Using parsed + + - name: Parse given config to structured data + cisco.nxos.nxos_acls: + running_config: | + ip access-list ACL1v4 + 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + ipv6 access-list ACL1v6 + 10 permit sctp any any + state: parsed + + # Task Output + # ------------ + # + # parsed: + # - afi: ipv4 + # acls: + # - name: ACL1v4 + # aces: + # - grant: deny + # destination: + # address: 192.0.2.64 + # wildcard_bits: 0.0.0.255 + # source: + # any: true + # port_protocol: + # lt: 55 + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # fin: true + # sequence: 50 + # + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # aces: + # - grant: permit + # sequence: 10 + # source: + # any: true + # destination: + # prefix: 2001:db8:12::/32 + # protocol: sctp + + + # Using gathered: + + # Before state: + # ------------ + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + + - name: Gather existing configuration + cisco.nxos.nxos_acls: + state: gathered + + # Task Output + # ----------- + # + # gathered: + # - afi: ipv4 + # acls: + # - name: ACL1v4 + # aces: + # - grant: deny + # destination: + # address: 192.0.2.64 + # wildcard_bits: 0.0.0.255 + # source: + # any: true + # port_protocol: + # lt: 55 + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # fin: true + # sequence: 50 + + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # aces: + # - grant: permit + # sequence: 10 + # source: + # any: true + # destination: + # prefix: 2001:db8:12::/32 + # protocol: sctp + + + # Using rendered + + - name: Render required configuration to be pushed to the device + cisco.nxos.nxos_acls: + config: + - afi: ipv4 + acls: + - name: ACL1v4 + aces: + - grant: deny + destination: + address: 192.0.2.64 + wildcard_bits: 0.0.0.255 + source: + any: true + port_protocol: + lt: 55 + protocol: tcp + protocol_options: + tcp: + ack: true + fin: true + sequence: 50 + - afi: ipv6 + acls: + - name: ACL1v6 + aces: + - grant: permit + sequence: 10 + source: + any: true + destination: + prefix: '2001:db8:12::/32' + protocol: sctp + state: rendered + + + # Task Output + # ----------- + # + # rendered: + # ip access-list ACL1v4 + # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['ip access-list ACL1v4', '10 permit ip any any precedence critical log', '20 deny tcp any lt smtp host 192.0.2.64 ack fin']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['ip access-list ACL1v4', '10 permit ip any any precedence critical log', '20 deny tcp any lt smtp host 192.0.2.64 ack fin']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_banner_module.rst b/docs/cisco.nxos.nxos_banner_module.rst new file mode 100644 index 000000000..7502173b7 --- /dev/null +++ b/docs/cisco.nxos.nxos_banner_module.rst @@ -0,0 +1,187 @@ +.. _cisco.nxos.nxos_banner_module: + + +********************** +cisco.nxos.nxos_banner +********************** + +**Manage multiline banners on Cisco NXOS devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This will configure both exec and motd banners on remote devices running Cisco NXOS. It allows playbooks to add or remove banner text from the active running configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ banner + +
+ string + / required +
+ 		+
    Choices: +
  • exec
    • +
  • motd
    • +
+ 		+
Specifies which banner that should be configured on the remote device.
+
+
+ multiline_delimiter + +
+ string +
+ 		+ Default:
"@"
+ 		+
Specify the delimiting character than will be used for configuration.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specifies whether or not the configuration is present in the current devices active running configuration.
+
+
+ text + +
+ string +
+ 		+ +
The banner text that should be present in the remote device running configuration. This argument accepts a multiline string, with no empty lines. Requires state=present.
+
+
+ + +Notes +----- + +.. note:: + - Since responses from the device are always read with surrounding whitespaces stripped, tasks that configure banners with preceeding or trailing whitespaces will not be idempotent. + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: configure the exec banner + cisco.nxos.nxos_banner: + banner: exec + text: | + this is my exec banner + that contains a multiline + string + state: present + - name: remove the motd banner + cisco.nxos.nxos_banner: + banner: motd + state: absent + - name: Configure banner from file + cisco.nxos.nxos_banner: + banner: motd + text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}" + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['banner exec', 'this is my exec banner', 'that contains a multiline', 'string']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_bfd_global_module.rst b/docs/cisco.nxos.nxos_bfd_global_module.rst new file mode 100644 index 000000000..8cd86ec48 --- /dev/null +++ b/docs/cisco.nxos.nxos_bfd_global_module.rst @@ -0,0 +1,326 @@ +.. _cisco.nxos.nxos_bfd_global_module: + + +************************** +cisco.nxos.nxos_bfd_global +************************** + +**Bidirectional Forwarding Detection (BFD) global-level configuration** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages Bidirectional Forwarding Detection (BFD) global-level configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ echo_interface + +
+ string +
+ 		+ +
Loopback interface used for echo frames.
+
Valid values are loopback interface name or 'deleted'.
+
Not supported on N5K/N6K
+
+
+ echo_rx_interval + +
+ integer +
+ 		+ +
BFD Echo receive interval in milliseconds.
+
+
+ fabricpath_interval + +
+ dictionary +
+ 		+ +
BFD fabricpath interval timer values.
+
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
+
+
+ fabricpath_slow_timer + +
+ integer +
+ 		+ +
BFD fabricpath slow rate timer in milliseconds.
+
+
+ fabricpath_vlan + +
+ integer +
+ 		+ +
BFD fabricpath control vlan.
+
+
+ interval + +
+ dictionary +
+ 		+ +
BFD interval timer values.
+
Value must be a dict defining values for keys (tx, min_rx, and multiplier)
+
+
+ ipv4_echo_rx_interval + +
+ integer +
+ 		+ +
BFD IPv4 session echo receive interval in milliseconds.
+
+
+ ipv4_interval + +
+ dictionary +
+ 		+ +
BFD IPv4 interval timer values.
+
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
+
+
+ ipv4_slow_timer + +
+ integer +
+ 		+ +
BFD IPv4 slow rate timer in milliseconds.
+
+
+ ipv6_echo_rx_interval + +
+ integer +
+ 		+ +
BFD IPv6 session echo receive interval in milliseconds.
+
+
+ ipv6_interval + +
+ dictionary +
+ 		+ +
BFD IPv6 interval timer values.
+
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
+
+
+ ipv6_slow_timer + +
+ integer +
+ 		+ +
BFD IPv6 slow rate timer in milliseconds.
+
+
+ slow_timer + +
+ integer +
+ 		+ +
BFD slow rate timer in milliseconds.
+
+
+ startup_timer + +
+ integer +
+ 		+ +
BFD delayed startup timer in seconds.
+
Not supported on N5K/N6K/N7K
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 9.2(2) + - Unsupported for Cisco MDS + - BFD global will automatically enable 'feature bfd' if it is disabled. + - BFD global does not have a 'state' parameter. All of the BFD commands are unique and are defined if 'feature bfd' is enabled. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_bfd_global: + echo_interface: Ethernet1/2 + echo_rx_interval: 50 + interval: + tx: 50 + min_rx: 50 + multiplier: 4 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ cmds + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['bfd echo-interface loopback1', 'bfd slow-timer 2000']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_bfd_interfaces_module.rst b/docs/cisco.nxos.nxos_bfd_interfaces_module.rst new file mode 100644 index 000000000..975de891c --- /dev/null +++ b/docs/cisco.nxos.nxos_bfd_interfaces_module.rst @@ -0,0 +1,394 @@ +.. _cisco.nxos.nxos_bfd_interfaces_module: + + +****************************** +cisco.nxos.nxos_bfd_interfaces +****************************** + +**BFD interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages attributes of Bidirectional Forwarding Detection (BFD) on the interface. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
The provided configuration
+
+
+ bfd + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/Disable Bidirectional Forwarding Detection (BFD) on the interface.
+
+
+ echo + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/Disable BFD Echo functionality on the interface.
+
+
+ name + +
+ string +
+ 		+ +
The name of the interface.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface|^feature bfd'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state of the configuration after module completion
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 7.0(3)I5(1). + - Unsupported for Cisco MDS + - Feature bfd should be enabled for this module. + + + +Examples +-------- + +.. code-block:: yaml + + # Using deleted + + - name: Configure interfaces + cisco.nxos.nxos_bfd_interfaces: + state: deleted + + + # Using merged + + - name: Configure interfaces + cisco.nxos.nxos_bfd_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + echo: enable + - name: Ethernet1/2 + bfd: disable + echo: disable + state: merged + + + # Using overridden + + - name: Configure interfaces + cisco.nxos.nxos_bfd_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + echo: enable + - name: Ethernet1/2 + bfd: disable + echo: disable + state: overridden + + + # Using replaced + + - name: Configure interfaces + cisco.nxos.nxos_bfd_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + echo: enable + - name: Ethernet1/2 + bfd: disable + echo: disable + state: replaced + + # Using rendered + + - name: Use rendered state to convert task input to device specific commands + cisco.nxos.nxos_bfd_interfaces: + config: + - name: Ethernet1/800 + bfd: enable + echo: enable + - name: Ethernet1/801 + bfd: disable + echo: disable + state: rendered + + # Task Output (redacted) + # ----------------------- + + # rendered: + # - "interface Ethernet1/800" + # - "bfd" + # - "bfd echo" + # - "interface Ethernet1/801" + # - "no bfd" + # - "no bfd echo" + + # Using parsed + + # parsed.cfg + # ------------ + + # feature bfd + # interface Ethernet1/800 + # no switchport + # no bfd + # no bfd echo + # interface Ethernet1/801 + # no switchport + # no bfd + # interface Ethernet1/802 + # no switchport + # no bfd echo + # interface mgmt0 + # ip address dhcp + # vrf member management + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_bfd_interfaces: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + + # parsed: + # - bfd: disable + # echo: disable + # name: Ethernet1/800 + # - bfd: disable + # echo: enable + # name: Ethernet1/801 + # - bfd: enable + # echo: disable + # name: Ethernet1/802 + # - bfd: enable + # echo: enable + # name: mgmt0 + + # Using gathered + + # Existing device config state + # ------------------------------- + + # feature bfd + # interface Ethernet1/1 + # no switchport + # no bfd + # interface Ethernet1/2 + # no switchport + # no bfd echo + # interface mgmt0 + # ip address dhcp + # vrf member management + + - name: Gather bfd_interfaces facts from the device using nxos_bfd_interfaces + cisco.nxos.nxos_bfd_interfaces: + state: gathered + + # Task output (redacted) + # ----------------------- + # gathered: + # - name: Ethernet1/1 + # bfd: disable + # echo: enable + # - name: Ethernet1/3 + # echo: disable + # bfd: enable + # - name: mgmt0 + # bfd: enable + # echo: enable + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/1', 'no bfd', 'no bfd echo']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_bgp_global_module.rst b/docs/cisco.nxos.nxos_bgp_global_module.rst new file mode 100644 index 000000000..19ee2709e --- /dev/null +++ b/docs/cisco.nxos.nxos_bgp_global_module.rst @@ -0,0 +1,5843 @@ +.. _cisco.nxos.nxos_bgp_global_module: + + +************************** +cisco.nxos.nxos_bgp_global +************************** + +**BGP Global resource module.** + + +Version added: 1.4.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages global BGP configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A list of BGP process configuration.
+
+
+ affinity_group + +
+ dictionary +
+ 		+ +
Configure an affinity group.
+
+
+ group_id + +
+ integer +
+ 		+ +
Affinity Group ID.
+
+
+ as_number + +
+ string +
+ 		+ +
Autonomous System Number of the router.
+
+
+ bestpath + +
+ dictionary +
+ 		+ +
Define the default bestpath selection algorithm.
+
+
+ always_compare_med + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare MED on paths from different AS.
+
+
+ as_path + +
+ dictionary +
+ 		+ +
AS-Path.
+
+
+ ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore AS-Path during bestpath selection.
+
+
+ multipath_relax + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Relax AS-Path restriction when choosing multipaths.
+
+
+ compare_neighborid + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
When more paths are available than max path config, use neighborid as tie-breaker.
+
+
+ compare_routerid + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare router-id for identical EBGP paths.
+
+
+ cost_community_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore cost communities in bestpath selection.
+
+
+ igp_metric_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore IGP metric for next-hop during bestpath selection.
+
+
+ med + +
+ dictionary +
+ 		+ +
MED
+
+
+ confed + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare MED only from paths originated from within a confederation.
+
+
+ missing_as_worst + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Treat missing MED as highest MED.
+
+
+ non_deterministic + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Not always pick the best-MED path among paths from same AS.
+
+
+ cluster_id + +
+ string +
+ 		+ +
Configure Route Reflector Cluster-ID.
+
+
+ confederation + +
+ dictionary +
+ 		+ +
AS confederation parameters.
+
+
+ identifier + +
+ string +
+ 		+ +
Set routing domain confederation AS.
+
+
+ peers + +
+ list + / elements=string +
+ 		+ +
Peer ASs in BGP confederation.
+
+
+ disable_policy_batching + +
+ dictionary +
+ 		+ +
Disable batching evaluation of outbound policy for a peer.
+
+
+ ipv4 + +
+ dictionary +
+ 		+ +
IPv4 address-family settings.
+
+
+ prefix_list + +
+ string +
+ 		+ +
Name of prefix-list to apply.
+
+
+ ipv6 + +
+ dictionary +
+ 		+ +
IPv6 address-family settings.
+
+
+ prefix_list + +
+ string +
+ 		+ +
Name of prefix-list to apply.
+
+
+ nexthop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Batching based on nexthop.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set policy batching.
+
+
+ dynamic_med_interval + +
+ integer +
+ 		+ +
Sets the interval for dampening of med changes.
+
+
+ enforce_first_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enforce neighbor AS is the first AS in AS-PATH attribute (EBGP).
+
+
+ enhanced_error + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable BGP Enhanced error handling.
+
+
+ fabric_soo + +
+ string +
+ 		+ +
Fabric site of origin.
+
+
+ fast_external_fallover + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Immediately reset the session if the link to a directly connected BGP peer goes down.
+
+
+ flush_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Flush routes in RIB upon controlled restart.
+
+
+ graceful_restart + +
+ dictionary +
+ 		+ +
Configure Graceful Restart functionality.
+
+
+ helper + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure Graceful Restart Helper mode functionality.
+
+
+ restart_time + +
+ integer +
+ 		+ +
Maximum time for restart advertised to peers.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable graceful-restart.
+
+
+ stalepath_time + +
+ integer +
+ 		+ +
Maximum time to keep a restarting peer's stale routes.
+
+
+ graceful_shutdown + +
+ dictionary +
+ 		+ +
Graceful-shutdown for BGP protocol.
+
+
+ activate + +
+ dictionary +
+ 		+ +
Send graceful-shutdown community on all routes.
+
+
+ route_map + +
+ string +
+ 		+ +
Apply route-map to modify attributes for outbound.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Activiate graceful-shutdown.
+
+
+ aware + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Lower preference of routes carrying graceful-shutdown community.
+
+
+ isolate + +
+ dictionary +
+ 		+ +
Isolate this router from BGP perspective.
+
+
+ include_local + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Withdraw both local and remote BGP routes.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Withdraw remote BGP routes to isolate this router.
+
+
+ log_neighbor_changes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log a message for neighbor up/down event.
+
+
+ maxas_limit + +
+ integer +
+ 		+ +
Allow AS-PATH attribute from EBGP neighbor imposing a limit on number of ASes.
+
+
+ neighbor_down + +
+ dictionary +
+ 		+ +
Handle BGP neighbor down event, due to various reasons.
+
+
+ fib_accelerate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor.
+
+
+ neighbors + +
+ list + / elements=dictionary +
+ 		+ +
Configure BGP neighbors.
+
+
+ bfd + +
+ dictionary +
+ 		+ +
Bidirectional Fast Detection for the neighbor.
+
+
+ multihop + +
+ dictionary +
+ 		+ +
Multihop session.
+
+
+ interval + +
+ dictionary +
+ 		+ +
Configure BFD session interval parameters.
+
+
+ min_rx_interval + +
+ integer +
+ 		+ +
Minimum RX interval.
+
+
+ multiplier + +
+ integer +
+ 		+ +
Detect Multiplier.
+
+
+ tx_interval + +
+ integer +
+ 		+ +
TX interval in milliseconds.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD multihop.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD for this neighbor.
+
+
+ singlehop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Single-hop session.
+
+
+ bmp_activate_server + +
+ integer +
+ 		+ +
Specify server ID for activating BMP monitoring for the peer.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Capability.
+
+
+ suppress_4_byte_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress 4-byte AS Capability.
+
+
+ description + +
+ string +
+ 		+ +
Neighbor specific descripion.
+
+
+ disable_connected_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable check for directly connected peer.
+
+
+ dont_capability_negotiate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Don't negotiate capability with this neighbor.
+
+
+ dscp + +
+ string +
+ 		+ +
Set dscp value for tcp transport.
+
+
+ dynamic_capability + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Dynamic Capability
+
+
+ ebgp_multihop + +
+ integer +
+ 		+ +
Specify multihop TTL for remote peer.
+
+
+ graceful_shutdown + +
+ dictionary +
+ 		+ +
Graceful-shutdown for this neighbor.
+
+
+ activate + +
+ dictionary +
+ 		+ +
Send graceful-shutdown community.
+
+
+ route_map + +
+ string +
+ 		+ +
Apply route-map to modify attributes for outbound.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set activate.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a template.
+
+
+ peer + +
+ string +
+ 		+ +
Peer template to inherit.
+
+
+ peer_session + +
+ string +
+ 		+ +
Peer-session template to inherit.
+
+
+ local_as + +
+ string +
+ 		+ +
Specify the local-as number for the eBGP neighbor.
+
+
+ log_neighbor_changes + +
+ dictionary +
+ 		+ +
Log message for neighbor up/down event.
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable logging of neighbor up/down event.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set log-neighbor-changes.
+
+
+ low_memory + +
+ dictionary +
+ 		+ +
Behaviour in low memory situations.
+
+
+ exempt + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not shutdown this peer when under memory pressure.
+
+
+ neighbor_address + +
+ string + / required +
+ 		+ +
IP address/Prefix of the neighbor or interface.
+
+
+ neighbor_affinity_group + +
+ dictionary +
+ 		+ +
Configure an affinity group.
+
+
+ group_id + +
+ integer +
+ 		+ +
Affinity Group ID.
+
+
+ password + +
+ dictionary +
+ 		+ +
Configure a password for neighbor.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 specifies an UNENCRYPTED neighbor password.
+
3 specifies an 3DES ENCRYPTED neighbor password will follow.
+
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
+
+
+ key + +
+ string +
+ 		+ +
Authentication password.
+
+
+ path_attribute + +
+ list + / elements=dictionary +
+ 		+ +
BGP path attribute optional filtering.
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • discard
    • +
  • treat-as-withdraw
    • +
+ 		+
Action.
+
+
+ range + +
+ dictionary +
+ 		+ +
Path attribute range.
+
+
+ end + +
+ integer +
+ 		+ +
Path attribute range end value.
+
+
+ start + +
+ integer +
+ 		+ +
Path attribute range start value.
+
+
+ type + +
+ integer +
+ 		+ +
Path attribute type
+
+
+ peer_type + +
+ string +
+ 		+
    Choices: +
  • fabric-border-leaf
    • +
  • fabric-external
    • +
+ 		+
Neighbor facing
+
+
+ remote_as + +
+ string +
+ 		+ +
Specify Autonomous System Number of the neighbor.
+
+
+ remote_as_route_map + +
+ string +
+ 		+ +
Route-map to match prefix peer AS number.
+
+
+ remove_private_as + +
+ dictionary +
+ 		+ +
Remove private AS number from outbound updates.
+
+
+ all + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All.
+
+
+ replace_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Replace.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Remove private AS.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown this neighbor.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure keepalive and hold timers.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Holdtime (seconds).
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval (seconds).
+
+
+ transport + +
+ dictionary +
+ 		+ +
BGP transport connection.
+
+
+ connection_mode + +
+ dictionary +
+ 		+ +
Specify type of connection.
+
+
+ passive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Allow passive connection setup only.
+
+
+ ttl_security + +
+ dictionary +
+ 		+ +
Enable TTL Security Mechanism.
+
+
+ hops + +
+ integer +
+ 		+ +
Specify hop count for remote peer.
+
+
+ update_source + +
+ string +
+ 		+ +
Specify source of BGP session and updates.
+
+
+ nexthop + +
+ dictionary +
+ 		+ +
Nexthop resolution options.
+
+
+ suppress_default_resolution + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Prohibit use of default route for nexthop address resolution.
+
+
+ rd + +
+ dictionary +
+ 		+ +
Secondary Route Distinguisher for vxlan multisite border gateway.
+
+
+ dual + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Generate Secondary RD for all VRFs and L2VNIs.
+
+
+ id + +
+ integer +
+ 		+ +
Specify 2 byte value for ID.
+
+
+ reconnect_interval + +
+ integer +
+ 		+ +
Configure connection reconnect interval.
+
+
+ router_id + +
+ string +
+ 		+ +
Specify the IP address to use as router-id.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown BGP protocol.
+
+
+ suppress_fib_pending + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise only routes that are programmed in hardware to peers.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure bgp related timers.
+
+
+ bestpath_limit + +
+ dictionary +
+ 		+ +
Configure timeout for first bestpath after restart.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure update-delay-always option.
+
+
+ timeout + +
+ integer +
+ 		+ +
Bestpath timeout (seconds).
+
+
+ bgp + +
+ dictionary +
+ 		+ +
Configure different bgp keepalive and holdtimes.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Holdtime (seconds).
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval (seconds).
+
+
+ prefix_peer_timeout + +
+ integer +
+ 		+ +
Prefix Peer timeout (seconds).
+
+
+ prefix_peer_wait + +
+ integer +
+ 		+ +
Configure wait timer for a prefix peer.
+
+
+ vrfs + +
+ list + / elements=dictionary +
+ 		+ +
Virtual Router Context configurations.
+
+
+ allocate_index + +
+ integer +
+ 		+ +
Configure allocate-index.
+
+
+ bestpath + +
+ dictionary +
+ 		+ +
Define the default bestpath selection algorithm.
+
+
+ always_compare_med + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare MED on paths from different AS.
+
+
+ as_path + +
+ dictionary +
+ 		+ +
AS-Path.
+
+
+ ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore AS-Path during bestpath selection.
+
+
+ multipath_relax + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Relax AS-Path restriction when choosing multipaths.
+
+
+ compare_neighborid + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
When more paths are available than max path config, use neighborid as tie-breaker.
+
+
+ compare_routerid + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare router-id for identical EBGP paths.
+
+
+ cost_community_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore cost communities in bestpath selection.
+
+
+ igp_metric_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore IGP metric for next-hop during bestpath selection.
+
+
+ med + +
+ dictionary +
+ 		+ +
MED
+
+
+ confed + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare MED only from paths originated from within a confederation.
+
+
+ missing_as_worst + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Treat missing MED as highest MED.
+
+
+ non_deterministic + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Not always pick the best-MED path among paths from same AS.
+
+
+ cluster_id + +
+ string +
+ 		+ +
Configure Route Reflector Cluster-ID.
+
+
+ confederation + +
+ dictionary +
+ 		+ +
AS confederation parameters.
+
+
+ identifier + +
+ string +
+ 		+ +
Set routing domain confederation AS.
+
+
+ peers + +
+ list + / elements=string +
+ 		+ +
Peer ASs in BGP confederation.
+
+
+ graceful_restart + +
+ dictionary +
+ 		+ +
Configure Graceful Restart functionality.
+
+
+ helper + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure Graceful Restart Helper mode functionality.
+
+
+ restart_time + +
+ integer +
+ 		+ +
Maximum time for restart advertised to peers.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable graceful-restart.
+
+
+ stalepath_time + +
+ integer +
+ 		+ +
Maximum time to keep a restarting peer's stale routes.
+
+
+ local_as + +
+ string +
+ 		+ +
Specify the local-as for this vrf.
+
+
+ log_neighbor_changes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log a message for neighbor up/down event.
+
+
+ maxas_limit + +
+ integer +
+ 		+ +
Allow AS-PATH attribute from EBGP neighbor imposing a limit on number of ASes.
+
+
+ neighbor_down + +
+ dictionary +
+ 		+ +
Handle BGP neighbor down event, due to various reasons.
+
+
+ fib_accelerate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor.
+
+
+ neighbors + +
+ list + / elements=dictionary +
+ 		+ +
Configure BGP neighbors.
+
+
+ bfd + +
+ dictionary +
+ 		+ +
Bidirectional Fast Detection for the neighbor.
+
+
+ multihop + +
+ dictionary +
+ 		+ +
Multihop session.
+
+
+ interval + +
+ dictionary +
+ 		+ +
Configure BFD session interval parameters.
+
+
+ min_rx_interval + +
+ integer +
+ 		+ +
Minimum RX interval.
+
+
+ multiplier + +
+ integer +
+ 		+ +
Detect Multiplier.
+
+
+ tx_interval + +
+ integer +
+ 		+ +
TX interval in milliseconds.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD multihop.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD for this neighbor.
+
+
+ singlehop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Single-hop session.
+
+
+ bmp_activate_server + +
+ integer +
+ 		+ +
Specify server ID for activating BMP monitoring for the peer.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Capability.
+
+
+ suppress_4_byte_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress 4-byte AS Capability.
+
+
+ description + +
+ string +
+ 		+ +
Neighbor specific descripion.
+
+
+ disable_connected_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable check for directly connected peer.
+
+
+ dont_capability_negotiate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Don't negotiate capability with this neighbor.
+
+
+ dscp + +
+ string +
+ 		+ +
Set dscp value for tcp transport.
+
+
+ dynamic_capability + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Dynamic Capability
+
+
+ ebgp_multihop + +
+ integer +
+ 		+ +
Specify multihop TTL for remote peer.
+
+
+ graceful_shutdown + +
+ dictionary +
+ 		+ +
Graceful-shutdown for this neighbor.
+
+
+ activate + +
+ dictionary +
+ 		+ +
Send graceful-shutdown community.
+
+
+ route_map + +
+ string +
+ 		+ +
Apply route-map to modify attributes for outbound.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set activate.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a template.
+
+
+ peer + +
+ string +
+ 		+ +
Peer template to inherit.
+
+
+ peer_session + +
+ string +
+ 		+ +
Peer-session template to inherit.
+
+
+ local_as + +
+ string +
+ 		+ +
Specify the local-as number for the eBGP neighbor.
+
+
+ log_neighbor_changes + +
+ dictionary +
+ 		+ +
Log message for neighbor up/down event.
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable logging of neighbor up/down event.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set log-neighbor-changes.
+
+
+ low_memory + +
+ dictionary +
+ 		+ +
Behaviour in low memory situations.
+
+
+ exempt + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not shutdown this peer when under memory pressure.
+
+
+ neighbor_address + +
+ string + / required +
+ 		+ +
IP address/Prefix of the neighbor or interface.
+
+
+ neighbor_affinity_group + +
+ dictionary +
+ 		+ +
Configure an affinity group.
+
+
+ group_id + +
+ integer +
+ 		+ +
Affinity Group ID.
+
+
+ password + +
+ dictionary +
+ 		+ +
Configure a password for neighbor.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 specifies an UNENCRYPTED neighbor password.
+
3 specifies an 3DES ENCRYPTED neighbor password will follow.
+
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
+
+
+ key + +
+ string +
+ 		+ +
Authentication password.
+
+
+ path_attribute + +
+ list + / elements=dictionary +
+ 		+ +
BGP path attribute optional filtering.
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • discard
    • +
  • treat-as-withdraw
    • +
+ 		+
Action.
+
+
+ range + +
+ dictionary +
+ 		+ +
Path attribute range.
+
+
+ end + +
+ integer +
+ 		+ +
Path attribute range end value.
+
+
+ start + +
+ integer +
+ 		+ +
Path attribute range start value.
+
+
+ type + +
+ integer +
+ 		+ +
Path attribute type
+
+
+ peer_type + +
+ string +
+ 		+
    Choices: +
  • fabric-border-leaf
    • +
  • fabric-external
    • +
+ 		+
Neighbor facing
+
+
+ remote_as + +
+ string +
+ 		+ +
Specify Autonomous System Number of the neighbor.
+
+
+ remote_as_route_map + +
+ string +
+ 		+ +
Route-map to match prefix peer AS number.
+
+
+ remove_private_as + +
+ dictionary +
+ 		+ +
Remove private AS number from outbound updates.
+
+
+ all + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All.
+
+
+ replace_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Replace.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Remove private AS.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown this neighbor.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure keepalive and hold timers.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Holdtime (seconds).
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval (seconds).
+
+
+ transport + +
+ dictionary +
+ 		+ +
BGP transport connection.
+
+
+ connection_mode + +
+ dictionary +
+ 		+ +
Specify type of connection.
+
+
+ passive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Allow passive connection setup only.
+
+
+ ttl_security + +
+ dictionary +
+ 		+ +
Enable TTL Security Mechanism.
+
+
+ hops + +
+ integer +
+ 		+ +
Specify hop count for remote peer.
+
+
+ update_source + +
+ string +
+ 		+ +
Specify source of BGP session and updates.
+
+
+ reconnect_interval + +
+ integer +
+ 		+ +
Configure connection reconnect interval.
+
+
+ router_id + +
+ string +
+ 		+ +
Specify the IP address to use as router-id.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure bgp related timers.
+
+
+ bestpath_limit + +
+ dictionary +
+ 		+ +
Configure timeout for first bestpath after restart.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure update-delay-always option.
+
+
+ timeout + +
+ integer +
+ 		+ +
Bestpath timeout (seconds).
+
+
+ bgp + +
+ dictionary +
+ 		+ +
Configure different bgp keepalive and holdtimes.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Holdtime (seconds).
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval (seconds).
+
+
+ prefix_peer_timeout + +
+ integer +
+ 		+ +
Prefix Peer timeout (seconds).
+
+
+ prefix_peer_wait + +
+ integer +
+ 		+ +
Configure wait timer for a prefix peer.
+
+
+ vrf + +
+ string +
+ 		+ +
VRF name.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^router bgp'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • purged
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
State purged removes all the BGP configurations from the target device. Use caution with this state.
+
State deleted only removes BGP attributes that this modules manages and does not negate the BGP process completely. Thereby, preserving address-family related configurations under BGP context.
+
Running states deleted and replaced will result in an error if there are address-family configuration lines present under a neighbor, or a vrf context that is to be removed. Please use the cisco.nxos.nxos_bgp_af or cisco.nxos.nxos_bgp_neighbor_af modules for prior cleanup.
+
States merged and replaced will result in a failure if BGP is already configured with a different ASN than what is provided in the task. In such cases, please use state purged to remove the existing BGP process and proceed further.
+
States replaced and overridden have the same behaviour for this module.
+
Refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # Nexus9000v# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_bgp_global: + config: + as_number: 65563 + router_id: 192.168.1.1 + bestpath: + as_path: + multipath_relax: true + compare_neighborid: true + cost_community_ignore: true + confederation: + identifier: 42 + peers: + - 65020 + - 65030 + - 65040 + log_neighbor_changes: true + maxas_limit: 20 + neighbors: + - neighbor_address: 192.168.1.100 + neighbor_affinity_group: + group_id: 160 + bmp_activate_server: 1 + remote_as: 65563 + description: NBR-1 + low_memory: + exempt: true + - neighbor_address: 192.168.1.101 + remote_as: 65563 + password: + encryption: 7 + key: 12090404011C03162E + neighbor_down: + fib_accelerate: true + vrfs: + - vrf: site-1 + allocate_index: 5000 + local_as: 200 + log_neighbor_changes: true + neighbors: + - neighbor_address: 198.51.100.1 + description: site-1-nbr-1 + password: + encryption: 3 + key: 13D4D3549493D2877B1DC116EE27A6BE + remote_as: 65562 + - neighbor_address: 198.51.100.2 + remote_as: 65562 + description: site-1-nbr-2 + - vrf: site-2 + local_as: 300 + log_neighbor_changes: true + neighbors: + - neighbor_address: 203.0.113.2 + description: site-2-nbr-1 + password: + encryption: 3 + key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + remote_as: 65568 + neighbor_down: + fib_accelerate: true + + # Task output: + # ------------ + # before: {} + # + # commands: + # - router bgp 65563 + # - bestpath as-path multipath-relax + # - bestpath compare-neighborid + # - bestpath cost-community ignore + # - confederation identifier 42 + # - log-neighbor-changes + # - maxas-limit 20 + # - neighbor-down fib-accelerate + # - router-id 192.168.1.1 + # - confederation peers 65020 65030 65040 + # - neighbor 192.168.1.100 + # - remote-as 65563 + # - affinity-group 160 + # - bmp-activate-server 1 + # - description NBR-1 + # - low-memory exempt + # - neighbor 192.168.1.101 + # - remote-as 65563 + # - password 7 12090404011C03162E + # - vrf site-1 + # - allocate-index 5000 + # - local-as 200 + # - log-neighbor-changes + # - neighbor 198.51.100.1 + # - remote-as 65562 + # - description site-1-nbr-1 + # - password 3 13D4D3549493D2877B1DC116EE27A6BE + # - neighbor 198.51.100.2 + # - remote-as 65562 + # - description site-1-nbr-2 + # - vrf site-2 + # - local-as 300 + # - log-neighbor-changes + # - neighbor-down fib-accelerate + # - neighbor 203.0.113.2 + # - remote-as 65568 + # - description site-2-nbr-1 + # - password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + # + # after: + # as_number: '65563' + # bestpath: + # as_path: + # multipath_relax: true + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65040' + # log_neighbor_changes: true + # maxas_limit: 20 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # - neighbor_address: 192.168.1.101 + # password: + # encryption: 7 + # key: 12090404011C03162E + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - allocate_index: 5000 + # local_as: '200' + # log_neighbor_changes: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 198.51.100.1 + # password: + # encryption: 3 + # key: 13D4D3549493D2877B1DC116EE27A6BE + # remote_as: '65562' + # - description: site-1-nbr-2 + # neighbor_address: 198.51.100.2 + # remote_as: '65562' + # vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - description: site-2-nbr-1 + # neighbor_address: 203.0.113.2 + # password: + # encryption: 3 + # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + # remote_as: '65568' + # vrf: site-2 + + + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65040 + # bestpath as-path multipath-relax + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 20 + # log-neighbor-changes + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # neighbor 192.168.1.101 + # remote-as 65563 + # password 7 12090404011C03162E + # vrf site-1 + # local-as 200 + # log-neighbor-changes + # allocate-index 5000 + # neighbor 198.51.100.1 + # remote-as 65562 + # description site-1-nbr-1 + # password 3 13D4D3549493D2877B1DC116EE27A6BE + # neighbor 198.51.100.2 + # remote-as 65562 + # description site-1-nbr-2 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # remote-as 65568 + # description site-2-nbr-1 + # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + # Using replaced + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65040 + # bestpath as-path multipath-relax + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 20 + # log-neighbor-changes + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # neighbor 192.168.1.101 + # remote-as 65563 + # password 7 12090404011C03162E + # vrf site-1 + # local-as 200 + # log-neighbor-changes + # allocate-index 5000 + # neighbor 198.51.100.1 + # remote-as 65562 + # description site-1-nbr-1 + # password 3 13D4D3549493D2877B1DC116EE27A6BE + # neighbor 198.51.100.2 + # remote-as 65562 + # description site-1-nbr-2 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # remote-as 65568 + # description site-2-nbr-1 + # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + - name: Replace BGP configuration with provided configuration + cisco.nxos.nxos_bgp_global: + config: + as_number: 65563 + router_id: 192.168.1.1 + bestpath: + compare_neighborid: true + cost_community_ignore: true + confederation: + identifier: 42 + peers: + - 65020 + - 65030 + - 65050 + maxas_limit: 40 + neighbors: + - neighbor_address: 192.168.1.100 + neighbor_affinity_group: + group_id: 160 + bmp_activate_server: 1 + remote_as: 65563 + description: NBR-1 + low_memory: + exempt: true + neighbor_down: + fib_accelerate: true + vrfs: + - vrf: site-2 + local_as: 300 + log_neighbor_changes: true + neighbors: + - neighbor_address: 203.0.113.2 + password: + encryption: 7 + key: 12090404011C03162E + neighbor_down: + fib_accelerate: true + state: replaced + + # Task output: + # ------------ + # before: + # as_number: '65563' + # bestpath: + # as_path: + # multipath_relax: true + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65040' + # log_neighbor_changes: true + # maxas_limit: 20 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # - neighbor_address: 192.168.1.101 + # password: + # encryption: 7 + # key: 12090404011C03162E + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - allocate_index: 5000 + # local_as: '200' + # log_neighbor_changes: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 198.51.100.1 + # password: + # encryption: 3 + # key: 13D4D3549493D2877B1DC116EE27A6BE + # remote_as: '65562' + # - description: site-1-nbr-2 + # neighbor_address: 198.51.100.2 + # remote_as: '65562' + # vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - description: site-2-nbr-1 + # neighbor_address: 203.0.113.2 + # password: + # encryption: 3 + # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + # remote_as: '65568' + # vrf: site-2 + # + # commands: + # - router bgp 65563 + # - no bestpath as-path multipath-relax + # - no log-neighbor-changes + # - maxas-limit 40 + # - no confederation peers 65020 65030 65040 + # - confederation peers 65020 65030 65050 + # - no neighbor 192.168.1.101 + # - vrf site-2 + # - neighbor 203.0.113.2 + # - no remote-as 65568 + # - no description site-2-nbr-1 + # - password 7 12090404011C03162E + # - no vrf site-1 + + # after: + # as_number: '65563' + # bestpath: + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65050' + # maxas_limit: 40 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - neighbor_address: 203.0.113.2 + # password: + # encryption: 7 + # key: 12090404011C03162E + # vrf: site-2 + # + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65050 + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 40 + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # password 7 12090404011C03162E + + # Using deleted + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65040 + # bestpath as-path multipath-relax + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 20 + # log-neighbor-changes + # address-family ipv4 unicast + # default-metric 400 + # suppress-inactive + # default-information originate + # address-family ipv6 multicast + # wait-igp-convergence + # redistribute eigrp eigrp-1 route-map site-1-rmap + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # neighbor 192.168.1.101 + # remote-as 65563 + # password 7 12090404011C03162E + # vrf site-1 + # local-as 200 + # log-neighbor-changes + # allocate-index 5000 + # address-family ipv4 multicast + # maximum-paths 40 + # dampen-igp-metric 1200 + # neighbor 198.51.100.1 + # remote-as 65562 + # description site-1-nbr-1 + # password 3 13D4D3549493D2877B1DC116EE27A6BE + # neighbor 198.51.100.2 + # remote-as 65562 + # description site-1-nbr-2 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # remote-as 65568 + # description site-1-nbr-1 + # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + - name: Delete BGP configurations handled by this module + cisco.nxos.nxos_bgp_global: + state: deleted + + # Task output: + # ------------ + + # before: + # as_number: '65563' + # bestpath: + # as_path: + # multipath_relax: true + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65040' + # log_neighbor_changes: true + # maxas_limit: 20 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # - neighbor_address: 192.168.1.101 + # password: + # encryption: 7 + # key: 12090404011C03162E + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - allocate_index: 5000 + # local_as: '200' + # log_neighbor_changes: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 198.51.100.1 + # password: + # encryption: 3 + # key: 13D4D3549493D2877B1DC116EE27A6BE + # remote_as: '65562' + # - description: site-1-nbr-2 + # neighbor_address: 198.51.100.2 + # remote_as: '65562' + # vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 203.0.113.2 + # password: + # encryption: 3 + # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + # remote_as: '65568' + # vrf: site-2 + # + # commands: + # - router bgp 65563 + # - no bestpath as-path multipath-relax + # - no bestpath compare-neighborid + # - no bestpath cost-community ignore + # - no confederation identifier 42 + # - no log-neighbor-changes + # - no maxas-limit 20 + # - no neighbor-down fib-accelerate + # - no router-id 192.168.1.1 + # - no confederation peers 65020 65030 65040 + # - no neighbor 192.168.1.100 + # - no neighbor 192.168.1.101 + # - no vrf site-1 + # - no vrf site-2 + # + # after: + # as_number: '65563' + # + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # address-family ipv4 unicast + # default-metric 400 + # suppress-inactive + # default-information originate + # address-family ipv6 multicast + # wait-igp-convergence + # redistribute eigrp eigrp-1 route-map site-1-rmap + # + + # Using purged + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65040 + # bestpath as-path multipath-relax + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 20 + # log-neighbor-changes + # address-family ipv4 unicast + # default-metric 400 + # suppress-inactive + # default-information originate + # address-family ipv6 multicast + # wait-igp-convergence + # redistribute eigrp eigrp-1 route-map site-1-rmap + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # neighbor 192.168.1.101 + # remote-as 65563 + # password 7 12090404011C03162E + # vrf site-1 + # local-as 200 + # log-neighbor-changes + # allocate-index 5000 + # address-family ipv4 multicast + # maximum-paths 40 + # dampen-igp-metric 1200 + # neighbor 198.51.100.1 + # remote-as 65562 + # description site-1-nbr-1 + # password 3 13D4D3549493D2877B1DC116EE27A6BE + # neighbor 198.51.100.2 + # remote-as 65562 + # description site-1-nbr-2 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # remote-as 65568 + # description site-1-nbr-1 + # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + - name: Purge all BGP configurations from the device + cisco.nxos.nxos_bgp_global: + state: purged + + # Task output: + # ------------ + + # before: + # as_number: '65563' + # bestpath: + # as_path: + # multipath_relax: true + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65040' + # log_neighbor_changes: true + # maxas_limit: 20 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # - neighbor_address: 192.168.1.101 + # password: + # encryption: 7 + # key: 12090404011C03162E + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - allocate_index: 5000 + # local_as: '200' + # log_neighbor_changes: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 198.51.100.1 + # password: + # encryption: 3 + # key: 13D4D3549493D2877B1DC116EE27A6BE + # remote_as: '65562' + # - description: site-1-nbr-2 + # neighbor_address: 198.51.100.2 + # remote_as: '65562' + # vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 203.0.113.2 + # password: + # encryption: 3 + # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + # remote_as: '65568' + # vrf: site-2 + # + # commands: + # - no router bgp 65563 + # + # after: {} + # + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # Nexus9000v# + + # Using rendered + + - name: Render platform specific configuration lines (without connecting to the device) + cisco.nxos.nxos_bgp_global: + config: + as_number: 65563 + router_id: 192.168.1.1 + bestpath: + as_path: + multipath_relax: true + compare_neighborid: true + cost_community_ignore: true + confederation: + identifier: 42 + peers: + - 65020 + - 65030 + - 65040 + log_neighbor_changes: true + maxas_limit: 20 + neighbors: + - neighbor_address: 192.168.1.100 + neighbor_affinity_group: + group_id: 160 + bmp_activate_server: 1 + remote_as: 65563 + description: NBR-1 + low_memory: + exempt: true + - neighbor_address: 192.168.1.101 + remote_as: 65563 + password: + encryption: 7 + key: 12090404011C03162E + neighbor_down: + fib_accelerate: true + vrfs: + - vrf: site-1 + allocate_index: 5000 + local_as: 200 + log_neighbor_changes: true + neighbors: + - neighbor_address: 198.51.100.1 + description: site-1-nbr-1 + password: + encryption: 3 + key: 13D4D3549493D2877B1DC116EE27A6BE + remote_as: 65562 + - neighbor_address: 198.51.100.2 + remote_as: 65562 + description: site-1-nbr-2 + - vrf: site-2 + local_as: 300 + log_neighbor_changes: true + neighbors: + - neighbor_address: 203.0.113.2 + description: site-1-nbr-1 + password: + encryption: 3 + key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + remote_as: 65568 + neighbor_down: + fib_accelerate: true + + # Task output: + # ------------ + # rendered: + # - router bgp 65563 + # - bestpath as-path multipath-relax + # - bestpath compare-neighborid + # - bestpath cost-community ignore + # - confederation identifier 42 + # - log-neighbor-changes + # - maxas-limit 20 + # - neighbor-down fib-accelerate + # - router-id 192.168.1.1 + # - confederation peers 65020 65030 65040 + # - neighbor 192.168.1.100 + # - remote-as 65563 + # - affinity-group 160 + # - bmp-activate-server 1 + # - description NBR-1 + # - low-memory exempt + # - neighbor 192.168.1.101 + # - remote-as 65563 + # - password 7 12090404011C03162E + # - vrf site-1 + # - allocate-index 5000 + # - local-as 200 + # - log-neighbor-changes + # - neighbor 198.51.100.1 + # - remote-as 65562 + # - description site-1-nbr-1 + # - password 3 13D4D3549493D2877B1DC116EE27A6BE + # - neighbor 198.51.100.2 + # - remote-as 65562 + # - description site-1-nbr-2 + # - vrf site-2 + # - local-as 300 + # - log-neighbor-changes + # - neighbor-down fib-accelerate + # - neighbor 203.0.113.2 + # - remote-as 65568 + # - description site-1-nbr-1 + # - password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + # Using parsed + + # parsed.cfg + # ------------ + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65040 + # bestpath as-path multipath-relax + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 20 + # log-neighbor-changes + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # neighbor 192.168.1.101 + # remote-as 65563 + # password 7 12090404011C03162E + # vrf site-1 + # local-as 200 + # log-neighbor-changes + # allocate-index 5000 + # neighbor 198.51.100.1 + # remote-as 65562 + # description site-1-nbr-1 + # password 3 13D4D3549493D2877B1DC116EE27A6BE + # neighbor 198.51.100.2 + # remote-as 65562 + # description site-1-nbr-2 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # remote-as 65568 + # description site-1-nbr-1 + # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + - name: Parse externally provided BGP config + cisco.nxos.nxos_bgp_global: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output: + # ------------ + # parsed: + # as_number: '65563' + # bestpath: + # as_path: + # multipath_relax: true + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65040' + # log_neighbor_changes: true + # maxas_limit: 20 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # - neighbor_address: 192.168.1.101 + # password: + # encryption: 7 + # key: 12090404011C03162E + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - allocate_index: 5000 + # local_as: '200' + # log_neighbor_changes: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 198.51.100.1 + # password: + # encryption: 3 + # key: 13D4D3549493D2877B1DC116EE27A6BE + # remote_as: '65562' + # - description: site-1-nbr-2 + # neighbor_address: 198.51.100.2 + # remote_as: '65562' + # vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 203.0.113.2 + # password: + # encryption: 3 + # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + # remote_as: '65568' + # vrf: site-2 + + # Using gathered + + # existing config + # + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65050 + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 40 + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # vrf site-1 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # password 7 12090404011C03162E + + - name: Gather BGP facts using gathered + cisco.nxos.nxos_bgp_global: + state: gathered + + # Task output: + # ------------ + # gathered: + # as_number: '65563' + # bestpath: + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65050' + # maxas_limit: 40 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - neighbor_address: 203.0.113.2 + # password: + # encryption: 7 + # key: 12090404011C03162E + # vrf: site-2 + + # Remove a neighbor having AF configurations with state replaced (will fail) + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # log-neighbor-changes + # maxas-limit 20 + # router-id 198.51.100.2 + # neighbor 203.0.113.2 + # address-family ipv4 unicast + # next-hop-self + # remote-as 65538 + # affinity-group 160 + # description NBR-1 + # low-memory exempt + # neighbor 192.0.2.1 + # remote-as 65537 + # password 7 12090404011C03162E + + - name: Remove a neighbor having AF configurations (should fail) + cisco.nxos.nxos_bgp_global: + config: + as_number: 65536 + router_id: 198.51.100.2 + maxas_limit: 20 + log_neighbor_changes: true + neighbors: + - neighbor_address: 192.0.2.1 + remote_as: 65537 + password: + encryption: 7 + key: 12090404011C03162E + state: replaced + + # Task output: + # ------------ + # fatal: [Nexus9000v]: FAILED! => changed=false + # msg: Neighbor 203.0.113.2 has address-family configurations. + # Please use the nxos_bgp_neighbor_af module to remove those first. + + # Remove a VRF having AF configurations with state replaced (will fail) + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # log-neighbor-changes + # maxas-limit 20 + # router-id 198.51.100.2 + # neighbor 192.0.2.1 + # remote-as 65537 + # password 7 12090404011C03162E + # vrf site-1 + # address-family ipv4 unicast + # default-information originate + # neighbor 203.0.113.2 + # remote-as 65538 + # affinity-group 160 + # description NBR-1 + # low-memory exempt + # vrf site-2 + # neighbor-down fib-accelerate + + - name: Remove a VRF having AF configurations (should fail) + cisco.nxos.nxos_bgp_global: + config: + as_number: 65536 + router_id: 198.51.100.2 + maxas_limit: 20 + log_neighbor_changes: true + neighbors: + - neighbor_address: 192.0.2.1 + remote_as: 65537 + password: + encryption: 7 + key: 12090404011C03162E + vrfs: + - vrf: site-2 + neighbor_down: + fib_accelerate: true + state: replaced + + # Task output: + # ------------ + # fatal: [Nexus9000v]: FAILED! => changed=false + # msg: VRF site-1 has address-family configurations. + # Please use the nxos_bgp_af module to remove those first. + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['router bgp 65563', 'maxas-limit 20', 'router-id 192.168.1.1', 'confederation peers 65020 65030 65040', 'neighbor 192.168.1.100', 'remote-as 65563', 'affinity-group 160', 'bmp-activate-server 1', 'description NBR-1', 'low-memory exempt', 'vrf site-1', 'log-neighbor-changes', 'neighbor 198.51.100.1', 'remote-as 65562', 'description site-1-nbr-1', 'password 3 13D4D3549493D2877B1DC116EE27A6BE']
+
+
+ gathered + +
+ dictionary +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ dictionary +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['router bgp 65563', 'maxas-limit 20', 'router-id 192.168.1.1']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst b/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst new file mode 100644 index 000000000..8668a0b9f --- /dev/null +++ b/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst @@ -0,0 +1,3575 @@ +.. _cisco.nxos.nxos_bgp_neighbor_address_family_module: + + +******************************************* +cisco.nxos.nxos_bgp_neighbor_address_family +******************************************* + +**BGP Neighbor Address Family resource module.** + + +Version added: 2.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages BGP Neighbor Address Family configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
BGP Neighbor AF configuration.
+
+
+ as_number + +
+ string +
+ 		+ +
Autonomous System Number of the router.
+
+
+ neighbors + +
+ list + / elements=dictionary +
+ 		+ +
A list of BGP Neighbor AF configuration.
+
+
+ address_family + +
+ list + / elements=dictionary +
+ 		+ +
BGP Neighbor Address Family related configurations.
+
+
+ advertise_map + +
+ dictionary +
+ 		+ +
Specify route-map for conditional advertisement.
+
+
+ exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition exists.
+
+
+ non_exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition does not exist.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
Route-map name.
+
+
+ advertisement_interval + +
+ integer +
+ 		+ +
Minimum interval between sending BGP routing updates.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
  • link-state
    • +
  • vpnv4
    • +
  • vpnv6
    • +
  • l2vpn
    • +
+ 		+
Address Family indicator.
+
+
+ allowas_in + +
+ dictionary +
+ 		+ +
Accept as-path with my AS present in it.
+
+
+ max_occurences + +
+ integer +
+ 		+ +
Number of occurrences of AS number, default is 3.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Activate allowas-in property.
+
+
+ as_override + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Override matching AS-number while sending update.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Advertise capability to the peer.
+
+
+ additional_paths + +
+ dictionary +
+ 		+ +
Additional paths capability.
+
+
+ receive + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Receive capability.
+
+
+ send + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Send capability.
+
+
+ default_originate + +
+ dictionary +
+ 		+ +
Originate a default toward this peer.
+
+
+ route_map + +
+ string +
+ 		+ +
Route-map to specify criteria for originating default.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set default-originate attribute.
+
+
+ disable_peer_as_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable checking of peer AS-number while advertising.
+
+
+ filter_list + +
+ dictionary +
+ 		+ +
Name of filter-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a template.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence number.
+
+
+ template + +
+ string +
+ 		+ +
Template name.
+
+
+ maximum_prefix + +
+ dictionary +
+ 		+ +
Maximum number of prefixes from this neighbor.
+
+
+ generate_warning_threshold + +
+ integer +
+ 		+ +
Threshold percentage at which to generate a warning.
+
+
+ max_prefix_limit + +
+ integer +
+ 		+ +
Maximum prefix limit.
+
+
+ restart_interval + +
+ integer +
+ 		+ +
Restart bgp connection after limit is exceeded.
+
+
+ warning_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Only give a warning message when limit is exceeded.
+
+
+ next_hop_self + +
+ dictionary +
+ 		+ +
Set our address as nexthop (non-reflected).
+
+
+ all_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set our address as nexthop for all routes.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set next-hop-self attribute.
+
+
+ next_hop_third_party + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compute a third-party nexthop if possible.
+
+
+ prefix_list + +
+ dictionary +
+ 		+ +
Apply prefix-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ rewrite_evpn_rt_asn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Auto generate RTs for EBGP neighbor.
+
+
+ rewrite_rt_asn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Auto generate RTs for EBGP neighbor.
+
+
+ route_map + +
+ dictionary +
+ 		+ +
Apply route-map to neighbor.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ route_reflector_client + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure a neighbor as Route reflector client.
+
+
+ safi + +
+ string +
+ 		+
    Choices: +
  • unicast
    • +
  • multicast
    • +
  • mvpn
    • +
  • evpn
    • +
+ 		+
Sub Address Family indicator.
+
+
+ send_community + +
+ dictionary +
+ 		+ +
Send Community attribute to this neighbor.
+
+
+ both + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Standard and Extended Community attributes.
+
+
+ extended + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Extended Community attribute.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set send-community attribute.
+
+
+ standard + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Standard Community attribute.
+
+
+ soft_reconfiguration_inbound + +
+ dictionary +
+ 		+ +
Soft reconfiguration.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always perform inbound soft reconfiguration.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set soft-reconfiguration inbound attribute.
+
+
+ soo + +
+ string +
+ 		+ +
Specify Site-of-origin extcommunity.
+
+
+ suppress_inactive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise only active routes to peer.
+
+
+ unsuppress_map + +
+ string +
+ 		+ +
Route-map to selectively unsuppress suppressed routes.
+
+
+ weight + +
+ integer +
+ 		+ +
Set default weight for routes from this neighbor.
+
+
+ neighbor_address + +
+ string + / required +
+ 		+ +
IP/IPv6 address of the neighbor.
+
+
+ vrfs + +
+ list + / elements=dictionary +
+ 		+ +
Virtual Router Context.
+
+
+ neighbors + +
+ list + / elements=dictionary +
+ 		+ +
A list of BGP Neighbor AF configuration.
+
+
+ address_family + +
+ list + / elements=dictionary +
+ 		+ +
BGP Neighbor Address Family related configurations.
+
+
+ advertise_map + +
+ dictionary +
+ 		+ +
Specify route-map for conditional advertisement.
+
+
+ exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition exists.
+
+
+ non_exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition does not exist.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
Route-map name.
+
+
+ advertisement_interval + +
+ integer +
+ 		+ +
Minimum interval between sending BGP routing updates.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
  • link-state
    • +
  • vpnv4
    • +
  • vpnv6
    • +
  • l2vpn
    • +
+ 		+
Address Family indicator.
+
+
+ allowas_in + +
+ dictionary +
+ 		+ +
Accept as-path with my AS present in it.
+
+
+ max_occurences + +
+ integer +
+ 		+ +
Number of occurrences of AS number, default is 3.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Activate allowas-in property.
+
+
+ as_override + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Override matching AS-number while sending update.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Advertise capability to the peer.
+
+
+ additional_paths + +
+ dictionary +
+ 		+ +
Additional paths capability.
+
+
+ receive + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Receive capability.
+
+
+ send + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Send capability.
+
+
+ default_originate + +
+ dictionary +
+ 		+ +
Originate a default toward this peer.
+
+
+ route_map + +
+ string +
+ 		+ +
Route-map to specify criteria for originating default.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set default-originate attribute.
+
+
+ disable_peer_as_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable checking of peer AS-number while advertising.
+
+
+ filter_list + +
+ dictionary +
+ 		+ +
Name of filter-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a template.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence number.
+
+
+ template + +
+ string +
+ 		+ +
Template name.
+
+
+ maximum_prefix + +
+ dictionary +
+ 		+ +
Maximum number of prefixes from this neighbor.
+
+
+ generate_warning_threshold + +
+ integer +
+ 		+ +
Threshold percentage at which to generate a warning.
+
+
+ max_prefix_limit + +
+ integer +
+ 		+ +
Maximum prefix limit.
+
+
+ restart_interval + +
+ integer +
+ 		+ +
Restart bgp connection after limit is exceeded.
+
+
+ warning_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Only give a warning message when limit is exceeded.
+
+
+ next_hop_self + +
+ dictionary +
+ 		+ +
Set our address as nexthop (non-reflected).
+
+
+ all_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set our address as nexthop for all routes.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set next-hop-self attribute.
+
+
+ next_hop_third_party + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compute a third-party nexthop if possible.
+
+
+ prefix_list + +
+ dictionary +
+ 		+ +
Apply prefix-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ rewrite_evpn_rt_asn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Auto generate RTs for EBGP neighbor.
+
+
+ rewrite_rt_asn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Auto generate RTs for EBGP neighbor.
+
+
+ route_map + +
+ dictionary +
+ 		+ +
Apply route-map to neighbor.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ route_reflector_client + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure a neighbor as Route reflector client.
+
+
+ safi + +
+ string +
+ 		+
    Choices: +
  • unicast
    • +
  • multicast
    • +
  • mvpn
    • +
  • evpn
    • +
+ 		+
Sub Address Family indicator.
+
+
+ send_community + +
+ dictionary +
+ 		+ +
Send Community attribute to this neighbor.
+
+
+ both + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Standard and Extended Community attributes.
+
+
+ extended + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Extended Community attribute.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set send-community attribute.
+
+
+ standard + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Standard Community attribute.
+
+
+ soft_reconfiguration_inbound + +
+ dictionary +
+ 		+ +
Soft reconfiguration.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always perform inbound soft reconfiguration.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set soft-reconfiguration inbound attribute.
+
+
+ soo + +
+ string +
+ 		+ +
Specify Site-of-origin extcommunity.
+
+
+ suppress_inactive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise only active routes to peer.
+
+
+ unsuppress_map + +
+ string +
+ 		+ +
Route-map to selectively unsuppress suppressed routes.
+
+
+ weight + +
+ integer +
+ 		+ +
Set default weight for routes from this neighbor.
+
+
+ neighbor_address + +
+ string + / required +
+ 		+ +
IP/IPv6 address of the neighbor.
+
+
+ vrf + +
+ string +
+ 		+ +
VRF name.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^router bgp'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
State deleted only removes BGP attributes that this modules manages and does not negate the BGP process completely.
+
Refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - For managing BGP address family configurations please use the :ref:`cisco.nxos.nxos_bgp_address_family ` module. + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # Nexus9000v# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_bgp_neighbor_address_family: &id001 + config: + as_number: 65536 + neighbors: + - neighbor_address: 192.0.2.32 + address_family: + - afi: ipv4 + safi: unicast + maximum_prefix: + max_prefix_limit: 20 + generate_warning_threshold: 75 + weight: 100 + prefix_list: + inbound: rmap1 + outbound: rmap2 + - afi: ipv6 + safi: unicast + - neighbor_address: 192.0.2.33 + address_family: + - afi: ipv4 + safi: multicast + inherit: + template: BasePolicy + sequence: 200 + vrfs: + - vrf: site-1 + neighbors: + - neighbor_address: 203.0.113.1 + address_family: + - afi: ipv4 + safi: unicast + suppress_inactive: true + next_hop_self: + set: true + - neighbor_address: 203.0.113.2 + address_family: + - afi: ipv6 + safi: unicast + - afi: ipv4 + safi: multicast + send_community: + set: true + + # Task output: + # ------------ + # before: {} + # + # commands: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - address-family ipv4 unicast + # - maximum-prefix 20 75 + # - weight 100 + # - prefix-list rmap1 in + # - prefix-list rmap2 out + # - address-family ipv6 unicast + # - neighbor 192.0.2.33 + # - address-family ipv4 multicast + # - inherit peer-policy BasePolicy 200 + # - vrf site-1 + # - neighbor 203.0.113.1 + # - address-family ipv4 unicast + # - suppress-inactive + # - next-hop-self + # - neighbor 203.0.113.2 + # - address-family ipv6 unicast + # - address-family ipv4 multicast + # - send-community + # + # after: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + # Using replaced + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + - name: Replace specified neighbor AFs with given configuration + cisco.nxos.nxos_bgp_neighbor_address_family: &replaced + config: + as_number: 65536 + neighbors: + - neighbor_address: 192.0.2.32 + address_family: + - afi: ipv4 + safi: unicast + weight: 110 + - afi: ipv6 + safi: unicast + - neighbor_address: 192.0.2.33 + address_family: + - afi: ipv4 + safi: multicast + inherit: + template: BasePolicy + sequence: 200 + vrfs: + - vrf: site-1 + neighbors: + - neighbor_address: 203.0.113.1 + address_family: + - afi: ipv4 + safi: unicast + - neighbor_address: 203.0.113.2 + address_family: + - afi: ipv6 + safi: unicast + - afi: ipv4 + safi: multicast + send_community: + set: true + state: replaced + + # Task output: + # ------------ + # before: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + # + # commands: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - address-family ipv4 unicast + # - no maximum-prefix 20 75 + # - weight 110 + # - no prefix-list rmap1 in + # - no prefix-list rmap2 out + # - vrf site-1 + # - neighbor 203.0.113.1 + # - address-family ipv4 unicast + # - no suppress-inactive + # - no next-hop-self + # + # after: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # weight: 110 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # weight 110 + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + # Using overridden + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + - name: Override all BGP AF configuration with provided configuration + cisco.nxos.nxos_bgp_neighbor_address_family: + config: + as_number: 65536 + neighbors: + - neighbor_address: 192.0.2.32 + address_family: + - afi: ipv4 + safi: unicast + vrfs: + - vrf: site-1 + neighbors: + - neighbor_address: 203.0.113.1 + address_family: + - afi: ipv4 + safi: unicast + suppress_inactive: true + next_hop_self: + set: true + state: overridden + + # Task output: + # ------------ + # before: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + # + # commands: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - address-family ipv4 unicast + # - no maximum-prefix 20 75 + # - no weight 100 + # - no prefix-list rmap1 in + # - no prefix-list rmap2 out + # - no address-family ipv6 unicast + # - neighbor 192.0.2.33 + # - no address-family ipv4 multicast + # - vrf site-1 + # - neighbor 203.0.113.2 + # - no address-family ipv4 multicast + # - no address-family ipv6 unicast + # + # after: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + + # Using deleted to remove specified neighbor AFs + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + - name: Delete BGP configs handled by this module + cisco.nxos.nxos_bgp_neighbor_address_family: + config: + as_number: 65536 + neighbors: + - neighbor_address: 192.0.2.32 + address_family: + - afi: ipv4 + safi: unicast + vrfs: + - vrf: site-1 + neighbors: + - neighbor_address: 203.0.113.2 + address_family: + - afi: ipv6 + safi: unicast + state: deleted + + # Task output: + # ------------ + # before: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + # + # commands: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - no address-family ipv4 unicast + # - vrf site-1 + # - neighbor 203.0.113.2 + # - no address-family ipv6 unicast + # + # after: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # + + # Using deleted to remove all neighbor AFs + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + - name: Delete all BGP neighbor AF configs handled by this module + cisco.nxos.nxos_bgp_neighbor_address_family: + state: deleted + + # Task output: + # ------------ + # before: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + # + # commands: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - no address-family ipv4 unicast + # - no address-family ipv6 unicast + # - neighbor 192.0.2.33 + # - no address-family ipv4 multicast + # - vrf site-1 + # - neighbor 203.0.113.1 + # - no address-family ipv4 unicast + # - neighbor 203.0.113.2 + # - no address-family ipv6 unicast + # - no address-family ipv4 multicast + # + # after: + # as_number: "65536" + # + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # neighbor 192.0.2.33 + # vrf site-1 + # neighbor 203.0.113.1 + # neighbor 203.0.113.2 + # + + # Using rendered + + - name: Render platform specific configuration lines with state rendered (without connecting to the device) + cisco.nxos.nxos_bgp_neighbor_address_family: + config: + as_number: 65536 + neighbors: + - neighbor_address: 192.0.2.32 + address_family: + - afi: ipv4 + safi: unicast + maximum_prefix: + max_prefix_limit: 20 + generate_warning_threshold: 75 + weight: 100 + prefix_list: + inbound: rmap1 + outbound: rmap2 + - afi: ipv6 + safi: unicast + - neighbor_address: 192.0.2.33 + address_family: + - afi: ipv4 + safi: multicast + inherit: + template: BasePolicy + sequence: 200 + vrfs: + - vrf: site-1 + neighbors: + - neighbor_address: 203.0.113.1 + address_family: + - afi: ipv4 + safi: unicast + suppress_inactive: true + next_hop_self: + set: true + - neighbor_address: 203.0.113.2 + address_family: + - afi: ipv6 + safi: unicast + - afi: ipv4 + safi: multicast + send_community: + set: true + state: rendered + + # Task output: + # ------------ + # rendered: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - address-family ipv4 unicast + # - maximum-prefix 20 75 + # - weight 100 + # - prefix-list rmap1 in + # - prefix-list rmap2 out + # - address-family ipv6 unicast + # - neighbor 192.0.2.33 + # - address-family ipv4 multicast + # - inherit peer-policy BasePolicy 200 + # - vrf site-1 + # - neighbor 203.0.113.1 + # - address-family ipv4 unicast + # - suppress-inactive + # - next-hop-self + # - neighbor 203.0.113.2 + # - address-family ipv6 unicast + # - address-family ipv4 multicast + # - send-community + + # Using parsed + + # parsed.cfg + # ------------ + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + + - name: Parse externally provided BGP neighbor AF config + register: result + cisco.nxos.nxos_bgp_neighbor_address_family: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output: + # ------------ + # parsed: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['router bgp 65536', 'neighbor 192.0.2.32', 'address-family ipv4 unicast']
+
+
+ gathered + +
+ dictionary +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ dictionary +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['router bgp 65536', 'neighbor 192.0.2.32', 'address-family ipv4 unicast']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_bgp_templates_module.rst b/docs/cisco.nxos.nxos_bgp_templates_module.rst new file mode 100644 index 000000000..9287d7a60 --- /dev/null +++ b/docs/cisco.nxos.nxos_bgp_templates_module.rst @@ -0,0 +1,2841 @@ +.. _cisco.nxos.nxos_bgp_templates_module: + + +***************************** +cisco.nxos.nxos_bgp_templates +***************************** + +**BGP Templates resource module.** + + +Version added: 4.2.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages BGP templates on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A list of BGP templates.
+
+
+ as_number + +
+ string +
+ 		+ +
Autonomous System Number of the router.
+
+
+ neighbor + +
+ list + / elements=dictionary +
+ 		+ +
Configure BGP peer templates.
+
+
+ address_family + +
+ list + / elements=dictionary +
+ 		+ +
Configure an address-family for peer.
+
+
+ advertise_map + +
+ dictionary +
+ 		+ +
Specify route-map for conditional advertisement.
+
+
+ exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition exists.
+
+
+ non_exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition does not exist.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
Route-map name.
+
+
+ advertisement_interval + +
+ integer +
+ 		+ +
Minimum interval between sending BGP routing updates.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
  • link-state
    • +
  • l2vpn
    • +
+ 		+
Address Family indicator.
+
+
+ allowas_in + +
+ dictionary +
+ 		+ +
Accept as-path with my AS present in it.
+
+
+ max_occurences + +
+ integer +
+ 		+ +
Number of occurrences of AS number, default is 3.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Activate allowas-in property.
+
+
+ as_override + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Override matching AS-number while sending update.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Advertise capability to the peer.
+
+
+ additional_paths + +
+ dictionary +
+ 		+ +
Additional paths capability.
+
+
+ receive + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Receive capability.
+
+
+ send + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Send capability.
+
+
+ default_originate + +
+ dictionary +
+ 		+ +
Originate a default toward this peer.
+
+
+ route_map + +
+ string +
+ 		+ +
Route-map to specify criteria for originating default.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set default-originate attribute.
+
+
+ disable_peer_as_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable checking of peer AS-number while advertising.
+
+
+ filter_list + +
+ dictionary +
+ 		+ +
Name of filter-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a peer-policy template.
+
+
+ peer_policy + +
+ string +
+ 		+ +
Peer-policy template to inherit.
+
+
+ maximum_prefix + +
+ dictionary +
+ 		+ +
Maximum number of prefixes from this neighbor.
+
+
+ generate_warning_threshold + +
+ integer +
+ 		+ +
Threshold percentage at which to generate a warning.
+
+
+ max_prefix_limit + +
+ integer +
+ 		+ +
Maximum prefix limit.
+
+
+ restart_interval + +
+ integer +
+ 		+ +
Restart bgp connection after limit is exceeded.
+
+
+ warning_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Only give a warning message when limit is exceeded.
+
+
+ next_hop_self + +
+ dictionary +
+ 		+ +
Set our address as nexthop (non-reflected).
+
+
+ all_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set our address as nexthop for all routes.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set next-hop-self attribute.
+
+
+ next_hop_third_party + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compute a third-party nexthop if possible.
+
+
+ prefix_list + +
+ dictionary +
+ 		+ +
Apply prefix-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ route_map + +
+ dictionary +
+ 		+ +
Apply route-map to neighbor.
+
+
+ inbound + +
+ string +
+ 		+ +
Name of policy to apply to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Name of policy to apply to outgoing routes.
+
+
+ route_reflector_client + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure a neighbor as Route reflector client.
+
+
+ safi + +
+ string +
+ 		+
    Choices: +
  • unicast
    • +
  • multicast
    • +
  • mvpn
    • +
  • evpn
    • +
+ 		+
Sub Address Family indicator.
+
+
+ send_community + +
+ string +
+ 		+
    Choices: +
  • standard
    • +
  • extended
    • +
  • both
    • +
+ 		+
Send Community attribute to this neighbor.
+
+
+ soft_reconfiguration_inbound + +
+ dictionary +
+ 		+ +
Soft reconfiguration.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always perform inbound soft reconfiguration.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set soft-reconfiguration inbound attribute.
+
+
+ soo + +
+ string +
+ 		+ +
Specify Site-of-origin extcommunity.
+
+
+ suppress_inactive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise only active routes to peer.
+
+
+ unsuppress_map + +
+ string +
+ 		+ +
Route-map to selectively unsuppress suppressed routes.
+
+
+ weight + +
+ integer +
+ 		+ +
Set default weight for routes from this neighbor.
+
+
+ bfd + +
+ dictionary +
+ 		+ +
Bidirectional Fast Detection for the neighbor.
+
+
+ multihop + +
+ dictionary +
+ 		+ +
Multihop session.
+
+
+ interval + +
+ dictionary +
+ 		+ +
Configure BFD session interval parameters.
+
+
+ min_rx_interval + +
+ integer + / required +
+ 		+ +
Minimum RX interval.
+
+
+ multiplier + +
+ integer + / required +
+ 		+ +
Detect Multiplier.
+
+
+ tx_interval + +
+ integer + / required +
+ 		+ +
TX interval in milliseconds.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD multihop.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD for this neighbor.
+
+
+ singlehop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Single-hop session.
+
+
+ bmp_activate_server + +
+ integer +
+ 		+ +
Specify server ID for activating BMP monitoring for the peer.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Capability.
+
+
+ suppress_4_byte_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress 4-byte AS Capability.
+
+
+ description + +
+ string +
+ 		+ +
Neighbor specific descripion.
+
+
+ disable_connected_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable check for directly connected peer.
+
+
+ dont_capability_negotiate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Don't negotiate capability with this neighbor.
+
+
+ dscp + +
+ string +
+ 		+ +
Set dscp value for tcp transport.
+
+
+ dynamic_capability + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Dynamic Capability
+
+
+ ebgp_multihop + +
+ integer +
+ 		+ +
Specify multihop TTL for remote peer.
+
+
+ graceful_shutdown + +
+ dictionary +
+ 		+ +
Graceful-shutdown for this neighbor.
+
+
+ activate + +
+ dictionary +
+ 		+ +
Send graceful-shutdown community.
+
+
+ route_map + +
+ string +
+ 		+ +
Apply route-map to modify attributes for outbound.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set activate.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a template.
+
+
+ peer_session + +
+ string +
+ 		+ +
Peer-session template to inherit.
+
+
+ local_as + +
+ string +
+ 		+ +
Specify the local-as number for the eBGP neighbor.
+
+
+ log_neighbor_changes + +
+ dictionary +
+ 		+ +
Log message for neighbor up/down event.
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable logging of neighbor up/down event.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set log-neighbor-changes.
+
+
+ low_memory + +
+ dictionary +
+ 		+ +
Behaviour in low memory situations.
+
+
+ exempt + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not shutdown this peer when under memory pressure.
+
+
+ name + +
+ string +
+ 		+ +
Name of the BGP peer template.
+
+
+ password + +
+ dictionary +
+ 		+ +
Configure a password for neighbor.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 specifies an UNENCRYPTED neighbor password.
+
3 specifies an 3DES ENCRYPTED neighbor password will follow.
+
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
+
+
+ key + +
+ string +
+ 		+ +
Authentication password.
+
+
+ path_attribute + +
+ list + / elements=dictionary +
+ 		+ +
BGP path attribute optional filtering.
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • discard
    • +
  • treat-as-withdraw
    • +
+ 		+
Action.
+
+
+ range + +
+ dictionary +
+ 		+ +
Path attribute range.
+
+
+ end + +
+ integer +
+ 		+ +
Path attribute range end value.
+
+
+ start + +
+ integer +
+ 		+ +
Path attribute range start value.
+
+
+ type + +
+ integer +
+ 		+ +
Path attribute type
+
+
+ remote_as + +
+ string +
+ 		+ +
Specify Autonomous System Number of the neighbor.
+
+
+ remove_private_as + +
+ dictionary +
+ 		+ +
Remove private AS number from outbound updates.
+
+
+ all + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All.
+
+
+ replace_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Replace.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Remove private AS.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown this neighbor.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure keepalive and hold timers.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Holdtime (seconds).
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval (seconds).
+
+
+ transport + +
+ dictionary +
+ 		+ +
BGP transport connection.
+
+
+ connection_mode + +
+ dictionary +
+ 		+ +
Specify type of connection.
+
+
+ passive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Allow passive connection setup only.
+
+
+ ttl_security + +
+ dictionary +
+ 		+ +
Enable TTL Security Mechanism.
+
+
+ hops + +
+ integer +
+ 		+ +
Specify hop count for remote peer.
+
+
+ update_source + +
+ string +
+ 		+ +
Specify source of BGP session and updates.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config bgp | section 'template'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
Refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # -------------- + # + # nxos9k# show running-config | section "^router bgp" + # nxos9k# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_bgp_templates: + config: + as_number: 65536 + neighbor: + - name: neighbor_tmplt_1 + address_family: + - afi: ipv4 + safi: unicast + advertise_map: + route_map: rmap1 + non_exist_map: nemap1 + advertisement_interval: 60 + disable_peer_as_check: true + bmp_activate_server: 2 + capability: + suppress_4_byte_as: true + description: Test_BGP_PEER_TEMPLATE_1 + local_as: 65536 + remote_as: 65001 + + - name: neighbor_tmplt_2 + description: Test_BGP_PEER_TEMPLATE_2 + address_family: + - afi: ipv4 + safi: multicast + advertise_map: + route_map: rmap1 + exist_map: emap1 + as_override: true + filter_list: + inbound: flist1 + outbound: flist2 + inherit: + peer_session: psession1 + timers: + holdtime: 100 + keepalive: 45 + # Task Output: + # ------------ + # before: {} + # + # commands: + # - router bgp 65536 + # - template peer neighbor_tmplt_1 + # - bmp-activate-server 2 + # - capability suppress 4-byte-as + # - description Test_BGP_PEER_TEMPLATE_1 + # - local-as 65536 + # - remote-as 65001 + # - address-family ipv4 unicast + # - advertise-map rmap1 non-exist-map nemap1 + # - advertisement-interval 60 + # - disable-peer-as-check + # - template peer neighbor_tmplt_2 + # - description Test_BGP_PEER_TEMPLATE_2 + # - inherit peer-session psession1 + # - timers 45 100 + # - address-family ipv4 multicast + # - advertise-map rmap1 exist-map emap1 + # - as-override + # - filter-list flist1 in + # - filter-list flist2 out + # + # after: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # bmp_activate_server: 2 + # capability: + # suppress_4_byte_as: true + # description: Test_BGP_PEER_TEMPLATE_1 + # local_as: "65536" + # remote_as: "65001" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + + # After state: + # -------------- + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # capability suppress 4-byte-as + # bmp-activate-server 2 + # description Test_BGP_PEER_TEMPLATE_1 + # local-as 65536 + # remote-as 65001 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + # Using replaced + + # Before state: + # ------------- + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # capability suppress 4-byte-as + # description Test_BGP_PEER_TEMPLATE_1 + # bmp-activate-server 2 + # local-as 65536 + # remote-as 65001 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + - name: Replace BGP templates configuration with provided configuration + cisco.nxos.nxos_bgp_templates: + config: + as_number: 65536 + neighbor: + - name: neighbor_tmplt_1 + address_family: + - afi: ipv4 + safi: unicast + advertise_map: + route_map: rmap1 + non_exist_map: nemap1 + advertisement_interval: 60 + disable_peer_as_check: true + inherit: + peer_session: psession1 + description: Test_BGP_PEER_TEMPLATE_1 + local_as: 65537 + state: replaced + + # Task output: + # ------------ + # + # before: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # bmp_activate_server: 2 + # capability: + # suppress_4_byte_as: true + # description: Test_BGP_PEER_TEMPLATE_1 + # local_as: "65536" + # remote_as: "65001" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + # + # commands: + # - router bgp 65536 + # - template peer neighbor_tmplt_1 + # - no bmp-activate-server 2 + # - no capability suppress 4-byte-as + # - inherit peer-session psession1 + # - local-as 65537 + # - no remote-as 65001 + # + # after: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # description: Test_BGP_PEER_TEMPLATE_1 + # inherit: + # peer_session: psession1 + # local_as: "65537" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + + # After state: + # ------------ + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # inherit peer-session psession1 + # description Test_BGP_PEER_TEMPLATE_1 + # local-as 65537 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # bmp-activate-server 2 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + # Using overridden + # + # Before state: + # ------------- + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # capability suppress 4-byte-as + # description Test_BGP_PEER_TEMPLATE_1 + # bmp-activate-server 2 + # local-as 65536 + # remote-as 65001 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + - name: Override BGP templates configuration with provided configuration + cisco.nxos.nxos_bgp_templates: + config: + as_number: 65536 + neighbor: + - name: neighbor_tmplt_1 + address_family: + - afi: ipv4 + safi: unicast + advertise_map: + route_map: rmap1 + non_exist_map: nemap1 + advertisement_interval: 60 + disable_peer_as_check: true + inherit: + peer_session: psession1 + description: Test_BGP_PEER_TEMPLATE_1 + local_as: 65537 + state: overridden + + # Task output: + # ------------ + # + # before: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # bmp_activate_server: 2 + # capability: + # suppress_4_byte_as: true + # description: Test_BGP_PEER_TEMPLATE_1 + # local_as: "65536" + # remote_as: "65001" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + # + # commands: + # - router bgp 65536 + # - template peer neighbor_tmplt_1 + # - no bmp-activate-server 2 + # - no capability suppress 4-byte-as + # - inherit peer-session psession1 + # - local-as 65537 + # - no remote-as 65001 + # - no template peer neighbor_tmplt_2 + # + # after: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # description: Test_BGP_PEER_TEMPLATE_1 + # inherit: + # peer_session: psession1 + # local_as: "65537" + + # After state: + # ------------ + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # inherit peer-session psession1 + # description Test_BGP_PEER_TEMPLATE_1 + # local-as 65537 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + + # Using deleted + + # Before state: + # -------------- + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # capability suppress 4-byte-as + # description Test_BGP_PEER_TEMPLATE_1 + # bmp-activate-server 2 + # local-as 65536 + # remote-as 65001 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + - name: Delete BGP configs handled by this module + cisco.nxos.nxos_bgp_templates: + state: deleted + + # Task output: + # ------------ + # + # before: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # bmp_activate_server: 2 + # capability: + # suppress_4_byte_as: true + # description: Test_BGP_PEER_TEMPLATE_1 + # local_as: "65536" + # remote_as: "65001" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + # + # commands: + # - router bgp 65536 + # - no template peer neighbor_tmplt_1 + # - no template peer neighbor_tmplt_2 + # + # after: {} + + # After state: + # ------------- + # nxos9k# show running-config | section "^router bgp" + # nxos9k# + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['router bgp 65536', 'template peer neighbor_tmplt_1', 'no bmp-activate-server 2', 'no capability suppress 4-byte-as', 'inherit peer-session psession1', 'local-as 65537', 'no remote-as 65001', 'no template peer neighbor_tmplt_2']
+
+
+ gathered + +
+ dictionary +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ dictionary +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['router bgp 65536', 'template peer neighbor_tmplt_1', 'bmp-activate-server 2', 'no capability suppress 4-byte-as', 'no template peer neighbor_tmplt_2']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_command_module.rst b/docs/cisco.nxos.nxos_command_module.rst new file mode 100644 index 000000000..4308a6582 --- /dev/null +++ b/docs/cisco.nxos.nxos_command_module.rst @@ -0,0 +1,258 @@ +.. _cisco.nxos.nxos_command_module: + + +*********************** +cisco.nxos.nxos_command +*********************** + +**Run arbitrary command on Cisco NXOS devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Sends an arbitrary command to an NXOS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ commands + +
+ list + / elements=raw + / required +
+ 		+ +
The commands to send to the remote NXOS device. The resulting output from the command is returned. If the wait_for argument is provided, the module is not returned until the condition is satisfied or the number of retires as expired.
+
The commands argument also accepts an alternative form that allows for complex values that specify the command to run and the output format to return. This can be done on a command by command basis. The complex argument supports the keywords command and output where command is the command to run and output is one of 'text' or 'json'.
+
If a command sent to the device requires answering a prompt, it is possible to pass a dict containing command, answer and prompt. Common answers are 'y' or "\r" (carriage return, must be double quotes). See examples.
+
+
+ interval + +
+ integer +
+ 		+ Default:
1
+ 		+
Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditional, the interval indicates how to long to wait before trying the command again.
+
+
+ match + +
+ string +
+ 		+
    Choices: +
  • any
    • +
  • all ←
    • +
+ 		+
The match argument is used in conjunction with the wait_for argument to specify the match policy. Valid values are all or any. If the value is set to all then all conditionals in the wait_for must be satisfied. If the value is set to any then only one of the values must be satisfied.
+
+
+ retries + +
+ integer +
+ 		+ Default:
9
+ 		+
Specifies the number of retries a command should by tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait_for conditionals.
+
The commands are run once when retries is set to 0.
+
+
+ wait_for + +
+ list + / elements=string +
+ 		+ +
Specifies what to evaluate from the output of the command and what conditionals to apply. This argument will cause the task to wait for a particular conditional to be true before moving forward. If the conditional is not true by the configured retries, the task fails. See examples.
+

aliases: waitfor
+
+
+ + +Notes +----- + +.. note:: + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: run show version on remote devices + cisco.nxos.nxos_command: + commands: show version + + - name: run show version and check to see if output contains Cisco + cisco.nxos.nxos_command: + commands: show version + wait_for: result[0] contains Cisco + + - name: run multiple commands on remote nodes + cisco.nxos.nxos_command: + commands: + - show version + - show interfaces + + - name: run multiple commands and evaluate the output + cisco.nxos.nxos_command: + commands: + - show version + - show interfaces + wait_for: + - result[0] contains Cisco + - result[1] contains loopback0 + + - name: run commands and specify the output format + cisco.nxos.nxos_command: + commands: + - command: show version + output: json + + - name: run commands that require answering a prompt + cisco.nxos.nxos_command: + commands: + - configure terminal + - command: no feature npv + prompt: Do you want to continue + answer: y + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ failed_conditions + +
+ list +
+ 		failed +
The list of conditionals that have failed
+
+
Sample:
+
['...', '...']
+
+
+ stdout + +
+ list +
+ 		always apart from low level errors (such as action plugin) +
The set of responses from the commands
+
+
Sample:
+
['...', '...']
+
+
+ stdout_lines + +
+ list +
+ 		always apart from low level errors (such as action plugin) +
The value of stdout split into a list
+
+
Sample:
+
[['...', '...'], ['...'], ['...']]
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_config_module.rst b/docs/cisco.nxos.nxos_config_module.rst new file mode 100644 index 000000000..3ead5ab50 --- /dev/null +++ b/docs/cisco.nxos.nxos_config_module.rst @@ -0,0 +1,566 @@ +.. _cisco.nxos.nxos_config_module: + + +********************** +cisco.nxos.nxos_config +********************** + +**Manage Cisco NXOS configuration sections** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- 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. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ after + +
+ list + / elements=string +
+ 		+ +
The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with before this allows the playbook designer to append a set of commands to be executed after the command set.
+
+
+ backup + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
This argument will cause the module to create a full backup of the current running-config from the remote device before any changes are made. If the backup_options value is not given, the backup file is written to the backup folder in the playbook root directory or role root directory, if playbook is part of an ansible role. If the directory does not exist, it is created.
+
+
+ backup_options + +
+ dictionary +
+ 		+ +
This is a dict object containing configurable options related to backup file path. The value of this option is read only when backup is set to True, if backup is set to false this option will be silently ignored.
+
+
+ dir_path + +
+ path +
+ 		+ +
This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be created and the filename is either the value of filename or default filename as described in filename options description. If the path value is not given in that case a backup directory will be created in the current working directory and backup configuration will be copied in filename within backup directory.
+
+
+ filename + +
+ string +
+ 		+ +
The filename to be used to store the backup configuration. If the filename is not given it will be generated based on the hostname, current time and date in format defined by <hostname>_config.<current-date>@<current-time>
+
+
+ before + +
+ list + / elements=string +
+ 		+ +
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.
+
+
+ defaults + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
The 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
+
+
+ diff_against + +
+ string +
+ 		+
    Choices: +
  • startup
    • +
  • intended
    • +
  • running
    • +
+ 		+
When using the ansible-playbook --diff command line argument the module can generate diffs against different sources.
+
When this option is configure as startup, the module will return the diff of the running-config against the startup-config.
+
When this option is configured as intended, the module will return the diff of the running-config against the configuration provided in the intended_config argument.
+
When this option is configured as running, the module will return the before and after diff of the running-config with respect to any changes made to the device configuration.
+
+
+ diff_ignore_lines + +
+ list + / elements=string +
+ 		+ +
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.
+
+
+ intended_config + +
+ string +
+ 		+ +
The 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 diff_against value and set it to intended. The configuration lines for this value should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure correct diff.
+
+
+ lines + +
+ list + / elements=string +
+ 		+ +
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 to ensure idempotency and correct diff. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser.
+

aliases: commands
+
+
+ match + +
+ string +
+ 		+
    Choices: +
  • line ←
    • +
  • strict
    • +
  • exact
    • +
  • none
    • +
+ 		+
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 line, commands are matched line by line. If match is set to strict, command lines are matched with respect to position. If match is set to exact, command lines must be an equal match. Finally, if match is set to none, the module will not attempt to compare the source configuration with the running configuration on the remote device.
+
+
+ parents + +
+ list + / elements=string +
+ 		+ +
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.
+
+
+ replace + +
+ string +
+ 		+
    Choices: +
  • line ←
    • +
  • block
    • +
  • config
    • +
+ 		+
Instructs the module on the way to perform the configuration on the device. If the replace argument is set to line then the modified lines are pushed to the device in configuration mode. If the replace argument is set to block then the entire command block is pushed to the device in configuration mode if any line is not correct. replace config will only work for NX-OS versions that support `config replace`.
+
+
+ replace_src + +
+ string +
+ 		+ +
The 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 replace with value config. This is mutually exclusive with the lines and src arguments. This argument will only work for NX-OS versions that support `config replace`. Use nxos_file_copy module to copy the flat file to remote device and then use the path with this argument. The configuration lines in the file should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure idempotency and correct diff.
+
+
+ running_config + +
+ string +
+ 		+ +
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 running_config argument allows the implementer to pass in the configuration to use as the base config for comparison. The configuration lines for this option should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure idempotency and correct diff.
+

aliases: config
+
+
+ save_when + +
+ string +
+ 		+
    Choices: +
  • always
    • +
  • never ←
    • +
  • modified
    • +
  • changed
    • +
+ 		+
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 always, then the running-config will always be copied to the startup-config and the modified flag will always be set to True. If the argument is set to 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 never, the running-config will never be copied to the startup-config. If the argument is set to changed, then the running-config will only be copied to the startup-config if the task has made a change. changed was added in Ansible 2.6.
+
+
+ src + +
+ path +
+ 		+ +
The 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 lines and parents arguments. The configuration lines in the source file should be similar to how it will appear if present in the running-configuration of the device including indentation to ensure idempotency and correct diff.
+
+
+ + +Notes +----- + +.. note:: + - Unsupported for Cisco MDS + - Abbreviated commands are NOT idempotent, see https://docs.ansible.com/ansible/latest/network/user_guide/faq.html#why-do-the-config-modules-always-return-changed-true-with-abbreviated-commands. + - To ensure idempotency and correct diff the configuration lines in the relevant module options should be similar to how they appear if present in the running configuration on device including the indentation. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: configure top level configuration and save it + cisco.nxos.nxos_config: + lines: hostname {{ inventory_hostname }} + save_when: modified + + - name: diff the running-config against a provided config + cisco.nxos.nxos_config: + diff_against: intended + intended_config: "{{ lookup('file', 'master.cfg') }}" + + - cisco.nxos.nxos_config: + lines: + - 10 permit ip 192.0.2.1/32 any log + - 20 permit ip 192.0.2.2/32 any log + - 30 permit ip 192.0.2.3/32 any log + - 40 permit ip 192.0.2.4/32 any log + - 50 permit ip 192.0.2.5/32 any log + parents: ip access-list test + before: no ip access-list test + match: exact + + - cisco.nxos.nxos_config: + lines: + - 10 permit ip 192.0.2.1/32 any log + - 20 permit ip 192.0.2.2/32 any log + - 30 permit ip 192.0.2.3/32 any log + - 40 permit ip 192.0.2.4/32 any log + parents: ip access-list test + before: no ip access-list test + replace: block + + - name: replace config with flat file + cisco.nxos.nxos_config: + replace_src: config.txt + replace: config + + - name: for idempotency, use full-form commands + cisco.nxos.nxos_config: + lines: + # - shut + - shutdown + # parents: int eth1/1 + parents: interface Ethernet1/1 + + - name: configurable backup path + cisco.nxos.nxos_config: + backup: true + backup_options: + filename: backup.cfg + dir_path: /home/user + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ backup_path + +
+ string +
+ 		when backup is yes +
The full path to the backup file
+
+
Sample:
+
/playbooks/ansible/backup/nxos_config.2016-07-16@22:28:34
+
+
+ commands + +
+ list +
+ 		always +
The set of commands that will be pushed to the remote device
+
+
Sample:
+
['hostname foo', 'vlan 1', 'name default']
+
+
+ date + +
+ string +
+ 		when backup is yes +
The date extracted from the backup file name
+
+
Sample:
+
2016-07-16
+
+
+ filename + +
+ string +
+ 		when backup is yes and filename is not specified in backup options +
The name of the backup file
+
+
Sample:
+
nxos_config.2016-07-16@22:28:34
+
+
+ shortname + +
+ string +
+ 		when backup is yes and filename is not specified in backup options +
The full path to the backup file excluding the timestamp
+
+
Sample:
+
/playbooks/ansible/backup/nxos_config
+
+
+ time + +
+ string +
+ 		when backup is yes +
The time extracted from the backup file name
+
+
Sample:
+
22:28:34
+
+
+ updates + +
+ list +
+ 		always +
The set of commands that will be pushed to the remote device
+
+
Sample:
+
['hostname foo', 'vlan 1', 'name default']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_devicealias_module.rst b/docs/cisco.nxos.nxos_devicealias_module.rst new file mode 100644 index 000000000..081c8759f --- /dev/null +++ b/docs/cisco.nxos.nxos_devicealias_module.rst @@ -0,0 +1,273 @@ +.. _cisco.nxos.nxos_devicealias_module: + + +*************************** +cisco.nxos.nxos_devicealias +*************************** + +**Configuration of device alias for Cisco NXOS MDS Switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Configuration of device alias for Cisco MDS NXOS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ da + +
+ list + / elements=dictionary +
+ 		+ +
List of device-alias to be added or removed
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the device-alias to be added or removed
+
+
+ pwwn + +
+ string +
+ 		+ +
pwwn to which the name needs to be associated with
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Removes the device-alias if set to True
+
+
+ distribute + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable device-alias distribution
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • basic
    • +
  • enhanced
    • +
+ 		+
Mode of devices-alias, basic or enhanced
+
+
+ rename + +
+ list + / elements=dictionary +
+ 		+ +
List of device-alias to be renamed
+
+
+ new_name + +
+ string + / required +
+ 		+ +
New name of the device-alias
+
+
+ old_name + +
+ string + / required +
+ 		+ +
Old name of the device-alias that needs to be renamed
+
+
+ + +Notes +----- + +.. note:: + - Tested against Cisco MDS NX-OS 8.4(1) + + + +Examples +-------- + +.. code-block:: yaml + + - name: Test that device alias module works + cisco.nxos.nxos_devicealias: + da: + - name: test1_add + pwwn: 56:2:22:11:22:88:11:67 + - name: test2_add + pwwn: 65:22:22:11:22:22:11:d + - name: dev1 + remove: true + - name: dev2 + remove: true + distribute: true + mode: enhanced + rename: + - new_name: bcd + old_name: abc + - new_name: bcd1 + old_name: abc1 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['terminal dont-ask', 'device-alias database', 'device-alias name somename pwwn 10:00:00:00:89:a1:01:03', 'device-alias name somename1 pwwn 10:00:00:00:89:a1:02:03', 'device-alias commit', 'no terminal dont-ask']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) diff --git a/docs/cisco.nxos.nxos_evpn_global_module.rst b/docs/cisco.nxos.nxos_evpn_global_module.rst new file mode 100644 index 000000000..d1b2a8241 --- /dev/null +++ b/docs/cisco.nxos.nxos_evpn_global_module.rst @@ -0,0 +1,122 @@ +.. _cisco.nxos.nxos_evpn_global_module: + + +*************************** +cisco.nxos.nxos_evpn_global +*************************** + +**Handles the EVPN control plane for VXLAN.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Handles the EVPN control plane for VXLAN. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ nv_overlay_evpn + +
+ boolean + / required +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
EVPN control plane.
+
+
+ + +Notes +----- + +.. note:: + - This module is not supported on Nexus 3000 series of switches. + - Unsupported for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_evpn_global: + nv_overlay_evpn: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The set of commands to be sent to the remote device
+
+
Sample:
+
['nv overlay evpn']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_evpn_vni_module.rst b/docs/cisco.nxos.nxos_evpn_vni_module.rst new file mode 100644 index 000000000..530a9ff18 --- /dev/null +++ b/docs/cisco.nxos.nxos_evpn_vni_module.rst @@ -0,0 +1,212 @@ +.. _cisco.nxos.nxos_evpn_vni_module: + + +************************ +cisco.nxos.nxos_evpn_vni +************************ + +**Manages Cisco EVPN VXLAN Network Identifier (VNI).** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages Cisco Ethernet Virtual Private Network (EVPN) VXLAN Network Identifier (VNI) configurations of a Nexus device. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ route_distinguisher + +
+ string +
+ 		+ +
The VPN Route Distinguisher (RD). The RD is combined with the IPv4 or IPv6 prefix learned by the PE router to create a globally unique address.
+
+
+ route_target_both + +
+ list + / elements=string +
+ 		+ +
Enables/Disables route-target settings for both import and export target communities using a single property.
+
+
+ route_target_export + +
+ list + / elements=string +
+ 		+ +
Sets the route-target 'export' extended communities.
+
+
+ route_target_import + +
+ list + / elements=string +
+ 		+ +
Sets the route-target 'import' extended communities.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Determines whether the config should be present or not on the device.
+
+
+ vni + +
+ string + / required +
+ 		+ +
The EVPN VXLAN Network Identifier.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - default, where supported, restores params default value. + - RD override is not permitted. You should set it to the default values first and then reconfigure it. + - ``route_target_both``, ``route_target_import`` and ``route_target_export valid`` values are a list of extended communities, (i.e. ['1.2.3.4:5', '33:55']) or the keywords 'auto' or 'default'. + - The ``route_target_both`` property is discouraged due to the inconsistent behavior of the property across Nexus platforms and image versions. For this reason it is recommended to use explicit ``route_target_export`` and ``route_target_import`` properties instead of ``route_target_both``. + - RD valid values are a string in one of the route-distinguisher formats, the keyword 'auto', or the keyword 'default'. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: vni configuration + cisco.nxos.nxos_evpn_vni: + vni: 6000 + route_distinguisher: 60:10 + route_target_import: + - "5000:10" + - "4100:100" + route_target_export: auto + route_target_both: default + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['evpn', 'vni 6000 l2', 'route-target import 5001:10']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_facts_module.rst b/docs/cisco.nxos.nxos_facts_module.rst new file mode 100644 index 000000000..3ce96abea --- /dev/null +++ b/docs/cisco.nxos.nxos_facts_module.rst @@ -0,0 +1,553 @@ +.. _cisco.nxos.nxos_facts_module: + + +********************* +cisco.nxos.nxos_facts +********************* + +**Gets facts about NX-OS switches** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Collects facts from Cisco Nexus devices running the NX-OS operating system. Fact collection is supported over both ``network_cli`` and ``httpapi``. This module prepends all of the base network fact keys with ``ansible_net_``. The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ available_network_resources + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
When set to true a list of network resources for which resource modules are available will be provided.
+
+
+ gather_network_resources + +
+ list + / elements=string +
+ 		+ +
When supplied, this argument will gather configuration facts only for the given subset. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
+
Valid subsets are all, bfd_interfaces, lag_interfaces, telemetry, vlans, lacp, lacp_interfaces, interfaces, l3_interfaces, l2_interfaces, lldp_global, acls, acl_interfaces, ospfv2, ospfv3, ospf_interfaces, bgp_global, bgp_address_family, route_maps, prefix_lists, logging_global, ntp_global, snmp_server, hostname.
+
+
+ gather_subset + +
+ list + / elements=string +
+ 		+ Default:
"min"
+ 		+
When supplied, this argument will gather operational facts only for the given subset. Possible values for this argument include all, hardware, config, legacy, interfaces, and min. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Gather all legacy facts + cisco.nxos.nxos_facts: + gather_subset: all + - name: Gather only the config and default facts + cisco.nxos.nxos_facts: + gather_subset: + - config + - name: Do not gather hardware facts + cisco.nxos.nxos_facts: + gather_subset: + - '!hardware' + - name: Gather legacy and resource facts + cisco.nxos.nxos_facts: + gather_subset: all + gather_network_resources: all + - name: Gather only the interfaces resource facts and no legacy facts + cisco.nxos.nxos_facts: + gather_subset: + - '!all' + - '!min' + gather_network_resources: + - interfaces + - name: Gather interfaces resource and minimal legacy facts + cisco.nxos.nxos_facts: + gather_subset: min + gather_network_resources: interfaces + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ ansible_net_all_ipv4_addresses + +
+ list +
+ 		when interfaces is configured +
All IPv4 addresses configured on the device
+
+
+
+ ansible_net_all_ipv6_addresses + +
+ list +
+ 		when interfaces is configured +
All IPv6 addresses configured on the device
+
+
+
+ ansible_net_api + +
+ string +
+ 		always +
The name of the transport
+
+
+
+ ansible_net_config + +
+ string +
+ 		when config is configured +
The current active config from the device
+
+
+
+ ansible_net_filesystems + +
+ list +
+ 		when hardware is configured +
All file system names available on the device
+
+
+
+ ansible_net_gather_network_resources + +
+ list +
+ 		when the resource is configured +
The list of fact for network resource subsets collected from the device
+
+
+
+ ansible_net_gather_subset + +
+ list +
+ 		always +
The list of fact subsets collected from the device
+
+
+
+ ansible_net_hostname + +
+ string +
+ 		always +
The configured hostname of the device
+
+
+
+ ansible_net_image + +
+ string +
+ 		always +
The image file the device is running
+
+
+
+ ansible_net_interfaces + +
+ dictionary +
+ 		when interfaces is configured +
A hash of all interfaces running on the system
+
+
+
+ ansible_net_license_hostid + +
+ string +
+ 		always +
The License host id of the device
+
+
+
+ ansible_net_memfree_mb + +
+ integer +
+ 		when hardware is configured +
The available free memory on the remote device in Mb
+
+
+
+ ansible_net_memtotal_mb + +
+ integer +
+ 		when hardware is configured +
The total memory on the remote device in Mb
+
+
+
+ ansible_net_model + +
+ string +
+ 		always +
The model name returned from the device
+
+
+
+ ansible_net_neighbors + +
+ dictionary +
+ 		when interfaces is configured +
The list of LLDP and CDP neighbors from the device. If both, CDP and LLDP neighbor data is present on one port, CDP is preferred.
+
+
+
+ ansible_net_python_version + +
+ string +
+ 		always +
The Python version Ansible controller is using
+
+
+
+ ansible_net_serialnum + +
+ string +
+ 		always +
The serial number of the remote device
+
+
+
+ ansible_net_version + +
+ string +
+ 		always +
The operating system version running on the remote device
+
+
+
+ fan_info + +
+ dictionary +
+ 		when legacy is configured +
A hash of facts about fans in the remote device
+
+
+
+ hostname + +
+ dictionary +
+ 		when legacy is configured +
The configured hostname of the remote device
+
+
+
+ interfaces_list + +
+ dictionary +
+ 		when legacy is configured +
The list of interface names on the remote device
+
+
+
+ kickstart + +
+ string +
+ 		when legacy is configured +
The software version used to boot the system
+
+
+
+ module + +
+ dictionary +
+ 		when legacy is configured +
A hash of facts about the modules in a remote device
+
+
+
+ platform + +
+ string +
+ 		when legacy is configured +
The hardware platform reported by the remote device
+
+
+
+ power_supply_info + +
+ string +
+ 		when legacy is configured +
A hash of facts about the power supplies in the remote device
+
+
+
+ vlan_list + +
+ list +
+ 		when legacy is configured +
The list of VLAN IDs configured on the remote device
+
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_feature_module.rst b/docs/cisco.nxos.nxos_feature_module.rst new file mode 100644 index 000000000..ee2539180 --- /dev/null +++ b/docs/cisco.nxos.nxos_feature_module.rst @@ -0,0 +1,150 @@ +.. _cisco.nxos.nxos_feature_module: + + +*********************** +cisco.nxos.nxos_feature +*********************** + +**Manage features in NX-OS switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Offers ability to enable and disable features in NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ feature + +
+ string + / required +
+ 		+ +
Name of feature.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • enabled ←
    • +
  • disabled
    • +
+ 		+
Desired state of the feature.
+
+
+ + +Notes +----- + +.. note:: + - Tested against Cisco MDS NX-OS 9.2(2) + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - 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 Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The set of commands to be sent to the remote device
+
+
Sample:
+
['nv overlay evpn']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) +- Suhas Bharadwaj (@srbharadwaj) diff --git a/docs/cisco.nxos.nxos_gir_module.rst b/docs/cisco.nxos.nxos_gir_module.rst new file mode 100644 index 000000000..61c809ea0 --- /dev/null +++ b/docs/cisco.nxos.nxos_gir_module.rst @@ -0,0 +1,302 @@ +.. _cisco.nxos.nxos_gir_module: + + +******************* +cisco.nxos.nxos_gir +******************* + +**Trigger a graceful removal or insertion (GIR) of the switch.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Trigger a graceful removal or insertion (GIR) of the switch. +- GIR processing may take more than 2 minutes. Timeout settings are automatically extended to 200s when user timeout settings are insufficient. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specify desired state of the resource.
+
+
+ system_mode_maintenance + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
When system_mode_maintenance=true it puts all enabled protocols in maintenance mode (using the isolate command). When system_mode_maintenance=false it puts all enabled protocols in normal mode (using the no isolate command).
+
+
+ system_mode_maintenance_dont_generate_profile + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
When system_mode_maintenance_dont_generate_profile=true it prevents the dynamic searching of enabled protocols and executes commands configured in a maintenance-mode profile. Use this option if you want the system to use a maintenance-mode profile that you have created. When system_mode_maintenance_dont_generate_profile=false it prevents the dynamic searching of enabled protocols and executes commands configured in a normal-mode profile. Use this option if you want the system to use a normal-mode profile that you have created.
+
+
+ system_mode_maintenance_on_reload_reset_reason + +
+ string +
+ 		+
    Choices: +
  • hw_error
    • +
  • svc_failure
    • +
  • kern_failure
    • +
  • wdog_timeout
    • +
  • fatal_error
    • +
  • lc_failure
    • +
  • match_any
    • +
  • manual_reload
    • +
  • any_other
    • +
  • maintenance
    • +
+ 		+
Boots the switch into maintenance mode automatically in the event of a specified system crash. Note that not all reset reasons are applicable for all platforms. Also if reset reason is set to match_any, it is not idempotent as it turns on all reset reasons. If reset reason is match_any and state is absent, it turns off all the reset reasons.
+
+
+ system_mode_maintenance_shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Shuts down all protocols, vPC domains, and interfaces except the management interface (using the shutdown command). This option is disruptive while system_mode_maintenance (which uses the isolate command) is not.
+
+
+ system_mode_maintenance_timeout + +
+ string +
+ 		+ +
Keeps the switch in maintenance mode for a specified number of minutes. Range is 5-65535.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - ``state`` has effect only in combination with ``system_mode_maintenance_timeout`` or ``system_mode_maintenance_on_reload_reset_reason``. + - Using ``system_mode_maintenance`` and ``system_mode_maintenance_dont_generate_profile`` would make the module fail, but the system mode will be triggered anyway. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Trigger system maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance: true + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Trigger system normal mode + - cisco.nxos.nxos_gir: + system_mode_maintenance: false + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Configure on-reload reset-reason for maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance_on_reload_reset_reason: manual_reload + state: present + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Add on-reload reset-reason for maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance_on_reload_reset_reason: hw_error + state: present + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Remove on-reload reset-reason for maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance_on_reload_reset_reason: manual_reload + state: absent + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Set timeout for maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance_timeout: 30 + state: present + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Remove timeout for maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance_timeout: 30 + state: absent + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ final_system_mode + +
+ string +
+ 		verbose mode +
describe the last system mode
+
+
Sample:
+
normal
+
+
+ updates + +
+ list +
+ 		verbose mode +
commands sent to the device
+
+
Sample:
+
['terminal dont-ask', 'system mode maintenance timeout 10']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_gir_profile_management_module.rst b/docs/cisco.nxos.nxos_gir_profile_management_module.rst new file mode 100644 index 000000000..95d85ae9b --- /dev/null +++ b/docs/cisco.nxos.nxos_gir_profile_management_module.rst @@ -0,0 +1,235 @@ +.. _cisco.nxos.nxos_gir_profile_management_module: + + +************************************** +cisco.nxos.nxos_gir_profile_management +************************************** + +**Create a maintenance-mode or normal-mode profile for GIR.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manage a maintenance-mode or normal-mode profile with configuration commands that can be applied during graceful removal or graceful insertion. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ commands + +
+ list + / elements=string +
+ 		+ +
List of commands to be included into the profile.
+
+
+ mode + +
+ string + / required +
+ 		+
    Choices: +
  • maintenance
    • +
  • normal
    • +
+ 		+
Configure the profile as Maintenance or Normal mode.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specify desired state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - ``state=absent`` removes the whole profile. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Create a maintenance-mode profile + - cisco.nxos.nxos_gir_profile_management: + mode: maintenance + commands: + - router eigrp 11 + - isolate + + # Remove the maintenance-mode profile + - cisco.nxos.nxos_gir_profile_management: + mode: maintenance + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ end_state + +
+ list +
+ 		verbose mode +
list of profile entries after module execution.
+
+
Sample:
+
['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete', 'router eigrp 11', 'isolate']
+
+
+ existing + +
+ list +
+ 		verbose mode +
list of existing profile commands.
+
+
Sample:
+
['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete']
+
+
+ proposed + +
+ list +
+ 		verbose mode +
list of commands passed into module.
+
+
Sample:
+
['router eigrp 11', 'isolate']
+
+
+ updates + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['configure maintenance profile maintenance-mode', 'router eigrp 11', 'isolate']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_hostname_module.rst b/docs/cisco.nxos.nxos_hostname_module.rst new file mode 100644 index 000000000..c8a9ee45d --- /dev/null +++ b/docs/cisco.nxos.nxos_hostname_module.rst @@ -0,0 +1,344 @@ +.. _cisco.nxos.nxos_hostname_module: + + +************************ +cisco.nxos.nxos_hostname +************************ + +**Hostname resource module.** + + +Version added: 2.9.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages hostname configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A dictionary of hostname configuration.
+
+
+ hostname + +
+ string +
+ 		+ +
Hostname of the device.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section hostname.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
The states merged, replaced and overridden have identical behaviour for this module.
+
Refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged (replaced, overridden has the same behaviour) + + # Before state: + # ------------- + # nxos-9k-rdo# show running-config | section ^hostname + # nxos-9k-rdo# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_hostname: + config: + hostname: NXOSv-9k + + # Task output + # ------------- + # before: {} + # + # commands: + # - hostname NXOSv-9k + # + # after: + # hostname: NXOSv-9k + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section ^hostname + # hostname NXOSv-9k + # + + # Using deleted + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section ^hostname + # hostname NXOSv-9k + + - name: Delete hostname from running-config + cisco.nxos.nxos_hostname: + state: deleted + + # Task output + # ------------- + # before: + # hostname: NXOSv-9k + # + # commands: + # - no hostname NXOSv-9k + # + # after: {} + + # Using gathered + + - name: Gather hostname facts using gathered + cisco.nxos.nxos_hostname: + state: gathered + + # Task output (redacted) + # ----------------------- + # gathered: + # hostname: NXOSv-9k + + # Using rendered + + - name: Render platform specific configuration lines (without connecting to the device) + cisco.nxos.nxos_hostname: + config: + hostname: NXOSv-9k + + # Task Output (redacted) + # ----------------------- + # rendered: + # - hostname NXOSv-9k + + # Using parsed + + # parsed.cfg + # ------------ + # hostname NXOSv-9k + + - name: Parse externally provided hostname config + cisco.nxos.nxos_hostname: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # hostname: NXOSv-9k + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['hostname switch01']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['hostname switch01']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst b/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst new file mode 100644 index 000000000..163612413 --- /dev/null +++ b/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst @@ -0,0 +1,344 @@ +.. _cisco.nxos.nxos_hsrp_interfaces_module: + + +******************************* +cisco.nxos.nxos_hsrp_interfaces +******************************* + +**HSRP interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages Hot Standby Router Protocol (HSRP) interface attributes. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
The provided configuration
+
+
+ bfd + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/Disable HSRP Bidirectional Forwarding Detection (BFD) on the interface.
+
+
+ name + +
+ string +
+ 		+ +
The name of the interface.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state the configuration should be left in
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 7.0(3)I5(1). + - Feature bfd should be enabled for this module. + - Unsupported for Cisco MDS + + + +Examples +-------- + +.. code-block:: yaml + + # Using deleted + + - name: Configure hsrp attributes on interfaces + cisco.nxos.nxos_hsrp_interfaces: + config: + - name: Ethernet1/1 + - name: Ethernet1/2 + operation: deleted + + + # Using merged + + - name: Configure hsrp attributes on interfaces + cisco.nxos.nxos_hsrp_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + - name: Ethernet1/2 + bfd: disable + operation: merged + + + # Using overridden + + - name: Configure hsrp attributes on interfaces + cisco.nxos.nxos_hsrp_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + - name: Ethernet1/2 + bfd: disable + operation: overridden + + + # Using replaced + + - name: Configure hsrp attributes on interfaces + cisco.nxos.nxos_hsrp_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + - name: Ethernet1/2 + bfd: disable + operation: replaced + + # Using rendered + + - name: Use rendered state to convert task input to device specific commands + cisco.nxos.nxos_hsrp_interfaces: + config: + - name: Ethernet1/800 + bfd: enable + - name: Ethernet1/801 + bfd: enable + state: rendered + + # Task Output (redacted) + # ----------------------- + + # rendered: + # - "interface Ethernet1/800" + # - "hsrp bfd" + # - "interface Ethernet1/801" + # - "hsrp bfd" + + # Using parsed + + # parsed.cfg + # ------------ + # interface Ethernet1/800 + # no switchport + # hsrp bfd + # interface Ethernet1/801 + # no switchport + # hsrp bfd + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_hsrp_interfaces: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + + # parsed: + # - name: Ethernet1/800 + # bfd: enable + # - name: Ethernet1/801 + # bfd: enable + + # Using gathered + + # Existing device config state + # ------------------------------- + + # interface Ethernet1/1 + # no switchport + # hsrp bfd + # interface Ethernet1/2 + # no switchport + # hsrp bfd + # interface Ethernet1/3 + # no switchport + + - name: Gather hsrp_interfaces facts from the device using nxos_hsrp_interfaces + cisco.nxos.nxos_hsrp_interfaces: + state: gathered + + # Task output (redacted) + # ----------------------- + + # gathered: + # - name: Ethernet1/1 + # bfd: enable + # - name: Ethernet1/2 + # bfd: enable + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/1', 'hsrp bfd']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_hsrp_module.rst b/docs/cisco.nxos.nxos_hsrp_module.rst new file mode 100644 index 000000000..0a55a4423 --- /dev/null +++ b/docs/cisco.nxos.nxos_hsrp_module.rst @@ -0,0 +1,305 @@ +.. _cisco.nxos.nxos_hsrp_module: + + +******************** +cisco.nxos.nxos_hsrp +******************** + +**Manages HSRP configuration on NX-OS switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages HSRP configuration on NX-OS switches. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ auth_string + +
+ string +
+ 		+ +
Authentication string. If this needs to be hidden(for md5 type), the string should be 7 followed by the key string. Otherwise, it can be 0 followed by key string or just key string (for backward compatibility). For text type, this should be just be a key string. if this is 'default', authentication is removed.
+
+
+ auth_type + +
+ string +
+ 		+
    Choices: +
  • text
    • +
  • md5
    • +
+ 		+
Authentication type.
+
+
+ group + +
+ string + / required +
+ 		+ +
HSRP group number.
+
+
+ interface + +
+ string + / required +
+ 		+ +
Full name of interface that is being managed for HSRP.
+
+
+ preempt + +
+ string +
+ 		+
    Choices: +
  • enabled
    • +
  • disabled
    • +
+ 		+
Enable/Disable preempt.
+
+
+ priority + +
+ string +
+ 		+ +
HSRP priority or keyword 'default'.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specify desired state of the resource.
+
+
+ version + +
+ string +
+ 		+
    Choices: +
  • 1 ←
    • +
  • 2
    • +
+ 		+
HSRP version.
+
+
+ vip + +
+ string +
+ 		+ +
HSRP virtual IP address or keyword 'default'
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - HSRP feature needs to be enabled first on the system. + - SVIs must exist before using this module. + - Interface must be a L3 port before using this module. + - HSRP cannot be configured on loopback interfaces. + - MD5 authentication is only possible with HSRPv2 while it is ignored if HSRPv1 is used instead, while it will not raise any error. Here we allow MD5 authentication only with HSRPv2 in order to enforce better practice. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Ensure HSRP is configured with following params on a SVI + cisco.nxos.nxos_hsrp: + group: 10 + vip: 10.1.1.1 + priority: 150 + interface: vlan10 + preempt: enabled + + - name: Ensure HSRP is configured with following params on a SVI with clear text authentication + cisco.nxos.nxos_hsrp: + group: 10 + vip: 10.1.1.1 + priority: 150 + interface: vlan10 + preempt: enabled + auth_type: text + auth_string: CISCO + + - name: Ensure HSRP is configured with md5 authentication and clear authentication + string + cisco.nxos.nxos_hsrp: + group: 10 + vip: 10.1.1.1 + priority: 150 + interface: vlan10 + preempt: enabled + auth_type: md5 + auth_string: 0 1234 + + - name: Ensure HSRP is configured with md5 authentication and hidden authentication + string + cisco.nxos.nxos_hsrp: + group: 10 + vip: 10.1.1.1 + priority: 150 + interface: vlan10 + preempt: enabled + auth_type: md5 + auth_string: 7 1234 + + - name: Remove HSRP config for given interface, group, and VIP + cisco.nxos.nxos_hsrp: + group: 10 + interface: vlan10 + vip: 10.1.1.1 + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['interface vlan10', 'hsrp version 2', 'hsrp 30', 'ip 10.30.1.1']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_igmp_module.rst b/docs/cisco.nxos.nxos_igmp_module.rst new file mode 100644 index 000000000..dbb46206f --- /dev/null +++ b/docs/cisco.nxos.nxos_igmp_module.rst @@ -0,0 +1,191 @@ +.. _cisco.nxos.nxos_igmp_module: + + +******************** +cisco.nxos.nxos_igmp +******************** + +**Manages IGMP global configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages IGMP global configuration configuration settings. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ enforce_rtr_alert + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables or disables the enforce router alert option check for IGMPv2 and IGMPv3 packets.
+
+
+ flush_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Removes routes when the IGMP process is restarted. By default, routes are not flushed.
+
+
+ restart + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Restarts the igmp process (using an exec config command).
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • default
    • +
+ 		+
Manages desired state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - When ``state=default``, all supported params will be reset to a default state. + - If restart is set to true with other params set, the restart will happen last, i.e. after the configuration takes place. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Default igmp global params (all params except restart) + cisco.nxos.nxos_igmp: + state: default + + - name: Ensure the following igmp global config exists on the device + cisco.nxos.nxos_igmp: + flush_routes: true + enforce_rtr_alert: true + + - name: Restart the igmp process + cisco.nxos.nxos_igmp: + restart: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ updates + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['ip igmp flush-routes']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_igmp_snooping_module.rst b/docs/cisco.nxos.nxos_igmp_snooping_module.rst new file mode 100644 index 000000000..31af97509 --- /dev/null +++ b/docs/cisco.nxos.nxos_igmp_snooping_module.rst @@ -0,0 +1,225 @@ +.. _cisco.nxos.nxos_igmp_snooping_module: + + +***************************** +cisco.nxos.nxos_igmp_snooping +***************************** + +**Manages IGMP snooping global configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages IGMP snooping global configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ group_timeout + +
+ string +
+ 		+ +
Group membership timeout value for all VLANs on the device. Accepted values are integer in range 1-10080, never and default.
+
+
+ link_local_grp_supp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Global link-local groups suppression.
+
+
+ report_supp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Global IGMPv1/IGMPv2 Report Suppression.
+
+
+ snooping + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/disables IGMP snooping on the switch.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • default
    • +
+ 		+
Manage the state of the resource.
+
+
+ v3_report_supp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Global IGMPv3 Report Suppression and Proxy Reporting.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - When ``state=default``, params will be reset to a default state. + - ``group_timeout`` also accepts *never* as an input. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure igmp snooping params supported in this module are in there default state + - cisco.nxos.nxos_igmp_snooping: + state: default + + # ensure following igmp snooping params are in the desired state + - cisco.nxos.nxos_igmp_snooping: + group_timeout: never + snooping: true + link_local_grp_supp: false + optimize_mcast_flood: false + report_supp: true + v3_report_supp: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['ip igmp snooping link-local-groups-suppression', 'ip igmp snooping group-timeout 50', 'no ip igmp snooping report-suppression', 'no ip igmp snooping v3-report-suppression', 'no ip igmp snooping']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_install_os_module.rst b/docs/cisco.nxos.nxos_install_os_module.rst new file mode 100644 index 000000000..ddd630d01 --- /dev/null +++ b/docs/cisco.nxos.nxos_install_os_module.rst @@ -0,0 +1,183 @@ +.. _cisco.nxos.nxos_install_os_module: + + +************************** +cisco.nxos.nxos_install_os +************************** + +**Set boot options like boot, kickstart image and issu.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Install an operating system by setting the boot options like boot image and kickstart image and optionally select to install using ISSU (In Server Software Upgrade). + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ issu + +
+ string +
+ 		+
    Choices: +
  • required
    • +
  • desired
    • +
  • yes
    • +
  • no ←
    • +
+ 		+
Upgrade using In Service Software Upgrade (ISSU). (Supported on N5k, N7k, N9k platforms)
+
Selecting 'required' or 'yes' means that upgrades will only proceed if the switch is capable of ISSU.
+
Selecting 'desired' means that upgrades will use ISSU if possible but will fall back to disruptive upgrade if needed.
+
Selecting 'no' means do not use ISSU. Forced disruptive.
+
+
+ kickstart_image_file + +
+ string +
+ 		+ +
Name of the kickstart image file on flash. (Not required on all Nexus platforms)
+
+
+ system_image_file + +
+ string + / required +
+ 		+ +
Name of the system (or combined) image file on flash.
+
+
+ + +Notes +----- + +.. note:: + - Tested against the following platforms and images - N9k 7.0(3)I4(6), 7.0(3)I5(3), 7.0(3)I6(1), 7.0(3)I7(1), 7.0(3)F2(2), 7.0(3)F3(2) - N3k 6.0(2)A8(6), 6.0(2)A8(8), 7.0(3)I6(1), 7.0(3)I7(1) - N7k 7.3(0)D1(1), 8.0(1), 8.1(1), 8.2(1) + - Tested against Cisco MDS NX-OS 9.2(1) + - This module requires both the ANSIBLE_PERSISTENT_CONNECT_TIMEOUT and ANSIBLE_PERSISTENT_COMMAND_TIMEOUT timers to be set to 600 seconds or higher. The module will exit if the timers are not set properly. + - When using connection local, ANSIBLE_PERSISTENT_CONNECT_TIMEOUT and ANSIBLE_PERSISTENT_COMMAND_TIMEOUT can only be set using ENV variables or the ansible.cfg file. + - Do not include full file paths, just the name of the file(s) stored on the top level flash directory. + - This module attempts to install the software immediately, which may trigger a reboot. + - In check mode, the module will indicate if an upgrade is needed and whether or not the upgrade is disruptive or non-disruptive(ISSU). + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Install OS on N9k + check_mode: false + cisco.nxos.nxos_install_os: + system_image_file: nxos.7.0.3.I6.1.bin + issu: desired + + - name: Wait for device to come back up with new image + wait_for: + port: 22 + state: started + timeout: 500 + delay: 60 + host: '{{ inventory_hostname }}' + + - name: Check installed OS for newly installed version + nxos_command: + commands: [show version | json] + register: output + + - assert: + that: + - output['stdout'][0]['kickstart_ver_str'] == '7.0(3)I6(1)' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ install_state + +
+ dictionary +
+ 		always +
Boot and install information.
+
+
Sample:
+
{'install_state': ['Compatibility check is done:', 'Module bootable Impact Install-type Reason', '------ -------- -------------- ------------ ------', ' 1 yes non-disruptive reset ', 'Images will be upgraded according to following table:', 'Module Image Running-Version(pri:alt) New-Version Upg-Required', '------ ---------- ---------------------------------------- -------------------- ------------', ' 1 nxos 7.0(3)I6(1) 7.0(3)I7(1) yes', ' 1 bios v4.4.0(07/12/2017) v4.4.0(07/12/2017) no']}
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbibo (@GGabriele) diff --git a/docs/cisco.nxos.nxos_l2_interfaces_module.rst b/docs/cisco.nxos.nxos_l2_interfaces_module.rst new file mode 100644 index 000000000..bfad0cf31 --- /dev/null +++ b/docs/cisco.nxos.nxos_l2_interfaces_module.rst @@ -0,0 +1,648 @@ +.. _cisco.nxos.nxos_l2_interfaces_module: + + +***************************** +cisco.nxos.nxos_l2_interfaces +***************************** + +**L2 interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages Layer-2 interfaces attributes of NX-OS Interfaces. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary of Layer-2 interface options
+
+
+ access + +
+ dictionary +
+ 		+ +
Switchport mode access command to configure the interface as a Layer-2 access.
+
+
+ vlan + +
+ integer +
+ 		+ +
Configure given VLAN in access port. It's used as the access VLAN ID.
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • dot1q-tunnel
    • +
  • access
    • +
  • trunk
    • +
  • fex-fabric
    • +
  • fabricpath
    • +
+ 		+
Mode in which interface needs to be configured.
+
Access mode is not shown in interface facts, so idempotency will not be maintained for switchport mode access and every time the output will come as changed=True.
+
+
+ name + +
+ string + / required +
+ 		+ +
Full name of interface, i.e. Ethernet1/1.
+
+
+ trunk + +
+ dictionary +
+ 		+ +
Switchport mode trunk command to configure the interface as a Layer-2 trunk.
+
+
+ allowed_vlans + +
+ string +
+ 		+ +
List of allowed VLANs in a given trunk port. These are the only VLANs that will be configured on the trunk.
+
+
+ native_vlan + +
+ integer +
+ 		+ +
Native VLAN to be configured in trunk port. It is used as the trunk native VLAN ID.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section ^interface.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state of the configuration after module completion.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOS 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # interface Ethernet1/2 + # switchport trunk native vlan 20 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + - name: Merge provided configuration with device configuration + cisco.nxos.nxos_l2_interfaces: + config: + - name: Ethernet1/1 + trunk: + native_vlan: 10 + allowed_vlans: 2,4,15 + - name: Ethernet1/2 + access: + vlan: 30 + state: merged + + # Task Output + # ----------- + # + # before: + # - name: Loopback999 + # - name: Ethernet1/2 + # - name: mgmt0 + # - name: Ethernet1/1 + # commands: + # - interface Ethernet1/1 + # - switchport trunk allowed vlan 2,4,15 + # - switchport trunk native vlan 10 + # - interface Ethernet1/2 + # - switchport access vlan 30 + # after: + # - name: Ethernet1/1 + # trunk: + # allowed_vlans: 2,4,15 + # native_vlan: 10 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + # - name: Loopback999 + + # After state: + # ------------ + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # switchport trunk native vlan 10 + # switchport trunk allowed vlans 2,4,15 + # interface Ethernet1/2 + # switchport access vlan 30 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + # Using replaced + + # Before state: + # ------------- + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # switchport trunk native vlan 10 + # switchport trunk allowed vlans 2,4,15 + # interface Ethernet1/2 + # switchport access vlan 30 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + - name: Replace device configuration of specified L2 interfaces with provided configuration. + cisco.nxos.nxos_l2_interfaces: + config: + - name: Ethernet1/1 + trunk: + native_vlan: 20 + allowed_vlans: 5-10, 15 + state: replaced + + # Task Output + # ----------- + # + # before: + # - name: Ethernet1/1 + # trunk: + # allowed_vlans: 2,4,15 + # native_vlan: 10 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + # commands: + # - interface Ethernet1/1 + # - no switchport trunk native vlan + # - switchport trunk allowed vlan 5-10,15 + # - switchport trunk native vlan 20 + # after: + # - name: Ethernet1/1 + # trunk: + # allowed_vlans: 5-10,15 + # native_vlan: 20 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + + # After state: + # ------------ + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # switchport trunk native vlan 20 + # switchport trunk allowed vlan 5-10,15 + # interface Ethernet1/2 + # switchport trunk native vlan 20 + # switchport mode trunk + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + # Using overridden + + # Before state: + # ------------- + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # switchport trunk native vlan 20 + # switchport trunk allowed vlan 5-10,15 + # interface Ethernet1/2 + # switchport trunk native vlan 20 + # switchport mode trunk + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + - name: Override device configuration with provided configuration. + cisco.nxos.nxos_l2_interfaces: + config: + - name: Ethernet1/2 + access: + vlan: 30 + state: overridden + + # Task Output + # ----------- + # + # before: + # - name: Ethernet1/1 + # trunk: + # allowed_vlans: 5,6,7,8,9,10,15 + # native_vlan: 20 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + # commands: + # - interface Ethernet1/1 + # - no switchport trunk allowed vlan + # - no switchport trunk native vlan + # after: + # - name: Ethernet1/1 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + + # After state: + # ------------ + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # interface Ethernet1/2 + # switchport access vlan 30 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + + # Using deleted + + # Before state: + # ------------- + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # switchport trunk native vlan 10 + # switchport trunk allowed vlan 2,4,15 + # interface Ethernet1/2 + # switchport access vlan 30 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + - name: Delete L2 attributes of given interfaces (Note This won't delete the interface + itself). + cisco.nxos.nxos_l2_interfaces: + config: + - name: Ethernet1/1 + - name: Ethernet1/2 + state: deleted + + # Task Output + # ----------- + # + # before: + # - name: Ethernet1/1 + # trunk: + # allowed_vlans: 2,4,15 + # native_vlan: 10 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + # commands: + # - interface Ethernet1/1 + # - no switchport trunk allowed vlan + # - no switchport trunk native vlan + # - interface Ethernet1/2 + # - no switchport access vlan + # after: + # - name: Ethernet1/1 + # - name: Ethernet1/2 + # - name: mgmt0 + + # After state: + # ------------ + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # interface Ethernet1/2 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + # Using rendered + + - name: Render platform specific configuration lines (without connecting to the device) + cisco.nxos.nxos_l2_interfaces: + config: + - name: Ethernet1/1 + trunk: + native_vlan: 10 + allowed_vlans: 2,4,15 + - name: Ethernet1/2 + access: + vlan: 30 + - name: Ethernet1/3 + trunk: + native_vlan: 20 + allowed_vlans: 5-10, 15 + state: rendered + + # Task Output + # ----------- + # + # rendered: + # - interface Ethernet1/1 + # - switchport trunk allowed vlan 2,4,15 + # - switchport trunk native vlan 10 + # - interface Ethernet1/2 + # - switchport access vlan 30 + # - interface Ethernet1/3 + # - switchport trunk allowed vlan 5-10,15 + # - switchport trunk native vlan 20 + + # Using parsed + + # parsed.cfg + # ------------ + # + # interface Ethernet1/800 + # switchport access vlan 18 + # switchport trunk allowed vlan 210 + # interface Ethernet1/801 + # switchport trunk allowed vlan 2,4,15 + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_l2_interfaces: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output + # ----------- + # + # parsed: + # - name: Ethernet1/800 + # access: + # vlan: 18 + # trunk: + # allowed_vlans: "210" + # - name: Ethernet1/801 + # trunk: + # allowed_vlans: "2,4,15" + + # Using gathered + + # Before state: + # ------------- + # + # switch# sh running-config | section ^interface + # interface Ethernet1/1 + # switchport access vlan 6 + # switchport trunk allowed vlan 200 + # interface Ethernet1/2 + # switchport trunk native vlan 10 + + - name: Gather l2_interfaces facts from the device using nxos_l2_interfaces + cisco.nxos.nxos_l2_interfaces: + state: gathered + + # Task output + # ----------- + # + # gathered: + # - name: "Ethernet1/1" + # access: + # vlan: 6 + # trunk: + # allowed_vlans: "200" + # - name: "Ethernet1/2" + # trunk: + # native_vlan: 10 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/1', 'switchport trunk allowed vlan 2,4,15', 'switchport trunk native vlan 10', 'interface Ethernet1/2', 'switchport access vlan 30', 'interface Ethernet1/3', 'switchport trunk allowed vlan 5,6,7,8,9,10,15', 'switchport trunk native vlan 20']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_l3_interfaces_module.rst b/docs/cisco.nxos.nxos_l3_interfaces_module.rst new file mode 100644 index 000000000..28a56bdf8 --- /dev/null +++ b/docs/cisco.nxos.nxos_l3_interfaces_module.rst @@ -0,0 +1,884 @@ +.. _cisco.nxos.nxos_l3_interfaces_module: + + +***************************** +cisco.nxos.nxos_l3_interfaces +***************************** + +**L3 interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages Layer-3 interfaces attributes of NX-OS Interfaces. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary of Layer-3 interface options
+
+
+ dot1q + +
+ integer +
+ 		+ +
Configures IEEE 802.1Q VLAN encapsulation on a subinterface.
+
+
+ evpn_multisite_tracking + +
+ string +
+
added in 1.1.0
+ 		+
    Choices: +
  • fabric-tracking
    • +
  • dci-tracking
    • +
+ 		+
VxLAN evpn multisite Interface tracking. Supported only on selected model.
+
+
+ ipv4 + +
+ list + / elements=dictionary +
+ 		+ +
IPv4 address and attributes of the L3 interface.
+
+
+ address + +
+ string +
+ 		+ +
IPV4 address of the L3 interface.
+
+
+ secondary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
A boolean attribute to manage addition of secondary IP address.
+
+
+ tag + +
+ integer +
+ 		+ +
URIB route tag value for local/direct routes.
+
+
+ ipv6 + +
+ list + / elements=dictionary +
+ 		+ +
IPv6 address and attributes of the L3 interface.
+
+
+ address + +
+ string +
+ 		+ +
IPV6 address of the L3 interface.
+
+
+ tag + +
+ integer +
+ 		+ +
URIB route tag value for local/direct routes.
+
+
+ ipv6_redirects + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/disables ipv6 redirects.
+
+
+ name + +
+ string + / required +
+ 		+ +
Full name of L3 interface, i.e. Ethernet1/1.
+
+
+ redirects + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/disables ipv4 redirects.
+
+
+ unreachables + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/disables ip redirects.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state of the configuration after module completion.
+
The state overridden would override the IP address configuration of all interfaces on the device with the provided configuration in the task. Use caution with this state as you may loose access to the device.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOS 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no shutdown + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + - name: Merge provided configuration with device configuration. + cisco.nxos.nxos_l3_interfaces: + config: + - name: Ethernet1/6 + ipv4: + - address: 192.168.1.1/24 + tag: 5 + - address: 10.1.1.1/24 + secondary: true + tag: 10 + ipv6: + - address: fd5d:12c9:2201:2::1/64 + tag: 6 + - name: Ethernet1/7.42 + redirects: false + unreachables: false + state: merged + + # Task Output + # ----------- + # + # before: + # - name: Ethernet1/6 + # - name: Ethernet1/7 + # - ipv4: + # - address: dhcp + # name: mgmt0 + # commands: + # - interface Ethernet1/6 + # - ip address 192.168.1.1/24 tag 5 + # - ip address 10.1.1.1/24 secondary tag 10 + # - ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + # - interface Ethernet1/7 + # - no ip redirects + # after: + # - ipv4: + # - address: 192.168.1.1/24 + # tag: 5 + # - address: 10.1.1.1/24 + # secondary: true + # tag: 10 + # ipv6: + # - address: fd5d:12c9:2201:2::1/64 + # tag: 6 + # name: Ethernet1/6 + # redirects: false + # - name: Ethernet1/7 + # redirects: false + # - ipv4: + # - address: dhcp + # name: mgmt0 + + # After state: + # ------------ + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no ip redirects + # ip address 192.168.1.1/24 tag 5 + # ip address 10.1.1.1/24 secondary tag 10 + # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no ip redirects + # no shutdown + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + + # Using replaced + + # Before state: + # ------------- + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no ip redirects + # ip address 192.168.1.1/24 tag 5 + # ip address 10.1.1.1/24 secondary tag 10 + # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no ip redirects + # no shutdown + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + - name: Replace device configuration of specified L3 interfaces with provided configuration. + cisco.nxos.nxos_l3_interfaces: + config: + - name: Ethernet1/6 + ipv4: + - address: 192.168.22.3/24 + state: replaced + + # Task Output + # ----------- + # + # before: + # - ipv4: + # - address: 192.168.1.1/24 + # tag: 5 + # - address: 10.1.1.1/24 + # secondary: true + # tag: 10 + # ipv6: + # - address: fd5d:12c9:2201:2::1/64 + # tag: 6 + # name: Ethernet1/6 + # redirects: false + # - name: Ethernet1/7 + # redirects: false + # - ipv4: + # - address: dhcp + # name: mgmt0 + # commands: + # - interface Ethernet1/6 + # - ip address 192.168.22.3/24 + # - no ipv6 address fd5d:12c9:2201:2::1/64 + # - ip redirects + # after: + # - ipv4: + # - address: 192.168.22.3/24 + # - address: 10.1.1.1/24 + # secondary: true + # tag: 10 + # name: Ethernet1/6 + # redirects: false + # - name: Ethernet1/7 + # redirects: false + # - ipv4: + # - address: dhcp + # name: mgmt0 + + # After state: + # ------------ + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no ip redirects + # ip address 192.168.22.3/24 + # ip address 10.1.1.1/24 secondary tag 10 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no ip redirects + # no shutdown + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + # Using overridden + + # Before state: + # ------------- + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no ip redirects + # ip address 192.168.1.1/24 tag 5 + # ip address 10.1.1.1/24 secondary tag 10 + # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no ip redirects + # no shutdown + # interface Ethernet1/7.42 + # no ip redirects + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + - name: Override device configuration with provided configuration. + cisco.nxos.nxos_l3_interfaces: + config: + - ipv4: + - address: dhcp + name: mgmt0 + - name: Ethernet1/6 + ipv4: + - address: 192.168.22.3/24 + state: overridden + + # Task Output + # ----------- + # + # before: + # - ipv4: + # - address: 192.168.1.1/24 + # tag: 5 + # - address: 10.1.1.1/24 + # secondary: true + # tag: 10 + # ipv6: + # - address: fd5d:12c9:2201:2::1/64 + # tag: 6 + # name: Ethernet1/6 + # redirects: false + # - name: Ethernet1/7 + # redirects: false + # - name: Ethernet1/7.42 + # redirects: false + # - ipv4: + # - address: dhcp + # name: mgmt0 + # commands: + # - interface Ethernet1/6 + # - no ipv6 address fd5d:12c9:2201:2::1/64 + # - no ip address 10.1.1.1/24 secondary + # - ip address 192.168.22.3/24 + # - ip redirects + # - interface Ethernet1/7 + # - ip redirects + # - interface Ethernet1/7.42 + # - ip redirects + # after: + # - ipv4: + # - address: 192.168.22.3/24 + # name: Ethernet1/6 + # - name: Ethernet1/7 + # - name: Ethernet1/7.42 + # - ipv4: + # - address: dhcp + # name: mgmt0 + + # After state: + # ------------ + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # ip address 192.168.22.3/24 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no shutdown + # interface Ethernet1/7.42 + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + # Using deleted + + # Before state: + # ------------- + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # ip address 192.168.22.3/24 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no shutdown + # interface Ethernet1/7.42 + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + - name: Delete L3 attributes of given interfaces (This won't delete the interface + itself). + cisco.nxos.nxos_l3_interfaces: + config: + - name: Ethernet1/6 + - name: Ethernet1/2 + state: deleted + + # Task Output + # ----------- + # + # before: + # - name: Ethernet1/2 + # - ipv4: + # - address: 192.168.22.3/24 + # name: Ethernet1/6 + # - name: Ethernet1/7 + # - name: Ethernet1/7.42 + # - ipv4: + # - address: dhcp + # name: mgmt0 + # commands: + # - interface Ethernet1/6 + # - no ip address + # after: + # - name: Ethernet1/2 + # - name: Ethernet1/7 + # - name: Ethernet1/7.42 + # - ipv4: + # - address: dhcp + # name: mgmt0 + + # After state: + # ------------ + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no shutdown + # interface Ethernet1/7.42 + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + # Using rendered + + - name: Use rendered state to convert task input to device specific commands + cisco.nxos.nxos_l3_interfaces: + config: + - name: Ethernet1/800 + ipv4: + - address: 192.168.1.100/24 + tag: 5 + - address: 10.1.1.1/24 + secondary: true + tag: 10 + - name: Ethernet1/800 + ipv6: + - address: fd5d:12c9:2201:2::1/64 + tag: 6 + state: rendered + + # Task Output + # ----------- + # + # rendered: + # - interface Ethernet1/800 + # - ip address 192.168.1.100/24 tag 5 + # - ip address 10.1.1.1/24 secondary tag 10 + # - interface Ethernet1/800 + # - ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + + # Using parsed + + # parsed.cfg + # ---------- + # + # interface Ethernet1/800 + # ip address 192.168.1.100/24 tag 5 + # ip address 10.1.1.1/24 secondary tag 10 + # no ip redirects + # interface Ethernet1/801 + # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + # ip unreachables + # interface mgmt0 + # ip address dhcp + # vrf member management + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_l3_interfaces: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output + # ----------- + # + # parsed: + # - name: Ethernet1/800 + # ipv4: + # - address: 192.168.1.100/24 + # tag: 5 + # - address: 10.1.1.1/24 + # secondary: True + # tag: 10 + # redirects: False + # - name: Ethernet1/801 + # ipv6: + # - address: fd5d:12c9:2201:2::1/64 + # tag: 6 + # unreachables: True + + # Using gathered + + # Before state: + # ------------- + # + # interface Ethernet1/1 + # ip address 192.0.2.100/24 + # interface Ethernet1/2 + # no ip redirects + # ip address 203.0.113.10/24 + # ip unreachables + # ipv6 address 2001:db8::1/32 + + - name: Gather l3_interfaces facts from the device using nxos_l3_interfaces + cisco.nxos.nxos_l3_interfaces: + state: gathered + + # Task output + # ----------- + # + # gathered: + # - name: Ethernet1/1 + # ipv4: + # - address: 192.0.2.100/24 + # - name: Ethernet1/2 + # ipv4: + # - address: 203.0.113.10/24 + # ipv6: + # - address: 2001:db8::1/32 + # redirects: False + # unreachables: True + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/2', 'ip address 192.168.0.1/2']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_lacp_module.rst b/docs/cisco.nxos.nxos_lacp_module.rst new file mode 100644 index 000000000..b0410c783 --- /dev/null +++ b/docs/cisco.nxos.nxos_lacp_module.rst @@ -0,0 +1,402 @@ +.. _cisco.nxos.nxos_lacp_module: + + +******************** +cisco.nxos.nxos_lacp +******************** + +**LACP resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages Global Link Aggregation Control Protocol (LACP) on NX-OS devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
LACP global options.
+
+
+ system + +
+ dictionary +
+ 		+ +
LACP system options
+
+
+ mac + +
+ dictionary +
+ 		+ +
MAC address to be used for the LACP Protocol exchanges
+
+
+ address + +
+ string +
+ 		+ +
MAC-address (FORMAT :xxxx.xxxx.xxxx).
+
+
+ role + +
+ string +
+ 		+
    Choices: +
  • primary
    • +
  • secondary
    • +
+ 		+
The role for the Switch.
+
+
+ priority + +
+ integer +
+ 		+ +
The system priority to use in LACP negotiations.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | include lacp.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state of the configuration after module completion.
+
States replaced and overridden have the same behaviour for this module.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOS 7.3.(0)D1(1) on VIRL. + - Unsupported for Cisco MDS + - Feature lacp should be enabled for this module. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + + - name: Merge provided configuration with device configuration. + cisco.nxos.nxos_lacp: + config: + system: + priority: 10 + mac: + address: 00c1.4c00.bd15 + state: merged + + # After state: + # ------------ + # + # lacp system-priority 10 + # lacp system-mac 00c1.4c00.bd15 + + + # Using replaced + + # Before state: + # ------------- + # + # lacp system-priority 10 + + - name: Replace device global lacp configuration with the given configuration. + cisco.nxos.nxos_lacp: + config: + system: + mac: + address: 00c1.4c00.bd15 + state: replaced + + # After state: + # ------------ + # + # lacp system-mac 00c1.4c00.bd15 + + + # Using deleted + + # Before state: + # ------------- + # + # lacp system-priority 10 + + - name: Delete global LACP configurations. + cisco.nxos.nxos_lacp: + state: deleted + + # After state: + # ------------ + # + + # Using rendered + + - name: Render platform specific configuration lines (without connecting to the device) + cisco.nxos.nxos_lacp: + config: + system: + priority: 10 + mac: + address: 00c1.4c00.bd15 + role: secondary + state: rendered + + # Task Output (redacted) + # ----------------------- + + # rendered: + # - "lacp system-priority 10" + # - "lacp system-mac 00c1.4c00.bd15 role secondary" + + # Using parsed + + # parsed.cfg + # ------------ + # lacp system-priority 10 + # lacp system-mac 00c1.4c00.bd15 role secondary + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_lacp: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # system: + # priority: 10 + # mac: + # address: 00c1.4c00.bd15 + # role: secondary + + # Using gathered + + # Existing device config state + # ------------------------------- + # Nexus9000v# show running-config | include lacp + # lacp system-priority 11 + # lacp system-mac 00c1.4c00.bd15 role primary + + - name: Gather lacp facts from the device using nxos_lacp + cisco.nxos.nxos_lacp: + state: gathered + + # Task output (redacted) + # ----------------------- + # gathered: + # system: + # priority: 11 + # mac: + # address: 00c1.4c00.bd15 + # role: primary + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['lacp system-priority 15', 'lacp system-mac 00c1.4c00.bd15 role primary']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_lldp_interfaces_module.rst b/docs/cisco.nxos.nxos_lldp_interfaces_module.rst new file mode 100644 index 000000000..d634e9aa4 --- /dev/null +++ b/docs/cisco.nxos.nxos_lldp_interfaces_module.rst @@ -0,0 +1,407 @@ +.. _cisco.nxos.nxos_lldp_interfaces_module: + + +******************************* +cisco.nxos.nxos_lldp_interfaces +******************************* + +**LLDP interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages interfaces' configuration for Link Layer Discovery Protocol (LLDP) on NX-OS platforms. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of link layer discovery configurations for interfaces.
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the interface
+
+
+ receive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Used to enable or disable the reception of LLDP packets on that interface. By default, this is enabled after LLDP is enabled globally.
+
+
+ tlv_set + +
+ dictionary +
+ 		+ +
Used to configure TLV parameters on the interface
+
+
+ management_address + +
+ string +
+ 		+ +
Used to mention the IPv4 or IPv6 management address for the interface
+
+
+ vlan + +
+ integer +
+ 		+ +
Used to mention the VLAN for the interface
+
+
+ transmit + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Used to enable or disable the transmission of LLDP packets on that interface. By default, this is enabled after LLDP is enabled globally.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section ^interface.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state the configuration should be left in
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOS 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - The LLDP feature needs to be enabled before using this module + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + + - name: Merge provided configuration with device configuration + cisco.nxos.nxos_lldp_interfaces: + config: + - name: Ethernet1/4 + receive: false + transmit: true + tlv_set: + management_address: 192.168.122.64 + vlan: 12 + state: merged + + # After state: + # ------------- + # + # interface Ethernet1/4 + # no lldp receive + # lldp tlv-set management-address 192.168.122.64 + # lldp tlv-set vlan 12 + + + # Using replaced + + # Before state: + # ------------ + # + # interface Ethernet1/4 + # no lldp receive + # lldp tlv-set management-address 192.168.122.64 + # interface Ethernet1/5 + # no lldp transmit + # lldp tlv-set vlan 10 + + - name: Replace LLDP configuration on interfaces with given configuration + cisco.nxos.nxos_lldp_interfaces: + config: + - name: Ethernet1/4 + transmit: false + tlv_set: + vlan: 2 + state: replaced + + + # After state: + # ----------- + # + # interface Ethernet1/4 + # no lldp transmit + # lldp tlv_set vlan 2 + # interface Ethernet1/5 + # no lldp transmit + # lldp tlv-set vlan 10 + + + # Using overridden + + # Before state: + # ------------ + # + # interface Ethernet1/4 + # no lldp receive + # lldp tlv-set management-address 192.168.122.64 + # interface Ethernet1/5 + # no lldp transmit + # lldp tlv-set vlan 10 + + - name: Override LLDP configuration on all interfaces with given configuration + cisco.nxos.nxos_lldp_interfaces: + config: + - name: Ethernet1/7 + receive: false + tlv_set: + vlan: 12 + state: overridden + + + # After state: + # ----------- + # + # interface Ethernet1/7 + # no lldp receive + # lldp tlv_set vlan 12 + + + # Using deleted + + # Before state: + # ------------ + # + # interface Ethernet1/4 + # lldp tlv-set management vlan 24 + # no lldp transmit + # interface mgmt0 + # no lldp receive + + - name: Delete LLDP interfaces configuration + cisco.nxos.nxos_lldp_interfaces: + state: deleted + + # After state: + # ------------ + # + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/2', 'lldp receive', 'lldp tlv-set vlan 12']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_logging_module.rst b/docs/cisco.nxos.nxos_logging_module.rst new file mode 100644 index 000000000..9dafd8e33 --- /dev/null +++ b/docs/cisco.nxos.nxos_logging_module.rst @@ -0,0 +1,458 @@ +.. _cisco.nxos.nxos_logging_module: + + +*********************** +cisco.nxos.nxos_logging +*********************** + +**Manage logging on network devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2023-08-01 +:Why: Updated module released with more functionality. +:Alternative: nxos_logging_global + + + +Synopsis +-------- +- This module provides declarative management of logging on Cisco NX-OS devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ aggregate + +
+ list + / elements=dictionary +
+ 		+ +
List of logging definitions.
+
+
+ dest + +
+ string +
+ 		+
    Choices: +
  • console
    • +
  • logfile
    • +
  • module
    • +
  • monitor
    • +
  • server
    • +
+ 		+
Destination of the logs.
+
+
+ dest_level + +
+ integer +
+ 		+ +
Set logging severity levels.
+

aliases: level
+
+
+ event + +
+ string +
+ 		+
    Choices: +
  • link-enable
    • +
  • link-default
    • +
  • trunk-enable
    • +
  • trunk-default
    • +
+ 		+
Link/trunk enable/default interface configuration logging
+
+
+ facility + +
+ string +
+ 		+ +
Facility name for logging.
+
+
+ facility_level + +
+ integer +
+ 		+ +
Set logging severity levels for facility based log messages.
+
+
+ facility_link_status + +
+ string +
+ 		+
    Choices: +
  • link-down-notif
    • +
  • link-down-error
    • +
  • link-up-notif
    • +
  • link-up-error
    • +
+ 		+
Set logging facility ethpm link status. Not idempotent with version 6.0 images.
+
+
+ file_size + +
+ integer +
+ 		+ +
Set logfile size
+
+
+ interface + +
+ string +
+ 		+ +
Interface to be used while configuring source-interface for logging (e.g., 'Ethernet1/2', 'mgmt0')
+
+
+ interface_message + +
+ string +
+ 		+
    Choices: +
  • add-interface-description
    • +
+ 		+
Add interface description to interface syslogs. Does not work with version 6.0 images using nxapi as a transport.
+
+
+ name + +
+ string +
+ 		+ +
If value of dest is logfile it indicates file-name.
+
+
+ purge + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Remove any switch logging configuration that does not match what has been configured Not supported for ansible_connection local. All nxos_logging tasks must use the same ansible_connection type.
+
+
+ remote_server + +
+ string +
+ 		+ +
Hostname or IP Address for remote logging (when dest is 'server').
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
State of the logging configuration.
+
+
+ timestamp + +
+ string +
+ 		+
    Choices: +
  • microseconds
    • +
  • milliseconds
    • +
  • seconds
    • +
+ 		+
Set logging timestamp format
+
+
+ use_vrf + +
+ string +
+ 		+ +
VRF to be used while configuring remote logging (when dest is 'server').
+
+
+ + +Notes +----- + +.. note:: + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: configure console logging with level + cisco.nxos.nxos_logging: + dest: console + level: 2 + state: present + - name: remove console logging configuration + cisco.nxos.nxos_logging: + dest: console + level: 2 + state: absent + - name: configure file logging with level + cisco.nxos.nxos_logging: + dest: logfile + name: testfile + dest_level: 3 + state: present + - name: Configure logging logfile with size + cisco.nxos.nxos_logging: + dest: logfile + name: testfile + dest_level: 3 + file_size: 16384 + - name: configure facility level logging + cisco.nxos.nxos_logging: + facility: daemon + facility_level: 0 + state: present + - name: remove facility level logging + cisco.nxos.nxos_logging: + facility: daemon + facility_level: 0 + state: absent + - name: Configure Remote Logging + cisco.nxos.nxos_logging: + dest: server + remote_server: test-syslogserver.com + facility: auth + facility_level: 1 + use_vrf: management + state: present + - name: Configure Source Interface for Logging + cisco.nxos.nxos_logging: + interface: mgmt0 + state: present + - name: Purge nxos_logging configuration not managed by this playbook + cisco.nxos.nxos_logging: + purge: true + - name: Configure logging timestamp + cisco.nxos.nxos_logging: + timestamp: milliseconds + state: present + - name: Configure logging facility ethpm link status + cisco.nxos.nxos_logging: + facility: ethpm + facility_link_status: link-up-notif + state: present + - name: Configure logging message ethernet description + cisco.nxos.nxos_logging: + interface_message: add-interface-description + state: present + - name: Configure logging event link enable + cisco.nxos.nxos_logging: + event: link-enable + state: present + - name: Configure logging using aggregate + cisco.nxos.nxos_logging: + aggregate: + - {dest: console, dest_level: 2} + - {dest: logfile, dest_level: 2, name: testfile} + - {facility: daemon, facility_level: 0} + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['logging console 2', 'logging logfile testfile 3', 'logging level daemon 0']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2023-08-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_ntp_auth_module.rst b/docs/cisco.nxos.nxos_ntp_auth_module.rst new file mode 100644 index 000000000..c825cd017 --- /dev/null +++ b/docs/cisco.nxos.nxos_ntp_auth_module.rst @@ -0,0 +1,224 @@ +.. _cisco.nxos.nxos_ntp_auth_module: + + +************************ +cisco.nxos.nxos_ntp_auth +************************ + +**Manages NTP authentication.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated module released with more functionality. +:Alternative: nxos_ntp_global + + + +Synopsis +-------- +- Manages NTP authentication. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ auth_type + +
+ string +
+ 		+
    Choices: +
  • text ←
    • +
  • encrypt
    • +
+ 		+
Whether the given md5string is in cleartext or has been encrypted. If in cleartext, the device will encrypt it before storing it.
+
+
+ authentication + +
+ string +
+ 		+
    Choices: +
  • on
    • +
  • off
    • +
+ 		+
Turns NTP authentication on or off.
+
+
+ key_id + +
+ string +
+ 		+ +
Authentication key identifier (numeric).
+
+
+ md5string + +
+ string +
+ 		+ +
MD5 String.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ trusted_key + +
+ string +
+ 		+
    Choices: +
  • false ←
    • +
  • true
    • +
+ 		+
Whether the given key is required to be supplied by a time source for the device to synchronize to the time source.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - If ``state=absent``, the module will remove the given key configuration if it exists. + - If ``state=absent`` and ``authentication=on``, authentication will be turned off. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Basic NTP authentication configuration + - cisco.nxos.nxos_ntp_auth: + key_id: 32 + md5string: hello + auth_type: text + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['ntp authentication-key 32 md5 helloWorld 0', 'ntp trusted-key 32']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_ntp_global_module.rst b/docs/cisco.nxos.nxos_ntp_global_module.rst new file mode 100644 index 000000000..b77fc9440 --- /dev/null +++ b/docs/cisco.nxos.nxos_ntp_global_module.rst @@ -0,0 +1,1411 @@ +.. _cisco.nxos.nxos_ntp_global_module: + + +************************** +cisco.nxos.nxos_ntp_global +************************** + +**NTP Global resource module.** + + +Version added: 2.6.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages ntp configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A dict of ntp configuration.
+
+
+ access_group + +
+ dictionary +
+ 		+ +
NTP access-group.
+
This option is unsupported on MDS switches.
+
+
+ match_all + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Scan ACLs present in all ntp access groups.
+
+
+ peer + +
+ list + / elements=dictionary +
+ 		+ +
Access-group peer.
+
+
+ access_list + +
+ string +
+ 		+ +
Name of access list.
+
+
+ query_only + +
+ list + / elements=dictionary +
+ 		+ +
Access-group query-only.
+
+
+ access_list + +
+ string +
+ 		+ +
Name of access list.
+
+
+ serve + +
+ list + / elements=dictionary +
+ 		+ +
Access-group serve.
+
+
+ access_list + +
+ string +
+ 		+ +
Name of access list.
+
+
+ serve_only + +
+ list + / elements=dictionary +
+ 		+ +
Access-group serve-only.
+
+
+ access_list + +
+ string +
+ 		+ +
Name of access list.
+
+
+ allow + +
+ dictionary +
+ 		+ +
Enable/Disable the packets.
+
+
+ control + +
+ dictionary +
+ 		+ +
Control mode packets.
+
+
+ rate_limit + +
+ integer +
+ 		+ +
Rate-limit delay.
+
+
+ private + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable Private mode packets.
+
+
+ authenticate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable authentication.
+
+
+ authentication_keys + +
+ list + / elements=dictionary +
+ 		+ +
NTP authentication key.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 for Clear text
+
7 for Encrypted
+
+
+ id + +
+ integer +
+ 		+ +
Authentication key number (range 1-65535).
+
+
+ key + +
+ string +
+ 		+ +
Authentication key.
+
+
+ logging + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable logging of NTPD Events.
+
+
+ master + +
+ dictionary +
+ 		+ +
Act as NTP master clock.
+
This option is unsupported on MDS switches.
+
+
+ stratum + +
+ integer +
+ 		+ +
Stratum number.
+
+
+ passive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
NTP passive command.
+
This option is unsupported on MDS switches.
+
+
+ peers + +
+ list + / elements=dictionary +
+ 		+ +
NTP Peers.
+
+
+ key_id + +
+ integer +
+ 		+ +
Keyid to be used while communicating to this server.
+
+
+ maxpoll + +
+ integer +
+ 		+ +
Maximum interval to poll a peer.
+
Poll interval in secs to a power of 2.
+
+
+ minpoll + +
+ integer +
+ 		+ +
Minimum interval to poll a peer.
+
Poll interval in secs to a power of 2.
+
+
+ peer + +
+ string +
+ 		+ +
Hostname/IP address of the NTP Peer.
+
+
+ prefer + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Preferred Server.
+
+
+ vrf + +
+ string +
+ 		+ +
Display per-VRF information.
+
This option is unsupported on MDS switches.
+

aliases: use_vrf
+
+
+ servers + +
+ list + / elements=dictionary +
+ 		+ +
NTP servers.
+
+
+ key_id + +
+ integer +
+ 		+ +
Keyid to be used while communicating to this server.
+
+
+ maxpoll + +
+ integer +
+ 		+ +
Maximum interval to poll a peer.
+
Poll interval in secs to a power of 2.
+
+
+ minpoll + +
+ integer +
+ 		+ +
Minimum interval to poll a peer.
+
Poll interval in secs to a power of 2.
+
+
+ prefer + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Preferred Server.
+
+
+ server + +
+ string +
+ 		+ +
Hostname/IP address of the NTP Peer.
+
+
+ vrf + +
+ string +
+ 		+ +
Display per-VRF information.
+
This option is not applicable for MDS switches.
+

aliases: use_vrf
+
+
+ source + +
+ string +
+ 		+ +
Source of NTP packets.
+
This option is unsupported on MDS switches.
+
+
+ source_interface + +
+ string +
+ 		+ +
Source interface sending NTP packets.
+
+
+ trusted_keys + +
+ list + / elements=dictionary +
+ 		+ +
NTP trusted-key number.
+
+
+ key_id + +
+ integer +
+ 		+ +
Trusted-Key number.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config ntp.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
The states replaced and overridden have identical behaviour for this module.
+
Please refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6 on Cisco Nexus Switches. + - This module works with connection ``network_cli`` and ``httpapi``. + - Tested against Cisco MDS NX-OS 9.2(2) with connection ``network_cli``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k-rdo# show running-config ntp + # nxos-9k-rdo# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_ntp_global: &id001 + config: + access_group: + peer: + - access_list: PeerAcl1 + serve: + - access_list: ServeAcl1 + authenticate: true + authentication_keys: + - id: 1001 + key: vagwwtKfkv + encryption: 7 + - id: 1002 + key: vagwwtKfkvgthz + encryption: 7 + logging: true + master: + stratum: 2 + peers: + - peer: 192.0.2.1 + key_id: 1 + maxpoll: 15 + minpoll: 5 + vrf: default + - peer: 192.0.2.2 + key_id: 2 + prefer: true + vrf: siteA + servers: + - server: 198.51.100.1 + key_id: 2 + vrf: default + - server: 203.0.113.1 + key_id: 1 + vrf: siteB + + # Task output + # ------------- + # before: {} + # + # commands: + # - "ntp authenticate" + # - "ntp logging" + # - "ntp master 2" + # - "ntp authentication-keys 1001 md5 vagwwtKfkv 7" + # - "ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" + # - "ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" + # - "ntp peer 192.0.2.2 prefer use-vrf siteA key 2" + # - "ntp server 198.51.100.1 use-vrf default key 2" + # - "ntp server 203.0.113.1 use-vrf siteB key 1" + # - "ntp access-group peer PeerAcl1" + # - "ntp access-group serve ServeAcl1" + # + # after: + # access_group: + # peer: + # - access_list: PeerAcl1 + # serve: + # - access_list: ServeAcl1 + # authenticate: true + # authentication_keys: + # - id: 1001 + # key: vagwwtKfkv + # encryption: 7 + # - id: 1002 + # key: vagwwtKfkvgthz + # encryption: 7 + # logging: true + # master: + # stratum: 2 + # peers: + # - peer: 192.0.2.1 + # key_id: 1 + # maxpoll: 15 + # minpoll: 5 + # vrf: default + # - peer: 192.0.2.2 + # key_id: 2 + # prefer: true + # vrf: siteA + # servers: + # - server: 198.51.100.1 + # key_id: 2 + # vrf: default + # - server: 203.0.113.1 + # key_id: 1 + # vrf: siteB + + # After state: + # ------------ + # nxos-9k-rdo# show running-config ntp + # ntp authenticate + # ntp logging + # ntp master 2 + # ntp authentication-keys 1001 md5 vagwwtKfkv 7 + # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 + # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 + # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 + # ntp server 198.51.100.1 use-vrf default key 2 + # ntp server 203.0.113.1 use-vrf siteB key 1 + # ntp access-group peer PeerAcl1 + # ntp access-group serve ServeAcl1 + + # Using replaced + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config ntp + # ntp authenticate + # ntp logging + # ntp master 2 + # ntp authentication-keys 1001 md5 vagwwtKfkv 7 + # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 + # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 + # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 + # ntp server 198.51.100.1 use-vrf default key 2 + # ntp server 203.0.113.1 use-vrf siteB key 1 + # ntp access-group peer PeerAcl1 + # ntp access-group serve ServeAcl1 + + - name: Replace logging global configurations of listed logging global with provided configurations + cisco.nxos.nxos_ntp_global: + config: + access_group: + peer: + - access_list: PeerAcl2 + serve: + - access_list: ServeAcl2 + logging: true + master: + stratum: 2 + peers: + - peer: 192.0.2.1 + key_id: 1 + maxpoll: 15 + minpoll: 5 + vrf: default + - peer: 192.0.2.5 + key_id: 2 + prefer: true + vrf: siteA + servers: + - server: 198.51.100.1 + key_id: 2 + vrf: default + state: replaced + + # Task output + # ------------- + # before: + # access_group: + # peer: + # - access_list: PeerAcl1 + # serve: + # - access_list: ServeAcl1 + # authenticate: true + # authentication_keys: + # - id: 1001 + # key: vagwwtKfkv + # encryption: 7 + # - id: 1002 + # key: vagwwtKfkvgthz + # encryption: 7 + # logging: true + # master: + # stratum: 2 + # peers: + # - peer: 192.0.2.1 + # key_id: 1 + # maxpoll: 15 + # minpoll: 5 + # vrf: default + # - peer: 192.0.2.2 + # key_id: 2 + # prefer: true + # vrf: siteA + # servers: + # - server: 198.51.100.1 + # key_id: 2 + # vrf: default + # - server: 203.0.113.1 + # key_id: 1 + # vrf: siteB + # + # commands: + # - "no ntp authenticate" + # - "no ntp authentication-keys 1001 md5 vagwwtKfkv 7" + # - "no ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" + # - "ntp peer 192.0.2.5 prefer use-vrf siteA key 2" + # - "no ntp peer 192.0.2.2 prefer use-vrf siteA key 2" + # - "no ntp server 203.0.113.1 use-vrf siteB key 1" + # - "ntp access-group peer PeerAcl2" + # - "no ntp access-group peer PeerAcl1" + # - "ntp access-group serve ServeAcl2" + # - "no ntp access-group serve ServeAcl1" + # + # after: + # access_group: + # peer: + # - access_list: PeerAcl2 + # serve: + # - access_list: ServeAcl2 + # logging: true + # master: + # stratum: 2 + # peers: + # - peer: 192.0.2.1 + # key_id: 1 + # maxpoll: 15 + # minpoll: 5 + # vrf: default + # - peer: 192.0.2.5 + # key_id: 2 + # prefer: true + # vrf: siteA + # servers: + # - server: 198.51.100.1 + # key_id: 2 + # vrf: default + + # After state: + # ------------ + # nxos-9k-rdo# show running-config ntp + # ntp logging + # ntp master 2 + # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 + # ntp peer 192.0.2.5 prefer use-vrf siteA key 2 + # ntp server 198.51.100.1 use-vrf default key 2 + # ntp access-group peer PeerAcl2 + # ntp access-group serve ServeAcl2 + + # Using deleted to delete all logging configurations + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config ntp + + - name: Delete all logging configuration + cisco.nxos.nxos_ntp_global: + state: deleted + + # Task output + # ------------- + # before: + # access_group: + # peer: + # - access_list: PeerAcl1 + # serve: + # - access_list: ServeAcl1 + # authenticate: true + # authentication_keys: + # - id: 1001 + # key: vagwwtKfkv + # encryption: 7 + # - id: 1002 + # key: vagwwtKfkvgthz + # encryption: 7 + # logging: true + # master: + # stratum: 2 + # peers: + # - peer: 192.0.2.1 + # key_id: 1 + # maxpoll: 15 + # minpoll: 5 + # vrf: default + # - peer: 192.0.2.2 + # key_id: 2 + # prefer: true + # vrf: siteA + # servers: + # - server: 198.51.100.1 + # key_id: 2 + # vrf: default + # - server: 203.0.113.1 + # key_id: 1 + # vrf: siteB + # + # commands: + # - "no ntp authenticate" + # - "no ntp logging" + # - "no ntp master 2" + # - "no ntp authentication-keys 1001 md5 vagwwtKfkv 7" + # - "no ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" + # - "no ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" + # - "no ntp peer 192.0.2.2 prefer use-vrf siteA key 2" + # - "no ntp server 198.51.100.1 use-vrf default key 2" + # - "no ntp server 203.0.113.1 use-vrf siteB key 1" + # - "no ntp access-group peer PeerAcl1" + # - "no ntp access-group serve ServeAcl1" + # + # after: {} + + # After state: + # ------------ + # nxos-9k-rdo# show running-config ntp + # nxos-9k-rdo# + + # Using rendered + + - name: Render platform specific configuration lines with state rendered (without connecting to the device) + cisco.nxos.nxos_ntp_global: + config: + access_group: + peer: + - access_list: PeerAcl1 + serve: + - access_list: ServeAcl1 + authenticate: true + authentication_keys: + - id: 1001 + key: vagwwtKfkv + encryption: 7 + - id: 1002 + key: vagwwtKfkvgthz + encryption: 7 + logging: true + master: + stratum: 2 + peers: + - peer: 192.0.2.1 + key_id: 1 + maxpoll: 15 + minpoll: 5 + vrf: default + - peer: 192.0.2.2 + key_id: 2 + prefer: true + vrf: siteA + servers: + - server: 198.51.100.1 + key_id: 2 + vrf: default + - server: 203.0.113.1 + key_id: 1 + vrf: siteB + state: rendered + + # Task Output (redacted) + # ----------------------- + # rendered: + # - "ntp authenticate" + # - "ntp logging" + # - "ntp master 2" + # - "ntp authentication-keys 1001 md5 vagwwtKfkv 7" + # - "ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" + # - "ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" + # - "ntp peer 192.0.2.2 prefer use-vrf siteA key 2" + # - "ntp server 198.51.100.1 use-vrf default key 2" + # - "ntp server 203.0.113.1 use-vrf siteB key 1" + # - "ntp access-group peer PeerAcl1" + # - "ntp access-group serve ServeAcl1" + + # Using parsed + + # parsed.cfg + # ------------ + # ntp authenticate + # ntp logging + # ntp master 2 + # ntp authentication-keys 1001 md5 vagwwtKfkv 7 + # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 + # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 + # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 + # ntp server 198.51.100.1 use-vrf default key 2 + # ntp server 203.0.113.1 use-vrf siteB key 1 + # ntp access-group peer PeerAcl1 + # ntp access-group serve ServeAcl1 + + - name: Parse externally provided ntp configuration + cisco.nxos.nxos_ntp_global: + running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # access_group: + # peer: + # - access_list: PeerAcl1 + # serve: + # - access_list: ServeAcl1 + # authenticate: true + # authentication_keys: + # - id: 1001 + # key: vagwwtKfkv + # encryption: 7 + # - id: 1002 + # key: vagwwtKfkvgthz + # encryption: 7 + # logging: true + # master: + # stratum: 2 + # peers: + # - peer: 192.0.2.1 + # key_id: 1 + # maxpoll: 15 + # minpoll: 5 + # vrf: default + # - peer: 192.0.2.2 + # key_id: 2 + # prefer: true + # vrf: siteA + # servers: + # - server: 198.51.100.1 + # key_id: 2 + # vrf: default + # - server: 203.0.113.1 + # key_id: 1 + # vrf: siteB + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['ntp master stratum 2', 'ntp peer 198.51.100.1 use-vrf test maxpoll 7', 'ntp authentication-key 10 md5 wawyhanx2 7', 'ntp access-group peer PeerAcl1', 'ntp access-group peer PeerAcl2', 'ntp access-group query-only QueryAcl1']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['ntp master stratum 2', 'ntp peer 198.51.100.1 use-vrf test maxpoll 7', 'ntp authentication-key 10 md5 wawyhanx2 7', 'ntp access-group peer PeerAcl1', 'ntp access-group peer PeerAcl2', 'ntp access-group query-only QueryAcl1']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_ntp_module.rst b/docs/cisco.nxos.nxos_ntp_module.rst new file mode 100644 index 000000000..3fa835a96 --- /dev/null +++ b/docs/cisco.nxos.nxos_ntp_module.rst @@ -0,0 +1,314 @@ +.. _cisco.nxos.nxos_ntp_module: + + +******************* +cisco.nxos.nxos_ntp +******************* + +**Manages core NTP configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated module released with more functionality. +:Alternative: nxos_ntp_global + + + +Synopsis +-------- +- Manages core NTP configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ key_id + +
+ string +
+ 		+ +
Authentication key identifier to use with given NTP server or peer or keyword 'default'.
+
+
+ peer + +
+ string +
+ 		+ +
Network address of NTP peer.
+
+
+ prefer + +
+ string +
+ 		+
    Choices: +
  • enabled
    • +
  • disabled
    • +
+ 		+
Makes given NTP server or peer the preferred NTP server or peer for the device.
+
+
+ server + +
+ string +
+ 		+ +
Network address of NTP server.
+
+
+ source_addr + +
+ string +
+ 		+ +
Local source address from which NTP messages are sent or keyword 'default'.
+
+
+ source_int + +
+ string +
+ 		+ +
Local source interface from which NTP messages are sent. Must be fully qualified interface name or keyword 'default'
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ vrf_name + +
+ string +
+ 		+ +
Makes the device communicate with the given NTP server or peer over a specific VRF or keyword 'default'.
+
+
+ + +Notes +----- + +.. note:: + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Set NTP Server with parameters + - cisco.nxos.nxos_ntp: + server: 1.2.3.4 + key_id: 32 + prefer: enabled + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ end_state + +
+ dictionary +
+ 		always +
k/v pairs of ntp info after module execution
+
+
Sample:
+
{'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'server', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'source'}
+
+
+ existing + +
+ dictionary +
+ 		always +
k/v pairs of existing ntp server/peer
+
+
Sample:
+
{'address': '192.0.2.2', 'key_id': '32', 'peer_type': 'server', 'prefer': 'enabled', 'source': 'ethernet2/1', 'source_type': 'source-interface'}
+
+
+ proposed + +
+ dictionary +
+ 		always +
k/v pairs of parameters passed into module
+
+
Sample:
+
{'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'server', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'source'}
+
+
+ updates + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['ntp server 192.0.2.2 prefer key 48', 'no ntp source-interface ethernet2/1', 'ntp source 192.0.2.3']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_ntp_options_module.rst b/docs/cisco.nxos.nxos_ntp_options_module.rst new file mode 100644 index 000000000..e99825641 --- /dev/null +++ b/docs/cisco.nxos.nxos_ntp_options_module.rst @@ -0,0 +1,192 @@ +.. _cisco.nxos.nxos_ntp_options_module: + + +*************************** +cisco.nxos.nxos_ntp_options +*************************** + +**Manages NTP options.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated module released with more functionality. +:Alternative: nxos_ntp_global + + + +Synopsis +-------- +- Manages NTP options, e.g. authoritative server and logging. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ logging + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Sets whether NTP logging is enabled on the device.
+
+
+ master + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Sets whether the device is an authoritative NTP server.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ stratum + +
+ string +
+ 		+ +
If master=true, an optional stratum can be supplied (1-15). The device default is 8.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - When ``state=absent``, master and logging will be set to False and stratum will be removed as well + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Basic NTP options configuration + - cisco.nxos.nxos_ntp_options: + master: true + stratum: 12 + logging: false + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ updates + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['no ntp logging', 'ntp master 12']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_nxapi_module.rst b/docs/cisco.nxos.nxos_nxapi_module.rst new file mode 100644 index 000000000..182fe1516 --- /dev/null +++ b/docs/cisco.nxos.nxos_nxapi_module.rst @@ -0,0 +1,300 @@ +.. _cisco.nxos.nxos_nxapi_module: + + +********************* +cisco.nxos.nxos_nxapi +********************* + +**Manage NXAPI configuration on an NXOS device.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Configures the NXAPI feature on devices running Cisco NXOS. The NXAPI feature is absent from the configuration by default. Since this module manages the NXAPI feature it only supports the use of the ``Cli`` transport. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ http + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
Controls the operating state of the HTTP protocol as one of the underlying transports for NXAPI. By default, NXAPI will enable the HTTP transport when the feature is first configured. To disable the use of the HTTP transport, set the value of this argument to False.
+

aliases: enable_http
+
+
+ http_port + +
+ integer +
+ 		+ Default:
80
+ 		+
Configure the port with which the HTTP server will listen on for requests. By default, NXAPI will bind the HTTP service to the standard HTTP port 80. This argument accepts valid port values in the range of 1 to 65535.
+
+
+ https + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Controls the operating state of the HTTPS protocol as one of the underlying transports for NXAPI. By default, NXAPI will disable the HTTPS transport when the feature is first configured. To enable the use of the HTTPS transport, set the value of this argument to True.
+

aliases: enable_https
+
+
+ https_port + +
+ integer +
+ 		+ Default:
443
+ 		+
Configure the port with which the HTTPS server will listen on for requests. By default, NXAPI will bind the HTTPS service to the standard HTTPS port 443. This argument accepts valid port values in the range of 1 to 65535.
+
+
+ sandbox + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
The NXAPI feature provides a web base UI for developers for entering commands. This feature is initially disabled when the NXAPI feature is configured for the first time. When the sandbox argument is set to True, the developer sandbox URL will accept requests and when the value is set to False, the sandbox URL is unavailable. This is supported on NX-OS 7K series.
+

aliases: enable_sandbox
+
+
+ ssl_strong_ciphers + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Controls the use of whether strong or weak ciphers are configured. By default, this feature is disabled and weak ciphers are configured. To enable the use of strong ciphers, set the value of this argument to True.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
The state argument controls whether or not the NXAPI feature is configured on the remote device. When the value is present the NXAPI feature configuration is present in the device running-config. When the values is absent the feature configuration is removed from the running-config.
+
+
+ tlsv1_0 + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
Controls the use of the Transport Layer Security version 1.0 is configured. By default, this feature is enabled. To disable the use of TLSV1.0, set the value of this argument to True.
+
+
+ tlsv1_1 + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Controls the use of the Transport Layer Security version 1.1 is configured. By default, this feature is disabled. To enable the use of TLSV1.1, set the value of this argument to True.
+
+
+ tlsv1_2 + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Controls the use of the Transport Layer Security version 1.2 is configured. By default, this feature is disabled. To enable the use of TLSV1.2, set the value of this argument to True.
+
+
+ + +Notes +----- + +.. note:: + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Enable NXAPI access with default configuration + cisco.nxos.nxos_nxapi: + state: present + + - name: Enable NXAPI with no HTTP, HTTPS at port 9443 and sandbox disabled + cisco.nxos.nxos_nxapi: + enable_http: false + https_port: 9443 + https: true + enable_sandbox: false + + - name: remove NXAPI configuration + cisco.nxos.nxos_nxapi: + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ updates + +
+ list +
+ 		always +
Returns the list of commands that need to be pushed into the remote device to satisfy the arguments
+
+
Sample:
+
['no feature nxapi']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_ospf_interfaces_module.rst b/docs/cisco.nxos.nxos_ospf_interfaces_module.rst new file mode 100644 index 000000000..ff69b6e71 --- /dev/null +++ b/docs/cisco.nxos.nxos_ospf_interfaces_module.rst @@ -0,0 +1,1732 @@ +.. _cisco.nxos.nxos_ospf_interfaces_module: + + +******************************* +cisco.nxos.nxos_ospf_interfaces +******************************* + +**OSPF Interfaces Resource Module.** + + +Version added: 1.3.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages OSPF(v2/v3) configuration of interfaces on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of OSPF configuration for interfaces.
+
+
+ address_family + +
+ list + / elements=dictionary +
+ 		+ +
OSPF settings on the interfaces in address-family context.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
Address Family Identifier (AFI) for OSPF settings on the interfaces.
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Authentication settings on the interface.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable authentication on the interface.
+
+
+ key_chain + +
+ string +
+ 		+ +
Authentication password key-chain.
+
+
+ message_digest + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use message-digest authentication.
+
+
+ null_auth + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use null(disable) authentication.
+
+
+ authentication_key + +
+ dictionary +
+ 		+ +
Configure the authentication key for the interface.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 Specifies an UNENCRYPTED authentication key will follow.
+
3 Specifies an 3DES ENCRYPTED authentication key will follow.
+
7 Specifies a Cisco type 7 ENCRYPTED authentication key will follow.
+
+
+ key + +
+ string + / required +
+ 		+ +
Authentication key.
+
Valid values are Cisco type 7 ENCRYPTED password, 3DES ENCRYPTED password and UNENCRYPTED (cleartext) password based on the value of encryption key.
+
+
+ cost + +
+ integer +
+ 		+ +
Cost associated with interface.
+
+
+ dead_interval + +
+ integer +
+ 		+ +
Dead interval value (in seconds).
+
+
+ default_passive_interface + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set passive-interface attribute on this interface to default.
+
This option is mutually exclusive with passive_interface.
+
+
+ hello_interval + +
+ integer +
+ 		+ +
Hello interval value (in seconds).
+
+
+ instance + +
+ integer +
+ 		+ +
Instance identifier.
+
+
+ message_digest_key + +
+ dictionary +
+ 		+ +
Message digest authentication password (key) settings.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 Specifies an UNENCRYPTED ospf password (key) will follow.
+
3 Specifies an 3DES ENCRYPTED ospf password (key) will follow.
+
7 Specifies a Cisco type 7 ENCRYPTED the ospf password (key) will follow.
+
+
+ key + +
+ string + / required +
+ 		+ +
Authentication key.
+
Valid values are Cisco type 7 ENCRYPTED password, 3DES ENCRYPTED password and UNENCRYPTED (cleartext) password based on the value of encryption key.
+
+
+ key_id + +
+ integer + / required +
+ 		+ +
Key ID.
+
+
+ mtu_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable OSPF MTU mismatch detection.
+
+
+ multi_areas + +
+ list + / elements=string +
+ 		+ +
Multi-Areas associated with interface (not tied to OSPF process).
+
Valid values are Area Ids as an integer or IP address.
+
+
+ network + +
+ string +
+ 		+
    Choices: +
  • broadcast
    • +
  • point-to-point
    • +
+ 		+
Network type.
+
+
+ passive_interface + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress routing updates on the interface.
+
This option is mutually exclusive with default_passive_interface.
+
+
+ priority + +
+ integer +
+ 		+ +
Router priority.
+
+
+ processes + +
+ list + / elements=dictionary +
+ 		+ +
Interfaces configuration for an OSPF process.
+
+
+ area + +
+ dictionary +
+ 		+ +
Area associated with interface.
+
+
+ area_id + +
+ string + / required +
+ 		+ +
Area ID in IP address format.
+
+
+ secondaries + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not include secondary IPv4/IPv6 addresses.
+
+
+ multi_areas + +
+ list + / elements=string +
+ 		+ +
Multi-Areas associated with interface.
+
Valid values are Area Ids as an integer or IP address.
+
+
+ process_id + +
+ string + / required +
+ 		+ +
OSPF process tag.
+
+
+ retransmit_interval + +
+ integer +
+ 		+ +
Packet retransmission interval.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Shutdown OSPF on this interface.
+
+
+ transmit_delay + +
+ integer +
+ 		+ +
Packet transmission delay.
+
+
+ name + +
+ string + / required +
+ 		+ +
Name/Identifier of the interface.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section "^interface".
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • parsed
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
+
+ + +Notes +----- + +.. note:: + - Unsupported for Cisco MDS + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # interface Ethernet1/2 + # no switchport + # interface Ethernet1/3 + # no switchport + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_ospf_interfaces: + config: + - name: Ethernet1/1 + address_family: + - afi: ipv4 + processes: + - process_id: '100' + area: + area_id: 1.1.1.1 + secondaries: false + multi_areas: + - 11.11.11.11 + - afi: ipv6 + processes: + - process_id: '200' + area: + area_id: 2.2.2.2 + multi_areas: + - 21.0.0.0 + - process_id: '300' + multi_areas: + - 50.50.50.50 + multi_areas: + - 16.10.10.10 + - name: Ethernet1/2 + address_family: + - afi: ipv4 + authentication: + enable: true + key_chain: test-1 + message_digest_key: + key_id: 10 + encryption: 3 + key: abc01d272be25d29 + cost: 100 + - afi: ipv6 + network: broadcast + shutdown: true + - name: Ethernet1/3 + address_family: + - afi: ipv4 + authentication_key: + encryption: 7 + key: 12090404011C03162E + state: merged + + # Task output: + # ------------ + # before: + # - name: Ethernet1/1 + # - name: Ethernet1/2 + # - name: Ethernet1/3 + # + # commands: + # - interface Ethernet1/1 + # - ip router ospf multi-area 11.11.11.11 + # - ip router ospf 100 area 1.1.1.1 secondaries none + # - ipv6 router ospfv3 multi-area 16.10.10.10 + # - ipv6 router ospfv3 200 area 2.2.2.2 + # - ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - ipv6 router ospfv3 300 multi-area 50.50.50.50 + # - interface Ethernet1/2 + # - ip ospf authentication key-chain test-1 + # - ip ospf authentication + # - ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # - ip ospf cost 100 + # - ospfv3 network broadcast + # - ospfv3 shutdown + # - interface Ethernet1/3 + # - ip ospf authentication-key 7 12090404011C03162E + # + # after: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + + # After state: + # ------------ + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + + # Using replaced + + # Before state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + - name: Replace OSPF configurations of listed interfaces with provided configurations + cisco.nxos.nxos_ospf_interfaces: + config: + - name: Ethernet1/1 + address_family: + - afi: ipv4 + processes: + - process_id: "100" + area: + area_id: 1.1.1.1 + secondaries: false + multi_areas: + - 11.11.11.12 + - name: Ethernet1/3 + state: replaced + + # Task output: + # ------------ + # before: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + # + # commands: + # - interface Ethernet1/1 + # - ip router ospf multi-area 11.11.11.12 + # - no ip router ospf multi-area 11.11.11.11 + # - no ipv6 router ospfv3 multi-area 16.10.10.10 + # - no ipv6 router ospfv3 200 area 2.2.2.2 + # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 + # - interface Ethernet1/3 + # - no ip ospf authentication-key 7 12090404011C03162E + # + # after: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.12 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - name: Ethernet1/3 + # + # After state: + # ------------ + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.12 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + + + # Using overridden + + # Before state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + - name: Override all OSPF interfaces configuration with provided configuration + cisco.nxos.nxos_ospf_interfaces: + config: + - name: Ethernet1/1 + address_family: + - afi: ipv4 + processes: + - process_id: "100" + area: + area_id: 1.1.1.1 + secondaries: false + multi_areas: + - 11.11.11.12 + state: overridden + + # Task output: + # ------------ + # before: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + # + # commands: + # - interface Ethernet1/2 + # - no ip ospf authentication key-chain test-1 + # - no ip ospf authentication + # - no ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # - no ip ospf cost 100 + # - no ospfv3 network broadcast + # - no ospfv3 shutdown + # - interface Ethernet1/3 + # - no ip ospf authentication-key 7 12090404011C03162E + # - interface Ethernet1/1 + # - ip router ospf multi-area 11.11.11.12 + # - no ip router ospf multi-area 11.11.11.11 + # - no ipv6 router ospfv3 multi-area 16.10.10.10 + # - no ipv6 router ospfv3 200 area 2.2.2.2 + # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 + # + # after: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.12 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # name: Ethernet1/1 + # - name: Ethernet1/2 + # - name: Ethernet1/3 + + # After state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.12 + # interface Ethernet1/2 + # no switchport + # interface Ethernet1/3 + # no switchport + + # Using deleted to delete OSPF config of a single interface + + # Before state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + - name: Delete OSPF config from a single interface + cisco.nxos.nxos_ospf_interfaces: + config: + - name: Ethernet1/1 + state: deleted + + # Task output: + # ------------ + # before: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + # + # commands: + # - interface Ethernet1/1 + # - no ip router ospf multi-area 11.11.11.11 + # - no ip router ospf 100 area 1.1.1.1 secondaries none + # - no ipv6 router ospfv3 multi-area 16.10.10.10 + # - no ipv6 router ospfv3 200 area 2.2.2.2 + # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 + # + # after: + # - name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + + + # After state: + # ------------ + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + # Using deleted to delete OSPF config from all interfaces + + # Before state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + - name: Delete OSPF config from all interfaces + cisco.nxos.nxos_ospf_interfaces: + state: deleted + + # Task output: + # ------------ + # before: + # - name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + # + # commands: + # - interface Ethernet1/1 + # - no ip router ospf multi-area 11.11.11.11 + # - no ip router ospf 100 area 1.1.1.1 secondaries none + # - no ipv6 router ospfv3 multi-area 16.10.10.10 + # - no ipv6 router ospfv3 200 area 2.2.2.2 + # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 + # - interface Ethernet1/2 + # - no ip ospf authentication key-chain test-1 + # - no ip ospf authentication + # - no ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # - no ip ospf cost 100 + # - no ospfv3 network broadcast + # - no ospfv3 shutdown + # - interface Ethernet1/3 + # - no ip ospf authentication-key 7 12090404011C03162E + # + # after: + # - name: Ethernet1/1 + # - name: Ethernet1/2 + # - name: Ethernet1/3 + + # After state: + # ------------ + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # interface Ethernet1/2 + # no switchport + # interface Ethernet1/3 + # no switchport + + # Using rendered + + - name: >- + Render platform specific configuration lines with state rendered (without + connecting to the device) + cisco.nxos.nxos_ospf_interfaces: + config: + - name: Ethernet1/1 + address_family: + - afi: ipv4 + processes: + - process_id: '100' + area: + area_id: 1.1.1.1 + secondaries: false + multi_areas: + - 11.11.11.11 + - afi: ipv6 + processes: + - process_id: '200' + area: + area_id: 2.2.2.2 + multi_areas: + - 21.0.0.0 + - process_id: '300' + multi_areas: + - 50.50.50.50 + multi_areas: + - 16.10.10.10 + - name: Ethernet1/2 + address_family: + - afi: ipv4 + authentication: + enable: true + key_chain: test-1 + message_digest_key: + key_id: 10 + encryption: 3 + key: abc01d272be25d29 + cost: 100 + - afi: ipv6 + network: broadcast + shutdown: true + - name: Ethernet1/3 + address_family: + - afi: ipv4 + authentication_key: + encryption: 7 + key: 12090404011C03162E + state: rendered + + + # Task Output: + # ------------ + # rendered: + # - interface Ethernet1/1 + # - ip router ospf multi-area 11.11.11.11 + # - ip router ospf 100 area 1.1.1.1 secondaries none + # - ipv6 router ospfv3 multi-area 16.10.10.10 + # - ipv6 router ospfv3 200 area 2.2.2.2 + # - ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - ipv6 router ospfv3 300 multi-area 50.50.50.50 + # - interface Ethernet1/2 + # - ip ospf authentication key-chain test-1 + # - ip ospf authentication + # - ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # - ip ospf cost 100 + # - ospfv3 network broadcast + # - ospfv3 shutdown + # - interface Ethernet1/3 + # - ip ospf authentication-key 7 12090404011C03162E + + # Using parsed + + # parsed.cfg + # ------------ + # interface Ethernet1/1 + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # interface Ethernet1/2 + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # ip ospf authentication-key 7 12090404011C03162E + + - name: arse externally provided OSPF interfaces config + cisco.nxos.nxos_ospf_interfaces: + running_config: "{{ lookup('file', 'ospf_interfaces.cfg') }}" + state: parsed + + # Task output: + # ------------ + # parsed: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + + # Using gathered + + # On-box config + + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.12 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + + # Task output: + # ------------ + # gathered: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.12 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - name: Ethernet1/3 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/1', 'ip router ospf multi-area 11.11.11.11', 'ip router ospf 100 area 1.1.1.1 secondaries none', 'no ipv6 router ospfv3 multi-area 16.10.10.10', 'ipv6 router ospfv3 200 area 2.2.2.2', 'ipv6 router ospfv3 200 multi-area 21.0.0.0', 'ipv6 router ospfv3 300 multi-area 50.50.50.50', 'interface Ethernet1/2', 'no ip ospf authentication key-chain test-1', 'ip ospf authentication']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['interface Ethernet1/1', 'ip router ospf multi-area 11.11.11.11', 'ip router ospf 100 area 1.1.1.1 secondaries none']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_ospfv2_module.rst b/docs/cisco.nxos.nxos_ospfv2_module.rst new file mode 100644 index 000000000..2115d34f2 --- /dev/null +++ b/docs/cisco.nxos.nxos_ospfv2_module.rst @@ -0,0 +1,5458 @@ +.. _cisco.nxos.nxos_ospfv2_module: + + +********************** +cisco.nxos.nxos_ospfv2 +********************** + +**OSPFv2 resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages OSPFv2 configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A list of OSPF process configuration.
+
+
+ processes + +
+ list + / elements=dictionary +
+ 		+ +
A list of OSPF instances' configurations.
+
+
+ areas + +
+ list + / elements=dictionary +
+ 		+ +
Configure properties of OSPF Areas.
+
+
+ area_id + +
+ string + / required +
+ 		+ +
The Area ID in IP Address format.
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Authentication settings for the Area.
+
+
+ message_digest + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use message-digest authentication.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set authentication for the area.
+
+
+ default_cost + +
+ integer +
+ 		+ +
Specify the default cost for default summary LSA.
+
+
+ filter_list + +
+ list + / elements=dictionary +
+ 		+ +
Filter prefixes between OSPF areas.
+
+
+ direction + +
+ string + / required +
+ 		+
    Choices: +
  • in
    • +
  • out
    • +
+ 		+
The direction to apply the route map.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
The Route-map name.
+
+
+ nssa + +
+ dictionary +
+ 		+ +
NSSA settings for the area.
+
+
+ default_information_originate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Originate Type-7 default LSA into NSSA area.
+
+
+ no_redistribution + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send redistributed LSAs into NSSA area.
+
+
+ no_summary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send summary LSAs into NSSA area.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure area as NSSA.
+
+
+ translate + +
+ dictionary +
+ 		+ +
Translate LSA.
+
+
+ type7 + +
+ dictionary +
+ 		+ +
Translate from Type 7 to Type 5.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always translate LSAs
+
+
+ never + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Never translate LSAs
+
+
+ supress_fa + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress forwarding address in translated LSAs.
+
+
+ ranges + +
+ list + / elements=dictionary +
+ 		+ +
Configure an address range for the area.
+
+
+ cost + +
+ integer +
+ 		+ +
Cost to use for the range.
+
+
+ not_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress advertising the specified range.
+
+
+ prefix + +
+ string + / required +
+ 		+ +
IP in Prefix format (x.x.x.x/len)
+
+
+ stub + +
+ dictionary +
+ 		+ +
Settings for configuring the area as a stub.
+
+
+ no_summary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Prevent ABR from sending summary LSAs into stub area.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure the area as a stub.
+
+
+ auto_cost + +
+ dictionary +
+ 		+ +
Calculate OSPF cost according to bandwidth.
+
+
+ reference_bandwidth + +
+ integer + / required +
+ 		+ +
Reference bandwidth used to assign OSPF cost.
+
+
+ unit + +
+ string + / required +
+ 		+
    Choices: +
  • Gbps
    • +
  • Mbps
    • +
+ 		+
Specify in which unit the reference bandwidth is specified.
+
+
+ bfd + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable BFD on all OSPF interfaces.
+
+
+ default_information + +
+ dictionary +
+ 		+ +
Control distribution of default routes.
+
+
+ originate + +
+ dictionary +
+ 		+ +
Distribute a default route.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always advertise a default route.
+
+
+ route_map + +
+ string +
+ 		+ +
Policy to control distribution of default routes
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable distribution of default route.
+
+
+ default_metric + +
+ integer +
+ 		+ +
Specify default metric for redistributed routes.
+
+
+ distance + +
+ integer +
+ 		+ +
Configure the OSPF administrative distance.
+
+
+ flush_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Flush routes on a non-graceful controlled restart.
+
+
+ graceful_restart + +
+ dictionary +
+ 		+ +
Configure graceful restart.
+
+
+ grace_period + +
+ integer +
+ 		+ +
Configure maximum interval to restart gracefully.
+
+
+ helper_disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable helper mode.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable graceful-restart.
+
+
+ isolate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Isolate this router from OSPF perspective.
+
+
+ log_adjacency_changes + +
+ dictionary +
+ 		+ +
Log changes in adjacency state.
+
+
+ detail + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Notify all state changes.
+
+
+ log + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable logging changes in adjacency state.
+
+
+ max_lsa + +
+ dictionary +
+ 		+ +
Feature to limit the number of non-self-originated LSAs.
+
+
+ ignore_count + +
+ integer +
+ 		+ +
Set count on how many times adjacencies can be suppressed.
+
+
+ ignore_time + +
+ integer +
+ 		+ +
Set time during which all adjacencies are suppressed.
+
+
+ max_non_self_generated_lsa + +
+ integer + / required +
+ 		+ +
Set the maximum number of non self-generated LSAs.
+
+
+ reset_time + +
+ integer +
+ 		+ +
Set number of minutes after which ignore-count is reset to zero.
+
+
+ threshold + +
+ integer +
+ 		+ +
Threshold value (%) at which to generate a warning message.
+
+
+ warning_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log a warning message when limit is exceeded.
+
+
+ max_metric + +
+ dictionary +
+ 		+ +
Maximize the cost metric.
+
+
+ router_lsa + +
+ dictionary +
+ 		+ +
Router LSA configuration.
+
+
+ external_lsa + +
+ dictionary +
+ 		+ +
External LSA configuration.
+
+
+ max_metric_value + +
+ integer +
+ 		+ +
Set max metric value for external LSAs.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set external-lsa attribute.
+
+
+ include_stub + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise Max metric for Stub links as well.
+
+
+ on_startup + +
+ dictionary +
+ 		+ +
Effective only at startup.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set on-startup attribute.
+
+
+ wait_for_bgp_asn + +
+ integer +
+ 		+ +
ASN of BGP to wait for.
+
+
+ wait_period + +
+ integer +
+ 		+ +
Wait period in seconds after startup.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set router-lsa attribute.
+
+
+ summary_lsa + +
+ dictionary +
+ 		+ +
Summary LSAs configuration.
+
+
+ max_metric_value + +
+ integer +
+ 		+ +
Max metric value for summary LSAs.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set summary-lsa attribute.
+
+
+ maximum_paths + +
+ integer +
+ 		+ +
Maximum paths per destination.
+
+
+ mpls + +
+ dictionary +
+ 		+ +
OSPF MPLS configuration settings.
+
+
+ traffic_eng + +
+ dictionary +
+ 		+ +
OSPF MPLS Traffic Engineering commands.
+
+
+ areas + +
+ list + / elements=dictionary +
+ 		+ +
List of Area IDs.
+
+
+ area_id + +
+ string +
+ 		+ +
Area Id in ip address format.
+
+
+ multicast_intact + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
MPLS TE multicast support.
+
+
+ router_id + +
+ string +
+ 		+ +
Router ID associated with TE.
+
+
+ name_lookup + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Display OSPF router ids as DNS names.
+
+
+ passive_interface + +
+ dictionary +
+ 		+ +
Suppress routing updates on the interface.
+
+
+ default + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Interfaces passive by default.
+
+
+ process_id + +
+ string + / required +
+ 		+ +
The OSPF process tag.
+
+
+ redistribute + +
+ list + / elements=dictionary +
+ 		+ +
Redistribute information from another routing protocol.
+
+
+ id + +
+ string +
+ 		+ +
The identifier for the protocol specified.
+
+
+ protocol + +
+ string + / required +
+ 		+
    Choices: +
  • bgp
    • +
  • direct
    • +
  • eigrp
    • +
  • isis
    • +
  • lisp
    • +
  • ospf
    • +
  • rip
    • +
  • static
    • +
+ 		+
The name of the protocol.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
The route map policy to constrain redistribution.
+
+
+ rfc1583compatibility + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure 1583 compatibility for external path preferences.
+
+
+ router_id + +
+ string +
+ 		+ +
Set OSPF process router-id.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Shutdown the OSPF protocol instance.
+
+
+ summary_address + +
+ list + / elements=dictionary +
+ 		+ +
Configure route summarization for redistribution.
+
+
+ not_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress advertising the specified summary.
+
+
+ prefix + +
+ string + / required +
+ 		+ +
IP prefix in format x.x.x.x/ml.
+
+
+ tag + +
+ integer +
+ 		+ +
A 32-bit tag value.
+
+
+ table_map + +
+ dictionary +
+ 		+ +
Policy for filtering/modifying OSPF routes before sending them to RIB.
+
+
+ filter + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Block the OSPF routes from being sent to RIB.
+
+
+ name + +
+ string + / required +
+ 		+ +
The Route Map name.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure timer related constants.
+
+
+ lsa_arrival + +
+ integer +
+ 		+ +
Mimimum interval between arrival of a LSA.
+
+
+ lsa_group_pacing + +
+ integer +
+ 		+ +
LSA group refresh/maxage interval.
+
+
+ throttle + +
+ dictionary +
+ 		+ +
Configure throttle related constants.
+
+
+ lsa + +
+ dictionary +
+ 		+ +
Set rate-limiting for LSA generation.
+
+
+ hold_interval + +
+ integer +
+ 		+ +
The hold interval.
+
+
+ max_interval + +
+ integer +
+ 		+ +
The max interval.
+
+
+ start_interval + +
+ integer +
+ 		+ +
The start interval.
+
+
+ spf + +
+ dictionary +
+ 		+ +
Set OSPF SPF timers.
+
+
+ initial_spf_delay + +
+ integer +
+ 		+ +
Initial SPF schedule delay in milliseconds.
+
+
+ max_wait_time + +
+ integer +
+ 		+ +
Maximum wait time between SPF calculations.
+
+
+ min_hold_time + +
+ integer +
+ 		+ +
Minimum hold time between SPF calculations.
+
+
+ vrfs + +
+ list + / elements=dictionary +
+ 		+ +
Configure VRF specific OSPF settings.
+
+
+ areas + +
+ list + / elements=dictionary +
+ 		+ +
Configure properties of OSPF Areas.
+
+
+ area_id + +
+ string + / required +
+ 		+ +
The Area ID in IP Address format.
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Authentication settings for the Area.
+
+
+ message_digest + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use message-digest authentication.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set authentication for the area.
+
+
+ default_cost + +
+ integer +
+ 		+ +
Specify the default cost for default summary LSA.
+
+
+ filter_list + +
+ list + / elements=dictionary +
+ 		+ +
Filter prefixes between OSPF areas.
+
+
+ direction + +
+ string + / required +
+ 		+
    Choices: +
  • in
    • +
  • out
    • +
+ 		+
The direction to apply the route map.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
The Route-map name.
+
+
+ nssa + +
+ dictionary +
+ 		+ +
NSSA settings for the area.
+
+
+ default_information_originate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Originate Type-7 default LSA into NSSA area.
+
+
+ no_redistribution + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send redistributed LSAs into NSSA area.
+
+
+ no_summary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send summary LSAs into NSSA area.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure area as NSSA.
+
+
+ translate + +
+ dictionary +
+ 		+ +
Translate LSA.
+
+
+ type7 + +
+ dictionary +
+ 		+ +
Translate from Type 7 to Type 5.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always translate LSAs
+
+
+ never + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Never translate LSAs
+
+
+ supress_fa + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress forwarding address in translated LSAs.
+
+
+ ranges + +
+ list + / elements=dictionary +
+ 		+ +
Configure an address range for the area.
+
+
+ cost + +
+ integer +
+ 		+ +
Cost to use for the range.
+
+
+ not_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress advertising the specified range.
+
+
+ prefix + +
+ string + / required +
+ 		+ +
IP in Prefix format (x.x.x.x/len)
+
+
+ stub + +
+ dictionary +
+ 		+ +
Settings for configuring the area as a stub.
+
+
+ no_summary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Prevent ABR from sending summary LSAs into stub area.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure the area as a stub.
+
+
+ auto_cost + +
+ dictionary +
+ 		+ +
Calculate OSPF cost according to bandwidth.
+
+
+ reference_bandwidth + +
+ integer + / required +
+ 		+ +
Reference bandwidth used to assign OSPF cost.
+
+
+ unit + +
+ string + / required +
+ 		+
    Choices: +
  • Gbps
    • +
  • Mbps
    • +
+ 		+
Specify in which unit the reference bandwidth is specified.
+
+
+ bfd + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable BFD on all OSPF interfaces.
+
+
+ capability + +
+ dictionary +
+ 		+ +
OSPF capability settings.
+
+
+ vrf_lite + +
+ dictionary +
+ 		+ +
Enable VRF-lite capability settings.
+
+
+ evpn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ethernet VPN.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable VRF-lite support.
+
+
+ default_information + +
+ dictionary +
+ 		+ +
Control distribution of default routes.
+
+
+ originate + +
+ dictionary +
+ 		+ +
Distribute a default route.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always advertise a default route.
+
+
+ route_map + +
+ string +
+ 		+ +
Policy to control distribution of default routes
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable distribution of default route.
+
+
+ default_metric + +
+ integer +
+ 		+ +
Specify default metric for redistributed routes.
+
+
+ distance + +
+ integer +
+ 		+ +
Configure the OSPF administrative distance.
+
+
+ down_bit_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure a PE router to ignore the DN bit for network summary, external and NSSA external LSA.
+
+
+ graceful_restart + +
+ dictionary +
+ 		+ +
Configure graceful restart.
+
+
+ grace_period + +
+ integer +
+ 		+ +
Configure maximum interval to restart gracefully.
+
+
+ helper_disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable helper mode.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable graceful-restart.
+
+
+ log_adjacency_changes + +
+ dictionary +
+ 		+ +
Log changes in adjacency state.
+
+
+ detail + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Notify all state changes.
+
+
+ log + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable logging changes in adjacency state.
+
+
+ max_lsa + +
+ dictionary +
+ 		+ +
Feature to limit the number of non-self-originated LSAs.
+
+
+ ignore_count + +
+ integer +
+ 		+ +
Set count on how many times adjacencies can be suppressed.
+
+
+ ignore_time + +
+ integer +
+ 		+ +
Set time during which all adjacencies are suppressed.
+
+
+ max_non_self_generated_lsa + +
+ integer + / required +
+ 		+ +
Set the maximum number of non self-generated LSAs.
+
+
+ reset_time + +
+ integer +
+ 		+ +
Set number of minutes after which ignore-count is reset to zero.
+
+
+ threshold + +
+ integer +
+ 		+ +
Threshold value (%) at which to generate a warning message.
+
+
+ warning_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log a warning message when limit is exceeded.
+
+
+ max_metric + +
+ dictionary +
+ 		+ +
Maximize the cost metric.
+
+
+ router_lsa + +
+ dictionary +
+ 		+ +
Router LSA configuration.
+
+
+ external_lsa + +
+ dictionary +
+ 		+ +
External LSA configuration.
+
+
+ max_metric_value + +
+ integer +
+ 		+ +
Set max metric value for external LSAs.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set external-lsa attribute.
+
+
+ include_stub + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise Max metric for Stub links as well.
+
+
+ on_startup + +
+ dictionary +
+ 		+ +
Effective only at startup.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set on-startup attribute.
+
+
+ wait_for_bgp_asn + +
+ integer +
+ 		+ +
ASN of BGP to wait for.
+
+
+ wait_period + +
+ integer +
+ 		+ +
Wait period in seconds after startup.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set router-lsa attribute.
+
+
+ summary_lsa + +
+ dictionary +
+ 		+ +
Summary LSAs configuration.
+
+
+ max_metric_value + +
+ integer +
+ 		+ +
Max metric value for summary LSAs.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set summary-lsa attribute.
+
+
+ maximum_paths + +
+ integer +
+ 		+ +
Maximum paths per destination.
+
+
+ name_lookup + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Display OSPF router ids as DNS names.
+
+
+ passive_interface + +
+ dictionary +
+ 		+ +
Suppress routing updates on the interface.
+
+
+ default + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Interfaces passive by default.
+
+
+ redistribute + +
+ list + / elements=dictionary +
+ 		+ +
Redistribute information from another routing protocol.
+
+
+ id + +
+ string +
+ 		+ +
The identifier for the protocol specified.
+
+
+ protocol + +
+ string + / required +
+ 		+
    Choices: +
  • bgp
    • +
  • direct
    • +
  • eigrp
    • +
  • isis
    • +
  • lisp
    • +
  • ospf
    • +
  • rip
    • +
  • static
    • +
+ 		+
The name of the protocol.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
The route map policy to constrain redistribution.
+
+
+ rfc1583compatibility + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure 1583 compatibility for external path preferences.
+
+
+ router_id + +
+ string +
+ 		+ +
Set OSPF process router-id.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Shutdown the OSPF protocol instance.
+
+
+ summary_address + +
+ list + / elements=dictionary +
+ 		+ +
Configure route summarization for redistribution.
+
+
+ not_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress advertising the specified summary.
+
+
+ prefix + +
+ string + / required +
+ 		+ +
IP prefix in format x.x.x.x/ml.
+
+
+ tag + +
+ integer +
+ 		+ +
A 32-bit tag value.
+
+
+ table_map + +
+ dictionary +
+ 		+ +
Policy for filtering/modifying OSPF routes before sending them to RIB.
+
+
+ filter + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Block the OSPF routes from being sent to RIB.
+
+
+ name + +
+ string + / required +
+ 		+ +
The Route Map name.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure timer related constants.
+
+
+ lsa_arrival + +
+ integer +
+ 		+ +
Mimimum interval between arrival of a LSA.
+
+
+ lsa_group_pacing + +
+ integer +
+ 		+ +
LSA group refresh/maxage interval.
+
+
+ throttle + +
+ dictionary +
+ 		+ +
Configure throttle related constants.
+
+
+ lsa + +
+ dictionary +
+ 		+ +
Set rate-limiting for LSA generation.
+
+
+ hold_interval + +
+ integer +
+ 		+ +
The hold interval.
+
+
+ max_interval + +
+ integer +
+ 		+ +
The max interval.
+
+
+ start_interval + +
+ integer +
+ 		+ +
The start interval.
+
+
+ spf + +
+ dictionary +
+ 		+ +
Set OSPF SPF timers.
+
+
+ initial_spf_delay + +
+ integer +
+ 		+ +
Initial SPF schedule delay in milliseconds.
+
+
+ max_wait_time + +
+ integer +
+ 		+ +
Maximum wait time between SPF calculations.
+
+
+ min_hold_time + +
+ integer +
+ 		+ +
Minimum hold time between SPF calculations.
+
+
+ vrf + +
+ string + / required +
+ 		+ +
Name/Identifier of the VRF.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section "^router ospf .*".
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • parsed
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 7.0(3)I5(1). + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # nxos-9k-rdo# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_ospfv2: + config: + processes: + - process_id: 100 + router_id: 203.0.113.20 + - process_id: 102 + router_id: 198.51.100.1 + areas: + - area_id: 0.0.0.100 + filter_list: + - route_map: rmap_1 + direction: in + - route_map: rmap_2 + direction: out + ranges: + - prefix: 198.51.100.64/27 + not_advertise: true + - prefix: 198.51.100.96/27 + cost: 120 + - area_id: 0.0.0.101 + authentication: + message_digest: true + redistribute: + - protocol: eigrp + id: 120 + route_map: rmap_1 + - protocol: direct + route_map: ospf102-direct-connect + vrfs: + - vrf: zone1 + router_id: 198.51.100.129 + redistribute: + - protocol: static + route_map: zone1-static-connect + summary_address: + - prefix: 198.51.100.128/27 + tag: 121 + - prefix: 198.51.100.160/27 + areas: + - area_id: 0.0.0.102 + nssa: + default_information_originate: true + no_summary: true + - area_id: 0.0.0.103 + nssa: + no_summary: true + translate: + type7: + always: true + - vrf: zone2 + auto_cost: + reference_bandwidth: 45 + unit: Gbps + state: merged + + # Task output: + # ------------ + # before: {} + # + # commands: + # - router ospf 102 + # - router-id 198.51.100.1 + # - redistribute eigrp 120 route-map rmap_1 + # - redistribute direct route-map ospf102-direct-connect + # - area 0.0.0.100 filter-list route-map rmap_1 in + # - area 0.0.0.100 filter-list route-map rmap_2 out + # - area 0.0.0.100 range 198.51.100.64/27 not-advertise + # - area 0.0.0.100 range 198.51.100.96/27 cost 120 + # - area 0.0.0.101 authentication message-digest + # - vrf zone1 + # - router-id 198.51.100.129 + # - summary-address 198.51.100.128/27 tag 121 + # - summary-address 198.51.100.160/27 + # - redistribute static route-map zone1-static-connect + # - area 0.0.0.102 nssa no-summary default-information-originate + # - area 0.0.0.103 nssa no-summary + # - area 0.0.0.103 nssa translate type7 always + # - vrf zone2 + # - auto-cost reference-bandwidth 45 Gbps + # - router ospf 100 + # - router-id 203.0.113.20 + # + # after: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.100 + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # - cost: 120 + # prefix: 198.51.100.96/27 + # - area_id: 0.0.0.101 + # authentication: + # message_digest: true + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # - area_id: 0.0.0.103 + # nssa: + # no_summary: true + # translate: + # type7: + # always: true + # redistribute: + # - protocol: static + # route_map: zone1-static-connect + # router_id: 198.51.100.129 + # vrf: zone1 + # - auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # vrf: zone2 + # + + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # area 0.0.0.100 range 198.51.100.96/27 cost 120 + # area 0.0.0.101 authentication message-digest + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # area 0.0.0.103 nssa no-summary + # area 0.0.0.103 nssa translate type7 always + # redistribute static route-map zone1-static-connect + # summary-address 198.51.100.128/27 tag 121 + # summary-address 198.51.100.160/27 + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + + # Using replaced + + # Before state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # area 0.0.0.100 range 198.51.100.96/27 cost 120 + # area 0.0.0.101 authentication message-digest + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # area 0.0.0.103 nssa no-summary + # area 0.0.0.103 nssa translate type7 always + # redistribute static route-map zone1-static-connect + # summary-address 198.51.100.128/27 tag 121 + # summary-address 198.51.100.160/27 + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + + - name: >- + Replace device configurations of listed OSPF processes with provided + configurations + cisco.nxos.nxos_ospfv2: + config: + processes: + - process_id: 102 + router_id: 198.51.100.1 + areas: + - area_id: 0.0.0.100 + filter_list: + - route_map: rmap_8 + direction: in + ranges: + - prefix: 198.51.100.64/27 + not_advertise: true + - area_id: 0.0.0.101 + stub: + no_summary: true + redistribute: + - protocol: eigrp + id: 130 + route_map: rmap_1 + - protocol: direct + route_map: ospf102-direct-connect + vrfs: + - vrf: zone1 + router_id: 198.51.100.129 + redistribute: + - protocol: bgp + id: 65563 + route_map: zone1-bgp-connect + areas: + - area_id: 0.0.0.102 + nssa: + default_information_originate: true + no_summary: true + state: replaced + + + # Task output: + # ------------ + # before: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.100 + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # - cost: 120 + # prefix: 198.51.100.96/27 + # - area_id: 0.0.0.101 + # authentication: + # message_digest: true + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # - area_id: 0.0.0.103 + # nssa: + # no_summary: true + # translate: + # type7: + # always: true + # redistribute: + # - protocol: static + # route_map: zone1-static-connect + # router_id: 198.51.100.129 + # vrf: zone1 + # - auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # vrf: zone2 + # + # commands: + # - router ospf 102 + # - redistribute eigrp 130 route-map rmap_1 + # - no redistribute eigrp 120 route-map rmap_1 + # - area 0.0.0.100 filter-list route-map rmap_8 in + # - no area 0.0.0.100 filter-list route-map rmap_2 out + # - no area 0.0.0.100 range 198.51.100.96/27 + # - no area 0.0.0.101 authentication + # - area 0.0.0.101 stub no-summary + # - vrf zone1 + # - no summary-address 198.51.100.128/27 tag 121 + # - no summary-address 198.51.100.160/27 + # - redistribute bgp 65563 route-map zone1-bgp-connect + # - no redistribute static route-map zone1-static-connect + # - no area 0.0.0.103 nssa + # - no area 0.0.0.103 nssa translate type7 always + # - no vrf zone2 + # + # after: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.101 + # stub: + # no_summary: true + # - area_id: 0.0.0.100 + # filter_list: + # - direction: in + # route_map: rmap_8 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "130" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # redistribute: + # - id: "65563" + # protocol: bgp + # route_map: zone1-bgp-connect + # router_id: 198.51.100.129 + # vrf: zone1 + + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # area 0.0.0.101 stub no-summary + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 130 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_8 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # redistribute bgp 65563 route-map zone1-bgp-connect + + # Using overridden + + # Before state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # area 0.0.0.100 range 198.51.100.96/27 cost 120 + # area 0.0.0.101 authentication message-digest + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # area 0.0.0.103 nssa no-summary + # area 0.0.0.103 nssa translate type7 always + # redistribute static route-map zone1-static-connect + # summary-address 198.51.100.128/27 tag 121 + # summary-address 198.51.100.160/27 + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + + - name: Override all OSPF configuration with provided configuration + cisco.nxos.nxos_ospfv2: + config: + processes: + - process_id: 104 + router_id: 203.0.113.20 + - process_id: 102 + router_id: 198.51.100.1 + shutdown: true + state: overridden + + # Task output: + # ------------ + # before: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.100 + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # - cost: 120 + # prefix: 198.51.100.96/27 + # - area_id: 0.0.0.101 + # authentication: + # message_digest: true + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # - area_id: 0.0.0.103 + # nssa: + # no_summary: true + # translate: + # type7: + # always: true + # redistribute: + # - protocol: static + # route_map: zone1-static-connect + # router_id: 198.51.100.129 + # vrf: zone1 + # - auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # vrf: zone2 + # + # commands: + # - no router ospf 100 + # - router ospf 104 + # - router-id 203.0.113.20 + # - router ospf 102 + # - shutdown + # - no redistribute direct route-map ospf102-direct-connect + # - no redistribute eigrp 120 route-map rmap_1 + # - no area 0.0.0.100 filter-list route-map rmap_2 out + # - no area 0.0.0.100 filter-list route-map rmap_1 in + # - no area 0.0.0.100 range 198.51.100.64/27 + # - no area 0.0.0.100 range 198.51.100.96/27 + # - no area 0.0.0.101 authentication + # - no vrf zone1 + # - no vrf zone2 + # + # after: + # processes: + # - process_id: "102" + # router_id: 198.51.100.1 + # shutdown: true + # - process_id: "104" + # router_id: 203.0.113.20 + + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 102 + # router-id 198.51.100.1 + # shutdown + # router ospf 104 + # router-id 203.0.113.20 + + # Using deleted to delete a single OSPF process + + # Before state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # area 0.0.0.100 range 198.51.100.96/27 cost 120 + # area 0.0.0.101 authentication message-digest + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # area 0.0.0.103 nssa no-summary + # area 0.0.0.103 nssa translate type7 always + # redistribute static route-map zone1-static-connect + # summary-address 198.51.100.128/27 tag 121 + # summary-address 198.51.100.160/27 + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + + - name: Delete a single OSPF process + cisco.nxos.nxos_ospfv2: + config: + processes: + - process_id: 102 + state: deleted + + # Task output: + # ------------ + # before: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.100 + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # - cost: 120 + # prefix: 198.51.100.96/27 + # - area_id: 0.0.0.101 + # authentication: + # message_digest: true + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # - area_id: 0.0.0.103 + # nssa: + # no_summary: true + # translate: + # type7: + # always: true + # redistribute: + # - protocol: static + # route_map: zone1-static-connect + # router_id: 198.51.100.129 + # vrf: zone1 + # - auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # vrf: zone2 + # + # commands: + # - no router ospf 102 + # + # after: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + + # Using deleted all OSPF processes from the device + + # Before state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # area 0.0.0.100 range 198.51.100.96/27 cost 120 + # area 0.0.0.101 authentication message-digest + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # area 0.0.0.103 nssa no-summary + # area 0.0.0.103 nssa translate type7 always + # redistribute static route-map zone1-static-connect + # summary-address 198.51.100.128/27 tag 121 + # summary-address 198.51.100.160/27 + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + + - name: Delete all OSPF processes from the device + cisco.nxos.nxos_ospfv2: + state: deleted + + # Task output: + # ------------ + # before: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.100 + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # - cost: 120 + # prefix: 198.51.100.96/27 + # - area_id: 0.0.0.101 + # authentication: + # message_digest: true + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # - area_id: 0.0.0.103 + # nssa: + # no_summary: true + # translate: + # type7: + # always: true + # redistribute: + # - protocol: static + # route_map: zone1-static-connect + # router_id: 198.51.100.129 + # vrf: zone1 + # - auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # vrf: zone2 + # + # commands: + # - no router ospf 100 + # - no router ospf 102 + # + # after: {} + + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # nxos-9k-rdo# + + # Using rendered + + - name: >- + Render platform specific configuration lines (without connecting to the + device) + cisco.nxos.nxos_ospfv2: + config: + processes: + - process_id: 100 + router_id: 203.0.113.20 + - process_id: 102 + router_id: 198.51.100.1 + areas: + - area_id: 0.0.0.100 + filter_list: + - route_map: rmap_1 + direction: in + - route_map: rmap_2 + direction: out + ranges: + - prefix: 198.51.100.64/27 + not_advertise: true + - prefix: 198.51.100.96/27 + cost: 120 + - area_id: 0.0.0.101 + authentication: + message_digest: true + redistribute: + - protocol: eigrp + id: 120 + route_map: rmap_1 + - protocol: direct + route_map: ospf102-direct-connect + vrfs: + - vrf: zone1 + router_id: 198.51.100.129 + redistribute: + - protocol: static + route_map: zone1-static-connect + summary_address: + - prefix: 198.51.100.128/27 + tag: 121 + - prefix: 198.51.100.160/27 + areas: + - area_id: 0.0.0.102 + nssa: + default_information_originate: true + no_summary: true + - area_id: 0.0.0.103 + nssa: + no_summary: true + translate: + type7: + always: true + - vrf: zone2 + auto_cost: + reference_bandwidth: 45 + unit: Gbps + state: rendered + + + # Task output: + # ------------ + # rendered: + # - router ospf 100 + # - router-id 203.0.113.20 + # - router ospf 102 + # - router-id 198.51.100.1 + # - redistribute eigrp 120 route-map rmap_1 + # - redistribute direct route-map ospf102-direct-connect + # - area 0.0.0.100 filter-list route-map rmap_1 in + # - area 0.0.0.100 filter-list route-map rmap_2 out + # - area 0.0.0.100 range 198.51.100.64/27 not-advertise + # - area 0.0.0.100 range 198.51.100.96/27 cost 120 + # - area 0.0.0.101 authentication message-digest + # - vrf zone1 + # - router-id 198.51.100.129 + # - summary-address 198.51.100.128/27 tag 121 + # - summary-address 198.51.100.160/27 + # - redistribute static route-map zone1-static-connect + # - area 0.0.0.102 nssa no-summary default-information-originate + # - area 0.0.0.103 nssa no-summary + # - area 0.0.0.103 nssa translate type7 always + # - vrf zone2 + # - auto-cost reference-bandwidth 45 Gbps + + # Using parsed + + # parsed.cfg + # ------------ + # router ospf 100 + # router-id 192.0.100.1 + # area 0.0.0.101 nssa no-summary no-redistribution + # area 0.0.0.102 stub no-summary + # redistribute direct route-map ospf-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 192.0.2.0/24 not-advertise + # area 0.0.0.100 range 192.0.3.0/24 cost 120 + # area 0.0.0.100 authentication message-digest + # vrf zone1 + # router-id 192.0.100.2 + # area 0.0.100.1 nssa no-summary no-redistribution + # redistribute static route-map zone1-direct-connect + # summary-address 10.0.0.0/24 tag 120 + # summary-address 11.0.0.0/24 not-advertise + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + # down-bit-ignore + # capability vrf-lite evpn + # shutdown + # router ospf 102 + # router-id 198.54.100.1 + # shutdown + # vrf zone2 + # summary-address 192.0.8.0/24 tag 120 + # vrf zone4 + # shutdown + + - name: Parse externally provided OSPFv2 config + cisco.nxos.nxos_ospfv2: + running_config: "{{ lookup('file', 'ospfv2.cfg') }}" + state: parsed + + # Task output: + # ------------ + # parsed: + # processes: + # - process_id: "100" + # areas: + # - area_id: 0.0.0.101 + # nssa: + # no_redistribution: true + # no_summary: true + # - area_id: 0.0.0.102 + # stub: + # no_summary: true + # - area_id: 0.0.0.100 + # authentication: + # message_digest: true + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 192.0.2.0/24 + # - cost: 120 + # prefix: 192.0.3.0/24 + # redistribute: + # - protocol: direct + # route_map: ospf-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 192.0.100.1 + # vrfs: + # - vrf: zone1 + # areas: + # - area_id: 0.0.100.1 + # nssa: + # no_redistribution: true + # no_summary: true + # redistribute: + # - protocol: static + # route_map: zone1-direct-connect + # router_id: 192.0.100.2 + # summary_address: + # - prefix: 10.0.0.0/24 + # tag: 120 + # - not_advertise: true + # prefix: 11.0.0.0/24 + # - vrf: zone2 + # auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # capability: + # vrf_lite: + # evpn: true + # down_bit_ignore: true + # shutdown: true + # - process_id: "102" + # router_id: 198.54.100.1 + # shutdown: true + # vrfs: + # - vrf: zone2 + # summary_address: + # - prefix: 192.0.8.0/24 + # tag: 120 + # - vrf: zone4 + # shutdown: true + + # Using gathered + + - name: Gather OSPFv2 facts using gathered + cisco.nxos.nxos_ospfv2: + state: gathered + + # Task output: + # ------------ + # gathered: + # processes: + # - process_id: "102" + # areas: + # - area_id: 0.0.0.101 + # stub: + # no_summary: true + # - area_id: 0.0.0.100 + # filter_list: + # - direction: in + # route_map: rmap_8 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "130" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - vrf: zone1 + # areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # redistribute: + # - id: "65563" + # protocol: bgp + # route_map: zone1-bgp-connect + # router_id: 198.51.100.129 + # + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['router ospf 102', 'router-id 198.54.100.1', 'router ospf 100', 'router-id 192.0.100.1', 'redistribute eigrp 120 route-map rmap_1', 'redistribute direct route-map ospf-direct-connect', 'area 0.0.0.100 filter-list route-map rmap_1 in', 'area 0.0.0.100 filter-list route-map rmap_2 out', 'area 0.0.0.100 range 192.0.2.0/24 not-advertise', 'area 0.0.0.100 range 192.0.3.0/24 cost 120', 'vrf zone1', 'router-id 192.0.100.2', 'summary-address 10.0.0.0/24 tag 121', 'summary-address 11.0.0.0/24', 'redistribute static route-map zone1-direct-connect', 'vrf zone2', 'auto-cost reference-bandwidth 45 Gbps', 'capability vrf-lite evpn']
+
+
+ gathered + +
+ dictionary +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ dictionary +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['router ospf 102', 'router-id 198.54.100.1', 'router ospf 100']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_overlay_global_module.rst b/docs/cisco.nxos.nxos_overlay_global_module.rst new file mode 100644 index 000000000..1a1b8d975 --- /dev/null +++ b/docs/cisco.nxos.nxos_overlay_global_module.rst @@ -0,0 +1,120 @@ +.. _cisco.nxos.nxos_overlay_global_module: + + +****************************** +cisco.nxos.nxos_overlay_global +****************************** + +**Configures anycast gateway MAC of the switch.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Configures anycast gateway MAC of the switch. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ anycast_gateway_mac + +
+ string + / required +
+ 		+ +
Anycast gateway mac of the switch.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Default restores params default value + - Supported MAC address format are "E.E.E", "EE-EE-EE-EE-EE-EE", "EE:EE:EE:EE:EE:EE" and "EEEE.EEEE.EEEE" + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_overlay_global: + anycast_gateway_mac: b.b.b + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['fabric forwarding anycast-gateway-mac 000B.000B.000B']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_pim_module.rst b/docs/cisco.nxos.nxos_pim_module.rst new file mode 100644 index 000000000..e19eee567 --- /dev/null +++ b/docs/cisco.nxos.nxos_pim_module.rst @@ -0,0 +1,148 @@ +.. _cisco.nxos.nxos_pim_module: + + +******************* +cisco.nxos.nxos_pim +******************* + +**Manages configuration of a PIM instance.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages configuration of a Protocol Independent Multicast (PIM) instance. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ bfd + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enables BFD on all PIM interfaces.
+
Dependency: ''feature bfd''
+
+
+ ssm_range + +
+ list + / elements=string +
+ 		+ Default:
[]
+ 		+
Configure group ranges for Source Specific Multicast (SSM). Valid values are multicast addresses or the keyword none or keyword default. none removes all SSM group ranges. 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 default, otherwise use the default option.
+
+
+ + +Notes +----- + +.. note:: + - Unsupported for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - 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 Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['ip pim bfd', 'ip pim ssm range 224.0.0.0/8']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_ping_module.rst b/docs/cisco.nxos.nxos_ping_module.rst new file mode 100644 index 000000000..d0d805868 --- /dev/null +++ b/docs/cisco.nxos.nxos_ping_module.rst @@ -0,0 +1,311 @@ +.. _cisco.nxos.nxos_ping_module: + + +******************** +cisco.nxos.nxos_ping +******************** + +**Tests reachability using ping from Nexus switch.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Tests reachability using ping from switch to a remote destination. +- For a general purpose network module, see the :ref:`ansible.netcommon.net_ping ` module. +- For Windows targets, use the :ref:`ansible.windows.win_ping ` module instead. +- For targets running Python, use the :ref:`ansible.builtin.ping ` module instead. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ count + +
+ integer +
+ 		+ Default:
5
+ 		+
Number of packets to send.
+
+
+ dest + +
+ string + / required +
+ 		+ +
IP address or hostname (resolvable by switch) of remote node.
+
+
+ df_bit + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Set the DF bit.
+
+
+ size + +
+ integer +
+ 		+ +
Size of packets to send.
+
+
+ source + +
+ string +
+ 		+ +
Source IP Address or hostname (resolvable by switch)
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • absent
    • +
  • present ←
    • +
+ 		+
Determines if the expected result is success or fail.
+
+
+ vrf + +
+ string +
+ 		+ +
Outgoing VRF.
+
+
+ + +Notes +----- + +.. note:: + - Unsupported for Cisco MDS + - For a general purpose network module, see the :ref:`ansible.netcommon.net_ping ` module. + - For Windows targets, use the :ref:`ansible.windows.win_ping ` module instead. + - For targets running Python, use the :ref:`ansible.builtin.ping ` module instead. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Test reachability to 8.8.8.8 using mgmt vrf + cisco.nxos.nxos_ping: + dest: 8.8.8.8 + vrf: management + host: 68.170.147.165 + + - name: Test reachability to a few different public IPs using mgmt vrf + cisco.nxos.nxos_ping: + dest: "{{ item }}" + vrf: management + host: 68.170.147.165 + with_items: + - 8.8.8.8 + - 4.4.4.4 + - 198.6.1.4 + + - name: Test reachability to 8.8.8.8 using mgmt vrf, size and df-bit + cisco.nxos.nxos_ping: + dest: 8.8.8.8 + df_bit: true + size: 1400 + vrf: management + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
Show the command sent
+
+
Sample:
+
['ping 8.8.8.8 count 2 vrf management']
+
+
+ packet_loss + +
+ string +
+ 		always +
Percentage of packets lost
+
+
Sample:
+
0.00%
+
+
+ packets_rx + +
+ integer +
+ 		always +
Packets successfully received
+
+
Sample:
+
2
+
+
+ packets_tx + +
+ integer +
+ 		always +
Packets successfully transmitted
+
+
Sample:
+
2
+
+
+ rtt + +
+ dictionary +
+ 		always +
Show RTT stats
+
+
Sample:
+
{'avg': 6.264, 'max': 6.564, 'min': 5.978}
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_prefix_lists_module.rst b/docs/cisco.nxos.nxos_prefix_lists_module.rst new file mode 100644 index 000000000..25f343132 --- /dev/null +++ b/docs/cisco.nxos.nxos_prefix_lists_module.rst @@ -0,0 +1,1049 @@ +.. _cisco.nxos.nxos_prefix_lists_module: + + +**************************** +cisco.nxos.nxos_prefix_lists +**************************** + +**Prefix-Lists resource module.** + + +Version added: 2.4.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages prefix-lists configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of prefix-list configuration.
+
+
+ afi + +
+ string +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
The Address Family Identifier (AFI) for the prefix-lists.
+
+
+ prefix_lists + +
+ list + / elements=dictionary +
+ 		+ +
List of prefix-list configurations.
+
+
+ description + +
+ string +
+ 		+ +
Description of the prefix list
+
+
+ entries + +
+ list + / elements=dictionary +
+ 		+ +
List of configurations for the specified prefix-list
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • permit
    • +
  • deny
    • +
+ 		+
Prefix-List permit or deny.
+
+
+ eq + +
+ integer +
+ 		+ +
Exact prefix length to be matched.
+
+
+ ge + +
+ integer +
+ 		+ +
Minimum prefix length to be matched.
+
+
+ le + +
+ integer +
+ 		+ +
Maximum prefix length to be matched.
+
+
+ mask + +
+ string +
+ 		+ +
Explicit match mask.
+
+
+ prefix + +
+ string +
+ 		+ +
IP or IPv6 prefix in A.B.C.D/LEN or A:B::C:D/LEN format.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence Number.
+
+
+ name + +
+ string +
+ 		+ +
Name of the prefix-list.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^ip(.* prefix-list').
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
Refer to examples for more details.
+
With state replaced, for the listed prefix-lists, sequences that are in running-config but not in the task are negated.
+
With state overridden, all prefix-lists that are in running-config but not in the task are negated.
+
Please refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # nxos-9k-rdo# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_prefix_lists: + config: + - afi: ipv4 + prefix_lists: + - name: AllowPrefix + description: allows engineering IPv4 networks + entries: + - sequence: 10 + action: permit + prefix: 192.0.2.0/23 + eq: 24 + - sequence: 20 + action: permit + prefix: 198.51.100.128/26 + - name: DenyPrefix + description: denies lab IPv4 networks + entries: + - sequence: 20 + action: deny + prefix: 203.0.113.0/24 + le: 25 + + - afi: ipv6 + prefix_lists: + - name: AllowIPv6Prefix + description: allows engineering IPv6 networks + entries: + - sequence: 8 + action: permit + prefix: "2001:db8:400::/38" + - sequence: 20 + action: permit + prefix: "2001:db8:8000::/35" + le: 37 + + # Task output + # ------------- + # before: [] + # + # commands: + # - "ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks" + # - "ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38" + # - "ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37" + # - "ip prefix-list AllowPrefix description allows engineering IPv4 networks" + # - "ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" + # - "ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" + # - "ip prefix-list DenyPrefix description denies lab IPv4 networks" + # - "ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25" + # + # after: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + # Using replaced + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Replace prefix-lists configurations of listed prefix-lists with provided configurations + cisco.nxos.nxos_prefix_lists: + config: + - afi: ipv4 + prefix_lists: + - name: AllowPrefix + description: allows engineering IPv4 networks + entries: + - sequence: 10 + action: permit + prefix: 203.0.113.64/27 + + - sequence: 30 + action: permit + prefix: 203.0.113.96/27 + - name: AllowPrefix2Stub + description: allow other engineering IPv4 network + state: replaced + + # Task output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # commands: + # - "no ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" + # - "ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27" + # - "ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27" + # - "no ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" + # - "ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network" + # + # after: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 203.0.113.64/27 + # - sequence: 30 + # action: permit + # prefix: 203.0.113.96/27 + # name: AllowPrefix + # - description: allow other engineering IPv4 network + # name: AllowPrefix2Stub + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27 + # ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27 + # ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + # Using overridden + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Override all prefix-lists configuration with provided configuration + cisco.nxos.nxos_prefix_lists: &id003 + config: + - afi: ipv4 + prefix_lists: + - name: AllowPrefix + description: allows engineering IPv4 networks + entries: + - sequence: 10 + action: permit + prefix: 203.0.113.64/27 + + - sequence: 30 + action: permit + prefix: 203.0.113.96/27 + - name: AllowPrefix2Stub + description: allow other engineering IPv4 network + state: overridden + + # Task output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # commands: + # - "no ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" + # - "ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27" + # - "ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27" + # - "no ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" + # - "ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network" + # - "no ip prefix-list DenyPrefix" + # - "no ipv6 prefix-list AllowIPv6Prefix" + # + # after: + # - afi: ipv4 + # prefix_lists: + # - name: AllowPrefix + # description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 203.0.113.64/27 + # + # - sequence: 30 + # action: permit + # prefix: 203.0.113.96/27 + # - name: AllowPrefix2Stub + # description: allow other engineering IPv4 network + # + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27 + # ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27 + # ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network + + # Using deleted to delete a all prefix lists for an AFI + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Delete all prefix-lists for an AFI + cisco.nxos.nxos_prefix_lists: + config: + - afi: ipv4 + state: deleted + register: result + + # Task output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # commands: + # - "no ip prefix-list AllowPrefix" + # - "no ip prefix-list DenyPrefix" + # + # after: + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + # Using deleted to delete a single prefix-list + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Delete a single prefix-list + cisco.nxos.nxos_prefix_lists: + config: + - afi: ipv4 + prefix_lists: + - name: AllowPrefix + state: deleted + + # Task output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # commands: + # - "no ip prefix-list AllowPrefix" + # + # after: + # - afi: ipv4 + # prefix_lists: + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + # Using deleted to delete all prefix-lists from the device + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Delete all prefix-lists + cisco.nxos.nxos_prefix_lists: + state: deleted + + # Task output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # commands: + # - "no ip prefix-list AllowPrefix" + # - "no ip prefix-list DenyPrefix" + # - "no ipv6 prefix-list AllowIPv6Prefix" + # + # after: [] + # + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # nxos-9k-rdo# + + # Using rendered + + - name: Render platform specific configuration lines with state rendered (without connecting to the device) + cisco.nxos.nxos_prefix_lists: &id001 + config: + - afi: ipv4 + prefix_lists: + - name: AllowPrefix + description: allows engineering IPv4 networks + entries: + - sequence: 10 + action: permit + prefix: 192.0.2.0/23 + eq: 24 + - sequence: 20 + action: permit + prefix: 198.51.100.128/26 + - name: DenyPrefix + description: denies lab IPv4 networks + entries: + - sequence: 20 + action: deny + prefix: 203.0.113.0/24 + le: 25 + + - afi: ipv6 + prefix_lists: + - name: AllowIPv6Prefix + description: allows engineering IPv6 networks + entries: + - sequence: 8 + action: permit + prefix: "2001:db8:400::/38" + - sequence: 20 + action: permit + prefix: "2001:db8:8000::/35" + le: 37 + state: rendered + + # Task Output (redacted) + # ----------------------- + # rendered: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + + # Using parsed + + # parsed.cfg + # ------------ + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Parse externally provided prefix-lists configuration + register: result + cisco.nxos.nxos_prefix_lists: + running_config: "{{ lookup('file', './parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + + + + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_reboot_module.rst b/docs/cisco.nxos.nxos_reboot_module.rst new file mode 100644 index 000000000..cc94a6762 --- /dev/null +++ b/docs/cisco.nxos.nxos_reboot_module.rst @@ -0,0 +1,123 @@ +.. _cisco.nxos.nxos_reboot_module: + + +********************** +cisco.nxos.nxos_reboot +********************** + +**Reboot a network device.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Reboot a network device. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ confirm + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Safeguard boolean. Set to true if you're sure you want to reboot.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Tested against Cisco MDS NX-OS 9.2(1) + - The module will fail due to timeout issues, but the reboot will be performed anyway. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_reboot: + confirm: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ rebooted + +
+ boolean +
+ 		success +
Whether the device was instructed to reboot.
+
+
Sample:
+
True
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_rollback_module.rst b/docs/cisco.nxos.nxos_rollback_module.rst new file mode 100644 index 000000000..c948e093a --- /dev/null +++ b/docs/cisco.nxos.nxos_rollback_module.rst @@ -0,0 +1,159 @@ +.. _cisco.nxos.nxos_rollback_module: + + +************************ +cisco.nxos.nxos_rollback +************************ + +**Set a checkpoint or rollback to a checkpoint.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module offers the ability to set a configuration checkpoint file or rollback to a configuration checkpoint file on Cisco NXOS switches. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ checkpoint_file + +
+ string +
+ 		+ +
Name of checkpoint file to create. Mutually exclusive with rollback_to.
+
+
+ rollback_to + +
+ string +
+ 		+ +
Name of checkpoint file to rollback to. Mutually exclusive with checkpoint_file.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Sometimes ``transport=nxapi`` may cause a timeout error. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_rollback: + checkpoint_file: backup.cfg + username: '{{ un }}' + password: '{{ pwd }}' + host: '{{ inventory_hostname }}' + - cisco.nxos.nxos_rollback: + rollback_to: backup.cfg + username: '{{ un }}' + password: '{{ pwd }}' + host: '{{ inventory_hostname }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ filename + +
+ string +
+ 		success +
The filename of the checkpoint/rollback file.
+
+
Sample:
+
backup.cfg
+
+
+ status + +
+ string +
+ 		success +
Which operation took place and whether it was successful.
+
+
Sample:
+
rollback executed
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_route_maps_module.rst b/docs/cisco.nxos.nxos_route_maps_module.rst new file mode 100644 index 000000000..bcdf6a426 --- /dev/null +++ b/docs/cisco.nxos.nxos_route_maps_module.rst @@ -0,0 +1,4368 @@ +.. _cisco.nxos.nxos_route_maps_module: + + +************************** +cisco.nxos.nxos_route_maps +************************** + +**Route Maps resource module.** + + +Version added: 2.2.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages route maps configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of route-map configuration.
+
+
+ entries + +
+ list + / elements=dictionary +
+ 		+ +
List of entries (identified by sequence number) for this route-map.
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • deny
    • +
  • permit
    • +
+ 		+
Route map denies or permits set operations.
+
+
+ continue_sequence + +
+ integer +
+ 		+ +
Continue on a different entry within the route-map.
+
+
+ description + +
+ string +
+ 		+ +
Description of the route-map.
+
+
+ match + +
+ dictionary +
+ 		+ +
Match values from routing table.
+
+
+ as_number + +
+ dictionary +
+ 		+ +
Match BGP peer AS number.
+
+
+ as_path_list + +
+ list + / elements=string +
+ 		+ +
AS path access list name.
+
+
+ asn + +
+ list + / elements=string +
+ 		+ +
AS number.
+
+
+ as_path + +
+ list + / elements=string +
+ 		+ +
Match BGP AS path access-list.
+
+
+ community + +
+ dictionary +
+ 		+ +
Match BGP community list.
+
+
+ community_list + +
+ list + / elements=string +
+ 		+ +
Community list.
+
+
+ exact_match + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do exact matching of communities.
+
+
+ evpn + +
+ dictionary +
+ 		+ +
Match BGP EVPN Routes.
+
+
+ route_types + +
+ list + / elements=string +
+ 		+ +
Match route type for evpn route.
+
+
+ extcommunity + +
+ dictionary +
+ 		+ +
Match BGP community list.
+
+
+ exact_match + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do exact matching of extended communities.
+
+
+ extcommunity_list + +
+ list + / elements=string +
+ 		+ +
Extended Community list.
+
+
+ interfaces + +
+ list + / elements=string +
+ 		+ +
Match first hop interface of route.
+
+
+ ip + +
+ dictionary +
+ 		+ +
Configure IP specific information.
+
+
+ address + +
+ dictionary +
+ 		+ +
Match address of route or match packet.
+
+
+ access_list + +
+ string +
+ 		+ +
IP access-list name (for use in route-maps for PBR only).
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ multicast + +
+ dictionary +
+ 		+ +
Match multicast attributes.
+
+
+ group + +
+ dictionary +
+ 		+ +
Multicast Group prefix.
+
Mutually exclusive with group_range.
+
+
+ prefix + +
+ string +
+ 		+ +
IPv4 group prefix.
+
+
+ group_range + +
+ dictionary +
+ 		+ +
Multicast Group address range.
+
Mutually exclusive with group.
+
+
+ first + +
+ string +
+ 		+ +
First Group address.
+
+
+ last + +
+ string +
+ 		+ +
Last Group address.
+
+
+ rp + +
+ dictionary +
+ 		+ +
Rendezvous point.
+
+
+ prefix + +
+ string +
+ 		+ +
IPv4 rendezvous prefix.
+
+
+ rp_type + +
+ string +
+ 		+
    Choices: +
  • ASM
    • +
  • Bidir
    • +
+ 		+
Multicast rendezvous point type.
+
+
+ source + +
+ string +
+ 		+ +
Multicast source address.
+
+
+ next_hop + +
+ dictionary +
+ 		+ +
Match next-hop address of route.
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ route_source + +
+ dictionary +
+ 		+ +
Match advertising source address of route.
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ ipv6 + +
+ dictionary +
+ 		+ +
Configure IPv6 specific information.
+
+
+ address + +
+ dictionary +
+ 		+ +
Match address of route or match packet.
+
+
+ access_list + +
+ string +
+ 		+ +
IP access-list name (for use in route-maps for PBR only).
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ multicast + +
+ dictionary +
+ 		+ +
Match multicast attributes.
+
+
+ group + +
+ dictionary +
+ 		+ +
Multicast Group prefix.
+
Mutually exclusive with group_range.
+
+
+ prefix + +
+ string +
+ 		+ +
IPv4 group prefix.
+
+
+ group_range + +
+ dictionary +
+ 		+ +
Multicast Group address range.
+
Mutually exclusive with group.
+
+
+ first + +
+ string +
+ 		+ +
First Group address.
+
+
+ last + +
+ string +
+ 		+ +
Last Group address.
+
+
+ rp + +
+ dictionary +
+ 		+ +
Rendezvous point.
+
+
+ prefix + +
+ string +
+ 		+ +
IPv4 rendezvous prefix.
+
+
+ rp_type + +
+ string +
+ 		+
    Choices: +
  • ASM
    • +
  • Bidir
    • +
+ 		+
Multicast rendezvous point type.
+
+
+ source + +
+ string +
+ 		+ +
Multicast source address.
+
+
+ next_hop + +
+ dictionary +
+ 		+ +
Match next-hop address of route.
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ route_source + +
+ dictionary +
+ 		+ +
Match advertising source address of route.
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ mac_list + +
+ list + / elements=string +
+ 		+ +
Match entries of mac-lists.
+
+
+ metric + +
+ list + / elements=integer +
+ 		+ +
Match metric of route.
+
+
+ ospf_area + +
+ list + / elements=integer +
+ 		+ +
Match ospf area.
+
+
+ route_types + +
+ list + / elements=string +
+ 		+
    Choices: +
  • external
    • +
  • inter-area
    • +
  • internal
    • +
  • intra-area
    • +
  • level-1
    • +
  • level-2
    • +
  • local
    • +
  • nssa-external
    • +
  • type-1
    • +
  • type-2
    • +
+ 		+
Match route-type of route.
+
+
+ source_protocol + +
+ list + / elements=string +
+ 		+ +
Match source protocol.
+
+
+ tags + +
+ list + / elements=integer +
+ 		+ +
Match tag of route.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence to insert to/delete from existing route-map entry.
+
+
+ set + +
+ dictionary +
+ 		+ +
Set values in destination routing protocol.
+
+
+ as_path + +
+ dictionary +
+ 		+ +
Prepend string for a BGP AS-path attribute.
+
+
+ prepend + +
+ dictionary +
+ 		+ +
Prepend to the AS-Path.
+
+
+ as_number + +
+ list + / elements=string +
+ 		+ +
AS number.
+
+
+ last_as + +
+ integer +
+ 		+ +
Number of last-AS prepends.
+
+
+ tag + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set the tag as an AS-path attribute.
+
+
+ comm_list + +
+ string +
+ 		+ +
Set BGP community list (for deletion).
+
+
+ community + +
+ dictionary +
+ 		+ +
Set BGP community attribute.
+
+
+ additive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Add to existing community.
+
+
+ graceful_shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Graceful Shutdown (well-known community).
+
+
+ internet + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Internet (well-known community).
+
+
+ local_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send outside local AS (well-known community).
+
+
+ no_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not advertise to any peer (well-known community).
+
+
+ no_export + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not export to next AS (well-known community).
+
+
+ number + +
+ list + / elements=string +
+ 		+ +
Community number aa:nn format
+
+
+ dampening + +
+ dictionary +
+ 		+ +
Set BGP route flap dampening parameters.
+
+
+ half_life + +
+ integer +
+ 		+ +
Half-life time for the penalty.
+
+
+ max_suppress_time + +
+ integer +
+ 		+ +
Maximum suppress time for stable route.
+
+
+ start_reuse_route + +
+ integer +
+ 		+ +
Value to start reusing a route.
+
+
+ start_suppress_route + +
+ integer +
+ 		+ +
Value to start suppressing a route.
+
+
+ distance + +
+ dictionary +
+ 		+ +
Configure administrative distance.
+
+
+ igp_ebgp_routes + +
+ integer +
+ 		+ +
Administrative distance for IGP or EBGP routes
+
+
+ internal_routes + +
+ integer +
+ 		+ +
Distance for internal routes.
+
+
+ local_routes + +
+ integer +
+ 		+ +
Distance for local routes.
+
+
+ evpn + +
+ dictionary +
+ 		+ +
Set BGP EVPN Routes.
+
+
+ gateway_ip + +
+ dictionary +
+ 		+ +
Set gateway IP for type 5 EVPN routes.
+
Cannot set ip and use-nexthop in the same route-map sequence.
+
+
+ ip + +
+ string +
+ 		+ +
Gateway IP address.
+
+
+ use_nexthop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use nexthop address as gateway IP.
+
+
+ extcomm_list + +
+ string +
+ 		+ +
Set BGP extcommunity list (for deletion).
+
+
+ extcommunity + +
+ dictionary +
+ 		+ +
Set BGP extcommunity attribute.
+
+
+ rt + +
+ dictionary +
+ 		+ +
Route-Target.
+
+
+ additive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Add to existing rt extcommunity.
+
+
+ extcommunity_numbers + +
+ list + / elements=string +
+ 		+ +
Extcommunity number.
+
Supported formats are ASN2:NN, ASN4:NN, IPV4:NN.
+
+
+ forwarding_address + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set the forwarding address.
+
+
+ ip + +
+ dictionary +
+ 		+ +
Configure IP features.
+
+
+ address + +
+ dictionary +
+ 		+ +
Specify IP address.
+
+
+ prefix_list + +
+ string +
+ 		+ +
Name of prefix list (Max Size 63).
+
+
+ next_hop + +
+ dictionary +
+ 		+ +
Set next-hop IP address (for policy-based routing)
+
+
+ address + +
+ string +
+ 		+ +
Set space-separated list of next-hop IP addresses. Address ordering is important. Also don`t use unnecessary spaces.
+
+
+ drop_on_fail + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Drop packets instead of using default routing when the configured next hop becomes unreachable
+
+
+ force_order + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Enable next-hop ordering as specified in the address parameter.
+
+
+ load_share + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Enable traffic load balancing across a maximum of 32 next-hop addresses
+
+
+ peer_address + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
BGP prefix next hop is set to the local address of the peer.
+
If no next hop is set in the route map, the next hop is set to the one stored in the path.
+
+
+ redist_unchanged + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set for next-hop address conservation for non-local generated routes.
+
Used with redistribute command. Available to maintain BGP routing compliant with RFC 4271 on Nexus OS.
+
+
+ unchanged + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set for next-hop address conservation in eBGP outgoing updates
+
+
+ verify_availability + +
+ list + / elements=dictionary +
+ 		+ +
Set next-hop ip address tracking with IP SLA
+
+
+ address + +
+ string + / required +
+ 		+ +
Set one next-hop address
+
+
+ drop_on_fail + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Drop packets instead of using default routing when the configured next hop becomes unreachable
+
+
+ force_order + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Enable next-hop ordering as specified in the address parameter.
+
+
+ load_share + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Enable traffic load balancing across a maximum of 32 next-hop addresses
+
+
+ track + +
+ integer + / required +
+ 		+ +
Set track number
+
+
+ precedence + +
+ string +
+ 		+ +
Set precedence field.
+
+
+ ipv6 + +
+ dictionary +
+ 		+ +
Configure IPv6 features.
+
+
+ address + +
+ dictionary +
+ 		+ +
Specify IP address.
+
+
+ prefix_list + +
+ string +
+ 		+ +
Name of prefix list (Max Size 63).
+
+
+ precedence + +
+ string +
+ 		+ +
Set precedence field.
+
+
+ label_index + +
+ integer +
+ 		+ +
Set Segment Routing (SR) label index of route.
+
+
+ level + +
+ string +
+ 		+
    Choices: +
  • level-1
    • +
  • level-1-2
    • +
  • level-2
    • +
+ 		+
Where to import route.
+
+
+ local_preference + +
+ integer +
+ 		+ +
BGP local preference path attribute.
+
+
+ metric + +
+ dictionary +
+ 		+ +
Set metric for destination routing protocol.
+
+
+ bandwidth + +
+ integer +
+ 		+ +
Metric value or Bandwidth in Kbits per second (Max Size 11).
+
+
+ igrp_delay_metric + +
+ integer +
+ 		+ +
IGRP delay metric.
+
+
+ igrp_effective_bandwidth_metric + +
+ integer +
+ 		+ +
IGRP Effective bandwidth metric (Loading) 255 is 100%.
+
+
+ igrp_mtu + +
+ integer +
+ 		+ +
IGRP MTU of the path.
+
+
+ igrp_reliability_metric + +
+ integer +
+ 		+ +
IGRP reliability metric where 255 is 100 percent reliable.
+
+
+ metric_type + +
+ string +
+ 		+
    Choices: +
  • external
    • +
  • internal
    • +
  • type-1
    • +
  • type-2
    • +
+ 		+
Type of metric for destination routing protocol.
+
+
+ nssa_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
OSPF NSSA Areas.
+
+
+ null_interface + +
+ string +
+ 		+ +
Output Null interface.
+
+
+ origin + +
+ string +
+ 		+
    Choices: +
  • egp
    • +
  • igp
    • +
  • incomplete
    • +
+ 		+
BGP origin code.
+
+
+ path_selection + +
+ string +
+ 		+
    Choices: +
  • all
    • +
  • backup
    • +
  • best2
    • +
  • multipaths
    • +
+ 		+
Path selection criteria for BGP.
+
+
+ tag + +
+ integer +
+ 		+ +
Tag value for destination routing protocol.
+
+
+ weight + +
+ integer +
+ 		+ +
BGP weight for routing table.
+
+
+ route_map + +
+ string +
+ 		+ +
Route-map name.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^route-map'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
With state replaced, for the listed route-maps, sequences that are in running-config but not in the task are negated.
+
With state overridden, all route-maps that are in running-config but not in the task are negated.
+
Please refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k-rdo# show running-config | section "^route-map" + # nxos-9k-rdo# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_route_maps: + config: + - route_map: rmap1 + entries: + - sequence: 10 + action: permit + description: rmap1-10-permit + match: + ip: + address: + access_list: acl_1 + as_path: Allow40 + as_number: + asn: 65564 + + - sequence: 20 + action: deny + description: rmap1-20-deny + match: + community: + community_list: + - BGPCommunity1 + - BGPCommunity2 + ip: + address: + prefix_lists: + - AllowPrefix1 + - AllowPrefix2 + set: + dampening: + half_life: 30 + start_reuse_route: 1500 + start_suppress_route: 10000 + max_suppress_time: 120 + + - route_map: rmap2 + entries: + - sequence: 20 + action: permit + description: rmap2-20-permit + continue_sequence: 40 + match: + ipv6: + address: + prefix_lists: AllowIPv6Prefix + interfaces: "{{ nxos_int1 }}" + set: + as_path: + prepend: + as_number: + - 65563 + - 65568 + - 65569 + comm_list: BGPCommunity + + - sequence: 40 + action: deny + description: rmap2-40-deny + match: + route_types: + - level-1 + - level-2 + tags: 2 + ip: + multicast: + rp: + prefix: 192.0.2.0/24 + rp_type: ASM + source: 203.0.113.0/24 + group_range: + first: 239.0.0.1 + last: 239.255.255.255 + + - route_map: rmap3 + entries: + - sequence: 10 + description: "*** first stanza ***" + action: permit + set: + ip: + next_hop: + verify_availability: + - address: 3.3.3.3 + track: 1 + - address: 4.4.4.4 + track: 3 + + - sequence: 20 + description: "*** second stanza ***" + action: permit + set: + ip: + next_hop: + address: 6.6.6.6 2.2.2.2 + load_share: true + drop_on_fail: true + + - sequence: 30 + description: "*** third stanza ***" + action: permit + set: + ip: + next_hop: + peer_address: true + + - sequence: 40 + description: "*** fourth stanza ***" + action: permit + set: + ip: + next_hop: + unchanged: true + redist_unchanged: true + state: merged + + # Task output + # ------------- + # before: [] + # + # commands: + # - "route-map rmap1 permit 10" + # - "match as-number 65564" + # - "match as-path Allow40" + # - "match ip address acl_1" + # - "description rmap1-10-permit" + # - "route-map rmap1 deny 20" + # - "match community BGPCommunity1 BGPCommunity2" + # - "match ip address prefix-list AllowPrefix1 AllowPrefix2" + # - "description rmap1-20-deny" + # - "set dampening 30 1500 10000 120" + # - "route-map rmap2 permit 20" + # - "match interface Ethernet1/1" + # - "match ipv6 address prefix-list AllowIPv6Prefix" + # - "set as-path prepend 65563 65568 65569" + # - "description rmap2-20-permit" + # - "continue 40" + # - "set comm-list BGPCommunity delete" + # - "route-map rmap2 deny 40" + # - "match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM" + # - "match route-type level-1 level-2" + # - "match tag 2" + # - "description rmap2-40-deny" + # - "route-map rmap3 permit 10" + # - "description *** first stanza ***" + # - "set ip next-hop verify-availability 3.3.3.3 track 1" + # - "set ip next-hop verify-availability 4.4.4.4 track 3" + # - "route-map rmap3 permit 20" + # - "description *** second stanza ***" + # - "set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail" + # - "route-map rmap3 permit 30" + # - "description *** third stanza ***" + # - "set ip next-hop peer-address" + # - "route-map rmap3 permit 40" + # - "description *** fourth stanza ***" + # - "set ip next-hop unchanged" + # - "set ip next-hop redist-unchanged" + # + # after: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # - route_map: rmap3 + # entries: + # - sequence: 10 + # description: "*** first stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # verify_availability: + # - address: 3.3.3.3 + # track: 1 + # - address: 4.4.4.4 + # track: 3 + # + # - sequence: 20 + # description: "*** second stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # address: 6.6.6.6 2.2.2.2 + # load_share: true + # drop_on_fail: true + # + # - sequence: 30 + # description: "*** third stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # peer_address: true + # + # - sequence: 40 + # description: "*** fourth stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # unchanged: true + # redist_unchanged: true + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + # route-map rmap3 permit 10 + # description *** first stanza *** + # set ip next-hop verify-availability 3.3.3.3 track 1 + # set ip next-hop verify-availability 4.4.4.4 track 3 + # route-map rmap3 permit 20 + # description *** second stanza *** + # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail + # route-map rmap3 permit 30 + # description *** third stanza *** + # set ip next-hop peer-address + # route-map rmap3 permit 40 + # description *** fourth stanza *** + # set ip next-hop unchanged + # set ip next-hop redist-unchanged + # + # Using replaced + # (for the listed route-map(s), sequences that are in running-config but not in the task are negated) + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + # route-map rmap3 permit 10 + # description *** first stanza *** + # set ip next-hop verify-availability 3.3.3.3 track 1 + # set ip next-hop verify-availability 4.4.4.4 track 3 + # route-map rmap3 permit 20 + # description *** second stanza *** + # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail + # route-map rmap3 permit 30 + # description *** third stanza *** + # set ip next-hop peer-address + # route-map rmap3 permit 40 + # description *** fourth stanza *** + # set ip next-hop unchanged + # set ip next-hop redist-unchanged + # + - name: Replace route-maps configurations of listed route-maps with provided configurations + cisco.nxos.nxos_route_maps: + config: + - route_map: rmap1 + entries: + - sequence: 20 + action: deny + description: rmap1-20-deny + match: + community: + community_list: + - BGPCommunity4 + - BGPCommunity5 + ip: + address: + prefix_lists: + - AllowPrefix1 + set: + community: + local_as: true + + - route_map: rmap3 + entries: + - sequence: 10 + description: "*** first stanza ***" + action: permit + set: + ip: + next_hop: + verify_availability: + - address: 3.3.3.3 + track: 1 + - sequence: 20 + description: "*** second stanza ***" + action: permit + set: + ip: + next_hop: + peer_address: true + - sequence: 30 + description: "*** third stanza ***" + action: permit + set: + ip: + next_hop: + address: 6.6.6.6 2.2.2.2 + load_share: true + drop_on_fail: true + state: replaced + + # Task output + # ------------- + # before: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # - route_map: rmap3 + # entries: + # - sequence: 10 + # description: "*** first stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # verify_availability: + # - address: 3.3.3.3 + # track: 1 + # - address: 4.4.4.4 + # track: 3 + # + # - sequence: 20 + # description: "*** second stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # address: 6.6.6.6 2.2.2.2 + # load_share: true + # drop_on_fail: true + # + # - sequence: 30 + # description: "*** third stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # peer_address: true + # + # - sequence: 40 + # description: "*** fourth stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # unchanged: true + # redist_unchanged: true + # + # commands: + # - no route-map rmap1 permit 10 + # - route-map rmap1 deny 20 + # - no match community BGPCommunity1 BGPCommunity2 + # - match community BGPCommunity4 BGPCommunity5 + # - no match ip address prefix-list AllowPrefix1 AllowPrefix2 + # - match ip address prefix-list AllowPrefix1 + # - no set dampening 30 1500 10000 120 + # - set community local-AS + # - route-map rmap3 permit 10 + # - no set ip next-hop verify-availability 4.4.4.4 track 3 + # - route-map rmap3 permit 20 + # - no set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail + # - set ip next-hop peer-address + # - route-map rmap3 permit 30 + # - no set ip next-hop peer-address + # - set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail + # - no route-map rmap3 permit 40 + # + # after: + # - route_map: rmap1 + # entries: + # - sequence: 20 + # action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity4 + # - BGPCommunity5 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # set: + # community: + # local_as: true + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # - route_map: rmap3 + # entries: + # - sequence: 10 + # description: "*** first stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # verify_availability: + # - address: 3.3.3.3 + # track: 1 + # - sequence: 20 + # description: "*** second stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # peer_address: true + # - sequence: 30 + # description: "*** third stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # address: 6.6.6.6 2.2.2.2 + # load_share: true + # drop_on_fail: true + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 deny 20 + # description rmap1-20-deny + # match community BGPCommunity4 BGPCommunity5 + # match ip address prefix-list AllowPrefix1 + # set community local-AS + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + # route-map rmap3 permit 10 + # description *** first stanza *** + # set ip next-hop verify-availability 3.3.3.3 track 1 + # route-map rmap3 permit 20 + # description *** second stanza *** + # set ip next-hop peer-address + # route-map rmap3 permit 30 + # description *** third stanza *** + # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail + + # Using overridden + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + + - name: Override all route-maps configuration with provided configuration + cisco.nxos.nxos_route_maps: + config: + - route_map: rmap1 + entries: + - sequence: 20 + action: deny + description: rmap1-20-deny + match: + community: + community_list: + - BGPCommunity4 + - BGPCommunity5 + ip: + address: + prefix_lists: + - AllowPrefix1 + set: + community: + local_as: true + state: overridden + + # Task output + # ------------- + # before: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # commands: + # - no route-map rmap1 permit 10 + # - route-map rmap1 deny 20 + # - no match community BGPCommunity1 BGPCommunity2 + # - match community BGPCommunity4 BGPCommunity5 + # - no match ip address prefix-list AllowPrefix1 AllowPrefix2 + # - match ip address prefix-list AllowPrefix1 + # - no set dampening 30 1500 10000 120 + # - set community local-AS + # - no route-map rmap2 permit 20 + # - no route-map rmap2 deny 40 + # + # after: + # - route_map: rmap1 + # entries: + # - sequence: 20 + # action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity4 + # - BGPCommunity5 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # set: + # community: + # local_as: true + # + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^route-map" + # route-map rmap1 deny 20 + # description rmap1-20-deny + # match community BGPCommunity4 BGPCommunity5 + # match ip address prefix-list AllowPrefix1 + # set community local-AS + + # Using deleted to delete a single route-map + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + + - name: Delete single route-map + cisco.nxos.nxos_route_maps: + config: + - route_map: rmap1 + state: deleted + + # Task output + # ------------- + # before: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # commands: + # - no route-map rmap1 permit 10 + # - no route-map rmap1 deny 20 + # + # after: + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^route-map" + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + + # Using deleted to delete all route-maps from the device running-config + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + + - name: Delete all route-maps + cisco.nxos.nxos_route_maps: + state: deleted + + # Task output + # ------------- + # before: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # commands: + # - no route-map rmap1 permit 10 + # - no route-map rmap1 deny 20 + # - no route-map rmap2 permit 20 + # - no route-map rmap2 deny 40 + # + # after: [] + # + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^route-map" + + - name: Render platform specific configuration lines with state rendered (without connecting to the device) + cisco.nxos.nxos_route_maps: + config: + - route_map: rmap1 + entries: + - sequence: 10 + action: permit + description: rmap1-10-permit + match: + ip: + address: + access_list: acl_1 + as_path: Allow40 + as_number: + asn: 65564 + + - sequence: 20 + action: deny + description: rmap1-20-deny + match: + community: + community_list: + - BGPCommunity1 + - BGPCommunity2 + ip: + address: + prefix_lists: + - AllowPrefix1 + - AllowPrefix2 + set: + dampening: + half_life: 30 + start_reuse_route: 1500 + start_suppress_route: 10000 + max_suppress_time: 120 + + - route_map: rmap2 + entries: + - sequence: 20 + action: permit + description: rmap2-20-permit + continue_sequence: 40 + match: + ipv6: + address: + prefix_lists: AllowIPv6Prefix + interfaces: "{{ nxos_int1 }}" + set: + as_path: + prepend: + as_number: + - 65563 + - 65568 + - 65569 + comm_list: BGPCommunity + + - sequence: 40 + action: deny + description: rmap2-40-deny + match: + route_types: + - level-1 + - level-2 + tags: 2 + ip: + multicast: + rp: + prefix: 192.0.2.0/24 + rp_type: ASM + source: 203.0.113.0/24 + group_range: + first: 239.0.0.1 + last: 239.255.255.255 + state: rendered + + # Task Output (redacted) + # ----------------------- + # rendered: + # - "route-map rmap1 permit 10" + # - "match as-number 65564" + # - "match as-path Allow40" + # - "match ip address acl_1" + # - "description rmap1-10-permit" + # - "route-map rmap1 deny 20" + # - "match community BGPCommunity1 BGPCommunity2" + # - "match ip address prefix-list AllowPrefix1 AllowPrefix2" + # - "description rmap1-20-deny" + # - "set dampening 30 1500 10000 120" + # - "route-map rmap2 permit 20" + # - "match interface Ethernet1/1" + # - "match ipv6 address prefix-list AllowIPv6Prefix" + # - "set as-path prepend 65563 65568 65569" + # - "description rmap2-20-permit" + # - "continue 40" + # - "set comm-list BGPCommunity delete" + # - "route-map rmap2 deny 40" + # - "match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM" + # - "match route-type level-1 level-2" + # - "match tag 2" + # - "description rmap2-40-deny" + + # Using parsed + + # parsed.cfg + # ------------ + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + + - name: Parse externally provided route-maps configuration + cisco.nxos.nxos_route_maps: + running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + + # Using gathered + + # Existing route-map config + # --------------------------- + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + + - name: Gather route-maps facts using gathered + cisco.nxos.nxos_route_maps: + state: gathered + + # gathered: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['route-map rmap1 permit 10', 'match as-number 65564', 'match as-path Allow40', 'match ip address acl_1', 'description rmap1-10-permit', 'route-map rmap1 deny 20', 'match community BGPCommunity1 BGPCommunity2']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_rpm_module.rst b/docs/cisco.nxos.nxos_rpm_module.rst new file mode 100644 index 000000000..79d616a59 --- /dev/null +++ b/docs/cisco.nxos.nxos_rpm_module.rst @@ -0,0 +1,226 @@ +.. _cisco.nxos.nxos_rpm_module: + + +******************* +cisco.nxos.nxos_rpm +******************* + +**Install patch or feature rpms on Cisco NX-OS devices.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Install software maintenance upgrade (smu) RPMS and 3rd party RPMS on Cisco NX-OS devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ aggregate + +
+ list + / elements=dictionary +
+ 		+ +
List of RPM/patch definitions.
+
+
+ file_system + +
+ string +
+ 		+ +
The remote file system of the device. If omitted, devices that support a file_system parameter will use their default values.
+
+
+ pkg + +
+ string + / required +
+ 		+ +
Name of the RPM package.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
If the state is present, the rpm will be installed, If the state is absent, it will be removed.
+
+
+ file_system + +
+ string +
+ 		+ Default:
"bootflash"
+ 		+
The remote file system of the device. If omitted, devices that support a file_system parameter will use their default values.
+
+
+ pkg + +
+ string +
+ 		+ +
Name of the RPM package.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
If the state is present, the rpm will be installed, If the state is absent, it will be removed.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.0(3)I2(5), 7.0(3)I4(6), 7.0(3)I5(3), 7.0(3)I6(1), 7.0(3)I7(3) + - Unsupported for Cisco MDS + - For patches, the minimum platform version needed is 7.0(3)I2(5) + - For feature rpms, the minimum platform version needed is 7.0(3)I6(1) + - The module manages the entire RPM lifecycle (Add, activate, commit, deactivate, remove) + - For reload patches, this module is NOT idempotent until the patch is committed. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_rpm: + pkg: nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000.rpm + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['install add bootflash:nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000.rpm forced', 'install activate nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000 forced', 'install commit nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Sai Chintalapudi (@saichint) diff --git a/docs/cisco.nxos.nxos_snapshot_module.rst b/docs/cisco.nxos.nxos_snapshot_module.rst new file mode 100644 index 000000000..fe89b5b7b --- /dev/null +++ b/docs/cisco.nxos.nxos_snapshot_module.rst @@ -0,0 +1,363 @@ +.. _cisco.nxos.nxos_snapshot_module: + + +************************ +cisco.nxos.nxos_snapshot +************************ + +**Manage snapshots of the running states of selected features.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Create snapshots of the running states of selected features, add new show commands for snapshot creation, delete and compare existing snapshots. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ action + +
+ string + / required +
+ 		+
    Choices: +
  • add
    • +
  • compare
    • +
  • create
    • +
  • delete
    • +
  • delete_all
    • +
+ 		+
Define what snapshot action the module would perform.
+
+
+ compare_option + +
+ string +
+ 		+
    Choices: +
  • summary
    • +
  • ipv4routes
    • +
  • ipv6routes
    • +
+ 		+
Snapshot options to be used when action=compare.
+
+
+ comparison_results_file + +
+ string +
+ 		+ +
Name of the file where snapshots comparison will be stored when action=compare.
+
+
+ description + +
+ string +
+ 		+ +
Snapshot description to be used when action=create.
+
+
+ element_key1 + +
+ string +
+ 		+ +
Specify the tags used to distinguish among row entries, to be used when action=add.
+
+
+ element_key2 + +
+ string +
+ 		+ +
Specify the tags used to distinguish among row entries, to be used when action=add.
+
+
+ path + +
+ string +
+ 		+ Default:
"./"
+ 		+
Specify the path of the file where new created snapshot or snapshots comparison will be stored, to be used when action=create and save_snapshot_locally=true or action=compare.
+
+
+ row_id + +
+ string +
+ 		+ +
Specifies the tag of each row entry of the show command's XML output, to be used when action=add.
+
+
+ save_snapshot_locally + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Specify to locally store a new created snapshot, to be used when action=create.
+
+
+ section + +
+ string +
+ 		+ +
Used to name the show command output, to be used when action=add.
+
+
+ show_command + +
+ string +
+ 		+ +
Specify a new show command, to be used when action=add.
+
+
+ snapshot1 + +
+ string +
+ 		+ +
First snapshot to be used when action=compare.
+
+
+ snapshot2 + +
+ string +
+ 		+ +
Second snapshot to be used when action=compare.
+
+
+ snapshot_name + +
+ string +
+ 		+ +
Snapshot name, to be used when action=create or action=delete.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - ``transport=cli`` may cause timeout errors. + - The ``element_key1`` and ``element_key2`` parameter specify the tags used to distinguish among row entries. In most cases, only the element_key1 parameter needs to specified to be able to distinguish among row entries. + - ``action=compare`` will always store a comparison report on a local file. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Create a snapshot and store it locally + - cisco.nxos.nxos_snapshot: + action: create + snapshot_name: test_snapshot + description: Done with Ansible + save_snapshot_locally: true + path: /home/user/snapshots/ + + # Delete a snapshot + - cisco.nxos.nxos_snapshot: + action: delete + snapshot_name: test_snapshot + + # Delete all existing snapshots + - cisco.nxos.nxos_snapshot: + action: delete_all + + # Add a show command for snapshots creation + - cisco.nxos.nxos_snapshot: + section: myshow + show_command: show ip interface brief + row_id: ROW_intf + element_key1: intf-name + + # Compare two snapshots + - cisco.nxos.nxos_snapshot: + action: compare + snapshot1: pre_snapshot + snapshot2: post_snapshot + comparison_results_file: compare_snapshots.txt + compare_option: summary + path: ../snapshot_reports/ + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		verbose mode +
commands sent to the device
+
+
Sample:
+
['snapshot create post_snapshot Post-snapshot']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_community_module.rst b/docs/cisco.nxos.nxos_snmp_community_module.rst new file mode 100644 index 000000000..584d2d772 --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_community_module.rst @@ -0,0 +1,201 @@ +.. _cisco.nxos.nxos_snmp_community_module: + + +****************************** +cisco.nxos.nxos_snmp_community +****************************** + +**(deprecated, removed after 2024-01-01) Manages SNMP community configs.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated modules released with more functionality +:Alternative: nxos_snmp_server + + + +Synopsis +-------- +- Manages SNMP community configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ access + +
+ string +
+ 		+
    Choices: +
  • ro
    • +
  • rw
    • +
+ 		+
Access type for community.
+
+
+ acl + +
+ string +
+ 		+ +
ACL name to filter snmp requests or keyword 'default'.
+
+
+ community + +
+ string + / required +
+ 		+ +
Case-sensitive community string.
+
+
+ group + +
+ string +
+ 		+ +
Group to which the community belongs.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure snmp community is configured + - cisco.nxos.nxos_snmp_community: + community: TESTING7 + group: network-operator + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['snmp-server community TESTING7 group network-operator']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_host_module.rst b/docs/cisco.nxos.nxos_snmp_host_module.rst new file mode 100644 index 000000000..8aef0b21d --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_host_module.rst @@ -0,0 +1,288 @@ +.. _cisco.nxos.nxos_snmp_host_module: + + +************************* +cisco.nxos.nxos_snmp_host +************************* + +**(deprecated, removed after 2024-01-01) Manages SNMP host configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated modules released with more functionality +:Alternative: nxos_snmp_server + + + +Synopsis +-------- +- Manages SNMP host configuration parameters. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ community + +
+ string +
+ 		+ +
Community string or v3 username.
+
+
+ snmp_host + +
+ string + / required +
+ 		+ +
IP address of hostname of target host.
+
+
+ snmp_type + +
+ string +
+ 		+
    Choices: +
  • trap
    • +
  • inform
    • +
+ 		+
type of message to send to host. If this is not specified, trap type is used.
+
+
+ src_intf + +
+ string +
+ 		+ +
Source interface. Must be fully qualified interface name. If state = absent, the interface is removed.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource. If state = present, the host is added to the configuration. If only vrf and/or vrf_filter and/or src_intf are given, they will be added to the existing host configuration. If state = absent, the host is removed if community parameter is given. It is possible to remove only vrf and/or src_int and/or vrf_filter by providing only those parameters and no community parameter.
+
+
+ udp + +
+ string +
+ 		+ Default:
"162"
+ 		+
UDP port number (0-65535).
+
+
+ v3 + +
+ string +
+ 		+
    Choices: +
  • noauth
    • +
  • auth
    • +
  • priv
    • +
+ 		+
Use this when verion is v3. SNMPv3 Security level.
+
+
+ version + +
+ string +
+ 		+
    Choices: +
  • v1
    • +
  • v2c
    • +
  • v3
    • +
+ 		+
SNMP version. If this is not specified, v1 is used.
+
+
+ vrf + +
+ string +
+ 		+ +
VRF to use to source traffic to source. If state = absent, the vrf is removed.
+
+
+ vrf_filter + +
+ string +
+ 		+ +
Name of VRF to filter. If state = absent, the vrf is removed from the filter.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - ``state=absent`` removes the host configuration if it is configured. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure snmp host is configured + - cisco.nxos.nxos_snmp_host: + snmp_host: 192.0.2.3 + community: TESTING + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['snmp-server host 192.0.2.3 filter-vrf another_test_vrf']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_location_module.rst b/docs/cisco.nxos.nxos_snmp_location_module.rst new file mode 100644 index 000000000..06f564693 --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_location_module.rst @@ -0,0 +1,156 @@ +.. _cisco.nxos.nxos_snmp_location_module: + + +***************************** +cisco.nxos.nxos_snmp_location +***************************** + +**(deprecated, removed after 2024-01-01) Manages SNMP location information.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated modules released with more functionality +:Alternative: nxos_snmp_server + + + +Synopsis +-------- +- Manages SNMP location configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ location + +
+ string + / required +
+ 		+ +
Location information.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure snmp location is configured + - cisco.nxos.nxos_snmp_location: + location: Test + state: present + + # ensure snmp location is not configured + - cisco.nxos.nxos_snmp_location: + location: Test + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['snmp-server location New_Test']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_server_module.rst b/docs/cisco.nxos.nxos_snmp_server_module.rst new file mode 100644 index 000000000..126e16341 --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_server_module.rst @@ -0,0 +1,4474 @@ +.. _cisco.nxos.nxos_snmp_server_module: + + +*************************** +cisco.nxos.nxos_snmp_server +*************************** + +**SNMP Server resource module.** + + +Version added: 2.8.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages SNMP server configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A dict of SNMP server configuration
+
+
+ aaa_user + +
+ dictionary +
+ 		+ +
Set duration for which aaa-cached snmp user exists.
+
+
+ cache_timeout + +
+ integer +
+ 		+ +
Timeout for which aaa-cached user exists(in secs).
+
+
+ communities + +
+ list + / elements=dictionary +
+ 		+ +
Set community string and access privs.
+
+
+ group + +
+ string +
+ 		+ +
Group to which the community belongs.
+
+
+ name + +
+ string +
+ 		+ +
SNMP community string (Max Size 32).
+

aliases: community
+
+
+ ro + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Read-only access with this community string.
+
+
+ rw + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Read-write access with this community string.
+
+
+ use_ipv4acl + +
+ string +
+ 		+ +
Specify IPv4 ACL, the ACL name specified must be IPv4 ACL.
+
This option is unsupported on MDS switches.
+
+
+ use_ipv6acl + +
+ string +
+ 		+ +
Specify IPv6 ACL, the ACL name specified after must be IPv6 ACL.
+
This option is unsupported on MDS switches.
+
+
+ contact + +
+ string +
+ 		+ +
Modify sysContact.
+
+
+ context + +
+ dictionary +
+ 		+ +
SNMP context to be mapped.
+
+
+ instance + +
+ string +
+ 		+ +
Name of the protocol instance (Max Size 32).
+
+
+ name + +
+ string +
+ 		+ +
Name of the SNMP context (Max Size 32).
+
+
+ topology + +
+ string +
+ 		+ +
Topology associated with the SNMP context.
+
+
+ vrf + +
+ string +
+ 		+ +
VRF associated with the SNMP context.
+
This option is unsupported on MDS switches.
+
+
+ counter + +
+ dictionary +
+ 		+ +
Configure port counter configuration.
+
This option is unsupported on MDS switches.
+
+
+ cache + +
+ dictionary +
+ 		+ +
Port stats cache.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable port stats cache.
+
+
+ timeout + +
+ integer +
+ 		+ +
Timeout for which cached port stats exists(in secs).
+
+
+ drop + +
+ dictionary +
+ 		+ +
Silently drop unknown v3 user packets.
+
This option is unsupported on MDS switches.
+
+
+ unknown_engine_id + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Unknown v3 engine id.
+
+
+ unknown_user + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Unknown v3 user.
+
+
+ engine_id + +
+ dictionary +
+ 		+ +
Configure a local SNMPv3 engineID.
+
This option is unsupported on MDS switches.
+
+
+ local + +
+ string +
+ 		+ +
EngineID of the local agent.
+
+
+ global_enforce_priv + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Globally enforce privacy for all the users.
+
+
+ hosts + +
+ list + / elements=dictionary +
+ 		+ +
Specify hosts to receive SNMP notifications.
+
SNMP hosts config lines that appear separately in running-config must be added as individual dictionaries.
+
+
+ auth + +
+ string +
+ 		+ +
Use the SNMPv3 authNoPriv Security Level.
+
+
+ community + +
+ string +
+ 		+ +
SNMP community string or SNMPv3 user name (Max Size 32).
+
+
+ filter_vrf + +
+ string +
+ 		+ +
Filters notifications to the notification host receiver based on the configured VRF.
+
This option is unsupported on MDS switches.
+
+
+ host + +
+ string +
+ 		+ +
IPv4 or IPv6 address or DNS Name of SNMP notification host.
+
+
+ informs + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Inform messages to this host.
+
+
+ priv + +
+ string +
+ 		+ +
Use the SNMPv3 authPriv Security Level.
+
+
+ source_interface + +
+ string +
+ 		+ +
Source interface to be used for sending out SNMP notifications to this host.
+
+
+ traps + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Traps messages to this host.
+
+
+ udp_port + +
+ integer +
+ 		+ +
The notification host's UDP port number.
+
+
+ use_vrf + +
+ string +
+ 		+ +
Configures SNMP to use the selected VRF to communicate with the host receiver.
+
This option is unsupported on MDS switches.
+
+
+ version + +
+ string +
+ 		+
    Choices: +
  • 1
    • +
  • 2c
    • +
  • 3
    • +
+ 		+
SNMP version to use for notification messages.
+
+
+ location + +
+ string +
+ 		+ +
Modify sysLocation.
+
+
+ mib + +
+ dictionary +
+ 		+ +
Mib access parameters.
+
+
+ community_map + +
+ dictionary +
+ 		+ +
SNMP community.
+
+
+ community + +
+ string +
+ 		+ +
SNMP community string (Max Size 32).
+
+
+ context + +
+ string +
+ 		+ +
Name of the SNMP context (Max Size 32).
+
+
+ packetsize + +
+ integer +
+ 		+ +
Largest SNMP packet size
+
+
+ protocol + +
+ dictionary +
+ 		+ +
Snmp protocol operations.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable snmp protocol operations.
+
+
+ source_interface + +
+ dictionary +
+ 		+ +
Source interface to be used for sending out SNMP notifications.
+
This option is unsupported on MDS switches.
+
+
+ informs + +
+ string +
+ 		+ +
SNMP Inform notifications for which this source interface needs to be used.
+
+
+ traps + +
+ string +
+ 		+ +
SNMP Trap notifications for which this source interface needs to be used.
+
+
+ system_shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure snmp-server for reload(2).
+
+
+ tcp_session + +
+ dictionary +
+ 		+ +
Enable one time authentication for snmp over tcp session.
+
+
+ auth + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable one time authentication for snmp over tcp session.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable tcp-session.
+
This option is unsupported on MDS switches.
+
+
+ traps + +
+ dictionary +
+ 		+ +
Enable SNMP Traps
+
+
+ aaa + +
+ dictionary +
+ 		+ +
AAA traps
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable AAA traps.
+
+
+ server_state_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
AAA server state change notification.
+
+
+ bgp + +
+ dictionary +
+ 		+ +
SNMP BGP traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP BGP traps.
+
+
+ bridge + +
+ dictionary +
+ 		+ +
Bridge traps.
+
This option is unsupported on MDS switches.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable bridge traps.
+
+
+ newroot + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP STP Bridge MIB newroot traps.
+
+
+ topologychange + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP STP Bridge MIB topologychange traps.
+
+
+ callhome + +
+ dictionary +
+ 		+ +
Callhome traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable callhome traps.
+
This option is unsupported on MDS switches.
+
+
+ event_notify + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Callhome External Event Notification.
+
+
+ smtp_send_fail + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
SMTP Message Send Fail notification.
+
+
+ cfs + +
+ dictionary +
+ 		+ +
CFS traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable cfs traps.
+
This option is unsupported on MDS switches.
+
+
+ merge_failure + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Merge failure notification.
+
+
+ state_change_notif + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
State change notification.
+
+
+ config + +
+ dictionary +
+ 		+ +
Config traps.
+
+
+ ccmCLIRunningConfigChanged + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Running config change trap.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable config traps.
+
This option is unsupported on MDS switches.
+
+
+ entity + +
+ dictionary +
+ 		+ +
Entity traps.
+
+
+ cefcMIBEnableStatusNotification + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
CefcMIBEnableStatusNotification.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable entity traps.
+
+
+ entity_fan_status_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Fan Status Change.
+
+
+ entity_mib_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity MIB change.
+
+
+ entity_module_inserted + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Module Inserted.
+
+
+ entity_module_removed + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Module Removed.
+
+
+ entity_module_status_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Module Status Change.
+
+
+ entity_power_out_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Power Out Change.
+
+
+ entity_power_status_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Power Status Change.
+
+
+ entity_sensor + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity sensor.
+
+
+ entity_unrecognised_module + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Unrecognised Module.
+
+
+ feature_control + +
+ dictionary +
+ 		+ +
Feature-Control traps.
+
+
+ ciscoFeatOpStatusChange + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Feature operation status change Notification.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable feature-control traps.
+
This option is unsupported on MDS switches.
+
+
+ featureOpStatusChange + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Feature operation status change notification.
+
+
+ generic + +
+ dictionary +
+ 		+ +
Generic traps.
+
+
+ coldStart + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Generic coldStart trap.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable generic traps.
+
This option is unsupported on MDS switches.
+
+
+ warmStart + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Generic warmStart trap.
+
+
+ license + +
+ dictionary +
+ 		+ +
License traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable license traps.
+
This option is unsupported on MDS switches.
+
+
+ notify_license_expiry + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
License Expiry Notification.
+
+
+ notify_license_expiry_warning + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
License Expiry Warning Notification.
+
+
+ notify_licensefile_missing + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
License File Missing Notification.
+
+
+ notify_no_license_for_feature + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
No License installed for feature Notification.
+
+
+ link + +
+ dictionary +
+ 		+ +
Link traps.
+
+
+ cErrDisableInterfaceEventRev1 + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Err-disable state notification.
+
This option is unsupported on MDS switches.
+
+
+ cieLinkDown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Cisco extended link state down notification.
+
+
+ cieLinkUp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Cisco extended link state up notification.
+
+
+ cisco_xcvr_mon_status_chg + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Cisco interface transceiver monitor status change notification.
+
+
+ cmn_mac_move_notification + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Mac addr move trap.
+
This option is unsupported on MDS switches.
+
+
+ delayed_link_state_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Delayed link state change.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable link traps.
+
This option is unsupported on MDS switches.
+
+
+ extended_linkDown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
IETF extended link state down notification.
+
+
+ extended_linkUp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
IETF extended link state up notification.
+
+
+ linkDown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
IETF Link state down notification.
+
+
+ linkUp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
IETF Link state up notification.
+
+
+ mmode + +
+ dictionary +
+ 		+ +
MMode traps.
+
This option is unsupported on MDS switches.
+
+
+ cseMaintModeChangeNotify + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Maint Mode Change Notification.
+
+
+ cseNormalModeChangeNotify + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Normal Mode Change Notification.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable mmode traps.
+
+
+ ospf + +
+ dictionary +
+ 		+ +
SNMP OSPF traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP OSPF traps.
+
+
+ ospfv3 + +
+ dictionary +
+ 		+ +
SNMP OSPFv3 traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP OSPFv3 traps.
+
+
+ rf + +
+ dictionary +
+ 		+ +
RF traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable rf traps.
+
This option is unsupported on MDS switches.
+
+
+ redundancy_framework + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Redundancy_Framework (RF) Sup switchover MIB.
+
+
+ rmon + +
+ dictionary +
+ 		+ +
RMON traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable rmon traps.
+
This option is unsupported on MDS switches.
+
+
+ fallingAlarm + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Rmon falling alarm.
+
+
+ hcFallingAlarm + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
High capacity Rmon falling alarm.
+
+
+ hcRisingAlarm + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
High capacity Rmon rising alarm.
+
+
+ risingAlarm + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Rmon rising alarm.
+
+
+ snmp + +
+ dictionary +
+ 		+ +
SNMP traps.
+
+
+ authentication + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
SNMP authentication trap.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable snmp traps.
+
This option is unsupported on MDS switches.
+
+
+ storm_control + +
+ dictionary +
+ 		+ +
Storm-Control traps.
+
+
+ cpscEventRev1 + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Port-Storm-Control-Event.
+
This option is unsupported on MDS switches.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable storm-control traps.
+
This option is unsupported on MDS switches.
+
+
+ trap_rate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Number of traps per minute.
+
+
+ stpx + +
+ dictionary +
+ 		+ +
Stpx traps.
+
This option is unsupported on MDS switches.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable stpx traps.
+
+
+ inconsistency + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP STPX MIB InconsistencyUpdate traps.
+
+
+ loop_inconsistency + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP STPX MIB LoopInconsistencyUpdate traps.
+
+
+ root_inconsistency + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP STPX MIB RootInconsistencyUpdate traps.
+
+
+ syslog + +
+ dictionary +
+ 		+ +
Enable syslog traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable syslog traps.
+
This option is unsupported on MDS switches.
+
+
+ message_generated + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Message Generated Notification.
+
+
+ sysmgr + +
+ dictionary +
+ 		+ +
Sysmgr traps.
+
+
+ cseFailSwCoreNotifyExtended + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Software Core Notification.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable sysmgr traps.
+
This option is unsupported on MDS switches.
+
+
+ system + +
+ dictionary +
+ 		+ +
System traps.
+
+
+ clock_change_notification + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Clock-change-notification traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable system traps.
+
This option is unsupported on MDS switches.
+
+
+ upgrade + +
+ dictionary +
+ 		+ +
Upgrade traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable upgrade traps.
+
This option is unsupported on MDS switches.
+
+
+ upgradeJobStatusNotify + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Upgrade Job Status Notification.
+
+
+ upgradeOpNotifyOnCompletion + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Upgrade Global Status Notification.
+
+
+ vtp + +
+ dictionary +
+ 		+ +
VTP traps.
+
This option is unsupported on MDS switches.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable VTP traps.
+
+
+ notifs + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable vtpConfigRevNumberError vtpConfigDigestEnable vtpConfigRevNumberError vtpConfigDigestError vtpServerDisabled vtpVersionOneDeviceDetected vlanTrunkPortDynamicStatusChange vtpLocalModeChanged vtpVersionInUseChanged notification.
+
+
+ vlancreate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable vtpVlanCreated notification.
+
+
+ vlandelete + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable vtpVlanDeleted notification.
+
+
+ users + +
+ dictionary +
+ 		+ +
Define users who can access the SNMP engine.
+
+
+ auth + +
+ list + / elements=dictionary +
+ 		+ +
SNMP User authentication related settings
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Authentication parameters for the user.
+
+
+ algorithm + +
+ string +
+ 		+
    Choices: +
  • md5
    • +
  • sha
    • +
  • sha-256
    • +
+ 		+
Select algorithm for authentication.
+
+
+ engine_id + +
+ string +
+ 		+ +
EngineID for configuring notif target user (for V3 informs).
+
This value needs to be enclosed in quotes in the task.
+
+
+ localized_key + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specifies whether the passwords are in localized key format.
+
+
+ localizedv2_key + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specifies whether the passwords are in localized V2 key format.
+
+
+ password + +
+ string +
+ 		+ +
Authentication password for user (Max Size 127).
+
If this value is localized, it has to be enclosed in quotes in the task.
+
+
+ priv + +
+ dictionary +
+ 		+ +
Encryption parameters for the user.
+
+
+ aes_128 + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use 128-bit AES algorithm for privacy.
+
+
+ privacy_password + +
+ string +
+ 		+ +
Privacy password for user (Max Size 130).
+
If this value is localized, it has to be enclosed in quotes in the task.
+
+
+ group + +
+ string +
+ 		+ +
Group name (ignored for notif target user) (Max Size 28).
+
+
+ user + +
+ string +
+ 		+ +
Name of the user (Max Size 28).
+
+
+ use_acls + +
+ list + / elements=dictionary +
+ 		+ +
Set IPv4 and IPv6 ACL to use.
+
+
+ ipv4 + +
+ string +
+ 		+ +
Specify IPv4 ACL, the ACL name specified after must be IPv4 ACL.
+
+
+ ipv6 + +
+ string +
+ 		+ +
Specify IPv6 ACL, the ACL name specified after must be IPv6 ACL.
+
+
+ user + +
+ string +
+ 		+ +
Name of the user (Max Size 28).
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^snmp-server'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
The states replaced and overridden have identical behaviour for this module.
+
Please refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6 on Cisco Nexus Switches. + - This module works with connection ``network_cli`` and ``httpapi``. + - Tested against Cisco MDS NX-OS 9.2(2) with connection ``network_cli``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_snmp_server: + config: + aaa_user: + cache_timeout: 36000 + communities: + - community: public + group: network-operator + - community: private + group: network-admin + contact: nxosswitchadmin@localhost + location: serverroom-1 + traps: + aaa: + server_state_change: true + system: + clock_change_notification: true + hosts: + - host: 192.0.2.1 + traps: true + version: '1' + community: public + - host: 192.0.2.1 + source_interface: Ethernet1/1 + - host: 192.0.2.2 + informs: true + version: '3' + auth: NMS + users: + auth: + - user: snmp_user_1 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + - user: snmp_user_2 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + priv: + privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' + aes_128: true + use_acls: + - user: snmp_user_1 + ipv4: acl1 + ipv6: acl2 + - user: snmp_user_2 + ipv4: acl3 + ipv6: acl4 + + # Task output + # ------------- + # before: + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # + # commands: + # - snmp-server contact nxosswitchadmin@localhost + # - snmp-server location serverroom-1 + # - snmp-server aaa-user cache-timeout 36000 + # - snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # - snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # - snmp-server host 192.0.2.1 traps version 1 public + # - snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # - snmp-server host 192.0.2.2 informs version 3 auth NMS + # - snmp-server community private group network-admin + # - snmp-server community public group network-operator + # - snmp-server enable traps aaa server-state-change + # - snmp-server enable traps system Clock-change-notification + # + # after: + # aaa_user: + # cache_timeout: 36000 + # communities: + # - community: private + # group: network-admin + # - community: public + # group: network-operator + # contact: nxosswitchadmin@localhost + # location: serverroom-1 + # traps: + # aaa: + # server_state_change: true + # system: + # clock_change_notification: true + # hosts: + # - host: 192.0.2.1 + # traps: true + # version: "1" + # community: public + # + # - host: 192.0.2.1 + # source_interface: Ethernet1/1 + # + # - host: 192.0.2.2 + # informs: true + # version: "3" + # auth: NMS + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # + # - user: snmp_user_1 + # group: network-operator + # authentication: + # algorithm: md5 + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # localized_key: true + # + # - authentication: + # algorithm: md5 + # localized_key: true + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # priv: + # aes_128: true + # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" + # group: network-operator + # user: snmp_user_2 + # + # use_acls: + # - user: snmp_user_1 + # ipv4: acl1 + # ipv6: acl2 + # - user: snmp_user_2 + # ipv4: acl3 + # ipv6: acl4 + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server contact nxosswitchadmin@localhost + # snmp-server location serverroom-1 + # snmp-server aaa-user cache-timeout 36000 + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # snmp-server host 192.0.2.1 traps version 1 public + # snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # snmp-server host 192.0.2.2 informs version 3 auth NMS + # snmp-server community private group network-admin + # snmp-server community public group network-operator + # snmp-server enable traps aaa server-state-change + # snmp-server enable traps system Clock-change-notification + + # Using replaced + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server contact nxosswitchadmin@localhost + # snmp-server location serverroom-1 + # snmp-server aaa-user cache-timeout 36000 + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # snmp-server host 192.0.2.1 traps version 1 public + # snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # snmp-server host 192.0.2.2 informs version 3 auth NMS + # snmp-server community private group network-admin + # snmp-server community public group network-operator + # snmp-server enable traps aaa server-state-change + # snmp-server enable traps system Clock-change-notification + + - name: Replace snmp-server configurations of listed snmp-server with provided configurations + cisco.nxos.nxos_snmp_server: + config: + aaa_user: + cache_timeout: 36000 + communities: + - community: public + group: network-operator + - community: secret + group: network-operator + contact: nxosswitchadmin2@localhost + location: serverroom-2 + traps: + aaa: + server_state_change: true + hosts: + - host: 192.0.2.1 + traps: true + version: '1' + community: public + - host: 192.0.2.1 + source_interface: Ethernet1/1 + - host: 192.0.3.2 + informs: true + version: '3' + auth: NMS + users: + auth: + - user: admin + group: network-admin + authentication: + algorithm: md5 + password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + localized_key: true + priv: + privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + + - user: snmp_user_1 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + + - user: snmp_user_2 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + priv: + privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' + aes_128: true + use_acls: + - user: snmp_user_1 + ipv4: acl1 + ipv6: acl2 + state: replaced + + # Task output + # ------------- + # before: + # aaa_user: + # cache_timeout: 36000 + # communities: + # - community: private + # group: network-admin + # - community: public + # group: network-operator + # contact: nxosswitchadmin@localhost + # location: serverroom-1 + # traps: + # aaa: + # server_state_change: true + # system: + # clock_change_notification: true + # hosts: + # - host: 192.0.2.1 + # traps: true + # version: "1" + # community: public + # + # - host: 192.0.2.1 + # source_interface: Ethernet1/1 + # + # - host: 192.0.2.2 + # informs: true + # version: "3" + # auth: NMS + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # + # - user: snmp_user_1 + # group: network-operator + # authentication: + # algorithm: md5 + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # localized_key: true + # + # - authentication: + # algorithm: md5 + # localized_key: true + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # priv: + # aes_128: true + # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" + # group: network-operator + # user: snmp_user_2 + # + # use_acls: + # - user: snmp_user_1 + # ipv4: acl1 + # ipv6: acl2 + # - user: snmp_user_2 + # ipv4: acl3 + # ipv6: acl4 + # + # commands: + # - snmp-server contact nxosswitchadmin2@localhost + # - no snmp-server enable traps system Clock-change-notification + # - snmp-server location serverroom-2 + # - no snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # - no snmp-server host 192.0.2.2 informs version 3 auth NMS + # - snmp-server host 192.0.3.2 informs version 3 auth NMS + # - no snmp-server community private group network-admin + # - snmp-server community secret group network-operator + # + # after: + # aaa_user: + # cache_timeout: 36000 + # communities: + # - community: public + # group: network-operator + # - community: secret + # group: network-operator + # contact: nxosswitchadmin2@localhost + # location: serverroom-2 + # traps: + # aaa: + # server_state_change: true + # hosts: + # - host: 192.0.2.1 + # traps: true + # version: '1' + # community: public + # - host: 192.0.2.1 + # source_interface: Ethernet1/1 + # - host: 192.0.3.2 + # informs: true + # version: '3' + # auth: NMS + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # + # - user: snmp_user_1 + # group: network-operator + # authentication: + # algorithm: md5 + # password: '0x5632724fb8ac3699296af26281e1d0f1' + # localized_key: true + # + # - user: snmp_user_2 + # group: network-operator + # authentication: + # algorithm: md5 + # password: '0x5632724fb8ac3699296af26281e1d0f1' + # localized_key: true + # priv: + # privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' + # aes_128: true + # + # use_acls: + # - user: snmp_user_1 + # ipv4: acl1 + # ipv6: acl2 + # + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server contact nxosswitchadmin2@localhost + # snmp-server location serverroom-2 + # snmp-server aaa-user cache-timeout 36000 + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # snmp-server host 192.0.2.1 traps version 1 public + # snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # snmp-server host 192.0.2.2 informs version 3 auth NMS + # snmp-server community secret group network-operator + # snmp-server community public group network-operator + # snmp-server enable traps aaa server-state-change + # snmp-server enable traps system Clock-change-notification + + # Using deleted + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server contact nxosswitchadmin@localhost + # snmp-server location serverroom-1 + # snmp-server aaa-user cache-timeout 36000 + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # snmp-server host 192.0.2.1 traps version 1 public + # snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # snmp-server host 192.0.2.2 informs version 3 auth NMS + # snmp-server community private group network-admin + # snmp-server community public group network-operator + # snmp-server enable traps aaa server-state-change + # snmp-server enable traps system Clock-change-notification + + - name: Delete SNMP Server configurations from the device (admin user will not be deleted) + cisco.nxos.nxos_snmp_server: + state: deleted + + # Task output + # ------------- + # before: + # aaa_user: + # cache_timeout: 36000 + # communities: + # - community: private + # group: network-admin + # - community: public + # group: network-operator + # contact: nxosswitchadmin@localhost + # location: serverroom-1 + # traps: + # aaa: + # server_state_change: true + # system: + # clock_change_notification: true + # hosts: + # - host: 192.0.2.1 + # traps: true + # version: "1" + # community: public + # + # - host: 192.0.2.1 + # source_interface: Ethernet1/1 + # + # - host: 192.0.2.2 + # informs: true + # version: "3" + # auth: NMS + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # + # - user: snmp_user_1 + # group: network-operator + # authentication: + # algorithm: md5 + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # localized_key: true + # + # - authentication: + # algorithm: md5 + # localized_key: true + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # priv: + # aes_128: true + # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" + # group: network-operator + # user: snmp_user_2 + # + # use_acls: + # - user: snmp_user_1 + # ipv4: acl1 + # ipv6: acl2 + # - user: snmp_user_2 + # ipv4: acl3 + # ipv6: acl4 + # + # commands: + # - no snmp-server contact nxosswitchadmin@localhost + # - no snmp-server location serverroom-1 + # - no snmp-server aaa-user cache-timeout 36000 + # - no snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + # - no snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - no snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - no snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # - no snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # - no snmp-server host 192.0.2.1 traps version 1 public + # - no snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # - no snmp-server host 192.0.2.2 informs version 3 auth NMS + # - no snmp-server community private group network-admin + # - no snmp-server community public group network-operator + # - no snmp-server enable traps aaa server-state-change + # - no snmp-server enable traps system Clock-change-notification + # + # after: + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + + # Using rendered + # --------------- + + - name: Render platform specific configuration lines with state rendered (without connecting to the device) + cisco.nxos.nxos_snmp_server: + config: + aaa_user: + cache_timeout: 36000 + communities: + - community: public + group: network-operator + - community: private + group: network-admin + contact: nxosswitchadmin@localhost + location: serverroom-1 + traps: + aaa: + server_state_change: true + system: + clock_change_notification: true + hosts: + - host: 192.0.2.1 + traps: true + version: '1' + community: public + - host: 192.0.2.1 + source_interface: Ethernet1/1 + - host: 192.0.2.2 + informs: true + version: '3' + auth: NMS + users: + auth: + - user: snmp_user_1 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + - user: snmp_user_2 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + priv: + privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' + aes_128: true + use_acls: + - user: snmp_user_1 + ipv4: acl1 + ipv6: acl2 + - user: snmp_user_2 + ipv4: acl3 + ipv6: acl4 + state: rendered + + + # Task Output (redacted) + # ----------------------- + # rendered: + # - snmp-server contact nxosswitchadmin@localhost + # - snmp-server location serverroom-1 + # - snmp-server aaa-user cache-timeout 36000 + # - snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # - snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # - snmp-server host 192.0.2.1 traps version 1 public + # - snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # - snmp-server host 192.0.2.2 informs version 3 auth NMS + # - snmp-server community private group network-admin + # - snmp-server community public group network-operator + # - snmp-server enable traps aaa server-state-change + # - snmp-server enable traps system Clock-change-notification + + # Using parsed + + # parsed.cfg + # ------------ + # snmp-server contact nxosswitchadmin@localhost + # snmp-server location serverroom-1 + # snmp-server aaa-user cache-timeout 36000 + # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # snmp-server host 192.0.2.1 traps version 1 public + # snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # snmp-server host 192.0.2.2 informs version 3 auth NMS + # snmp-server community private group network-admin + # snmp-server community public group network-operator + # snmp-server enable traps aaa server-state-change + # snmp-server enable traps system Clock-change-notification + + - name: Parse externally provided snmp-server configuration + cisco.nxos.nxos_snmp_server: + running_config: "{{ lookup('file', './parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # aaa_user: + # cache_timeout: 36000 + # communities: + # - community: private + # group: network-admin + # - community: public + # group: network-operator + # contact: nxosswitchadmin@localhost + # location: serverroom-1 + # traps: + # aaa: + # server_state_change: true + # system: + # clock_change_notification: true + # hosts: + # - host: 192.0.2.1 + # traps: true + # version: "1" + # community: public + # + # - host: 192.0.2.1 + # source_interface: Ethernet1/1 + # + # - host: 192.0.2.2 + # informs: true + # version: "3" + # auth: NMS + # users: + # auth: + # - user: snmp_user_1 + # group: network-operator + # authentication: + # algorithm: md5 + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # localized_key: true + # + # - authentication: + # algorithm: md5 + # localized_key: true + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # priv: + # aes_128: true + # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" + # group: network-operator + # user: snmp_user_2 + # + # use_acls: + # - user: snmp_user_1 + # ipv4: acl1 + # ipv6: acl2 + # - user: snmp_user_2 + # ipv4: acl3 + # ipv6: acl4 + # + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['sample command 1', 'sample command 2', 'sample command 3']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['sample command 1', 'sample command 2', 'sample command 3']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_snmp_traps_module.rst b/docs/cisco.nxos.nxos_snmp_traps_module.rst new file mode 100644 index 000000000..726a4d5fe --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_traps_module.rst @@ -0,0 +1,189 @@ +.. _cisco.nxos.nxos_snmp_traps_module: + + +************************** +cisco.nxos.nxos_snmp_traps +************************** + +**(deprecated, removed after 2024-01-01) Manages SNMP traps.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated modules released with more functionality +:Alternative: nxos_snmp_server + + + +Synopsis +-------- +- Manages SNMP traps configurations. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ group + +
+ string + / required +
+ 		+
    Choices: +
  • aaa
    • +
  • bfd
    • +
  • bgp
    • +
  • bridge
    • +
  • callhome
    • +
  • cfs
    • +
  • config
    • +
  • eigrp
    • +
  • entity
    • +
  • feature-control
    • +
  • generic
    • +
  • hsrp
    • +
  • license
    • +
  • link
    • +
  • lldp
    • +
  • mmode
    • +
  • ospf
    • +
  • pim
    • +
  • rf
    • +
  • rmon
    • +
  • snmp
    • +
  • storm-control
    • +
  • stpx
    • +
  • switchfabric
    • +
  • syslog
    • +
  • sysmgr
    • +
  • system
    • +
  • upgrade
    • +
  • vtp
    • +
  • all
    • +
+ 		+
Case sensitive group.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • enabled ←
    • +
  • disabled
    • +
+ 		+
Manage the state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - This module works at the group level for traps. If you need to only enable/disable 1 specific trap within a group, use the :ref:`cisco.nxos.nxos_command ` module. + - Be aware that you can set a trap only for an enabled feature. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure lldp trap configured + - cisco.nxos.nxos_snmp_traps: + group: lldp + state: enabled + + # ensure lldp trap is not configured + - cisco.nxos.nxos_snmp_traps: + group: lldp + state: disabled + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
snmp-server enable traps lldp ;
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_snmp_user_module.rst b/docs/cisco.nxos.nxos_snmp_user_module.rst new file mode 100644 index 000000000..2d3f6f26c --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_user_module.rst @@ -0,0 +1,235 @@ +.. _cisco.nxos.nxos_snmp_user_module: + + +************************* +cisco.nxos.nxos_snmp_user +************************* + +**(deprecated, removed after 2024-01-01) Manages SNMP users for monitoring.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated modules released with more functionality +:Alternative: nxos_snmp_server + + + +Synopsis +-------- +- Manages SNMP user configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ authentication + +
+ string +
+ 		+
    Choices: +
  • md5
    • +
  • sha
    • +
+ 		+
Authentication parameters for the user.
+
+
+ encrypt + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables AES-128 bit encryption when using privacy password.
+
+
+ group + +
+ string +
+ 		+ +
Group to which the user will belong to. If state = present, and the user is existing, the group is added to the user. If the user is not existing, user entry is created with this group argument. If state = absent, only the group is removed from the user entry. However, to maintain backward compatibility, if the existing user belongs to only one group, and if group argument is same as the existing user's group, then the user entry also is deleted.
+
+
+ privacy + +
+ string +
+ 		+ +
Privacy password for the user. This is not idempotent
+
+
+ pwd + +
+ string +
+ 		+ +
Authentication password when using md5 or sha. This is not idempotent
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ user + +
+ string + / required +
+ 		+ +
Name of the user.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - Authentication parameters not idempotent. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_snmp_user: + user: ntc + group: network-operator + authentication: md5 + pwd: test_password + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['snmp-server user ntc network-operator auth md5 test_password']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_udld_interface_module.rst b/docs/cisco.nxos.nxos_udld_interface_module.rst new file mode 100644 index 000000000..cba2733c0 --- /dev/null +++ b/docs/cisco.nxos.nxos_udld_interface_module.rst @@ -0,0 +1,250 @@ +.. _cisco.nxos.nxos_udld_interface_module: + + +****************************** +cisco.nxos.nxos_udld_interface +****************************** + +**Manages UDLD interface configuration params.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages UDLD interface configuration params. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ interface + +
+ string + / required +
+ 		+ +
FULL name of the interface, i.e. Ethernet1/1-
+
+
+ mode + +
+ string + / required +
+ 		+
    Choices: +
  • enabled
    • +
  • disabled
    • +
  • aggressive
    • +
+ 		+
Manages UDLD mode for an interface.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Feature UDLD must be enabled on the device to use this module. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure Ethernet1/1 is configured to be in aggressive mode + - cisco.nxos.nxos_udld_interface: + interface: Ethernet1/1 + mode: aggressive + state: present + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + # Remove the aggressive config only if it's currently in aggressive mode and then disable udld (switch default) + - cisco.nxos.nxos_udld_interface: + interface: Ethernet1/1 + mode: aggressive + state: absent + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + # ensure Ethernet1/1 has aggressive mode enabled + - cisco.nxos.nxos_udld_interface: + interface: Ethernet1/1 + mode: enabled + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ end_state + +
+ dictionary +
+ 		always +
k/v pairs of configuration after module execution
+
+
Sample:
+
{'mode': 'enabled'}
+
+
+ existing + +
+ dictionary +
+ 		always +
k/v pairs of existing configuration
+
+
Sample:
+
{'mode': 'aggressive'}
+
+
+ proposed + +
+ dictionary +
+ 		always +
k/v pairs of parameters passed into module
+
+
Sample:
+
{'mode': 'enabled'}
+
+
+ updates + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['interface ethernet1/33', 'no udld aggressive ; no udld disable']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_udld_module.rst b/docs/cisco.nxos.nxos_udld_module.rst new file mode 100644 index 000000000..dc461bc89 --- /dev/null +++ b/docs/cisco.nxos.nxos_udld_module.rst @@ -0,0 +1,256 @@ +.. _cisco.nxos.nxos_udld_module: + + +******************** +cisco.nxos.nxos_udld +******************** + +**Manages UDLD global configuration params.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages UDLD global configuration params. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ aggressive + +
+ string +
+ 		+
    Choices: +
  • enabled
    • +
  • disabled
    • +
+ 		+
Toggles aggressive mode.
+
+
+ msg_time + +
+ string +
+ 		+ +
Message time in seconds for UDLD packets or keyword 'default'.
+
+
+ reset + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ability to reset all ports shut down by UDLD. 'state' parameter cannot be 'absent' when this is present.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource. When set to 'absent', aggressive and msg_time are set to their default values.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Module will fail if the udld feature has not been previously enabled. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure udld aggressive mode is globally disabled and se global message interval is 20 + - cisco.nxos.nxos_udld: + aggressive: disabled + msg_time: 20 + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + # Ensure agg mode is globally enabled and msg time is 15 + - cisco.nxos.nxos_udld: + aggressive: enabled + msg_time: 15 + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ end_state + +
+ dictionary +
+ 		always +
k/v pairs of udld configuration after module execution
+
+
Sample:
+
{'aggressive': 'enabled', 'msg_time': '40'}
+
+
+ existing + +
+ dictionary +
+ 		always +
k/v pairs of existing udld configuration
+
+
Sample:
+
{'aggressive': 'disabled', 'msg_time': '15'}
+
+
+ proposed + +
+ dictionary +
+ 		always +
k/v pairs of parameters passed into module
+
+
Sample:
+
{'aggressive': 'enabled', 'msg_time': '40'}
+
+
+ updates + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['udld message-time 40', 'udld aggressive']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_user_module.rst b/docs/cisco.nxos.nxos_user_module.rst new file mode 100644 index 000000000..a03a23a03 --- /dev/null +++ b/docs/cisco.nxos.nxos_user_module.rst @@ -0,0 +1,390 @@ +.. _cisco.nxos.nxos_user_module: + + +******************** +cisco.nxos.nxos_user +******************** + +**Manage the collection of local users on Nexus devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module provides declarative management of the local usernames configured on Cisco Nexus devices. It allows playbooks to manage either individual usernames or the collection of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ aggregate + +
+ list + / elements=dictionary +
+ 		+ +
The set of username objects to be configured on the remote Cisco Nexus device. The list entries can either be the username or a hash of username and properties. This argument is mutually exclusive with the name argument.
+

aliases: users, collection
+
+
+ configured_password + +
+ string +
+ 		+ +
The password to be configured on the network device. The password needs to be provided in cleartext and it will be encrypted on the device.
+
+
+ hashed_password + +
+ string +
+ 		+ +
The hashed password to be configured on the network device. The password needs to already be encrypted.
+
+
+ name + +
+ string +
+ 		+ +
The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
+
+
+ roles + +
+ list + / elements=string +
+ 		+ +
The role argument configures the role for the username in the device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device.
+

aliases: role
+
+
+ sshkey + +
+ string +
+ 		+ +
The sshkey argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
The state argument configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
+
+
+ update_password + +
+ string +
+ 		+
    Choices: +
  • on_create
    • +
  • always
    • +
+ 		+
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
+
+
+ configured_password + +
+ string +
+ 		+ +
The password to be configured on the network device. The password needs to be provided in cleartext and it will be encrypted on the device.
+
+
+ hashed_password + +
+ string +
+ 		+ +
The hashed password to be configured on the network device. The password needs to already be encrypted.
+
+
+ name + +
+ string +
+ 		+ +
The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
+
+
+ purge + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
The purge argument instructs the module to consider the resource definition absolute. It will remove any previously configured usernames on the device with the exception of the `admin` user which cannot be deleted per nxos constraints.
+
+
+ roles + +
+ list + / elements=string +
+ 		+ +
The role argument configures the role for the username in the device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device.
+

aliases: role
+
+
+ sshkey + +
+ string +
+ 		+ +
The sshkey argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
The state argument configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
+
+
+ update_password + +
+ string +
+ 		+
    Choices: +
  • on_create
    • +
  • always ←
    • +
+ 		+
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
+
+
+ + +Notes +----- + +.. note:: + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: create a new user + cisco.nxos.nxos_user: + name: ansible + sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}" + state: present + + - name: remove all users except admin + cisco.nxos.nxos_user: + purge: true + + - name: set multiple users role + cisco.nxos.nxos_user: + aggregate: + - name: netop + - name: netend + role: network-operator + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['name ansible', 'name ansible password password']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_vpc_module.rst b/docs/cisco.nxos.nxos_vpc_module.rst new file mode 100644 index 000000000..9e0ca3c29 --- /dev/null +++ b/docs/cisco.nxos.nxos_vpc_module.rst @@ -0,0 +1,352 @@ +.. _cisco.nxos.nxos_vpc_module: + + +******************* +cisco.nxos.nxos_vpc +******************* + +**Manages global VPC configuration** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages global VPC configuration + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ auto_recovery + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/Disables auto recovery on platforms that support disable
+
timers are not modifiable with this attribute
+
mutually exclusive with auto_recovery_reload_delay
+
+
+ auto_recovery_reload_delay + +
+ string +
+ 		+ +
Manages auto-recovery reload-delay timer in seconds
+
mutually exclusive with auto_recovery
+
+
+ delay_restore + +
+ string +
+ 		+ +
manages delay restore command and config value in seconds
+
+
+ delay_restore_interface_vlan + +
+ string +
+ 		+ +
manages delay restore interface-vlan command and config value in seconds
+
not supported on all platforms
+
+
+ delay_restore_orphan_port + +
+ string +
+ 		+ +
manages delay restore orphan-port command and config value in seconds
+
not supported on all platforms
+
+
+ domain + +
+ string + / required +
+ 		+ +
VPC domain
+
+
+ peer_gw + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/Disables peer gateway
+
+
+ pkl_dest + +
+ string +
+ 		+ +
Destination (remote) IP address used for peer keepalive link
+
pkl_dest is required whenever pkl options are used.
+
+
+ pkl_src + +
+ string +
+ 		+ +
Source IP address used for peer keepalive link
+
+
+ pkl_vrf + +
+ string +
+ 		+ +
VRF used for peer keepalive link
+
The VRF must exist on the device before using pkl_vrf.
+
(Note) 'default' is an overloaded term: Default vrf context for pkl_vrf is 'management'; 'pkl_vrf: default' refers to the literal 'default' rib.
+
+
+ role_priority + +
+ string +
+ 		+ +
Role priority for device. Remember lower is better.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manages desired state of the resource
+
+
+ system_priority + +
+ string +
+ 		+ +
System priority device. Remember they must match between peers.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - The feature vpc must be enabled before this module can be used + - If not using management vrf, vrf must be globally on the device before using in the pkl config + - Although source IP isn't required on the command line it is required when using this module. The PKL VRF must also be configured prior to using this module. + - Both pkl_src and pkl_dest are needed when changing PKL VRF. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: configure a simple asn + cisco.nxos.nxos_vpc: + domain: 100 + role_priority: 1000 + system_priority: 2000 + pkl_dest: 192.168.100.4 + pkl_src: 10.1.100.20 + peer_gw: true + auto_recovery: true + + - name: configure + cisco.nxos.nxos_vpc: + domain: 100 + role_priority: 32667 + system_priority: 2000 + peer_gw: true + pkl_src: 10.1.100.2 + pkl_dest: 192.168.100.4 + auto_recovery: true + + - name: Configure VPC with delay restore and existing keepalive VRF + cisco.nxos.nxos_vpc: + domain: 10 + role_priority: 28672 + system_priority: 2000 + delay_restore: 180 + peer_gw: true + pkl_src: 1.1.1.2 + pkl_dest: 1.1.1.1 + pkl_vrf: vpckeepalive + auto_recovery: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['vpc domain 100', 'peer-keepalive destination 192.168.100.4 source 10.1.100.20 vrf management', 'auto-recovery', 'peer-gateway']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vrf_af_module.rst b/docs/cisco.nxos.nxos_vrf_af_module.rst new file mode 100644 index 000000000..236991587 --- /dev/null +++ b/docs/cisco.nxos.nxos_vrf_af_module.rst @@ -0,0 +1,300 @@ +.. _cisco.nxos.nxos_vrf_af_module: + + +********************** +cisco.nxos.nxos_vrf_af +********************** + +**Manages VRF AF.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages VRF AF + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
Address-Family Identifier (AFI).
+
+
+ route_target_both_auto_evpn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable the EVPN route-target 'auto' setting for both import and export target communities.
+
+
+ route_targets + +
+ list + / elements=dictionary +
+ 		+ +
Specify the route-targets which should be imported and/or exported under the AF. This argument accepts a list of dicts that specify the route-target, the direction (import|export|both) and state of each route-target. Default direction is direction=both. See examples.
+
+
+ direction + +
+ string +
+ 		+
    Choices: +
  • import
    • +
  • export
    • +
  • both ←
    • +
+ 		+
Indicates the direction of the route-target (import|export|both)
+
+
+ rt + +
+ string + / required +
+ 		+ +
Defines the route-target itself
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Determines whether the route-target with the given direction should be present or not on the device.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Determines whether the config should be present or not on the device.
+
+
+ vrf + +
+ string + / required +
+ 		+ +
Name of the VRF.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Default, where supported, restores params default value. + - In case of ``state=absent`` the address-family configuration will be absent. Therefore the options ``route_target_both_auto_evpn`` and ``route_targets`` are ignored. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_target_both_auto_evpn: true + state: present + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_targets: + - rt: '65000:1000' + direction: import + - rt: '65001:1000' + direction: import + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_targets: + - rt: '65000:1000' + direction: import + - rt: '65001:1000' + state: absent + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_targets: + - rt: '65000:1000' + direction: export + - rt: '65001:1000' + direction: export + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_targets: + - rt: '65000:1000' + direction: export + state: absent + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_targets: + - rt: '65000:1000' + direction: both + state: present + - rt: '65001:1000' + direction: import + state: present + - rt: '65002:1000' + direction: both + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['vrf context ntc', 'address-family ipv4 unicast']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vrf_module.rst b/docs/cisco.nxos.nxos_vrf_module.rst new file mode 100644 index 000000000..6765f78b5 --- /dev/null +++ b/docs/cisco.nxos.nxos_vrf_module.rst @@ -0,0 +1,494 @@ +.. _cisco.nxos.nxos_vrf_module: + + +******************* +cisco.nxos.nxos_vrf +******************* + +**Manages global VRF configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module provides declarative management of VRFs on CISCO NXOS network devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ admin_state + +
+ string +
+ 		+
    Choices: +
  • up ←
    • +
  • down
    • +
+ 		+
Administrative state of the VRF.
+
+
+ aggregate + +
+ list + / elements=dictionary +
+ 		+ +
List of VRFs definitions.
+
+
+ admin_state + +
+ string +
+ 		+
    Choices: +
  • up
    • +
  • down
    • +
+ 		+
Administrative state of the VRF.
+
+
+ associated_interfaces + +
+ list + / elements=string +
+ 		+ +
This is a intent option and checks the operational state of the for given vrf name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vrf interfaces on device it will result in failure.
+
+
+ delay + +
+ integer +
+ 		+ +
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
+
+
+ description + +
+ string +
+ 		+ +
Description of the VRF or keyword 'default'.
+
+
+ interfaces + +
+ list + / elements=string +
+ 		+ +
List of interfaces to check the VRF has been configured correctly or keyword 'default'.
+
+
+ name + +
+ string +
+ 		+ +
Name of VRF to be managed.
+

aliases: vrf
+
+
+ rd + +
+ string +
+ 		+ +
VPN Route Distinguisher (RD). Valid values are a string in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword 'auto', or the keyword 'default'.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
Manages desired state of the resource.
+
+
+ vni + +
+ string +
+ 		+ +
Specify virtual network identifier. Valid values are Integer or keyword 'default'.
+
+
+ associated_interfaces + +
+ list + / elements=string +
+ 		+ +
This is a intent option and checks the operational state of the for given vrf name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vrf interfaces on device it will result in failure.
+
+
+ delay + +
+ integer +
+ 		+ Default:
10
+ 		+
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
+
+
+ description + +
+ string +
+ 		+ +
Description of the VRF or keyword 'default'.
+
+
+ interfaces + +
+ list + / elements=string +
+ 		+ +
List of interfaces to check the VRF has been configured correctly or keyword 'default'.
+
+
+ name + +
+ string +
+ 		+ +
Name of VRF to be managed.
+

aliases: vrf
+
+
+ purge + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Purge VRFs not defined in the aggregate parameter.
+
+
+ rd + +
+ string +
+ 		+ +
VPN Route Distinguisher (RD). Valid values are a string in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword 'auto', or the keyword 'default'.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manages desired state of the resource.
+
+
+ vni + +
+ string +
+ 		+ +
Specify virtual network identifier. Valid values are Integer or keyword 'default'.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Cisco NX-OS creates the default VRF by itself. Therefore, you're not allowed to use default as *vrf* name in this module. + - ``vrf`` name must be shorter than 32 chars. + - VRF names are not case sensible in NX-OS. Anyway, the name is stored just like it's inserted by the user and it'll not be changed again unless the VRF is removed and re-created. i.e. ``vrf=NTC`` will create a VRF named NTC, but running it again with ``vrf=ntc`` will not cause a configuration change. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Ensure ntc VRF exists on switch + cisco.nxos.nxos_vrf: + name: ntc + description: testing + state: present + - name: Aggregate definition of VRFs + cisco.nxos.nxos_vrf: + aggregate: + - name: test1 + description: Testing + admin_state: down + - name: test2 + interfaces: Ethernet1/2 + - name: Aggregate definitions of VRFs with Purge + cisco.nxos.nxos_vrf: + aggregate: + - name: ntc1 + description: purge test1 + - name: ntc2 + description: purge test2 + state: present + purge: true + - name: Delete VRFs exist on switch + cisco.nxos.nxos_vrf: + aggregate: + - name: ntc1 + - name: ntc2 + state: absent + - name: Assign interfaces to VRF declaratively + cisco.nxos.nxos_vrf: + name: test1 + interfaces: + - Ethernet2/3 + - Ethernet2/5 + - name: Check interfaces assigned to VRF + cisco.nxos.nxos_vrf: + name: test1 + associated_interfaces: + - Ethernet2/3 + - Ethernet2/5 + - name: >- + Ensure VRF is tagged with interface Ethernet2/5 only (Removes from + Ethernet2/3) + cisco.nxos.nxos_vrf: + name: test1 + interfaces: + - Ethernet2/5 + - name: Delete VRF + cisco.nxos.nxos_vrf: + name: ntc + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['vrf context ntc', 'no shutdown', 'interface Ethernet1/2', 'no switchport', 'vrf member test2']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_vrrp_module.rst b/docs/cisco.nxos.nxos_vrrp_module.rst new file mode 100644 index 000000000..88183c5af --- /dev/null +++ b/docs/cisco.nxos.nxos_vrrp_module.rst @@ -0,0 +1,277 @@ +.. _cisco.nxos.nxos_vrrp_module: + + +******************** +cisco.nxos.nxos_vrrp +******************** + +**Manages VRRP configuration on NX-OS switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages VRRP configuration on NX-OS switches. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ admin_state + +
+ string +
+ 		+
    Choices: +
  • shutdown ←
    • +
  • no shutdown
    • +
  • default
    • +
+ 		+
Used to enable or disable the VRRP process.
+
+
+ authentication + +
+ string +
+ 		+ +
Clear text authentication string or 'default' keyword
+
+
+ group + +
+ string + / required +
+ 		+ +
VRRP group number.
+
+
+ interface + +
+ string + / required +
+ 		+ +
Full name of interface that is being managed for VRRP.
+
+
+ interval + +
+ string +
+ 		+ +
Time interval between advertisement or 'default' keyword
+
+
+ preempt + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable preempt.
+
+
+ priority + +
+ string +
+ 		+ +
VRRP priority or 'default' keyword
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specify desired state of the resource.
+
+
+ vip + +
+ string +
+ 		+ +
VRRP virtual IP address or 'default' keyword
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - VRRP feature needs to be enabled first on the system. + - SVIs must exist before using this module. + - Interface must be a L3 port before using this module. + - ``state=absent`` removes the VRRP group if it exists on the device. + - VRRP cannot be configured on loopback interfaces. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Ensure vrrp group 100 and vip 10.1.100.1 is on vlan10 + cisco.nxos.nxos_vrrp: + interface: vlan10 + group: 100 + vip: 10.1.100.1 + + - name: Ensure removal of the vrrp group config + cisco.nxos.nxos_vrrp: + interface: vlan10 + group: 100 + vip: 10.1.100.1 + state: absent + + - name: Re-config with more params + cisco.nxos.nxos_vrrp: + interface: vlan10 + group: 100 + vip: 10.1.100.1 + preempt: false + priority: 130 + authentication: AUTHKEY + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['interface vlan10', 'vrrp 150', 'address 10.1.15.1', 'authentication text testing', 'no shutdown']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vsan_module.rst b/docs/cisco.nxos.nxos_vsan_module.rst new file mode 100644 index 000000000..9baa64c68 --- /dev/null +++ b/docs/cisco.nxos.nxos_vsan_module.rst @@ -0,0 +1,225 @@ +.. _cisco.nxos.nxos_vsan_module: + + +******************** +cisco.nxos.nxos_vsan +******************** + +**Configuration of vsan for Cisco NXOS MDS Switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Configuration of vsan for Cisco MDS NXOS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ vsan + +
+ list + / elements=dictionary +
+ 		+ +
List of vsan details to be added or removed
+
+
+ id + +
+ integer + / required +
+ 		+ +
Vsan id
+
+
+ interface + +
+ list + / elements=string +
+ 		+ +
List of vsan's interfaces to be added
+
+
+ name + +
+ string +
+ 		+ +
Name of the vsan
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Removes the vsan if True
+
+
+ suspend + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
suspend the vsan if True
+
+
+ + +Notes +----- + +.. note:: + - Tested against Cisco MDS NX-OS 8.4(1) + + + +Examples +-------- + +.. code-block:: yaml + + - name: Test that vsan module works + cisco.nxos.nxos_vsan: + vsan: + - id: 922 + interface: + - fc1/1 + - fc1/2 + - port-channel 1 + name: vsan-SAN-A + remove: false + suspend: false + - id: 923 + interface: + - fc1/11 + - fc1/21 + - port-channel 2 + name: vsan-SAN-B + remove: false + suspend: true + - id: 1923 + name: vsan-SAN-Old + remove: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['terminal dont-ask', 'vsan database', 'vsan 922 interface fc1/40', 'vsan 922 interface port-channel 155', 'no terminal dont-ask']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) diff --git a/docs/cisco.nxos.nxos_vxlan_vtep_module.rst b/docs/cisco.nxos.nxos_vxlan_vtep_module.rst new file mode 100644 index 000000000..57fdc14a3 --- /dev/null +++ b/docs/cisco.nxos.nxos_vxlan_vtep_module.rst @@ -0,0 +1,332 @@ +.. _cisco.nxos.nxos_vxlan_vtep_module: + + +************************** +cisco.nxos.nxos_vxlan_vtep +************************** + +**Manages VXLAN Network Virtualization Endpoint (NVE).** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages VXLAN Network Virtualization Endpoint (NVE) overlay interface that terminates VXLAN tunnels. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ advertise_virtual_rmac + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
The advertise_virtual_rmac parameter lets BGP to use the VMAC with VIP as next-hop when advertising type-2 routes. Should be used together with advertise_pip parameter from cisco.nxos.nxos_bgp_address_family module.
+
+
+ description + +
+ string +
+ 		+ +
Description of the NVE interface.
+
+
+ global_ingress_replication_bgp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configures ingress replication protocol as bgp for all VNIs. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
+
+
+ global_mcast_group_L2 + +
+ string +
+ 		+ +
Global multicast IP prefix for L2 VNIs or the keyword 'default'. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
+
+
+ global_mcast_group_L3 + +
+ string +
+ 		+ +
Global multicast IP prefix for L3 VNIs or the keyword 'default'. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
+
+
+ global_suppress_arp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables ARP suppression for all VNIs. This is available on NX-OS 9K series running 9.2.x or higher.
+
+
+ host_reachability + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specify mechanism for host reachability advertisement. A Boolean value of 'true' indicates that BGP will be used for host reachability advertisement. A Boolean value of 'false' indicates that no protocol is used for host reachability advertisement. Other host reachability advertisement protocols (e.g. OpenFlow, controller, etc.) are not supported.
+
+
+ interface + +
+ string + / required +
+ 		+ +
Interface name for the VXLAN Network Virtualization Endpoint.
+
+
+ multisite_border_gateway_interface + +
+ string +
+
added in 1.1.0
+ 		+ +
Specify the loopback interface whose IP address should be used for the NVE Multisite Border-gateway Interface. This is available on specific Nexus 9000 series switches running NX-OS 7.0(3)I7(x) or higher. Specify "default" to remove an existing gateway config.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown the NVE interface.
+
+
+ source_interface + +
+ string +
+ 		+ +
Specify the loopback interface whose IP address should be used for the NVE interface.
+
+
+ source_interface_hold_down_time + +
+ string +
+ 		+ +
Suppresses advertisement of the NVE loopback address until the overlay has converged.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Determines whether the config should be present or not on the device.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - The module is used to manage NVE properties, not to create NVE interfaces. Use :ref:`cisco.nxos.nxos_interfaces ` if you wish to do so. + - ``state=absent`` removes the interface. + - Default, where supported, restores params default value. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_vxlan_vtep: + interface: nve1 + description: default + host_reachability: true + source_interface: Loopback0 + source_interface_hold_down_time: 30 + shutdown: default + multisite_border_gateway_interface: Loopback0 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['interface nve1', 'source-interface loopback0', 'source-interface hold-down-time 30', 'description simple description', 'shutdown', 'host-reachability protocol bgp', 'multisite border-gateway interface loopback0']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_zone_zoneset_module.rst b/docs/cisco.nxos.nxos_zone_zoneset_module.rst new file mode 100644 index 000000000..95ef4972a --- /dev/null +++ b/docs/cisco.nxos.nxos_zone_zoneset_module.rst @@ -0,0 +1,537 @@ +.. _cisco.nxos.nxos_zone_zoneset_module: + + +**************************** +cisco.nxos.nxos_zone_zoneset +**************************** + +**Configuration of zone/zoneset for Cisco NXOS MDS Switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Configuration of zone/zoneset for Cisco MDS NXOS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ zone_zoneset_details + +
+ list + / elements=dictionary +
+ 		+ +
List of zone/zoneset details to be added or removed
+
+
+ default_zone + +
+ string +
+ 		+
    Choices: +
  • permit
    • +
  • deny
    • +
+ 		+
default zone behaviour for the vsan
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • enhanced
    • +
  • basic
    • +
+ 		+
mode of the zone for the vsan
+
+
+ smart_zoning + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Removes the vsan if True
+
+
+ vsan + +
+ integer + / required +
+ 		+ +
vsan id
+
+
+ zone + +
+ list + / elements=dictionary +
+ 		+ +
List of zone options for that vsan
+
+
+ members + +
+ list + / elements=dictionary +
+ 		+ +
Members of the zone that needs to be removed or added
+
+
+ devtype + +
+ string +
+ 		+
    Choices: +
  • initiator
    • +
  • target
    • +
  • both
    • +
+ 		+
devtype of the zone member used along with Smart zoning config
+
+
+ pwwn + +
+ string + / required +
+ 		+ +
pwwn member of the zone, use alias 'device_alias' as option for device_alias member
+

aliases: device_alias
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Removes member from the zone if True
+
+
+ name + +
+ string + / required +
+ 		+ +
name of the zone
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Deletes the zone if True
+
+
+ zoneset + +
+ list + / elements=dictionary +
+ 		+ +
List of zoneset options for the vsan
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • activate
    • +
  • deactivate
    • +
+ 		+
activates/de-activates the zoneset
+
+
+ members + +
+ list + / elements=dictionary +
+ 		+ +
Members of the zoneset that needs to be removed or added
+
+
+ name + +
+ string + / required +
+ 		+ +
name of the zone that needs to be added to the zoneset or removed from the zoneset
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Removes zone member from the zoneset
+
+
+ name + +
+ string + / required +
+ 		+ +
name of the zoneset
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Removes zoneset if True
+
+
+ + +Notes +----- + +.. note:: + - Tested against Cisco MDS NX-OS 8.4(1) + + + +Examples +-------- + +.. code-block:: yaml + + - name: Test that zone/zoneset module works + cisco.nxos.nxos_zone_zoneset: + zone_zoneset_details: + - mode: enhanced + vsan: 22 + zone: + - members: + - pwwn: 31314874576271 + - device_alias: test123 + - pwwn: '61:61:62:62:12:12:12:12' + remove: true + name: zoneA + - members: + - pwwn: 28515514576271 + - pwwn: '62:62:62:62:21:21:21:21' + name: zoneB + - name: zoneC + remove: true + zoneset: + - action: activate + members: + - name: zoneA + - name: zoneB + - name: zoneC + remove: true + name: zsetname1 + - action: deactivate + name: zsetTestExtra + remove: true + - mode: basic + smart_zoning: true + vsan: 21 + zone: + - members: + - devtype: both + pwwn: 31314874576271 + - pwwn: '62:62:62:62:12:12:12:12' + - devtype: both + pwwn: '92:62:62:62:12:12:1a:1a' + remove: true + name: zone21A + - members: + - pwwn: 28515514576271 + - pwwn: '62:62:62:62:21:21:21:21' + name: zone21B + zoneset: + - action: activate + members: + - name: zone21A + - name: zone21B + name: zsetname212 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['terminal dont-ask', 'zone name zoneA vsan 923', 'member pwwn 11:11:11:11:11:11:11:11', 'no member device-alias test123', 'zone commit vsan 923', 'no terminal dont-ask']
+
+
+ messages + +
+ list +
+ 		always +
debug messages
+
+
Sample:
+
['zone mode is already enhanced ,no change in zone mode configuration for vsan 922', "zone member '11:11:11:11:11:11:11:11' is already present in zone 'zoneA' in vsan 922 hence nothing to add", "zone member 'test123' is already present in zone 'zoneA' in vsan 922 hence nothing to add", "zone member '61:61:62:62:12:12:12:12' is not present in zone 'zoneA' in vsan 922 hence nothing to remove", "zone member '10:11:11:11:11:11:11:11' is already present in zone 'zoneB' in vsan 922 hence nothing to add", "zone member '62:62:62:62:21:21:21:21' is already present in zone 'zoneB' in vsan 922 hence nothing to add", "zone 'zoneC' is not present in vsan 922 , so nothing to remove"]
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) diff --git a/plugins/modules/nxos_spanning_tree_global.py b/plugins/modules/nxos_spanning_tree_global.py index f8297eca1..036aefd57 100644 --- a/plugins/modules/nxos_spanning_tree_global.py +++ b/plugins/modules/nxos_spanning_tree_global.py @@ -16,14 +16,13 @@ DOCUMENTATION = """ module: nxos_spanning_tree_global short_description: Resource module to configure spanning tree. -description: -- This module configures and manages the attributes of Spanning-tree on Cisco NXOS. +description: This module configures and manages the attributes of Spanning-tree on Cisco NXOS. version_added: 6.0.3 author: Vinay Mulugund (@roverflow) notes: -- Tested against NX-OS 9.3.6 on Cisco Nexus Switches. -- This module works with connection C(network_cli) and C(httpapi). -- Tested against Cisco MDS NX-OS 9.2(2) with connection C(network_cli). + - Tested against NX-OS 9.3.6 on Cisco Nexus Switches. + - This module works with connection C(network_cli) and C(httpapi). + - Tested against Cisco MDS NX-OS 9.2(2) with connection C(network_cli). options: config: description: A dict of Spanning-tree options. From 0076c427730eaaae84bbf74fe18d20491c79812c Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 7 Mar 2024 14:25:31 +0000 Subject: [PATCH 13/30] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- ...cisco.nxos.nxos_aaa_server_host_module.rst | 343 - docs/cisco.nxos.nxos_aaa_server_module.rst | 248 - .../cisco.nxos.nxos_acl_interfaces_module.rst | 610 -- docs/cisco.nxos.nxos_acls_module.rst | 4086 ------------ docs/cisco.nxos.nxos_banner_module.rst | 187 - docs/cisco.nxos.nxos_bfd_global_module.rst | 326 - .../cisco.nxos.nxos_bfd_interfaces_module.rst | 394 -- docs/cisco.nxos.nxos_bgp_global_module.rst | 5843 ----------------- ...xos_bgp_neighbor_address_family_module.rst | 3575 ---------- docs/cisco.nxos.nxos_bgp_templates_module.rst | 2841 -------- docs/cisco.nxos.nxos_command_module.rst | 258 - docs/cisco.nxos.nxos_config_module.rst | 566 -- docs/cisco.nxos.nxos_devicealias_module.rst | 273 - docs/cisco.nxos.nxos_evpn_global_module.rst | 122 - docs/cisco.nxos.nxos_evpn_vni_module.rst | 212 - docs/cisco.nxos.nxos_facts_module.rst | 553 -- docs/cisco.nxos.nxos_feature_module.rst | 150 - docs/cisco.nxos.nxos_gir_module.rst | 302 - ...xos.nxos_gir_profile_management_module.rst | 235 - docs/cisco.nxos.nxos_hostname_module.rst | 344 - ...cisco.nxos.nxos_hsrp_interfaces_module.rst | 344 - docs/cisco.nxos.nxos_hsrp_module.rst | 305 - docs/cisco.nxos.nxos_igmp_module.rst | 191 - docs/cisco.nxos.nxos_igmp_snooping_module.rst | 225 - docs/cisco.nxos.nxos_install_os_module.rst | 183 - docs/cisco.nxos.nxos_l2_interfaces_module.rst | 648 -- docs/cisco.nxos.nxos_l3_interfaces_module.rst | 884 --- docs/cisco.nxos.nxos_lacp_module.rst | 402 -- ...cisco.nxos.nxos_lldp_interfaces_module.rst | 407 -- docs/cisco.nxos.nxos_logging_module.rst | 458 -- docs/cisco.nxos.nxos_ntp_auth_module.rst | 224 - docs/cisco.nxos.nxos_ntp_global_module.rst | 1411 ---- docs/cisco.nxos.nxos_ntp_module.rst | 314 - docs/cisco.nxos.nxos_ntp_options_module.rst | 192 - docs/cisco.nxos.nxos_nxapi_module.rst | 300 - ...cisco.nxos.nxos_ospf_interfaces_module.rst | 1732 ----- docs/cisco.nxos.nxos_ospfv2_module.rst | 5458 --------------- .../cisco.nxos.nxos_overlay_global_module.rst | 120 - docs/cisco.nxos.nxos_pim_module.rst | 148 - docs/cisco.nxos.nxos_ping_module.rst | 311 - docs/cisco.nxos.nxos_prefix_lists_module.rst | 1049 --- docs/cisco.nxos.nxos_reboot_module.rst | 123 - docs/cisco.nxos.nxos_rollback_module.rst | 159 - docs/cisco.nxos.nxos_route_maps_module.rst | 4368 ------------ docs/cisco.nxos.nxos_rpm_module.rst | 226 - docs/cisco.nxos.nxos_snapshot_module.rst | 363 - .../cisco.nxos.nxos_snmp_community_module.rst | 201 - docs/cisco.nxos.nxos_snmp_host_module.rst | 288 - docs/cisco.nxos.nxos_snmp_location_module.rst | 156 - docs/cisco.nxos.nxos_snmp_server_module.rst | 4474 ------------- docs/cisco.nxos.nxos_snmp_traps_module.rst | 189 - docs/cisco.nxos.nxos_snmp_user_module.rst | 235 - .../cisco.nxos.nxos_udld_interface_module.rst | 250 - docs/cisco.nxos.nxos_udld_module.rst | 256 - docs/cisco.nxos.nxos_user_module.rst | 390 -- docs/cisco.nxos.nxos_vpc_module.rst | 352 - docs/cisco.nxos.nxos_vrf_af_module.rst | 300 - docs/cisco.nxos.nxos_vrf_module.rst | 494 -- docs/cisco.nxos.nxos_vrrp_module.rst | 277 - docs/cisco.nxos.nxos_vsan_module.rst | 225 - docs/cisco.nxos.nxos_vxlan_vtep_module.rst | 332 - docs/cisco.nxos.nxos_zone_zoneset_module.rst | 537 -- 62 files changed, 50969 deletions(-) delete mode 100644 docs/cisco.nxos.nxos_aaa_server_host_module.rst delete mode 100644 docs/cisco.nxos.nxos_aaa_server_module.rst delete mode 100644 docs/cisco.nxos.nxos_acl_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_acls_module.rst delete mode 100644 docs/cisco.nxos.nxos_banner_module.rst delete mode 100644 docs/cisco.nxos.nxos_bfd_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_bfd_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_bgp_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst delete mode 100644 docs/cisco.nxos.nxos_bgp_templates_module.rst delete mode 100644 docs/cisco.nxos.nxos_command_module.rst delete mode 100644 docs/cisco.nxos.nxos_config_module.rst delete mode 100644 docs/cisco.nxos.nxos_devicealias_module.rst delete mode 100644 docs/cisco.nxos.nxos_evpn_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_evpn_vni_module.rst delete mode 100644 docs/cisco.nxos.nxos_facts_module.rst delete mode 100644 docs/cisco.nxos.nxos_feature_module.rst delete mode 100644 docs/cisco.nxos.nxos_gir_module.rst delete mode 100644 docs/cisco.nxos.nxos_gir_profile_management_module.rst delete mode 100644 docs/cisco.nxos.nxos_hostname_module.rst delete mode 100644 docs/cisco.nxos.nxos_hsrp_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_hsrp_module.rst delete mode 100644 docs/cisco.nxos.nxos_igmp_module.rst delete mode 100644 docs/cisco.nxos.nxos_igmp_snooping_module.rst delete mode 100644 docs/cisco.nxos.nxos_install_os_module.rst delete mode 100644 docs/cisco.nxos.nxos_l2_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_l3_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_lacp_module.rst delete mode 100644 docs/cisco.nxos.nxos_lldp_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_logging_module.rst delete mode 100644 docs/cisco.nxos.nxos_ntp_auth_module.rst delete mode 100644 docs/cisco.nxos.nxos_ntp_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_ntp_module.rst delete mode 100644 docs/cisco.nxos.nxos_ntp_options_module.rst delete mode 100644 docs/cisco.nxos.nxos_nxapi_module.rst delete mode 100644 docs/cisco.nxos.nxos_ospf_interfaces_module.rst delete mode 100644 docs/cisco.nxos.nxos_ospfv2_module.rst delete mode 100644 docs/cisco.nxos.nxos_overlay_global_module.rst delete mode 100644 docs/cisco.nxos.nxos_pim_module.rst delete mode 100644 docs/cisco.nxos.nxos_ping_module.rst delete mode 100644 docs/cisco.nxos.nxos_prefix_lists_module.rst delete mode 100644 docs/cisco.nxos.nxos_reboot_module.rst delete mode 100644 docs/cisco.nxos.nxos_rollback_module.rst delete mode 100644 docs/cisco.nxos.nxos_route_maps_module.rst delete mode 100644 docs/cisco.nxos.nxos_rpm_module.rst delete mode 100644 docs/cisco.nxos.nxos_snapshot_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_community_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_host_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_location_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_server_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_traps_module.rst delete mode 100644 docs/cisco.nxos.nxos_snmp_user_module.rst delete mode 100644 docs/cisco.nxos.nxos_udld_interface_module.rst delete mode 100644 docs/cisco.nxos.nxos_udld_module.rst delete mode 100644 docs/cisco.nxos.nxos_user_module.rst delete mode 100644 docs/cisco.nxos.nxos_vpc_module.rst delete mode 100644 docs/cisco.nxos.nxos_vrf_af_module.rst delete mode 100644 docs/cisco.nxos.nxos_vrf_module.rst delete mode 100644 docs/cisco.nxos.nxos_vrrp_module.rst delete mode 100644 docs/cisco.nxos.nxos_vsan_module.rst delete mode 100644 docs/cisco.nxos.nxos_vxlan_vtep_module.rst delete mode 100644 docs/cisco.nxos.nxos_zone_zoneset_module.rst diff --git a/docs/cisco.nxos.nxos_aaa_server_host_module.rst b/docs/cisco.nxos.nxos_aaa_server_host_module.rst deleted file mode 100644 index 5730e6359..000000000 --- a/docs/cisco.nxos.nxos_aaa_server_host_module.rst +++ /dev/null @@ -1,343 +0,0 @@ -.. _cisco.nxos.nxos_aaa_server_host_module: - - -******************************* -cisco.nxos.nxos_aaa_server_host -******************************* - -**Manages AAA server host-specific configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages AAA server host-specific configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- acct_port - -
- string -
- 		- -
Alternate UDP port for RADIUS accounting or keyword 'default'.
-
-
- address - -
- string - / required -
- 		- -
Address or name of the radius or tacacs host.
-
-
- auth_port - -
- string -
- 		- -
Alternate UDP port for RADIUS authentication or keyword 'default'.
-
-
- encrypt_type - -
- string -
- 		-
    Choices: -
  • 0
    • -
  • 7
    • -
- 		-
The state of encryption applied to the entered key. O for clear text, 7 for encrypted. Type-6 encryption is not supported.
-
-
- host_timeout - -
- string -
- 		- -
Timeout period for specified host, in seconds or keyword 'default. Range is 1-60.
-
-
- key - -
- string -
- 		- -
Shared secret for the specified host or keyword 'default'.
-
-
- server_type - -
- string - / required -
- 		-
    Choices: -
  • radius
    • -
  • tacacs
    • -
- 		-
The server type is either radius or tacacs.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- tacacs_port - -
- string -
- 		- -
Alternate TCP port TACACS Server or keyword 'default'.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - Changes to the host key (shared secret) are not idempotent for type 0. - - If ``state=absent`` removes the whole host configuration. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Radius Server Host Basic settings - - name: Radius Server Host Basic settings - cisco.nxos.nxos_aaa_server_host: - state: present - server_type: radius - address: 1.2.3.4 - acct_port: 2084 - host_timeout: 10 - - # Radius Server Host Key Configuration - - name: Radius Server Host Key Configuration - cisco.nxos.nxos_aaa_server_host: - state: present - server_type: radius - address: 1.2.3.4 - key: hello - encrypt_type: 7 - - # TACACS Server Host Configuration - - name: Tacacs Server Host Configuration - cisco.nxos.nxos_aaa_server_host: - state: present - server_type: tacacs - tacacs_port: 89 - host_timeout: 10 - address: 5.6.7.8 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- end_state - -
- dictionary -
- 		always -
k/v pairs of configuration after module execution
-
-
Sample:
-
{'address': '1.2.3.4', 'auth_port': '2084', 'host_timeout': '10', 'server_type': 'radius'}
-
-
- existing - -
- dictionary -
- 		always -
k/v pairs of existing configuration
-
-
-
- proposed - -
- dictionary -
- 		always -
k/v pairs of parameters passed into module
-
-
Sample:
-
{'address': '1.2.3.4', 'auth_port': '2084', 'host_timeout': '10', 'server_type': 'radius'}
-
-
- updates - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['radius-server host 1.2.3.4 auth-port 2084 timeout 10']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_aaa_server_module.rst b/docs/cisco.nxos.nxos_aaa_server_module.rst deleted file mode 100644 index 1307c9033..000000000 --- a/docs/cisco.nxos.nxos_aaa_server_module.rst +++ /dev/null @@ -1,248 +0,0 @@ -.. _cisco.nxos.nxos_aaa_server_module: - - -************************** -cisco.nxos.nxos_aaa_server -************************** - -**Manages AAA server global configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages AAA server global configuration - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- deadtime - -
- string -
- 		- -
Duration for which a non-reachable AAA server is skipped, in minutes or keyword 'default. Range is 1-1440. Device default is 0.
-
-
- directed_request - -
- string -
- 		-
    Choices: -
  • enabled
    • -
  • disabled
    • -
  • default
    • -
- 		-
Enables direct authentication requests to AAA server or keyword 'default' Device default is disabled.
-
-
- encrypt_type - -
- string -
- 		-
    Choices: -
  • 0
    • -
  • 7
    • -
- 		-
The state of encryption applied to the entered global key. O clear text, 7 encrypted. Type-6 encryption is not supported.
-
-
- global_key - -
- string -
- 		- -
Global AAA shared secret or keyword 'default'.
-
-
- server_timeout - -
- string -
- 		- -
Global AAA server timeout period, in seconds or keyword 'default. Range is 1-60. Device default is 5.
-
-
- server_type - -
- string - / required -
- 		-
    Choices: -
  • radius
    • -
  • tacacs
    • -
- 		-
The server type is either radius or tacacs.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • default
    • -
- 		-
Manage the state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - The server_type parameter is always required. - - If encrypt_type is not supplied, the global AAA server key will be stored as encrypted (type 7). - - Changes to the global AAA server key with encrypt_type=0 are not idempotent. - - state=default will set the supplied parameters to their default values. The parameters that you want to default must also be set to default. If global_key=default, the global key will be removed. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Radius Server Basic settings - - name: Radius Server Basic settings - cisco.nxos.nxos_aaa_server: - server_type: radius - server_timeout: 9 - deadtime: 20 - directed_request: enabled - - # Tacacs Server Basic settings - - name: Tacacs Server Basic settings - cisco.nxos.nxos_aaa_server: - server_type: tacacs - server_timeout: 8 - deadtime: 19 - directed_request: disabled - - # Setting Global Key - - name: AAA Server Global Key - cisco.nxos.nxos_aaa_server: - server_type: radius - global_key: test_key - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['radius-server deadtime 22', 'radius-server timeout 11', 'radius-server directed-request']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_acl_interfaces_module.rst b/docs/cisco.nxos.nxos_acl_interfaces_module.rst deleted file mode 100644 index a2885df02..000000000 --- a/docs/cisco.nxos.nxos_acl_interfaces_module.rst +++ /dev/null @@ -1,610 +0,0 @@ -.. _cisco.nxos.nxos_acl_interfaces_module: - - -****************************** -cisco.nxos.nxos_acl_interfaces -****************************** - -**ACL interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Add and remove Access Control Lists on interfaces in NX-OS platform - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of interfaces to be configured with ACLs
-
-
- access_groups - -
- list - / elements=dictionary -
- 		- -
List of address family indicators with ACLs to be configured on the interface
-
-
- acls - -
- list - / elements=dictionary -
- 		- -
List of Access Control Lists for the interface
-
-
- direction - -
- string - / required -
- 		-
    Choices: -
  • in
    • -
  • out
    • -
- 		-
Direction to be applied for the ACL
-
-
- name - -
- string - / required -
- 		- -
Name of the ACL to be added/removed
-
-
- port - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use ACL as port policy.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
Address Family Indicator of the ACLs to be configured
-
-
- name - -
- string - / required -
- 		- -
Name of the interface
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • deleted
    • -
  • gathered
    • -
  • merged ←
    • -
  • overridden
    • -
  • rendered
    • -
  • replaced
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------ - # - - - name: Merge ACL interfaces configuration - cisco.nxos.nxos_acl_interfaces: - config: - - name: Ethernet1/2 - access_groups: - - afi: ipv6 - acls: - - name: ACL1v6 - direction: in - - - name: Eth1/5 - access_groups: - - afi: ipv4 - acls: - - name: PortACL - direction: in - port: true - - - name: ACL1v4 - direction: out - - - afi: ipv6 - acls: - - name: ACL1v6 - direction: in - state: merged - - # After state: - # ------------ - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ip port access-group PortACL in - # ip access-group ACL1v4 out - # ipv6 traffic-filter ACL1v6 in - - # Using replaced - - # Before state: - # ------------ - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ip port access-group PortACL in - # ip access-group ACL1v4 out - # ipv6 traffic-filter ACL1v6 in - - - name: Replace interface configuration with given configuration - cisco.nxos.nxos_acl_interfaces: - config: - - name: Eth1/5 - access_groups: - - afi: ipv4 - acls: - - name: NewACLv4 - direction: out - - - name: Ethernet1/3 - access_groups: - - afi: ipv6 - acls: - - name: NewACLv6 - direction: in - port: true - state: replaced - - # After state: - # ------------ - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/3 - # ipv6 port traffic-filter NewACLv6 in - # interface Ethernet1/5 - # ip access-group NewACLv4 out - - # Using overridden - - # Before state: - # ------------ - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ip port access-group PortACL in - # ip access-group ACL1v4 out - # ipv6 traffic-filter ACL1v6 in - - - name: Override interface configuration with given configuration - cisco.nxos.nxos_acl_interfaces: - config: - - name: Ethernet1/3 - access_groups: - - afi: ipv4 - acls: - - name: ACL1v4 - direction: out - - - name: PortACL - port: true - direction: in - - afi: ipv6 - acls: - - name: NewACLv6 - direction: in - port: true - state: overridden - - # After state: - # ------------ - # interface Ethernet1/3 - # ip access-group ACL1v4 out - # ip port access-group PortACL in - # ipv6 port traffic-filter NewACLv6 in - - # Using deleted to remove ACL config from specified interfaces - - # Before state: - # ------------- - # interface Ethernet1/1 - # ip access-group ACL2v4 in - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ip port access-group PortACL in - # ip access-group ACL1v4 out - # ipv6 traffic-filter ACL1v6 in - - - name: Delete ACL configuration on interfaces - cisco.nxos.nxos_acl_interfaces: - config: - - name: Ethernet1/5 - - name: Ethernet1/2 - state: deleted - - # After state: - # ------------- - # interface Ethernet1/1 - # ip access-group ACL2v4 in - # interface Ethernet1/2 - # interface Ethernet1/5 - - # Using deleted to remove ACL config from all interfaces - - # Before state: - # ------------- - # interface Ethernet1/1 - # ip access-group ACL2v4 in - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ip port access-group PortACL in - # ip access-group ACL1v4 out - # ipv6 traffic-filter ACL1v6 in - - - name: Delete ACL configuration from all interfaces - cisco.nxos.nxos_acl_interfaces: - state: deleted - - # After state: - # ------------- - # interface Ethernet1/1 - # interface Ethernet1/2 - # interface Ethernet1/5 - - # Using parsed - - - name: Parse given configuration into structured format - cisco.nxos.nxos_acl_interfaces: - running_config: | - interface Ethernet1/2 - ipv6 traffic-filter ACL1v6 in - interface Ethernet1/5 - ipv6 traffic-filter ACL1v6 in - ip access-group ACL1v4 out - ip port access-group PortACL in - state: parsed - - # returns - # parsed: - # - name: Ethernet1/2 - # access_groups: - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # direction: in - # - name: Ethernet1/5 - # access_groups: - # - afi: ipv4 - # acls: - # - name: PortACL - # direction: in - # port: True - # - name: ACL1v4 - # direction: out - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # direction: in - - - # Using gathered: - - # Before state: - # ------------ - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ipv6 traffic-filter ACL1v6 in - # ip access-group ACL1v4 out - # ip port access-group PortACL in - - - name: Gather existing configuration from device - cisco.nxos.nxos_acl_interfaces: - config: - state: gathered - - # returns - # gathered: - # - name: Ethernet1/2 - # access_groups: - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # direction: in - # - name: Ethernet1/5 - # access_groups: - # - afi: ipv4 - # acls: - # - name: PortACL - # direction: in - # port: True - # - name: ACL1v4 - # direction: out - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # direction: in - - - # Using rendered - - - name: Render required configuration to be pushed to the device - cisco.nxos.nxos_acl_interfaces: - config: - - name: Ethernet1/2 - access_groups: - - afi: ipv6 - acls: - - name: ACL1v6 - direction: in - - name: Ethernet1/5 - access_groups: - - afi: ipv4 - acls: - - name: PortACL - direction: in - port: true - - name: ACL1v4 - direction: out - - afi: ipv6 - acls: - - name: ACL1v6 - direction: in - state: rendered - - - # returns - # rendered: - # interface Ethernet1/2 - # ipv6 traffic-filter ACL1v6 in - # interface Ethernet1/5 - # ipv6 traffic-filter ACL1v6 in - # ip access-group ACL1v4 out - # ip port access-group PortACL in - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/2', 'ipv6 traffic-filter ACL1v6 out', 'ip port access-group PortACL in']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_acls_module.rst b/docs/cisco.nxos.nxos_acls_module.rst deleted file mode 100644 index 1b806511d..000000000 --- a/docs/cisco.nxos.nxos_acls_module.rst +++ /dev/null @@ -1,4086 +0,0 @@ -.. _cisco.nxos.nxos_acls_module: - - -******************** -cisco.nxos.nxos_acls -******************** - -**ACLs resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manage named IP ACLs on the Cisco NX-OS platform - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A dictionary of ACL options.
-
-
- acls - -
- list - / elements=dictionary -
- 		- -
A list of the ACLs.
-
-
- aces - -
- list - / elements=dictionary -
- 		- -
The entries within the ACL.
-
-
- destination - -
- dictionary -
- 		- -
Specify the packet destination.
-
-
- address - -
- string -
- 		- -
Destination network address.
-
-
- any - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Any destination address.
-
-
- host - -
- string -
- 		- -
Host IP address.
-
-
- port_protocol - -
- dictionary -
- 		- -
Specify the destination port or protocol (only for TCP and UDP).
-
-
- eq - -
- string -
- 		- -
Match only packets on a given port number.
-
-
- gt - -
- string -
- 		- -
Match only packets with a greater port number.
-
-
- lt - -
- string -
- 		- -
Match only packets with a lower port number.
-
-
- neq - -
- string -
- 		- -
Match only packets not on a given port number.
-
-
- range - -
- dictionary -
- 		- -
Match only packets in the range of port numbers.
-
-
- end - -
- string -
- 		- -
Specify the end of the port range.
-
-
- start - -
- string -
- 		- -
Specify the start of the port range.
-
-
- prefix - -
- string -
- 		- -
Destination network prefix. Only for prefixes of value less than 31 for ipv4 and 127 for ipv6. Prefixes of 32 (ipv4) and 128 (ipv6) should be given in the 'host' key.
-
-
- wildcard_bits - -
- string -
- 		- -
Destination wildcard bits.
-
-
- dscp - -
- string -
- 		- -
Match packets with given DSCP value.
-
-
- fragments - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Check non-initial fragments.
-
-
- grant - -
- string -
- 		-
    Choices: -
  • permit
    • -
  • deny
    • -
- 		-
Action to be applied on the rule.
-
-
- log - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Log matches against this entry.
-
-
- precedence - -
- string -
- 		- -
Match packets with given precedence value.
-
-
- protocol - -
- string -
- 		- -
Specify the protocol.
-
-
- protocol_options - -
- dictionary -
- 		- -
All possible suboptions for the protocol chosen.
-
-
- icmp - -
- dictionary -
- 		- -
ICMP protocol options.
-
-
- administratively_prohibited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively prohibited
-
-
- alternate_address - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Alternate address
-
-
- conversion_error - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Datagram conversion
-
-
- dod_host_prohibited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host prohibited
-
-
- dod_net_prohibited - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Net prohibited
-
-
- echo - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo (ping)
-
-
- echo_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo reply
-
-
- echo_request - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo request (ping)
-
-
- general_parameter_problem - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter problem
-
-
- host_isolated - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host isolated
-
-
- host_precedence_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host unreachable for precedence
-
-
- host_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host redirect
-
-
- host_tos_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host redirect for TOS
-
-
- host_tos_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host unreachable for TOS
-
-
- host_unknown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host unknown
-
-
- host_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host unreachable
-
-
- information_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Information replies
-
-
- information_request - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Information requests
-
-
- mask_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Mask replies
-
-
- mask_request - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Mask requests
-
-
- message_code - -
- integer -
- 		- -
ICMP message code
-
-
- message_type - -
- integer -
- 		- -
ICMP message type
-
-
- mobile_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Mobile host redirect
-
-
- net_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Network redirect
-
-
- net_tos_redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Net redirect for TOS
-
-
- net_tos_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Network unreachable for TOS
-
-
- net_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Net unreachable
-
-
- network_unknown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Network unknown
-
-
- no_room_for_option - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter required but no room
-
-
- option_missing - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter required but not present
-
-
- packet_too_big - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Fragmentation needed and DF set
-
-
- parameter_problem - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All parameter problems
-
-
- port_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Port unreachable
-
-
- precedence_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Precedence cutoff
-
-
- protocol_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Protocol unreachable
-
-
- reassembly_timeout - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Reassembly timeout
-
-
- redirect - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All redirects
-
-
- router_advertisement - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router discovery advertisements
-
-
- router_solicitation - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router discovery solicitations
-
-
- source_quench - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Source quenches
-
-
- source_route_failed - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Source route failed
-
-
- time_exceeded - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All time exceeded.
-
-
- timestamp_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Timestamp replies
-
-
- timestamp_request - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Timestamp requests
-
-
- traceroute - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Traceroute
-
-
- ttl_exceeded - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
TTL exceeded
-
-
- unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All unreachables
-
-
- icmpv6 - -
- dictionary -
- 		- -
ICMPv6 protocol options.
-
-
- beyond_scope - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Destination beyond scope.
-
-
- destination_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Destination address is unreachable.
-
-
- echo_reply - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo reply.
-
-
- echo_request - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Echo request (ping).
-
-
- fragments - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Check non-initial fragments.
-
-
- header - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter header problem.
-
-
- hop_limit - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Hop limit exceeded in transit.
-
-
- mld_query - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Multicast Listener Discovery Query.
-
-
- mld_reduction - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Multicast Listener Discovery Reduction.
-
-
- mld_report - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Multicast Listener Discovery Report.
-
-
- mldv2 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Multicast Listener Discovery Protocol.
-
-
- nd_na - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Neighbor discovery neighbor advertisements.
-
-
- nd_ns - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Neighbor discovery neighbor solicitations.
-
-
- next_header - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter next header problems.
-
-
- no_admin - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administration prohibited destination.
-
-
- no_route - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
No route to destination.
-
-
- packet_too_big - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Packet too big.
-
-
- parameter_option - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Parameter option problems.
-
-
- parameter_problem - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All parameter problems.
-
-
- port_unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Port unreachable.
-
-
- reassembly_timeout - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Reassembly timeout.
-
-
- renum_command - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router renumbering command.
-
-
- renum_result - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router renumbering result.
-
-
- renum_seq_number - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Router renumbering sequence number reset.
-
-
- router_advertisement - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Neighbor discovery router advertisements.
-
-
- router_renumbering - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All router renumbering.
-
-
- router_solicitation - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Neighbor discovery router solicitations.
-
-
- telemetry_path - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IPT enabled.
-
-
- telemetry_queue - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flow of interest for BDC/HDC.
-
-
- time_exceeded - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All time exceeded.
-
-
- unreachable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All unreachable.
-
-
- igmp - -
- dictionary -
- 		- -
IGMP protocol options.
-
-
- dvmrp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Distance Vector Multicast Routing Protocol
-
-
- host_query - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host Query
-
-
- host_report - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Host Report
-
-
- tcp - -
- dictionary -
- 		- -
TCP flags.
-
-
- ack - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the ACK bit
-
-
- established - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match established connections
-
-
- fin - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the FIN bit
-
-
- psh - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the PSH bit
-
-
- rst - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the RST bit
-
-
- syn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the SYN bit
-
-
- urg - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Match on the URG bit
-
-
- remark - -
- string -
- 		- -
Access list entry comment.
-
-
- sequence - -
- integer -
- 		- -
Sequence number.
-
-
- source - -
- dictionary -
- 		- -
Specify the packet source.
-
-
- address - -
- string -
- 		- -
Source network address.
-
-
- any - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Any source address.
-
-
- host - -
- string -
- 		- -
Host IP address.
-
-
- port_protocol - -
- dictionary -
- 		- -
Specify the destination port or protocol (only for TCP and UDP).
-
-
- eq - -
- string -
- 		- -
Match only packets on a given port number.
-
-
- gt - -
- string -
- 		- -
Match only packets with a greater port number.
-
-
- lt - -
- string -
- 		- -
Match only packets with a lower port number.
-
-
- neq - -
- string -
- 		- -
Match only packets not on a given port number.
-
-
- range - -
- dictionary -
- 		- -
Match only packets in the range of port numbers.
-
-
- end - -
- string -
- 		- -
Specify the end of the port range.
-
-
- start - -
- string -
- 		- -
Specify the start of the port range.
-
-
- prefix - -
- string -
- 		- -
Source network prefix. Only for prefixes of mask value less than 31 for ipv4 and 127 for ipv6. Prefixes of mask 32 (ipv4) and 128 (ipv6) should be given in the 'host' key.
-
-
- wildcard_bits - -
- string -
- 		- -
Source wildcard bits.
-
-
- name - -
- string - / required -
- 		- -
Name of the ACL.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
The Address Family Indicator (AFI) for the ACL.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section 'ip(v6* access-list).
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • deleted
    • -
  • gathered
    • -
  • merged ←
    • -
  • overridden
    • -
  • rendered
    • -
  • replaced
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - As NX-OS allows configuring a rule again with different sequence numbers, the user is expected to provide sequence numbers for the access control entries to preserve idempotency. If no sequence number is given, the rule will be added as a new rule by the device. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - - - name: Merge provided ACLs configuration with device configuration - cisco.nxos.nxos_acls: - state: merged - config: - - afi: ipv4 - acls: - - name: ACL1v4 - aces: - - grant: deny - destination: - address: 192.0.2.64 - wildcard_bits: 0.0.0.255 - source: - any: true - port_protocol: - lt: 55 - protocol: tcp - protocol_options: - tcp: - ack: true - fin: true - sequence: 50 - - - afi: ipv6 - acls: - - name: ACL1v6 - aces: - - grant: permit - sequence: 10 - source: - any: true - destination: - prefix: 2001:db8:12::/32 - protocol: sctp - - # Task Output - # ----------- - # before: [] - # - # commands: - # - ip access-list ACL1v4 - # - 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin - # - ipv6 access-list ACL1v6 - # - 10 permit sctp any 2001:db8:12::/32 - # - # after: - # - acls: - # - aces: - # - destination: - # prefix: 2001:db8:12::/32 - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # name: ACL1v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # address: 192.0.2.64 - # wildcard_bits: 0.0.0.255 - # grant: deny - # protocol: tcp - # protocol_options: - # tcp: - # ack: true - # fin: true - # sequence: 50 - # source: - # any: true - # port_protocol: - # lt: '55' - # name: ACL1v4 - # afi: ipv4 - - - # After state: - # ------------ - # - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - - # Using replaced - - # Before state: - # ---------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 10 permit ip any any - # 20 deny udp any any - # ip access-list ACL2v4 - # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ipv6 access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - - name: Replace existing ACL configuration with provided configuration - cisco.nxos.nxos_acls: - config: - - afi: ipv4 - - afi: ipv6 - acls: - - name: ACL1v6 - aces: - - sequence: 20 - grant: permit - source: - any: true - destination: - any: true - protocol: pim - - - remark: Replaced ACE - - name: ACL2v6 - state: replaced - - # Task Output - # ----------- - # before: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ip - # sequence: 10 - # source: - # any: true - # - destination: - # any: true - # grant: deny - # protocol: udp - # sequence: 20 - # source: - # any: true - # name: ACL1v4 - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ahp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.0.255 - # name: ACL2v4 - # afi: ipv4 - # - # commands: - # - no ip access-list ACL1v4 - # - no ip access-list ACL2v4 - # - ipv6 access-list ACL1v6 - # - no 10 permit sctp any any - # - no 20 remark IPv6 ACL - # - remark Replaced ACE - # - 20 permit pim any any - # - ipv6 access-list ACL2v6 - # - no 10 deny ipv6 any 2001:db8:3000::/36 - # - no 20 permit tcp host 2001:db8:2000:2::2 host 2001:db8:2000:ab::2 - # - # after: - # - acls: - # - aces: - # - remark: Replaced ACE - # sequence: 10 - # - destination: - # any: true - # grant: permit - # protocol: pim - # sequence: 20 - # source: - # any: true - # name: ACL1v6 - # - name: ACL2v6 - # afi: ipv6 - - # After state: - # --------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ipv6 access-list ACL1v6 - # 10 remark Replaced ACE - # 20 permit pim any any - # ipv6 access-list ACL2v6 - - # Using overridden - - # Before state: - # ---------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 10 permit ip any any - # 20 deny udp any any - # ip access-list ACL2v4 - # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ipv6 access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - - name: Override existing configuration with provided configuration - cisco.nxos.nxos_acls: - config: - - afi: ipv4 - acls: - - name: NewACL - aces: - - grant: deny - source: - address: 192.0.2.0 - wildcard_bits: 0.0.255.255 - destination: - any: true - protocol: eigrp - - remark: Example for overridden state - state: overridden - - # Task Output - # ----------- - # - # before: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ip - # sequence: 10 - # source: - # any: true - # - destination: - # any: true - # grant: deny - # protocol: udp - # sequence: 20 - # source: - # any: true - # name: ACL1v4 - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ahp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.0.255 - # name: ACL2v4 - # afi: ipv4 - # - # commands: - # - no ipv6 access-list ACL1v6 - # - no ipv6 access-list ACL2v6 - # - no ip access-list ACL1v4 - # - no ip access-list ACL2v4 - # - ip access-list NewACL - # - deny eigrp 192.0.2.0 0.0.255.255 any - # - remark Example for overridden state - # - # after: - # - acls: - # - aces: - # - destination: - # any: true - # grant: deny - # protocol: eigrp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.255.255 - # - remark: Example for overridden state - # sequence: 20 - # name: NewACL - # afi: ipv4 - - # After state: - # ------------ - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list NewACL - # 10 deny eigrp 192.0.2.0 0.0.255.255 any - # 20 remark Example for overridden state - - # Using deleted - delete all - # - # Before state: - # ------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 10 permit ip any any - # 20 deny udp any any - # ip access-list ACL2v4 - # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ip access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ip access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - - name: Delete all ACLs - cisco.nxos.nxos_acls: - state: deleted - - # Task Output - # ----------- - # - # before: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ip - # sequence: 10 - # source: - # any: true - # - destination: - # any: true - # grant: deny - # protocol: udp - # sequence: 20 - # source: - # any: true - # name: ACL1v4 - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ahp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.0.255 - # name: ACL2v4 - # afi: ipv4 - # - # commands: - # - no ip access-list ACL1v4 - # - no ip access-list ACL2v4 - # - no ipv6 access-list ACL1v6 - # - no ipv6 access-list ACL2v6 - # - # after: [] - - - # After state: - # ----------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # - - # Using deleted - delete AFI - - # Before state: - # ------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 10 permit ip any any - # 20 deny udp any any - # ip access-list ACL2v4 - # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ip access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ip access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - - name: Delete all ACLs in given AFI - cisco.nxos.nxos_acls: - config: - - afi: ipv4 - state: deleted - - # Task Output - # ----------- - # - # before: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ip - # sequence: 10 - # source: - # any: true - # - destination: - # any: true - # grant: deny - # protocol: udp - # sequence: 20 - # source: - # any: true - # name: ACL1v4 - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ahp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.0.255 - # name: ACL2v4 - # afi: ipv4 - # - # commands: - # - no ip access-list ACL1v4 - # - no ip access-list ACL2v4 - # - # after: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - - # After state: - # ------------ - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ip access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - # Using deleted - delete ACLs - - # Before state: - # ------------- - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 10 permit ip any any - # 20 deny udp any any - # ip access-list ACL2v4 - # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - # 20 remark IPv6 ACL - # ipv6 access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - - name: Delete specific ACLs - cisco.nxos.nxos_acls: - state: deleted - config: - - afi: ipv4 - acls: - - name: ACL1v4 - - name: ACL2v4 - - afi: ipv6 - acls: - - name: ACL1v6 - - # Task Output - # ----------- - # - # before: - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: sctp - # sequence: 10 - # source: - # any: true - # - remark: IPv6 ACL - # sequence: 20 - # name: ACL1v6 - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - # - acls: - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ip - # sequence: 10 - # source: - # any: true - # - destination: - # any: true - # grant: deny - # protocol: udp - # sequence: 20 - # source: - # any: true - # name: ACL1v4 - # - aces: - # - destination: - # any: true - # grant: permit - # protocol: ahp - # sequence: 10 - # source: - # address: 192.0.2.0 - # wildcard_bits: 0.0.0.255 - # name: ACL2v4 - # afi: ipv4 - # - # commands: - # - no ip access-list ACL1v4 - # - no ip access-list ACL2v4 - # - no ipv6 access-list ACL1v6 - # - # after: - # - acls: - # - aces: - # - destination: - # prefix: 2001:db8:3000::/36 - # grant: deny - # protocol: ipv6 - # sequence: 10 - # source: - # any: true - # - destination: - # host: 2001:db8:2000:ab::2 - # grant: permit - # protocol: tcp - # sequence: 20 - # source: - # host: 2001:db8:2000:2::2 - # name: ACL2v6 - # afi: ipv6 - - # After state: - # ------------ - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ipv6 access-list ACL2v6 - # 10 deny ipv6 any 2001:db8:3000::/36 - # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - - # Using parsed - - - name: Parse given config to structured data - cisco.nxos.nxos_acls: - running_config: | - ip access-list ACL1v4 - 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin - ipv6 access-list ACL1v6 - 10 permit sctp any any - state: parsed - - # Task Output - # ------------ - # - # parsed: - # - afi: ipv4 - # acls: - # - name: ACL1v4 - # aces: - # - grant: deny - # destination: - # address: 192.0.2.64 - # wildcard_bits: 0.0.0.255 - # source: - # any: true - # port_protocol: - # lt: 55 - # protocol: tcp - # protocol_options: - # tcp: - # ack: true - # fin: true - # sequence: 50 - # - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # aces: - # - grant: permit - # sequence: 10 - # source: - # any: true - # destination: - # prefix: 2001:db8:12::/32 - # protocol: sctp - - - # Using gathered: - - # Before state: - # ------------ - # nxos-9k# show running-config | section '^ip(v6)* access-list' - # ip access-list ACL1v4 - # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - - - name: Gather existing configuration - cisco.nxos.nxos_acls: - state: gathered - - # Task Output - # ----------- - # - # gathered: - # - afi: ipv4 - # acls: - # - name: ACL1v4 - # aces: - # - grant: deny - # destination: - # address: 192.0.2.64 - # wildcard_bits: 0.0.0.255 - # source: - # any: true - # port_protocol: - # lt: 55 - # protocol: tcp - # protocol_options: - # tcp: - # ack: true - # fin: true - # sequence: 50 - - # - afi: ipv6 - # acls: - # - name: ACL1v6 - # aces: - # - grant: permit - # sequence: 10 - # source: - # any: true - # destination: - # prefix: 2001:db8:12::/32 - # protocol: sctp - - - # Using rendered - - - name: Render required configuration to be pushed to the device - cisco.nxos.nxos_acls: - config: - - afi: ipv4 - acls: - - name: ACL1v4 - aces: - - grant: deny - destination: - address: 192.0.2.64 - wildcard_bits: 0.0.0.255 - source: - any: true - port_protocol: - lt: 55 - protocol: tcp - protocol_options: - tcp: - ack: true - fin: true - sequence: 50 - - afi: ipv6 - acls: - - name: ACL1v6 - aces: - - grant: permit - sequence: 10 - source: - any: true - destination: - prefix: '2001:db8:12::/32' - protocol: sctp - state: rendered - - - # Task Output - # ----------- - # - # rendered: - # ip access-list ACL1v4 - # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin - # ipv6 access-list ACL1v6 - # 10 permit sctp any any - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['ip access-list ACL1v4', '10 permit ip any any precedence critical log', '20 deny tcp any lt smtp host 192.0.2.64 ack fin']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['ip access-list ACL1v4', '10 permit ip any any precedence critical log', '20 deny tcp any lt smtp host 192.0.2.64 ack fin']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_banner_module.rst b/docs/cisco.nxos.nxos_banner_module.rst deleted file mode 100644 index 7502173b7..000000000 --- a/docs/cisco.nxos.nxos_banner_module.rst +++ /dev/null @@ -1,187 +0,0 @@ -.. _cisco.nxos.nxos_banner_module: - - -********************** -cisco.nxos.nxos_banner -********************** - -**Manage multiline banners on Cisco NXOS devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This will configure both exec and motd banners on remote devices running Cisco NXOS. It allows playbooks to add or remove banner text from the active running configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- banner - -
- string - / required -
- 		-
    Choices: -
  • exec
    • -
  • motd
    • -
- 		-
Specifies which banner that should be configured on the remote device.
-
-
- multiline_delimiter - -
- string -
- 		- Default:
"@"
- 		-
Specify the delimiting character than will be used for configuration.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Specifies whether or not the configuration is present in the current devices active running configuration.
-
-
- text - -
- string -
- 		- -
The banner text that should be present in the remote device running configuration. This argument accepts a multiline string, with no empty lines. Requires state=present.
-
-
- - -Notes ------ - -.. note:: - - Since responses from the device are always read with surrounding whitespaces stripped, tasks that configure banners with preceeding or trailing whitespaces will not be idempotent. - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: configure the exec banner - cisco.nxos.nxos_banner: - banner: exec - text: | - this is my exec banner - that contains a multiline - string - state: present - - name: remove the motd banner - cisco.nxos.nxos_banner: - banner: motd - state: absent - - name: Configure banner from file - cisco.nxos.nxos_banner: - banner: motd - text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}" - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['banner exec', 'this is my exec banner', 'that contains a multiline', 'string']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_bfd_global_module.rst b/docs/cisco.nxos.nxos_bfd_global_module.rst deleted file mode 100644 index 8cd86ec48..000000000 --- a/docs/cisco.nxos.nxos_bfd_global_module.rst +++ /dev/null @@ -1,326 +0,0 @@ -.. _cisco.nxos.nxos_bfd_global_module: - - -************************** -cisco.nxos.nxos_bfd_global -************************** - -**Bidirectional Forwarding Detection (BFD) global-level configuration** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages Bidirectional Forwarding Detection (BFD) global-level configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- echo_interface - -
- string -
- 		- -
Loopback interface used for echo frames.
-
Valid values are loopback interface name or 'deleted'.
-
Not supported on N5K/N6K
-
-
- echo_rx_interval - -
- integer -
- 		- -
BFD Echo receive interval in milliseconds.
-
-
- fabricpath_interval - -
- dictionary -
- 		- -
BFD fabricpath interval timer values.
-
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
-
-
- fabricpath_slow_timer - -
- integer -
- 		- -
BFD fabricpath slow rate timer in milliseconds.
-
-
- fabricpath_vlan - -
- integer -
- 		- -
BFD fabricpath control vlan.
-
-
- interval - -
- dictionary -
- 		- -
BFD interval timer values.
-
Value must be a dict defining values for keys (tx, min_rx, and multiplier)
-
-
- ipv4_echo_rx_interval - -
- integer -
- 		- -
BFD IPv4 session echo receive interval in milliseconds.
-
-
- ipv4_interval - -
- dictionary -
- 		- -
BFD IPv4 interval timer values.
-
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
-
-
- ipv4_slow_timer - -
- integer -
- 		- -
BFD IPv4 slow rate timer in milliseconds.
-
-
- ipv6_echo_rx_interval - -
- integer -
- 		- -
BFD IPv6 session echo receive interval in milliseconds.
-
-
- ipv6_interval - -
- dictionary -
- 		- -
BFD IPv6 interval timer values.
-
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
-
-
- ipv6_slow_timer - -
- integer -
- 		- -
BFD IPv6 slow rate timer in milliseconds.
-
-
- slow_timer - -
- integer -
- 		- -
BFD slow rate timer in milliseconds.
-
-
- startup_timer - -
- integer -
- 		- -
BFD delayed startup timer in seconds.
-
Not supported on N5K/N6K/N7K
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 9.2(2) - - Unsupported for Cisco MDS - - BFD global will automatically enable 'feature bfd' if it is disabled. - - BFD global does not have a 'state' parameter. All of the BFD commands are unique and are defined if 'feature bfd' is enabled. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_bfd_global: - echo_interface: Ethernet1/2 - echo_rx_interval: 50 - interval: - tx: 50 - min_rx: 50 - multiplier: 4 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- cmds - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['bfd echo-interface loopback1', 'bfd slow-timer 2000']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_bfd_interfaces_module.rst b/docs/cisco.nxos.nxos_bfd_interfaces_module.rst deleted file mode 100644 index 975de891c..000000000 --- a/docs/cisco.nxos.nxos_bfd_interfaces_module.rst +++ /dev/null @@ -1,394 +0,0 @@ -.. _cisco.nxos.nxos_bfd_interfaces_module: - - -****************************** -cisco.nxos.nxos_bfd_interfaces -****************************** - -**BFD interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages attributes of Bidirectional Forwarding Detection (BFD) on the interface. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
The provided configuration
-
-
- bfd - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Enable/Disable Bidirectional Forwarding Detection (BFD) on the interface.
-
-
- echo - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Enable/Disable BFD Echo functionality on the interface.
-
-
- name - -
- string -
- 		- -
The name of the interface.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface|^feature bfd'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state of the configuration after module completion
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 7.0(3)I5(1). - - Unsupported for Cisco MDS - - Feature bfd should be enabled for this module. - - - -Examples --------- - -.. code-block:: yaml - - # Using deleted - - - name: Configure interfaces - cisco.nxos.nxos_bfd_interfaces: - state: deleted - - - # Using merged - - - name: Configure interfaces - cisco.nxos.nxos_bfd_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - echo: enable - - name: Ethernet1/2 - bfd: disable - echo: disable - state: merged - - - # Using overridden - - - name: Configure interfaces - cisco.nxos.nxos_bfd_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - echo: enable - - name: Ethernet1/2 - bfd: disable - echo: disable - state: overridden - - - # Using replaced - - - name: Configure interfaces - cisco.nxos.nxos_bfd_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - echo: enable - - name: Ethernet1/2 - bfd: disable - echo: disable - state: replaced - - # Using rendered - - - name: Use rendered state to convert task input to device specific commands - cisco.nxos.nxos_bfd_interfaces: - config: - - name: Ethernet1/800 - bfd: enable - echo: enable - - name: Ethernet1/801 - bfd: disable - echo: disable - state: rendered - - # Task Output (redacted) - # ----------------------- - - # rendered: - # - "interface Ethernet1/800" - # - "bfd" - # - "bfd echo" - # - "interface Ethernet1/801" - # - "no bfd" - # - "no bfd echo" - - # Using parsed - - # parsed.cfg - # ------------ - - # feature bfd - # interface Ethernet1/800 - # no switchport - # no bfd - # no bfd echo - # interface Ethernet1/801 - # no switchport - # no bfd - # interface Ethernet1/802 - # no switchport - # no bfd echo - # interface mgmt0 - # ip address dhcp - # vrf member management - - - name: Use parsed state to convert externally supplied config to structured format - cisco.nxos.nxos_bfd_interfaces: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - - # parsed: - # - bfd: disable - # echo: disable - # name: Ethernet1/800 - # - bfd: disable - # echo: enable - # name: Ethernet1/801 - # - bfd: enable - # echo: disable - # name: Ethernet1/802 - # - bfd: enable - # echo: enable - # name: mgmt0 - - # Using gathered - - # Existing device config state - # ------------------------------- - - # feature bfd - # interface Ethernet1/1 - # no switchport - # no bfd - # interface Ethernet1/2 - # no switchport - # no bfd echo - # interface mgmt0 - # ip address dhcp - # vrf member management - - - name: Gather bfd_interfaces facts from the device using nxos_bfd_interfaces - cisco.nxos.nxos_bfd_interfaces: - state: gathered - - # Task output (redacted) - # ----------------------- - # gathered: - # - name: Ethernet1/1 - # bfd: disable - # echo: enable - # - name: Ethernet1/3 - # echo: disable - # bfd: enable - # - name: mgmt0 - # bfd: enable - # echo: enable - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/1', 'no bfd', 'no bfd echo']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_bgp_global_module.rst b/docs/cisco.nxos.nxos_bgp_global_module.rst deleted file mode 100644 index 19ee2709e..000000000 --- a/docs/cisco.nxos.nxos_bgp_global_module.rst +++ /dev/null @@ -1,5843 +0,0 @@ -.. _cisco.nxos.nxos_bgp_global_module: - - -************************** -cisco.nxos.nxos_bgp_global -************************** - -**BGP Global resource module.** - - -Version added: 1.4.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages global BGP configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A list of BGP process configuration.
-
-
- affinity_group - -
- dictionary -
- 		- -
Configure an affinity group.
-
-
- group_id - -
- integer -
- 		- -
Affinity Group ID.
-
-
- as_number - -
- string -
- 		- -
Autonomous System Number of the router.
-
-
- bestpath - -
- dictionary -
- 		- -
Define the default bestpath selection algorithm.
-
-
- always_compare_med - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare MED on paths from different AS.
-
-
- as_path - -
- dictionary -
- 		- -
AS-Path.
-
-
- ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore AS-Path during bestpath selection.
-
-
- multipath_relax - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Relax AS-Path restriction when choosing multipaths.
-
-
- compare_neighborid - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
When more paths are available than max path config, use neighborid as tie-breaker.
-
-
- compare_routerid - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare router-id for identical EBGP paths.
-
-
- cost_community_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore cost communities in bestpath selection.
-
-
- igp_metric_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore IGP metric for next-hop during bestpath selection.
-
-
- med - -
- dictionary -
- 		- -
MED
-
-
- confed - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare MED only from paths originated from within a confederation.
-
-
- missing_as_worst - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Treat missing MED as highest MED.
-
-
- non_deterministic - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Not always pick the best-MED path among paths from same AS.
-
-
- cluster_id - -
- string -
- 		- -
Configure Route Reflector Cluster-ID.
-
-
- confederation - -
- dictionary -
- 		- -
AS confederation parameters.
-
-
- identifier - -
- string -
- 		- -
Set routing domain confederation AS.
-
-
- peers - -
- list - / elements=string -
- 		- -
Peer ASs in BGP confederation.
-
-
- disable_policy_batching - -
- dictionary -
- 		- -
Disable batching evaluation of outbound policy for a peer.
-
-
- ipv4 - -
- dictionary -
- 		- -
IPv4 address-family settings.
-
-
- prefix_list - -
- string -
- 		- -
Name of prefix-list to apply.
-
-
- ipv6 - -
- dictionary -
- 		- -
IPv6 address-family settings.
-
-
- prefix_list - -
- string -
- 		- -
Name of prefix-list to apply.
-
-
- nexthop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Batching based on nexthop.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set policy batching.
-
-
- dynamic_med_interval - -
- integer -
- 		- -
Sets the interval for dampening of med changes.
-
-
- enforce_first_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enforce neighbor AS is the first AS in AS-PATH attribute (EBGP).
-
-
- enhanced_error - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable BGP Enhanced error handling.
-
-
- fabric_soo - -
- string -
- 		- -
Fabric site of origin.
-
-
- fast_external_fallover - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Immediately reset the session if the link to a directly connected BGP peer goes down.
-
-
- flush_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flush routes in RIB upon controlled restart.
-
-
- graceful_restart - -
- dictionary -
- 		- -
Configure Graceful Restart functionality.
-
-
- helper - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure Graceful Restart Helper mode functionality.
-
-
- restart_time - -
- integer -
- 		- -
Maximum time for restart advertised to peers.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable graceful-restart.
-
-
- stalepath_time - -
- integer -
- 		- -
Maximum time to keep a restarting peer's stale routes.
-
-
- graceful_shutdown - -
- dictionary -
- 		- -
Graceful-shutdown for BGP protocol.
-
-
- activate - -
- dictionary -
- 		- -
Send graceful-shutdown community on all routes.
-
-
- route_map - -
- string -
- 		- -
Apply route-map to modify attributes for outbound.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Activiate graceful-shutdown.
-
-
- aware - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Lower preference of routes carrying graceful-shutdown community.
-
-
- isolate - -
- dictionary -
- 		- -
Isolate this router from BGP perspective.
-
-
- include_local - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Withdraw both local and remote BGP routes.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Withdraw remote BGP routes to isolate this router.
-
-
- log_neighbor_changes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Log a message for neighbor up/down event.
-
-
- maxas_limit - -
- integer -
- 		- -
Allow AS-PATH attribute from EBGP neighbor imposing a limit on number of ASes.
-
-
- neighbor_down - -
- dictionary -
- 		- -
Handle BGP neighbor down event, due to various reasons.
-
-
- fib_accelerate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor.
-
-
- neighbors - -
- list - / elements=dictionary -
- 		- -
Configure BGP neighbors.
-
-
- bfd - -
- dictionary -
- 		- -
Bidirectional Fast Detection for the neighbor.
-
-
- multihop - -
- dictionary -
- 		- -
Multihop session.
-
-
- interval - -
- dictionary -
- 		- -
Configure BFD session interval parameters.
-
-
- min_rx_interval - -
- integer -
- 		- -
Minimum RX interval.
-
-
- multiplier - -
- integer -
- 		- -
Detect Multiplier.
-
-
- tx_interval - -
- integer -
- 		- -
TX interval in milliseconds.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD multihop.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD for this neighbor.
-
-
- singlehop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Single-hop session.
-
-
- bmp_activate_server - -
- integer -
- 		- -
Specify server ID for activating BMP monitoring for the peer.
-
-
- capability - -
- dictionary -
- 		- -
Capability.
-
-
- suppress_4_byte_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress 4-byte AS Capability.
-
-
- description - -
- string -
- 		- -
Neighbor specific descripion.
-
-
- disable_connected_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable check for directly connected peer.
-
-
- dont_capability_negotiate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't negotiate capability with this neighbor.
-
-
- dscp - -
- string -
- 		- -
Set dscp value for tcp transport.
-
-
- dynamic_capability - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Dynamic Capability
-
-
- ebgp_multihop - -
- integer -
- 		- -
Specify multihop TTL for remote peer.
-
-
- graceful_shutdown - -
- dictionary -
- 		- -
Graceful-shutdown for this neighbor.
-
-
- activate - -
- dictionary -
- 		- -
Send graceful-shutdown community.
-
-
- route_map - -
- string -
- 		- -
Apply route-map to modify attributes for outbound.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set activate.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a template.
-
-
- peer - -
- string -
- 		- -
Peer template to inherit.
-
-
- peer_session - -
- string -
- 		- -
Peer-session template to inherit.
-
-
- local_as - -
- string -
- 		- -
Specify the local-as number for the eBGP neighbor.
-
-
- log_neighbor_changes - -
- dictionary -
- 		- -
Log message for neighbor up/down event.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable logging of neighbor up/down event.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set log-neighbor-changes.
-
-
- low_memory - -
- dictionary -
- 		- -
Behaviour in low memory situations.
-
-
- exempt - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not shutdown this peer when under memory pressure.
-
-
- neighbor_address - -
- string - / required -
- 		- -
IP address/Prefix of the neighbor or interface.
-
-
- neighbor_affinity_group - -
- dictionary -
- 		- -
Configure an affinity group.
-
-
- group_id - -
- integer -
- 		- -
Affinity Group ID.
-
-
- password - -
- dictionary -
- 		- -
Configure a password for neighbor.
-
-
- encryption - -
- integer -
- 		- -
0 specifies an UNENCRYPTED neighbor password.
-
3 specifies an 3DES ENCRYPTED neighbor password will follow.
-
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
-
-
- key - -
- string -
- 		- -
Authentication password.
-
-
- path_attribute - -
- list - / elements=dictionary -
- 		- -
BGP path attribute optional filtering.
-
-
- action - -
- string -
- 		-
    Choices: -
  • discard
    • -
  • treat-as-withdraw
    • -
- 		-
Action.
-
-
- range - -
- dictionary -
- 		- -
Path attribute range.
-
-
- end - -
- integer -
- 		- -
Path attribute range end value.
-
-
- start - -
- integer -
- 		- -
Path attribute range start value.
-
-
- type - -
- integer -
- 		- -
Path attribute type
-
-
- peer_type - -
- string -
- 		-
    Choices: -
  • fabric-border-leaf
    • -
  • fabric-external
    • -
- 		-
Neighbor facing
-
-
- remote_as - -
- string -
- 		- -
Specify Autonomous System Number of the neighbor.
-
-
- remote_as_route_map - -
- string -
- 		- -
Route-map to match prefix peer AS number.
-
-
- remove_private_as - -
- dictionary -
- 		- -
Remove private AS number from outbound updates.
-
-
- all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All.
-
-
- replace_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Replace.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove private AS.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively shutdown this neighbor.
-
-
- timers - -
- dictionary -
- 		- -
Configure keepalive and hold timers.
-
-
- holdtime - -
- integer -
- 		- -
Holdtime (seconds).
-
-
- keepalive - -
- integer -
- 		- -
Keepalive interval (seconds).
-
-
- transport - -
- dictionary -
- 		- -
BGP transport connection.
-
-
- connection_mode - -
- dictionary -
- 		- -
Specify type of connection.
-
-
- passive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow passive connection setup only.
-
-
- ttl_security - -
- dictionary -
- 		- -
Enable TTL Security Mechanism.
-
-
- hops - -
- integer -
- 		- -
Specify hop count for remote peer.
-
-
- update_source - -
- string -
- 		- -
Specify source of BGP session and updates.
-
-
- nexthop - -
- dictionary -
- 		- -
Nexthop resolution options.
-
-
- suppress_default_resolution - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Prohibit use of default route for nexthop address resolution.
-
-
- rd - -
- dictionary -
- 		- -
Secondary Route Distinguisher for vxlan multisite border gateway.
-
-
- dual - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Generate Secondary RD for all VRFs and L2VNIs.
-
-
- id - -
- integer -
- 		- -
Specify 2 byte value for ID.
-
-
- reconnect_interval - -
- integer -
- 		- -
Configure connection reconnect interval.
-
-
- router_id - -
- string -
- 		- -
Specify the IP address to use as router-id.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively shutdown BGP protocol.
-
-
- suppress_fib_pending - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise only routes that are programmed in hardware to peers.
-
-
- timers - -
- dictionary -
- 		- -
Configure bgp related timers.
-
-
- bestpath_limit - -
- dictionary -
- 		- -
Configure timeout for first bestpath after restart.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure update-delay-always option.
-
-
- timeout - -
- integer -
- 		- -
Bestpath timeout (seconds).
-
-
- bgp - -
- dictionary -
- 		- -
Configure different bgp keepalive and holdtimes.
-
-
- holdtime - -
- integer -
- 		- -
Holdtime (seconds).
-
-
- keepalive - -
- integer -
- 		- -
Keepalive interval (seconds).
-
-
- prefix_peer_timeout - -
- integer -
- 		- -
Prefix Peer timeout (seconds).
-
-
- prefix_peer_wait - -
- integer -
- 		- -
Configure wait timer for a prefix peer.
-
-
- vrfs - -
- list - / elements=dictionary -
- 		- -
Virtual Router Context configurations.
-
-
- allocate_index - -
- integer -
- 		- -
Configure allocate-index.
-
-
- bestpath - -
- dictionary -
- 		- -
Define the default bestpath selection algorithm.
-
-
- always_compare_med - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare MED on paths from different AS.
-
-
- as_path - -
- dictionary -
- 		- -
AS-Path.
-
-
- ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore AS-Path during bestpath selection.
-
-
- multipath_relax - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Relax AS-Path restriction when choosing multipaths.
-
-
- compare_neighborid - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
When more paths are available than max path config, use neighborid as tie-breaker.
-
-
- compare_routerid - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare router-id for identical EBGP paths.
-
-
- cost_community_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore cost communities in bestpath selection.
-
-
- igp_metric_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ignore IGP metric for next-hop during bestpath selection.
-
-
- med - -
- dictionary -
- 		- -
MED
-
-
- confed - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compare MED only from paths originated from within a confederation.
-
-
- missing_as_worst - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Treat missing MED as highest MED.
-
-
- non_deterministic - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Not always pick the best-MED path among paths from same AS.
-
-
- cluster_id - -
- string -
- 		- -
Configure Route Reflector Cluster-ID.
-
-
- confederation - -
- dictionary -
- 		- -
AS confederation parameters.
-
-
- identifier - -
- string -
- 		- -
Set routing domain confederation AS.
-
-
- peers - -
- list - / elements=string -
- 		- -
Peer ASs in BGP confederation.
-
-
- graceful_restart - -
- dictionary -
- 		- -
Configure Graceful Restart functionality.
-
-
- helper - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure Graceful Restart Helper mode functionality.
-
-
- restart_time - -
- integer -
- 		- -
Maximum time for restart advertised to peers.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable graceful-restart.
-
-
- stalepath_time - -
- integer -
- 		- -
Maximum time to keep a restarting peer's stale routes.
-
-
- local_as - -
- string -
- 		- -
Specify the local-as for this vrf.
-
-
- log_neighbor_changes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Log a message for neighbor up/down event.
-
-
- maxas_limit - -
- integer -
- 		- -
Allow AS-PATH attribute from EBGP neighbor imposing a limit on number of ASes.
-
-
- neighbor_down - -
- dictionary -
- 		- -
Handle BGP neighbor down event, due to various reasons.
-
-
- fib_accelerate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor.
-
-
- neighbors - -
- list - / elements=dictionary -
- 		- -
Configure BGP neighbors.
-
-
- bfd - -
- dictionary -
- 		- -
Bidirectional Fast Detection for the neighbor.
-
-
- multihop - -
- dictionary -
- 		- -
Multihop session.
-
-
- interval - -
- dictionary -
- 		- -
Configure BFD session interval parameters.
-
-
- min_rx_interval - -
- integer -
- 		- -
Minimum RX interval.
-
-
- multiplier - -
- integer -
- 		- -
Detect Multiplier.
-
-
- tx_interval - -
- integer -
- 		- -
TX interval in milliseconds.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD multihop.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD for this neighbor.
-
-
- singlehop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Single-hop session.
-
-
- bmp_activate_server - -
- integer -
- 		- -
Specify server ID for activating BMP monitoring for the peer.
-
-
- capability - -
- dictionary -
- 		- -
Capability.
-
-
- suppress_4_byte_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress 4-byte AS Capability.
-
-
- description - -
- string -
- 		- -
Neighbor specific descripion.
-
-
- disable_connected_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable check for directly connected peer.
-
-
- dont_capability_negotiate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't negotiate capability with this neighbor.
-
-
- dscp - -
- string -
- 		- -
Set dscp value for tcp transport.
-
-
- dynamic_capability - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Dynamic Capability
-
-
- ebgp_multihop - -
- integer -
- 		- -
Specify multihop TTL for remote peer.
-
-
- graceful_shutdown - -
- dictionary -
- 		- -
Graceful-shutdown for this neighbor.
-
-
- activate - -
- dictionary -
- 		- -
Send graceful-shutdown community.
-
-
- route_map - -
- string -
- 		- -
Apply route-map to modify attributes for outbound.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set activate.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a template.
-
-
- peer - -
- string -
- 		- -
Peer template to inherit.
-
-
- peer_session - -
- string -
- 		- -
Peer-session template to inherit.
-
-
- local_as - -
- string -
- 		- -
Specify the local-as number for the eBGP neighbor.
-
-
- log_neighbor_changes - -
- dictionary -
- 		- -
Log message for neighbor up/down event.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable logging of neighbor up/down event.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set log-neighbor-changes.
-
-
- low_memory - -
- dictionary -
- 		- -
Behaviour in low memory situations.
-
-
- exempt - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not shutdown this peer when under memory pressure.
-
-
- neighbor_address - -
- string - / required -
- 		- -
IP address/Prefix of the neighbor or interface.
-
-
- neighbor_affinity_group - -
- dictionary -
- 		- -
Configure an affinity group.
-
-
- group_id - -
- integer -
- 		- -
Affinity Group ID.
-
-
- password - -
- dictionary -
- 		- -
Configure a password for neighbor.
-
-
- encryption - -
- integer -
- 		- -
0 specifies an UNENCRYPTED neighbor password.
-
3 specifies an 3DES ENCRYPTED neighbor password will follow.
-
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
-
-
- key - -
- string -
- 		- -
Authentication password.
-
-
- path_attribute - -
- list - / elements=dictionary -
- 		- -
BGP path attribute optional filtering.
-
-
- action - -
- string -
- 		-
    Choices: -
  • discard
    • -
  • treat-as-withdraw
    • -
- 		-
Action.
-
-
- range - -
- dictionary -
- 		- -
Path attribute range.
-
-
- end - -
- integer -
- 		- -
Path attribute range end value.
-
-
- start - -
- integer -
- 		- -
Path attribute range start value.
-
-
- type - -
- integer -
- 		- -
Path attribute type
-
-
- peer_type - -
- string -
- 		-
    Choices: -
  • fabric-border-leaf
    • -
  • fabric-external
    • -
- 		-
Neighbor facing
-
-
- remote_as - -
- string -
- 		- -
Specify Autonomous System Number of the neighbor.
-
-
- remote_as_route_map - -
- string -
- 		- -
Route-map to match prefix peer AS number.
-
-
- remove_private_as - -
- dictionary -
- 		- -
Remove private AS number from outbound updates.
-
-
- all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All.
-
-
- replace_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Replace.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove private AS.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively shutdown this neighbor.
-
-
- timers - -
- dictionary -
- 		- -
Configure keepalive and hold timers.
-
-
- holdtime - -
- integer -
- 		- -
Holdtime (seconds).
-
-
- keepalive - -
- integer -
- 		- -
Keepalive interval (seconds).
-
-
- transport - -
- dictionary -
- 		- -
BGP transport connection.
-
-
- connection_mode - -
- dictionary -
- 		- -
Specify type of connection.
-
-
- passive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow passive connection setup only.
-
-
- ttl_security - -
- dictionary -
- 		- -
Enable TTL Security Mechanism.
-
-
- hops - -
- integer -
- 		- -
Specify hop count for remote peer.
-
-
- update_source - -
- string -
- 		- -
Specify source of BGP session and updates.
-
-
- reconnect_interval - -
- integer -
- 		- -
Configure connection reconnect interval.
-
-
- router_id - -
- string -
- 		- -
Specify the IP address to use as router-id.
-
-
- timers - -
- dictionary -
- 		- -
Configure bgp related timers.
-
-
- bestpath_limit - -
- dictionary -
- 		- -
Configure timeout for first bestpath after restart.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure update-delay-always option.
-
-
- timeout - -
- integer -
- 		- -
Bestpath timeout (seconds).
-
-
- bgp - -
- dictionary -
- 		- -
Configure different bgp keepalive and holdtimes.
-
-
- holdtime - -
- integer -
- 		- -
Holdtime (seconds).
-
-
- keepalive - -
- integer -
- 		- -
Keepalive interval (seconds).
-
-
- prefix_peer_timeout - -
- integer -
- 		- -
Prefix Peer timeout (seconds).
-
-
- prefix_peer_wait - -
- integer -
- 		- -
Configure wait timer for a prefix peer.
-
-
- vrf - -
- string -
- 		- -
VRF name.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^router bgp'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • purged
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
State purged removes all the BGP configurations from the target device. Use caution with this state.
-
State deleted only removes BGP attributes that this modules manages and does not negate the BGP process completely. Thereby, preserving address-family related configurations under BGP context.
-
Running states deleted and replaced will result in an error if there are address-family configuration lines present under a neighbor, or a vrf context that is to be removed. Please use the cisco.nxos.nxos_bgp_af or cisco.nxos.nxos_bgp_neighbor_af modules for prior cleanup.
-
States merged and replaced will result in a failure if BGP is already configured with a different ASN than what is provided in the task. In such cases, please use state purged to remove the existing BGP process and proceed further.
-
States replaced and overridden have the same behaviour for this module.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - Unsupported for Cisco MDS - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # Nexus9000v# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_bgp_global: - config: - as_number: 65563 - router_id: 192.168.1.1 - bestpath: - as_path: - multipath_relax: true - compare_neighborid: true - cost_community_ignore: true - confederation: - identifier: 42 - peers: - - 65020 - - 65030 - - 65040 - log_neighbor_changes: true - maxas_limit: 20 - neighbors: - - neighbor_address: 192.168.1.100 - neighbor_affinity_group: - group_id: 160 - bmp_activate_server: 1 - remote_as: 65563 - description: NBR-1 - low_memory: - exempt: true - - neighbor_address: 192.168.1.101 - remote_as: 65563 - password: - encryption: 7 - key: 12090404011C03162E - neighbor_down: - fib_accelerate: true - vrfs: - - vrf: site-1 - allocate_index: 5000 - local_as: 200 - log_neighbor_changes: true - neighbors: - - neighbor_address: 198.51.100.1 - description: site-1-nbr-1 - password: - encryption: 3 - key: 13D4D3549493D2877B1DC116EE27A6BE - remote_as: 65562 - - neighbor_address: 198.51.100.2 - remote_as: 65562 - description: site-1-nbr-2 - - vrf: site-2 - local_as: 300 - log_neighbor_changes: true - neighbors: - - neighbor_address: 203.0.113.2 - description: site-2-nbr-1 - password: - encryption: 3 - key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - remote_as: 65568 - neighbor_down: - fib_accelerate: true - - # Task output: - # ------------ - # before: {} - # - # commands: - # - router bgp 65563 - # - bestpath as-path multipath-relax - # - bestpath compare-neighborid - # - bestpath cost-community ignore - # - confederation identifier 42 - # - log-neighbor-changes - # - maxas-limit 20 - # - neighbor-down fib-accelerate - # - router-id 192.168.1.1 - # - confederation peers 65020 65030 65040 - # - neighbor 192.168.1.100 - # - remote-as 65563 - # - affinity-group 160 - # - bmp-activate-server 1 - # - description NBR-1 - # - low-memory exempt - # - neighbor 192.168.1.101 - # - remote-as 65563 - # - password 7 12090404011C03162E - # - vrf site-1 - # - allocate-index 5000 - # - local-as 200 - # - log-neighbor-changes - # - neighbor 198.51.100.1 - # - remote-as 65562 - # - description site-1-nbr-1 - # - password 3 13D4D3549493D2877B1DC116EE27A6BE - # - neighbor 198.51.100.2 - # - remote-as 65562 - # - description site-1-nbr-2 - # - vrf site-2 - # - local-as 300 - # - log-neighbor-changes - # - neighbor-down fib-accelerate - # - neighbor 203.0.113.2 - # - remote-as 65568 - # - description site-2-nbr-1 - # - password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - # - # after: - # as_number: '65563' - # bestpath: - # as_path: - # multipath_relax: true - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65040' - # log_neighbor_changes: true - # maxas_limit: 20 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # - neighbor_address: 192.168.1.101 - # password: - # encryption: 7 - # key: 12090404011C03162E - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - allocate_index: 5000 - # local_as: '200' - # log_neighbor_changes: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 198.51.100.1 - # password: - # encryption: 3 - # key: 13D4D3549493D2877B1DC116EE27A6BE - # remote_as: '65562' - # - description: site-1-nbr-2 - # neighbor_address: 198.51.100.2 - # remote_as: '65562' - # vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - description: site-2-nbr-1 - # neighbor_address: 203.0.113.2 - # password: - # encryption: 3 - # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - # remote_as: '65568' - # vrf: site-2 - - - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65040 - # bestpath as-path multipath-relax - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 20 - # log-neighbor-changes - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # neighbor 192.168.1.101 - # remote-as 65563 - # password 7 12090404011C03162E - # vrf site-1 - # local-as 200 - # log-neighbor-changes - # allocate-index 5000 - # neighbor 198.51.100.1 - # remote-as 65562 - # description site-1-nbr-1 - # password 3 13D4D3549493D2877B1DC116EE27A6BE - # neighbor 198.51.100.2 - # remote-as 65562 - # description site-1-nbr-2 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # remote-as 65568 - # description site-2-nbr-1 - # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - # Using replaced - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65040 - # bestpath as-path multipath-relax - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 20 - # log-neighbor-changes - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # neighbor 192.168.1.101 - # remote-as 65563 - # password 7 12090404011C03162E - # vrf site-1 - # local-as 200 - # log-neighbor-changes - # allocate-index 5000 - # neighbor 198.51.100.1 - # remote-as 65562 - # description site-1-nbr-1 - # password 3 13D4D3549493D2877B1DC116EE27A6BE - # neighbor 198.51.100.2 - # remote-as 65562 - # description site-1-nbr-2 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # remote-as 65568 - # description site-2-nbr-1 - # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - - name: Replace BGP configuration with provided configuration - cisco.nxos.nxos_bgp_global: - config: - as_number: 65563 - router_id: 192.168.1.1 - bestpath: - compare_neighborid: true - cost_community_ignore: true - confederation: - identifier: 42 - peers: - - 65020 - - 65030 - - 65050 - maxas_limit: 40 - neighbors: - - neighbor_address: 192.168.1.100 - neighbor_affinity_group: - group_id: 160 - bmp_activate_server: 1 - remote_as: 65563 - description: NBR-1 - low_memory: - exempt: true - neighbor_down: - fib_accelerate: true - vrfs: - - vrf: site-2 - local_as: 300 - log_neighbor_changes: true - neighbors: - - neighbor_address: 203.0.113.2 - password: - encryption: 7 - key: 12090404011C03162E - neighbor_down: - fib_accelerate: true - state: replaced - - # Task output: - # ------------ - # before: - # as_number: '65563' - # bestpath: - # as_path: - # multipath_relax: true - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65040' - # log_neighbor_changes: true - # maxas_limit: 20 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # - neighbor_address: 192.168.1.101 - # password: - # encryption: 7 - # key: 12090404011C03162E - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - allocate_index: 5000 - # local_as: '200' - # log_neighbor_changes: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 198.51.100.1 - # password: - # encryption: 3 - # key: 13D4D3549493D2877B1DC116EE27A6BE - # remote_as: '65562' - # - description: site-1-nbr-2 - # neighbor_address: 198.51.100.2 - # remote_as: '65562' - # vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - description: site-2-nbr-1 - # neighbor_address: 203.0.113.2 - # password: - # encryption: 3 - # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - # remote_as: '65568' - # vrf: site-2 - # - # commands: - # - router bgp 65563 - # - no bestpath as-path multipath-relax - # - no log-neighbor-changes - # - maxas-limit 40 - # - no confederation peers 65020 65030 65040 - # - confederation peers 65020 65030 65050 - # - no neighbor 192.168.1.101 - # - vrf site-2 - # - neighbor 203.0.113.2 - # - no remote-as 65568 - # - no description site-2-nbr-1 - # - password 7 12090404011C03162E - # - no vrf site-1 - - # after: - # as_number: '65563' - # bestpath: - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65050' - # maxas_limit: 40 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - neighbor_address: 203.0.113.2 - # password: - # encryption: 7 - # key: 12090404011C03162E - # vrf: site-2 - # - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65050 - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 40 - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # password 7 12090404011C03162E - - # Using deleted - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65040 - # bestpath as-path multipath-relax - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 20 - # log-neighbor-changes - # address-family ipv4 unicast - # default-metric 400 - # suppress-inactive - # default-information originate - # address-family ipv6 multicast - # wait-igp-convergence - # redistribute eigrp eigrp-1 route-map site-1-rmap - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # neighbor 192.168.1.101 - # remote-as 65563 - # password 7 12090404011C03162E - # vrf site-1 - # local-as 200 - # log-neighbor-changes - # allocate-index 5000 - # address-family ipv4 multicast - # maximum-paths 40 - # dampen-igp-metric 1200 - # neighbor 198.51.100.1 - # remote-as 65562 - # description site-1-nbr-1 - # password 3 13D4D3549493D2877B1DC116EE27A6BE - # neighbor 198.51.100.2 - # remote-as 65562 - # description site-1-nbr-2 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # remote-as 65568 - # description site-1-nbr-1 - # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - - name: Delete BGP configurations handled by this module - cisco.nxos.nxos_bgp_global: - state: deleted - - # Task output: - # ------------ - - # before: - # as_number: '65563' - # bestpath: - # as_path: - # multipath_relax: true - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65040' - # log_neighbor_changes: true - # maxas_limit: 20 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # - neighbor_address: 192.168.1.101 - # password: - # encryption: 7 - # key: 12090404011C03162E - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - allocate_index: 5000 - # local_as: '200' - # log_neighbor_changes: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 198.51.100.1 - # password: - # encryption: 3 - # key: 13D4D3549493D2877B1DC116EE27A6BE - # remote_as: '65562' - # - description: site-1-nbr-2 - # neighbor_address: 198.51.100.2 - # remote_as: '65562' - # vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 203.0.113.2 - # password: - # encryption: 3 - # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - # remote_as: '65568' - # vrf: site-2 - # - # commands: - # - router bgp 65563 - # - no bestpath as-path multipath-relax - # - no bestpath compare-neighborid - # - no bestpath cost-community ignore - # - no confederation identifier 42 - # - no log-neighbor-changes - # - no maxas-limit 20 - # - no neighbor-down fib-accelerate - # - no router-id 192.168.1.1 - # - no confederation peers 65020 65030 65040 - # - no neighbor 192.168.1.100 - # - no neighbor 192.168.1.101 - # - no vrf site-1 - # - no vrf site-2 - # - # after: - # as_number: '65563' - # - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # address-family ipv4 unicast - # default-metric 400 - # suppress-inactive - # default-information originate - # address-family ipv6 multicast - # wait-igp-convergence - # redistribute eigrp eigrp-1 route-map site-1-rmap - # - - # Using purged - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65040 - # bestpath as-path multipath-relax - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 20 - # log-neighbor-changes - # address-family ipv4 unicast - # default-metric 400 - # suppress-inactive - # default-information originate - # address-family ipv6 multicast - # wait-igp-convergence - # redistribute eigrp eigrp-1 route-map site-1-rmap - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # neighbor 192.168.1.101 - # remote-as 65563 - # password 7 12090404011C03162E - # vrf site-1 - # local-as 200 - # log-neighbor-changes - # allocate-index 5000 - # address-family ipv4 multicast - # maximum-paths 40 - # dampen-igp-metric 1200 - # neighbor 198.51.100.1 - # remote-as 65562 - # description site-1-nbr-1 - # password 3 13D4D3549493D2877B1DC116EE27A6BE - # neighbor 198.51.100.2 - # remote-as 65562 - # description site-1-nbr-2 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # remote-as 65568 - # description site-1-nbr-1 - # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - - name: Purge all BGP configurations from the device - cisco.nxos.nxos_bgp_global: - state: purged - - # Task output: - # ------------ - - # before: - # as_number: '65563' - # bestpath: - # as_path: - # multipath_relax: true - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65040' - # log_neighbor_changes: true - # maxas_limit: 20 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # - neighbor_address: 192.168.1.101 - # password: - # encryption: 7 - # key: 12090404011C03162E - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - allocate_index: 5000 - # local_as: '200' - # log_neighbor_changes: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 198.51.100.1 - # password: - # encryption: 3 - # key: 13D4D3549493D2877B1DC116EE27A6BE - # remote_as: '65562' - # - description: site-1-nbr-2 - # neighbor_address: 198.51.100.2 - # remote_as: '65562' - # vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 203.0.113.2 - # password: - # encryption: 3 - # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - # remote_as: '65568' - # vrf: site-2 - # - # commands: - # - no router bgp 65563 - # - # after: {} - # - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # Nexus9000v# - - # Using rendered - - - name: Render platform specific configuration lines (without connecting to the device) - cisco.nxos.nxos_bgp_global: - config: - as_number: 65563 - router_id: 192.168.1.1 - bestpath: - as_path: - multipath_relax: true - compare_neighborid: true - cost_community_ignore: true - confederation: - identifier: 42 - peers: - - 65020 - - 65030 - - 65040 - log_neighbor_changes: true - maxas_limit: 20 - neighbors: - - neighbor_address: 192.168.1.100 - neighbor_affinity_group: - group_id: 160 - bmp_activate_server: 1 - remote_as: 65563 - description: NBR-1 - low_memory: - exempt: true - - neighbor_address: 192.168.1.101 - remote_as: 65563 - password: - encryption: 7 - key: 12090404011C03162E - neighbor_down: - fib_accelerate: true - vrfs: - - vrf: site-1 - allocate_index: 5000 - local_as: 200 - log_neighbor_changes: true - neighbors: - - neighbor_address: 198.51.100.1 - description: site-1-nbr-1 - password: - encryption: 3 - key: 13D4D3549493D2877B1DC116EE27A6BE - remote_as: 65562 - - neighbor_address: 198.51.100.2 - remote_as: 65562 - description: site-1-nbr-2 - - vrf: site-2 - local_as: 300 - log_neighbor_changes: true - neighbors: - - neighbor_address: 203.0.113.2 - description: site-1-nbr-1 - password: - encryption: 3 - key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - remote_as: 65568 - neighbor_down: - fib_accelerate: true - - # Task output: - # ------------ - # rendered: - # - router bgp 65563 - # - bestpath as-path multipath-relax - # - bestpath compare-neighborid - # - bestpath cost-community ignore - # - confederation identifier 42 - # - log-neighbor-changes - # - maxas-limit 20 - # - neighbor-down fib-accelerate - # - router-id 192.168.1.1 - # - confederation peers 65020 65030 65040 - # - neighbor 192.168.1.100 - # - remote-as 65563 - # - affinity-group 160 - # - bmp-activate-server 1 - # - description NBR-1 - # - low-memory exempt - # - neighbor 192.168.1.101 - # - remote-as 65563 - # - password 7 12090404011C03162E - # - vrf site-1 - # - allocate-index 5000 - # - local-as 200 - # - log-neighbor-changes - # - neighbor 198.51.100.1 - # - remote-as 65562 - # - description site-1-nbr-1 - # - password 3 13D4D3549493D2877B1DC116EE27A6BE - # - neighbor 198.51.100.2 - # - remote-as 65562 - # - description site-1-nbr-2 - # - vrf site-2 - # - local-as 300 - # - log-neighbor-changes - # - neighbor-down fib-accelerate - # - neighbor 203.0.113.2 - # - remote-as 65568 - # - description site-1-nbr-1 - # - password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - # Using parsed - - # parsed.cfg - # ------------ - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65040 - # bestpath as-path multipath-relax - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 20 - # log-neighbor-changes - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # neighbor 192.168.1.101 - # remote-as 65563 - # password 7 12090404011C03162E - # vrf site-1 - # local-as 200 - # log-neighbor-changes - # allocate-index 5000 - # neighbor 198.51.100.1 - # remote-as 65562 - # description site-1-nbr-1 - # password 3 13D4D3549493D2877B1DC116EE27A6BE - # neighbor 198.51.100.2 - # remote-as 65562 - # description site-1-nbr-2 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # remote-as 65568 - # description site-1-nbr-1 - # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 - - - name: Parse externally provided BGP config - cisco.nxos.nxos_bgp_global: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output: - # ------------ - # parsed: - # as_number: '65563' - # bestpath: - # as_path: - # multipath_relax: true - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65040' - # log_neighbor_changes: true - # maxas_limit: 20 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # - neighbor_address: 192.168.1.101 - # password: - # encryption: 7 - # key: 12090404011C03162E - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - allocate_index: 5000 - # local_as: '200' - # log_neighbor_changes: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 198.51.100.1 - # password: - # encryption: 3 - # key: 13D4D3549493D2877B1DC116EE27A6BE - # remote_as: '65562' - # - description: site-1-nbr-2 - # neighbor_address: 198.51.100.2 - # remote_as: '65562' - # vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - description: site-1-nbr-1 - # neighbor_address: 203.0.113.2 - # password: - # encryption: 3 - # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 - # remote_as: '65568' - # vrf: site-2 - - # Using gathered - - # existing config - # - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65563 - # router-id 192.168.1.1 - # confederation identifier 42 - # confederation peers 65020 65030 65050 - # bestpath cost-community ignore - # bestpath compare-neighborid - # neighbor-down fib-accelerate - # maxas-limit 40 - # neighbor 192.168.1.100 - # low-memory exempt - # bmp-activate-server 1 - # remote-as 65563 - # description NBR-1 - # affinity-group 160 - # vrf site-1 - # vrf site-2 - # local-as 300 - # neighbor-down fib-accelerate - # log-neighbor-changes - # neighbor 203.0.113.2 - # password 7 12090404011C03162E - - - name: Gather BGP facts using gathered - cisco.nxos.nxos_bgp_global: - state: gathered - - # Task output: - # ------------ - # gathered: - # as_number: '65563' - # bestpath: - # compare_neighborid: true - # cost_community_ignore: true - # confederation: - # identifier: '42' - # peers: - # - '65020' - # - '65030' - # - '65050' - # maxas_limit: 40 - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - bmp_activate_server: 1 - # description: NBR-1 - # low_memory: - # exempt: true - # neighbor_address: 192.168.1.100 - # neighbor_affinity_group: - # group_id: 160 - # remote_as: '65563' - # router_id: 192.168.1.1 - # vrfs: - # - vrf: site-1 - # - local_as: '300' - # log_neighbor_changes: true - # neighbor_down: - # fib_accelerate: true - # neighbors: - # - neighbor_address: 203.0.113.2 - # password: - # encryption: 7 - # key: 12090404011C03162E - # vrf: site-2 - - # Remove a neighbor having AF configurations with state replaced (will fail) - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # log-neighbor-changes - # maxas-limit 20 - # router-id 198.51.100.2 - # neighbor 203.0.113.2 - # address-family ipv4 unicast - # next-hop-self - # remote-as 65538 - # affinity-group 160 - # description NBR-1 - # low-memory exempt - # neighbor 192.0.2.1 - # remote-as 65537 - # password 7 12090404011C03162E - - - name: Remove a neighbor having AF configurations (should fail) - cisco.nxos.nxos_bgp_global: - config: - as_number: 65536 - router_id: 198.51.100.2 - maxas_limit: 20 - log_neighbor_changes: true - neighbors: - - neighbor_address: 192.0.2.1 - remote_as: 65537 - password: - encryption: 7 - key: 12090404011C03162E - state: replaced - - # Task output: - # ------------ - # fatal: [Nexus9000v]: FAILED! => changed=false - # msg: Neighbor 203.0.113.2 has address-family configurations. - # Please use the nxos_bgp_neighbor_af module to remove those first. - - # Remove a VRF having AF configurations with state replaced (will fail) - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # log-neighbor-changes - # maxas-limit 20 - # router-id 198.51.100.2 - # neighbor 192.0.2.1 - # remote-as 65537 - # password 7 12090404011C03162E - # vrf site-1 - # address-family ipv4 unicast - # default-information originate - # neighbor 203.0.113.2 - # remote-as 65538 - # affinity-group 160 - # description NBR-1 - # low-memory exempt - # vrf site-2 - # neighbor-down fib-accelerate - - - name: Remove a VRF having AF configurations (should fail) - cisco.nxos.nxos_bgp_global: - config: - as_number: 65536 - router_id: 198.51.100.2 - maxas_limit: 20 - log_neighbor_changes: true - neighbors: - - neighbor_address: 192.0.2.1 - remote_as: 65537 - password: - encryption: 7 - key: 12090404011C03162E - vrfs: - - vrf: site-2 - neighbor_down: - fib_accelerate: true - state: replaced - - # Task output: - # ------------ - # fatal: [Nexus9000v]: FAILED! => changed=false - # msg: VRF site-1 has address-family configurations. - # Please use the nxos_bgp_af module to remove those first. - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['router bgp 65563', 'maxas-limit 20', 'router-id 192.168.1.1', 'confederation peers 65020 65030 65040', 'neighbor 192.168.1.100', 'remote-as 65563', 'affinity-group 160', 'bmp-activate-server 1', 'description NBR-1', 'low-memory exempt', 'vrf site-1', 'log-neighbor-changes', 'neighbor 198.51.100.1', 'remote-as 65562', 'description site-1-nbr-1', 'password 3 13D4D3549493D2877B1DC116EE27A6BE']
-
-
- gathered - -
- dictionary -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- dictionary -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['router bgp 65563', 'maxas-limit 20', 'router-id 192.168.1.1']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst b/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst deleted file mode 100644 index 8668a0b9f..000000000 --- a/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst +++ /dev/null @@ -1,3575 +0,0 @@ -.. _cisco.nxos.nxos_bgp_neighbor_address_family_module: - - -******************************************* -cisco.nxos.nxos_bgp_neighbor_address_family -******************************************* - -**BGP Neighbor Address Family resource module.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages BGP Neighbor Address Family configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
BGP Neighbor AF configuration.
-
-
- as_number - -
- string -
- 		- -
Autonomous System Number of the router.
-
-
- neighbors - -
- list - / elements=dictionary -
- 		- -
A list of BGP Neighbor AF configuration.
-
-
- address_family - -
- list - / elements=dictionary -
- 		- -
BGP Neighbor Address Family related configurations.
-
-
- advertise_map - -
- dictionary -
- 		- -
Specify route-map for conditional advertisement.
-
-
- exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition exists.
-
-
- non_exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition does not exist.
-
-
- route_map - -
- string - / required -
- 		- -
Route-map name.
-
-
- advertisement_interval - -
- integer -
- 		- -
Minimum interval between sending BGP routing updates.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
  • link-state
    • -
  • vpnv4
    • -
  • vpnv6
    • -
  • l2vpn
    • -
- 		-
Address Family indicator.
-
-
- allowas_in - -
- dictionary -
- 		- -
Accept as-path with my AS present in it.
-
-
- max_occurences - -
- integer -
- 		- -
Number of occurrences of AS number, default is 3.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Activate allowas-in property.
-
-
- as_override - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Override matching AS-number while sending update.
-
-
- capability - -
- dictionary -
- 		- -
Advertise capability to the peer.
-
-
- additional_paths - -
- dictionary -
- 		- -
Additional paths capability.
-
-
- receive - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Receive capability.
-
-
- send - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Send capability.
-
-
- default_originate - -
- dictionary -
- 		- -
Originate a default toward this peer.
-
-
- route_map - -
- string -
- 		- -
Route-map to specify criteria for originating default.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set default-originate attribute.
-
-
- disable_peer_as_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable checking of peer AS-number while advertising.
-
-
- filter_list - -
- dictionary -
- 		- -
Name of filter-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a template.
-
-
- sequence - -
- integer -
- 		- -
Sequence number.
-
-
- template - -
- string -
- 		- -
Template name.
-
-
- maximum_prefix - -
- dictionary -
- 		- -
Maximum number of prefixes from this neighbor.
-
-
- generate_warning_threshold - -
- integer -
- 		- -
Threshold percentage at which to generate a warning.
-
-
- max_prefix_limit - -
- integer -
- 		- -
Maximum prefix limit.
-
-
- restart_interval - -
- integer -
- 		- -
Restart bgp connection after limit is exceeded.
-
-
- warning_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Only give a warning message when limit is exceeded.
-
-
- next_hop_self - -
- dictionary -
- 		- -
Set our address as nexthop (non-reflected).
-
-
- all_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set our address as nexthop for all routes.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set next-hop-self attribute.
-
-
- next_hop_third_party - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compute a third-party nexthop if possible.
-
-
- prefix_list - -
- dictionary -
- 		- -
Apply prefix-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- rewrite_evpn_rt_asn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Auto generate RTs for EBGP neighbor.
-
-
- rewrite_rt_asn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Auto generate RTs for EBGP neighbor.
-
-
- route_map - -
- dictionary -
- 		- -
Apply route-map to neighbor.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- route_reflector_client - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure a neighbor as Route reflector client.
-
-
- safi - -
- string -
- 		-
    Choices: -
  • unicast
    • -
  • multicast
    • -
  • mvpn
    • -
  • evpn
    • -
- 		-
Sub Address Family indicator.
-
-
- send_community - -
- dictionary -
- 		- -
Send Community attribute to this neighbor.
-
-
- both - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Standard and Extended Community attributes.
-
-
- extended - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Extended Community attribute.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set send-community attribute.
-
-
- standard - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Standard Community attribute.
-
-
- soft_reconfiguration_inbound - -
- dictionary -
- 		- -
Soft reconfiguration.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always perform inbound soft reconfiguration.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set soft-reconfiguration inbound attribute.
-
-
- soo - -
- string -
- 		- -
Specify Site-of-origin extcommunity.
-
-
- suppress_inactive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise only active routes to peer.
-
-
- unsuppress_map - -
- string -
- 		- -
Route-map to selectively unsuppress suppressed routes.
-
-
- weight - -
- integer -
- 		- -
Set default weight for routes from this neighbor.
-
-
- neighbor_address - -
- string - / required -
- 		- -
IP/IPv6 address of the neighbor.
-
-
- vrfs - -
- list - / elements=dictionary -
- 		- -
Virtual Router Context.
-
-
- neighbors - -
- list - / elements=dictionary -
- 		- -
A list of BGP Neighbor AF configuration.
-
-
- address_family - -
- list - / elements=dictionary -
- 		- -
BGP Neighbor Address Family related configurations.
-
-
- advertise_map - -
- dictionary -
- 		- -
Specify route-map for conditional advertisement.
-
-
- exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition exists.
-
-
- non_exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition does not exist.
-
-
- route_map - -
- string - / required -
- 		- -
Route-map name.
-
-
- advertisement_interval - -
- integer -
- 		- -
Minimum interval between sending BGP routing updates.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
  • link-state
    • -
  • vpnv4
    • -
  • vpnv6
    • -
  • l2vpn
    • -
- 		-
Address Family indicator.
-
-
- allowas_in - -
- dictionary -
- 		- -
Accept as-path with my AS present in it.
-
-
- max_occurences - -
- integer -
- 		- -
Number of occurrences of AS number, default is 3.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Activate allowas-in property.
-
-
- as_override - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Override matching AS-number while sending update.
-
-
- capability - -
- dictionary -
- 		- -
Advertise capability to the peer.
-
-
- additional_paths - -
- dictionary -
- 		- -
Additional paths capability.
-
-
- receive - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Receive capability.
-
-
- send - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Send capability.
-
-
- default_originate - -
- dictionary -
- 		- -
Originate a default toward this peer.
-
-
- route_map - -
- string -
- 		- -
Route-map to specify criteria for originating default.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set default-originate attribute.
-
-
- disable_peer_as_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable checking of peer AS-number while advertising.
-
-
- filter_list - -
- dictionary -
- 		- -
Name of filter-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a template.
-
-
- sequence - -
- integer -
- 		- -
Sequence number.
-
-
- template - -
- string -
- 		- -
Template name.
-
-
- maximum_prefix - -
- dictionary -
- 		- -
Maximum number of prefixes from this neighbor.
-
-
- generate_warning_threshold - -
- integer -
- 		- -
Threshold percentage at which to generate a warning.
-
-
- max_prefix_limit - -
- integer -
- 		- -
Maximum prefix limit.
-
-
- restart_interval - -
- integer -
- 		- -
Restart bgp connection after limit is exceeded.
-
-
- warning_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Only give a warning message when limit is exceeded.
-
-
- next_hop_self - -
- dictionary -
- 		- -
Set our address as nexthop (non-reflected).
-
-
- all_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set our address as nexthop for all routes.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set next-hop-self attribute.
-
-
- next_hop_third_party - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compute a third-party nexthop if possible.
-
-
- prefix_list - -
- dictionary -
- 		- -
Apply prefix-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- rewrite_evpn_rt_asn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Auto generate RTs for EBGP neighbor.
-
-
- rewrite_rt_asn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Auto generate RTs for EBGP neighbor.
-
-
- route_map - -
- dictionary -
- 		- -
Apply route-map to neighbor.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- route_reflector_client - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure a neighbor as Route reflector client.
-
-
- safi - -
- string -
- 		-
    Choices: -
  • unicast
    • -
  • multicast
    • -
  • mvpn
    • -
  • evpn
    • -
- 		-
Sub Address Family indicator.
-
-
- send_community - -
- dictionary -
- 		- -
Send Community attribute to this neighbor.
-
-
- both - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Standard and Extended Community attributes.
-
-
- extended - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Extended Community attribute.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set send-community attribute.
-
-
- standard - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Standard Community attribute.
-
-
- soft_reconfiguration_inbound - -
- dictionary -
- 		- -
Soft reconfiguration.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always perform inbound soft reconfiguration.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set soft-reconfiguration inbound attribute.
-
-
- soo - -
- string -
- 		- -
Specify Site-of-origin extcommunity.
-
-
- suppress_inactive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise only active routes to peer.
-
-
- unsuppress_map - -
- string -
- 		- -
Route-map to selectively unsuppress suppressed routes.
-
-
- weight - -
- integer -
- 		- -
Set default weight for routes from this neighbor.
-
-
- neighbor_address - -
- string - / required -
- 		- -
IP/IPv6 address of the neighbor.
-
-
- vrf - -
- string -
- 		- -
VRF name.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^router bgp'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
State deleted only removes BGP attributes that this modules manages and does not negate the BGP process completely.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - Unsupported for Cisco MDS - - For managing BGP address family configurations please use the :ref:`cisco.nxos.nxos_bgp_address_family ` module. - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # Nexus9000v# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_bgp_neighbor_address_family: &id001 - config: - as_number: 65536 - neighbors: - - neighbor_address: 192.0.2.32 - address_family: - - afi: ipv4 - safi: unicast - maximum_prefix: - max_prefix_limit: 20 - generate_warning_threshold: 75 - weight: 100 - prefix_list: - inbound: rmap1 - outbound: rmap2 - - afi: ipv6 - safi: unicast - - neighbor_address: 192.0.2.33 - address_family: - - afi: ipv4 - safi: multicast - inherit: - template: BasePolicy - sequence: 200 - vrfs: - - vrf: site-1 - neighbors: - - neighbor_address: 203.0.113.1 - address_family: - - afi: ipv4 - safi: unicast - suppress_inactive: true - next_hop_self: - set: true - - neighbor_address: 203.0.113.2 - address_family: - - afi: ipv6 - safi: unicast - - afi: ipv4 - safi: multicast - send_community: - set: true - - # Task output: - # ------------ - # before: {} - # - # commands: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - address-family ipv4 unicast - # - maximum-prefix 20 75 - # - weight 100 - # - prefix-list rmap1 in - # - prefix-list rmap2 out - # - address-family ipv6 unicast - # - neighbor 192.0.2.33 - # - address-family ipv4 multicast - # - inherit peer-policy BasePolicy 200 - # - vrf site-1 - # - neighbor 203.0.113.1 - # - address-family ipv4 unicast - # - suppress-inactive - # - next-hop-self - # - neighbor 203.0.113.2 - # - address-family ipv6 unicast - # - address-family ipv4 multicast - # - send-community - # - # after: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - # Using replaced - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - - name: Replace specified neighbor AFs with given configuration - cisco.nxos.nxos_bgp_neighbor_address_family: &replaced - config: - as_number: 65536 - neighbors: - - neighbor_address: 192.0.2.32 - address_family: - - afi: ipv4 - safi: unicast - weight: 110 - - afi: ipv6 - safi: unicast - - neighbor_address: 192.0.2.33 - address_family: - - afi: ipv4 - safi: multicast - inherit: - template: BasePolicy - sequence: 200 - vrfs: - - vrf: site-1 - neighbors: - - neighbor_address: 203.0.113.1 - address_family: - - afi: ipv4 - safi: unicast - - neighbor_address: 203.0.113.2 - address_family: - - afi: ipv6 - safi: unicast - - afi: ipv4 - safi: multicast - send_community: - set: true - state: replaced - - # Task output: - # ------------ - # before: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - # - # commands: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - address-family ipv4 unicast - # - no maximum-prefix 20 75 - # - weight 110 - # - no prefix-list rmap1 in - # - no prefix-list rmap2 out - # - vrf site-1 - # - neighbor 203.0.113.1 - # - address-family ipv4 unicast - # - no suppress-inactive - # - no next-hop-self - # - # after: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # weight: 110 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # weight 110 - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - # Using overridden - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - - name: Override all BGP AF configuration with provided configuration - cisco.nxos.nxos_bgp_neighbor_address_family: - config: - as_number: 65536 - neighbors: - - neighbor_address: 192.0.2.32 - address_family: - - afi: ipv4 - safi: unicast - vrfs: - - vrf: site-1 - neighbors: - - neighbor_address: 203.0.113.1 - address_family: - - afi: ipv4 - safi: unicast - suppress_inactive: true - next_hop_self: - set: true - state: overridden - - # Task output: - # ------------ - # before: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - # - # commands: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - address-family ipv4 unicast - # - no maximum-prefix 20 75 - # - no weight 100 - # - no prefix-list rmap1 in - # - no prefix-list rmap2 out - # - no address-family ipv6 unicast - # - neighbor 192.0.2.33 - # - no address-family ipv4 multicast - # - vrf site-1 - # - neighbor 203.0.113.2 - # - no address-family ipv4 multicast - # - no address-family ipv6 unicast - # - # after: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - - # Using deleted to remove specified neighbor AFs - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - - name: Delete BGP configs handled by this module - cisco.nxos.nxos_bgp_neighbor_address_family: - config: - as_number: 65536 - neighbors: - - neighbor_address: 192.0.2.32 - address_family: - - afi: ipv4 - safi: unicast - vrfs: - - vrf: site-1 - neighbors: - - neighbor_address: 203.0.113.2 - address_family: - - afi: ipv6 - safi: unicast - state: deleted - - # Task output: - # ------------ - # before: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - # - # commands: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - no address-family ipv4 unicast - # - vrf site-1 - # - neighbor 203.0.113.2 - # - no address-family ipv6 unicast - # - # after: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # - - # Using deleted to remove all neighbor AFs - - # Before state: - # ------------- - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - # - - - name: Delete all BGP neighbor AF configs handled by this module - cisco.nxos.nxos_bgp_neighbor_address_family: - state: deleted - - # Task output: - # ------------ - # before: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - # - # commands: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - no address-family ipv4 unicast - # - no address-family ipv6 unicast - # - neighbor 192.0.2.33 - # - no address-family ipv4 multicast - # - vrf site-1 - # - neighbor 203.0.113.1 - # - no address-family ipv4 unicast - # - neighbor 203.0.113.2 - # - no address-family ipv6 unicast - # - no address-family ipv4 multicast - # - # after: - # as_number: "65536" - # - # After state: - # ------------ - # Nexus9000v# show running-config | section "^router bgp" - # router bgp 65536 - # neighbor 192.0.2.32 - # neighbor 192.0.2.33 - # vrf site-1 - # neighbor 203.0.113.1 - # neighbor 203.0.113.2 - # - - # Using rendered - - - name: Render platform specific configuration lines with state rendered (without connecting to the device) - cisco.nxos.nxos_bgp_neighbor_address_family: - config: - as_number: 65536 - neighbors: - - neighbor_address: 192.0.2.32 - address_family: - - afi: ipv4 - safi: unicast - maximum_prefix: - max_prefix_limit: 20 - generate_warning_threshold: 75 - weight: 100 - prefix_list: - inbound: rmap1 - outbound: rmap2 - - afi: ipv6 - safi: unicast - - neighbor_address: 192.0.2.33 - address_family: - - afi: ipv4 - safi: multicast - inherit: - template: BasePolicy - sequence: 200 - vrfs: - - vrf: site-1 - neighbors: - - neighbor_address: 203.0.113.1 - address_family: - - afi: ipv4 - safi: unicast - suppress_inactive: true - next_hop_self: - set: true - - neighbor_address: 203.0.113.2 - address_family: - - afi: ipv6 - safi: unicast - - afi: ipv4 - safi: multicast - send_community: - set: true - state: rendered - - # Task output: - # ------------ - # rendered: - # - router bgp 65536 - # - neighbor 192.0.2.32 - # - address-family ipv4 unicast - # - maximum-prefix 20 75 - # - weight 100 - # - prefix-list rmap1 in - # - prefix-list rmap2 out - # - address-family ipv6 unicast - # - neighbor 192.0.2.33 - # - address-family ipv4 multicast - # - inherit peer-policy BasePolicy 200 - # - vrf site-1 - # - neighbor 203.0.113.1 - # - address-family ipv4 unicast - # - suppress-inactive - # - next-hop-self - # - neighbor 203.0.113.2 - # - address-family ipv6 unicast - # - address-family ipv4 multicast - # - send-community - - # Using parsed - - # parsed.cfg - # ------------ - # router bgp 65536 - # neighbor 192.0.2.32 - # address-family ipv4 unicast - # maximum-prefix 20 75 - # weight 100 - # prefix-list rmap1 in - # prefix-list rmap2 out - # address-family ipv6 unicast - # neighbor 192.0.2.33 - # address-family ipv4 multicast - # inherit peer-policy BasePolicy 200 - # vrf site-1 - # neighbor 203.0.113.1 - # address-family ipv4 unicast - # suppress-inactive - # next-hop-self - # neighbor 203.0.113.2 - # address-family ipv4 multicast - # send-community - # address-family ipv6 unicast - - - name: Parse externally provided BGP neighbor AF config - register: result - cisco.nxos.nxos_bgp_neighbor_address_family: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output: - # ------------ - # parsed: - # as_number: "65536" - # neighbors: - # - neighbor_address: 192.0.2.32 - # address_family: - # - afi: ipv4 - # safi: unicast - # maximum_prefix: - # max_prefix_limit: 20 - # generate_warning_threshold: 75 - # weight: 100 - # prefix_list: - # inbound: rmap1 - # outbound: rmap2 - # - afi: ipv6 - # safi: unicast - # - neighbor_address: 192.0.2.33 - # address_family: - # - afi: ipv4 - # safi: multicast - # inherit: - # template: BasePolicy - # sequence: 200 - # vrfs: - # - vrf: site-1 - # neighbors: - # - neighbor_address: 203.0.113.1 - # address_family: - # - afi: ipv4 - # safi: unicast - # suppress_inactive: true - # next_hop_self: - # set: true - # - neighbor_address: 203.0.113.2 - # address_family: - # - afi: ipv4 - # safi: multicast - # send_community: - # set: true - # - afi: ipv6 - # safi: unicast - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['router bgp 65536', 'neighbor 192.0.2.32', 'address-family ipv4 unicast']
-
-
- gathered - -
- dictionary -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- dictionary -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['router bgp 65536', 'neighbor 192.0.2.32', 'address-family ipv4 unicast']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_bgp_templates_module.rst b/docs/cisco.nxos.nxos_bgp_templates_module.rst deleted file mode 100644 index 9287d7a60..000000000 --- a/docs/cisco.nxos.nxos_bgp_templates_module.rst +++ /dev/null @@ -1,2841 +0,0 @@ -.. _cisco.nxos.nxos_bgp_templates_module: - - -***************************** -cisco.nxos.nxos_bgp_templates -***************************** - -**BGP Templates resource module.** - - -Version added: 4.2.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages BGP templates on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A list of BGP templates.
-
-
- as_number - -
- string -
- 		- -
Autonomous System Number of the router.
-
-
- neighbor - -
- list - / elements=dictionary -
- 		- -
Configure BGP peer templates.
-
-
- address_family - -
- list - / elements=dictionary -
- 		- -
Configure an address-family for peer.
-
-
- advertise_map - -
- dictionary -
- 		- -
Specify route-map for conditional advertisement.
-
-
- exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition exists.
-
-
- non_exist_map - -
- string -
- 		- -
Condition route-map to advertise only when prefix in condition does not exist.
-
-
- route_map - -
- string - / required -
- 		- -
Route-map name.
-
-
- advertisement_interval - -
- integer -
- 		- -
Minimum interval between sending BGP routing updates.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
  • link-state
    • -
  • l2vpn
    • -
- 		-
Address Family indicator.
-
-
- allowas_in - -
- dictionary -
- 		- -
Accept as-path with my AS present in it.
-
-
- max_occurences - -
- integer -
- 		- -
Number of occurrences of AS number, default is 3.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Activate allowas-in property.
-
-
- as_override - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Override matching AS-number while sending update.
-
-
- capability - -
- dictionary -
- 		- -
Advertise capability to the peer.
-
-
- additional_paths - -
- dictionary -
- 		- -
Additional paths capability.
-
-
- receive - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Receive capability.
-
-
- send - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Additional paths Send capability.
-
-
- default_originate - -
- dictionary -
- 		- -
Originate a default toward this peer.
-
-
- route_map - -
- string -
- 		- -
Route-map to specify criteria for originating default.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set default-originate attribute.
-
-
- disable_peer_as_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable checking of peer AS-number while advertising.
-
-
- filter_list - -
- dictionary -
- 		- -
Name of filter-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a peer-policy template.
-
-
- peer_policy - -
- string -
- 		- -
Peer-policy template to inherit.
-
-
- maximum_prefix - -
- dictionary -
- 		- -
Maximum number of prefixes from this neighbor.
-
-
- generate_warning_threshold - -
- integer -
- 		- -
Threshold percentage at which to generate a warning.
-
-
- max_prefix_limit - -
- integer -
- 		- -
Maximum prefix limit.
-
-
- restart_interval - -
- integer -
- 		- -
Restart bgp connection after limit is exceeded.
-
-
- warning_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Only give a warning message when limit is exceeded.
-
-
- next_hop_self - -
- dictionary -
- 		- -
Set our address as nexthop (non-reflected).
-
-
- all_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set our address as nexthop for all routes.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set next-hop-self attribute.
-
-
- next_hop_third_party - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compute a third-party nexthop if possible.
-
-
- prefix_list - -
- dictionary -
- 		- -
Apply prefix-list.
-
-
- inbound - -
- string -
- 		- -
Apply policy to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Apply policy to outgoing routes.
-
-
- route_map - -
- dictionary -
- 		- -
Apply route-map to neighbor.
-
-
- inbound - -
- string -
- 		- -
Name of policy to apply to incoming routes.
-
-
- outbound - -
- string -
- 		- -
Name of policy to apply to outgoing routes.
-
-
- route_reflector_client - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure a neighbor as Route reflector client.
-
-
- safi - -
- string -
- 		-
    Choices: -
  • unicast
    • -
  • multicast
    • -
  • mvpn
    • -
  • evpn
    • -
- 		-
Sub Address Family indicator.
-
-
- send_community - -
- string -
- 		-
    Choices: -
  • standard
    • -
  • extended
    • -
  • both
    • -
- 		-
Send Community attribute to this neighbor.
-
-
- soft_reconfiguration_inbound - -
- dictionary -
- 		- -
Soft reconfiguration.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always perform inbound soft reconfiguration.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set soft-reconfiguration inbound attribute.
-
-
- soo - -
- string -
- 		- -
Specify Site-of-origin extcommunity.
-
-
- suppress_inactive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise only active routes to peer.
-
-
- unsuppress_map - -
- string -
- 		- -
Route-map to selectively unsuppress suppressed routes.
-
-
- weight - -
- integer -
- 		- -
Set default weight for routes from this neighbor.
-
-
- bfd - -
- dictionary -
- 		- -
Bidirectional Fast Detection for the neighbor.
-
-
- multihop - -
- dictionary -
- 		- -
Multihop session.
-
-
- interval - -
- dictionary -
- 		- -
Configure BFD session interval parameters.
-
-
- min_rx_interval - -
- integer - / required -
- 		- -
Minimum RX interval.
-
-
- multiplier - -
- integer - / required -
- 		- -
Detect Multiplier.
-
-
- tx_interval - -
- integer - / required -
- 		- -
TX interval in milliseconds.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD multihop.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set BFD for this neighbor.
-
-
- singlehop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Single-hop session.
-
-
- bmp_activate_server - -
- integer -
- 		- -
Specify server ID for activating BMP monitoring for the peer.
-
-
- capability - -
- dictionary -
- 		- -
Capability.
-
-
- suppress_4_byte_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress 4-byte AS Capability.
-
-
- description - -
- string -
- 		- -
Neighbor specific descripion.
-
-
- disable_connected_check - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable check for directly connected peer.
-
-
- dont_capability_negotiate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Don't negotiate capability with this neighbor.
-
-
- dscp - -
- string -
- 		- -
Set dscp value for tcp transport.
-
-
- dynamic_capability - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Dynamic Capability
-
-
- ebgp_multihop - -
- integer -
- 		- -
Specify multihop TTL for remote peer.
-
-
- graceful_shutdown - -
- dictionary -
- 		- -
Graceful-shutdown for this neighbor.
-
-
- activate - -
- dictionary -
- 		- -
Send graceful-shutdown community.
-
-
- route_map - -
- string -
- 		- -
Apply route-map to modify attributes for outbound.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set activate.
-
-
- inherit - -
- dictionary -
- 		- -
Inherit a template.
-
-
- peer_session - -
- string -
- 		- -
Peer-session template to inherit.
-
-
- local_as - -
- string -
- 		- -
Specify the local-as number for the eBGP neighbor.
-
-
- log_neighbor_changes - -
- dictionary -
- 		- -
Log message for neighbor up/down event.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable logging of neighbor up/down event.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set log-neighbor-changes.
-
-
- low_memory - -
- dictionary -
- 		- -
Behaviour in low memory situations.
-
-
- exempt - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not shutdown this peer when under memory pressure.
-
-
- name - -
- string -
- 		- -
Name of the BGP peer template.
-
-
- password - -
- dictionary -
- 		- -
Configure a password for neighbor.
-
-
- encryption - -
- integer -
- 		- -
0 specifies an UNENCRYPTED neighbor password.
-
3 specifies an 3DES ENCRYPTED neighbor password will follow.
-
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
-
-
- key - -
- string -
- 		- -
Authentication password.
-
-
- path_attribute - -
- list - / elements=dictionary -
- 		- -
BGP path attribute optional filtering.
-
-
- action - -
- string -
- 		-
    Choices: -
  • discard
    • -
  • treat-as-withdraw
    • -
- 		-
Action.
-
-
- range - -
- dictionary -
- 		- -
Path attribute range.
-
-
- end - -
- integer -
- 		- -
Path attribute range end value.
-
-
- start - -
- integer -
- 		- -
Path attribute range start value.
-
-
- type - -
- integer -
- 		- -
Path attribute type
-
-
- remote_as - -
- string -
- 		- -
Specify Autonomous System Number of the neighbor.
-
-
- remove_private_as - -
- dictionary -
- 		- -
Remove private AS number from outbound updates.
-
-
- all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All.
-
-
- replace_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Replace.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove private AS.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively shutdown this neighbor.
-
-
- timers - -
- dictionary -
- 		- -
Configure keepalive and hold timers.
-
-
- holdtime - -
- integer -
- 		- -
Holdtime (seconds).
-
-
- keepalive - -
- integer -
- 		- -
Keepalive interval (seconds).
-
-
- transport - -
- dictionary -
- 		- -
BGP transport connection.
-
-
- connection_mode - -
- dictionary -
- 		- -
Specify type of connection.
-
-
- passive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow passive connection setup only.
-
-
- ttl_security - -
- dictionary -
- 		- -
Enable TTL Security Mechanism.
-
-
- hops - -
- integer -
- 		- -
Specify hop count for remote peer.
-
-
- update_source - -
- string -
- 		- -
Specify source of BGP session and updates.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config bgp | section 'template'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - Unsupported for Cisco MDS - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # -------------- - # - # nxos9k# show running-config | section "^router bgp" - # nxos9k# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_bgp_templates: - config: - as_number: 65536 - neighbor: - - name: neighbor_tmplt_1 - address_family: - - afi: ipv4 - safi: unicast - advertise_map: - route_map: rmap1 - non_exist_map: nemap1 - advertisement_interval: 60 - disable_peer_as_check: true - bmp_activate_server: 2 - capability: - suppress_4_byte_as: true - description: Test_BGP_PEER_TEMPLATE_1 - local_as: 65536 - remote_as: 65001 - - - name: neighbor_tmplt_2 - description: Test_BGP_PEER_TEMPLATE_2 - address_family: - - afi: ipv4 - safi: multicast - advertise_map: - route_map: rmap1 - exist_map: emap1 - as_override: true - filter_list: - inbound: flist1 - outbound: flist2 - inherit: - peer_session: psession1 - timers: - holdtime: 100 - keepalive: 45 - # Task Output: - # ------------ - # before: {} - # - # commands: - # - router bgp 65536 - # - template peer neighbor_tmplt_1 - # - bmp-activate-server 2 - # - capability suppress 4-byte-as - # - description Test_BGP_PEER_TEMPLATE_1 - # - local-as 65536 - # - remote-as 65001 - # - address-family ipv4 unicast - # - advertise-map rmap1 non-exist-map nemap1 - # - advertisement-interval 60 - # - disable-peer-as-check - # - template peer neighbor_tmplt_2 - # - description Test_BGP_PEER_TEMPLATE_2 - # - inherit peer-session psession1 - # - timers 45 100 - # - address-family ipv4 multicast - # - advertise-map rmap1 exist-map emap1 - # - as-override - # - filter-list flist1 in - # - filter-list flist2 out - # - # after: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # bmp_activate_server: 2 - # capability: - # suppress_4_byte_as: true - # description: Test_BGP_PEER_TEMPLATE_1 - # local_as: "65536" - # remote_as: "65001" - # - # - name: neighbor_tmplt_2 - # description: Test_BGP_PEER_TEMPLATE_2 - # address_family: - # - afi: ipv4 - # safi: multicast - # advertise_map: - # exist_map: emap1 - # route_map: rmap1 - # as_override: true - # filter_list: - # inbound: flist1 - # outbound: flist2 - # inherit: - # peer_session: psession1 - # timers: - # holdtime: 100 - # keepalive: 45 - - # After state: - # -------------- - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # capability suppress 4-byte-as - # bmp-activate-server 2 - # description Test_BGP_PEER_TEMPLATE_1 - # local-as 65536 - # remote-as 65001 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - # template peer neighbor_tmplt_2 - # description Test_BGP_PEER_TEMPLATE_2 - # inherit peer-session psession1 - # timers 45 100 - # address-family ipv4 multicast - # advertise-map rmap1 exist-map emap1 - # as-override - # filter-list flist1 in - # filter-list flist2 out - - # Using replaced - - # Before state: - # ------------- - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # capability suppress 4-byte-as - # description Test_BGP_PEER_TEMPLATE_1 - # bmp-activate-server 2 - # local-as 65536 - # remote-as 65001 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - # template peer neighbor_tmplt_2 - # description Test_BGP_PEER_TEMPLATE_2 - # inherit peer-session psession1 - # timers 45 100 - # address-family ipv4 multicast - # advertise-map rmap1 exist-map emap1 - # as-override - # filter-list flist1 in - # filter-list flist2 out - - - name: Replace BGP templates configuration with provided configuration - cisco.nxos.nxos_bgp_templates: - config: - as_number: 65536 - neighbor: - - name: neighbor_tmplt_1 - address_family: - - afi: ipv4 - safi: unicast - advertise_map: - route_map: rmap1 - non_exist_map: nemap1 - advertisement_interval: 60 - disable_peer_as_check: true - inherit: - peer_session: psession1 - description: Test_BGP_PEER_TEMPLATE_1 - local_as: 65537 - state: replaced - - # Task output: - # ------------ - # - # before: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # bmp_activate_server: 2 - # capability: - # suppress_4_byte_as: true - # description: Test_BGP_PEER_TEMPLATE_1 - # local_as: "65536" - # remote_as: "65001" - # - # - name: neighbor_tmplt_2 - # description: Test_BGP_PEER_TEMPLATE_2 - # address_family: - # - afi: ipv4 - # safi: multicast - # advertise_map: - # exist_map: emap1 - # route_map: rmap1 - # as_override: true - # filter_list: - # inbound: flist1 - # outbound: flist2 - # inherit: - # peer_session: psession1 - # timers: - # holdtime: 100 - # keepalive: 45 - # - # commands: - # - router bgp 65536 - # - template peer neighbor_tmplt_1 - # - no bmp-activate-server 2 - # - no capability suppress 4-byte-as - # - inherit peer-session psession1 - # - local-as 65537 - # - no remote-as 65001 - # - # after: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # description: Test_BGP_PEER_TEMPLATE_1 - # inherit: - # peer_session: psession1 - # local_as: "65537" - # - # - name: neighbor_tmplt_2 - # description: Test_BGP_PEER_TEMPLATE_2 - # address_family: - # - afi: ipv4 - # safi: multicast - # advertise_map: - # exist_map: emap1 - # route_map: rmap1 - # as_override: true - # filter_list: - # inbound: flist1 - # outbound: flist2 - # inherit: - # peer_session: psession1 - # timers: - # holdtime: 100 - # keepalive: 45 - - # After state: - # ------------ - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # inherit peer-session psession1 - # description Test_BGP_PEER_TEMPLATE_1 - # local-as 65537 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - # template peer neighbor_tmplt_2 - # description Test_BGP_PEER_TEMPLATE_2 - # inherit peer-session psession1 - # bmp-activate-server 2 - # timers 45 100 - # address-family ipv4 multicast - # advertise-map rmap1 exist-map emap1 - # as-override - # filter-list flist1 in - # filter-list flist2 out - - # Using overridden - # - # Before state: - # ------------- - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # capability suppress 4-byte-as - # description Test_BGP_PEER_TEMPLATE_1 - # bmp-activate-server 2 - # local-as 65536 - # remote-as 65001 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - # template peer neighbor_tmplt_2 - # description Test_BGP_PEER_TEMPLATE_2 - # inherit peer-session psession1 - # timers 45 100 - # address-family ipv4 multicast - # advertise-map rmap1 exist-map emap1 - # as-override - # filter-list flist1 in - # filter-list flist2 out - - - name: Override BGP templates configuration with provided configuration - cisco.nxos.nxos_bgp_templates: - config: - as_number: 65536 - neighbor: - - name: neighbor_tmplt_1 - address_family: - - afi: ipv4 - safi: unicast - advertise_map: - route_map: rmap1 - non_exist_map: nemap1 - advertisement_interval: 60 - disable_peer_as_check: true - inherit: - peer_session: psession1 - description: Test_BGP_PEER_TEMPLATE_1 - local_as: 65537 - state: overridden - - # Task output: - # ------------ - # - # before: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # bmp_activate_server: 2 - # capability: - # suppress_4_byte_as: true - # description: Test_BGP_PEER_TEMPLATE_1 - # local_as: "65536" - # remote_as: "65001" - # - # - name: neighbor_tmplt_2 - # description: Test_BGP_PEER_TEMPLATE_2 - # address_family: - # - afi: ipv4 - # safi: multicast - # advertise_map: - # exist_map: emap1 - # route_map: rmap1 - # as_override: true - # filter_list: - # inbound: flist1 - # outbound: flist2 - # inherit: - # peer_session: psession1 - # timers: - # holdtime: 100 - # keepalive: 45 - # - # commands: - # - router bgp 65536 - # - template peer neighbor_tmplt_1 - # - no bmp-activate-server 2 - # - no capability suppress 4-byte-as - # - inherit peer-session psession1 - # - local-as 65537 - # - no remote-as 65001 - # - no template peer neighbor_tmplt_2 - # - # after: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # description: Test_BGP_PEER_TEMPLATE_1 - # inherit: - # peer_session: psession1 - # local_as: "65537" - - # After state: - # ------------ - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # inherit peer-session psession1 - # description Test_BGP_PEER_TEMPLATE_1 - # local-as 65537 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - - # Using deleted - - # Before state: - # -------------- - # - # nxos9k# show running-config | section "^router bgp" - # router bgp 65536 - # template peer neighbor_tmplt_1 - # capability suppress 4-byte-as - # description Test_BGP_PEER_TEMPLATE_1 - # bmp-activate-server 2 - # local-as 65536 - # remote-as 65001 - # address-family ipv4 unicast - # advertise-map rmap1 non-exist-map nemap1 - # advertisement-interval 60 - # disable-peer-as-check - # template peer neighbor_tmplt_2 - # description Test_BGP_PEER_TEMPLATE_2 - # inherit peer-session psession1 - # timers 45 100 - # address-family ipv4 multicast - # advertise-map rmap1 exist-map emap1 - # as-override - # filter-list flist1 in - # filter-list flist2 out - - - name: Delete BGP configs handled by this module - cisco.nxos.nxos_bgp_templates: - state: deleted - - # Task output: - # ------------ - # - # before: - # as_number: "65536" - # neighbor: - # - name: neighbor_tmplt_1 - # address_family: - # - afi: ipv4 - # safi: unicast - # advertise_map: - # non_exist_map: nemap1 - # route_map: rmap1 - # advertisement_interval: 60 - # disable_peer_as_check: true - # bmp_activate_server: 2 - # capability: - # suppress_4_byte_as: true - # description: Test_BGP_PEER_TEMPLATE_1 - # local_as: "65536" - # remote_as: "65001" - # - # - name: neighbor_tmplt_2 - # description: Test_BGP_PEER_TEMPLATE_2 - # address_family: - # - afi: ipv4 - # safi: multicast - # advertise_map: - # exist_map: emap1 - # route_map: rmap1 - # as_override: true - # filter_list: - # inbound: flist1 - # outbound: flist2 - # inherit: - # peer_session: psession1 - # timers: - # holdtime: 100 - # keepalive: 45 - # - # commands: - # - router bgp 65536 - # - no template peer neighbor_tmplt_1 - # - no template peer neighbor_tmplt_2 - # - # after: {} - - # After state: - # ------------- - # nxos9k# show running-config | section "^router bgp" - # nxos9k# - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['router bgp 65536', 'template peer neighbor_tmplt_1', 'no bmp-activate-server 2', 'no capability suppress 4-byte-as', 'inherit peer-session psession1', 'local-as 65537', 'no remote-as 65001', 'no template peer neighbor_tmplt_2']
-
-
- gathered - -
- dictionary -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- dictionary -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['router bgp 65536', 'template peer neighbor_tmplt_1', 'bmp-activate-server 2', 'no capability suppress 4-byte-as', 'no template peer neighbor_tmplt_2']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_command_module.rst b/docs/cisco.nxos.nxos_command_module.rst deleted file mode 100644 index 4308a6582..000000000 --- a/docs/cisco.nxos.nxos_command_module.rst +++ /dev/null @@ -1,258 +0,0 @@ -.. _cisco.nxos.nxos_command_module: - - -*********************** -cisco.nxos.nxos_command -*********************** - -**Run arbitrary command on Cisco NXOS devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Sends an arbitrary command to an NXOS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- commands - -
- list - / elements=raw - / required -
- 		- -
The commands to send to the remote NXOS device. The resulting output from the command is returned. If the wait_for argument is provided, the module is not returned until the condition is satisfied or the number of retires as expired.
-
The commands argument also accepts an alternative form that allows for complex values that specify the command to run and the output format to return. This can be done on a command by command basis. The complex argument supports the keywords command and output where command is the command to run and output is one of 'text' or 'json'.
-
If a command sent to the device requires answering a prompt, it is possible to pass a dict containing command, answer and prompt. Common answers are 'y' or "\r" (carriage return, must be double quotes). See examples.
-
-
- interval - -
- integer -
- 		- Default:
1
- 		-
Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditional, the interval indicates how to long to wait before trying the command again.
-
-
- match - -
- string -
- 		-
    Choices: -
  • any
    • -
  • all ←
    • -
- 		-
The match argument is used in conjunction with the wait_for argument to specify the match policy. Valid values are all or any. If the value is set to all then all conditionals in the wait_for must be satisfied. If the value is set to any then only one of the values must be satisfied.
-
-
- retries - -
- integer -
- 		- Default:
9
- 		-
Specifies the number of retries a command should by tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait_for conditionals.
-
The commands are run once when retries is set to 0.
-
-
- wait_for - -
- list - / elements=string -
- 		- -
Specifies what to evaluate from the output of the command and what conditionals to apply. This argument will cause the task to wait for a particular conditional to be true before moving forward. If the conditional is not true by the configured retries, the task fails. See examples.
-

aliases: waitfor
-
-
- - -Notes ------ - -.. note:: - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: run show version on remote devices - cisco.nxos.nxos_command: - commands: show version - - - name: run show version and check to see if output contains Cisco - cisco.nxos.nxos_command: - commands: show version - wait_for: result[0] contains Cisco - - - name: run multiple commands on remote nodes - cisco.nxos.nxos_command: - commands: - - show version - - show interfaces - - - name: run multiple commands and evaluate the output - cisco.nxos.nxos_command: - commands: - - show version - - show interfaces - wait_for: - - result[0] contains Cisco - - result[1] contains loopback0 - - - name: run commands and specify the output format - cisco.nxos.nxos_command: - commands: - - command: show version - output: json - - - name: run commands that require answering a prompt - cisco.nxos.nxos_command: - commands: - - configure terminal - - command: no feature npv - prompt: Do you want to continue - answer: y - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- failed_conditions - -
- list -
- 		failed -
The list of conditionals that have failed
-
-
Sample:
-
['...', '...']
-
-
- stdout - -
- list -
- 		always apart from low level errors (such as action plugin) -
The set of responses from the commands
-
-
Sample:
-
['...', '...']
-
-
- stdout_lines - -
- list -
- 		always apart from low level errors (such as action plugin) -
The value of stdout split into a list
-
-
Sample:
-
[['...', '...'], ['...'], ['...']]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_config_module.rst b/docs/cisco.nxos.nxos_config_module.rst deleted file mode 100644 index 3ead5ab50..000000000 --- a/docs/cisco.nxos.nxos_config_module.rst +++ /dev/null @@ -1,566 +0,0 @@ -.. _cisco.nxos.nxos_config_module: - - -********************** -cisco.nxos.nxos_config -********************** - -**Manage Cisco NXOS configuration sections** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- 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. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- after - -
- list - / elements=string -
- 		- -
The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with before this allows the playbook designer to append a set of commands to be executed after the command set.
-
-
- backup - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
This argument will cause the module to create a full backup of the current running-config from the remote device before any changes are made. If the backup_options value is not given, the backup file is written to the backup folder in the playbook root directory or role root directory, if playbook is part of an ansible role. If the directory does not exist, it is created.
-
-
- backup_options - -
- dictionary -
- 		- -
This is a dict object containing configurable options related to backup file path. The value of this option is read only when backup is set to True, if backup is set to false this option will be silently ignored.
-
-
- dir_path - -
- path -
- 		- -
This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be created and the filename is either the value of filename or default filename as described in filename options description. If the path value is not given in that case a backup directory will be created in the current working directory and backup configuration will be copied in filename within backup directory.
-
-
- filename - -
- string -
- 		- -
The filename to be used to store the backup configuration. If the filename is not given it will be generated based on the hostname, current time and date in format defined by <hostname>_config.<current-date>@<current-time>
-
-
- before - -
- list - / elements=string -
- 		- -
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.
-
-
- defaults - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
The 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
-
-
- diff_against - -
- string -
- 		-
    Choices: -
  • startup
    • -
  • intended
    • -
  • running
    • -
- 		-
When using the ansible-playbook --diff command line argument the module can generate diffs against different sources.
-
When this option is configure as startup, the module will return the diff of the running-config against the startup-config.
-
When this option is configured as intended, the module will return the diff of the running-config against the configuration provided in the intended_config argument.
-
When this option is configured as running, the module will return the before and after diff of the running-config with respect to any changes made to the device configuration.
-
-
- diff_ignore_lines - -
- list - / elements=string -
- 		- -
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.
-
-
- intended_config - -
- string -
- 		- -
The 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 diff_against value and set it to intended. The configuration lines for this value should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure correct diff.
-
-
- lines - -
- list - / elements=string -
- 		- -
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 to ensure idempotency and correct diff. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser.
-

aliases: commands
-
-
- match - -
- string -
- 		-
    Choices: -
  • line ←
    • -
  • strict
    • -
  • exact
    • -
  • none
    • -
- 		-
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 line, commands are matched line by line. If match is set to strict, command lines are matched with respect to position. If match is set to exact, command lines must be an equal match. Finally, if match is set to none, the module will not attempt to compare the source configuration with the running configuration on the remote device.
-
-
- parents - -
- list - / elements=string -
- 		- -
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.
-
-
- replace - -
- string -
- 		-
    Choices: -
  • line ←
    • -
  • block
    • -
  • config
    • -
- 		-
Instructs the module on the way to perform the configuration on the device. If the replace argument is set to line then the modified lines are pushed to the device in configuration mode. If the replace argument is set to block then the entire command block is pushed to the device in configuration mode if any line is not correct. replace config will only work for NX-OS versions that support `config replace`.
-
-
- replace_src - -
- string -
- 		- -
The 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 replace with value config. This is mutually exclusive with the lines and src arguments. This argument will only work for NX-OS versions that support `config replace`. Use nxos_file_copy module to copy the flat file to remote device and then use the path with this argument. The configuration lines in the file should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure idempotency and correct diff.
-
-
- running_config - -
- string -
- 		- -
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 running_config argument allows the implementer to pass in the configuration to use as the base config for comparison. The configuration lines for this option should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure idempotency and correct diff.
-

aliases: config
-
-
- save_when - -
- string -
- 		-
    Choices: -
  • always
    • -
  • never ←
    • -
  • modified
    • -
  • changed
    • -
- 		-
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 always, then the running-config will always be copied to the startup-config and the modified flag will always be set to True. If the argument is set to 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 never, the running-config will never be copied to the startup-config. If the argument is set to changed, then the running-config will only be copied to the startup-config if the task has made a change. changed was added in Ansible 2.6.
-
-
- src - -
- path -
- 		- -
The 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 lines and parents arguments. The configuration lines in the source file should be similar to how it will appear if present in the running-configuration of the device including indentation to ensure idempotency and correct diff.
-
-
- - -Notes ------ - -.. note:: - - Unsupported for Cisco MDS - - Abbreviated commands are NOT idempotent, see https://docs.ansible.com/ansible/latest/network/user_guide/faq.html#why-do-the-config-modules-always-return-changed-true-with-abbreviated-commands. - - To ensure idempotency and correct diff the configuration lines in the relevant module options should be similar to how they appear if present in the running configuration on device including the indentation. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: configure top level configuration and save it - cisco.nxos.nxos_config: - lines: hostname {{ inventory_hostname }} - save_when: modified - - - name: diff the running-config against a provided config - cisco.nxos.nxos_config: - diff_against: intended - intended_config: "{{ lookup('file', 'master.cfg') }}" - - - cisco.nxos.nxos_config: - lines: - - 10 permit ip 192.0.2.1/32 any log - - 20 permit ip 192.0.2.2/32 any log - - 30 permit ip 192.0.2.3/32 any log - - 40 permit ip 192.0.2.4/32 any log - - 50 permit ip 192.0.2.5/32 any log - parents: ip access-list test - before: no ip access-list test - match: exact - - - cisco.nxos.nxos_config: - lines: - - 10 permit ip 192.0.2.1/32 any log - - 20 permit ip 192.0.2.2/32 any log - - 30 permit ip 192.0.2.3/32 any log - - 40 permit ip 192.0.2.4/32 any log - parents: ip access-list test - before: no ip access-list test - replace: block - - - name: replace config with flat file - cisco.nxos.nxos_config: - replace_src: config.txt - replace: config - - - name: for idempotency, use full-form commands - cisco.nxos.nxos_config: - lines: - # - shut - - shutdown - # parents: int eth1/1 - parents: interface Ethernet1/1 - - - name: configurable backup path - cisco.nxos.nxos_config: - backup: true - backup_options: - filename: backup.cfg - dir_path: /home/user - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- backup_path - -
- string -
- 		when backup is yes -
The full path to the backup file
-
-
Sample:
-
/playbooks/ansible/backup/nxos_config.2016-07-16@22:28:34
-
-
- commands - -
- list -
- 		always -
The set of commands that will be pushed to the remote device
-
-
Sample:
-
['hostname foo', 'vlan 1', 'name default']
-
-
- date - -
- string -
- 		when backup is yes -
The date extracted from the backup file name
-
-
Sample:
-
2016-07-16
-
-
- filename - -
- string -
- 		when backup is yes and filename is not specified in backup options -
The name of the backup file
-
-
Sample:
-
nxos_config.2016-07-16@22:28:34
-
-
- shortname - -
- string -
- 		when backup is yes and filename is not specified in backup options -
The full path to the backup file excluding the timestamp
-
-
Sample:
-
/playbooks/ansible/backup/nxos_config
-
-
- time - -
- string -
- 		when backup is yes -
The time extracted from the backup file name
-
-
Sample:
-
22:28:34
-
-
- updates - -
- list -
- 		always -
The set of commands that will be pushed to the remote device
-
-
Sample:
-
['hostname foo', 'vlan 1', 'name default']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_devicealias_module.rst b/docs/cisco.nxos.nxos_devicealias_module.rst deleted file mode 100644 index 081c8759f..000000000 --- a/docs/cisco.nxos.nxos_devicealias_module.rst +++ /dev/null @@ -1,273 +0,0 @@ -.. _cisco.nxos.nxos_devicealias_module: - - -*************************** -cisco.nxos.nxos_devicealias -*************************** - -**Configuration of device alias for Cisco NXOS MDS Switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configuration of device alias for Cisco MDS NXOS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- da - -
- list - / elements=dictionary -
- 		- -
List of device-alias to be added or removed
-
-
- name - -
- string - / required -
- 		- -
Name of the device-alias to be added or removed
-
-
- pwwn - -
- string -
- 		- -
pwwn to which the name needs to be associated with
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Removes the device-alias if set to True
-
-
- distribute - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable device-alias distribution
-
-
- mode - -
- string -
- 		-
    Choices: -
  • basic
    • -
  • enhanced
    • -
- 		-
Mode of devices-alias, basic or enhanced
-
-
- rename - -
- list - / elements=dictionary -
- 		- -
List of device-alias to be renamed
-
-
- new_name - -
- string - / required -
- 		- -
New name of the device-alias
-
-
- old_name - -
- string - / required -
- 		- -
Old name of the device-alias that needs to be renamed
-
-
- - -Notes ------ - -.. note:: - - Tested against Cisco MDS NX-OS 8.4(1) - - - -Examples --------- - -.. code-block:: yaml - - - name: Test that device alias module works - cisco.nxos.nxos_devicealias: - da: - - name: test1_add - pwwn: 56:2:22:11:22:88:11:67 - - name: test2_add - pwwn: 65:22:22:11:22:22:11:d - - name: dev1 - remove: true - - name: dev2 - remove: true - distribute: true - mode: enhanced - rename: - - new_name: bcd - old_name: abc - - new_name: bcd1 - old_name: abc1 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['terminal dont-ask', 'device-alias database', 'device-alias name somename pwwn 10:00:00:00:89:a1:01:03', 'device-alias name somename1 pwwn 10:00:00:00:89:a1:02:03', 'device-alias commit', 'no terminal dont-ask']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) diff --git a/docs/cisco.nxos.nxos_evpn_global_module.rst b/docs/cisco.nxos.nxos_evpn_global_module.rst deleted file mode 100644 index d1b2a8241..000000000 --- a/docs/cisco.nxos.nxos_evpn_global_module.rst +++ /dev/null @@ -1,122 +0,0 @@ -.. _cisco.nxos.nxos_evpn_global_module: - - -*************************** -cisco.nxos.nxos_evpn_global -*************************** - -**Handles the EVPN control plane for VXLAN.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Handles the EVPN control plane for VXLAN. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- nv_overlay_evpn - -
- boolean - / required -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
EVPN control plane.
-
-
- - -Notes ------ - -.. note:: - - This module is not supported on Nexus 3000 series of switches. - - Unsupported for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_evpn_global: - nv_overlay_evpn: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The set of commands to be sent to the remote device
-
-
Sample:
-
['nv overlay evpn']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_evpn_vni_module.rst b/docs/cisco.nxos.nxos_evpn_vni_module.rst deleted file mode 100644 index 530a9ff18..000000000 --- a/docs/cisco.nxos.nxos_evpn_vni_module.rst +++ /dev/null @@ -1,212 +0,0 @@ -.. _cisco.nxos.nxos_evpn_vni_module: - - -************************ -cisco.nxos.nxos_evpn_vni -************************ - -**Manages Cisco EVPN VXLAN Network Identifier (VNI).** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages Cisco Ethernet Virtual Private Network (EVPN) VXLAN Network Identifier (VNI) configurations of a Nexus device. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- route_distinguisher - -
- string -
- 		- -
The VPN Route Distinguisher (RD). The RD is combined with the IPv4 or IPv6 prefix learned by the PE router to create a globally unique address.
-
-
- route_target_both - -
- list - / elements=string -
- 		- -
Enables/Disables route-target settings for both import and export target communities using a single property.
-
-
- route_target_export - -
- list - / elements=string -
- 		- -
Sets the route-target 'export' extended communities.
-
-
- route_target_import - -
- list - / elements=string -
- 		- -
Sets the route-target 'import' extended communities.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Determines whether the config should be present or not on the device.
-
-
- vni - -
- string - / required -
- 		- -
The EVPN VXLAN Network Identifier.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - default, where supported, restores params default value. - - RD override is not permitted. You should set it to the default values first and then reconfigure it. - - ``route_target_both``, ``route_target_import`` and ``route_target_export valid`` values are a list of extended communities, (i.e. ['1.2.3.4:5', '33:55']) or the keywords 'auto' or 'default'. - - The ``route_target_both`` property is discouraged due to the inconsistent behavior of the property across Nexus platforms and image versions. For this reason it is recommended to use explicit ``route_target_export`` and ``route_target_import`` properties instead of ``route_target_both``. - - RD valid values are a string in one of the route-distinguisher formats, the keyword 'auto', or the keyword 'default'. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: vni configuration - cisco.nxos.nxos_evpn_vni: - vni: 6000 - route_distinguisher: 60:10 - route_target_import: - - "5000:10" - - "4100:100" - route_target_export: auto - route_target_both: default - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['evpn', 'vni 6000 l2', 'route-target import 5001:10']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_facts_module.rst b/docs/cisco.nxos.nxos_facts_module.rst deleted file mode 100644 index 3ce96abea..000000000 --- a/docs/cisco.nxos.nxos_facts_module.rst +++ /dev/null @@ -1,553 +0,0 @@ -.. _cisco.nxos.nxos_facts_module: - - -********************* -cisco.nxos.nxos_facts -********************* - -**Gets facts about NX-OS switches** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Collects facts from Cisco Nexus devices running the NX-OS operating system. Fact collection is supported over both ``network_cli`` and ``httpapi``. This module prepends all of the base network fact keys with ``ansible_net_``. The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- available_network_resources - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
When set to true a list of network resources for which resource modules are available will be provided.
-
-
- gather_network_resources - -
- list - / elements=string -
- 		- -
When supplied, this argument will gather configuration facts only for the given subset. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
-
Valid subsets are all, bfd_interfaces, lag_interfaces, telemetry, vlans, lacp, lacp_interfaces, interfaces, l3_interfaces, l2_interfaces, lldp_global, acls, acl_interfaces, ospfv2, ospfv3, ospf_interfaces, bgp_global, bgp_address_family, route_maps, prefix_lists, logging_global, ntp_global, snmp_server, hostname.
-
-
- gather_subset - -
- list - / elements=string -
- 		- Default:
"min"
- 		-
When supplied, this argument will gather operational facts only for the given subset. Possible values for this argument include all, hardware, config, legacy, interfaces, and min. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Gather all legacy facts - cisco.nxos.nxos_facts: - gather_subset: all - - name: Gather only the config and default facts - cisco.nxos.nxos_facts: - gather_subset: - - config - - name: Do not gather hardware facts - cisco.nxos.nxos_facts: - gather_subset: - - '!hardware' - - name: Gather legacy and resource facts - cisco.nxos.nxos_facts: - gather_subset: all - gather_network_resources: all - - name: Gather only the interfaces resource facts and no legacy facts - cisco.nxos.nxos_facts: - gather_subset: - - '!all' - - '!min' - gather_network_resources: - - interfaces - - name: Gather interfaces resource and minimal legacy facts - cisco.nxos.nxos_facts: - gather_subset: min - gather_network_resources: interfaces - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- ansible_net_all_ipv4_addresses - -
- list -
- 		when interfaces is configured -
All IPv4 addresses configured on the device
-
-
-
- ansible_net_all_ipv6_addresses - -
- list -
- 		when interfaces is configured -
All IPv6 addresses configured on the device
-
-
-
- ansible_net_api - -
- string -
- 		always -
The name of the transport
-
-
-
- ansible_net_config - -
- string -
- 		when config is configured -
The current active config from the device
-
-
-
- ansible_net_filesystems - -
- list -
- 		when hardware is configured -
All file system names available on the device
-
-
-
- ansible_net_gather_network_resources - -
- list -
- 		when the resource is configured -
The list of fact for network resource subsets collected from the device
-
-
-
- ansible_net_gather_subset - -
- list -
- 		always -
The list of fact subsets collected from the device
-
-
-
- ansible_net_hostname - -
- string -
- 		always -
The configured hostname of the device
-
-
-
- ansible_net_image - -
- string -
- 		always -
The image file the device is running
-
-
-
- ansible_net_interfaces - -
- dictionary -
- 		when interfaces is configured -
A hash of all interfaces running on the system
-
-
-
- ansible_net_license_hostid - -
- string -
- 		always -
The License host id of the device
-
-
-
- ansible_net_memfree_mb - -
- integer -
- 		when hardware is configured -
The available free memory on the remote device in Mb
-
-
-
- ansible_net_memtotal_mb - -
- integer -
- 		when hardware is configured -
The total memory on the remote device in Mb
-
-
-
- ansible_net_model - -
- string -
- 		always -
The model name returned from the device
-
-
-
- ansible_net_neighbors - -
- dictionary -
- 		when interfaces is configured -
The list of LLDP and CDP neighbors from the device. If both, CDP and LLDP neighbor data is present on one port, CDP is preferred.
-
-
-
- ansible_net_python_version - -
- string -
- 		always -
The Python version Ansible controller is using
-
-
-
- ansible_net_serialnum - -
- string -
- 		always -
The serial number of the remote device
-
-
-
- ansible_net_version - -
- string -
- 		always -
The operating system version running on the remote device
-
-
-
- fan_info - -
- dictionary -
- 		when legacy is configured -
A hash of facts about fans in the remote device
-
-
-
- hostname - -
- dictionary -
- 		when legacy is configured -
The configured hostname of the remote device
-
-
-
- interfaces_list - -
- dictionary -
- 		when legacy is configured -
The list of interface names on the remote device
-
-
-
- kickstart - -
- string -
- 		when legacy is configured -
The software version used to boot the system
-
-
-
- module - -
- dictionary -
- 		when legacy is configured -
A hash of facts about the modules in a remote device
-
-
-
- platform - -
- string -
- 		when legacy is configured -
The hardware platform reported by the remote device
-
-
-
- power_supply_info - -
- string -
- 		when legacy is configured -
A hash of facts about the power supplies in the remote device
-
-
-
- vlan_list - -
- list -
- 		when legacy is configured -
The list of VLAN IDs configured on the remote device
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_feature_module.rst b/docs/cisco.nxos.nxos_feature_module.rst deleted file mode 100644 index ee2539180..000000000 --- a/docs/cisco.nxos.nxos_feature_module.rst +++ /dev/null @@ -1,150 +0,0 @@ -.. _cisco.nxos.nxos_feature_module: - - -*********************** -cisco.nxos.nxos_feature -*********************** - -**Manage features in NX-OS switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Offers ability to enable and disable features in NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- feature - -
- string - / required -
- 		- -
Name of feature.
-
-
- state - -
- string -
- 		-
    Choices: -
  • enabled ←
    • -
  • disabled
    • -
- 		-
Desired state of the feature.
-
-
- - -Notes ------ - -.. note:: - - Tested against Cisco MDS NX-OS 9.2(2) - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - 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 Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The set of commands to be sent to the remote device
-
-
Sample:
-
['nv overlay evpn']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) -- Suhas Bharadwaj (@srbharadwaj) diff --git a/docs/cisco.nxos.nxos_gir_module.rst b/docs/cisco.nxos.nxos_gir_module.rst deleted file mode 100644 index 61c809ea0..000000000 --- a/docs/cisco.nxos.nxos_gir_module.rst +++ /dev/null @@ -1,302 +0,0 @@ -.. _cisco.nxos.nxos_gir_module: - - -******************* -cisco.nxos.nxos_gir -******************* - -**Trigger a graceful removal or insertion (GIR) of the switch.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Trigger a graceful removal or insertion (GIR) of the switch. -- GIR processing may take more than 2 minutes. Timeout settings are automatically extended to 200s when user timeout settings are insufficient. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Specify desired state of the resource.
-
-
- system_mode_maintenance - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
When system_mode_maintenance=true it puts all enabled protocols in maintenance mode (using the isolate command). When system_mode_maintenance=false it puts all enabled protocols in normal mode (using the no isolate command).
-
-
- system_mode_maintenance_dont_generate_profile - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
When system_mode_maintenance_dont_generate_profile=true it prevents the dynamic searching of enabled protocols and executes commands configured in a maintenance-mode profile. Use this option if you want the system to use a maintenance-mode profile that you have created. When system_mode_maintenance_dont_generate_profile=false it prevents the dynamic searching of enabled protocols and executes commands configured in a normal-mode profile. Use this option if you want the system to use a normal-mode profile that you have created.
-
-
- system_mode_maintenance_on_reload_reset_reason - -
- string -
- 		-
    Choices: -
  • hw_error
    • -
  • svc_failure
    • -
  • kern_failure
    • -
  • wdog_timeout
    • -
  • fatal_error
    • -
  • lc_failure
    • -
  • match_any
    • -
  • manual_reload
    • -
  • any_other
    • -
  • maintenance
    • -
- 		-
Boots the switch into maintenance mode automatically in the event of a specified system crash. Note that not all reset reasons are applicable for all platforms. Also if reset reason is set to match_any, it is not idempotent as it turns on all reset reasons. If reset reason is match_any and state is absent, it turns off all the reset reasons.
-
-
- system_mode_maintenance_shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Shuts down all protocols, vPC domains, and interfaces except the management interface (using the shutdown command). This option is disruptive while system_mode_maintenance (which uses the isolate command) is not.
-
-
- system_mode_maintenance_timeout - -
- string -
- 		- -
Keeps the switch in maintenance mode for a specified number of minutes. Range is 5-65535.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - ``state`` has effect only in combination with ``system_mode_maintenance_timeout`` or ``system_mode_maintenance_on_reload_reset_reason``. - - Using ``system_mode_maintenance`` and ``system_mode_maintenance_dont_generate_profile`` would make the module fail, but the system mode will be triggered anyway. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Trigger system maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance: true - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Trigger system normal mode - - cisco.nxos.nxos_gir: - system_mode_maintenance: false - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Configure on-reload reset-reason for maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance_on_reload_reset_reason: manual_reload - state: present - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Add on-reload reset-reason for maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance_on_reload_reset_reason: hw_error - state: present - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Remove on-reload reset-reason for maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance_on_reload_reset_reason: manual_reload - state: absent - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Set timeout for maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance_timeout: 30 - state: present - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - # Remove timeout for maintenance mode - - cisco.nxos.nxos_gir: - system_mode_maintenance_timeout: 30 - state: absent - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- final_system_mode - -
- string -
- 		verbose mode -
describe the last system mode
-
-
Sample:
-
normal
-
-
- updates - -
- list -
- 		verbose mode -
commands sent to the device
-
-
Sample:
-
['terminal dont-ask', 'system mode maintenance timeout 10']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_gir_profile_management_module.rst b/docs/cisco.nxos.nxos_gir_profile_management_module.rst deleted file mode 100644 index 95d85ae9b..000000000 --- a/docs/cisco.nxos.nxos_gir_profile_management_module.rst +++ /dev/null @@ -1,235 +0,0 @@ -.. _cisco.nxos.nxos_gir_profile_management_module: - - -************************************** -cisco.nxos.nxos_gir_profile_management -************************************** - -**Create a maintenance-mode or normal-mode profile for GIR.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manage a maintenance-mode or normal-mode profile with configuration commands that can be applied during graceful removal or graceful insertion. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- commands - -
- list - / elements=string -
- 		- -
List of commands to be included into the profile.
-
-
- mode - -
- string - / required -
- 		-
    Choices: -
  • maintenance
    • -
  • normal
    • -
- 		-
Configure the profile as Maintenance or Normal mode.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Specify desired state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - ``state=absent`` removes the whole profile. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Create a maintenance-mode profile - - cisco.nxos.nxos_gir_profile_management: - mode: maintenance - commands: - - router eigrp 11 - - isolate - - # Remove the maintenance-mode profile - - cisco.nxos.nxos_gir_profile_management: - mode: maintenance - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- end_state - -
- list -
- 		verbose mode -
list of profile entries after module execution.
-
-
Sample:
-
['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete', 'router eigrp 11', 'isolate']
-
-
- existing - -
- list -
- 		verbose mode -
list of existing profile commands.
-
-
Sample:
-
['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete']
-
-
- proposed - -
- list -
- 		verbose mode -
list of commands passed into module.
-
-
Sample:
-
['router eigrp 11', 'isolate']
-
-
- updates - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['configure maintenance profile maintenance-mode', 'router eigrp 11', 'isolate']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_hostname_module.rst b/docs/cisco.nxos.nxos_hostname_module.rst deleted file mode 100644 index c8a9ee45d..000000000 --- a/docs/cisco.nxos.nxos_hostname_module.rst +++ /dev/null @@ -1,344 +0,0 @@ -.. _cisco.nxos.nxos_hostname_module: - - -************************ -cisco.nxos.nxos_hostname -************************ - -**Hostname resource module.** - - -Version added: 2.9.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages hostname configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A dictionary of hostname configuration.
-
-
- hostname - -
- string -
- 		- -
Hostname of the device.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section hostname.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
The states merged, replaced and overridden have identical behaviour for this module.
-
Refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged (replaced, overridden has the same behaviour) - - # Before state: - # ------------- - # nxos-9k-rdo# show running-config | section ^hostname - # nxos-9k-rdo# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_hostname: - config: - hostname: NXOSv-9k - - # Task output - # ------------- - # before: {} - # - # commands: - # - hostname NXOSv-9k - # - # after: - # hostname: NXOSv-9k - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section ^hostname - # hostname NXOSv-9k - # - - # Using deleted - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section ^hostname - # hostname NXOSv-9k - - - name: Delete hostname from running-config - cisco.nxos.nxos_hostname: - state: deleted - - # Task output - # ------------- - # before: - # hostname: NXOSv-9k - # - # commands: - # - no hostname NXOSv-9k - # - # after: {} - - # Using gathered - - - name: Gather hostname facts using gathered - cisco.nxos.nxos_hostname: - state: gathered - - # Task output (redacted) - # ----------------------- - # gathered: - # hostname: NXOSv-9k - - # Using rendered - - - name: Render platform specific configuration lines (without connecting to the device) - cisco.nxos.nxos_hostname: - config: - hostname: NXOSv-9k - - # Task Output (redacted) - # ----------------------- - # rendered: - # - hostname NXOSv-9k - - # Using parsed - - # parsed.cfg - # ------------ - # hostname NXOSv-9k - - - name: Parse externally provided hostname config - cisco.nxos.nxos_hostname: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # hostname: NXOSv-9k - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['hostname switch01']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['hostname switch01']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst b/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst deleted file mode 100644 index 163612413..000000000 --- a/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst +++ /dev/null @@ -1,344 +0,0 @@ -.. _cisco.nxos.nxos_hsrp_interfaces_module: - - -******************************* -cisco.nxos.nxos_hsrp_interfaces -******************************* - -**HSRP interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages Hot Standby Router Protocol (HSRP) interface attributes. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
The provided configuration
-
-
- bfd - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Enable/Disable HSRP Bidirectional Forwarding Detection (BFD) on the interface.
-
-
- name - -
- string -
- 		- -
The name of the interface.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 7.0(3)I5(1). - - Feature bfd should be enabled for this module. - - Unsupported for Cisco MDS - - - -Examples --------- - -.. code-block:: yaml - - # Using deleted - - - name: Configure hsrp attributes on interfaces - cisco.nxos.nxos_hsrp_interfaces: - config: - - name: Ethernet1/1 - - name: Ethernet1/2 - operation: deleted - - - # Using merged - - - name: Configure hsrp attributes on interfaces - cisco.nxos.nxos_hsrp_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - - name: Ethernet1/2 - bfd: disable - operation: merged - - - # Using overridden - - - name: Configure hsrp attributes on interfaces - cisco.nxos.nxos_hsrp_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - - name: Ethernet1/2 - bfd: disable - operation: overridden - - - # Using replaced - - - name: Configure hsrp attributes on interfaces - cisco.nxos.nxos_hsrp_interfaces: - config: - - name: Ethernet1/1 - bfd: enable - - name: Ethernet1/2 - bfd: disable - operation: replaced - - # Using rendered - - - name: Use rendered state to convert task input to device specific commands - cisco.nxos.nxos_hsrp_interfaces: - config: - - name: Ethernet1/800 - bfd: enable - - name: Ethernet1/801 - bfd: enable - state: rendered - - # Task Output (redacted) - # ----------------------- - - # rendered: - # - "interface Ethernet1/800" - # - "hsrp bfd" - # - "interface Ethernet1/801" - # - "hsrp bfd" - - # Using parsed - - # parsed.cfg - # ------------ - # interface Ethernet1/800 - # no switchport - # hsrp bfd - # interface Ethernet1/801 - # no switchport - # hsrp bfd - - - name: Use parsed state to convert externally supplied config to structured format - cisco.nxos.nxos_hsrp_interfaces: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - - # parsed: - # - name: Ethernet1/800 - # bfd: enable - # - name: Ethernet1/801 - # bfd: enable - - # Using gathered - - # Existing device config state - # ------------------------------- - - # interface Ethernet1/1 - # no switchport - # hsrp bfd - # interface Ethernet1/2 - # no switchport - # hsrp bfd - # interface Ethernet1/3 - # no switchport - - - name: Gather hsrp_interfaces facts from the device using nxos_hsrp_interfaces - cisco.nxos.nxos_hsrp_interfaces: - state: gathered - - # Task output (redacted) - # ----------------------- - - # gathered: - # - name: Ethernet1/1 - # bfd: enable - # - name: Ethernet1/2 - # bfd: enable - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/1', 'hsrp bfd']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_hsrp_module.rst b/docs/cisco.nxos.nxos_hsrp_module.rst deleted file mode 100644 index 0a55a4423..000000000 --- a/docs/cisco.nxos.nxos_hsrp_module.rst +++ /dev/null @@ -1,305 +0,0 @@ -.. _cisco.nxos.nxos_hsrp_module: - - -******************** -cisco.nxos.nxos_hsrp -******************** - -**Manages HSRP configuration on NX-OS switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages HSRP configuration on NX-OS switches. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- auth_string - -
- string -
- 		- -
Authentication string. If this needs to be hidden(for md5 type), the string should be 7 followed by the key string. Otherwise, it can be 0 followed by key string or just key string (for backward compatibility). For text type, this should be just be a key string. if this is 'default', authentication is removed.
-
-
- auth_type - -
- string -
- 		-
    Choices: -
  • text
    • -
  • md5
    • -
- 		-
Authentication type.
-
-
- group - -
- string - / required -
- 		- -
HSRP group number.
-
-
- interface - -
- string - / required -
- 		- -
Full name of interface that is being managed for HSRP.
-
-
- preempt - -
- string -
- 		-
    Choices: -
  • enabled
    • -
  • disabled
    • -
- 		-
Enable/Disable preempt.
-
-
- priority - -
- string -
- 		- -
HSRP priority or keyword 'default'.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Specify desired state of the resource.
-
-
- version - -
- string -
- 		-
    Choices: -
  • 1 ←
    • -
  • 2
    • -
- 		-
HSRP version.
-
-
- vip - -
- string -
- 		- -
HSRP virtual IP address or keyword 'default'
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - HSRP feature needs to be enabled first on the system. - - SVIs must exist before using this module. - - Interface must be a L3 port before using this module. - - HSRP cannot be configured on loopback interfaces. - - MD5 authentication is only possible with HSRPv2 while it is ignored if HSRPv1 is used instead, while it will not raise any error. Here we allow MD5 authentication only with HSRPv2 in order to enforce better practice. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Ensure HSRP is configured with following params on a SVI - cisco.nxos.nxos_hsrp: - group: 10 - vip: 10.1.1.1 - priority: 150 - interface: vlan10 - preempt: enabled - - - name: Ensure HSRP is configured with following params on a SVI with clear text authentication - cisco.nxos.nxos_hsrp: - group: 10 - vip: 10.1.1.1 - priority: 150 - interface: vlan10 - preempt: enabled - auth_type: text - auth_string: CISCO - - - name: Ensure HSRP is configured with md5 authentication and clear authentication - string - cisco.nxos.nxos_hsrp: - group: 10 - vip: 10.1.1.1 - priority: 150 - interface: vlan10 - preempt: enabled - auth_type: md5 - auth_string: 0 1234 - - - name: Ensure HSRP is configured with md5 authentication and hidden authentication - string - cisco.nxos.nxos_hsrp: - group: 10 - vip: 10.1.1.1 - priority: 150 - interface: vlan10 - preempt: enabled - auth_type: md5 - auth_string: 7 1234 - - - name: Remove HSRP config for given interface, group, and VIP - cisco.nxos.nxos_hsrp: - group: 10 - interface: vlan10 - vip: 10.1.1.1 - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['interface vlan10', 'hsrp version 2', 'hsrp 30', 'ip 10.30.1.1']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_igmp_module.rst b/docs/cisco.nxos.nxos_igmp_module.rst deleted file mode 100644 index dbb46206f..000000000 --- a/docs/cisco.nxos.nxos_igmp_module.rst +++ /dev/null @@ -1,191 +0,0 @@ -.. _cisco.nxos.nxos_igmp_module: - - -******************** -cisco.nxos.nxos_igmp -******************** - -**Manages IGMP global configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages IGMP global configuration configuration settings. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- enforce_rtr_alert - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables or disables the enforce router alert option check for IGMPv2 and IGMPv3 packets.
-
-
- flush_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Removes routes when the IGMP process is restarted. By default, routes are not flushed.
-
-
- restart - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Restarts the igmp process (using an exec config command).
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • default
    • -
- 		-
Manages desired state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - When ``state=default``, all supported params will be reset to a default state. - - If restart is set to true with other params set, the restart will happen last, i.e. after the configuration takes place. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Default igmp global params (all params except restart) - cisco.nxos.nxos_igmp: - state: default - - - name: Ensure the following igmp global config exists on the device - cisco.nxos.nxos_igmp: - flush_routes: true - enforce_rtr_alert: true - - - name: Restart the igmp process - cisco.nxos.nxos_igmp: - restart: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- updates - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['ip igmp flush-routes']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_igmp_snooping_module.rst b/docs/cisco.nxos.nxos_igmp_snooping_module.rst deleted file mode 100644 index 31af97509..000000000 --- a/docs/cisco.nxos.nxos_igmp_snooping_module.rst +++ /dev/null @@ -1,225 +0,0 @@ -.. _cisco.nxos.nxos_igmp_snooping_module: - - -***************************** -cisco.nxos.nxos_igmp_snooping -***************************** - -**Manages IGMP snooping global configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages IGMP snooping global configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- group_timeout - -
- string -
- 		- -
Group membership timeout value for all VLANs on the device. Accepted values are integer in range 1-10080, never and default.
-
-
- link_local_grp_supp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Global link-local groups suppression.
-
-
- report_supp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Global IGMPv1/IGMPv2 Report Suppression.
-
-
- snooping - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/disables IGMP snooping on the switch.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • default
    • -
- 		-
Manage the state of the resource.
-
-
- v3_report_supp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Global IGMPv3 Report Suppression and Proxy Reporting.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - When ``state=default``, params will be reset to a default state. - - ``group_timeout`` also accepts *never* as an input. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure igmp snooping params supported in this module are in there default state - - cisco.nxos.nxos_igmp_snooping: - state: default - - # ensure following igmp snooping params are in the desired state - - cisco.nxos.nxos_igmp_snooping: - group_timeout: never - snooping: true - link_local_grp_supp: false - optimize_mcast_flood: false - report_supp: true - v3_report_supp: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['ip igmp snooping link-local-groups-suppression', 'ip igmp snooping group-timeout 50', 'no ip igmp snooping report-suppression', 'no ip igmp snooping v3-report-suppression', 'no ip igmp snooping']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_install_os_module.rst b/docs/cisco.nxos.nxos_install_os_module.rst deleted file mode 100644 index ddd630d01..000000000 --- a/docs/cisco.nxos.nxos_install_os_module.rst +++ /dev/null @@ -1,183 +0,0 @@ -.. _cisco.nxos.nxos_install_os_module: - - -************************** -cisco.nxos.nxos_install_os -************************** - -**Set boot options like boot, kickstart image and issu.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Install an operating system by setting the boot options like boot image and kickstart image and optionally select to install using ISSU (In Server Software Upgrade). - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- issu - -
- string -
- 		-
    Choices: -
  • required
    • -
  • desired
    • -
  • yes
    • -
  • no ←
    • -
- 		-
Upgrade using In Service Software Upgrade (ISSU). (Supported on N5k, N7k, N9k platforms)
-
Selecting 'required' or 'yes' means that upgrades will only proceed if the switch is capable of ISSU.
-
Selecting 'desired' means that upgrades will use ISSU if possible but will fall back to disruptive upgrade if needed.
-
Selecting 'no' means do not use ISSU. Forced disruptive.
-
-
- kickstart_image_file - -
- string -
- 		- -
Name of the kickstart image file on flash. (Not required on all Nexus platforms)
-
-
- system_image_file - -
- string - / required -
- 		- -
Name of the system (or combined) image file on flash.
-
-
- - -Notes ------ - -.. note:: - - Tested against the following platforms and images - N9k 7.0(3)I4(6), 7.0(3)I5(3), 7.0(3)I6(1), 7.0(3)I7(1), 7.0(3)F2(2), 7.0(3)F3(2) - N3k 6.0(2)A8(6), 6.0(2)A8(8), 7.0(3)I6(1), 7.0(3)I7(1) - N7k 7.3(0)D1(1), 8.0(1), 8.1(1), 8.2(1) - - Tested against Cisco MDS NX-OS 9.2(1) - - This module requires both the ANSIBLE_PERSISTENT_CONNECT_TIMEOUT and ANSIBLE_PERSISTENT_COMMAND_TIMEOUT timers to be set to 600 seconds or higher. The module will exit if the timers are not set properly. - - When using connection local, ANSIBLE_PERSISTENT_CONNECT_TIMEOUT and ANSIBLE_PERSISTENT_COMMAND_TIMEOUT can only be set using ENV variables or the ansible.cfg file. - - Do not include full file paths, just the name of the file(s) stored on the top level flash directory. - - This module attempts to install the software immediately, which may trigger a reboot. - - In check mode, the module will indicate if an upgrade is needed and whether or not the upgrade is disruptive or non-disruptive(ISSU). - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Install OS on N9k - check_mode: false - cisco.nxos.nxos_install_os: - system_image_file: nxos.7.0.3.I6.1.bin - issu: desired - - - name: Wait for device to come back up with new image - wait_for: - port: 22 - state: started - timeout: 500 - delay: 60 - host: '{{ inventory_hostname }}' - - - name: Check installed OS for newly installed version - nxos_command: - commands: [show version | json] - register: output - - - assert: - that: - - output['stdout'][0]['kickstart_ver_str'] == '7.0(3)I6(1)' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- install_state - -
- dictionary -
- 		always -
Boot and install information.
-
-
Sample:
-
{'install_state': ['Compatibility check is done:', 'Module bootable Impact Install-type Reason', '------ -------- -------------- ------------ ------', ' 1 yes non-disruptive reset ', 'Images will be upgraded according to following table:', 'Module Image Running-Version(pri:alt) New-Version Upg-Required', '------ ---------- ---------------------------------------- -------------------- ------------', ' 1 nxos 7.0(3)I6(1) 7.0(3)I7(1) yes', ' 1 bios v4.4.0(07/12/2017) v4.4.0(07/12/2017) no']}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbibo (@GGabriele) diff --git a/docs/cisco.nxos.nxos_l2_interfaces_module.rst b/docs/cisco.nxos.nxos_l2_interfaces_module.rst deleted file mode 100644 index bfad0cf31..000000000 --- a/docs/cisco.nxos.nxos_l2_interfaces_module.rst +++ /dev/null @@ -1,648 +0,0 @@ -.. _cisco.nxos.nxos_l2_interfaces_module: - - -***************************** -cisco.nxos.nxos_l2_interfaces -***************************** - -**L2 interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages Layer-2 interfaces attributes of NX-OS Interfaces. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A dictionary of Layer-2 interface options
-
-
- access - -
- dictionary -
- 		- -
Switchport mode access command to configure the interface as a Layer-2 access.
-
-
- vlan - -
- integer -
- 		- -
Configure given VLAN in access port. It's used as the access VLAN ID.
-
-
- mode - -
- string -
- 		-
    Choices: -
  • dot1q-tunnel
    • -
  • access
    • -
  • trunk
    • -
  • fex-fabric
    • -
  • fabricpath
    • -
- 		-
Mode in which interface needs to be configured.
-
Access mode is not shown in interface facts, so idempotency will not be maintained for switchport mode access and every time the output will come as changed=True.
-
-
- name - -
- string - / required -
- 		- -
Full name of interface, i.e. Ethernet1/1.
-
-
- trunk - -
- dictionary -
- 		- -
Switchport mode trunk command to configure the interface as a Layer-2 trunk.
-
-
- allowed_vlans - -
- string -
- 		- -
List of allowed VLANs in a given trunk port. These are the only VLANs that will be configured on the trunk.
-
-
- native_vlan - -
- integer -
- 		- -
Native VLAN to be configured in trunk port. It is used as the trunk native VLAN ID.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section ^interface.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state of the configuration after module completion.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOS 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # interface Ethernet1/2 - # switchport trunk native vlan 20 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - - name: Merge provided configuration with device configuration - cisco.nxos.nxos_l2_interfaces: - config: - - name: Ethernet1/1 - trunk: - native_vlan: 10 - allowed_vlans: 2,4,15 - - name: Ethernet1/2 - access: - vlan: 30 - state: merged - - # Task Output - # ----------- - # - # before: - # - name: Loopback999 - # - name: Ethernet1/2 - # - name: mgmt0 - # - name: Ethernet1/1 - # commands: - # - interface Ethernet1/1 - # - switchport trunk allowed vlan 2,4,15 - # - switchport trunk native vlan 10 - # - interface Ethernet1/2 - # - switchport access vlan 30 - # after: - # - name: Ethernet1/1 - # trunk: - # allowed_vlans: 2,4,15 - # native_vlan: 10 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - # - name: Loopback999 - - # After state: - # ------------ - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # switchport trunk native vlan 10 - # switchport trunk allowed vlans 2,4,15 - # interface Ethernet1/2 - # switchport access vlan 30 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - # Using replaced - - # Before state: - # ------------- - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # switchport trunk native vlan 10 - # switchport trunk allowed vlans 2,4,15 - # interface Ethernet1/2 - # switchport access vlan 30 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - - name: Replace device configuration of specified L2 interfaces with provided configuration. - cisco.nxos.nxos_l2_interfaces: - config: - - name: Ethernet1/1 - trunk: - native_vlan: 20 - allowed_vlans: 5-10, 15 - state: replaced - - # Task Output - # ----------- - # - # before: - # - name: Ethernet1/1 - # trunk: - # allowed_vlans: 2,4,15 - # native_vlan: 10 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - # commands: - # - interface Ethernet1/1 - # - no switchport trunk native vlan - # - switchport trunk allowed vlan 5-10,15 - # - switchport trunk native vlan 20 - # after: - # - name: Ethernet1/1 - # trunk: - # allowed_vlans: 5-10,15 - # native_vlan: 20 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - - # After state: - # ------------ - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # switchport trunk native vlan 20 - # switchport trunk allowed vlan 5-10,15 - # interface Ethernet1/2 - # switchport trunk native vlan 20 - # switchport mode trunk - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - # Using overridden - - # Before state: - # ------------- - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # switchport trunk native vlan 20 - # switchport trunk allowed vlan 5-10,15 - # interface Ethernet1/2 - # switchport trunk native vlan 20 - # switchport mode trunk - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - - name: Override device configuration with provided configuration. - cisco.nxos.nxos_l2_interfaces: - config: - - name: Ethernet1/2 - access: - vlan: 30 - state: overridden - - # Task Output - # ----------- - # - # before: - # - name: Ethernet1/1 - # trunk: - # allowed_vlans: 5,6,7,8,9,10,15 - # native_vlan: 20 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - # commands: - # - interface Ethernet1/1 - # - no switchport trunk allowed vlan - # - no switchport trunk native vlan - # after: - # - name: Ethernet1/1 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - - # After state: - # ------------ - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # interface Ethernet1/2 - # switchport access vlan 30 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - - # Using deleted - - # Before state: - # ------------- - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # switchport trunk native vlan 10 - # switchport trunk allowed vlan 2,4,15 - # interface Ethernet1/2 - # switchport access vlan 30 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - - name: Delete L2 attributes of given interfaces (Note This won't delete the interface - itself). - cisco.nxos.nxos_l2_interfaces: - config: - - name: Ethernet1/1 - - name: Ethernet1/2 - state: deleted - - # Task Output - # ----------- - # - # before: - # - name: Ethernet1/1 - # trunk: - # allowed_vlans: 2,4,15 - # native_vlan: 10 - # - access: - # vlan: 30 - # name: Ethernet1/2 - # - name: mgmt0 - # commands: - # - interface Ethernet1/1 - # - no switchport trunk allowed vlan - # - no switchport trunk native vlan - # - interface Ethernet1/2 - # - no switchport access vlan - # after: - # - name: Ethernet1/1 - # - name: Ethernet1/2 - # - name: mgmt0 - - # After state: - # ------------ - # - # switch# show running-config | section interface - # interface Ethernet1/1 - # interface Ethernet1/2 - # interface mgmt0 - # ip address dhcp - # ipv6 address auto-config - - # Using rendered - - - name: Render platform specific configuration lines (without connecting to the device) - cisco.nxos.nxos_l2_interfaces: - config: - - name: Ethernet1/1 - trunk: - native_vlan: 10 - allowed_vlans: 2,4,15 - - name: Ethernet1/2 - access: - vlan: 30 - - name: Ethernet1/3 - trunk: - native_vlan: 20 - allowed_vlans: 5-10, 15 - state: rendered - - # Task Output - # ----------- - # - # rendered: - # - interface Ethernet1/1 - # - switchport trunk allowed vlan 2,4,15 - # - switchport trunk native vlan 10 - # - interface Ethernet1/2 - # - switchport access vlan 30 - # - interface Ethernet1/3 - # - switchport trunk allowed vlan 5-10,15 - # - switchport trunk native vlan 20 - - # Using parsed - - # parsed.cfg - # ------------ - # - # interface Ethernet1/800 - # switchport access vlan 18 - # switchport trunk allowed vlan 210 - # interface Ethernet1/801 - # switchport trunk allowed vlan 2,4,15 - - - name: Use parsed state to convert externally supplied config to structured format - cisco.nxos.nxos_l2_interfaces: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output - # ----------- - # - # parsed: - # - name: Ethernet1/800 - # access: - # vlan: 18 - # trunk: - # allowed_vlans: "210" - # - name: Ethernet1/801 - # trunk: - # allowed_vlans: "2,4,15" - - # Using gathered - - # Before state: - # ------------- - # - # switch# sh running-config | section ^interface - # interface Ethernet1/1 - # switchport access vlan 6 - # switchport trunk allowed vlan 200 - # interface Ethernet1/2 - # switchport trunk native vlan 10 - - - name: Gather l2_interfaces facts from the device using nxos_l2_interfaces - cisco.nxos.nxos_l2_interfaces: - state: gathered - - # Task output - # ----------- - # - # gathered: - # - name: "Ethernet1/1" - # access: - # vlan: 6 - # trunk: - # allowed_vlans: "200" - # - name: "Ethernet1/2" - # trunk: - # native_vlan: 10 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/1', 'switchport trunk allowed vlan 2,4,15', 'switchport trunk native vlan 10', 'interface Ethernet1/2', 'switchport access vlan 30', 'interface Ethernet1/3', 'switchport trunk allowed vlan 5,6,7,8,9,10,15', 'switchport trunk native vlan 20']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_l3_interfaces_module.rst b/docs/cisco.nxos.nxos_l3_interfaces_module.rst deleted file mode 100644 index 28a56bdf8..000000000 --- a/docs/cisco.nxos.nxos_l3_interfaces_module.rst +++ /dev/null @@ -1,884 +0,0 @@ -.. _cisco.nxos.nxos_l3_interfaces_module: - - -***************************** -cisco.nxos.nxos_l3_interfaces -***************************** - -**L3 interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages Layer-3 interfaces attributes of NX-OS Interfaces. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A dictionary of Layer-3 interface options
-
-
- dot1q - -
- integer -
- 		- -
Configures IEEE 802.1Q VLAN encapsulation on a subinterface.
-
-
- evpn_multisite_tracking - -
- string -
-
added in 1.1.0
- 		-
    Choices: -
  • fabric-tracking
    • -
  • dci-tracking
    • -
- 		-
VxLAN evpn multisite Interface tracking. Supported only on selected model.
-
-
- ipv4 - -
- list - / elements=dictionary -
- 		- -
IPv4 address and attributes of the L3 interface.
-
-
- address - -
- string -
- 		- -
IPV4 address of the L3 interface.
-
-
- secondary - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
A boolean attribute to manage addition of secondary IP address.
-
-
- tag - -
- integer -
- 		- -
URIB route tag value for local/direct routes.
-
-
- ipv6 - -
- list - / elements=dictionary -
- 		- -
IPv6 address and attributes of the L3 interface.
-
-
- address - -
- string -
- 		- -
IPV6 address of the L3 interface.
-
-
- tag - -
- integer -
- 		- -
URIB route tag value for local/direct routes.
-
-
- ipv6_redirects - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/disables ipv6 redirects.
-
-
- name - -
- string - / required -
- 		- -
Full name of L3 interface, i.e. Ethernet1/1.
-
-
- redirects - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/disables ipv4 redirects.
-
-
- unreachables - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/disables ip redirects.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state of the configuration after module completion.
-
The state overridden would override the IP address configuration of all interfaces on the device with the provided configuration in the task. Use caution with this state as you may loose access to the device.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOS 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no shutdown - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - - name: Merge provided configuration with device configuration. - cisco.nxos.nxos_l3_interfaces: - config: - - name: Ethernet1/6 - ipv4: - - address: 192.168.1.1/24 - tag: 5 - - address: 10.1.1.1/24 - secondary: true - tag: 10 - ipv6: - - address: fd5d:12c9:2201:2::1/64 - tag: 6 - - name: Ethernet1/7.42 - redirects: false - unreachables: false - state: merged - - # Task Output - # ----------- - # - # before: - # - name: Ethernet1/6 - # - name: Ethernet1/7 - # - ipv4: - # - address: dhcp - # name: mgmt0 - # commands: - # - interface Ethernet1/6 - # - ip address 192.168.1.1/24 tag 5 - # - ip address 10.1.1.1/24 secondary tag 10 - # - ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - # - interface Ethernet1/7 - # - no ip redirects - # after: - # - ipv4: - # - address: 192.168.1.1/24 - # tag: 5 - # - address: 10.1.1.1/24 - # secondary: true - # tag: 10 - # ipv6: - # - address: fd5d:12c9:2201:2::1/64 - # tag: 6 - # name: Ethernet1/6 - # redirects: false - # - name: Ethernet1/7 - # redirects: false - # - ipv4: - # - address: dhcp - # name: mgmt0 - - # After state: - # ------------ - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no ip redirects - # ip address 192.168.1.1/24 tag 5 - # ip address 10.1.1.1/24 secondary tag 10 - # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no ip redirects - # no shutdown - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - - # Using replaced - - # Before state: - # ------------- - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no ip redirects - # ip address 192.168.1.1/24 tag 5 - # ip address 10.1.1.1/24 secondary tag 10 - # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no ip redirects - # no shutdown - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - - name: Replace device configuration of specified L3 interfaces with provided configuration. - cisco.nxos.nxos_l3_interfaces: - config: - - name: Ethernet1/6 - ipv4: - - address: 192.168.22.3/24 - state: replaced - - # Task Output - # ----------- - # - # before: - # - ipv4: - # - address: 192.168.1.1/24 - # tag: 5 - # - address: 10.1.1.1/24 - # secondary: true - # tag: 10 - # ipv6: - # - address: fd5d:12c9:2201:2::1/64 - # tag: 6 - # name: Ethernet1/6 - # redirects: false - # - name: Ethernet1/7 - # redirects: false - # - ipv4: - # - address: dhcp - # name: mgmt0 - # commands: - # - interface Ethernet1/6 - # - ip address 192.168.22.3/24 - # - no ipv6 address fd5d:12c9:2201:2::1/64 - # - ip redirects - # after: - # - ipv4: - # - address: 192.168.22.3/24 - # - address: 10.1.1.1/24 - # secondary: true - # tag: 10 - # name: Ethernet1/6 - # redirects: false - # - name: Ethernet1/7 - # redirects: false - # - ipv4: - # - address: dhcp - # name: mgmt0 - - # After state: - # ------------ - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no ip redirects - # ip address 192.168.22.3/24 - # ip address 10.1.1.1/24 secondary tag 10 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no ip redirects - # no shutdown - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - # Using overridden - - # Before state: - # ------------- - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no ip redirects - # ip address 192.168.1.1/24 tag 5 - # ip address 10.1.1.1/24 secondary tag 10 - # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no ip redirects - # no shutdown - # interface Ethernet1/7.42 - # no ip redirects - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - - name: Override device configuration with provided configuration. - cisco.nxos.nxos_l3_interfaces: - config: - - ipv4: - - address: dhcp - name: mgmt0 - - name: Ethernet1/6 - ipv4: - - address: 192.168.22.3/24 - state: overridden - - # Task Output - # ----------- - # - # before: - # - ipv4: - # - address: 192.168.1.1/24 - # tag: 5 - # - address: 10.1.1.1/24 - # secondary: true - # tag: 10 - # ipv6: - # - address: fd5d:12c9:2201:2::1/64 - # tag: 6 - # name: Ethernet1/6 - # redirects: false - # - name: Ethernet1/7 - # redirects: false - # - name: Ethernet1/7.42 - # redirects: false - # - ipv4: - # - address: dhcp - # name: mgmt0 - # commands: - # - interface Ethernet1/6 - # - no ipv6 address fd5d:12c9:2201:2::1/64 - # - no ip address 10.1.1.1/24 secondary - # - ip address 192.168.22.3/24 - # - ip redirects - # - interface Ethernet1/7 - # - ip redirects - # - interface Ethernet1/7.42 - # - ip redirects - # after: - # - ipv4: - # - address: 192.168.22.3/24 - # name: Ethernet1/6 - # - name: Ethernet1/7 - # - name: Ethernet1/7.42 - # - ipv4: - # - address: dhcp - # name: mgmt0 - - # After state: - # ------------ - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # ip address 192.168.22.3/24 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no shutdown - # interface Ethernet1/7.42 - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - # Using deleted - - # Before state: - # ------------- - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # ip address 192.168.22.3/24 - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no shutdown - # interface Ethernet1/7.42 - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - - name: Delete L3 attributes of given interfaces (This won't delete the interface - itself). - cisco.nxos.nxos_l3_interfaces: - config: - - name: Ethernet1/6 - - name: Ethernet1/2 - state: deleted - - # Task Output - # ----------- - # - # before: - # - name: Ethernet1/2 - # - ipv4: - # - address: 192.168.22.3/24 - # name: Ethernet1/6 - # - name: Ethernet1/7 - # - name: Ethernet1/7.42 - # - ipv4: - # - address: dhcp - # name: mgmt0 - # commands: - # - interface Ethernet1/6 - # - no ip address - # after: - # - name: Ethernet1/2 - # - name: Ethernet1/7 - # - name: Ethernet1/7.42 - # - ipv4: - # - address: dhcp - # name: mgmt0 - - # After state: - # ------------ - # - # router# show running-config | section interface - # interface Ethernet1/6 - # description Configured by Ansible Network - # no switchport - # no shutdown - # interface Ethernet1/7 - # description Configured by Ansible - # no switchport - # no shutdown - # interface Ethernet1/7.42 - # interface mgmt0 - # description mgmt interface - # ip address dhcp - # vrf member management - - # Using rendered - - - name: Use rendered state to convert task input to device specific commands - cisco.nxos.nxos_l3_interfaces: - config: - - name: Ethernet1/800 - ipv4: - - address: 192.168.1.100/24 - tag: 5 - - address: 10.1.1.1/24 - secondary: true - tag: 10 - - name: Ethernet1/800 - ipv6: - - address: fd5d:12c9:2201:2::1/64 - tag: 6 - state: rendered - - # Task Output - # ----------- - # - # rendered: - # - interface Ethernet1/800 - # - ip address 192.168.1.100/24 tag 5 - # - ip address 10.1.1.1/24 secondary tag 10 - # - interface Ethernet1/800 - # - ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - - # Using parsed - - # parsed.cfg - # ---------- - # - # interface Ethernet1/800 - # ip address 192.168.1.100/24 tag 5 - # ip address 10.1.1.1/24 secondary tag 10 - # no ip redirects - # interface Ethernet1/801 - # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 - # ip unreachables - # interface mgmt0 - # ip address dhcp - # vrf member management - - - name: Use parsed state to convert externally supplied config to structured format - cisco.nxos.nxos_l3_interfaces: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output - # ----------- - # - # parsed: - # - name: Ethernet1/800 - # ipv4: - # - address: 192.168.1.100/24 - # tag: 5 - # - address: 10.1.1.1/24 - # secondary: True - # tag: 10 - # redirects: False - # - name: Ethernet1/801 - # ipv6: - # - address: fd5d:12c9:2201:2::1/64 - # tag: 6 - # unreachables: True - - # Using gathered - - # Before state: - # ------------- - # - # interface Ethernet1/1 - # ip address 192.0.2.100/24 - # interface Ethernet1/2 - # no ip redirects - # ip address 203.0.113.10/24 - # ip unreachables - # ipv6 address 2001:db8::1/32 - - - name: Gather l3_interfaces facts from the device using nxos_l3_interfaces - cisco.nxos.nxos_l3_interfaces: - state: gathered - - # Task output - # ----------- - # - # gathered: - # - name: Ethernet1/1 - # ipv4: - # - address: 192.0.2.100/24 - # - name: Ethernet1/2 - # ipv4: - # - address: 203.0.113.10/24 - # ipv6: - # - address: 2001:db8::1/32 - # redirects: False - # unreachables: True - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/2', 'ip address 192.168.0.1/2']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_lacp_module.rst b/docs/cisco.nxos.nxos_lacp_module.rst deleted file mode 100644 index b0410c783..000000000 --- a/docs/cisco.nxos.nxos_lacp_module.rst +++ /dev/null @@ -1,402 +0,0 @@ -.. _cisco.nxos.nxos_lacp_module: - - -******************** -cisco.nxos.nxos_lacp -******************** - -**LACP resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages Global Link Aggregation Control Protocol (LACP) on NX-OS devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
LACP global options.
-
-
- system - -
- dictionary -
- 		- -
LACP system options
-
-
- mac - -
- dictionary -
- 		- -
MAC address to be used for the LACP Protocol exchanges
-
-
- address - -
- string -
- 		- -
MAC-address (FORMAT :xxxx.xxxx.xxxx).
-
-
- role - -
- string -
- 		-
    Choices: -
  • primary
    • -
  • secondary
    • -
- 		-
The role for the Switch.
-
-
- priority - -
- integer -
- 		- -
The system priority to use in LACP negotiations.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | include lacp.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state of the configuration after module completion.
-
States replaced and overridden have the same behaviour for this module.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOS 7.3.(0)D1(1) on VIRL. - - Unsupported for Cisco MDS - - Feature lacp should be enabled for this module. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # - - - name: Merge provided configuration with device configuration. - cisco.nxos.nxos_lacp: - config: - system: - priority: 10 - mac: - address: 00c1.4c00.bd15 - state: merged - - # After state: - # ------------ - # - # lacp system-priority 10 - # lacp system-mac 00c1.4c00.bd15 - - - # Using replaced - - # Before state: - # ------------- - # - # lacp system-priority 10 - - - name: Replace device global lacp configuration with the given configuration. - cisco.nxos.nxos_lacp: - config: - system: - mac: - address: 00c1.4c00.bd15 - state: replaced - - # After state: - # ------------ - # - # lacp system-mac 00c1.4c00.bd15 - - - # Using deleted - - # Before state: - # ------------- - # - # lacp system-priority 10 - - - name: Delete global LACP configurations. - cisco.nxos.nxos_lacp: - state: deleted - - # After state: - # ------------ - # - - # Using rendered - - - name: Render platform specific configuration lines (without connecting to the device) - cisco.nxos.nxos_lacp: - config: - system: - priority: 10 - mac: - address: 00c1.4c00.bd15 - role: secondary - state: rendered - - # Task Output (redacted) - # ----------------------- - - # rendered: - # - "lacp system-priority 10" - # - "lacp system-mac 00c1.4c00.bd15 role secondary" - - # Using parsed - - # parsed.cfg - # ------------ - # lacp system-priority 10 - # lacp system-mac 00c1.4c00.bd15 role secondary - - - name: Use parsed state to convert externally supplied config to structured format - cisco.nxos.nxos_lacp: - running_config: "{{ lookup('file', 'parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # system: - # priority: 10 - # mac: - # address: 00c1.4c00.bd15 - # role: secondary - - # Using gathered - - # Existing device config state - # ------------------------------- - # Nexus9000v# show running-config | include lacp - # lacp system-priority 11 - # lacp system-mac 00c1.4c00.bd15 role primary - - - name: Gather lacp facts from the device using nxos_lacp - cisco.nxos.nxos_lacp: - state: gathered - - # Task output (redacted) - # ----------------------- - # gathered: - # system: - # priority: 11 - # mac: - # address: 00c1.4c00.bd15 - # role: primary - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['lacp system-priority 15', 'lacp system-mac 00c1.4c00.bd15 role primary']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_lldp_interfaces_module.rst b/docs/cisco.nxos.nxos_lldp_interfaces_module.rst deleted file mode 100644 index d634e9aa4..000000000 --- a/docs/cisco.nxos.nxos_lldp_interfaces_module.rst +++ /dev/null @@ -1,407 +0,0 @@ -.. _cisco.nxos.nxos_lldp_interfaces_module: - - -******************************* -cisco.nxos.nxos_lldp_interfaces -******************************* - -**LLDP interfaces resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages interfaces' configuration for Link Layer Discovery Protocol (LLDP) on NX-OS platforms. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of link layer discovery configurations for interfaces.
-
-
- name - -
- string - / required -
- 		- -
Name of the interface
-
-
- receive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Used to enable or disable the reception of LLDP packets on that interface. By default, this is enabled after LLDP is enabled globally.
-
-
- tlv_set - -
- dictionary -
- 		- -
Used to configure TLV parameters on the interface
-
-
- management_address - -
- string -
- 		- -
Used to mention the IPv4 or IPv6 management address for the interface
-
-
- vlan - -
- integer -
- 		- -
Used to mention the VLAN for the interface
-
-
- transmit - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Used to enable or disable the transmission of LLDP packets on that interface. By default, this is enabled after LLDP is enabled globally.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section ^interface.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOS 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - The LLDP feature needs to be enabled before using this module - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # - - - name: Merge provided configuration with device configuration - cisco.nxos.nxos_lldp_interfaces: - config: - - name: Ethernet1/4 - receive: false - transmit: true - tlv_set: - management_address: 192.168.122.64 - vlan: 12 - state: merged - - # After state: - # ------------- - # - # interface Ethernet1/4 - # no lldp receive - # lldp tlv-set management-address 192.168.122.64 - # lldp tlv-set vlan 12 - - - # Using replaced - - # Before state: - # ------------ - # - # interface Ethernet1/4 - # no lldp receive - # lldp tlv-set management-address 192.168.122.64 - # interface Ethernet1/5 - # no lldp transmit - # lldp tlv-set vlan 10 - - - name: Replace LLDP configuration on interfaces with given configuration - cisco.nxos.nxos_lldp_interfaces: - config: - - name: Ethernet1/4 - transmit: false - tlv_set: - vlan: 2 - state: replaced - - - # After state: - # ----------- - # - # interface Ethernet1/4 - # no lldp transmit - # lldp tlv_set vlan 2 - # interface Ethernet1/5 - # no lldp transmit - # lldp tlv-set vlan 10 - - - # Using overridden - - # Before state: - # ------------ - # - # interface Ethernet1/4 - # no lldp receive - # lldp tlv-set management-address 192.168.122.64 - # interface Ethernet1/5 - # no lldp transmit - # lldp tlv-set vlan 10 - - - name: Override LLDP configuration on all interfaces with given configuration - cisco.nxos.nxos_lldp_interfaces: - config: - - name: Ethernet1/7 - receive: false - tlv_set: - vlan: 12 - state: overridden - - - # After state: - # ----------- - # - # interface Ethernet1/7 - # no lldp receive - # lldp tlv_set vlan 12 - - - # Using deleted - - # Before state: - # ------------ - # - # interface Ethernet1/4 - # lldp tlv-set management vlan 24 - # no lldp transmit - # interface mgmt0 - # no lldp receive - - - name: Delete LLDP interfaces configuration - cisco.nxos.nxos_lldp_interfaces: - state: deleted - - # After state: - # ------------ - # - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/2', 'lldp receive', 'lldp tlv-set vlan 12']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_logging_module.rst b/docs/cisco.nxos.nxos_logging_module.rst deleted file mode 100644 index 9dafd8e33..000000000 --- a/docs/cisco.nxos.nxos_logging_module.rst +++ /dev/null @@ -1,458 +0,0 @@ -.. _cisco.nxos.nxos_logging_module: - - -*********************** -cisco.nxos.nxos_logging -*********************** - -**Manage logging on network devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2023-08-01 -:Why: Updated module released with more functionality. -:Alternative: nxos_logging_global - - - -Synopsis --------- -- This module provides declarative management of logging on Cisco NX-OS devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
List of logging definitions.
-
-
- dest - -
- string -
- 		-
    Choices: -
  • console
    • -
  • logfile
    • -
  • module
    • -
  • monitor
    • -
  • server
    • -
- 		-
Destination of the logs.
-
-
- dest_level - -
- integer -
- 		- -
Set logging severity levels.
-

aliases: level
-
-
- event - -
- string -
- 		-
    Choices: -
  • link-enable
    • -
  • link-default
    • -
  • trunk-enable
    • -
  • trunk-default
    • -
- 		-
Link/trunk enable/default interface configuration logging
-
-
- facility - -
- string -
- 		- -
Facility name for logging.
-
-
- facility_level - -
- integer -
- 		- -
Set logging severity levels for facility based log messages.
-
-
- facility_link_status - -
- string -
- 		-
    Choices: -
  • link-down-notif
    • -
  • link-down-error
    • -
  • link-up-notif
    • -
  • link-up-error
    • -
- 		-
Set logging facility ethpm link status. Not idempotent with version 6.0 images.
-
-
- file_size - -
- integer -
- 		- -
Set logfile size
-
-
- interface - -
- string -
- 		- -
Interface to be used while configuring source-interface for logging (e.g., 'Ethernet1/2', 'mgmt0')
-
-
- interface_message - -
- string -
- 		-
    Choices: -
  • add-interface-description
    • -
- 		-
Add interface description to interface syslogs. Does not work with version 6.0 images using nxapi as a transport.
-
-
- name - -
- string -
- 		- -
If value of dest is logfile it indicates file-name.
-
-
- purge - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Remove any switch logging configuration that does not match what has been configured Not supported for ansible_connection local. All nxos_logging tasks must use the same ansible_connection type.
-
-
- remote_server - -
- string -
- 		- -
Hostname or IP Address for remote logging (when dest is 'server').
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
State of the logging configuration.
-
-
- timestamp - -
- string -
- 		-
    Choices: -
  • microseconds
    • -
  • milliseconds
    • -
  • seconds
    • -
- 		-
Set logging timestamp format
-
-
- use_vrf - -
- string -
- 		- -
VRF to be used while configuring remote logging (when dest is 'server').
-
-
- - -Notes ------ - -.. note:: - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: configure console logging with level - cisco.nxos.nxos_logging: - dest: console - level: 2 - state: present - - name: remove console logging configuration - cisco.nxos.nxos_logging: - dest: console - level: 2 - state: absent - - name: configure file logging with level - cisco.nxos.nxos_logging: - dest: logfile - name: testfile - dest_level: 3 - state: present - - name: Configure logging logfile with size - cisco.nxos.nxos_logging: - dest: logfile - name: testfile - dest_level: 3 - file_size: 16384 - - name: configure facility level logging - cisco.nxos.nxos_logging: - facility: daemon - facility_level: 0 - state: present - - name: remove facility level logging - cisco.nxos.nxos_logging: - facility: daemon - facility_level: 0 - state: absent - - name: Configure Remote Logging - cisco.nxos.nxos_logging: - dest: server - remote_server: test-syslogserver.com - facility: auth - facility_level: 1 - use_vrf: management - state: present - - name: Configure Source Interface for Logging - cisco.nxos.nxos_logging: - interface: mgmt0 - state: present - - name: Purge nxos_logging configuration not managed by this playbook - cisco.nxos.nxos_logging: - purge: true - - name: Configure logging timestamp - cisco.nxos.nxos_logging: - timestamp: milliseconds - state: present - - name: Configure logging facility ethpm link status - cisco.nxos.nxos_logging: - facility: ethpm - facility_link_status: link-up-notif - state: present - - name: Configure logging message ethernet description - cisco.nxos.nxos_logging: - interface_message: add-interface-description - state: present - - name: Configure logging event link enable - cisco.nxos.nxos_logging: - event: link-enable - state: present - - name: Configure logging using aggregate - cisco.nxos.nxos_logging: - aggregate: - - {dest: console, dest_level: 2} - - {dest: logfile, dest_level: 2, name: testfile} - - {facility: daemon, facility_level: 0} - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['logging console 2', 'logging logfile testfile 3', 'logging level daemon 0']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2023-08-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_ntp_auth_module.rst b/docs/cisco.nxos.nxos_ntp_auth_module.rst deleted file mode 100644 index c825cd017..000000000 --- a/docs/cisco.nxos.nxos_ntp_auth_module.rst +++ /dev/null @@ -1,224 +0,0 @@ -.. _cisco.nxos.nxos_ntp_auth_module: - - -************************ -cisco.nxos.nxos_ntp_auth -************************ - -**Manages NTP authentication.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated module released with more functionality. -:Alternative: nxos_ntp_global - - - -Synopsis --------- -- Manages NTP authentication. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- auth_type - -
- string -
- 		-
    Choices: -
  • text ←
    • -
  • encrypt
    • -
- 		-
Whether the given md5string is in cleartext or has been encrypted. If in cleartext, the device will encrypt it before storing it.
-
-
- authentication - -
- string -
- 		-
    Choices: -
  • on
    • -
  • off
    • -
- 		-
Turns NTP authentication on or off.
-
-
- key_id - -
- string -
- 		- -
Authentication key identifier (numeric).
-
-
- md5string - -
- string -
- 		- -
MD5 String.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- trusted_key - -
- string -
- 		-
    Choices: -
  • false ←
    • -
  • true
    • -
- 		-
Whether the given key is required to be supplied by a time source for the device to synchronize to the time source.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - If ``state=absent``, the module will remove the given key configuration if it exists. - - If ``state=absent`` and ``authentication=on``, authentication will be turned off. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Basic NTP authentication configuration - - cisco.nxos.nxos_ntp_auth: - key_id: 32 - md5string: hello - auth_type: text - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['ntp authentication-key 32 md5 helloWorld 0', 'ntp trusted-key 32']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_ntp_global_module.rst b/docs/cisco.nxos.nxos_ntp_global_module.rst deleted file mode 100644 index b77fc9440..000000000 --- a/docs/cisco.nxos.nxos_ntp_global_module.rst +++ /dev/null @@ -1,1411 +0,0 @@ -.. _cisco.nxos.nxos_ntp_global_module: - - -************************** -cisco.nxos.nxos_ntp_global -************************** - -**NTP Global resource module.** - - -Version added: 2.6.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages ntp configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A dict of ntp configuration.
-
-
- access_group - -
- dictionary -
- 		- -
NTP access-group.
-
This option is unsupported on MDS switches.
-
-
- match_all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Scan ACLs present in all ntp access groups.
-
-
- peer - -
- list - / elements=dictionary -
- 		- -
Access-group peer.
-
-
- access_list - -
- string -
- 		- -
Name of access list.
-
-
- query_only - -
- list - / elements=dictionary -
- 		- -
Access-group query-only.
-
-
- access_list - -
- string -
- 		- -
Name of access list.
-
-
- serve - -
- list - / elements=dictionary -
- 		- -
Access-group serve.
-
-
- access_list - -
- string -
- 		- -
Name of access list.
-
-
- serve_only - -
- list - / elements=dictionary -
- 		- -
Access-group serve-only.
-
-
- access_list - -
- string -
- 		- -
Name of access list.
-
-
- allow - -
- dictionary -
- 		- -
Enable/Disable the packets.
-
-
- control - -
- dictionary -
- 		- -
Control mode packets.
-
-
- rate_limit - -
- integer -
- 		- -
Rate-limit delay.
-
-
- private - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable Private mode packets.
-
-
- authenticate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable authentication.
-
-
- authentication_keys - -
- list - / elements=dictionary -
- 		- -
NTP authentication key.
-
-
- encryption - -
- integer -
- 		- -
0 for Clear text
-
7 for Encrypted
-
-
- id - -
- integer -
- 		- -
Authentication key number (range 1-65535).
-
-
- key - -
- string -
- 		- -
Authentication key.
-
-
- logging - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable logging of NTPD Events.
-
-
- master - -
- dictionary -
- 		- -
Act as NTP master clock.
-
This option is unsupported on MDS switches.
-
-
- stratum - -
- integer -
- 		- -
Stratum number.
-
-
- passive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
NTP passive command.
-
This option is unsupported on MDS switches.
-
-
- peers - -
- list - / elements=dictionary -
- 		- -
NTP Peers.
-
-
- key_id - -
- integer -
- 		- -
Keyid to be used while communicating to this server.
-
-
- maxpoll - -
- integer -
- 		- -
Maximum interval to poll a peer.
-
Poll interval in secs to a power of 2.
-
-
- minpoll - -
- integer -
- 		- -
Minimum interval to poll a peer.
-
Poll interval in secs to a power of 2.
-
-
- peer - -
- string -
- 		- -
Hostname/IP address of the NTP Peer.
-
-
- prefer - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Preferred Server.
-
-
- vrf - -
- string -
- 		- -
Display per-VRF information.
-
This option is unsupported on MDS switches.
-

aliases: use_vrf
-
-
- servers - -
- list - / elements=dictionary -
- 		- -
NTP servers.
-
-
- key_id - -
- integer -
- 		- -
Keyid to be used while communicating to this server.
-
-
- maxpoll - -
- integer -
- 		- -
Maximum interval to poll a peer.
-
Poll interval in secs to a power of 2.
-
-
- minpoll - -
- integer -
- 		- -
Minimum interval to poll a peer.
-
Poll interval in secs to a power of 2.
-
-
- prefer - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Preferred Server.
-
-
- server - -
- string -
- 		- -
Hostname/IP address of the NTP Peer.
-
-
- vrf - -
- string -
- 		- -
Display per-VRF information.
-
This option is not applicable for MDS switches.
-

aliases: use_vrf
-
-
- source - -
- string -
- 		- -
Source of NTP packets.
-
This option is unsupported on MDS switches.
-
-
- source_interface - -
- string -
- 		- -
Source interface sending NTP packets.
-
-
- trusted_keys - -
- list - / elements=dictionary -
- 		- -
NTP trusted-key number.
-
-
- key_id - -
- integer -
- 		- -
Trusted-Key number.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config ntp.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
The states replaced and overridden have identical behaviour for this module.
-
Please refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6 on Cisco Nexus Switches. - - This module works with connection ``network_cli`` and ``httpapi``. - - Tested against Cisco MDS NX-OS 9.2(2) with connection ``network_cli``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k-rdo# show running-config ntp - # nxos-9k-rdo# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_ntp_global: &id001 - config: - access_group: - peer: - - access_list: PeerAcl1 - serve: - - access_list: ServeAcl1 - authenticate: true - authentication_keys: - - id: 1001 - key: vagwwtKfkv - encryption: 7 - - id: 1002 - key: vagwwtKfkvgthz - encryption: 7 - logging: true - master: - stratum: 2 - peers: - - peer: 192.0.2.1 - key_id: 1 - maxpoll: 15 - minpoll: 5 - vrf: default - - peer: 192.0.2.2 - key_id: 2 - prefer: true - vrf: siteA - servers: - - server: 198.51.100.1 - key_id: 2 - vrf: default - - server: 203.0.113.1 - key_id: 1 - vrf: siteB - - # Task output - # ------------- - # before: {} - # - # commands: - # - "ntp authenticate" - # - "ntp logging" - # - "ntp master 2" - # - "ntp authentication-keys 1001 md5 vagwwtKfkv 7" - # - "ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" - # - "ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" - # - "ntp peer 192.0.2.2 prefer use-vrf siteA key 2" - # - "ntp server 198.51.100.1 use-vrf default key 2" - # - "ntp server 203.0.113.1 use-vrf siteB key 1" - # - "ntp access-group peer PeerAcl1" - # - "ntp access-group serve ServeAcl1" - # - # after: - # access_group: - # peer: - # - access_list: PeerAcl1 - # serve: - # - access_list: ServeAcl1 - # authenticate: true - # authentication_keys: - # - id: 1001 - # key: vagwwtKfkv - # encryption: 7 - # - id: 1002 - # key: vagwwtKfkvgthz - # encryption: 7 - # logging: true - # master: - # stratum: 2 - # peers: - # - peer: 192.0.2.1 - # key_id: 1 - # maxpoll: 15 - # minpoll: 5 - # vrf: default - # - peer: 192.0.2.2 - # key_id: 2 - # prefer: true - # vrf: siteA - # servers: - # - server: 198.51.100.1 - # key_id: 2 - # vrf: default - # - server: 203.0.113.1 - # key_id: 1 - # vrf: siteB - - # After state: - # ------------ - # nxos-9k-rdo# show running-config ntp - # ntp authenticate - # ntp logging - # ntp master 2 - # ntp authentication-keys 1001 md5 vagwwtKfkv 7 - # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 - # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 - # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 - # ntp server 198.51.100.1 use-vrf default key 2 - # ntp server 203.0.113.1 use-vrf siteB key 1 - # ntp access-group peer PeerAcl1 - # ntp access-group serve ServeAcl1 - - # Using replaced - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config ntp - # ntp authenticate - # ntp logging - # ntp master 2 - # ntp authentication-keys 1001 md5 vagwwtKfkv 7 - # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 - # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 - # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 - # ntp server 198.51.100.1 use-vrf default key 2 - # ntp server 203.0.113.1 use-vrf siteB key 1 - # ntp access-group peer PeerAcl1 - # ntp access-group serve ServeAcl1 - - - name: Replace logging global configurations of listed logging global with provided configurations - cisco.nxos.nxos_ntp_global: - config: - access_group: - peer: - - access_list: PeerAcl2 - serve: - - access_list: ServeAcl2 - logging: true - master: - stratum: 2 - peers: - - peer: 192.0.2.1 - key_id: 1 - maxpoll: 15 - minpoll: 5 - vrf: default - - peer: 192.0.2.5 - key_id: 2 - prefer: true - vrf: siteA - servers: - - server: 198.51.100.1 - key_id: 2 - vrf: default - state: replaced - - # Task output - # ------------- - # before: - # access_group: - # peer: - # - access_list: PeerAcl1 - # serve: - # - access_list: ServeAcl1 - # authenticate: true - # authentication_keys: - # - id: 1001 - # key: vagwwtKfkv - # encryption: 7 - # - id: 1002 - # key: vagwwtKfkvgthz - # encryption: 7 - # logging: true - # master: - # stratum: 2 - # peers: - # - peer: 192.0.2.1 - # key_id: 1 - # maxpoll: 15 - # minpoll: 5 - # vrf: default - # - peer: 192.0.2.2 - # key_id: 2 - # prefer: true - # vrf: siteA - # servers: - # - server: 198.51.100.1 - # key_id: 2 - # vrf: default - # - server: 203.0.113.1 - # key_id: 1 - # vrf: siteB - # - # commands: - # - "no ntp authenticate" - # - "no ntp authentication-keys 1001 md5 vagwwtKfkv 7" - # - "no ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" - # - "ntp peer 192.0.2.5 prefer use-vrf siteA key 2" - # - "no ntp peer 192.0.2.2 prefer use-vrf siteA key 2" - # - "no ntp server 203.0.113.1 use-vrf siteB key 1" - # - "ntp access-group peer PeerAcl2" - # - "no ntp access-group peer PeerAcl1" - # - "ntp access-group serve ServeAcl2" - # - "no ntp access-group serve ServeAcl1" - # - # after: - # access_group: - # peer: - # - access_list: PeerAcl2 - # serve: - # - access_list: ServeAcl2 - # logging: true - # master: - # stratum: 2 - # peers: - # - peer: 192.0.2.1 - # key_id: 1 - # maxpoll: 15 - # minpoll: 5 - # vrf: default - # - peer: 192.0.2.5 - # key_id: 2 - # prefer: true - # vrf: siteA - # servers: - # - server: 198.51.100.1 - # key_id: 2 - # vrf: default - - # After state: - # ------------ - # nxos-9k-rdo# show running-config ntp - # ntp logging - # ntp master 2 - # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 - # ntp peer 192.0.2.5 prefer use-vrf siteA key 2 - # ntp server 198.51.100.1 use-vrf default key 2 - # ntp access-group peer PeerAcl2 - # ntp access-group serve ServeAcl2 - - # Using deleted to delete all logging configurations - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config ntp - - - name: Delete all logging configuration - cisco.nxos.nxos_ntp_global: - state: deleted - - # Task output - # ------------- - # before: - # access_group: - # peer: - # - access_list: PeerAcl1 - # serve: - # - access_list: ServeAcl1 - # authenticate: true - # authentication_keys: - # - id: 1001 - # key: vagwwtKfkv - # encryption: 7 - # - id: 1002 - # key: vagwwtKfkvgthz - # encryption: 7 - # logging: true - # master: - # stratum: 2 - # peers: - # - peer: 192.0.2.1 - # key_id: 1 - # maxpoll: 15 - # minpoll: 5 - # vrf: default - # - peer: 192.0.2.2 - # key_id: 2 - # prefer: true - # vrf: siteA - # servers: - # - server: 198.51.100.1 - # key_id: 2 - # vrf: default - # - server: 203.0.113.1 - # key_id: 1 - # vrf: siteB - # - # commands: - # - "no ntp authenticate" - # - "no ntp logging" - # - "no ntp master 2" - # - "no ntp authentication-keys 1001 md5 vagwwtKfkv 7" - # - "no ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" - # - "no ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" - # - "no ntp peer 192.0.2.2 prefer use-vrf siteA key 2" - # - "no ntp server 198.51.100.1 use-vrf default key 2" - # - "no ntp server 203.0.113.1 use-vrf siteB key 1" - # - "no ntp access-group peer PeerAcl1" - # - "no ntp access-group serve ServeAcl1" - # - # after: {} - - # After state: - # ------------ - # nxos-9k-rdo# show running-config ntp - # nxos-9k-rdo# - - # Using rendered - - - name: Render platform specific configuration lines with state rendered (without connecting to the device) - cisco.nxos.nxos_ntp_global: - config: - access_group: - peer: - - access_list: PeerAcl1 - serve: - - access_list: ServeAcl1 - authenticate: true - authentication_keys: - - id: 1001 - key: vagwwtKfkv - encryption: 7 - - id: 1002 - key: vagwwtKfkvgthz - encryption: 7 - logging: true - master: - stratum: 2 - peers: - - peer: 192.0.2.1 - key_id: 1 - maxpoll: 15 - minpoll: 5 - vrf: default - - peer: 192.0.2.2 - key_id: 2 - prefer: true - vrf: siteA - servers: - - server: 198.51.100.1 - key_id: 2 - vrf: default - - server: 203.0.113.1 - key_id: 1 - vrf: siteB - state: rendered - - # Task Output (redacted) - # ----------------------- - # rendered: - # - "ntp authenticate" - # - "ntp logging" - # - "ntp master 2" - # - "ntp authentication-keys 1001 md5 vagwwtKfkv 7" - # - "ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" - # - "ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" - # - "ntp peer 192.0.2.2 prefer use-vrf siteA key 2" - # - "ntp server 198.51.100.1 use-vrf default key 2" - # - "ntp server 203.0.113.1 use-vrf siteB key 1" - # - "ntp access-group peer PeerAcl1" - # - "ntp access-group serve ServeAcl1" - - # Using parsed - - # parsed.cfg - # ------------ - # ntp authenticate - # ntp logging - # ntp master 2 - # ntp authentication-keys 1001 md5 vagwwtKfkv 7 - # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 - # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 - # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 - # ntp server 198.51.100.1 use-vrf default key 2 - # ntp server 203.0.113.1 use-vrf siteB key 1 - # ntp access-group peer PeerAcl1 - # ntp access-group serve ServeAcl1 - - - name: Parse externally provided ntp configuration - cisco.nxos.nxos_ntp_global: - running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # access_group: - # peer: - # - access_list: PeerAcl1 - # serve: - # - access_list: ServeAcl1 - # authenticate: true - # authentication_keys: - # - id: 1001 - # key: vagwwtKfkv - # encryption: 7 - # - id: 1002 - # key: vagwwtKfkvgthz - # encryption: 7 - # logging: true - # master: - # stratum: 2 - # peers: - # - peer: 192.0.2.1 - # key_id: 1 - # maxpoll: 15 - # minpoll: 5 - # vrf: default - # - peer: 192.0.2.2 - # key_id: 2 - # prefer: true - # vrf: siteA - # servers: - # - server: 198.51.100.1 - # key_id: 2 - # vrf: default - # - server: 203.0.113.1 - # key_id: 1 - # vrf: siteB - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['ntp master stratum 2', 'ntp peer 198.51.100.1 use-vrf test maxpoll 7', 'ntp authentication-key 10 md5 wawyhanx2 7', 'ntp access-group peer PeerAcl1', 'ntp access-group peer PeerAcl2', 'ntp access-group query-only QueryAcl1']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['ntp master stratum 2', 'ntp peer 198.51.100.1 use-vrf test maxpoll 7', 'ntp authentication-key 10 md5 wawyhanx2 7', 'ntp access-group peer PeerAcl1', 'ntp access-group peer PeerAcl2', 'ntp access-group query-only QueryAcl1']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_ntp_module.rst b/docs/cisco.nxos.nxos_ntp_module.rst deleted file mode 100644 index 3fa835a96..000000000 --- a/docs/cisco.nxos.nxos_ntp_module.rst +++ /dev/null @@ -1,314 +0,0 @@ -.. _cisco.nxos.nxos_ntp_module: - - -******************* -cisco.nxos.nxos_ntp -******************* - -**Manages core NTP configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated module released with more functionality. -:Alternative: nxos_ntp_global - - - -Synopsis --------- -- Manages core NTP configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- key_id - -
- string -
- 		- -
Authentication key identifier to use with given NTP server or peer or keyword 'default'.
-
-
- peer - -
- string -
- 		- -
Network address of NTP peer.
-
-
- prefer - -
- string -
- 		-
    Choices: -
  • enabled
    • -
  • disabled
    • -
- 		-
Makes given NTP server or peer the preferred NTP server or peer for the device.
-
-
- server - -
- string -
- 		- -
Network address of NTP server.
-
-
- source_addr - -
- string -
- 		- -
Local source address from which NTP messages are sent or keyword 'default'.
-
-
- source_int - -
- string -
- 		- -
Local source interface from which NTP messages are sent. Must be fully qualified interface name or keyword 'default'
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- vrf_name - -
- string -
- 		- -
Makes the device communicate with the given NTP server or peer over a specific VRF or keyword 'default'.
-
-
- - -Notes ------ - -.. note:: - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Set NTP Server with parameters - - cisco.nxos.nxos_ntp: - server: 1.2.3.4 - key_id: 32 - prefer: enabled - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- end_state - -
- dictionary -
- 		always -
k/v pairs of ntp info after module execution
-
-
Sample:
-
{'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'server', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'source'}
-
-
- existing - -
- dictionary -
- 		always -
k/v pairs of existing ntp server/peer
-
-
Sample:
-
{'address': '192.0.2.2', 'key_id': '32', 'peer_type': 'server', 'prefer': 'enabled', 'source': 'ethernet2/1', 'source_type': 'source-interface'}
-
-
- proposed - -
- dictionary -
- 		always -
k/v pairs of parameters passed into module
-
-
Sample:
-
{'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'server', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'source'}
-
-
- updates - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['ntp server 192.0.2.2 prefer key 48', 'no ntp source-interface ethernet2/1', 'ntp source 192.0.2.3']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_ntp_options_module.rst b/docs/cisco.nxos.nxos_ntp_options_module.rst deleted file mode 100644 index e99825641..000000000 --- a/docs/cisco.nxos.nxos_ntp_options_module.rst +++ /dev/null @@ -1,192 +0,0 @@ -.. _cisco.nxos.nxos_ntp_options_module: - - -*************************** -cisco.nxos.nxos_ntp_options -*************************** - -**Manages NTP options.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated module released with more functionality. -:Alternative: nxos_ntp_global - - - -Synopsis --------- -- Manages NTP options, e.g. authoritative server and logging. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- logging - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Sets whether NTP logging is enabled on the device.
-
-
- master - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Sets whether the device is an authoritative NTP server.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- stratum - -
- string -
- 		- -
If master=true, an optional stratum can be supplied (1-15). The device default is 8.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - When ``state=absent``, master and logging will be set to False and stratum will be removed as well - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Basic NTP options configuration - - cisco.nxos.nxos_ntp_options: - master: true - stratum: 12 - logging: false - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- updates - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['no ntp logging', 'ntp master 12']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_nxapi_module.rst b/docs/cisco.nxos.nxos_nxapi_module.rst deleted file mode 100644 index 182fe1516..000000000 --- a/docs/cisco.nxos.nxos_nxapi_module.rst +++ /dev/null @@ -1,300 +0,0 @@ -.. _cisco.nxos.nxos_nxapi_module: - - -********************* -cisco.nxos.nxos_nxapi -********************* - -**Manage NXAPI configuration on an NXOS device.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configures the NXAPI feature on devices running Cisco NXOS. The NXAPI feature is absent from the configuration by default. Since this module manages the NXAPI feature it only supports the use of the ``Cli`` transport. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- http - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Controls the operating state of the HTTP protocol as one of the underlying transports for NXAPI. By default, NXAPI will enable the HTTP transport when the feature is first configured. To disable the use of the HTTP transport, set the value of this argument to False.
-

aliases: enable_http
-
-
- http_port - -
- integer -
- 		- Default:
80
- 		-
Configure the port with which the HTTP server will listen on for requests. By default, NXAPI will bind the HTTP service to the standard HTTP port 80. This argument accepts valid port values in the range of 1 to 65535.
-
-
- https - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Controls the operating state of the HTTPS protocol as one of the underlying transports for NXAPI. By default, NXAPI will disable the HTTPS transport when the feature is first configured. To enable the use of the HTTPS transport, set the value of this argument to True.
-

aliases: enable_https
-
-
- https_port - -
- integer -
- 		- Default:
443
- 		-
Configure the port with which the HTTPS server will listen on for requests. By default, NXAPI will bind the HTTPS service to the standard HTTPS port 443. This argument accepts valid port values in the range of 1 to 65535.
-
-
- sandbox - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
The NXAPI feature provides a web base UI for developers for entering commands. This feature is initially disabled when the NXAPI feature is configured for the first time. When the sandbox argument is set to True, the developer sandbox URL will accept requests and when the value is set to False, the sandbox URL is unavailable. This is supported on NX-OS 7K series.
-

aliases: enable_sandbox
-
-
- ssl_strong_ciphers - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Controls the use of whether strong or weak ciphers are configured. By default, this feature is disabled and weak ciphers are configured. To enable the use of strong ciphers, set the value of this argument to True.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
The state argument controls whether or not the NXAPI feature is configured on the remote device. When the value is present the NXAPI feature configuration is present in the device running-config. When the values is absent the feature configuration is removed from the running-config.
-
-
- tlsv1_0 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Controls the use of the Transport Layer Security version 1.0 is configured. By default, this feature is enabled. To disable the use of TLSV1.0, set the value of this argument to True.
-
-
- tlsv1_1 - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Controls the use of the Transport Layer Security version 1.1 is configured. By default, this feature is disabled. To enable the use of TLSV1.1, set the value of this argument to True.
-
-
- tlsv1_2 - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Controls the use of the Transport Layer Security version 1.2 is configured. By default, this feature is disabled. To enable the use of TLSV1.2, set the value of this argument to True.
-
-
- - -Notes ------ - -.. note:: - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Enable NXAPI access with default configuration - cisco.nxos.nxos_nxapi: - state: present - - - name: Enable NXAPI with no HTTP, HTTPS at port 9443 and sandbox disabled - cisco.nxos.nxos_nxapi: - enable_http: false - https_port: 9443 - https: true - enable_sandbox: false - - - name: remove NXAPI configuration - cisco.nxos.nxos_nxapi: - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- updates - -
- list -
- 		always -
Returns the list of commands that need to be pushed into the remote device to satisfy the arguments
-
-
Sample:
-
['no feature nxapi']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_ospf_interfaces_module.rst b/docs/cisco.nxos.nxos_ospf_interfaces_module.rst deleted file mode 100644 index ff69b6e71..000000000 --- a/docs/cisco.nxos.nxos_ospf_interfaces_module.rst +++ /dev/null @@ -1,1732 +0,0 @@ -.. _cisco.nxos.nxos_ospf_interfaces_module: - - -******************************* -cisco.nxos.nxos_ospf_interfaces -******************************* - -**OSPF Interfaces Resource Module.** - - -Version added: 1.3.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages OSPF(v2/v3) configuration of interfaces on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of OSPF configuration for interfaces.
-
-
- address_family - -
- list - / elements=dictionary -
- 		- -
OSPF settings on the interfaces in address-family context.
-
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
Address Family Identifier (AFI) for OSPF settings on the interfaces.
-
-
- authentication - -
- dictionary -
- 		- -
Authentication settings on the interface.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/disable authentication on the interface.
-
-
- key_chain - -
- string -
- 		- -
Authentication password key-chain.
-
-
- message_digest - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use message-digest authentication.
-
-
- null_auth - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use null(disable) authentication.
-
-
- authentication_key - -
- dictionary -
- 		- -
Configure the authentication key for the interface.
-
-
- encryption - -
- integer -
- 		- -
0 Specifies an UNENCRYPTED authentication key will follow.
-
3 Specifies an 3DES ENCRYPTED authentication key will follow.
-
7 Specifies a Cisco type 7 ENCRYPTED authentication key will follow.
-
-
- key - -
- string - / required -
- 		- -
Authentication key.
-
Valid values are Cisco type 7 ENCRYPTED password, 3DES ENCRYPTED password and UNENCRYPTED (cleartext) password based on the value of encryption key.
-
-
- cost - -
- integer -
- 		- -
Cost associated with interface.
-
-
- dead_interval - -
- integer -
- 		- -
Dead interval value (in seconds).
-
-
- default_passive_interface - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set passive-interface attribute on this interface to default.
-
This option is mutually exclusive with passive_interface.
-
-
- hello_interval - -
- integer -
- 		- -
Hello interval value (in seconds).
-
-
- instance - -
- integer -
- 		- -
Instance identifier.
-
-
- message_digest_key - -
- dictionary -
- 		- -
Message digest authentication password (key) settings.
-
-
- encryption - -
- integer -
- 		- -
0 Specifies an UNENCRYPTED ospf password (key) will follow.
-
3 Specifies an 3DES ENCRYPTED ospf password (key) will follow.
-
7 Specifies a Cisco type 7 ENCRYPTED the ospf password (key) will follow.
-
-
- key - -
- string - / required -
- 		- -
Authentication key.
-
Valid values are Cisco type 7 ENCRYPTED password, 3DES ENCRYPTED password and UNENCRYPTED (cleartext) password based on the value of encryption key.
-
-
- key_id - -
- integer - / required -
- 		- -
Key ID.
-
-
- mtu_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/disable OSPF MTU mismatch detection.
-
-
- multi_areas - -
- list - / elements=string -
- 		- -
Multi-Areas associated with interface (not tied to OSPF process).
-
Valid values are Area Ids as an integer or IP address.
-
-
- network - -
- string -
- 		-
    Choices: -
  • broadcast
    • -
  • point-to-point
    • -
- 		-
Network type.
-
-
- passive_interface - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress routing updates on the interface.
-
This option is mutually exclusive with default_passive_interface.
-
-
- priority - -
- integer -
- 		- -
Router priority.
-
-
- processes - -
- list - / elements=dictionary -
- 		- -
Interfaces configuration for an OSPF process.
-
-
- area - -
- dictionary -
- 		- -
Area associated with interface.
-
-
- area_id - -
- string - / required -
- 		- -
Area ID in IP address format.
-
-
- secondaries - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not include secondary IPv4/IPv6 addresses.
-
-
- multi_areas - -
- list - / elements=string -
- 		- -
Multi-Areas associated with interface.
-
Valid values are Area Ids as an integer or IP address.
-
-
- process_id - -
- string - / required -
- 		- -
OSPF process tag.
-
-
- retransmit_interval - -
- integer -
- 		- -
Packet retransmission interval.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Shutdown OSPF on this interface.
-
-
- transmit_delay - -
- integer -
- 		- -
Packet transmission delay.
-
-
- name - -
- string - / required -
- 		- -
Name/Identifier of the interface.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section "^interface".
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • parsed
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
-
- - -Notes ------ - -.. note:: - - Unsupported for Cisco MDS - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # interface Ethernet1/2 - # no switchport - # interface Ethernet1/3 - # no switchport - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_ospf_interfaces: - config: - - name: Ethernet1/1 - address_family: - - afi: ipv4 - processes: - - process_id: '100' - area: - area_id: 1.1.1.1 - secondaries: false - multi_areas: - - 11.11.11.11 - - afi: ipv6 - processes: - - process_id: '200' - area: - area_id: 2.2.2.2 - multi_areas: - - 21.0.0.0 - - process_id: '300' - multi_areas: - - 50.50.50.50 - multi_areas: - - 16.10.10.10 - - name: Ethernet1/2 - address_family: - - afi: ipv4 - authentication: - enable: true - key_chain: test-1 - message_digest_key: - key_id: 10 - encryption: 3 - key: abc01d272be25d29 - cost: 100 - - afi: ipv6 - network: broadcast - shutdown: true - - name: Ethernet1/3 - address_family: - - afi: ipv4 - authentication_key: - encryption: 7 - key: 12090404011C03162E - state: merged - - # Task output: - # ------------ - # before: - # - name: Ethernet1/1 - # - name: Ethernet1/2 - # - name: Ethernet1/3 - # - # commands: - # - interface Ethernet1/1 - # - ip router ospf multi-area 11.11.11.11 - # - ip router ospf 100 area 1.1.1.1 secondaries none - # - ipv6 router ospfv3 multi-area 16.10.10.10 - # - ipv6 router ospfv3 200 area 2.2.2.2 - # - ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - interface Ethernet1/2 - # - ip ospf authentication key-chain test-1 - # - ip ospf authentication - # - ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # - ip ospf cost 100 - # - ospfv3 network broadcast - # - ospfv3 shutdown - # - interface Ethernet1/3 - # - ip ospf authentication-key 7 12090404011C03162E - # - # after: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.11 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # - afi: ipv6 - # multi_areas: - # - 16.10.10.10 - # processes: - # - area: - # area_id: 2.2.2.2 - # multi_areas: - # - 21.0.0.0 - # process_id: '200' - # - multi_areas: - # - 50.50.50.50 - # process_id: '300' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - - # After state: - # ------------ - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - - # Using replaced - - # Before state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - - name: Replace OSPF configurations of listed interfaces with provided configurations - cisco.nxos.nxos_ospf_interfaces: - config: - - name: Ethernet1/1 - address_family: - - afi: ipv4 - processes: - - process_id: "100" - area: - area_id: 1.1.1.1 - secondaries: false - multi_areas: - - 11.11.11.12 - - name: Ethernet1/3 - state: replaced - - # Task output: - # ------------ - # before: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.11 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # - afi: ipv6 - # multi_areas: - # - 16.10.10.10 - # processes: - # - area: - # area_id: 2.2.2.2 - # multi_areas: - # - 21.0.0.0 - # process_id: '200' - # - multi_areas: - # - 50.50.50.50 - # process_id: '300' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - # - # commands: - # - interface Ethernet1/1 - # - ip router ospf multi-area 11.11.11.12 - # - no ip router ospf multi-area 11.11.11.11 - # - no ipv6 router ospfv3 multi-area 16.10.10.10 - # - no ipv6 router ospfv3 200 area 2.2.2.2 - # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - interface Ethernet1/3 - # - no ip ospf authentication-key 7 12090404011C03162E - # - # after: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.12 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - name: Ethernet1/3 - # - # After state: - # ------------ - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.12 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - - - # Using overridden - - # Before state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - - name: Override all OSPF interfaces configuration with provided configuration - cisco.nxos.nxos_ospf_interfaces: - config: - - name: Ethernet1/1 - address_family: - - afi: ipv4 - processes: - - process_id: "100" - area: - area_id: 1.1.1.1 - secondaries: false - multi_areas: - - 11.11.11.12 - state: overridden - - # Task output: - # ------------ - # before: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.11 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # - afi: ipv6 - # multi_areas: - # - 16.10.10.10 - # processes: - # - area: - # area_id: 2.2.2.2 - # multi_areas: - # - 21.0.0.0 - # process_id: '200' - # - multi_areas: - # - 50.50.50.50 - # process_id: '300' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - # - # commands: - # - interface Ethernet1/2 - # - no ip ospf authentication key-chain test-1 - # - no ip ospf authentication - # - no ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # - no ip ospf cost 100 - # - no ospfv3 network broadcast - # - no ospfv3 shutdown - # - interface Ethernet1/3 - # - no ip ospf authentication-key 7 12090404011C03162E - # - interface Ethernet1/1 - # - ip router ospf multi-area 11.11.11.12 - # - no ip router ospf multi-area 11.11.11.11 - # - no ipv6 router ospfv3 multi-area 16.10.10.10 - # - no ipv6 router ospfv3 200 area 2.2.2.2 - # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - # after: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.12 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # name: Ethernet1/1 - # - name: Ethernet1/2 - # - name: Ethernet1/3 - - # After state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.12 - # interface Ethernet1/2 - # no switchport - # interface Ethernet1/3 - # no switchport - - # Using deleted to delete OSPF config of a single interface - - # Before state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - - name: Delete OSPF config from a single interface - cisco.nxos.nxos_ospf_interfaces: - config: - - name: Ethernet1/1 - state: deleted - - # Task output: - # ------------ - # before: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.11 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # - afi: ipv6 - # multi_areas: - # - 16.10.10.10 - # processes: - # - area: - # area_id: 2.2.2.2 - # multi_areas: - # - 21.0.0.0 - # process_id: '200' - # - multi_areas: - # - 50.50.50.50 - # process_id: '300' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - # - # commands: - # - interface Ethernet1/1 - # - no ip router ospf multi-area 11.11.11.11 - # - no ip router ospf 100 area 1.1.1.1 secondaries none - # - no ipv6 router ospfv3 multi-area 16.10.10.10 - # - no ipv6 router ospfv3 200 area 2.2.2.2 - # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - # after: - # - name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - - - # After state: - # ------------ - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - # Using deleted to delete OSPF config from all interfaces - - # Before state: - # ------------- - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - # ip ospf authentication-key 7 12090404011C03162E - - - name: Delete OSPF config from all interfaces - cisco.nxos.nxos_ospf_interfaces: - state: deleted - - # Task output: - # ------------ - # before: - # - name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - # - # commands: - # - interface Ethernet1/1 - # - no ip router ospf multi-area 11.11.11.11 - # - no ip router ospf 100 area 1.1.1.1 secondaries none - # - no ipv6 router ospfv3 multi-area 16.10.10.10 - # - no ipv6 router ospfv3 200 area 2.2.2.2 - # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - interface Ethernet1/2 - # - no ip ospf authentication key-chain test-1 - # - no ip ospf authentication - # - no ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # - no ip ospf cost 100 - # - no ospfv3 network broadcast - # - no ospfv3 shutdown - # - interface Ethernet1/3 - # - no ip ospf authentication-key 7 12090404011C03162E - # - # after: - # - name: Ethernet1/1 - # - name: Ethernet1/2 - # - name: Ethernet1/3 - - # After state: - # ------------ - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # interface Ethernet1/2 - # no switchport - # interface Ethernet1/3 - # no switchport - - # Using rendered - - - name: >- - Render platform specific configuration lines with state rendered (without - connecting to the device) - cisco.nxos.nxos_ospf_interfaces: - config: - - name: Ethernet1/1 - address_family: - - afi: ipv4 - processes: - - process_id: '100' - area: - area_id: 1.1.1.1 - secondaries: false - multi_areas: - - 11.11.11.11 - - afi: ipv6 - processes: - - process_id: '200' - area: - area_id: 2.2.2.2 - multi_areas: - - 21.0.0.0 - - process_id: '300' - multi_areas: - - 50.50.50.50 - multi_areas: - - 16.10.10.10 - - name: Ethernet1/2 - address_family: - - afi: ipv4 - authentication: - enable: true - key_chain: test-1 - message_digest_key: - key_id: 10 - encryption: 3 - key: abc01d272be25d29 - cost: 100 - - afi: ipv6 - network: broadcast - shutdown: true - - name: Ethernet1/3 - address_family: - - afi: ipv4 - authentication_key: - encryption: 7 - key: 12090404011C03162E - state: rendered - - - # Task Output: - # ------------ - # rendered: - # - interface Ethernet1/1 - # - ip router ospf multi-area 11.11.11.11 - # - ip router ospf 100 area 1.1.1.1 secondaries none - # - ipv6 router ospfv3 multi-area 16.10.10.10 - # - ipv6 router ospfv3 200 area 2.2.2.2 - # - ipv6 router ospfv3 200 multi-area 21.0.0.0 - # - ipv6 router ospfv3 300 multi-area 50.50.50.50 - # - interface Ethernet1/2 - # - ip ospf authentication key-chain test-1 - # - ip ospf authentication - # - ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # - ip ospf cost 100 - # - ospfv3 network broadcast - # - ospfv3 shutdown - # - interface Ethernet1/3 - # - ip ospf authentication-key 7 12090404011C03162E - - # Using parsed - - # parsed.cfg - # ------------ - # interface Ethernet1/1 - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.11 - # ipv6 router ospfv3 200 area 2.2.2.2 - # ipv6 router ospfv3 200 multi-area 21.0.0.0 - # ipv6 router ospfv3 300 multi-area 50.50.50.50 - # ipv6 router ospfv3 multi-area 16.10.10.10 - # interface Ethernet1/2 - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # ip ospf authentication-key 7 12090404011C03162E - - - name: arse externally provided OSPF interfaces config - cisco.nxos.nxos_ospf_interfaces: - running_config: "{{ lookup('file', 'ospf_interfaces.cfg') }}" - state: parsed - - # Task output: - # ------------ - # parsed: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.11 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # - afi: ipv6 - # multi_areas: - # - 16.10.10.10 - # processes: - # - area: - # area_id: 2.2.2.2 - # multi_areas: - # - 21.0.0.0 - # process_id: '200' - # - multi_areas: - # - 50.50.50.50 - # process_id: '300' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - address_family: - # - afi: ipv4 - # authentication_key: - # encryption: 7 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # name: Ethernet1/3 - - # Using gathered - - # On-box config - - # NXOS# show running-config | section ^interface - # interface Ethernet1/1 - # no switchport - # ip router ospf 100 area 1.1.1.1 secondaries none - # ip router ospf multi-area 11.11.11.12 - # interface Ethernet1/2 - # no switchport - # ip ospf authentication - # ip ospf authentication key-chain test-1 - # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 - # ip ospf cost 100 - # ospfv3 network broadcast - # ospfv3 shutdown - # interface Ethernet1/3 - # no switchport - - # Task output: - # ------------ - # gathered: - # - address_family: - # - afi: ipv4 - # multi_areas: - # - 11.11.11.12 - # processes: - # - area: - # area_id: 1.1.1.1 - # secondaries: false - # process_id: '100' - # name: Ethernet1/1 - # - address_family: - # - afi: ipv4 - # authentication: - # enable: true - # key_chain: test-1 - # cost: 100 - # message_digest_key: - # encryption: 3 - # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER - # key_id: 10 - # - afi: ipv6 - # network: broadcast - # shutdown: true - # name: Ethernet1/2 - # - name: Ethernet1/3 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- list -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- list -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['interface Ethernet1/1', 'ip router ospf multi-area 11.11.11.11', 'ip router ospf 100 area 1.1.1.1 secondaries none', 'no ipv6 router ospfv3 multi-area 16.10.10.10', 'ipv6 router ospfv3 200 area 2.2.2.2', 'ipv6 router ospfv3 200 multi-area 21.0.0.0', 'ipv6 router ospfv3 300 multi-area 50.50.50.50', 'interface Ethernet1/2', 'no ip ospf authentication key-chain test-1', 'ip ospf authentication']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['interface Ethernet1/1', 'ip router ospf multi-area 11.11.11.11', 'ip router ospf 100 area 1.1.1.1 secondaries none']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_ospfv2_module.rst b/docs/cisco.nxos.nxos_ospfv2_module.rst deleted file mode 100644 index 2115d34f2..000000000 --- a/docs/cisco.nxos.nxos_ospfv2_module.rst +++ /dev/null @@ -1,5458 +0,0 @@ -.. _cisco.nxos.nxos_ospfv2_module: - - -********************** -cisco.nxos.nxos_ospfv2 -********************** - -**OSPFv2 resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages OSPFv2 configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A list of OSPF process configuration.
-
-
- processes - -
- list - / elements=dictionary -
- 		- -
A list of OSPF instances' configurations.
-
-
- areas - -
- list - / elements=dictionary -
- 		- -
Configure properties of OSPF Areas.
-
-
- area_id - -
- string - / required -
- 		- -
The Area ID in IP Address format.
-
-
- authentication - -
- dictionary -
- 		- -
Authentication settings for the Area.
-
-
- message_digest - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use message-digest authentication.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set authentication for the area.
-
-
- default_cost - -
- integer -
- 		- -
Specify the default cost for default summary LSA.
-
-
- filter_list - -
- list - / elements=dictionary -
- 		- -
Filter prefixes between OSPF areas.
-
-
- direction - -
- string - / required -
- 		-
    Choices: -
  • in
    • -
  • out
    • -
- 		-
The direction to apply the route map.
-
-
- route_map - -
- string - / required -
- 		- -
The Route-map name.
-
-
- nssa - -
- dictionary -
- 		- -
NSSA settings for the area.
-
-
- default_information_originate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Originate Type-7 default LSA into NSSA area.
-
-
- no_redistribution - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send redistributed LSAs into NSSA area.
-
-
- no_summary - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send summary LSAs into NSSA area.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure area as NSSA.
-
-
- translate - -
- dictionary -
- 		- -
Translate LSA.
-
-
- type7 - -
- dictionary -
- 		- -
Translate from Type 7 to Type 5.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always translate LSAs
-
-
- never - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Never translate LSAs
-
-
- supress_fa - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress forwarding address in translated LSAs.
-
-
- ranges - -
- list - / elements=dictionary -
- 		- -
Configure an address range for the area.
-
-
- cost - -
- integer -
- 		- -
Cost to use for the range.
-
-
- not_advertise - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress advertising the specified range.
-
-
- prefix - -
- string - / required -
- 		- -
IP in Prefix format (x.x.x.x/len)
-
-
- stub - -
- dictionary -
- 		- -
Settings for configuring the area as a stub.
-
-
- no_summary - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Prevent ABR from sending summary LSAs into stub area.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure the area as a stub.
-
-
- auto_cost - -
- dictionary -
- 		- -
Calculate OSPF cost according to bandwidth.
-
-
- reference_bandwidth - -
- integer - / required -
- 		- -
Reference bandwidth used to assign OSPF cost.
-
-
- unit - -
- string - / required -
- 		-
    Choices: -
  • Gbps
    • -
  • Mbps
    • -
- 		-
Specify in which unit the reference bandwidth is specified.
-
-
- bfd - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable BFD on all OSPF interfaces.
-
-
- default_information - -
- dictionary -
- 		- -
Control distribution of default routes.
-
-
- originate - -
- dictionary -
- 		- -
Distribute a default route.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always advertise a default route.
-
-
- route_map - -
- string -
- 		- -
Policy to control distribution of default routes
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable distribution of default route.
-
-
- default_metric - -
- integer -
- 		- -
Specify default metric for redistributed routes.
-
-
- distance - -
- integer -
- 		- -
Configure the OSPF administrative distance.
-
-
- flush_routes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Flush routes on a non-graceful controlled restart.
-
-
- graceful_restart - -
- dictionary -
- 		- -
Configure graceful restart.
-
-
- grace_period - -
- integer -
- 		- -
Configure maximum interval to restart gracefully.
-
-
- helper_disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable helper mode.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable graceful-restart.
-
-
- isolate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Isolate this router from OSPF perspective.
-
-
- log_adjacency_changes - -
- dictionary -
- 		- -
Log changes in adjacency state.
-
-
- detail - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Notify all state changes.
-
-
- log - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/disable logging changes in adjacency state.
-
-
- max_lsa - -
- dictionary -
- 		- -
Feature to limit the number of non-self-originated LSAs.
-
-
- ignore_count - -
- integer -
- 		- -
Set count on how many times adjacencies can be suppressed.
-
-
- ignore_time - -
- integer -
- 		- -
Set time during which all adjacencies are suppressed.
-
-
- max_non_self_generated_lsa - -
- integer - / required -
- 		- -
Set the maximum number of non self-generated LSAs.
-
-
- reset_time - -
- integer -
- 		- -
Set number of minutes after which ignore-count is reset to zero.
-
-
- threshold - -
- integer -
- 		- -
Threshold value (%) at which to generate a warning message.
-
-
- warning_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Log a warning message when limit is exceeded.
-
-
- max_metric - -
- dictionary -
- 		- -
Maximize the cost metric.
-
-
- router_lsa - -
- dictionary -
- 		- -
Router LSA configuration.
-
-
- external_lsa - -
- dictionary -
- 		- -
External LSA configuration.
-
-
- max_metric_value - -
- integer -
- 		- -
Set max metric value for external LSAs.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set external-lsa attribute.
-
-
- include_stub - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise Max metric for Stub links as well.
-
-
- on_startup - -
- dictionary -
- 		- -
Effective only at startup.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set on-startup attribute.
-
-
- wait_for_bgp_asn - -
- integer -
- 		- -
ASN of BGP to wait for.
-
-
- wait_period - -
- integer -
- 		- -
Wait period in seconds after startup.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set router-lsa attribute.
-
-
- summary_lsa - -
- dictionary -
- 		- -
Summary LSAs configuration.
-
-
- max_metric_value - -
- integer -
- 		- -
Max metric value for summary LSAs.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set summary-lsa attribute.
-
-
- maximum_paths - -
- integer -
- 		- -
Maximum paths per destination.
-
-
- mpls - -
- dictionary -
- 		- -
OSPF MPLS configuration settings.
-
-
- traffic_eng - -
- dictionary -
- 		- -
OSPF MPLS Traffic Engineering commands.
-
-
- areas - -
- list - / elements=dictionary -
- 		- -
List of Area IDs.
-
-
- area_id - -
- string -
- 		- -
Area Id in ip address format.
-
-
- multicast_intact - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
MPLS TE multicast support.
-
-
- router_id - -
- string -
- 		- -
Router ID associated with TE.
-
-
- name_lookup - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Display OSPF router ids as DNS names.
-
-
- passive_interface - -
- dictionary -
- 		- -
Suppress routing updates on the interface.
-
-
- default - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Interfaces passive by default.
-
-
- process_id - -
- string - / required -
- 		- -
The OSPF process tag.
-
-
- redistribute - -
- list - / elements=dictionary -
- 		- -
Redistribute information from another routing protocol.
-
-
- id - -
- string -
- 		- -
The identifier for the protocol specified.
-
-
- protocol - -
- string - / required -
- 		-
    Choices: -
  • bgp
    • -
  • direct
    • -
  • eigrp
    • -
  • isis
    • -
  • lisp
    • -
  • ospf
    • -
  • rip
    • -
  • static
    • -
- 		-
The name of the protocol.
-
-
- route_map - -
- string - / required -
- 		- -
The route map policy to constrain redistribution.
-
-
- rfc1583compatibility - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure 1583 compatibility for external path preferences.
-
-
- router_id - -
- string -
- 		- -
Set OSPF process router-id.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Shutdown the OSPF protocol instance.
-
-
- summary_address - -
- list - / elements=dictionary -
- 		- -
Configure route summarization for redistribution.
-
-
- not_advertise - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress advertising the specified summary.
-
-
- prefix - -
- string - / required -
- 		- -
IP prefix in format x.x.x.x/ml.
-
-
- tag - -
- integer -
- 		- -
A 32-bit tag value.
-
-
- table_map - -
- dictionary -
- 		- -
Policy for filtering/modifying OSPF routes before sending them to RIB.
-
-
- filter - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Block the OSPF routes from being sent to RIB.
-
-
- name - -
- string - / required -
- 		- -
The Route Map name.
-
-
- timers - -
- dictionary -
- 		- -
Configure timer related constants.
-
-
- lsa_arrival - -
- integer -
- 		- -
Mimimum interval between arrival of a LSA.
-
-
- lsa_group_pacing - -
- integer -
- 		- -
LSA group refresh/maxage interval.
-
-
- throttle - -
- dictionary -
- 		- -
Configure throttle related constants.
-
-
- lsa - -
- dictionary -
- 		- -
Set rate-limiting for LSA generation.
-
-
- hold_interval - -
- integer -
- 		- -
The hold interval.
-
-
- max_interval - -
- integer -
- 		- -
The max interval.
-
-
- start_interval - -
- integer -
- 		- -
The start interval.
-
-
- spf - -
- dictionary -
- 		- -
Set OSPF SPF timers.
-
-
- initial_spf_delay - -
- integer -
- 		- -
Initial SPF schedule delay in milliseconds.
-
-
- max_wait_time - -
- integer -
- 		- -
Maximum wait time between SPF calculations.
-
-
- min_hold_time - -
- integer -
- 		- -
Minimum hold time between SPF calculations.
-
-
- vrfs - -
- list - / elements=dictionary -
- 		- -
Configure VRF specific OSPF settings.
-
-
- areas - -
- list - / elements=dictionary -
- 		- -
Configure properties of OSPF Areas.
-
-
- area_id - -
- string - / required -
- 		- -
The Area ID in IP Address format.
-
-
- authentication - -
- dictionary -
- 		- -
Authentication settings for the Area.
-
-
- message_digest - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use message-digest authentication.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set authentication for the area.
-
-
- default_cost - -
- integer -
- 		- -
Specify the default cost for default summary LSA.
-
-
- filter_list - -
- list - / elements=dictionary -
- 		- -
Filter prefixes between OSPF areas.
-
-
- direction - -
- string - / required -
- 		-
    Choices: -
  • in
    • -
  • out
    • -
- 		-
The direction to apply the route map.
-
-
- route_map - -
- string - / required -
- 		- -
The Route-map name.
-
-
- nssa - -
- dictionary -
- 		- -
NSSA settings for the area.
-
-
- default_information_originate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Originate Type-7 default LSA into NSSA area.
-
-
- no_redistribution - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send redistributed LSAs into NSSA area.
-
-
- no_summary - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send summary LSAs into NSSA area.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure area as NSSA.
-
-
- translate - -
- dictionary -
- 		- -
Translate LSA.
-
-
- type7 - -
- dictionary -
- 		- -
Translate from Type 7 to Type 5.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always translate LSAs
-
-
- never - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Never translate LSAs
-
-
- supress_fa - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress forwarding address in translated LSAs.
-
-
- ranges - -
- list - / elements=dictionary -
- 		- -
Configure an address range for the area.
-
-
- cost - -
- integer -
- 		- -
Cost to use for the range.
-
-
- not_advertise - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress advertising the specified range.
-
-
- prefix - -
- string - / required -
- 		- -
IP in Prefix format (x.x.x.x/len)
-
-
- stub - -
- dictionary -
- 		- -
Settings for configuring the area as a stub.
-
-
- no_summary - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Prevent ABR from sending summary LSAs into stub area.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure the area as a stub.
-
-
- auto_cost - -
- dictionary -
- 		- -
Calculate OSPF cost according to bandwidth.
-
-
- reference_bandwidth - -
- integer - / required -
- 		- -
Reference bandwidth used to assign OSPF cost.
-
-
- unit - -
- string - / required -
- 		-
    Choices: -
  • Gbps
    • -
  • Mbps
    • -
- 		-
Specify in which unit the reference bandwidth is specified.
-
-
- bfd - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable BFD on all OSPF interfaces.
-
-
- capability - -
- dictionary -
- 		- -
OSPF capability settings.
-
-
- vrf_lite - -
- dictionary -
- 		- -
Enable VRF-lite capability settings.
-
-
- evpn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ethernet VPN.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable VRF-lite support.
-
-
- default_information - -
- dictionary -
- 		- -
Control distribution of default routes.
-
-
- originate - -
- dictionary -
- 		- -
Distribute a default route.
-
-
- always - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Always advertise a default route.
-
-
- route_map - -
- string -
- 		- -
Policy to control distribution of default routes
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable distribution of default route.
-
-
- default_metric - -
- integer -
- 		- -
Specify default metric for redistributed routes.
-
-
- distance - -
- integer -
- 		- -
Configure the OSPF administrative distance.
-
-
- down_bit_ignore - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure a PE router to ignore the DN bit for network summary, external and NSSA external LSA.
-
-
- graceful_restart - -
- dictionary -
- 		- -
Configure graceful restart.
-
-
- grace_period - -
- integer -
- 		- -
Configure maximum interval to restart gracefully.
-
-
- helper_disable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable helper mode.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable graceful-restart.
-
-
- log_adjacency_changes - -
- dictionary -
- 		- -
Log changes in adjacency state.
-
-
- detail - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Notify all state changes.
-
-
- log - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/disable logging changes in adjacency state.
-
-
- max_lsa - -
- dictionary -
- 		- -
Feature to limit the number of non-self-originated LSAs.
-
-
- ignore_count - -
- integer -
- 		- -
Set count on how many times adjacencies can be suppressed.
-
-
- ignore_time - -
- integer -
- 		- -
Set time during which all adjacencies are suppressed.
-
-
- max_non_self_generated_lsa - -
- integer - / required -
- 		- -
Set the maximum number of non self-generated LSAs.
-
-
- reset_time - -
- integer -
- 		- -
Set number of minutes after which ignore-count is reset to zero.
-
-
- threshold - -
- integer -
- 		- -
Threshold value (%) at which to generate a warning message.
-
-
- warning_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Log a warning message when limit is exceeded.
-
-
- max_metric - -
- dictionary -
- 		- -
Maximize the cost metric.
-
-
- router_lsa - -
- dictionary -
- 		- -
Router LSA configuration.
-
-
- external_lsa - -
- dictionary -
- 		- -
External LSA configuration.
-
-
- max_metric_value - -
- integer -
- 		- -
Set max metric value for external LSAs.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set external-lsa attribute.
-
-
- include_stub - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Advertise Max metric for Stub links as well.
-
-
- on_startup - -
- dictionary -
- 		- -
Effective only at startup.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set on-startup attribute.
-
-
- wait_for_bgp_asn - -
- integer -
- 		- -
ASN of BGP to wait for.
-
-
- wait_period - -
- integer -
- 		- -
Wait period in seconds after startup.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set router-lsa attribute.
-
-
- summary_lsa - -
- dictionary -
- 		- -
Summary LSAs configuration.
-
-
- max_metric_value - -
- integer -
- 		- -
Max metric value for summary LSAs.
-
-
- set - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set summary-lsa attribute.
-
-
- maximum_paths - -
- integer -
- 		- -
Maximum paths per destination.
-
-
- name_lookup - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Display OSPF router ids as DNS names.
-
-
- passive_interface - -
- dictionary -
- 		- -
Suppress routing updates on the interface.
-
-
- default - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Interfaces passive by default.
-
-
- redistribute - -
- list - / elements=dictionary -
- 		- -
Redistribute information from another routing protocol.
-
-
- id - -
- string -
- 		- -
The identifier for the protocol specified.
-
-
- protocol - -
- string - / required -
- 		-
    Choices: -
  • bgp
    • -
  • direct
    • -
  • eigrp
    • -
  • isis
    • -
  • lisp
    • -
  • ospf
    • -
  • rip
    • -
  • static
    • -
- 		-
The name of the protocol.
-
-
- route_map - -
- string - / required -
- 		- -
The route map policy to constrain redistribution.
-
-
- rfc1583compatibility - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure 1583 compatibility for external path preferences.
-
-
- router_id - -
- string -
- 		- -
Set OSPF process router-id.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Shutdown the OSPF protocol instance.
-
-
- summary_address - -
- list - / elements=dictionary -
- 		- -
Configure route summarization for redistribution.
-
-
- not_advertise - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Suppress advertising the specified summary.
-
-
- prefix - -
- string - / required -
- 		- -
IP prefix in format x.x.x.x/ml.
-
-
- tag - -
- integer -
- 		- -
A 32-bit tag value.
-
-
- table_map - -
- dictionary -
- 		- -
Policy for filtering/modifying OSPF routes before sending them to RIB.
-
-
- filter - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Block the OSPF routes from being sent to RIB.
-
-
- name - -
- string - / required -
- 		- -
The Route Map name.
-
-
- timers - -
- dictionary -
- 		- -
Configure timer related constants.
-
-
- lsa_arrival - -
- integer -
- 		- -
Mimimum interval between arrival of a LSA.
-
-
- lsa_group_pacing - -
- integer -
- 		- -
LSA group refresh/maxage interval.
-
-
- throttle - -
- dictionary -
- 		- -
Configure throttle related constants.
-
-
- lsa - -
- dictionary -
- 		- -
Set rate-limiting for LSA generation.
-
-
- hold_interval - -
- integer -
- 		- -
The hold interval.
-
-
- max_interval - -
- integer -
- 		- -
The max interval.
-
-
- start_interval - -
- integer -
- 		- -
The start interval.
-
-
- spf - -
- dictionary -
- 		- -
Set OSPF SPF timers.
-
-
- initial_spf_delay - -
- integer -
- 		- -
Initial SPF schedule delay in milliseconds.
-
-
- max_wait_time - -
- integer -
- 		- -
Maximum wait time between SPF calculations.
-
-
- min_hold_time - -
- integer -
- 		- -
Minimum hold time between SPF calculations.
-
-
- vrf - -
- string - / required -
- 		- -
Name/Identifier of the VRF.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section "^router ospf .*".
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • parsed
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 7.0(3)I5(1). - - Unsupported for Cisco MDS - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # nxos-9k-rdo# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_ospfv2: - config: - processes: - - process_id: 100 - router_id: 203.0.113.20 - - process_id: 102 - router_id: 198.51.100.1 - areas: - - area_id: 0.0.0.100 - filter_list: - - route_map: rmap_1 - direction: in - - route_map: rmap_2 - direction: out - ranges: - - prefix: 198.51.100.64/27 - not_advertise: true - - prefix: 198.51.100.96/27 - cost: 120 - - area_id: 0.0.0.101 - authentication: - message_digest: true - redistribute: - - protocol: eigrp - id: 120 - route_map: rmap_1 - - protocol: direct - route_map: ospf102-direct-connect - vrfs: - - vrf: zone1 - router_id: 198.51.100.129 - redistribute: - - protocol: static - route_map: zone1-static-connect - summary_address: - - prefix: 198.51.100.128/27 - tag: 121 - - prefix: 198.51.100.160/27 - areas: - - area_id: 0.0.0.102 - nssa: - default_information_originate: true - no_summary: true - - area_id: 0.0.0.103 - nssa: - no_summary: true - translate: - type7: - always: true - - vrf: zone2 - auto_cost: - reference_bandwidth: 45 - unit: Gbps - state: merged - - # Task output: - # ------------ - # before: {} - # - # commands: - # - router ospf 102 - # - router-id 198.51.100.1 - # - redistribute eigrp 120 route-map rmap_1 - # - redistribute direct route-map ospf102-direct-connect - # - area 0.0.0.100 filter-list route-map rmap_1 in - # - area 0.0.0.100 filter-list route-map rmap_2 out - # - area 0.0.0.100 range 198.51.100.64/27 not-advertise - # - area 0.0.0.100 range 198.51.100.96/27 cost 120 - # - area 0.0.0.101 authentication message-digest - # - vrf zone1 - # - router-id 198.51.100.129 - # - summary-address 198.51.100.128/27 tag 121 - # - summary-address 198.51.100.160/27 - # - redistribute static route-map zone1-static-connect - # - area 0.0.0.102 nssa no-summary default-information-originate - # - area 0.0.0.103 nssa no-summary - # - area 0.0.0.103 nssa translate type7 always - # - vrf zone2 - # - auto-cost reference-bandwidth 45 Gbps - # - router ospf 100 - # - router-id 203.0.113.20 - # - # after: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.100 - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # - cost: 120 - # prefix: 198.51.100.96/27 - # - area_id: 0.0.0.101 - # authentication: - # message_digest: true - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # - area_id: 0.0.0.103 - # nssa: - # no_summary: true - # translate: - # type7: - # always: true - # redistribute: - # - protocol: static - # route_map: zone1-static-connect - # router_id: 198.51.100.129 - # vrf: zone1 - # - auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # vrf: zone2 - # - - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # area 0.0.0.100 range 198.51.100.96/27 cost 120 - # area 0.0.0.101 authentication message-digest - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # area 0.0.0.103 nssa no-summary - # area 0.0.0.103 nssa translate type7 always - # redistribute static route-map zone1-static-connect - # summary-address 198.51.100.128/27 tag 121 - # summary-address 198.51.100.160/27 - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - - # Using replaced - - # Before state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # area 0.0.0.100 range 198.51.100.96/27 cost 120 - # area 0.0.0.101 authentication message-digest - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # area 0.0.0.103 nssa no-summary - # area 0.0.0.103 nssa translate type7 always - # redistribute static route-map zone1-static-connect - # summary-address 198.51.100.128/27 tag 121 - # summary-address 198.51.100.160/27 - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - - - name: >- - Replace device configurations of listed OSPF processes with provided - configurations - cisco.nxos.nxos_ospfv2: - config: - processes: - - process_id: 102 - router_id: 198.51.100.1 - areas: - - area_id: 0.0.0.100 - filter_list: - - route_map: rmap_8 - direction: in - ranges: - - prefix: 198.51.100.64/27 - not_advertise: true - - area_id: 0.0.0.101 - stub: - no_summary: true - redistribute: - - protocol: eigrp - id: 130 - route_map: rmap_1 - - protocol: direct - route_map: ospf102-direct-connect - vrfs: - - vrf: zone1 - router_id: 198.51.100.129 - redistribute: - - protocol: bgp - id: 65563 - route_map: zone1-bgp-connect - areas: - - area_id: 0.0.0.102 - nssa: - default_information_originate: true - no_summary: true - state: replaced - - - # Task output: - # ------------ - # before: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.100 - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # - cost: 120 - # prefix: 198.51.100.96/27 - # - area_id: 0.0.0.101 - # authentication: - # message_digest: true - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # - area_id: 0.0.0.103 - # nssa: - # no_summary: true - # translate: - # type7: - # always: true - # redistribute: - # - protocol: static - # route_map: zone1-static-connect - # router_id: 198.51.100.129 - # vrf: zone1 - # - auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # vrf: zone2 - # - # commands: - # - router ospf 102 - # - redistribute eigrp 130 route-map rmap_1 - # - no redistribute eigrp 120 route-map rmap_1 - # - area 0.0.0.100 filter-list route-map rmap_8 in - # - no area 0.0.0.100 filter-list route-map rmap_2 out - # - no area 0.0.0.100 range 198.51.100.96/27 - # - no area 0.0.0.101 authentication - # - area 0.0.0.101 stub no-summary - # - vrf zone1 - # - no summary-address 198.51.100.128/27 tag 121 - # - no summary-address 198.51.100.160/27 - # - redistribute bgp 65563 route-map zone1-bgp-connect - # - no redistribute static route-map zone1-static-connect - # - no area 0.0.0.103 nssa - # - no area 0.0.0.103 nssa translate type7 always - # - no vrf zone2 - # - # after: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.101 - # stub: - # no_summary: true - # - area_id: 0.0.0.100 - # filter_list: - # - direction: in - # route_map: rmap_8 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "130" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # redistribute: - # - id: "65563" - # protocol: bgp - # route_map: zone1-bgp-connect - # router_id: 198.51.100.129 - # vrf: zone1 - - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # area 0.0.0.101 stub no-summary - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 130 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_8 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # redistribute bgp 65563 route-map zone1-bgp-connect - - # Using overridden - - # Before state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # area 0.0.0.100 range 198.51.100.96/27 cost 120 - # area 0.0.0.101 authentication message-digest - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # area 0.0.0.103 nssa no-summary - # area 0.0.0.103 nssa translate type7 always - # redistribute static route-map zone1-static-connect - # summary-address 198.51.100.128/27 tag 121 - # summary-address 198.51.100.160/27 - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - - - name: Override all OSPF configuration with provided configuration - cisco.nxos.nxos_ospfv2: - config: - processes: - - process_id: 104 - router_id: 203.0.113.20 - - process_id: 102 - router_id: 198.51.100.1 - shutdown: true - state: overridden - - # Task output: - # ------------ - # before: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.100 - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # - cost: 120 - # prefix: 198.51.100.96/27 - # - area_id: 0.0.0.101 - # authentication: - # message_digest: true - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # - area_id: 0.0.0.103 - # nssa: - # no_summary: true - # translate: - # type7: - # always: true - # redistribute: - # - protocol: static - # route_map: zone1-static-connect - # router_id: 198.51.100.129 - # vrf: zone1 - # - auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # vrf: zone2 - # - # commands: - # - no router ospf 100 - # - router ospf 104 - # - router-id 203.0.113.20 - # - router ospf 102 - # - shutdown - # - no redistribute direct route-map ospf102-direct-connect - # - no redistribute eigrp 120 route-map rmap_1 - # - no area 0.0.0.100 filter-list route-map rmap_2 out - # - no area 0.0.0.100 filter-list route-map rmap_1 in - # - no area 0.0.0.100 range 198.51.100.64/27 - # - no area 0.0.0.100 range 198.51.100.96/27 - # - no area 0.0.0.101 authentication - # - no vrf zone1 - # - no vrf zone2 - # - # after: - # processes: - # - process_id: "102" - # router_id: 198.51.100.1 - # shutdown: true - # - process_id: "104" - # router_id: 203.0.113.20 - - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 102 - # router-id 198.51.100.1 - # shutdown - # router ospf 104 - # router-id 203.0.113.20 - - # Using deleted to delete a single OSPF process - - # Before state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # area 0.0.0.100 range 198.51.100.96/27 cost 120 - # area 0.0.0.101 authentication message-digest - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # area 0.0.0.103 nssa no-summary - # area 0.0.0.103 nssa translate type7 always - # redistribute static route-map zone1-static-connect - # summary-address 198.51.100.128/27 tag 121 - # summary-address 198.51.100.160/27 - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - - - name: Delete a single OSPF process - cisco.nxos.nxos_ospfv2: - config: - processes: - - process_id: 102 - state: deleted - - # Task output: - # ------------ - # before: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.100 - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # - cost: 120 - # prefix: 198.51.100.96/27 - # - area_id: 0.0.0.101 - # authentication: - # message_digest: true - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # - area_id: 0.0.0.103 - # nssa: - # no_summary: true - # translate: - # type7: - # always: true - # redistribute: - # - protocol: static - # route_map: zone1-static-connect - # router_id: 198.51.100.129 - # vrf: zone1 - # - auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # vrf: zone2 - # - # commands: - # - no router ospf 102 - # - # after: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - - # Using deleted all OSPF processes from the device - - # Before state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # router ospf 100 - # router-id 203.0.113.20 - # router ospf 102 - # router-id 198.51.100.1 - # redistribute direct route-map ospf102-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 198.51.100.64/27 not-advertise - # area 0.0.0.100 range 198.51.100.96/27 cost 120 - # area 0.0.0.101 authentication message-digest - # vrf zone1 - # router-id 198.51.100.129 - # area 0.0.0.102 nssa no-summary default-information-originate - # area 0.0.0.103 nssa no-summary - # area 0.0.0.103 nssa translate type7 always - # redistribute static route-map zone1-static-connect - # summary-address 198.51.100.128/27 tag 121 - # summary-address 198.51.100.160/27 - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - - - name: Delete all OSPF processes from the device - cisco.nxos.nxos_ospfv2: - state: deleted - - # Task output: - # ------------ - # before: - # processes: - # - process_id: "100" - # router_id: 203.0.113.20 - # - areas: - # - area_id: 0.0.0.100 - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # - cost: 120 - # prefix: 198.51.100.96/27 - # - area_id: 0.0.0.101 - # authentication: - # message_digest: true - # process_id: "102" - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # - area_id: 0.0.0.103 - # nssa: - # no_summary: true - # translate: - # type7: - # always: true - # redistribute: - # - protocol: static - # route_map: zone1-static-connect - # router_id: 198.51.100.129 - # vrf: zone1 - # - auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # vrf: zone2 - # - # commands: - # - no router ospf 100 - # - no router ospf 102 - # - # after: {} - - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^router ospf .*" - # nxos-9k-rdo# - - # Using rendered - - - name: >- - Render platform specific configuration lines (without connecting to the - device) - cisco.nxos.nxos_ospfv2: - config: - processes: - - process_id: 100 - router_id: 203.0.113.20 - - process_id: 102 - router_id: 198.51.100.1 - areas: - - area_id: 0.0.0.100 - filter_list: - - route_map: rmap_1 - direction: in - - route_map: rmap_2 - direction: out - ranges: - - prefix: 198.51.100.64/27 - not_advertise: true - - prefix: 198.51.100.96/27 - cost: 120 - - area_id: 0.0.0.101 - authentication: - message_digest: true - redistribute: - - protocol: eigrp - id: 120 - route_map: rmap_1 - - protocol: direct - route_map: ospf102-direct-connect - vrfs: - - vrf: zone1 - router_id: 198.51.100.129 - redistribute: - - protocol: static - route_map: zone1-static-connect - summary_address: - - prefix: 198.51.100.128/27 - tag: 121 - - prefix: 198.51.100.160/27 - areas: - - area_id: 0.0.0.102 - nssa: - default_information_originate: true - no_summary: true - - area_id: 0.0.0.103 - nssa: - no_summary: true - translate: - type7: - always: true - - vrf: zone2 - auto_cost: - reference_bandwidth: 45 - unit: Gbps - state: rendered - - - # Task output: - # ------------ - # rendered: - # - router ospf 100 - # - router-id 203.0.113.20 - # - router ospf 102 - # - router-id 198.51.100.1 - # - redistribute eigrp 120 route-map rmap_1 - # - redistribute direct route-map ospf102-direct-connect - # - area 0.0.0.100 filter-list route-map rmap_1 in - # - area 0.0.0.100 filter-list route-map rmap_2 out - # - area 0.0.0.100 range 198.51.100.64/27 not-advertise - # - area 0.0.0.100 range 198.51.100.96/27 cost 120 - # - area 0.0.0.101 authentication message-digest - # - vrf zone1 - # - router-id 198.51.100.129 - # - summary-address 198.51.100.128/27 tag 121 - # - summary-address 198.51.100.160/27 - # - redistribute static route-map zone1-static-connect - # - area 0.0.0.102 nssa no-summary default-information-originate - # - area 0.0.0.103 nssa no-summary - # - area 0.0.0.103 nssa translate type7 always - # - vrf zone2 - # - auto-cost reference-bandwidth 45 Gbps - - # Using parsed - - # parsed.cfg - # ------------ - # router ospf 100 - # router-id 192.0.100.1 - # area 0.0.0.101 nssa no-summary no-redistribution - # area 0.0.0.102 stub no-summary - # redistribute direct route-map ospf-direct-connect - # redistribute eigrp 120 route-map rmap_1 - # area 0.0.0.100 filter-list route-map rmap_2 out - # area 0.0.0.100 filter-list route-map rmap_1 in - # area 0.0.0.100 range 192.0.2.0/24 not-advertise - # area 0.0.0.100 range 192.0.3.0/24 cost 120 - # area 0.0.0.100 authentication message-digest - # vrf zone1 - # router-id 192.0.100.2 - # area 0.0.100.1 nssa no-summary no-redistribution - # redistribute static route-map zone1-direct-connect - # summary-address 10.0.0.0/24 tag 120 - # summary-address 11.0.0.0/24 not-advertise - # vrf zone2 - # auto-cost reference-bandwidth 45 Gbps - # down-bit-ignore - # capability vrf-lite evpn - # shutdown - # router ospf 102 - # router-id 198.54.100.1 - # shutdown - # vrf zone2 - # summary-address 192.0.8.0/24 tag 120 - # vrf zone4 - # shutdown - - - name: Parse externally provided OSPFv2 config - cisco.nxos.nxos_ospfv2: - running_config: "{{ lookup('file', 'ospfv2.cfg') }}" - state: parsed - - # Task output: - # ------------ - # parsed: - # processes: - # - process_id: "100" - # areas: - # - area_id: 0.0.0.101 - # nssa: - # no_redistribution: true - # no_summary: true - # - area_id: 0.0.0.102 - # stub: - # no_summary: true - # - area_id: 0.0.0.100 - # authentication: - # message_digest: true - # filter_list: - # - direction: out - # route_map: rmap_2 - # - direction: in - # route_map: rmap_1 - # ranges: - # - not_advertise: true - # prefix: 192.0.2.0/24 - # - cost: 120 - # prefix: 192.0.3.0/24 - # redistribute: - # - protocol: direct - # route_map: ospf-direct-connect - # - id: "120" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 192.0.100.1 - # vrfs: - # - vrf: zone1 - # areas: - # - area_id: 0.0.100.1 - # nssa: - # no_redistribution: true - # no_summary: true - # redistribute: - # - protocol: static - # route_map: zone1-direct-connect - # router_id: 192.0.100.2 - # summary_address: - # - prefix: 10.0.0.0/24 - # tag: 120 - # - not_advertise: true - # prefix: 11.0.0.0/24 - # - vrf: zone2 - # auto_cost: - # reference_bandwidth: 45 - # unit: Gbps - # capability: - # vrf_lite: - # evpn: true - # down_bit_ignore: true - # shutdown: true - # - process_id: "102" - # router_id: 198.54.100.1 - # shutdown: true - # vrfs: - # - vrf: zone2 - # summary_address: - # - prefix: 192.0.8.0/24 - # tag: 120 - # - vrf: zone4 - # shutdown: true - - # Using gathered - - - name: Gather OSPFv2 facts using gathered - cisco.nxos.nxos_ospfv2: - state: gathered - - # Task output: - # ------------ - # gathered: - # processes: - # - process_id: "102" - # areas: - # - area_id: 0.0.0.101 - # stub: - # no_summary: true - # - area_id: 0.0.0.100 - # filter_list: - # - direction: in - # route_map: rmap_8 - # ranges: - # - not_advertise: true - # prefix: 198.51.100.64/27 - # redistribute: - # - protocol: direct - # route_map: ospf102-direct-connect - # - id: "130" - # protocol: eigrp - # route_map: rmap_1 - # router_id: 198.51.100.1 - # vrfs: - # - vrf: zone1 - # areas: - # - area_id: 0.0.0.102 - # nssa: - # default_information_originate: true - # no_summary: true - # redistribute: - # - id: "65563" - # protocol: bgp - # route_map: zone1-bgp-connect - # router_id: 198.51.100.129 - # - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['router ospf 102', 'router-id 198.54.100.1', 'router ospf 100', 'router-id 192.0.100.1', 'redistribute eigrp 120 route-map rmap_1', 'redistribute direct route-map ospf-direct-connect', 'area 0.0.0.100 filter-list route-map rmap_1 in', 'area 0.0.0.100 filter-list route-map rmap_2 out', 'area 0.0.0.100 range 192.0.2.0/24 not-advertise', 'area 0.0.0.100 range 192.0.3.0/24 cost 120', 'vrf zone1', 'router-id 192.0.100.2', 'summary-address 10.0.0.0/24 tag 121', 'summary-address 11.0.0.0/24', 'redistribute static route-map zone1-direct-connect', 'vrf zone2', 'auto-cost reference-bandwidth 45 Gbps', 'capability vrf-lite evpn']
-
-
- gathered - -
- dictionary -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- dictionary -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['router ospf 102', 'router-id 198.54.100.1', 'router ospf 100']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_overlay_global_module.rst b/docs/cisco.nxos.nxos_overlay_global_module.rst deleted file mode 100644 index 1a1b8d975..000000000 --- a/docs/cisco.nxos.nxos_overlay_global_module.rst +++ /dev/null @@ -1,120 +0,0 @@ -.. _cisco.nxos.nxos_overlay_global_module: - - -****************************** -cisco.nxos.nxos_overlay_global -****************************** - -**Configures anycast gateway MAC of the switch.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configures anycast gateway MAC of the switch. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- anycast_gateway_mac - -
- string - / required -
- 		- -
Anycast gateway mac of the switch.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Default restores params default value - - Supported MAC address format are "E.E.E", "EE-EE-EE-EE-EE-EE", "EE:EE:EE:EE:EE:EE" and "EEEE.EEEE.EEEE" - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_overlay_global: - anycast_gateway_mac: b.b.b - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['fabric forwarding anycast-gateway-mac 000B.000B.000B']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_pim_module.rst b/docs/cisco.nxos.nxos_pim_module.rst deleted file mode 100644 index e19eee567..000000000 --- a/docs/cisco.nxos.nxos_pim_module.rst +++ /dev/null @@ -1,148 +0,0 @@ -.. _cisco.nxos.nxos_pim_module: - - -******************* -cisco.nxos.nxos_pim -******************* - -**Manages configuration of a PIM instance.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages configuration of a Protocol Independent Multicast (PIM) instance. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- bfd - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
Enables BFD on all PIM interfaces.
-
Dependency: ''feature bfd''
-
-
- ssm_range - -
- list - / elements=string -
- 		- Default:
[]
- 		-
Configure group ranges for Source Specific Multicast (SSM). Valid values are multicast addresses or the keyword none or keyword default. none removes all SSM group ranges. 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 default, otherwise use the default option.
-
-
- - -Notes ------ - -.. note:: - - Unsupported for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - 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 Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['ip pim bfd', 'ip pim ssm range 224.0.0.0/8']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_ping_module.rst b/docs/cisco.nxos.nxos_ping_module.rst deleted file mode 100644 index d0d805868..000000000 --- a/docs/cisco.nxos.nxos_ping_module.rst +++ /dev/null @@ -1,311 +0,0 @@ -.. _cisco.nxos.nxos_ping_module: - - -******************** -cisco.nxos.nxos_ping -******************** - -**Tests reachability using ping from Nexus switch.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Tests reachability using ping from switch to a remote destination. -- For a general purpose network module, see the :ref:`ansible.netcommon.net_ping ` module. -- For Windows targets, use the :ref:`ansible.windows.win_ping ` module instead. -- For targets running Python, use the :ref:`ansible.builtin.ping ` module instead. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- count - -
- integer -
- 		- Default:
5
- 		-
Number of packets to send.
-
-
- dest - -
- string - / required -
- 		- -
IP address or hostname (resolvable by switch) of remote node.
-
-
- df_bit - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Set the DF bit.
-
-
- size - -
- integer -
- 		- -
Size of packets to send.
-
-
- source - -
- string -
- 		- -
Source IP Address or hostname (resolvable by switch)
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Determines if the expected result is success or fail.
-
-
- vrf - -
- string -
- 		- -
Outgoing VRF.
-
-
- - -Notes ------ - -.. note:: - - Unsupported for Cisco MDS - - For a general purpose network module, see the :ref:`ansible.netcommon.net_ping ` module. - - For Windows targets, use the :ref:`ansible.windows.win_ping ` module instead. - - For targets running Python, use the :ref:`ansible.builtin.ping ` module instead. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Test reachability to 8.8.8.8 using mgmt vrf - cisco.nxos.nxos_ping: - dest: 8.8.8.8 - vrf: management - host: 68.170.147.165 - - - name: Test reachability to a few different public IPs using mgmt vrf - cisco.nxos.nxos_ping: - dest: "{{ item }}" - vrf: management - host: 68.170.147.165 - with_items: - - 8.8.8.8 - - 4.4.4.4 - - 198.6.1.4 - - - name: Test reachability to 8.8.8.8 using mgmt vrf, size and df-bit - cisco.nxos.nxos_ping: - dest: 8.8.8.8 - df_bit: true - size: 1400 - vrf: management - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
Show the command sent
-
-
Sample:
-
['ping 8.8.8.8 count 2 vrf management']
-
-
- packet_loss - -
- string -
- 		always -
Percentage of packets lost
-
-
Sample:
-
0.00%
-
-
- packets_rx - -
- integer -
- 		always -
Packets successfully received
-
-
Sample:
-
2
-
-
- packets_tx - -
- integer -
- 		always -
Packets successfully transmitted
-
-
Sample:
-
2
-
-
- rtt - -
- dictionary -
- 		always -
Show RTT stats
-
-
Sample:
-
{'avg': 6.264, 'max': 6.564, 'min': 5.978}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_prefix_lists_module.rst b/docs/cisco.nxos.nxos_prefix_lists_module.rst deleted file mode 100644 index 25f343132..000000000 --- a/docs/cisco.nxos.nxos_prefix_lists_module.rst +++ /dev/null @@ -1,1049 +0,0 @@ -.. _cisco.nxos.nxos_prefix_lists_module: - - -**************************** -cisco.nxos.nxos_prefix_lists -**************************** - -**Prefix-Lists resource module.** - - -Version added: 2.4.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages prefix-lists configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of prefix-list configuration.
-
-
- afi - -
- string -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
The Address Family Identifier (AFI) for the prefix-lists.
-
-
- prefix_lists - -
- list - / elements=dictionary -
- 		- -
List of prefix-list configurations.
-
-
- description - -
- string -
- 		- -
Description of the prefix list
-
-
- entries - -
- list - / elements=dictionary -
- 		- -
List of configurations for the specified prefix-list
-
-
- action - -
- string -
- 		-
    Choices: -
  • permit
    • -
  • deny
    • -
- 		-
Prefix-List permit or deny.
-
-
- eq - -
- integer -
- 		- -
Exact prefix length to be matched.
-
-
- ge - -
- integer -
- 		- -
Minimum prefix length to be matched.
-
-
- le - -
- integer -
- 		- -
Maximum prefix length to be matched.
-
-
- mask - -
- string -
- 		- -
Explicit match mask.
-
-
- prefix - -
- string -
- 		- -
IP or IPv6 prefix in A.B.C.D/LEN or A:B::C:D/LEN format.
-
-
- sequence - -
- integer -
- 		- -
Sequence Number.
-
-
- name - -
- string -
- 		- -
Name of the prefix-list.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^ip(.* prefix-list').
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
Refer to examples for more details.
-
With state replaced, for the listed prefix-lists, sequences that are in running-config but not in the task are negated.
-
With state overridden, all prefix-lists that are in running-config but not in the task are negated.
-
Please refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - Unsupported for Cisco MDS - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # nxos-9k-rdo# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_prefix_lists: - config: - - afi: ipv4 - prefix_lists: - - name: AllowPrefix - description: allows engineering IPv4 networks - entries: - - sequence: 10 - action: permit - prefix: 192.0.2.0/23 - eq: 24 - - sequence: 20 - action: permit - prefix: 198.51.100.128/26 - - name: DenyPrefix - description: denies lab IPv4 networks - entries: - - sequence: 20 - action: deny - prefix: 203.0.113.0/24 - le: 25 - - - afi: ipv6 - prefix_lists: - - name: AllowIPv6Prefix - description: allows engineering IPv6 networks - entries: - - sequence: 8 - action: permit - prefix: "2001:db8:400::/38" - - sequence: 20 - action: permit - prefix: "2001:db8:8000::/35" - le: 37 - - # Task output - # ------------- - # before: [] - # - # commands: - # - "ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks" - # - "ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38" - # - "ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37" - # - "ip prefix-list AllowPrefix description allows engineering IPv4 networks" - # - "ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" - # - "ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" - # - "ip prefix-list DenyPrefix description denies lab IPv4 networks" - # - "ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25" - # - # after: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - # Using replaced - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Replace prefix-lists configurations of listed prefix-lists with provided configurations - cisco.nxos.nxos_prefix_lists: - config: - - afi: ipv4 - prefix_lists: - - name: AllowPrefix - description: allows engineering IPv4 networks - entries: - - sequence: 10 - action: permit - prefix: 203.0.113.64/27 - - - sequence: 30 - action: permit - prefix: 203.0.113.96/27 - - name: AllowPrefix2Stub - description: allow other engineering IPv4 network - state: replaced - - # Task output - # ------------- - # before: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # commands: - # - "no ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" - # - "ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27" - # - "ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27" - # - "no ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" - # - "ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network" - # - # after: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 203.0.113.64/27 - # - sequence: 30 - # action: permit - # prefix: 203.0.113.96/27 - # name: AllowPrefix - # - description: allow other engineering IPv4 network - # name: AllowPrefix2Stub - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27 - # ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27 - # ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - # Using overridden - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Override all prefix-lists configuration with provided configuration - cisco.nxos.nxos_prefix_lists: &id003 - config: - - afi: ipv4 - prefix_lists: - - name: AllowPrefix - description: allows engineering IPv4 networks - entries: - - sequence: 10 - action: permit - prefix: 203.0.113.64/27 - - - sequence: 30 - action: permit - prefix: 203.0.113.96/27 - - name: AllowPrefix2Stub - description: allow other engineering IPv4 network - state: overridden - - # Task output - # ------------- - # before: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # commands: - # - "no ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" - # - "ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27" - # - "ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27" - # - "no ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" - # - "ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network" - # - "no ip prefix-list DenyPrefix" - # - "no ipv6 prefix-list AllowIPv6Prefix" - # - # after: - # - afi: ipv4 - # prefix_lists: - # - name: AllowPrefix - # description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 203.0.113.64/27 - # - # - sequence: 30 - # action: permit - # prefix: 203.0.113.96/27 - # - name: AllowPrefix2Stub - # description: allow other engineering IPv4 network - # - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27 - # ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27 - # ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network - - # Using deleted to delete a all prefix lists for an AFI - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Delete all prefix-lists for an AFI - cisco.nxos.nxos_prefix_lists: - config: - - afi: ipv4 - state: deleted - register: result - - # Task output - # ------------- - # before: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # commands: - # - "no ip prefix-list AllowPrefix" - # - "no ip prefix-list DenyPrefix" - # - # after: - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - # Using deleted to delete a single prefix-list - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Delete a single prefix-list - cisco.nxos.nxos_prefix_lists: - config: - - afi: ipv4 - prefix_lists: - - name: AllowPrefix - state: deleted - - # Task output - # ------------- - # before: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # commands: - # - "no ip prefix-list AllowPrefix" - # - # after: - # - afi: ipv4 - # prefix_lists: - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - # Using deleted to delete all prefix-lists from the device - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Delete all prefix-lists - cisco.nxos.nxos_prefix_lists: - state: deleted - - # Task output - # ------------- - # before: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - # - # commands: - # - "no ip prefix-list AllowPrefix" - # - "no ip prefix-list DenyPrefix" - # - "no ipv6 prefix-list AllowIPv6Prefix" - # - # after: [] - # - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' - # nxos-9k-rdo# - - # Using rendered - - - name: Render platform specific configuration lines with state rendered (without connecting to the device) - cisco.nxos.nxos_prefix_lists: &id001 - config: - - afi: ipv4 - prefix_lists: - - name: AllowPrefix - description: allows engineering IPv4 networks - entries: - - sequence: 10 - action: permit - prefix: 192.0.2.0/23 - eq: 24 - - sequence: 20 - action: permit - prefix: 198.51.100.128/26 - - name: DenyPrefix - description: denies lab IPv4 networks - entries: - - sequence: 20 - action: deny - prefix: 203.0.113.0/24 - le: 25 - - - afi: ipv6 - prefix_lists: - - name: AllowIPv6Prefix - description: allows engineering IPv6 networks - entries: - - sequence: 8 - action: permit - prefix: "2001:db8:400::/38" - - sequence: 20 - action: permit - prefix: "2001:db8:8000::/35" - le: 37 - state: rendered - - # Task Output (redacted) - # ----------------------- - # rendered: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - - # Using parsed - - # parsed.cfg - # ------------ - # ip prefix-list AllowPrefix description allows engineering IPv4 networks - # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 - # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 - # ip prefix-list DenyPrefix description denies lab IPv4 networks - # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 - # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks - # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 - # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 - - - name: Parse externally provided prefix-lists configuration - register: result - cisco.nxos.nxos_prefix_lists: - running_config: "{{ lookup('file', './parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # - afi: ipv4 - # prefix_lists: - # - description: allows engineering IPv4 networks - # entries: - # - sequence: 10 - # action: permit - # prefix: 192.0.2.0/23 - # eq: 24 - # - sequence: 20 - # action: permit - # prefix: 198.51.100.128/26 - # name: AllowPrefix - # - description: denies lab IPv4 networks - # entries: - # - sequence: 20 - # action: deny - # prefix: 203.0.113.0/24 - # le: 25 - # name: DenyPrefix - # - # - afi: ipv6 - # prefix_lists: - # - description: allows engineering IPv6 networks - # entries: - # - sequence: 8 - # action: permit - # prefix: "2001:db8:400::/38" - # - sequence: 20 - # action: permit - # prefix: "2001:db8:8000::/35" - # le: 37 - # name: AllowIPv6Prefix - - - - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_reboot_module.rst b/docs/cisco.nxos.nxos_reboot_module.rst deleted file mode 100644 index cc94a6762..000000000 --- a/docs/cisco.nxos.nxos_reboot_module.rst +++ /dev/null @@ -1,123 +0,0 @@ -.. _cisco.nxos.nxos_reboot_module: - - -********************** -cisco.nxos.nxos_reboot -********************** - -**Reboot a network device.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Reboot a network device. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- confirm - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Safeguard boolean. Set to true if you're sure you want to reboot.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Tested against Cisco MDS NX-OS 9.2(1) - - The module will fail due to timeout issues, but the reboot will be performed anyway. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_reboot: - confirm: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- rebooted - -
- boolean -
- 		success -
Whether the device was instructed to reboot.
-
-
Sample:
-
True
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_rollback_module.rst b/docs/cisco.nxos.nxos_rollback_module.rst deleted file mode 100644 index c948e093a..000000000 --- a/docs/cisco.nxos.nxos_rollback_module.rst +++ /dev/null @@ -1,159 +0,0 @@ -.. _cisco.nxos.nxos_rollback_module: - - -************************ -cisco.nxos.nxos_rollback -************************ - -**Set a checkpoint or rollback to a checkpoint.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module offers the ability to set a configuration checkpoint file or rollback to a configuration checkpoint file on Cisco NXOS switches. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- checkpoint_file - -
- string -
- 		- -
Name of checkpoint file to create. Mutually exclusive with rollback_to.
-
-
- rollback_to - -
- string -
- 		- -
Name of checkpoint file to rollback to. Mutually exclusive with checkpoint_file.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Sometimes ``transport=nxapi`` may cause a timeout error. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_rollback: - checkpoint_file: backup.cfg - username: '{{ un }}' - password: '{{ pwd }}' - host: '{{ inventory_hostname }}' - - cisco.nxos.nxos_rollback: - rollback_to: backup.cfg - username: '{{ un }}' - password: '{{ pwd }}' - host: '{{ inventory_hostname }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- filename - -
- string -
- 		success -
The filename of the checkpoint/rollback file.
-
-
Sample:
-
backup.cfg
-
-
- status - -
- string -
- 		success -
Which operation took place and whether it was successful.
-
-
Sample:
-
rollback executed
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_route_maps_module.rst b/docs/cisco.nxos.nxos_route_maps_module.rst deleted file mode 100644 index bcdf6a426..000000000 --- a/docs/cisco.nxos.nxos_route_maps_module.rst +++ /dev/null @@ -1,4368 +0,0 @@ -.. _cisco.nxos.nxos_route_maps_module: - - -************************** -cisco.nxos.nxos_route_maps -************************** - -**Route Maps resource module.** - - -Version added: 2.2.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages route maps configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- list - / elements=dictionary -
- 		- -
A list of route-map configuration.
-
-
- entries - -
- list - / elements=dictionary -
- 		- -
List of entries (identified by sequence number) for this route-map.
-
-
- action - -
- string -
- 		-
    Choices: -
  • deny
    • -
  • permit
    • -
- 		-
Route map denies or permits set operations.
-
-
- continue_sequence - -
- integer -
- 		- -
Continue on a different entry within the route-map.
-
-
- description - -
- string -
- 		- -
Description of the route-map.
-
-
- match - -
- dictionary -
- 		- -
Match values from routing table.
-
-
- as_number - -
- dictionary -
- 		- -
Match BGP peer AS number.
-
-
- as_path_list - -
- list - / elements=string -
- 		- -
AS path access list name.
-
-
- asn - -
- list - / elements=string -
- 		- -
AS number.
-
-
- as_path - -
- list - / elements=string -
- 		- -
Match BGP AS path access-list.
-
-
- community - -
- dictionary -
- 		- -
Match BGP community list.
-
-
- community_list - -
- list - / elements=string -
- 		- -
Community list.
-
-
- exact_match - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do exact matching of communities.
-
-
- evpn - -
- dictionary -
- 		- -
Match BGP EVPN Routes.
-
-
- route_types - -
- list - / elements=string -
- 		- -
Match route type for evpn route.
-
-
- extcommunity - -
- dictionary -
- 		- -
Match BGP community list.
-
-
- exact_match - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do exact matching of extended communities.
-
-
- extcommunity_list - -
- list - / elements=string -
- 		- -
Extended Community list.
-
-
- interfaces - -
- list - / elements=string -
- 		- -
Match first hop interface of route.
-
-
- ip - -
- dictionary -
- 		- -
Configure IP specific information.
-
-
- address - -
- dictionary -
- 		- -
Match address of route or match packet.
-
-
- access_list - -
- string -
- 		- -
IP access-list name (for use in route-maps for PBR only).
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- multicast - -
- dictionary -
- 		- -
Match multicast attributes.
-
-
- group - -
- dictionary -
- 		- -
Multicast Group prefix.
-
Mutually exclusive with group_range.
-
-
- prefix - -
- string -
- 		- -
IPv4 group prefix.
-
-
- group_range - -
- dictionary -
- 		- -
Multicast Group address range.
-
Mutually exclusive with group.
-
-
- first - -
- string -
- 		- -
First Group address.
-
-
- last - -
- string -
- 		- -
Last Group address.
-
-
- rp - -
- dictionary -
- 		- -
Rendezvous point.
-
-
- prefix - -
- string -
- 		- -
IPv4 rendezvous prefix.
-
-
- rp_type - -
- string -
- 		-
    Choices: -
  • ASM
    • -
  • Bidir
    • -
- 		-
Multicast rendezvous point type.
-
-
- source - -
- string -
- 		- -
Multicast source address.
-
-
- next_hop - -
- dictionary -
- 		- -
Match next-hop address of route.
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- route_source - -
- dictionary -
- 		- -
Match advertising source address of route.
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- ipv6 - -
- dictionary -
- 		- -
Configure IPv6 specific information.
-
-
- address - -
- dictionary -
- 		- -
Match address of route or match packet.
-
-
- access_list - -
- string -
- 		- -
IP access-list name (for use in route-maps for PBR only).
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- multicast - -
- dictionary -
- 		- -
Match multicast attributes.
-
-
- group - -
- dictionary -
- 		- -
Multicast Group prefix.
-
Mutually exclusive with group_range.
-
-
- prefix - -
- string -
- 		- -
IPv4 group prefix.
-
-
- group_range - -
- dictionary -
- 		- -
Multicast Group address range.
-
Mutually exclusive with group.
-
-
- first - -
- string -
- 		- -
First Group address.
-
-
- last - -
- string -
- 		- -
Last Group address.
-
-
- rp - -
- dictionary -
- 		- -
Rendezvous point.
-
-
- prefix - -
- string -
- 		- -
IPv4 rendezvous prefix.
-
-
- rp_type - -
- string -
- 		-
    Choices: -
  • ASM
    • -
  • Bidir
    • -
- 		-
Multicast rendezvous point type.
-
-
- source - -
- string -
- 		- -
Multicast source address.
-
-
- next_hop - -
- dictionary -
- 		- -
Match next-hop address of route.
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- route_source - -
- dictionary -
- 		- -
Match advertising source address of route.
-
-
- prefix_lists - -
- list - / elements=string -
- 		- -
Match entries of prefix-lists.
-
-
- mac_list - -
- list - / elements=string -
- 		- -
Match entries of mac-lists.
-
-
- metric - -
- list - / elements=integer -
- 		- -
Match metric of route.
-
-
- ospf_area - -
- list - / elements=integer -
- 		- -
Match ospf area.
-
-
- route_types - -
- list - / elements=string -
- 		-
    Choices: -
  • external
    • -
  • inter-area
    • -
  • internal
    • -
  • intra-area
    • -
  • level-1
    • -
  • level-2
    • -
  • local
    • -
  • nssa-external
    • -
  • type-1
    • -
  • type-2
    • -
- 		-
Match route-type of route.
-
-
- source_protocol - -
- list - / elements=string -
- 		- -
Match source protocol.
-
-
- tags - -
- list - / elements=integer -
- 		- -
Match tag of route.
-
-
- sequence - -
- integer -
- 		- -
Sequence to insert to/delete from existing route-map entry.
-
-
- set - -
- dictionary -
- 		- -
Set values in destination routing protocol.
-
-
- as_path - -
- dictionary -
- 		- -
Prepend string for a BGP AS-path attribute.
-
-
- prepend - -
- dictionary -
- 		- -
Prepend to the AS-Path.
-
-
- as_number - -
- list - / elements=string -
- 		- -
AS number.
-
-
- last_as - -
- integer -
- 		- -
Number of last-AS prepends.
-
-
- tag - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set the tag as an AS-path attribute.
-
-
- comm_list - -
- string -
- 		- -
Set BGP community list (for deletion).
-
-
- community - -
- dictionary -
- 		- -
Set BGP community attribute.
-
-
- additive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Add to existing community.
-
-
- graceful_shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Graceful Shutdown (well-known community).
-
-
- internet - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Internet (well-known community).
-
-
- local_as - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not send outside local AS (well-known community).
-
-
- no_advertise - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not advertise to any peer (well-known community).
-
-
- no_export - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Do not export to next AS (well-known community).
-
-
- number - -
- list - / elements=string -
- 		- -
Community number aa:nn format
-
-
- dampening - -
- dictionary -
- 		- -
Set BGP route flap dampening parameters.
-
-
- half_life - -
- integer -
- 		- -
Half-life time for the penalty.
-
-
- max_suppress_time - -
- integer -
- 		- -
Maximum suppress time for stable route.
-
-
- start_reuse_route - -
- integer -
- 		- -
Value to start reusing a route.
-
-
- start_suppress_route - -
- integer -
- 		- -
Value to start suppressing a route.
-
-
- distance - -
- dictionary -
- 		- -
Configure administrative distance.
-
-
- igp_ebgp_routes - -
- integer -
- 		- -
Administrative distance for IGP or EBGP routes
-
-
- internal_routes - -
- integer -
- 		- -
Distance for internal routes.
-
-
- local_routes - -
- integer -
- 		- -
Distance for local routes.
-
-
- evpn - -
- dictionary -
- 		- -
Set BGP EVPN Routes.
-
-
- gateway_ip - -
- dictionary -
- 		- -
Set gateway IP for type 5 EVPN routes.
-
Cannot set ip and use-nexthop in the same route-map sequence.
-
-
- ip - -
- string -
- 		- -
Gateway IP address.
-
-
- use_nexthop - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use nexthop address as gateway IP.
-
-
- extcomm_list - -
- string -
- 		- -
Set BGP extcommunity list (for deletion).
-
-
- extcommunity - -
- dictionary -
- 		- -
Set BGP extcommunity attribute.
-
-
- rt - -
- dictionary -
- 		- -
Route-Target.
-
-
- additive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Add to existing rt extcommunity.
-
-
- extcommunity_numbers - -
- list - / elements=string -
- 		- -
Extcommunity number.
-
Supported formats are ASN2:NN, ASN4:NN, IPV4:NN.
-
-
- forwarding_address - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set the forwarding address.
-
-
- ip - -
- dictionary -
- 		- -
Configure IP features.
-
-
- address - -
- dictionary -
- 		- -
Specify IP address.
-
-
- prefix_list - -
- string -
- 		- -
Name of prefix list (Max Size 63).
-
-
- next_hop - -
- dictionary -
- 		- -
Set next-hop IP address (for policy-based routing)
-
-
- address - -
- string -
- 		- -
Set space-separated list of next-hop IP addresses. Address ordering is important. Also don`t use unnecessary spaces.
-
-
- drop_on_fail - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Drop packets instead of using default routing when the configured next hop becomes unreachable
-
-
- force_order - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Enable next-hop ordering as specified in the address parameter.
-
-
- load_share - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Enable traffic load balancing across a maximum of 32 next-hop addresses
-
-
- peer_address - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
BGP prefix next hop is set to the local address of the peer.
-
If no next hop is set in the route map, the next hop is set to the one stored in the path.
-
-
- redist_unchanged - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set for next-hop address conservation for non-local generated routes.
-
Used with redistribute command. Available to maintain BGP routing compliant with RFC 4271 on Nexus OS.
-
-
- unchanged - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Set for next-hop address conservation in eBGP outgoing updates
-
-
- verify_availability - -
- list - / elements=dictionary -
- 		- -
Set next-hop ip address tracking with IP SLA
-
-
- address - -
- string - / required -
- 		- -
Set one next-hop address
-
-
- drop_on_fail - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Drop packets instead of using default routing when the configured next hop becomes unreachable
-
-
- force_order - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Enable next-hop ordering as specified in the address parameter.
-
-
- load_share - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Enable traffic load balancing across a maximum of 32 next-hop addresses
-
-
- track - -
- integer - / required -
- 		- -
Set track number
-
-
- precedence - -
- string -
- 		- -
Set precedence field.
-
-
- ipv6 - -
- dictionary -
- 		- -
Configure IPv6 features.
-
-
- address - -
- dictionary -
- 		- -
Specify IP address.
-
-
- prefix_list - -
- string -
- 		- -
Name of prefix list (Max Size 63).
-
-
- precedence - -
- string -
- 		- -
Set precedence field.
-
-
- label_index - -
- integer -
- 		- -
Set Segment Routing (SR) label index of route.
-
-
- level - -
- string -
- 		-
    Choices: -
  • level-1
    • -
  • level-1-2
    • -
  • level-2
    • -
- 		-
Where to import route.
-
-
- local_preference - -
- integer -
- 		- -
BGP local preference path attribute.
-
-
- metric - -
- dictionary -
- 		- -
Set metric for destination routing protocol.
-
-
- bandwidth - -
- integer -
- 		- -
Metric value or Bandwidth in Kbits per second (Max Size 11).
-
-
- igrp_delay_metric - -
- integer -
- 		- -
IGRP delay metric.
-
-
- igrp_effective_bandwidth_metric - -
- integer -
- 		- -
IGRP Effective bandwidth metric (Loading) 255 is 100%.
-
-
- igrp_mtu - -
- integer -
- 		- -
IGRP MTU of the path.
-
-
- igrp_reliability_metric - -
- integer -
- 		- -
IGRP reliability metric where 255 is 100 percent reliable.
-
-
- metric_type - -
- string -
- 		-
    Choices: -
  • external
    • -
  • internal
    • -
  • type-1
    • -
  • type-2
    • -
- 		-
Type of metric for destination routing protocol.
-
-
- nssa_only - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
OSPF NSSA Areas.
-
-
- null_interface - -
- string -
- 		- -
Output Null interface.
-
-
- origin - -
- string -
- 		-
    Choices: -
  • egp
    • -
  • igp
    • -
  • incomplete
    • -
- 		-
BGP origin code.
-
-
- path_selection - -
- string -
- 		-
    Choices: -
  • all
    • -
  • backup
    • -
  • best2
    • -
  • multipaths
    • -
- 		-
Path selection criteria for BGP.
-
-
- tag - -
- integer -
- 		- -
Tag value for destination routing protocol.
-
-
- weight - -
- integer -
- 		- -
BGP weight for routing table.
-
-
- route_map - -
- string -
- 		- -
Route-map name.
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^route-map'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
With state replaced, for the listed route-maps, sequences that are in running-config but not in the task are negated.
-
With state overridden, all route-maps that are in running-config but not in the task are negated.
-
Please refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6. - - Unsupported for Cisco MDS - - This module works with connection ``network_cli`` and ``httpapi``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k-rdo# show running-config | section "^route-map" - # nxos-9k-rdo# - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_route_maps: - config: - - route_map: rmap1 - entries: - - sequence: 10 - action: permit - description: rmap1-10-permit - match: - ip: - address: - access_list: acl_1 - as_path: Allow40 - as_number: - asn: 65564 - - - sequence: 20 - action: deny - description: rmap1-20-deny - match: - community: - community_list: - - BGPCommunity1 - - BGPCommunity2 - ip: - address: - prefix_lists: - - AllowPrefix1 - - AllowPrefix2 - set: - dampening: - half_life: 30 - start_reuse_route: 1500 - start_suppress_route: 10000 - max_suppress_time: 120 - - - route_map: rmap2 - entries: - - sequence: 20 - action: permit - description: rmap2-20-permit - continue_sequence: 40 - match: - ipv6: - address: - prefix_lists: AllowIPv6Prefix - interfaces: "{{ nxos_int1 }}" - set: - as_path: - prepend: - as_number: - - 65563 - - 65568 - - 65569 - comm_list: BGPCommunity - - - sequence: 40 - action: deny - description: rmap2-40-deny - match: - route_types: - - level-1 - - level-2 - tags: 2 - ip: - multicast: - rp: - prefix: 192.0.2.0/24 - rp_type: ASM - source: 203.0.113.0/24 - group_range: - first: 239.0.0.1 - last: 239.255.255.255 - - - route_map: rmap3 - entries: - - sequence: 10 - description: "*** first stanza ***" - action: permit - set: - ip: - next_hop: - verify_availability: - - address: 3.3.3.3 - track: 1 - - address: 4.4.4.4 - track: 3 - - - sequence: 20 - description: "*** second stanza ***" - action: permit - set: - ip: - next_hop: - address: 6.6.6.6 2.2.2.2 - load_share: true - drop_on_fail: true - - - sequence: 30 - description: "*** third stanza ***" - action: permit - set: - ip: - next_hop: - peer_address: true - - - sequence: 40 - description: "*** fourth stanza ***" - action: permit - set: - ip: - next_hop: - unchanged: true - redist_unchanged: true - state: merged - - # Task output - # ------------- - # before: [] - # - # commands: - # - "route-map rmap1 permit 10" - # - "match as-number 65564" - # - "match as-path Allow40" - # - "match ip address acl_1" - # - "description rmap1-10-permit" - # - "route-map rmap1 deny 20" - # - "match community BGPCommunity1 BGPCommunity2" - # - "match ip address prefix-list AllowPrefix1 AllowPrefix2" - # - "description rmap1-20-deny" - # - "set dampening 30 1500 10000 120" - # - "route-map rmap2 permit 20" - # - "match interface Ethernet1/1" - # - "match ipv6 address prefix-list AllowIPv6Prefix" - # - "set as-path prepend 65563 65568 65569" - # - "description rmap2-20-permit" - # - "continue 40" - # - "set comm-list BGPCommunity delete" - # - "route-map rmap2 deny 40" - # - "match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM" - # - "match route-type level-1 level-2" - # - "match tag 2" - # - "description rmap2-40-deny" - # - "route-map rmap3 permit 10" - # - "description *** first stanza ***" - # - "set ip next-hop verify-availability 3.3.3.3 track 1" - # - "set ip next-hop verify-availability 4.4.4.4 track 3" - # - "route-map rmap3 permit 20" - # - "description *** second stanza ***" - # - "set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail" - # - "route-map rmap3 permit 30" - # - "description *** third stanza ***" - # - "set ip next-hop peer-address" - # - "route-map rmap3 permit 40" - # - "description *** fourth stanza ***" - # - "set ip next-hop unchanged" - # - "set ip next-hop redist-unchanged" - # - # after: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # - route_map: rmap3 - # entries: - # - sequence: 10 - # description: "*** first stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # verify_availability: - # - address: 3.3.3.3 - # track: 1 - # - address: 4.4.4.4 - # track: 3 - # - # - sequence: 20 - # description: "*** second stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # address: 6.6.6.6 2.2.2.2 - # load_share: true - # drop_on_fail: true - # - # - sequence: 30 - # description: "*** third stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # peer_address: true - # - # - sequence: 40 - # description: "*** fourth stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # unchanged: true - # redist_unchanged: true - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - # route-map rmap3 permit 10 - # description *** first stanza *** - # set ip next-hop verify-availability 3.3.3.3 track 1 - # set ip next-hop verify-availability 4.4.4.4 track 3 - # route-map rmap3 permit 20 - # description *** second stanza *** - # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail - # route-map rmap3 permit 30 - # description *** third stanza *** - # set ip next-hop peer-address - # route-map rmap3 permit 40 - # description *** fourth stanza *** - # set ip next-hop unchanged - # set ip next-hop redist-unchanged - # - # Using replaced - # (for the listed route-map(s), sequences that are in running-config but not in the task are negated) - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - # route-map rmap3 permit 10 - # description *** first stanza *** - # set ip next-hop verify-availability 3.3.3.3 track 1 - # set ip next-hop verify-availability 4.4.4.4 track 3 - # route-map rmap3 permit 20 - # description *** second stanza *** - # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail - # route-map rmap3 permit 30 - # description *** third stanza *** - # set ip next-hop peer-address - # route-map rmap3 permit 40 - # description *** fourth stanza *** - # set ip next-hop unchanged - # set ip next-hop redist-unchanged - # - - name: Replace route-maps configurations of listed route-maps with provided configurations - cisco.nxos.nxos_route_maps: - config: - - route_map: rmap1 - entries: - - sequence: 20 - action: deny - description: rmap1-20-deny - match: - community: - community_list: - - BGPCommunity4 - - BGPCommunity5 - ip: - address: - prefix_lists: - - AllowPrefix1 - set: - community: - local_as: true - - - route_map: rmap3 - entries: - - sequence: 10 - description: "*** first stanza ***" - action: permit - set: - ip: - next_hop: - verify_availability: - - address: 3.3.3.3 - track: 1 - - sequence: 20 - description: "*** second stanza ***" - action: permit - set: - ip: - next_hop: - peer_address: true - - sequence: 30 - description: "*** third stanza ***" - action: permit - set: - ip: - next_hop: - address: 6.6.6.6 2.2.2.2 - load_share: true - drop_on_fail: true - state: replaced - - # Task output - # ------------- - # before: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # - route_map: rmap3 - # entries: - # - sequence: 10 - # description: "*** first stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # verify_availability: - # - address: 3.3.3.3 - # track: 1 - # - address: 4.4.4.4 - # track: 3 - # - # - sequence: 20 - # description: "*** second stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # address: 6.6.6.6 2.2.2.2 - # load_share: true - # drop_on_fail: true - # - # - sequence: 30 - # description: "*** third stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # peer_address: true - # - # - sequence: 40 - # description: "*** fourth stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # unchanged: true - # redist_unchanged: true - # - # commands: - # - no route-map rmap1 permit 10 - # - route-map rmap1 deny 20 - # - no match community BGPCommunity1 BGPCommunity2 - # - match community BGPCommunity4 BGPCommunity5 - # - no match ip address prefix-list AllowPrefix1 AllowPrefix2 - # - match ip address prefix-list AllowPrefix1 - # - no set dampening 30 1500 10000 120 - # - set community local-AS - # - route-map rmap3 permit 10 - # - no set ip next-hop verify-availability 4.4.4.4 track 3 - # - route-map rmap3 permit 20 - # - no set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail - # - set ip next-hop peer-address - # - route-map rmap3 permit 30 - # - no set ip next-hop peer-address - # - set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail - # - no route-map rmap3 permit 40 - # - # after: - # - route_map: rmap1 - # entries: - # - sequence: 20 - # action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity4 - # - BGPCommunity5 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # set: - # community: - # local_as: true - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # - route_map: rmap3 - # entries: - # - sequence: 10 - # description: "*** first stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # verify_availability: - # - address: 3.3.3.3 - # track: 1 - # - sequence: 20 - # description: "*** second stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # peer_address: true - # - sequence: 30 - # description: "*** third stanza ***" - # action: permit - # set: - # ip: - # next_hop: - # address: 6.6.6.6 2.2.2.2 - # load_share: true - # drop_on_fail: true - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 deny 20 - # description rmap1-20-deny - # match community BGPCommunity4 BGPCommunity5 - # match ip address prefix-list AllowPrefix1 - # set community local-AS - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - # route-map rmap3 permit 10 - # description *** first stanza *** - # set ip next-hop verify-availability 3.3.3.3 track 1 - # route-map rmap3 permit 20 - # description *** second stanza *** - # set ip next-hop peer-address - # route-map rmap3 permit 30 - # description *** third stanza *** - # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail - - # Using overridden - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - - - name: Override all route-maps configuration with provided configuration - cisco.nxos.nxos_route_maps: - config: - - route_map: rmap1 - entries: - - sequence: 20 - action: deny - description: rmap1-20-deny - match: - community: - community_list: - - BGPCommunity4 - - BGPCommunity5 - ip: - address: - prefix_lists: - - AllowPrefix1 - set: - community: - local_as: true - state: overridden - - # Task output - # ------------- - # before: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # commands: - # - no route-map rmap1 permit 10 - # - route-map rmap1 deny 20 - # - no match community BGPCommunity1 BGPCommunity2 - # - match community BGPCommunity4 BGPCommunity5 - # - no match ip address prefix-list AllowPrefix1 AllowPrefix2 - # - match ip address prefix-list AllowPrefix1 - # - no set dampening 30 1500 10000 120 - # - set community local-AS - # - no route-map rmap2 permit 20 - # - no route-map rmap2 deny 40 - # - # after: - # - route_map: rmap1 - # entries: - # - sequence: 20 - # action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity4 - # - BGPCommunity5 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # set: - # community: - # local_as: true - # - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^route-map" - # route-map rmap1 deny 20 - # description rmap1-20-deny - # match community BGPCommunity4 BGPCommunity5 - # match ip address prefix-list AllowPrefix1 - # set community local-AS - - # Using deleted to delete a single route-map - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - - - name: Delete single route-map - cisco.nxos.nxos_route_maps: - config: - - route_map: rmap1 - state: deleted - - # Task output - # ------------- - # before: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # commands: - # - no route-map rmap1 permit 10 - # - no route-map rmap1 deny 20 - # - # after: - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^route-map" - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - - # Using deleted to delete all route-maps from the device running-config - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - - - name: Delete all route-maps - cisco.nxos.nxos_route_maps: - state: deleted - - # Task output - # ------------- - # before: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - # - # commands: - # - no route-map rmap1 permit 10 - # - no route-map rmap1 deny 20 - # - no route-map rmap2 permit 20 - # - no route-map rmap2 deny 40 - # - # after: [] - # - # After state: - # ------------ - # nxos-9k-rdo# sh running-config | section "^route-map" - - - name: Render platform specific configuration lines with state rendered (without connecting to the device) - cisco.nxos.nxos_route_maps: - config: - - route_map: rmap1 - entries: - - sequence: 10 - action: permit - description: rmap1-10-permit - match: - ip: - address: - access_list: acl_1 - as_path: Allow40 - as_number: - asn: 65564 - - - sequence: 20 - action: deny - description: rmap1-20-deny - match: - community: - community_list: - - BGPCommunity1 - - BGPCommunity2 - ip: - address: - prefix_lists: - - AllowPrefix1 - - AllowPrefix2 - set: - dampening: - half_life: 30 - start_reuse_route: 1500 - start_suppress_route: 10000 - max_suppress_time: 120 - - - route_map: rmap2 - entries: - - sequence: 20 - action: permit - description: rmap2-20-permit - continue_sequence: 40 - match: - ipv6: - address: - prefix_lists: AllowIPv6Prefix - interfaces: "{{ nxos_int1 }}" - set: - as_path: - prepend: - as_number: - - 65563 - - 65568 - - 65569 - comm_list: BGPCommunity - - - sequence: 40 - action: deny - description: rmap2-40-deny - match: - route_types: - - level-1 - - level-2 - tags: 2 - ip: - multicast: - rp: - prefix: 192.0.2.0/24 - rp_type: ASM - source: 203.0.113.0/24 - group_range: - first: 239.0.0.1 - last: 239.255.255.255 - state: rendered - - # Task Output (redacted) - # ----------------------- - # rendered: - # - "route-map rmap1 permit 10" - # - "match as-number 65564" - # - "match as-path Allow40" - # - "match ip address acl_1" - # - "description rmap1-10-permit" - # - "route-map rmap1 deny 20" - # - "match community BGPCommunity1 BGPCommunity2" - # - "match ip address prefix-list AllowPrefix1 AllowPrefix2" - # - "description rmap1-20-deny" - # - "set dampening 30 1500 10000 120" - # - "route-map rmap2 permit 20" - # - "match interface Ethernet1/1" - # - "match ipv6 address prefix-list AllowIPv6Prefix" - # - "set as-path prepend 65563 65568 65569" - # - "description rmap2-20-permit" - # - "continue 40" - # - "set comm-list BGPCommunity delete" - # - "route-map rmap2 deny 40" - # - "match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM" - # - "match route-type level-1 level-2" - # - "match tag 2" - # - "description rmap2-40-deny" - - # Using parsed - - # parsed.cfg - # ------------ - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap1 deny 20 - # match community BGPCommunity1 BGPCommunity2 - # match ip address prefix-list AllowPrefix1 AllowPrefix2 - # description rmap1-20-deny - # set dampening 30 1500 10000 120 - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - # route-map rmap2 deny 40 - # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM - # match route-type level-1 level-2 - # match tag 2 - # description rmap2-40-deny - - - name: Parse externally provided route-maps configuration - cisco.nxos.nxos_route_maps: - running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - action: deny - # description: rmap1-20-deny - # match: - # community: - # community_list: - # - BGPCommunity1 - # - BGPCommunity2 - # ip: - # address: - # prefix_lists: - # - AllowPrefix1 - # - AllowPrefix2 - # sequence: 20 - # set: - # dampening: - # half_life: 30 - # max_suppress_time: 120 - # start_reuse_route: 1500 - # start_suppress_route: 10000 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - # - action: deny - # description: rmap2-40-deny - # match: - # ip: - # multicast: - # group_range: - # first: 239.0.0.1 - # last: 239.255.255.255 - # rp: - # prefix: 192.0.2.0/24 - # rp_type: ASM - # source: 203.0.113.0/24 - # route_types: - # - level-1 - # - level-2 - # tags: - # - 2 - # sequence: 40 - - # Using gathered - - # Existing route-map config - # --------------------------- - # nxos-9k-rdo# show running-config | section "^route-map" - # route-map rmap1 permit 10 - # match as-number 65564 - # match as-path Allow40 - # match ip address acl_1 - # description rmap1-10-permit - # route-map rmap2 permit 20 - # match interface Ethernet1/1 - # match ipv6 address prefix-list AllowIPv6Prefix - # set as-path prepend 65563 65568 65569 - # description rmap2-20-permit - # continue 40 - # set comm-list BGPCommunity delete - - - name: Gather route-maps facts using gathered - cisco.nxos.nxos_route_maps: - state: gathered - - # gathered: - # - route_map: rmap1 - # entries: - # - action: permit - # description: rmap1-10-permit - # match: - # as_number: - # asn: - # - '65564' - # as_path: - # - Allow40 - # ip: - # address: - # access_list: acl_1 - # sequence: 10 - # - # - route_map: rmap2 - # entries: - # - action: permit - # continue_sequence: 40 - # description: rmap2-20-permit - # match: - # interfaces: - # - Ethernet1/1 - # ipv6: - # address: - # prefix_lists: - # - AllowIPv6Prefix - # sequence: 20 - # set: - # as_path: - # prepend: - # as_number: - # - '65563' - # - '65568' - # - '65569' - # comm_list: BGPCommunity - # - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- before - -
- dictionary -
- 		always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format - of the parameters above.
-
-
- commands - -
- list -
- 		always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['route-map rmap1 permit 10', 'match as-number 65564', 'match as-path Allow40', 'match ip address acl_1', 'description rmap1-10-permit', 'route-map rmap1 deny 20', 'match community BGPCommunity1 BGPCommunity2']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_rpm_module.rst b/docs/cisco.nxos.nxos_rpm_module.rst deleted file mode 100644 index 79d616a59..000000000 --- a/docs/cisco.nxos.nxos_rpm_module.rst +++ /dev/null @@ -1,226 +0,0 @@ -.. _cisco.nxos.nxos_rpm_module: - - -******************* -cisco.nxos.nxos_rpm -******************* - -**Install patch or feature rpms on Cisco NX-OS devices.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Install software maintenance upgrade (smu) RPMS and 3rd party RPMS on Cisco NX-OS devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
List of RPM/patch definitions.
-
-
- file_system - -
- string -
- 		- -
The remote file system of the device. If omitted, devices that support a file_system parameter will use their default values.
-
-
- pkg - -
- string - / required -
- 		- -
Name of the RPM package.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
- 		-
If the state is present, the rpm will be installed, If the state is absent, it will be removed.
-
-
- file_system - -
- string -
- 		- Default:
"bootflash"
- 		-
The remote file system of the device. If omitted, devices that support a file_system parameter will use their default values.
-
-
- pkg - -
- string -
- 		- -
Name of the RPM package.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
If the state is present, the rpm will be installed, If the state is absent, it will be removed.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.0(3)I2(5), 7.0(3)I4(6), 7.0(3)I5(3), 7.0(3)I6(1), 7.0(3)I7(3) - - Unsupported for Cisco MDS - - For patches, the minimum platform version needed is 7.0(3)I2(5) - - For feature rpms, the minimum platform version needed is 7.0(3)I6(1) - - The module manages the entire RPM lifecycle (Add, activate, commit, deactivate, remove) - - For reload patches, this module is NOT idempotent until the patch is committed. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_rpm: - pkg: nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000.rpm - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['install add bootflash:nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000.rpm forced', 'install activate nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000 forced', 'install commit nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Sai Chintalapudi (@saichint) diff --git a/docs/cisco.nxos.nxos_snapshot_module.rst b/docs/cisco.nxos.nxos_snapshot_module.rst deleted file mode 100644 index fe89b5b7b..000000000 --- a/docs/cisco.nxos.nxos_snapshot_module.rst +++ /dev/null @@ -1,363 +0,0 @@ -.. _cisco.nxos.nxos_snapshot_module: - - -************************ -cisco.nxos.nxos_snapshot -************************ - -**Manage snapshots of the running states of selected features.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Create snapshots of the running states of selected features, add new show commands for snapshot creation, delete and compare existing snapshots. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- action - -
- string - / required -
- 		-
    Choices: -
  • add
    • -
  • compare
    • -
  • create
    • -
  • delete
    • -
  • delete_all
    • -
- 		-
Define what snapshot action the module would perform.
-
-
- compare_option - -
- string -
- 		-
    Choices: -
  • summary
    • -
  • ipv4routes
    • -
  • ipv6routes
    • -
- 		-
Snapshot options to be used when action=compare.
-
-
- comparison_results_file - -
- string -
- 		- -
Name of the file where snapshots comparison will be stored when action=compare.
-
-
- description - -
- string -
- 		- -
Snapshot description to be used when action=create.
-
-
- element_key1 - -
- string -
- 		- -
Specify the tags used to distinguish among row entries, to be used when action=add.
-
-
- element_key2 - -
- string -
- 		- -
Specify the tags used to distinguish among row entries, to be used when action=add.
-
-
- path - -
- string -
- 		- Default:
"./"
- 		-
Specify the path of the file where new created snapshot or snapshots comparison will be stored, to be used when action=create and save_snapshot_locally=true or action=compare.
-
-
- row_id - -
- string -
- 		- -
Specifies the tag of each row entry of the show command's XML output, to be used when action=add.
-
-
- save_snapshot_locally - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Specify to locally store a new created snapshot, to be used when action=create.
-
-
- section - -
- string -
- 		- -
Used to name the show command output, to be used when action=add.
-
-
- show_command - -
- string -
- 		- -
Specify a new show command, to be used when action=add.
-
-
- snapshot1 - -
- string -
- 		- -
First snapshot to be used when action=compare.
-
-
- snapshot2 - -
- string -
- 		- -
Second snapshot to be used when action=compare.
-
-
- snapshot_name - -
- string -
- 		- -
Snapshot name, to be used when action=create or action=delete.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - ``transport=cli`` may cause timeout errors. - - The ``element_key1`` and ``element_key2`` parameter specify the tags used to distinguish among row entries. In most cases, only the element_key1 parameter needs to specified to be able to distinguish among row entries. - - ``action=compare`` will always store a comparison report on a local file. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # Create a snapshot and store it locally - - cisco.nxos.nxos_snapshot: - action: create - snapshot_name: test_snapshot - description: Done with Ansible - save_snapshot_locally: true - path: /home/user/snapshots/ - - # Delete a snapshot - - cisco.nxos.nxos_snapshot: - action: delete - snapshot_name: test_snapshot - - # Delete all existing snapshots - - cisco.nxos.nxos_snapshot: - action: delete_all - - # Add a show command for snapshots creation - - cisco.nxos.nxos_snapshot: - section: myshow - show_command: show ip interface brief - row_id: ROW_intf - element_key1: intf-name - - # Compare two snapshots - - cisco.nxos.nxos_snapshot: - action: compare - snapshot1: pre_snapshot - snapshot2: post_snapshot - comparison_results_file: compare_snapshots.txt - compare_option: summary - path: ../snapshot_reports/ - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		verbose mode -
commands sent to the device
-
-
Sample:
-
['snapshot create post_snapshot Post-snapshot']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_community_module.rst b/docs/cisco.nxos.nxos_snmp_community_module.rst deleted file mode 100644 index 584d2d772..000000000 --- a/docs/cisco.nxos.nxos_snmp_community_module.rst +++ /dev/null @@ -1,201 +0,0 @@ -.. _cisco.nxos.nxos_snmp_community_module: - - -****************************** -cisco.nxos.nxos_snmp_community -****************************** - -**(deprecated, removed after 2024-01-01) Manages SNMP community configs.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated modules released with more functionality -:Alternative: nxos_snmp_server - - - -Synopsis --------- -- Manages SNMP community configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- access - -
- string -
- 		-
    Choices: -
  • ro
    • -
  • rw
    • -
- 		-
Access type for community.
-
-
- acl - -
- string -
- 		- -
ACL name to filter snmp requests or keyword 'default'.
-
-
- community - -
- string - / required -
- 		- -
Case-sensitive community string.
-
-
- group - -
- string -
- 		- -
Group to which the community belongs.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure snmp community is configured - - cisco.nxos.nxos_snmp_community: - community: TESTING7 - group: network-operator - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['snmp-server community TESTING7 group network-operator']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_host_module.rst b/docs/cisco.nxos.nxos_snmp_host_module.rst deleted file mode 100644 index 8aef0b21d..000000000 --- a/docs/cisco.nxos.nxos_snmp_host_module.rst +++ /dev/null @@ -1,288 +0,0 @@ -.. _cisco.nxos.nxos_snmp_host_module: - - -************************* -cisco.nxos.nxos_snmp_host -************************* - -**(deprecated, removed after 2024-01-01) Manages SNMP host configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated modules released with more functionality -:Alternative: nxos_snmp_server - - - -Synopsis --------- -- Manages SNMP host configuration parameters. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- community - -
- string -
- 		- -
Community string or v3 username.
-
-
- snmp_host - -
- string - / required -
- 		- -
IP address of hostname of target host.
-
-
- snmp_type - -
- string -
- 		-
    Choices: -
  • trap
    • -
  • inform
    • -
- 		-
type of message to send to host. If this is not specified, trap type is used.
-
-
- src_intf - -
- string -
- 		- -
Source interface. Must be fully qualified interface name. If state = absent, the interface is removed.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource. If state = present, the host is added to the configuration. If only vrf and/or vrf_filter and/or src_intf are given, they will be added to the existing host configuration. If state = absent, the host is removed if community parameter is given. It is possible to remove only vrf and/or src_int and/or vrf_filter by providing only those parameters and no community parameter.
-
-
- udp - -
- string -
- 		- Default:
"162"
- 		-
UDP port number (0-65535).
-
-
- v3 - -
- string -
- 		-
    Choices: -
  • noauth
    • -
  • auth
    • -
  • priv
    • -
- 		-
Use this when verion is v3. SNMPv3 Security level.
-
-
- version - -
- string -
- 		-
    Choices: -
  • v1
    • -
  • v2c
    • -
  • v3
    • -
- 		-
SNMP version. If this is not specified, v1 is used.
-
-
- vrf - -
- string -
- 		- -
VRF to use to source traffic to source. If state = absent, the vrf is removed.
-
-
- vrf_filter - -
- string -
- 		- -
Name of VRF to filter. If state = absent, the vrf is removed from the filter.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - ``state=absent`` removes the host configuration if it is configured. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure snmp host is configured - - cisco.nxos.nxos_snmp_host: - snmp_host: 192.0.2.3 - community: TESTING - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['snmp-server host 192.0.2.3 filter-vrf another_test_vrf']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_location_module.rst b/docs/cisco.nxos.nxos_snmp_location_module.rst deleted file mode 100644 index 06f564693..000000000 --- a/docs/cisco.nxos.nxos_snmp_location_module.rst +++ /dev/null @@ -1,156 +0,0 @@ -.. _cisco.nxos.nxos_snmp_location_module: - - -***************************** -cisco.nxos.nxos_snmp_location -***************************** - -**(deprecated, removed after 2024-01-01) Manages SNMP location information.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated modules released with more functionality -:Alternative: nxos_snmp_server - - - -Synopsis --------- -- Manages SNMP location configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- location - -
- string - / required -
- 		- -
Location information.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure snmp location is configured - - cisco.nxos.nxos_snmp_location: - location: Test - state: present - - # ensure snmp location is not configured - - cisco.nxos.nxos_snmp_location: - location: Test - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['snmp-server location New_Test']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_server_module.rst b/docs/cisco.nxos.nxos_snmp_server_module.rst deleted file mode 100644 index 126e16341..000000000 --- a/docs/cisco.nxos.nxos_snmp_server_module.rst +++ /dev/null @@ -1,4474 +0,0 @@ -.. _cisco.nxos.nxos_snmp_server_module: - - -*************************** -cisco.nxos.nxos_snmp_server -*************************** - -**SNMP Server resource module.** - - -Version added: 2.8.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages SNMP server configuration on devices running Cisco NX-OS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A dict of SNMP server configuration
-
-
- aaa_user - -
- dictionary -
- 		- -
Set duration for which aaa-cached snmp user exists.
-
-
- cache_timeout - -
- integer -
- 		- -
Timeout for which aaa-cached user exists(in secs).
-
-
- communities - -
- list - / elements=dictionary -
- 		- -
Set community string and access privs.
-
-
- group - -
- string -
- 		- -
Group to which the community belongs.
-
-
- name - -
- string -
- 		- -
SNMP community string (Max Size 32).
-

aliases: community
-
-
- ro - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Read-only access with this community string.
-
-
- rw - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Read-write access with this community string.
-
-
- use_ipv4acl - -
- string -
- 		- -
Specify IPv4 ACL, the ACL name specified must be IPv4 ACL.
-
This option is unsupported on MDS switches.
-
-
- use_ipv6acl - -
- string -
- 		- -
Specify IPv6 ACL, the ACL name specified after must be IPv6 ACL.
-
This option is unsupported on MDS switches.
-
-
- contact - -
- string -
- 		- -
Modify sysContact.
-
-
- context - -
- dictionary -
- 		- -
SNMP context to be mapped.
-
-
- instance - -
- string -
- 		- -
Name of the protocol instance (Max Size 32).
-
-
- name - -
- string -
- 		- -
Name of the SNMP context (Max Size 32).
-
-
- topology - -
- string -
- 		- -
Topology associated with the SNMP context.
-
-
- vrf - -
- string -
- 		- -
VRF associated with the SNMP context.
-
This option is unsupported on MDS switches.
-
-
- counter - -
- dictionary -
- 		- -
Configure port counter configuration.
-
This option is unsupported on MDS switches.
-
-
- cache - -
- dictionary -
- 		- -
Port stats cache.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable port stats cache.
-
-
- timeout - -
- integer -
- 		- -
Timeout for which cached port stats exists(in secs).
-
-
- drop - -
- dictionary -
- 		- -
Silently drop unknown v3 user packets.
-
This option is unsupported on MDS switches.
-
-
- unknown_engine_id - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Unknown v3 engine id.
-
-
- unknown_user - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Unknown v3 user.
-
-
- engine_id - -
- dictionary -
- 		- -
Configure a local SNMPv3 engineID.
-
This option is unsupported on MDS switches.
-
-
- local - -
- string -
- 		- -
EngineID of the local agent.
-
-
- global_enforce_priv - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Globally enforce privacy for all the users.
-
-
- hosts - -
- list - / elements=dictionary -
- 		- -
Specify hosts to receive SNMP notifications.
-
SNMP hosts config lines that appear separately in running-config must be added as individual dictionaries.
-
-
- auth - -
- string -
- 		- -
Use the SNMPv3 authNoPriv Security Level.
-
-
- community - -
- string -
- 		- -
SNMP community string or SNMPv3 user name (Max Size 32).
-
-
- filter_vrf - -
- string -
- 		- -
Filters notifications to the notification host receiver based on the configured VRF.
-
This option is unsupported on MDS switches.
-
-
- host - -
- string -
- 		- -
IPv4 or IPv6 address or DNS Name of SNMP notification host.
-
-
- informs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Inform messages to this host.
-
-
- priv - -
- string -
- 		- -
Use the SNMPv3 authPriv Security Level.
-
-
- source_interface - -
- string -
- 		- -
Source interface to be used for sending out SNMP notifications to this host.
-
-
- traps - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Send Traps messages to this host.
-
-
- udp_port - -
- integer -
- 		- -
The notification host's UDP port number.
-
-
- use_vrf - -
- string -
- 		- -
Configures SNMP to use the selected VRF to communicate with the host receiver.
-
This option is unsupported on MDS switches.
-
-
- version - -
- string -
- 		-
    Choices: -
  • 1
    • -
  • 2c
    • -
  • 3
    • -
- 		-
SNMP version to use for notification messages.
-
-
- location - -
- string -
- 		- -
Modify sysLocation.
-
-
- mib - -
- dictionary -
- 		- -
Mib access parameters.
-
-
- community_map - -
- dictionary -
- 		- -
SNMP community.
-
-
- community - -
- string -
- 		- -
SNMP community string (Max Size 32).
-
-
- context - -
- string -
- 		- -
Name of the SNMP context (Max Size 32).
-
-
- packetsize - -
- integer -
- 		- -
Largest SNMP packet size
-
-
- protocol - -
- dictionary -
- 		- -
Snmp protocol operations.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable snmp protocol operations.
-
-
- source_interface - -
- dictionary -
- 		- -
Source interface to be used for sending out SNMP notifications.
-
This option is unsupported on MDS switches.
-
-
- informs - -
- string -
- 		- -
SNMP Inform notifications for which this source interface needs to be used.
-
-
- traps - -
- string -
- 		- -
SNMP Trap notifications for which this source interface needs to be used.
-
-
- system_shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configure snmp-server for reload(2).
-
-
- tcp_session - -
- dictionary -
- 		- -
Enable one time authentication for snmp over tcp session.
-
-
- auth - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable one time authentication for snmp over tcp session.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable tcp-session.
-
This option is unsupported on MDS switches.
-
-
- traps - -
- dictionary -
- 		- -
Enable SNMP Traps
-
-
- aaa - -
- dictionary -
- 		- -
AAA traps
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable AAA traps.
-
-
- server_state_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
AAA server state change notification.
-
-
- bgp - -
- dictionary -
- 		- -
SNMP BGP traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP BGP traps.
-
-
- bridge - -
- dictionary -
- 		- -
Bridge traps.
-
This option is unsupported on MDS switches.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable bridge traps.
-
-
- newroot - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP STP Bridge MIB newroot traps.
-
-
- topologychange - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP STP Bridge MIB topologychange traps.
-
-
- callhome - -
- dictionary -
- 		- -
Callhome traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable callhome traps.
-
This option is unsupported on MDS switches.
-
-
- event_notify - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Callhome External Event Notification.
-
-
- smtp_send_fail - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
SMTP Message Send Fail notification.
-
-
- cfs - -
- dictionary -
- 		- -
CFS traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable cfs traps.
-
This option is unsupported on MDS switches.
-
-
- merge_failure - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Merge failure notification.
-
-
- state_change_notif - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
State change notification.
-
-
- config - -
- dictionary -
- 		- -
Config traps.
-
-
- ccmCLIRunningConfigChanged - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Running config change trap.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable config traps.
-
This option is unsupported on MDS switches.
-
-
- entity - -
- dictionary -
- 		- -
Entity traps.
-
-
- cefcMIBEnableStatusNotification - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
CefcMIBEnableStatusNotification.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable entity traps.
-
-
- entity_fan_status_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Fan Status Change.
-
-
- entity_mib_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity MIB change.
-
-
- entity_module_inserted - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Module Inserted.
-
-
- entity_module_removed - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Module Removed.
-
-
- entity_module_status_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Module Status Change.
-
-
- entity_power_out_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Power Out Change.
-
-
- entity_power_status_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Power Status Change.
-
-
- entity_sensor - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity sensor.
-
-
- entity_unrecognised_module - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Entity Unrecognised Module.
-
-
- feature_control - -
- dictionary -
- 		- -
Feature-Control traps.
-
-
- ciscoFeatOpStatusChange - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Feature operation status change Notification.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable feature-control traps.
-
This option is unsupported on MDS switches.
-
-
- featureOpStatusChange - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Feature operation status change notification.
-
-
- generic - -
- dictionary -
- 		- -
Generic traps.
-
-
- coldStart - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Generic coldStart trap.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable generic traps.
-
This option is unsupported on MDS switches.
-
-
- warmStart - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Generic warmStart trap.
-
-
- license - -
- dictionary -
- 		- -
License traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable license traps.
-
This option is unsupported on MDS switches.
-
-
- notify_license_expiry - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
License Expiry Notification.
-
-
- notify_license_expiry_warning - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
License Expiry Warning Notification.
-
-
- notify_licensefile_missing - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
License File Missing Notification.
-
-
- notify_no_license_for_feature - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
No License installed for feature Notification.
-
-
- link - -
- dictionary -
- 		- -
Link traps.
-
-
- cErrDisableInterfaceEventRev1 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Err-disable state notification.
-
This option is unsupported on MDS switches.
-
-
- cieLinkDown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Cisco extended link state down notification.
-
-
- cieLinkUp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Cisco extended link state up notification.
-
-
- cisco_xcvr_mon_status_chg - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Cisco interface transceiver monitor status change notification.
-
-
- cmn_mac_move_notification - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Mac addr move trap.
-
This option is unsupported on MDS switches.
-
-
- delayed_link_state_change - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Delayed link state change.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable link traps.
-
This option is unsupported on MDS switches.
-
-
- extended_linkDown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IETF extended link state down notification.
-
-
- extended_linkUp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IETF extended link state up notification.
-
-
- linkDown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IETF Link state down notification.
-
-
- linkUp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IETF Link state up notification.
-
-
- mmode - -
- dictionary -
- 		- -
MMode traps.
-
This option is unsupported on MDS switches.
-
-
- cseMaintModeChangeNotify - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Maint Mode Change Notification.
-
-
- cseNormalModeChangeNotify - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Normal Mode Change Notification.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable mmode traps.
-
-
- ospf - -
- dictionary -
- 		- -
SNMP OSPF traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP OSPF traps.
-
-
- ospfv3 - -
- dictionary -
- 		- -
SNMP OSPFv3 traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP OSPFv3 traps.
-
-
- rf - -
- dictionary -
- 		- -
RF traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable rf traps.
-
This option is unsupported on MDS switches.
-
-
- redundancy_framework - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Redundancy_Framework (RF) Sup switchover MIB.
-
-
- rmon - -
- dictionary -
- 		- -
RMON traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable rmon traps.
-
This option is unsupported on MDS switches.
-
-
- fallingAlarm - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Rmon falling alarm.
-
-
- hcFallingAlarm - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
High capacity Rmon falling alarm.
-
-
- hcRisingAlarm - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
High capacity Rmon rising alarm.
-
-
- risingAlarm - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Rmon rising alarm.
-
-
- snmp - -
- dictionary -
- 		- -
SNMP traps.
-
-
- authentication - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
SNMP authentication trap.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable snmp traps.
-
This option is unsupported on MDS switches.
-
-
- storm_control - -
- dictionary -
- 		- -
Storm-Control traps.
-
-
- cpscEventRev1 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Port-Storm-Control-Event.
-
This option is unsupported on MDS switches.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable storm-control traps.
-
This option is unsupported on MDS switches.
-
-
- trap_rate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Number of traps per minute.
-
-
- stpx - -
- dictionary -
- 		- -
Stpx traps.
-
This option is unsupported on MDS switches.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable stpx traps.
-
-
- inconsistency - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP STPX MIB InconsistencyUpdate traps.
-
-
- loop_inconsistency - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP STPX MIB LoopInconsistencyUpdate traps.
-
-
- root_inconsistency - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable SNMP STPX MIB RootInconsistencyUpdate traps.
-
-
- syslog - -
- dictionary -
- 		- -
Enable syslog traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable syslog traps.
-
This option is unsupported on MDS switches.
-
-
- message_generated - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Message Generated Notification.
-
-
- sysmgr - -
- dictionary -
- 		- -
Sysmgr traps.
-
-
- cseFailSwCoreNotifyExtended - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Software Core Notification.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable sysmgr traps.
-
This option is unsupported on MDS switches.
-
-
- system - -
- dictionary -
- 		- -
System traps.
-
-
- clock_change_notification - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Clock-change-notification traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable system traps.
-
This option is unsupported on MDS switches.
-
-
- upgrade - -
- dictionary -
- 		- -
Upgrade traps.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable upgrade traps.
-
This option is unsupported on MDS switches.
-
-
- upgradeJobStatusNotify - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Upgrade Job Status Notification.
-
-
- upgradeOpNotifyOnCompletion - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Upgrade Global Status Notification.
-
-
- vtp - -
- dictionary -
- 		- -
VTP traps.
-
This option is unsupported on MDS switches.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable VTP traps.
-
-
- notifs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable vtpConfigRevNumberError vtpConfigDigestEnable vtpConfigRevNumberError vtpConfigDigestError vtpServerDisabled vtpVersionOneDeviceDetected vlanTrunkPortDynamicStatusChange vtpLocalModeChanged vtpVersionInUseChanged notification.
-
-
- vlancreate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable vtpVlanCreated notification.
-
-
- vlandelete - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable vtpVlanDeleted notification.
-
-
- users - -
- dictionary -
- 		- -
Define users who can access the SNMP engine.
-
-
- auth - -
- list - / elements=dictionary -
- 		- -
SNMP User authentication related settings
-
-
- authentication - -
- dictionary -
- 		- -
Authentication parameters for the user.
-
-
- algorithm - -
- string -
- 		-
    Choices: -
  • md5
    • -
  • sha
    • -
  • sha-256
    • -
- 		-
Select algorithm for authentication.
-
-
- engine_id - -
- string -
- 		- -
EngineID for configuring notif target user (for V3 informs).
-
This value needs to be enclosed in quotes in the task.
-
-
- localized_key - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specifies whether the passwords are in localized key format.
-
-
- localizedv2_key - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specifies whether the passwords are in localized V2 key format.
-
-
- password - -
- string -
- 		- -
Authentication password for user (Max Size 127).
-
If this value is localized, it has to be enclosed in quotes in the task.
-
-
- priv - -
- dictionary -
- 		- -
Encryption parameters for the user.
-
-
- aes_128 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use 128-bit AES algorithm for privacy.
-
-
- privacy_password - -
- string -
- 		- -
Privacy password for user (Max Size 130).
-
If this value is localized, it has to be enclosed in quotes in the task.
-
-
- group - -
- string -
- 		- -
Group name (ignored for notif target user) (Max Size 28).
-
-
- user - -
- string -
- 		- -
Name of the user (Max Size 28).
-
-
- use_acls - -
- list - / elements=dictionary -
- 		- -
Set IPv4 and IPv6 ACL to use.
-
-
- ipv4 - -
- string -
- 		- -
Specify IPv4 ACL, the ACL name specified after must be IPv4 ACL.
-
-
- ipv6 - -
- string -
- 		- -
Specify IPv6 ACL, the ACL name specified after must be IPv6 ACL.
-
-
- user - -
- string -
- 		- -
Name of the user (Max Size 28).
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^snmp-server'.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- 		-
The state the configuration should be left in.
-
The states replaced and overridden have identical behaviour for this module.
-
Please refer to examples for more details.
-
-
- - -Notes ------ - -.. note:: - - Tested against NX-OS 9.3.6 on Cisco Nexus Switches. - - This module works with connection ``network_cli`` and ``httpapi``. - - Tested against Cisco MDS NX-OS 9.2(2) with connection ``network_cli``. - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - - # Before state: - # ------------- - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - - - name: Merge the provided configuration with the existing running configuration - cisco.nxos.nxos_snmp_server: - config: - aaa_user: - cache_timeout: 36000 - communities: - - community: public - group: network-operator - - community: private - group: network-admin - contact: nxosswitchadmin@localhost - location: serverroom-1 - traps: - aaa: - server_state_change: true - system: - clock_change_notification: true - hosts: - - host: 192.0.2.1 - traps: true - version: '1' - community: public - - host: 192.0.2.1 - source_interface: Ethernet1/1 - - host: 192.0.2.2 - informs: true - version: '3' - auth: NMS - users: - auth: - - user: snmp_user_1 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - - user: snmp_user_2 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - priv: - privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' - aes_128: true - use_acls: - - user: snmp_user_1 - ipv4: acl1 - ipv6: acl2 - - user: snmp_user_2 - ipv4: acl3 - ipv6: acl4 - - # Task output - # ------------- - # before: - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # - # commands: - # - snmp-server contact nxosswitchadmin@localhost - # - snmp-server location serverroom-1 - # - snmp-server aaa-user cache-timeout 36000 - # - snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # - snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # - snmp-server host 192.0.2.1 traps version 1 public - # - snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # - snmp-server host 192.0.2.2 informs version 3 auth NMS - # - snmp-server community private group network-admin - # - snmp-server community public group network-operator - # - snmp-server enable traps aaa server-state-change - # - snmp-server enable traps system Clock-change-notification - # - # after: - # aaa_user: - # cache_timeout: 36000 - # communities: - # - community: private - # group: network-admin - # - community: public - # group: network-operator - # contact: nxosswitchadmin@localhost - # location: serverroom-1 - # traps: - # aaa: - # server_state_change: true - # system: - # clock_change_notification: true - # hosts: - # - host: 192.0.2.1 - # traps: true - # version: "1" - # community: public - # - # - host: 192.0.2.1 - # source_interface: Ethernet1/1 - # - # - host: 192.0.2.2 - # informs: true - # version: "3" - # auth: NMS - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # - # - user: snmp_user_1 - # group: network-operator - # authentication: - # algorithm: md5 - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # localized_key: true - # - # - authentication: - # algorithm: md5 - # localized_key: true - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # priv: - # aes_128: true - # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" - # group: network-operator - # user: snmp_user_2 - # - # use_acls: - # - user: snmp_user_1 - # ipv4: acl1 - # ipv6: acl2 - # - user: snmp_user_2 - # ipv4: acl3 - # ipv6: acl4 - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server contact nxosswitchadmin@localhost - # snmp-server location serverroom-1 - # snmp-server aaa-user cache-timeout 36000 - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # snmp-server host 192.0.2.1 traps version 1 public - # snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # snmp-server host 192.0.2.2 informs version 3 auth NMS - # snmp-server community private group network-admin - # snmp-server community public group network-operator - # snmp-server enable traps aaa server-state-change - # snmp-server enable traps system Clock-change-notification - - # Using replaced - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server contact nxosswitchadmin@localhost - # snmp-server location serverroom-1 - # snmp-server aaa-user cache-timeout 36000 - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # snmp-server host 192.0.2.1 traps version 1 public - # snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # snmp-server host 192.0.2.2 informs version 3 auth NMS - # snmp-server community private group network-admin - # snmp-server community public group network-operator - # snmp-server enable traps aaa server-state-change - # snmp-server enable traps system Clock-change-notification - - - name: Replace snmp-server configurations of listed snmp-server with provided configurations - cisco.nxos.nxos_snmp_server: - config: - aaa_user: - cache_timeout: 36000 - communities: - - community: public - group: network-operator - - community: secret - group: network-operator - contact: nxosswitchadmin2@localhost - location: serverroom-2 - traps: - aaa: - server_state_change: true - hosts: - - host: 192.0.2.1 - traps: true - version: '1' - community: public - - host: 192.0.2.1 - source_interface: Ethernet1/1 - - host: 192.0.3.2 - informs: true - version: '3' - auth: NMS - users: - auth: - - user: admin - group: network-admin - authentication: - algorithm: md5 - password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - localized_key: true - priv: - privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - - - user: snmp_user_1 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - - - user: snmp_user_2 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - priv: - privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' - aes_128: true - use_acls: - - user: snmp_user_1 - ipv4: acl1 - ipv6: acl2 - state: replaced - - # Task output - # ------------- - # before: - # aaa_user: - # cache_timeout: 36000 - # communities: - # - community: private - # group: network-admin - # - community: public - # group: network-operator - # contact: nxosswitchadmin@localhost - # location: serverroom-1 - # traps: - # aaa: - # server_state_change: true - # system: - # clock_change_notification: true - # hosts: - # - host: 192.0.2.1 - # traps: true - # version: "1" - # community: public - # - # - host: 192.0.2.1 - # source_interface: Ethernet1/1 - # - # - host: 192.0.2.2 - # informs: true - # version: "3" - # auth: NMS - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # - # - user: snmp_user_1 - # group: network-operator - # authentication: - # algorithm: md5 - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # localized_key: true - # - # - authentication: - # algorithm: md5 - # localized_key: true - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # priv: - # aes_128: true - # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" - # group: network-operator - # user: snmp_user_2 - # - # use_acls: - # - user: snmp_user_1 - # ipv4: acl1 - # ipv6: acl2 - # - user: snmp_user_2 - # ipv4: acl3 - # ipv6: acl4 - # - # commands: - # - snmp-server contact nxosswitchadmin2@localhost - # - no snmp-server enable traps system Clock-change-notification - # - snmp-server location serverroom-2 - # - no snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # - no snmp-server host 192.0.2.2 informs version 3 auth NMS - # - snmp-server host 192.0.3.2 informs version 3 auth NMS - # - no snmp-server community private group network-admin - # - snmp-server community secret group network-operator - # - # after: - # aaa_user: - # cache_timeout: 36000 - # communities: - # - community: public - # group: network-operator - # - community: secret - # group: network-operator - # contact: nxosswitchadmin2@localhost - # location: serverroom-2 - # traps: - # aaa: - # server_state_change: true - # hosts: - # - host: 192.0.2.1 - # traps: true - # version: '1' - # community: public - # - host: 192.0.2.1 - # source_interface: Ethernet1/1 - # - host: 192.0.3.2 - # informs: true - # version: '3' - # auth: NMS - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # - # - user: snmp_user_1 - # group: network-operator - # authentication: - # algorithm: md5 - # password: '0x5632724fb8ac3699296af26281e1d0f1' - # localized_key: true - # - # - user: snmp_user_2 - # group: network-operator - # authentication: - # algorithm: md5 - # password: '0x5632724fb8ac3699296af26281e1d0f1' - # localized_key: true - # priv: - # privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' - # aes_128: true - # - # use_acls: - # - user: snmp_user_1 - # ipv4: acl1 - # ipv6: acl2 - # - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server contact nxosswitchadmin2@localhost - # snmp-server location serverroom-2 - # snmp-server aaa-user cache-timeout 36000 - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # snmp-server host 192.0.2.1 traps version 1 public - # snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # snmp-server host 192.0.2.2 informs version 3 auth NMS - # snmp-server community secret group network-operator - # snmp-server community public group network-operator - # snmp-server enable traps aaa server-state-change - # snmp-server enable traps system Clock-change-notification - - # Using deleted - - # Before state: - # ------------ - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server contact nxosswitchadmin@localhost - # snmp-server location serverroom-1 - # snmp-server aaa-user cache-timeout 36000 - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # snmp-server host 192.0.2.1 traps version 1 public - # snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # snmp-server host 192.0.2.2 informs version 3 auth NMS - # snmp-server community private group network-admin - # snmp-server community public group network-operator - # snmp-server enable traps aaa server-state-change - # snmp-server enable traps system Clock-change-notification - - - name: Delete SNMP Server configurations from the device (admin user will not be deleted) - cisco.nxos.nxos_snmp_server: - state: deleted - - # Task output - # ------------- - # before: - # aaa_user: - # cache_timeout: 36000 - # communities: - # - community: private - # group: network-admin - # - community: public - # group: network-operator - # contact: nxosswitchadmin@localhost - # location: serverroom-1 - # traps: - # aaa: - # server_state_change: true - # system: - # clock_change_notification: true - # hosts: - # - host: 192.0.2.1 - # traps: true - # version: "1" - # community: public - # - # - host: 192.0.2.1 - # source_interface: Ethernet1/1 - # - # - host: 192.0.2.2 - # informs: true - # version: "3" - # auth: NMS - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # - # - user: snmp_user_1 - # group: network-operator - # authentication: - # algorithm: md5 - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # localized_key: true - # - # - authentication: - # algorithm: md5 - # localized_key: true - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # priv: - # aes_128: true - # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" - # group: network-operator - # user: snmp_user_2 - # - # use_acls: - # - user: snmp_user_1 - # ipv4: acl1 - # ipv6: acl2 - # - user: snmp_user_2 - # ipv4: acl3 - # ipv6: acl4 - # - # commands: - # - no snmp-server contact nxosswitchadmin@localhost - # - no snmp-server location serverroom-1 - # - no snmp-server aaa-user cache-timeout 36000 - # - no snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - # - no snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - no snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - no snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # - no snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # - no snmp-server host 192.0.2.1 traps version 1 public - # - no snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # - no snmp-server host 192.0.2.2 informs version 3 auth NMS - # - no snmp-server community private group network-admin - # - no snmp-server community public group network-operator - # - no snmp-server enable traps aaa server-state-change - # - no snmp-server enable traps system Clock-change-notification - # - # after: - # users: - # auth: - # - user: admin - # group: network-admin - # authentication: - # algorithm: md5 - # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - # localized_key: true - # priv: - # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" - - # After state: - # ------------ - # nxos-9k-rdo# show running-config | section "^snmp-server" - # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey - - # Using rendered - # --------------- - - - name: Render platform specific configuration lines with state rendered (without connecting to the device) - cisco.nxos.nxos_snmp_server: - config: - aaa_user: - cache_timeout: 36000 - communities: - - community: public - group: network-operator - - community: private - group: network-admin - contact: nxosswitchadmin@localhost - location: serverroom-1 - traps: - aaa: - server_state_change: true - system: - clock_change_notification: true - hosts: - - host: 192.0.2.1 - traps: true - version: '1' - community: public - - host: 192.0.2.1 - source_interface: Ethernet1/1 - - host: 192.0.2.2 - informs: true - version: '3' - auth: NMS - users: - auth: - - user: snmp_user_1 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - - user: snmp_user_2 - group: network-operator - authentication: - algorithm: md5 - password: '0x5632724fb8ac3699296af26281e1d0f1' - localized_key: true - priv: - privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' - aes_128: true - use_acls: - - user: snmp_user_1 - ipv4: acl1 - ipv6: acl2 - - user: snmp_user_2 - ipv4: acl3 - ipv6: acl4 - state: rendered - - - # Task Output (redacted) - # ----------------------- - # rendered: - # - snmp-server contact nxosswitchadmin@localhost - # - snmp-server location serverroom-1 - # - snmp-server aaa-user cache-timeout 36000 - # - snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # - snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # - snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # - snmp-server host 192.0.2.1 traps version 1 public - # - snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # - snmp-server host 192.0.2.2 informs version 3 auth NMS - # - snmp-server community private group network-admin - # - snmp-server community public group network-operator - # - snmp-server enable traps aaa server-state-change - # - snmp-server enable traps system Clock-change-notification - - # Using parsed - - # parsed.cfg - # ------------ - # snmp-server contact nxosswitchadmin@localhost - # snmp-server location serverroom-1 - # snmp-server aaa-user cache-timeout 36000 - # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey - # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 - # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 - # snmp-server host 192.0.2.1 traps version 1 public - # snmp-server host 192.0.2.1 source-interface Ethernet1/1 - # snmp-server host 192.0.2.2 informs version 3 auth NMS - # snmp-server community private group network-admin - # snmp-server community public group network-operator - # snmp-server enable traps aaa server-state-change - # snmp-server enable traps system Clock-change-notification - - - name: Parse externally provided snmp-server configuration - cisco.nxos.nxos_snmp_server: - running_config: "{{ lookup('file', './parsed.cfg') }}" - state: parsed - - # Task output (redacted) - # ----------------------- - # parsed: - # aaa_user: - # cache_timeout: 36000 - # communities: - # - community: private - # group: network-admin - # - community: public - # group: network-operator - # contact: nxosswitchadmin@localhost - # location: serverroom-1 - # traps: - # aaa: - # server_state_change: true - # system: - # clock_change_notification: true - # hosts: - # - host: 192.0.2.1 - # traps: true - # version: "1" - # community: public - # - # - host: 192.0.2.1 - # source_interface: Ethernet1/1 - # - # - host: 192.0.2.2 - # informs: true - # version: "3" - # auth: NMS - # users: - # auth: - # - user: snmp_user_1 - # group: network-operator - # authentication: - # algorithm: md5 - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # localized_key: true - # - # - authentication: - # algorithm: md5 - # localized_key: true - # password: "0x5632724fb8ac3699296af26281e1d0f1" - # priv: - # aes_128: true - # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" - # group: network-operator - # user: snmp_user_2 - # - # use_acls: - # - user: snmp_user_1 - # ipv4: acl1 - # ipv6: acl2 - # - user: snmp_user_2 - # ipv4: acl3 - # ipv6: acl4 - # - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['sample command 1', 'sample command 2', 'sample command 3']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['sample command 1', 'sample command 2', 'sample command 3']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_snmp_traps_module.rst b/docs/cisco.nxos.nxos_snmp_traps_module.rst deleted file mode 100644 index 726a4d5fe..000000000 --- a/docs/cisco.nxos.nxos_snmp_traps_module.rst +++ /dev/null @@ -1,189 +0,0 @@ -.. _cisco.nxos.nxos_snmp_traps_module: - - -************************** -cisco.nxos.nxos_snmp_traps -************************** - -**(deprecated, removed after 2024-01-01) Manages SNMP traps.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated modules released with more functionality -:Alternative: nxos_snmp_server - - - -Synopsis --------- -- Manages SNMP traps configurations. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- group - -
- string - / required -
- 		-
    Choices: -
  • aaa
    • -
  • bfd
    • -
  • bgp
    • -
  • bridge
    • -
  • callhome
    • -
  • cfs
    • -
  • config
    • -
  • eigrp
    • -
  • entity
    • -
  • feature-control
    • -
  • generic
    • -
  • hsrp
    • -
  • license
    • -
  • link
    • -
  • lldp
    • -
  • mmode
    • -
  • ospf
    • -
  • pim
    • -
  • rf
    • -
  • rmon
    • -
  • snmp
    • -
  • storm-control
    • -
  • stpx
    • -
  • switchfabric
    • -
  • syslog
    • -
  • sysmgr
    • -
  • system
    • -
  • upgrade
    • -
  • vtp
    • -
  • all
    • -
- 		-
Case sensitive group.
-
-
- state - -
- string -
- 		-
    Choices: -
  • enabled ←
    • -
  • disabled
    • -
- 		-
Manage the state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - This module works at the group level for traps. If you need to only enable/disable 1 specific trap within a group, use the :ref:`cisco.nxos.nxos_command ` module. - - Be aware that you can set a trap only for an enabled feature. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure lldp trap configured - - cisco.nxos.nxos_snmp_traps: - group: lldp - state: enabled - - # ensure lldp trap is not configured - - cisco.nxos.nxos_snmp_traps: - group: lldp - state: disabled - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
snmp-server enable traps lldp ;
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_snmp_user_module.rst b/docs/cisco.nxos.nxos_snmp_user_module.rst deleted file mode 100644 index 2d3f6f26c..000000000 --- a/docs/cisco.nxos.nxos_snmp_user_module.rst +++ /dev/null @@ -1,235 +0,0 @@ -.. _cisco.nxos.nxos_snmp_user_module: - - -************************* -cisco.nxos.nxos_snmp_user -************************* - -**(deprecated, removed after 2024-01-01) Manages SNMP users for monitoring.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2024-01-01 -:Why: Updated modules released with more functionality -:Alternative: nxos_snmp_server - - - -Synopsis --------- -- Manages SNMP user configuration. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- authentication - -
- string -
- 		-
    Choices: -
  • md5
    • -
  • sha
    • -
- 		-
Authentication parameters for the user.
-
-
- encrypt - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables AES-128 bit encryption when using privacy password.
-
-
- group - -
- string -
- 		- -
Group to which the user will belong to. If state = present, and the user is existing, the group is added to the user. If the user is not existing, user entry is created with this group argument. If state = absent, only the group is removed from the user entry. However, to maintain backward compatibility, if the existing user belongs to only one group, and if group argument is same as the existing user's group, then the user entry also is deleted.
-
-
- privacy - -
- string -
- 		- -
Privacy password for the user. This is not idempotent
-
-
- pwd - -
- string -
- 		- -
Authentication password when using md5 or sha. This is not idempotent
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- user - -
- string - / required -
- 		- -
Name of the user.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Limited Support for Cisco MDS - - Authentication parameters not idempotent. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_snmp_user: - user: ntc - group: network-operator - authentication: md5 - pwd: test_password - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['snmp-server user ntc network-operator auth md5 test_password']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2024-01-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_udld_interface_module.rst b/docs/cisco.nxos.nxos_udld_interface_module.rst deleted file mode 100644 index cba2733c0..000000000 --- a/docs/cisco.nxos.nxos_udld_interface_module.rst +++ /dev/null @@ -1,250 +0,0 @@ -.. _cisco.nxos.nxos_udld_interface_module: - - -****************************** -cisco.nxos.nxos_udld_interface -****************************** - -**Manages UDLD interface configuration params.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages UDLD interface configuration params. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- interface - -
- string - / required -
- 		- -
FULL name of the interface, i.e. Ethernet1/1-
-
-
- mode - -
- string - / required -
- 		-
    Choices: -
  • enabled
    • -
  • disabled
    • -
  • aggressive
    • -
- 		-
Manages UDLD mode for an interface.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Feature UDLD must be enabled on the device to use this module. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure Ethernet1/1 is configured to be in aggressive mode - - cisco.nxos.nxos_udld_interface: - interface: Ethernet1/1 - mode: aggressive - state: present - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - # Remove the aggressive config only if it's currently in aggressive mode and then disable udld (switch default) - - cisco.nxos.nxos_udld_interface: - interface: Ethernet1/1 - mode: aggressive - state: absent - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - # ensure Ethernet1/1 has aggressive mode enabled - - cisco.nxos.nxos_udld_interface: - interface: Ethernet1/1 - mode: enabled - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- end_state - -
- dictionary -
- 		always -
k/v pairs of configuration after module execution
-
-
Sample:
-
{'mode': 'enabled'}
-
-
- existing - -
- dictionary -
- 		always -
k/v pairs of existing configuration
-
-
Sample:
-
{'mode': 'aggressive'}
-
-
- proposed - -
- dictionary -
- 		always -
k/v pairs of parameters passed into module
-
-
Sample:
-
{'mode': 'enabled'}
-
-
- updates - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['interface ethernet1/33', 'no udld aggressive ; no udld disable']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_udld_module.rst b/docs/cisco.nxos.nxos_udld_module.rst deleted file mode 100644 index dc461bc89..000000000 --- a/docs/cisco.nxos.nxos_udld_module.rst +++ /dev/null @@ -1,256 +0,0 @@ -.. _cisco.nxos.nxos_udld_module: - - -******************** -cisco.nxos.nxos_udld -******************** - -**Manages UDLD global configuration params.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages UDLD global configuration params. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggressive - -
- string -
- 		-
    Choices: -
  • enabled
    • -
  • disabled
    • -
- 		-
Toggles aggressive mode.
-
-
- msg_time - -
- string -
- 		- -
Message time in seconds for UDLD packets or keyword 'default'.
-
-
- reset - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Ability to reset all ports shut down by UDLD. 'state' parameter cannot be 'absent' when this is present.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manage the state of the resource. When set to 'absent', aggressive and msg_time are set to their default values.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Module will fail if the udld feature has not been previously enabled. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - # ensure udld aggressive mode is globally disabled and se global message interval is 20 - - cisco.nxos.nxos_udld: - aggressive: disabled - msg_time: 20 - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - # Ensure agg mode is globally enabled and msg time is 15 - - cisco.nxos.nxos_udld: - aggressive: enabled - msg_time: 15 - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
check to see if a change was made on the device
-
-
Sample:
-
True
-
-
- end_state - -
- dictionary -
- 		always -
k/v pairs of udld configuration after module execution
-
-
Sample:
-
{'aggressive': 'enabled', 'msg_time': '40'}
-
-
- existing - -
- dictionary -
- 		always -
k/v pairs of existing udld configuration
-
-
Sample:
-
{'aggressive': 'disabled', 'msg_time': '15'}
-
-
- proposed - -
- dictionary -
- 		always -
k/v pairs of parameters passed into module
-
-
Sample:
-
{'aggressive': 'enabled', 'msg_time': '40'}
-
-
- updates - -
- list -
- 		always -
command sent to the device
-
-
Sample:
-
['udld message-time 40', 'udld aggressive']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_user_module.rst b/docs/cisco.nxos.nxos_user_module.rst deleted file mode 100644 index a03a23a03..000000000 --- a/docs/cisco.nxos.nxos_user_module.rst +++ /dev/null @@ -1,390 +0,0 @@ -.. _cisco.nxos.nxos_user_module: - - -******************** -cisco.nxos.nxos_user -******************** - -**Manage the collection of local users on Nexus devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module provides declarative management of the local usernames configured on Cisco Nexus devices. It allows playbooks to manage either individual usernames or the collection of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
The set of username objects to be configured on the remote Cisco Nexus device. The list entries can either be the username or a hash of username and properties. This argument is mutually exclusive with the name argument.
-

aliases: users, collection
-
-
- configured_password - -
- string -
- 		- -
The password to be configured on the network device. The password needs to be provided in cleartext and it will be encrypted on the device.
-
-
- hashed_password - -
- string -
- 		- -
The hashed password to be configured on the network device. The password needs to already be encrypted.
-
-
- name - -
- string -
- 		- -
The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
-
-
- roles - -
- list - / elements=string -
- 		- -
The role argument configures the role for the username in the device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device.
-

aliases: role
-
-
- sshkey - -
- string -
- 		- -
The sshkey argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
- 		-
The state argument configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
-
-
- update_password - -
- string -
- 		-
    Choices: -
  • on_create
    • -
  • always
    • -
- 		-
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
-
-
- configured_password - -
- string -
- 		- -
The password to be configured on the network device. The password needs to be provided in cleartext and it will be encrypted on the device.
-
-
- hashed_password - -
- string -
- 		- -
The hashed password to be configured on the network device. The password needs to already be encrypted.
-
-
- name - -
- string -
- 		- -
The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
-
-
- purge - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
The purge argument instructs the module to consider the resource definition absolute. It will remove any previously configured usernames on the device with the exception of the `admin` user which cannot be deleted per nxos constraints.
-
-
- roles - -
- list - / elements=string -
- 		- -
The role argument configures the role for the username in the device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device.
-

aliases: role
-
-
- sshkey - -
- string -
- 		- -
The sshkey argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
The state argument configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
-
-
- update_password - -
- string -
- 		-
    Choices: -
  • on_create
    • -
  • always ←
    • -
- 		-
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
-
-
- - -Notes ------ - -.. note:: - - Limited Support for Cisco MDS - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: create a new user - cisco.nxos.nxos_user: - name: ansible - sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}" - state: present - - - name: remove all users except admin - cisco.nxos.nxos_user: - purge: true - - - name: set multiple users role - cisco.nxos.nxos_user: - aggregate: - - name: netop - - name: netend - role: network-operator - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['name ansible', 'name ansible password password']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_vpc_module.rst b/docs/cisco.nxos.nxos_vpc_module.rst deleted file mode 100644 index 9e0ca3c29..000000000 --- a/docs/cisco.nxos.nxos_vpc_module.rst +++ /dev/null @@ -1,352 +0,0 @@ -.. _cisco.nxos.nxos_vpc_module: - - -******************* -cisco.nxos.nxos_vpc -******************* - -**Manages global VPC configuration** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages global VPC configuration - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- auto_recovery - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/Disables auto recovery on platforms that support disable
-
timers are not modifiable with this attribute
-
mutually exclusive with auto_recovery_reload_delay
-
-
- auto_recovery_reload_delay - -
- string -
- 		- -
Manages auto-recovery reload-delay timer in seconds
-
mutually exclusive with auto_recovery
-
-
- delay_restore - -
- string -
- 		- -
manages delay restore command and config value in seconds
-
-
- delay_restore_interface_vlan - -
- string -
- 		- -
manages delay restore interface-vlan command and config value in seconds
-
not supported on all platforms
-
-
- delay_restore_orphan_port - -
- string -
- 		- -
manages delay restore orphan-port command and config value in seconds
-
not supported on all platforms
-
-
- domain - -
- string - / required -
- 		- -
VPC domain
-
-
- peer_gw - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables/Disables peer gateway
-
-
- pkl_dest - -
- string -
- 		- -
Destination (remote) IP address used for peer keepalive link
-
pkl_dest is required whenever pkl options are used.
-
-
- pkl_src - -
- string -
- 		- -
Source IP address used for peer keepalive link
-
-
- pkl_vrf - -
- string -
- 		- -
VRF used for peer keepalive link
-
The VRF must exist on the device before using pkl_vrf.
-
(Note) 'default' is an overloaded term: Default vrf context for pkl_vrf is 'management'; 'pkl_vrf: default' refers to the literal 'default' rib.
-
-
- role_priority - -
- string -
- 		- -
Role priority for device. Remember lower is better.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manages desired state of the resource
-
-
- system_priority - -
- string -
- 		- -
System priority device. Remember they must match between peers.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - The feature vpc must be enabled before this module can be used - - If not using management vrf, vrf must be globally on the device before using in the pkl config - - Although source IP isn't required on the command line it is required when using this module. The PKL VRF must also be configured prior to using this module. - - Both pkl_src and pkl_dest are needed when changing PKL VRF. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: configure a simple asn - cisco.nxos.nxos_vpc: - domain: 100 - role_priority: 1000 - system_priority: 2000 - pkl_dest: 192.168.100.4 - pkl_src: 10.1.100.20 - peer_gw: true - auto_recovery: true - - - name: configure - cisco.nxos.nxos_vpc: - domain: 100 - role_priority: 32667 - system_priority: 2000 - peer_gw: true - pkl_src: 10.1.100.2 - pkl_dest: 192.168.100.4 - auto_recovery: true - - - name: Configure VPC with delay restore and existing keepalive VRF - cisco.nxos.nxos_vpc: - domain: 10 - role_priority: 28672 - system_priority: 2000 - delay_restore: 180 - peer_gw: true - pkl_src: 1.1.1.2 - pkl_dest: 1.1.1.1 - pkl_vrf: vpckeepalive - auto_recovery: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['vpc domain 100', 'peer-keepalive destination 192.168.100.4 source 10.1.100.20 vrf management', 'auto-recovery', 'peer-gateway']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vrf_af_module.rst b/docs/cisco.nxos.nxos_vrf_af_module.rst deleted file mode 100644 index 236991587..000000000 --- a/docs/cisco.nxos.nxos_vrf_af_module.rst +++ /dev/null @@ -1,300 +0,0 @@ -.. _cisco.nxos.nxos_vrf_af_module: - - -********************** -cisco.nxos.nxos_vrf_af -********************** - -**Manages VRF AF.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages VRF AF - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- afi - -
- string - / required -
- 		-
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- 		-
Address-Family Identifier (AFI).
-
-
- route_target_both_auto_evpn - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable the EVPN route-target 'auto' setting for both import and export target communities.
-
-
- route_targets - -
- list - / elements=dictionary -
- 		- -
Specify the route-targets which should be imported and/or exported under the AF. This argument accepts a list of dicts that specify the route-target, the direction (import|export|both) and state of each route-target. Default direction is direction=both. See examples.
-
-
- direction - -
- string -
- 		-
    Choices: -
  • import
    • -
  • export
    • -
  • both ←
    • -
- 		-
Indicates the direction of the route-target (import|export|both)
-
-
- rt - -
- string - / required -
- 		- -
Defines the route-target itself
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Determines whether the route-target with the given direction should be present or not on the device.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Determines whether the config should be present or not on the device.
-
-
- vrf - -
- string - / required -
- 		- -
Name of the VRF.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Default, where supported, restores params default value. - - In case of ``state=absent`` the address-family configuration will be absent. Therefore the options ``route_target_both_auto_evpn`` and ``route_targets`` are ignored. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_target_both_auto_evpn: true - state: present - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_targets: - - rt: '65000:1000' - direction: import - - rt: '65001:1000' - direction: import - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_targets: - - rt: '65000:1000' - direction: import - - rt: '65001:1000' - state: absent - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_targets: - - rt: '65000:1000' - direction: export - - rt: '65001:1000' - direction: export - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_targets: - - rt: '65000:1000' - direction: export - state: absent - - cisco.nxos.nxos_vrf_af: - vrf: ntc - afi: ipv4 - route_targets: - - rt: '65000:1000' - direction: both - state: present - - rt: '65001:1000' - direction: import - state: present - - rt: '65002:1000' - direction: both - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['vrf context ntc', 'address-family ipv4 unicast']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vrf_module.rst b/docs/cisco.nxos.nxos_vrf_module.rst deleted file mode 100644 index 6765f78b5..000000000 --- a/docs/cisco.nxos.nxos_vrf_module.rst +++ /dev/null @@ -1,494 +0,0 @@ -.. _cisco.nxos.nxos_vrf_module: - - -******************* -cisco.nxos.nxos_vrf -******************* - -**Manages global VRF configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module provides declarative management of VRFs on CISCO NXOS network devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- admin_state - -
- string -
- 		-
    Choices: -
  • up ←
    • -
  • down
    • -
- 		-
Administrative state of the VRF.
-
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
List of VRFs definitions.
-
-
- admin_state - -
- string -
- 		-
    Choices: -
  • up
    • -
  • down
    • -
- 		-
Administrative state of the VRF.
-
-
- associated_interfaces - -
- list - / elements=string -
- 		- -
This is a intent option and checks the operational state of the for given vrf name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vrf interfaces on device it will result in failure.
-
-
- delay - -
- integer -
- 		- -
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
-
-
- description - -
- string -
- 		- -
Description of the VRF or keyword 'default'.
-
-
- interfaces - -
- list - / elements=string -
- 		- -
List of interfaces to check the VRF has been configured correctly or keyword 'default'.
-
-
- name - -
- string -
- 		- -
Name of VRF to be managed.
-

aliases: vrf
-
-
- rd - -
- string -
- 		- -
VPN Route Distinguisher (RD). Valid values are a string in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword 'auto', or the keyword 'default'.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
- 		-
Manages desired state of the resource.
-
-
- vni - -
- string -
- 		- -
Specify virtual network identifier. Valid values are Integer or keyword 'default'.
-
-
- associated_interfaces - -
- list - / elements=string -
- 		- -
This is a intent option and checks the operational state of the for given vrf name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vrf interfaces on device it will result in failure.
-
-
- delay - -
- integer -
- 		- Default:
10
- 		-
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
-
-
- description - -
- string -
- 		- -
Description of the VRF or keyword 'default'.
-
-
- interfaces - -
- list - / elements=string -
- 		- -
List of interfaces to check the VRF has been configured correctly or keyword 'default'.
-
-
- name - -
- string -
- 		- -
Name of VRF to be managed.
-

aliases: vrf
-
-
- purge - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Purge VRFs not defined in the aggregate parameter.
-
-
- rd - -
- string -
- 		- -
VPN Route Distinguisher (RD). Valid values are a string in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword 'auto', or the keyword 'default'.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Manages desired state of the resource.
-
-
- vni - -
- string -
- 		- -
Specify virtual network identifier. Valid values are Integer or keyword 'default'.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - Cisco NX-OS creates the default VRF by itself. Therefore, you're not allowed to use default as *vrf* name in this module. - - ``vrf`` name must be shorter than 32 chars. - - VRF names are not case sensible in NX-OS. Anyway, the name is stored just like it's inserted by the user and it'll not be changed again unless the VRF is removed and re-created. i.e. ``vrf=NTC`` will create a VRF named NTC, but running it again with ``vrf=ntc`` will not cause a configuration change. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Ensure ntc VRF exists on switch - cisco.nxos.nxos_vrf: - name: ntc - description: testing - state: present - - name: Aggregate definition of VRFs - cisco.nxos.nxos_vrf: - aggregate: - - name: test1 - description: Testing - admin_state: down - - name: test2 - interfaces: Ethernet1/2 - - name: Aggregate definitions of VRFs with Purge - cisco.nxos.nxos_vrf: - aggregate: - - name: ntc1 - description: purge test1 - - name: ntc2 - description: purge test2 - state: present - purge: true - - name: Delete VRFs exist on switch - cisco.nxos.nxos_vrf: - aggregate: - - name: ntc1 - - name: ntc2 - state: absent - - name: Assign interfaces to VRF declaratively - cisco.nxos.nxos_vrf: - name: test1 - interfaces: - - Ethernet2/3 - - Ethernet2/5 - - name: Check interfaces assigned to VRF - cisco.nxos.nxos_vrf: - name: test1 - associated_interfaces: - - Ethernet2/3 - - Ethernet2/5 - - name: >- - Ensure VRF is tagged with interface Ethernet2/5 only (Removes from - Ethernet2/3) - cisco.nxos.nxos_vrf: - name: test1 - interfaces: - - Ethernet2/5 - - name: Delete VRF - cisco.nxos.nxos_vrf: - name: ntc - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['vrf context ntc', 'no shutdown', 'interface Ethernet1/2', 'no switchport', 'vrf member test2']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) -- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_vrrp_module.rst b/docs/cisco.nxos.nxos_vrrp_module.rst deleted file mode 100644 index 88183c5af..000000000 --- a/docs/cisco.nxos.nxos_vrrp_module.rst +++ /dev/null @@ -1,277 +0,0 @@ -.. _cisco.nxos.nxos_vrrp_module: - - -******************** -cisco.nxos.nxos_vrrp -******************** - -**Manages VRRP configuration on NX-OS switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages VRRP configuration on NX-OS switches. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- admin_state - -
- string -
- 		-
    Choices: -
  • shutdown ←
    • -
  • no shutdown
    • -
  • default
    • -
- 		-
Used to enable or disable the VRRP process.
-
-
- authentication - -
- string -
- 		- -
Clear text authentication string or 'default' keyword
-
-
- group - -
- string - / required -
- 		- -
VRRP group number.
-
-
- interface - -
- string - / required -
- 		- -
Full name of interface that is being managed for VRRP.
-
-
- interval - -
- string -
- 		- -
Time interval between advertisement or 'default' keyword
-
-
- preempt - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable/Disable preempt.
-
-
- priority - -
- string -
- 		- -
VRRP priority or 'default' keyword
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Specify desired state of the resource.
-
-
- vip - -
- string -
- 		- -
VRRP virtual IP address or 'default' keyword
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - VRRP feature needs to be enabled first on the system. - - SVIs must exist before using this module. - - Interface must be a L3 port before using this module. - - ``state=absent`` removes the VRRP group if it exists on the device. - - VRRP cannot be configured on loopback interfaces. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Ensure vrrp group 100 and vip 10.1.100.1 is on vlan10 - cisco.nxos.nxos_vrrp: - interface: vlan10 - group: 100 - vip: 10.1.100.1 - - - name: Ensure removal of the vrrp group config - cisco.nxos.nxos_vrrp: - interface: vlan10 - group: 100 - vip: 10.1.100.1 - state: absent - - - name: Re-config with more params - cisco.nxos.nxos_vrrp: - interface: vlan10 - group: 100 - vip: 10.1.100.1 - preempt: false - priority: 130 - authentication: AUTHKEY - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['interface vlan10', 'vrrp 150', 'address 10.1.15.1', 'authentication text testing', 'no shutdown']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vsan_module.rst b/docs/cisco.nxos.nxos_vsan_module.rst deleted file mode 100644 index 9baa64c68..000000000 --- a/docs/cisco.nxos.nxos_vsan_module.rst +++ /dev/null @@ -1,225 +0,0 @@ -.. _cisco.nxos.nxos_vsan_module: - - -******************** -cisco.nxos.nxos_vsan -******************** - -**Configuration of vsan for Cisco NXOS MDS Switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configuration of vsan for Cisco MDS NXOS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- vsan - -
- list - / elements=dictionary -
- 		- -
List of vsan details to be added or removed
-
-
- id - -
- integer - / required -
- 		- -
Vsan id
-
-
- interface - -
- list - / elements=string -
- 		- -
List of vsan's interfaces to be added
-
-
- name - -
- string -
- 		- -
Name of the vsan
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Removes the vsan if True
-
-
- suspend - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
suspend the vsan if True
-
-
- - -Notes ------ - -.. note:: - - Tested against Cisco MDS NX-OS 8.4(1) - - - -Examples --------- - -.. code-block:: yaml - - - name: Test that vsan module works - cisco.nxos.nxos_vsan: - vsan: - - id: 922 - interface: - - fc1/1 - - fc1/2 - - port-channel 1 - name: vsan-SAN-A - remove: false - suspend: false - - id: 923 - interface: - - fc1/11 - - fc1/21 - - port-channel 2 - name: vsan-SAN-B - remove: false - suspend: true - - id: 1923 - name: vsan-SAN-Old - remove: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['terminal dont-ask', 'vsan database', 'vsan 922 interface fc1/40', 'vsan 922 interface port-channel 155', 'no terminal dont-ask']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) diff --git a/docs/cisco.nxos.nxos_vxlan_vtep_module.rst b/docs/cisco.nxos.nxos_vxlan_vtep_module.rst deleted file mode 100644 index 57fdc14a3..000000000 --- a/docs/cisco.nxos.nxos_vxlan_vtep_module.rst +++ /dev/null @@ -1,332 +0,0 @@ -.. _cisco.nxos.nxos_vxlan_vtep_module: - - -************************** -cisco.nxos.nxos_vxlan_vtep -************************** - -**Manages VXLAN Network Virtualization Endpoint (NVE).** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manages VXLAN Network Virtualization Endpoint (NVE) overlay interface that terminates VXLAN tunnels. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- advertise_virtual_rmac - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
The advertise_virtual_rmac parameter lets BGP to use the VMAC with VIP as next-hop when advertising type-2 routes. Should be used together with advertise_pip parameter from cisco.nxos.nxos_bgp_address_family module.
-
-
- description - -
- string -
- 		- -
Description of the NVE interface.
-
-
- global_ingress_replication_bgp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Configures ingress replication protocol as bgp for all VNIs. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
-
-
- global_mcast_group_L2 - -
- string -
- 		- -
Global multicast IP prefix for L2 VNIs or the keyword 'default'. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
-
-
- global_mcast_group_L3 - -
- string -
- 		- -
Global multicast IP prefix for L3 VNIs or the keyword 'default'. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
-
-
- global_suppress_arp - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enables ARP suppression for all VNIs. This is available on NX-OS 9K series running 9.2.x or higher.
-
-
- host_reachability - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Specify mechanism for host reachability advertisement. A Boolean value of 'true' indicates that BGP will be used for host reachability advertisement. A Boolean value of 'false' indicates that no protocol is used for host reachability advertisement. Other host reachability advertisement protocols (e.g. OpenFlow, controller, etc.) are not supported.
-
-
- interface - -
- string - / required -
- 		- -
Interface name for the VXLAN Network Virtualization Endpoint.
-
-
- multisite_border_gateway_interface - -
- string -
-
added in 1.1.0
- 		- -
Specify the loopback interface whose IP address should be used for the NVE Multisite Border-gateway Interface. This is available on specific Nexus 9000 series switches running NX-OS 7.0(3)I7(x) or higher. Specify "default" to remove an existing gateway config.
-
-
- shutdown - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Administratively shutdown the NVE interface.
-
-
- source_interface - -
- string -
- 		- -
Specify the loopback interface whose IP address should be used for the NVE interface.
-
-
- source_interface_hold_down_time - -
- string -
- 		- -
Suppresses advertisement of the NVE loopback address until the overlay has converged.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Determines whether the config should be present or not on the device.
-
-
- - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - The module is used to manage NVE properties, not to create NVE interfaces. Use :ref:`cisco.nxos.nxos_interfaces ` if you wish to do so. - - ``state=absent`` removes the interface. - - Default, where supported, restores params default value. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. - - - -Examples --------- - -.. code-block:: yaml - - - cisco.nxos.nxos_vxlan_vtep: - interface: nve1 - description: default - host_reachability: true - source_interface: Loopback0 - source_interface_hold_down_time: 30 - shutdown: default - multisite_border_gateway_interface: Loopback0 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['interface nve1', 'source-interface loopback0', 'source-interface hold-down-time 30', 'description simple description', 'shutdown', 'host-reachability protocol bgp', 'multisite border-gateway interface loopback0']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_zone_zoneset_module.rst b/docs/cisco.nxos.nxos_zone_zoneset_module.rst deleted file mode 100644 index 95ef4972a..000000000 --- a/docs/cisco.nxos.nxos_zone_zoneset_module.rst +++ /dev/null @@ -1,537 +0,0 @@ -.. _cisco.nxos.nxos_zone_zoneset_module: - - -**************************** -cisco.nxos.nxos_zone_zoneset -**************************** - -**Configuration of zone/zoneset for Cisco NXOS MDS Switches.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configuration of zone/zoneset for Cisco MDS NXOS. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- zone_zoneset_details - -
- list - / elements=dictionary -
- 		- -
List of zone/zoneset details to be added or removed
-
-
- default_zone - -
- string -
- 		-
    Choices: -
  • permit
    • -
  • deny
    • -
- 		-
default zone behaviour for the vsan
-
-
- mode - -
- string -
- 		-
    Choices: -
  • enhanced
    • -
  • basic
    • -
- 		-
mode of the zone for the vsan
-
-
- smart_zoning - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Removes the vsan if True
-
-
- vsan - -
- integer - / required -
- 		- -
vsan id
-
-
- zone - -
- list - / elements=dictionary -
- 		- -
List of zone options for that vsan
-
-
- members - -
- list - / elements=dictionary -
- 		- -
Members of the zone that needs to be removed or added
-
-
- devtype - -
- string -
- 		-
    Choices: -
  • initiator
    • -
  • target
    • -
  • both
    • -
- 		-
devtype of the zone member used along with Smart zoning config
-
-
- pwwn - -
- string - / required -
- 		- -
pwwn member of the zone, use alias 'device_alias' as option for device_alias member
-

aliases: device_alias
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Removes member from the zone if True
-
-
- name - -
- string - / required -
- 		- -
name of the zone
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Deletes the zone if True
-
-
- zoneset - -
- list - / elements=dictionary -
- 		- -
List of zoneset options for the vsan
-
-
- action - -
- string -
- 		-
    Choices: -
  • activate
    • -
  • deactivate
    • -
- 		-
activates/de-activates the zoneset
-
-
- members - -
- list - / elements=dictionary -
- 		- -
Members of the zoneset that needs to be removed or added
-
-
- name - -
- string - / required -
- 		- -
name of the zone that needs to be added to the zoneset or removed from the zoneset
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Removes zone member from the zoneset
-
-
- name - -
- string - / required -
- 		- -
name of the zoneset
-
-
- remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Removes zoneset if True
-
-
- - -Notes ------ - -.. note:: - - Tested against Cisco MDS NX-OS 8.4(1) - - - -Examples --------- - -.. code-block:: yaml - - - name: Test that zone/zoneset module works - cisco.nxos.nxos_zone_zoneset: - zone_zoneset_details: - - mode: enhanced - vsan: 22 - zone: - - members: - - pwwn: 31314874576271 - - device_alias: test123 - - pwwn: '61:61:62:62:12:12:12:12' - remove: true - name: zoneA - - members: - - pwwn: 28515514576271 - - pwwn: '62:62:62:62:21:21:21:21' - name: zoneB - - name: zoneC - remove: true - zoneset: - - action: activate - members: - - name: zoneA - - name: zoneB - - name: zoneC - remove: true - name: zsetname1 - - action: deactivate - name: zsetTestExtra - remove: true - - mode: basic - smart_zoning: true - vsan: 21 - zone: - - members: - - devtype: both - pwwn: 31314874576271 - - pwwn: '62:62:62:62:12:12:12:12' - - devtype: both - pwwn: '92:62:62:62:12:12:1a:1a' - remove: true - name: zone21A - - members: - - pwwn: 28515514576271 - - pwwn: '62:62:62:62:21:21:21:21' - name: zone21B - zoneset: - - action: activate - members: - - name: zone21A - - name: zone21B - name: zsetname212 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always -
commands sent to the device
-
-
Sample:
-
['terminal dont-ask', 'zone name zoneA vsan 923', 'member pwwn 11:11:11:11:11:11:11:11', 'no member device-alias test123', 'zone commit vsan 923', 'no terminal dont-ask']
-
-
- messages - -
- list -
- 		always -
debug messages
-
-
Sample:
-
['zone mode is already enhanced ,no change in zone mode configuration for vsan 922', "zone member '11:11:11:11:11:11:11:11' is already present in zone 'zoneA' in vsan 922 hence nothing to add", "zone member 'test123' is already present in zone 'zoneA' in vsan 922 hence nothing to add", "zone member '61:61:62:62:12:12:12:12' is not present in zone 'zoneA' in vsan 922 hence nothing to remove", "zone member '10:11:11:11:11:11:11:11' is already present in zone 'zoneB' in vsan 922 hence nothing to add", "zone member '62:62:62:62:21:21:21:21' is already present in zone 'zoneB' in vsan 922 hence nothing to add", "zone 'zoneC' is not present in vsan 922 , so nothing to remove"]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) From bab28d10755b5cc107f50205ce70597511c0ecdb Mon Sep 17 00:00:00 2001 From: Vinay Mulugund Date: Thu, 7 Mar 2024 20:02:29 +0530 Subject: [PATCH 14/30] fixed pre-commit doc issue --- ....nxos.nxos_spanning_tree_global_module.rst | 1608 +++++++++++++++++ plugins/modules/nxos_spanning_tree_global.py | 10 +- 2 files changed, 1614 insertions(+), 4 deletions(-) create mode 100644 docs/cisco.nxos.nxos_spanning_tree_global_module.rst diff --git a/docs/cisco.nxos.nxos_spanning_tree_global_module.rst b/docs/cisco.nxos.nxos_spanning_tree_global_module.rst new file mode 100644 index 000000000..003169da0 --- /dev/null +++ b/docs/cisco.nxos.nxos_spanning_tree_global_module.rst @@ -0,0 +1,1608 @@ +.. _cisco.nxos.nxos_spanning_tree_global_module: + + +************************************ +cisco.nxos.nxos_spanning_tree_global +************************************ + +**Resource module to configure spanning tree.** + + +Version added: 6.0.3 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module configures and manages the attributes of Spanning-tree on Cisco NXOS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A dict of Spanning-tree options.
+
+
+ bridge + +
+ dictionary +
+ 		+ +
Bridge options in spanning-tree.
+
+
+ bridge_assurance + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable bridge assurance.
+
+
+ bridge_domain + +
+ dictionary +
+ 		+ +
+
+ bd_list_range + +
+ string +
+ 		+ +
Bridge-Domain Spanning Trees range.
+
+
+ forward_time + +
+ integer +
+ 		+ +
Forward time for bridge domain.
+
+
+ hello_time + +
+ integer +
+ 		+ +
Hello time for bridge domain.
+
+
+ max_age + +
+ integer +
+ 		+ +
Max age for bridge domain.
+
+
+ priority + +
+ integer +
+ 		+ +
Priority for bridge domain.
+
+
+ root + +
+ dictionary +
+ 		+ +
Configure switch as root.
+
+
+ primary + +
+ dictionary +
+ 		+ +
Configure primary root.
+
+
+ diameter + +
+ integer +
+ 		+ +
Priority for primary root.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable primary root.
+
+
+ hello_time + +
+ integer +
+ 		+ +
Configure secondary root.
+
+
+ secondary + +
+ dictionary +
+ 		+ +
Configure secondary root.
+
+
+ diameter + +
+ integer +
+ 		+ +
Priority for primary root.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable primary root.
+
+
+ hello_time + +
+ integer +
+ 		+ +
Configure secondary root.
+
+
+ domain + +
+ dictionary +
+ 		+ +
Spanning tree domain options.
+
+
+ clear_stats + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Clear spanning tree domain statistics.
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable spanning tree domain.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable spanning tree domain.
+
+
+ identifier + +
+ integer +
+ 		+ +
Spanning tree domain identifier.
+
+
+ fcoe + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable STP for FCoE VLANs.
+
+
+ lc_issu + +
+ string +
+ 		+
    Choices: +
  • auto
    • +
  • disruptive
    • +
  • non-disruptive
    • +
+ 		+
Configure Linecard ISSU type.
+
+
+ loopguard_default + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Spanning tree loopguard .
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • mst
    • +
  • rapid-pvst
    • +
+ 		+
Spanning tree mode.
+
+
+ mst + +
+ dictionary +
+ 		+ +
Multiple spanning tree configuration.
+
+
+ configure_mst + +
+ list + / elements=dictionary +
+ 		+ +
MST configuration submode options.
+
+
+ instance_vlan + +
+ dictionary +
+ 		+ +
MST configuration submode instance.
+
+
+ instance_id + +
+ integer +
+ 		+ +
MST configuration submode instance id.
+
+
+ vlan_range + +
+ string +
+ 		+ +
MST configuration submode instance vlan range.
+
+
+ name + +
+ string +
+ 		+ +
MST configuration submode instance name.
+
+
+ private_vlan_sync + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
MST configuration submode private vlan sync.
+
+
+ revision + +
+ integer +
+ 		+ +
MST configuration submode instance revision.
+
+
+ forward-time + +
+ integer +
+ 		+ +
Forward time for MST.
+
+
+ hello-time + +
+ integer +
+ 		+ +
Hello time for MST.
+
+
+ max_age + +
+ integer +
+ 		+ +
Max age for MST.
+
+
+ max_hops + +
+ integer +
+ 		+ +
Max hops for MST.
+
+
+ simulate_pvst_global + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable Simulate PVST global.
+
+
+ pathcost_method + +
+ string +
+ 		+
    Choices: +
  • long
    • +
  • short
    • +
+ 		+
Spanning tree pathcost options.
+
+
+ port_type + +
+ dictionary +
+ 		+ +
Spanning tree port type.
+
+
+ default + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable default port type.
+
+
+ edge + +
+ string +
+ 		+
    Choices: +
  • bpdufilter
    • +
  • bpduguard
    • +
  • default
    • +
+ 		+
Enable edge port type.
+
+
+ network + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable network port type.
+
+
+ pseudo_info + +
+ dictionary +
+ 		+ +
Configure spanning tree pseudo information
+
+
+ bridge_domain_info + +
+ dictionary +
+ 		+ +
Pseudo information bridge domain.
+
+
+ designated_priority + +
+ integer +
+ 		+ +
Pseudo information bridge domain designated priority.
+
+
+ range + +
+ string +
+ 		+ +
Pseudo information bridge domain range.
+
+
+ root_priority + +
+ integer +
+ 		+ +
Pseudo information bridge domain root priority.
+
+
+ mst_info + +
+ dictionary +
+ 		+ +
Pseudo information MST.
+
+
+ designated_priority + +
+ integer +
+ 		+ +
Pseudo information MST designated priority.
+
+
+ range + +
+ string +
+ 		+ +
Pseudo information MST range.
+
+
+ root_priority + +
+ integer +
+ 		+ +
Pseudo information MST root priority.
+
+
+ vlan_info + +
+ dictionary +
+ 		+ +
Pseudo information MST.
+
+
+ designated_priority + +
+ integer +
+ 		+ +
Pseudo information MST designated priority.
+
+
+ range + +
+ string +
+ 		+ +
Pseudo information MST range.
+
+
+ root_priority + +
+ integer +
+ 		+ +
Pseudo information MST root priority.
+
+
+ vlan + +
+ dictionary +
+ 		+ +
VLAN Switch Spanning Trees.
+
+
+ forward_time + +
+ integer +
+ 		+ +
Forward time for VLAN.
+
+
+ hello_time + +
+ integer +
+ 		+ +
Hello time for VLAN.
+
+
+ max_age + +
+ integer +
+ 		+ +
Max age for VLAN.
+
+
+ priority + +
+ integer +
+ 		+ +
Priority for VLAN.
+
+
+ root + +
+ dictionary +
+ 		+ +
Configure switch as root.
+
+
+ primary + +
+ dictionary +
+ 		+ +
Configure primary root.
+
+
+ diameter + +
+ integer +
+ 		+ +
Priority for primary root.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable primary root.
+
+
+ hello_time + +
+ integer +
+ 		+ +
Configure secondary root.
+
+
+ secondary + +
+ dictionary +
+ 		+ +
Configure secondary root.
+
+
+ diameter + +
+ integer +
+ 		+ +
Priority for primary root.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable primary root.
+
+
+ hello_time + +
+ integer +
+ 		+ +
Configure secondary root.
+
+
+ vlan_range + +
+ string +
+ 		+ +
VLAN range for spanning tree.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NXOS device by executing the command show running-config | section ^spanning-tree.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • rendered
    • +
  • gathered
    • +
  • purged
    • +
  • parsed
    • +
+ 		+
The state the configuration should be left in
+
The states rendered, gathered and parsed does not perform any change on the device.
+
The state rendered will transform the configuration in config option to platform specific CLI commands which will be returned in the rendered key within the result. For state rendered active connection to remote host is not required.
+
The state gathered will fetch the running configuration from device and transform it into structured data in the format as per the resource module argspec and the value is returned in the gathered key within the result.
+
The state parsed reads the configuration from running_config option and transforms it into JSON format as per the resource module parameters and the value is returned in the parsed key within the result. The value of running_config option should be the same format as the output of command show running-config | include ip route|ipv6 route executed on device. For state parsed active connection to remote host is not required.
+
The state purged negates virtual/logical interfaces that are specified in task from running-config.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6 on Cisco Nexus Switches. + - This module works with connection ``network_cli`` and ``httpapi``. + - Tested against Cisco MDS NX-OS 9.2(2) with connection ``network_cli``. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['sample command 1', 'sample command 2', 'sample command 3']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['sample command 1', 'sample command 2', 'sample command 3']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Vinay Mulugund (@roverflow) diff --git a/plugins/modules/nxos_spanning_tree_global.py b/plugins/modules/nxos_spanning_tree_global.py index 036aefd57..3b83b37bb 100644 --- a/plugins/modules/nxos_spanning_tree_global.py +++ b/plugins/modules/nxos_spanning_tree_global.py @@ -15,14 +15,16 @@ DOCUMENTATION = """ module: nxos_spanning_tree_global +extends_documentation_fragment: +- cisco.nxos.nxos short_description: Resource module to configure spanning tree. description: This module configures and manages the attributes of Spanning-tree on Cisco NXOS. version_added: 6.0.3 author: Vinay Mulugund (@roverflow) notes: - - Tested against NX-OS 9.3.6 on Cisco Nexus Switches. - - This module works with connection C(network_cli) and C(httpapi). - - Tested against Cisco MDS NX-OS 9.2(2) with connection C(network_cli). +- Tested against NX-OS 9.3.6 on Cisco Nexus Switches. +- This module works with connection C(network_cli) and C(httpapi). +- Tested against Cisco MDS NX-OS 9.2(2) with connection C(network_cli). options: config: description: A dict of Spanning-tree options. @@ -205,7 +207,7 @@ type: int root_priority: description: Pseudo information bridge domain root priority. - type: int\ + type: int mst_info: description: Pseudo information MST. type: dict From f1a36fcdced0aea938edc6d3a02bdfd29d0c6189 Mon Sep 17 00:00:00 2001 From: Vinay Mulugund Date: Thu, 7 Mar 2024 20:05:33 +0530 Subject: [PATCH 15/30] add other docs --- ...cisco.nxos.nxos_aaa_server_host_module.rst | 343 + docs/cisco.nxos.nxos_aaa_server_module.rst | 248 + .../cisco.nxos.nxos_acl_interfaces_module.rst | 610 ++ docs/cisco.nxos.nxos_acls_module.rst | 4086 ++++++++++++ docs/cisco.nxos.nxos_banner_module.rst | 187 + docs/cisco.nxos.nxos_bfd_global_module.rst | 326 + .../cisco.nxos.nxos_bfd_interfaces_module.rst | 394 ++ docs/cisco.nxos.nxos_bgp_global_module.rst | 5843 +++++++++++++++++ ...xos_bgp_neighbor_address_family_module.rst | 3575 ++++++++++ docs/cisco.nxos.nxos_bgp_templates_module.rst | 2841 ++++++++ docs/cisco.nxos.nxos_command_module.rst | 258 + docs/cisco.nxos.nxos_config_module.rst | 566 ++ docs/cisco.nxos.nxos_devicealias_module.rst | 273 + docs/cisco.nxos.nxos_evpn_global_module.rst | 122 + docs/cisco.nxos.nxos_evpn_vni_module.rst | 212 + docs/cisco.nxos.nxos_facts_module.rst | 553 ++ docs/cisco.nxos.nxos_feature_module.rst | 150 + docs/cisco.nxos.nxos_gir_module.rst | 302 + ...xos.nxos_gir_profile_management_module.rst | 235 + docs/cisco.nxos.nxos_hostname_module.rst | 344 + ...cisco.nxos.nxos_hsrp_interfaces_module.rst | 344 + docs/cisco.nxos.nxos_hsrp_module.rst | 305 + docs/cisco.nxos.nxos_igmp_module.rst | 191 + docs/cisco.nxos.nxos_igmp_snooping_module.rst | 225 + docs/cisco.nxos.nxos_install_os_module.rst | 183 + docs/cisco.nxos.nxos_l2_interfaces_module.rst | 648 ++ docs/cisco.nxos.nxos_l3_interfaces_module.rst | 884 +++ docs/cisco.nxos.nxos_lacp_module.rst | 402 ++ ...cisco.nxos.nxos_lldp_interfaces_module.rst | 407 ++ docs/cisco.nxos.nxos_logging_module.rst | 458 ++ docs/cisco.nxos.nxos_ntp_auth_module.rst | 224 + docs/cisco.nxos.nxos_ntp_global_module.rst | 1411 ++++ docs/cisco.nxos.nxos_ntp_module.rst | 314 + docs/cisco.nxos.nxos_ntp_options_module.rst | 192 + docs/cisco.nxos.nxos_nxapi_module.rst | 300 + ...cisco.nxos.nxos_ospf_interfaces_module.rst | 1732 +++++ docs/cisco.nxos.nxos_ospfv2_module.rst | 5458 +++++++++++++++ .../cisco.nxos.nxos_overlay_global_module.rst | 120 + docs/cisco.nxos.nxos_pim_module.rst | 148 + docs/cisco.nxos.nxos_ping_module.rst | 311 + docs/cisco.nxos.nxos_prefix_lists_module.rst | 1049 +++ docs/cisco.nxos.nxos_reboot_module.rst | 123 + docs/cisco.nxos.nxos_rollback_module.rst | 159 + docs/cisco.nxos.nxos_route_maps_module.rst | 4368 ++++++++++++ docs/cisco.nxos.nxos_rpm_module.rst | 226 + docs/cisco.nxos.nxos_snapshot_module.rst | 363 + .../cisco.nxos.nxos_snmp_community_module.rst | 201 + docs/cisco.nxos.nxos_snmp_host_module.rst | 288 + docs/cisco.nxos.nxos_snmp_location_module.rst | 156 + docs/cisco.nxos.nxos_snmp_server_module.rst | 4474 +++++++++++++ docs/cisco.nxos.nxos_snmp_traps_module.rst | 189 + docs/cisco.nxos.nxos_snmp_user_module.rst | 235 + .../cisco.nxos.nxos_udld_interface_module.rst | 250 + docs/cisco.nxos.nxos_udld_module.rst | 256 + docs/cisco.nxos.nxos_user_module.rst | 390 ++ docs/cisco.nxos.nxos_vpc_module.rst | 352 + docs/cisco.nxos.nxos_vrf_af_module.rst | 300 + docs/cisco.nxos.nxos_vrf_module.rst | 494 ++ docs/cisco.nxos.nxos_vrrp_module.rst | 277 + docs/cisco.nxos.nxos_vsan_module.rst | 225 + docs/cisco.nxos.nxos_vxlan_vtep_module.rst | 332 + docs/cisco.nxos.nxos_zone_zoneset_module.rst | 537 ++ 62 files changed, 50969 insertions(+) create mode 100644 docs/cisco.nxos.nxos_aaa_server_host_module.rst create mode 100644 docs/cisco.nxos.nxos_aaa_server_module.rst create mode 100644 docs/cisco.nxos.nxos_acl_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_acls_module.rst create mode 100644 docs/cisco.nxos.nxos_banner_module.rst create mode 100644 docs/cisco.nxos.nxos_bfd_global_module.rst create mode 100644 docs/cisco.nxos.nxos_bfd_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_bgp_global_module.rst create mode 100644 docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst create mode 100644 docs/cisco.nxos.nxos_bgp_templates_module.rst create mode 100644 docs/cisco.nxos.nxos_command_module.rst create mode 100644 docs/cisco.nxos.nxos_config_module.rst create mode 100644 docs/cisco.nxos.nxos_devicealias_module.rst create mode 100644 docs/cisco.nxos.nxos_evpn_global_module.rst create mode 100644 docs/cisco.nxos.nxos_evpn_vni_module.rst create mode 100644 docs/cisco.nxos.nxos_facts_module.rst create mode 100644 docs/cisco.nxos.nxos_feature_module.rst create mode 100644 docs/cisco.nxos.nxos_gir_module.rst create mode 100644 docs/cisco.nxos.nxos_gir_profile_management_module.rst create mode 100644 docs/cisco.nxos.nxos_hostname_module.rst create mode 100644 docs/cisco.nxos.nxos_hsrp_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_hsrp_module.rst create mode 100644 docs/cisco.nxos.nxos_igmp_module.rst create mode 100644 docs/cisco.nxos.nxos_igmp_snooping_module.rst create mode 100644 docs/cisco.nxos.nxos_install_os_module.rst create mode 100644 docs/cisco.nxos.nxos_l2_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_l3_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_lacp_module.rst create mode 100644 docs/cisco.nxos.nxos_lldp_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_logging_module.rst create mode 100644 docs/cisco.nxos.nxos_ntp_auth_module.rst create mode 100644 docs/cisco.nxos.nxos_ntp_global_module.rst create mode 100644 docs/cisco.nxos.nxos_ntp_module.rst create mode 100644 docs/cisco.nxos.nxos_ntp_options_module.rst create mode 100644 docs/cisco.nxos.nxos_nxapi_module.rst create mode 100644 docs/cisco.nxos.nxos_ospf_interfaces_module.rst create mode 100644 docs/cisco.nxos.nxos_ospfv2_module.rst create mode 100644 docs/cisco.nxos.nxos_overlay_global_module.rst create mode 100644 docs/cisco.nxos.nxos_pim_module.rst create mode 100644 docs/cisco.nxos.nxos_ping_module.rst create mode 100644 docs/cisco.nxos.nxos_prefix_lists_module.rst create mode 100644 docs/cisco.nxos.nxos_reboot_module.rst create mode 100644 docs/cisco.nxos.nxos_rollback_module.rst create mode 100644 docs/cisco.nxos.nxos_route_maps_module.rst create mode 100644 docs/cisco.nxos.nxos_rpm_module.rst create mode 100644 docs/cisco.nxos.nxos_snapshot_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_community_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_host_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_location_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_server_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_traps_module.rst create mode 100644 docs/cisco.nxos.nxos_snmp_user_module.rst create mode 100644 docs/cisco.nxos.nxos_udld_interface_module.rst create mode 100644 docs/cisco.nxos.nxos_udld_module.rst create mode 100644 docs/cisco.nxos.nxos_user_module.rst create mode 100644 docs/cisco.nxos.nxos_vpc_module.rst create mode 100644 docs/cisco.nxos.nxos_vrf_af_module.rst create mode 100644 docs/cisco.nxos.nxos_vrf_module.rst create mode 100644 docs/cisco.nxos.nxos_vrrp_module.rst create mode 100644 docs/cisco.nxos.nxos_vsan_module.rst create mode 100644 docs/cisco.nxos.nxos_vxlan_vtep_module.rst create mode 100644 docs/cisco.nxos.nxos_zone_zoneset_module.rst diff --git a/docs/cisco.nxos.nxos_aaa_server_host_module.rst b/docs/cisco.nxos.nxos_aaa_server_host_module.rst new file mode 100644 index 000000000..5730e6359 --- /dev/null +++ b/docs/cisco.nxos.nxos_aaa_server_host_module.rst @@ -0,0 +1,343 @@ +.. _cisco.nxos.nxos_aaa_server_host_module: + + +******************************* +cisco.nxos.nxos_aaa_server_host +******************************* + +**Manages AAA server host-specific configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages AAA server host-specific configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ acct_port + +
+ string +
+ 		+ +
Alternate UDP port for RADIUS accounting or keyword 'default'.
+
+
+ address + +
+ string + / required +
+ 		+ +
Address or name of the radius or tacacs host.
+
+
+ auth_port + +
+ string +
+ 		+ +
Alternate UDP port for RADIUS authentication or keyword 'default'.
+
+
+ encrypt_type + +
+ string +
+ 		+
    Choices: +
  • 0
    • +
  • 7
    • +
+ 		+
The state of encryption applied to the entered key. O for clear text, 7 for encrypted. Type-6 encryption is not supported.
+
+
+ host_timeout + +
+ string +
+ 		+ +
Timeout period for specified host, in seconds or keyword 'default. Range is 1-60.
+
+
+ key + +
+ string +
+ 		+ +
Shared secret for the specified host or keyword 'default'.
+
+
+ server_type + +
+ string + / required +
+ 		+
    Choices: +
  • radius
    • +
  • tacacs
    • +
+ 		+
The server type is either radius or tacacs.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ tacacs_port + +
+ string +
+ 		+ +
Alternate TCP port TACACS Server or keyword 'default'.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - Changes to the host key (shared secret) are not idempotent for type 0. + - If ``state=absent`` removes the whole host configuration. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Radius Server Host Basic settings + - name: Radius Server Host Basic settings + cisco.nxos.nxos_aaa_server_host: + state: present + server_type: radius + address: 1.2.3.4 + acct_port: 2084 + host_timeout: 10 + + # Radius Server Host Key Configuration + - name: Radius Server Host Key Configuration + cisco.nxos.nxos_aaa_server_host: + state: present + server_type: radius + address: 1.2.3.4 + key: hello + encrypt_type: 7 + + # TACACS Server Host Configuration + - name: Tacacs Server Host Configuration + cisco.nxos.nxos_aaa_server_host: + state: present + server_type: tacacs + tacacs_port: 89 + host_timeout: 10 + address: 5.6.7.8 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ end_state + +
+ dictionary +
+ 		always +
k/v pairs of configuration after module execution
+
+
Sample:
+
{'address': '1.2.3.4', 'auth_port': '2084', 'host_timeout': '10', 'server_type': 'radius'}
+
+
+ existing + +
+ dictionary +
+ 		always +
k/v pairs of existing configuration
+
+
+
+ proposed + +
+ dictionary +
+ 		always +
k/v pairs of parameters passed into module
+
+
Sample:
+
{'address': '1.2.3.4', 'auth_port': '2084', 'host_timeout': '10', 'server_type': 'radius'}
+
+
+ updates + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['radius-server host 1.2.3.4 auth-port 2084 timeout 10']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_aaa_server_module.rst b/docs/cisco.nxos.nxos_aaa_server_module.rst new file mode 100644 index 000000000..1307c9033 --- /dev/null +++ b/docs/cisco.nxos.nxos_aaa_server_module.rst @@ -0,0 +1,248 @@ +.. _cisco.nxos.nxos_aaa_server_module: + + +************************** +cisco.nxos.nxos_aaa_server +************************** + +**Manages AAA server global configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages AAA server global configuration + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ deadtime + +
+ string +
+ 		+ +
Duration for which a non-reachable AAA server is skipped, in minutes or keyword 'default. Range is 1-1440. Device default is 0.
+
+
+ directed_request + +
+ string +
+ 		+
    Choices: +
  • enabled
    • +
  • disabled
    • +
  • default
    • +
+ 		+
Enables direct authentication requests to AAA server or keyword 'default' Device default is disabled.
+
+
+ encrypt_type + +
+ string +
+ 		+
    Choices: +
  • 0
    • +
  • 7
    • +
+ 		+
The state of encryption applied to the entered global key. O clear text, 7 encrypted. Type-6 encryption is not supported.
+
+
+ global_key + +
+ string +
+ 		+ +
Global AAA shared secret or keyword 'default'.
+
+
+ server_timeout + +
+ string +
+ 		+ +
Global AAA server timeout period, in seconds or keyword 'default. Range is 1-60. Device default is 5.
+
+
+ server_type + +
+ string + / required +
+ 		+
    Choices: +
  • radius
    • +
  • tacacs
    • +
+ 		+
The server type is either radius or tacacs.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • default
    • +
+ 		+
Manage the state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - The server_type parameter is always required. + - If encrypt_type is not supplied, the global AAA server key will be stored as encrypted (type 7). + - Changes to the global AAA server key with encrypt_type=0 are not idempotent. + - state=default will set the supplied parameters to their default values. The parameters that you want to default must also be set to default. If global_key=default, the global key will be removed. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Radius Server Basic settings + - name: Radius Server Basic settings + cisco.nxos.nxos_aaa_server: + server_type: radius + server_timeout: 9 + deadtime: 20 + directed_request: enabled + + # Tacacs Server Basic settings + - name: Tacacs Server Basic settings + cisco.nxos.nxos_aaa_server: + server_type: tacacs + server_timeout: 8 + deadtime: 19 + directed_request: disabled + + # Setting Global Key + - name: AAA Server Global Key + cisco.nxos.nxos_aaa_server: + server_type: radius + global_key: test_key + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['radius-server deadtime 22', 'radius-server timeout 11', 'radius-server directed-request']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_acl_interfaces_module.rst b/docs/cisco.nxos.nxos_acl_interfaces_module.rst new file mode 100644 index 000000000..a2885df02 --- /dev/null +++ b/docs/cisco.nxos.nxos_acl_interfaces_module.rst @@ -0,0 +1,610 @@ +.. _cisco.nxos.nxos_acl_interfaces_module: + + +****************************** +cisco.nxos.nxos_acl_interfaces +****************************** + +**ACL interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Add and remove Access Control Lists on interfaces in NX-OS platform + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of interfaces to be configured with ACLs
+
+
+ access_groups + +
+ list + / elements=dictionary +
+ 		+ +
List of address family indicators with ACLs to be configured on the interface
+
+
+ acls + +
+ list + / elements=dictionary +
+ 		+ +
List of Access Control Lists for the interface
+
+
+ direction + +
+ string + / required +
+ 		+
    Choices: +
  • in
    • +
  • out
    • +
+ 		+
Direction to be applied for the ACL
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the ACL to be added/removed
+
+
+ port + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use ACL as port policy.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
Address Family Indicator of the ACLs to be configured
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the interface
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • deleted
    • +
  • gathered
    • +
  • merged ←
    • +
  • overridden
    • +
  • rendered
    • +
  • replaced
    • +
  • parsed
    • +
+ 		+
The state the configuration should be left in
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------ + # + + - name: Merge ACL interfaces configuration + cisco.nxos.nxos_acl_interfaces: + config: + - name: Ethernet1/2 + access_groups: + - afi: ipv6 + acls: + - name: ACL1v6 + direction: in + + - name: Eth1/5 + access_groups: + - afi: ipv4 + acls: + - name: PortACL + direction: in + port: true + + - name: ACL1v4 + direction: out + + - afi: ipv6 + acls: + - name: ACL1v6 + direction: in + state: merged + + # After state: + # ------------ + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ip port access-group PortACL in + # ip access-group ACL1v4 out + # ipv6 traffic-filter ACL1v6 in + + # Using replaced + + # Before state: + # ------------ + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ip port access-group PortACL in + # ip access-group ACL1v4 out + # ipv6 traffic-filter ACL1v6 in + + - name: Replace interface configuration with given configuration + cisco.nxos.nxos_acl_interfaces: + config: + - name: Eth1/5 + access_groups: + - afi: ipv4 + acls: + - name: NewACLv4 + direction: out + + - name: Ethernet1/3 + access_groups: + - afi: ipv6 + acls: + - name: NewACLv6 + direction: in + port: true + state: replaced + + # After state: + # ------------ + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/3 + # ipv6 port traffic-filter NewACLv6 in + # interface Ethernet1/5 + # ip access-group NewACLv4 out + + # Using overridden + + # Before state: + # ------------ + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ip port access-group PortACL in + # ip access-group ACL1v4 out + # ipv6 traffic-filter ACL1v6 in + + - name: Override interface configuration with given configuration + cisco.nxos.nxos_acl_interfaces: + config: + - name: Ethernet1/3 + access_groups: + - afi: ipv4 + acls: + - name: ACL1v4 + direction: out + + - name: PortACL + port: true + direction: in + - afi: ipv6 + acls: + - name: NewACLv6 + direction: in + port: true + state: overridden + + # After state: + # ------------ + # interface Ethernet1/3 + # ip access-group ACL1v4 out + # ip port access-group PortACL in + # ipv6 port traffic-filter NewACLv6 in + + # Using deleted to remove ACL config from specified interfaces + + # Before state: + # ------------- + # interface Ethernet1/1 + # ip access-group ACL2v4 in + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ip port access-group PortACL in + # ip access-group ACL1v4 out + # ipv6 traffic-filter ACL1v6 in + + - name: Delete ACL configuration on interfaces + cisco.nxos.nxos_acl_interfaces: + config: + - name: Ethernet1/5 + - name: Ethernet1/2 + state: deleted + + # After state: + # ------------- + # interface Ethernet1/1 + # ip access-group ACL2v4 in + # interface Ethernet1/2 + # interface Ethernet1/5 + + # Using deleted to remove ACL config from all interfaces + + # Before state: + # ------------- + # interface Ethernet1/1 + # ip access-group ACL2v4 in + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ip port access-group PortACL in + # ip access-group ACL1v4 out + # ipv6 traffic-filter ACL1v6 in + + - name: Delete ACL configuration from all interfaces + cisco.nxos.nxos_acl_interfaces: + state: deleted + + # After state: + # ------------- + # interface Ethernet1/1 + # interface Ethernet1/2 + # interface Ethernet1/5 + + # Using parsed + + - name: Parse given configuration into structured format + cisco.nxos.nxos_acl_interfaces: + running_config: | + interface Ethernet1/2 + ipv6 traffic-filter ACL1v6 in + interface Ethernet1/5 + ipv6 traffic-filter ACL1v6 in + ip access-group ACL1v4 out + ip port access-group PortACL in + state: parsed + + # returns + # parsed: + # - name: Ethernet1/2 + # access_groups: + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # direction: in + # - name: Ethernet1/5 + # access_groups: + # - afi: ipv4 + # acls: + # - name: PortACL + # direction: in + # port: True + # - name: ACL1v4 + # direction: out + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # direction: in + + + # Using gathered: + + # Before state: + # ------------ + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ipv6 traffic-filter ACL1v6 in + # ip access-group ACL1v4 out + # ip port access-group PortACL in + + - name: Gather existing configuration from device + cisco.nxos.nxos_acl_interfaces: + config: + state: gathered + + # returns + # gathered: + # - name: Ethernet1/2 + # access_groups: + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # direction: in + # - name: Ethernet1/5 + # access_groups: + # - afi: ipv4 + # acls: + # - name: PortACL + # direction: in + # port: True + # - name: ACL1v4 + # direction: out + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # direction: in + + + # Using rendered + + - name: Render required configuration to be pushed to the device + cisco.nxos.nxos_acl_interfaces: + config: + - name: Ethernet1/2 + access_groups: + - afi: ipv6 + acls: + - name: ACL1v6 + direction: in + - name: Ethernet1/5 + access_groups: + - afi: ipv4 + acls: + - name: PortACL + direction: in + port: true + - name: ACL1v4 + direction: out + - afi: ipv6 + acls: + - name: ACL1v6 + direction: in + state: rendered + + + # returns + # rendered: + # interface Ethernet1/2 + # ipv6 traffic-filter ACL1v6 in + # interface Ethernet1/5 + # ipv6 traffic-filter ACL1v6 in + # ip access-group ACL1v4 out + # ip port access-group PortACL in + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/2', 'ipv6 traffic-filter ACL1v6 out', 'ip port access-group PortACL in']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_acls_module.rst b/docs/cisco.nxos.nxos_acls_module.rst new file mode 100644 index 000000000..1b806511d --- /dev/null +++ b/docs/cisco.nxos.nxos_acls_module.rst @@ -0,0 +1,4086 @@ +.. _cisco.nxos.nxos_acls_module: + + +******************** +cisco.nxos.nxos_acls +******************** + +**ACLs resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manage named IP ACLs on the Cisco NX-OS platform + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary of ACL options.
+
+
+ acls + +
+ list + / elements=dictionary +
+ 		+ +
A list of the ACLs.
+
+
+ aces + +
+ list + / elements=dictionary +
+ 		+ +
The entries within the ACL.
+
+
+ destination + +
+ dictionary +
+ 		+ +
Specify the packet destination.
+
+
+ address + +
+ string +
+ 		+ +
Destination network address.
+
+
+ any + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Any destination address.
+
+
+ host + +
+ string +
+ 		+ +
Host IP address.
+
+
+ port_protocol + +
+ dictionary +
+ 		+ +
Specify the destination port or protocol (only for TCP and UDP).
+
+
+ eq + +
+ string +
+ 		+ +
Match only packets on a given port number.
+
+
+ gt + +
+ string +
+ 		+ +
Match only packets with a greater port number.
+
+
+ lt + +
+ string +
+ 		+ +
Match only packets with a lower port number.
+
+
+ neq + +
+ string +
+ 		+ +
Match only packets not on a given port number.
+
+
+ range + +
+ dictionary +
+ 		+ +
Match only packets in the range of port numbers.
+
+
+ end + +
+ string +
+ 		+ +
Specify the end of the port range.
+
+
+ start + +
+ string +
+ 		+ +
Specify the start of the port range.
+
+
+ prefix + +
+ string +
+ 		+ +
Destination network prefix. Only for prefixes of value less than 31 for ipv4 and 127 for ipv6. Prefixes of 32 (ipv4) and 128 (ipv6) should be given in the 'host' key.
+
+
+ wildcard_bits + +
+ string +
+ 		+ +
Destination wildcard bits.
+
+
+ dscp + +
+ string +
+ 		+ +
Match packets with given DSCP value.
+
+
+ fragments + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Check non-initial fragments.
+
+
+ grant + +
+ string +
+ 		+
    Choices: +
  • permit
    • +
  • deny
    • +
+ 		+
Action to be applied on the rule.
+
+
+ log + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log matches against this entry.
+
+
+ precedence + +
+ string +
+ 		+ +
Match packets with given precedence value.
+
+
+ protocol + +
+ string +
+ 		+ +
Specify the protocol.
+
+
+ protocol_options + +
+ dictionary +
+ 		+ +
All possible suboptions for the protocol chosen.
+
+
+ icmp + +
+ dictionary +
+ 		+ +
ICMP protocol options.
+
+
+ administratively_prohibited + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively prohibited
+
+
+ alternate_address + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Alternate address
+
+
+ conversion_error + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Datagram conversion
+
+
+ dod_host_prohibited + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host prohibited
+
+
+ dod_net_prohibited + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Net prohibited
+
+
+ echo + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo (ping)
+
+
+ echo_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo reply
+
+
+ echo_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo request (ping)
+
+
+ general_parameter_problem + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter problem
+
+
+ host_isolated + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host isolated
+
+
+ host_precedence_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host unreachable for precedence
+
+
+ host_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host redirect
+
+
+ host_tos_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host redirect for TOS
+
+
+ host_tos_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host unreachable for TOS
+
+
+ host_unknown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host unknown
+
+
+ host_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host unreachable
+
+
+ information_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Information replies
+
+
+ information_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Information requests
+
+
+ mask_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Mask replies
+
+
+ mask_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Mask requests
+
+
+ message_code + +
+ integer +
+ 		+ +
ICMP message code
+
+
+ message_type + +
+ integer +
+ 		+ +
ICMP message type
+
+
+ mobile_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Mobile host redirect
+
+
+ net_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Network redirect
+
+
+ net_tos_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Net redirect for TOS
+
+
+ net_tos_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Network unreachable for TOS
+
+
+ net_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Net unreachable
+
+
+ network_unknown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Network unknown
+
+
+ no_room_for_option + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter required but no room
+
+
+ option_missing + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter required but not present
+
+
+ packet_too_big + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Fragmentation needed and DF set
+
+
+ parameter_problem + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All parameter problems
+
+
+ port_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Port unreachable
+
+
+ precedence_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Precedence cutoff
+
+
+ protocol_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Protocol unreachable
+
+
+ reassembly_timeout + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Reassembly timeout
+
+
+ redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All redirects
+
+
+ router_advertisement + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router discovery advertisements
+
+
+ router_solicitation + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router discovery solicitations
+
+
+ source_quench + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Source quenches
+
+
+ source_route_failed + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Source route failed
+
+
+ time_exceeded + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All time exceeded.
+
+
+ timestamp_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Timestamp replies
+
+
+ timestamp_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Timestamp requests
+
+
+ traceroute + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Traceroute
+
+
+ ttl_exceeded + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
TTL exceeded
+
+
+ unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All unreachables
+
+
+ icmpv6 + +
+ dictionary +
+ 		+ +
ICMPv6 protocol options.
+
+
+ beyond_scope + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Destination beyond scope.
+
+
+ destination_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Destination address is unreachable.
+
+
+ echo_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo reply.
+
+
+ echo_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo request (ping).
+
+
+ fragments + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Check non-initial fragments.
+
+
+ header + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter header problem.
+
+
+ hop_limit + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Hop limit exceeded in transit.
+
+
+ mld_query + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Multicast Listener Discovery Query.
+
+
+ mld_reduction + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Multicast Listener Discovery Reduction.
+
+
+ mld_report + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Multicast Listener Discovery Report.
+
+
+ mldv2 + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Multicast Listener Discovery Protocol.
+
+
+ nd_na + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor discovery neighbor advertisements.
+
+
+ nd_ns + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor discovery neighbor solicitations.
+
+
+ next_header + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter next header problems.
+
+
+ no_admin + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administration prohibited destination.
+
+
+ no_route + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
No route to destination.
+
+
+ packet_too_big + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Packet too big.
+
+
+ parameter_option + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter option problems.
+
+
+ parameter_problem + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All parameter problems.
+
+
+ port_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Port unreachable.
+
+
+ reassembly_timeout + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Reassembly timeout.
+
+
+ renum_command + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router renumbering command.
+
+
+ renum_result + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router renumbering result.
+
+
+ renum_seq_number + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router renumbering sequence number reset.
+
+
+ router_advertisement + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor discovery router advertisements.
+
+
+ router_renumbering + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All router renumbering.
+
+
+ router_solicitation + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor discovery router solicitations.
+
+
+ telemetry_path + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
IPT enabled.
+
+
+ telemetry_queue + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Flow of interest for BDC/HDC.
+
+
+ time_exceeded + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All time exceeded.
+
+
+ unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All unreachable.
+
+
+ igmp + +
+ dictionary +
+ 		+ +
IGMP protocol options.
+
+
+ dvmrp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Distance Vector Multicast Routing Protocol
+
+
+ host_query + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host Query
+
+
+ host_report + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host Report
+
+
+ tcp + +
+ dictionary +
+ 		+ +
TCP flags.
+
+
+ ack + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the ACK bit
+
+
+ established + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match established connections
+
+
+ fin + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the FIN bit
+
+
+ psh + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the PSH bit
+
+
+ rst + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the RST bit
+
+
+ syn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the SYN bit
+
+
+ urg + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match on the URG bit
+
+
+ remark + +
+ string +
+ 		+ +
Access list entry comment.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence number.
+
+
+ source + +
+ dictionary +
+ 		+ +
Specify the packet source.
+
+
+ address + +
+ string +
+ 		+ +
Source network address.
+
+
+ any + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Any source address.
+
+
+ host + +
+ string +
+ 		+ +
Host IP address.
+
+
+ port_protocol + +
+ dictionary +
+ 		+ +
Specify the destination port or protocol (only for TCP and UDP).
+
+
+ eq + +
+ string +
+ 		+ +
Match only packets on a given port number.
+
+
+ gt + +
+ string +
+ 		+ +
Match only packets with a greater port number.
+
+
+ lt + +
+ string +
+ 		+ +
Match only packets with a lower port number.
+
+
+ neq + +
+ string +
+ 		+ +
Match only packets not on a given port number.
+
+
+ range + +
+ dictionary +
+ 		+ +
Match only packets in the range of port numbers.
+
+
+ end + +
+ string +
+ 		+ +
Specify the end of the port range.
+
+
+ start + +
+ string +
+ 		+ +
Specify the start of the port range.
+
+
+ prefix + +
+ string +
+ 		+ +
Source network prefix. Only for prefixes of mask value less than 31 for ipv4 and 127 for ipv6. Prefixes of mask 32 (ipv4) and 128 (ipv6) should be given in the 'host' key.
+
+
+ wildcard_bits + +
+ string +
+ 		+ +
Source wildcard bits.
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the ACL.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
The Address Family Indicator (AFI) for the ACL.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section 'ip(v6* access-list).
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • deleted
    • +
  • gathered
    • +
  • merged ←
    • +
  • overridden
    • +
  • rendered
    • +
  • replaced
    • +
  • parsed
    • +
+ 		+
The state the configuration should be left in
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - As NX-OS allows configuring a rule again with different sequence numbers, the user is expected to provide sequence numbers for the access control entries to preserve idempotency. If no sequence number is given, the rule will be added as a new rule by the device. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + + - name: Merge provided ACLs configuration with device configuration + cisco.nxos.nxos_acls: + state: merged + config: + - afi: ipv4 + acls: + - name: ACL1v4 + aces: + - grant: deny + destination: + address: 192.0.2.64 + wildcard_bits: 0.0.0.255 + source: + any: true + port_protocol: + lt: 55 + protocol: tcp + protocol_options: + tcp: + ack: true + fin: true + sequence: 50 + + - afi: ipv6 + acls: + - name: ACL1v6 + aces: + - grant: permit + sequence: 10 + source: + any: true + destination: + prefix: 2001:db8:12::/32 + protocol: sctp + + # Task Output + # ----------- + # before: [] + # + # commands: + # - ip access-list ACL1v4 + # - 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + # - ipv6 access-list ACL1v6 + # - 10 permit sctp any 2001:db8:12::/32 + # + # after: + # - acls: + # - aces: + # - destination: + # prefix: 2001:db8:12::/32 + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # name: ACL1v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # address: 192.0.2.64 + # wildcard_bits: 0.0.0.255 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # fin: true + # sequence: 50 + # source: + # any: true + # port_protocol: + # lt: '55' + # name: ACL1v4 + # afi: ipv4 + + + # After state: + # ------------ + # + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + + # Using replaced + + # Before state: + # ---------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 10 permit ip any any + # 20 deny udp any any + # ip access-list ACL2v4 + # 10 permit ahp 192.0.2.0 0.0.0.255 any + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ipv6 access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + - name: Replace existing ACL configuration with provided configuration + cisco.nxos.nxos_acls: + config: + - afi: ipv4 + - afi: ipv6 + acls: + - name: ACL1v6 + aces: + - sequence: 20 + grant: permit + source: + any: true + destination: + any: true + protocol: pim + + - remark: Replaced ACE + - name: ACL2v6 + state: replaced + + # Task Output + # ----------- + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # - ipv6 access-list ACL1v6 + # - no 10 permit sctp any any + # - no 20 remark IPv6 ACL + # - remark Replaced ACE + # - 20 permit pim any any + # - ipv6 access-list ACL2v6 + # - no 10 deny ipv6 any 2001:db8:3000::/36 + # - no 20 permit tcp host 2001:db8:2000:2::2 host 2001:db8:2000:ab::2 + # + # after: + # - acls: + # - aces: + # - remark: Replaced ACE + # sequence: 10 + # - destination: + # any: true + # grant: permit + # protocol: pim + # sequence: 20 + # source: + # any: true + # name: ACL1v6 + # - name: ACL2v6 + # afi: ipv6 + + # After state: + # --------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ipv6 access-list ACL1v6 + # 10 remark Replaced ACE + # 20 permit pim any any + # ipv6 access-list ACL2v6 + + # Using overridden + + # Before state: + # ---------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 10 permit ip any any + # 20 deny udp any any + # ip access-list ACL2v4 + # 10 permit ahp 192.0.2.0 0.0.0.255 any + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ipv6 access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + - name: Override existing configuration with provided configuration + cisco.nxos.nxos_acls: + config: + - afi: ipv4 + acls: + - name: NewACL + aces: + - grant: deny + source: + address: 192.0.2.0 + wildcard_bits: 0.0.255.255 + destination: + any: true + protocol: eigrp + - remark: Example for overridden state + state: overridden + + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ipv6 access-list ACL1v6 + # - no ipv6 access-list ACL2v6 + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # - ip access-list NewACL + # - deny eigrp 192.0.2.0 0.0.255.255 any + # - remark Example for overridden state + # + # after: + # - acls: + # - aces: + # - destination: + # any: true + # grant: deny + # protocol: eigrp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.255.255 + # - remark: Example for overridden state + # sequence: 20 + # name: NewACL + # afi: ipv4 + + # After state: + # ------------ + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list NewACL + # 10 deny eigrp 192.0.2.0 0.0.255.255 any + # 20 remark Example for overridden state + + # Using deleted - delete all + # + # Before state: + # ------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 10 permit ip any any + # 20 deny udp any any + # ip access-list ACL2v4 + # 10 permit ahp 192.0.2.0 0.0.0.255 any + # ip access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ip access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + - name: Delete all ACLs + cisco.nxos.nxos_acls: + state: deleted + + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # - no ipv6 access-list ACL1v6 + # - no ipv6 access-list ACL2v6 + # + # after: [] + + + # After state: + # ----------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # + + # Using deleted - delete AFI + + # Before state: + # ------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 10 permit ip any any + # 20 deny udp any any + # ip access-list ACL2v4 + # 10 permit ahp 192.0.2.0 0.0.0.255 any + # ip access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ip access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + - name: Delete all ACLs in given AFI + cisco.nxos.nxos_acls: + config: + - afi: ipv4 + state: deleted + + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # + # after: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + + # After state: + # ------------ + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ip access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + # Using deleted - delete ACLs + + # Before state: + # ------------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 10 permit ip any any + # 20 deny udp any any + # ip access-list ACL2v4 + # 10 permit ahp 192.0.2.0 0.0.0.255 any + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + # 20 remark IPv6 ACL + # ipv6 access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + - name: Delete specific ACLs + cisco.nxos.nxos_acls: + state: deleted + config: + - afi: ipv4 + acls: + - name: ACL1v4 + - name: ACL2v4 + - afi: ipv6 + acls: + - name: ACL1v6 + + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # - no ipv6 access-list ACL1v6 + # + # after: + # - acls: + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + + # After state: + # ------------ + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ipv6 access-list ACL2v6 + # 10 deny ipv6 any 2001:db8:3000::/36 + # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 + + # Using parsed + + - name: Parse given config to structured data + cisco.nxos.nxos_acls: + running_config: | + ip access-list ACL1v4 + 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + ipv6 access-list ACL1v6 + 10 permit sctp any any + state: parsed + + # Task Output + # ------------ + # + # parsed: + # - afi: ipv4 + # acls: + # - name: ACL1v4 + # aces: + # - grant: deny + # destination: + # address: 192.0.2.64 + # wildcard_bits: 0.0.0.255 + # source: + # any: true + # port_protocol: + # lt: 55 + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # fin: true + # sequence: 50 + # + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # aces: + # - grant: permit + # sequence: 10 + # source: + # any: true + # destination: + # prefix: 2001:db8:12::/32 + # protocol: sctp + + + # Using gathered: + + # Before state: + # ------------ + # nxos-9k# show running-config | section '^ip(v6)* access-list' + # ip access-list ACL1v4 + # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + + - name: Gather existing configuration + cisco.nxos.nxos_acls: + state: gathered + + # Task Output + # ----------- + # + # gathered: + # - afi: ipv4 + # acls: + # - name: ACL1v4 + # aces: + # - grant: deny + # destination: + # address: 192.0.2.64 + # wildcard_bits: 0.0.0.255 + # source: + # any: true + # port_protocol: + # lt: 55 + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # fin: true + # sequence: 50 + + # - afi: ipv6 + # acls: + # - name: ACL1v6 + # aces: + # - grant: permit + # sequence: 10 + # source: + # any: true + # destination: + # prefix: 2001:db8:12::/32 + # protocol: sctp + + + # Using rendered + + - name: Render required configuration to be pushed to the device + cisco.nxos.nxos_acls: + config: + - afi: ipv4 + acls: + - name: ACL1v4 + aces: + - grant: deny + destination: + address: 192.0.2.64 + wildcard_bits: 0.0.0.255 + source: + any: true + port_protocol: + lt: 55 + protocol: tcp + protocol_options: + tcp: + ack: true + fin: true + sequence: 50 + - afi: ipv6 + acls: + - name: ACL1v6 + aces: + - grant: permit + sequence: 10 + source: + any: true + destination: + prefix: '2001:db8:12::/32' + protocol: sctp + state: rendered + + + # Task Output + # ----------- + # + # rendered: + # ip access-list ACL1v4 + # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + # ipv6 access-list ACL1v6 + # 10 permit sctp any any + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['ip access-list ACL1v4', '10 permit ip any any precedence critical log', '20 deny tcp any lt smtp host 192.0.2.64 ack fin']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['ip access-list ACL1v4', '10 permit ip any any precedence critical log', '20 deny tcp any lt smtp host 192.0.2.64 ack fin']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_banner_module.rst b/docs/cisco.nxos.nxos_banner_module.rst new file mode 100644 index 000000000..7502173b7 --- /dev/null +++ b/docs/cisco.nxos.nxos_banner_module.rst @@ -0,0 +1,187 @@ +.. _cisco.nxos.nxos_banner_module: + + +********************** +cisco.nxos.nxos_banner +********************** + +**Manage multiline banners on Cisco NXOS devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This will configure both exec and motd banners on remote devices running Cisco NXOS. It allows playbooks to add or remove banner text from the active running configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ banner + +
+ string + / required +
+ 		+
    Choices: +
  • exec
    • +
  • motd
    • +
+ 		+
Specifies which banner that should be configured on the remote device.
+
+
+ multiline_delimiter + +
+ string +
+ 		+ Default:
"@"
+ 		+
Specify the delimiting character than will be used for configuration.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specifies whether or not the configuration is present in the current devices active running configuration.
+
+
+ text + +
+ string +
+ 		+ +
The banner text that should be present in the remote device running configuration. This argument accepts a multiline string, with no empty lines. Requires state=present.
+
+
+ + +Notes +----- + +.. note:: + - Since responses from the device are always read with surrounding whitespaces stripped, tasks that configure banners with preceeding or trailing whitespaces will not be idempotent. + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: configure the exec banner + cisco.nxos.nxos_banner: + banner: exec + text: | + this is my exec banner + that contains a multiline + string + state: present + - name: remove the motd banner + cisco.nxos.nxos_banner: + banner: motd + state: absent + - name: Configure banner from file + cisco.nxos.nxos_banner: + banner: motd + text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}" + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['banner exec', 'this is my exec banner', 'that contains a multiline', 'string']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_bfd_global_module.rst b/docs/cisco.nxos.nxos_bfd_global_module.rst new file mode 100644 index 000000000..8cd86ec48 --- /dev/null +++ b/docs/cisco.nxos.nxos_bfd_global_module.rst @@ -0,0 +1,326 @@ +.. _cisco.nxos.nxos_bfd_global_module: + + +************************** +cisco.nxos.nxos_bfd_global +************************** + +**Bidirectional Forwarding Detection (BFD) global-level configuration** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages Bidirectional Forwarding Detection (BFD) global-level configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ echo_interface + +
+ string +
+ 		+ +
Loopback interface used for echo frames.
+
Valid values are loopback interface name or 'deleted'.
+
Not supported on N5K/N6K
+
+
+ echo_rx_interval + +
+ integer +
+ 		+ +
BFD Echo receive interval in milliseconds.
+
+
+ fabricpath_interval + +
+ dictionary +
+ 		+ +
BFD fabricpath interval timer values.
+
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
+
+
+ fabricpath_slow_timer + +
+ integer +
+ 		+ +
BFD fabricpath slow rate timer in milliseconds.
+
+
+ fabricpath_vlan + +
+ integer +
+ 		+ +
BFD fabricpath control vlan.
+
+
+ interval + +
+ dictionary +
+ 		+ +
BFD interval timer values.
+
Value must be a dict defining values for keys (tx, min_rx, and multiplier)
+
+
+ ipv4_echo_rx_interval + +
+ integer +
+ 		+ +
BFD IPv4 session echo receive interval in milliseconds.
+
+
+ ipv4_interval + +
+ dictionary +
+ 		+ +
BFD IPv4 interval timer values.
+
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
+
+
+ ipv4_slow_timer + +
+ integer +
+ 		+ +
BFD IPv4 slow rate timer in milliseconds.
+
+
+ ipv6_echo_rx_interval + +
+ integer +
+ 		+ +
BFD IPv6 session echo receive interval in milliseconds.
+
+
+ ipv6_interval + +
+ dictionary +
+ 		+ +
BFD IPv6 interval timer values.
+
Value must be a dict defining values for keys (tx, min_rx, and multiplier).
+
+
+ ipv6_slow_timer + +
+ integer +
+ 		+ +
BFD IPv6 slow rate timer in milliseconds.
+
+
+ slow_timer + +
+ integer +
+ 		+ +
BFD slow rate timer in milliseconds.
+
+
+ startup_timer + +
+ integer +
+ 		+ +
BFD delayed startup timer in seconds.
+
Not supported on N5K/N6K/N7K
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 9.2(2) + - Unsupported for Cisco MDS + - BFD global will automatically enable 'feature bfd' if it is disabled. + - BFD global does not have a 'state' parameter. All of the BFD commands are unique and are defined if 'feature bfd' is enabled. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_bfd_global: + echo_interface: Ethernet1/2 + echo_rx_interval: 50 + interval: + tx: 50 + min_rx: 50 + multiplier: 4 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ cmds + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['bfd echo-interface loopback1', 'bfd slow-timer 2000']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_bfd_interfaces_module.rst b/docs/cisco.nxos.nxos_bfd_interfaces_module.rst new file mode 100644 index 000000000..975de891c --- /dev/null +++ b/docs/cisco.nxos.nxos_bfd_interfaces_module.rst @@ -0,0 +1,394 @@ +.. _cisco.nxos.nxos_bfd_interfaces_module: + + +****************************** +cisco.nxos.nxos_bfd_interfaces +****************************** + +**BFD interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages attributes of Bidirectional Forwarding Detection (BFD) on the interface. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
The provided configuration
+
+
+ bfd + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/Disable Bidirectional Forwarding Detection (BFD) on the interface.
+
+
+ echo + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/Disable BFD Echo functionality on the interface.
+
+
+ name + +
+ string +
+ 		+ +
The name of the interface.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface|^feature bfd'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state of the configuration after module completion
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 7.0(3)I5(1). + - Unsupported for Cisco MDS + - Feature bfd should be enabled for this module. + + + +Examples +-------- + +.. code-block:: yaml + + # Using deleted + + - name: Configure interfaces + cisco.nxos.nxos_bfd_interfaces: + state: deleted + + + # Using merged + + - name: Configure interfaces + cisco.nxos.nxos_bfd_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + echo: enable + - name: Ethernet1/2 + bfd: disable + echo: disable + state: merged + + + # Using overridden + + - name: Configure interfaces + cisco.nxos.nxos_bfd_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + echo: enable + - name: Ethernet1/2 + bfd: disable + echo: disable + state: overridden + + + # Using replaced + + - name: Configure interfaces + cisco.nxos.nxos_bfd_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + echo: enable + - name: Ethernet1/2 + bfd: disable + echo: disable + state: replaced + + # Using rendered + + - name: Use rendered state to convert task input to device specific commands + cisco.nxos.nxos_bfd_interfaces: + config: + - name: Ethernet1/800 + bfd: enable + echo: enable + - name: Ethernet1/801 + bfd: disable + echo: disable + state: rendered + + # Task Output (redacted) + # ----------------------- + + # rendered: + # - "interface Ethernet1/800" + # - "bfd" + # - "bfd echo" + # - "interface Ethernet1/801" + # - "no bfd" + # - "no bfd echo" + + # Using parsed + + # parsed.cfg + # ------------ + + # feature bfd + # interface Ethernet1/800 + # no switchport + # no bfd + # no bfd echo + # interface Ethernet1/801 + # no switchport + # no bfd + # interface Ethernet1/802 + # no switchport + # no bfd echo + # interface mgmt0 + # ip address dhcp + # vrf member management + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_bfd_interfaces: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + + # parsed: + # - bfd: disable + # echo: disable + # name: Ethernet1/800 + # - bfd: disable + # echo: enable + # name: Ethernet1/801 + # - bfd: enable + # echo: disable + # name: Ethernet1/802 + # - bfd: enable + # echo: enable + # name: mgmt0 + + # Using gathered + + # Existing device config state + # ------------------------------- + + # feature bfd + # interface Ethernet1/1 + # no switchport + # no bfd + # interface Ethernet1/2 + # no switchport + # no bfd echo + # interface mgmt0 + # ip address dhcp + # vrf member management + + - name: Gather bfd_interfaces facts from the device using nxos_bfd_interfaces + cisco.nxos.nxos_bfd_interfaces: + state: gathered + + # Task output (redacted) + # ----------------------- + # gathered: + # - name: Ethernet1/1 + # bfd: disable + # echo: enable + # - name: Ethernet1/3 + # echo: disable + # bfd: enable + # - name: mgmt0 + # bfd: enable + # echo: enable + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/1', 'no bfd', 'no bfd echo']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_bgp_global_module.rst b/docs/cisco.nxos.nxos_bgp_global_module.rst new file mode 100644 index 000000000..19ee2709e --- /dev/null +++ b/docs/cisco.nxos.nxos_bgp_global_module.rst @@ -0,0 +1,5843 @@ +.. _cisco.nxos.nxos_bgp_global_module: + + +************************** +cisco.nxos.nxos_bgp_global +************************** + +**BGP Global resource module.** + + +Version added: 1.4.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages global BGP configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A list of BGP process configuration.
+
+
+ affinity_group + +
+ dictionary +
+ 		+ +
Configure an affinity group.
+
+
+ group_id + +
+ integer +
+ 		+ +
Affinity Group ID.
+
+
+ as_number + +
+ string +
+ 		+ +
Autonomous System Number of the router.
+
+
+ bestpath + +
+ dictionary +
+ 		+ +
Define the default bestpath selection algorithm.
+
+
+ always_compare_med + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare MED on paths from different AS.
+
+
+ as_path + +
+ dictionary +
+ 		+ +
AS-Path.
+
+
+ ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore AS-Path during bestpath selection.
+
+
+ multipath_relax + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Relax AS-Path restriction when choosing multipaths.
+
+
+ compare_neighborid + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
When more paths are available than max path config, use neighborid as tie-breaker.
+
+
+ compare_routerid + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare router-id for identical EBGP paths.
+
+
+ cost_community_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore cost communities in bestpath selection.
+
+
+ igp_metric_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore IGP metric for next-hop during bestpath selection.
+
+
+ med + +
+ dictionary +
+ 		+ +
MED
+
+
+ confed + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare MED only from paths originated from within a confederation.
+
+
+ missing_as_worst + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Treat missing MED as highest MED.
+
+
+ non_deterministic + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Not always pick the best-MED path among paths from same AS.
+
+
+ cluster_id + +
+ string +
+ 		+ +
Configure Route Reflector Cluster-ID.
+
+
+ confederation + +
+ dictionary +
+ 		+ +
AS confederation parameters.
+
+
+ identifier + +
+ string +
+ 		+ +
Set routing domain confederation AS.
+
+
+ peers + +
+ list + / elements=string +
+ 		+ +
Peer ASs in BGP confederation.
+
+
+ disable_policy_batching + +
+ dictionary +
+ 		+ +
Disable batching evaluation of outbound policy for a peer.
+
+
+ ipv4 + +
+ dictionary +
+ 		+ +
IPv4 address-family settings.
+
+
+ prefix_list + +
+ string +
+ 		+ +
Name of prefix-list to apply.
+
+
+ ipv6 + +
+ dictionary +
+ 		+ +
IPv6 address-family settings.
+
+
+ prefix_list + +
+ string +
+ 		+ +
Name of prefix-list to apply.
+
+
+ nexthop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Batching based on nexthop.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set policy batching.
+
+
+ dynamic_med_interval + +
+ integer +
+ 		+ +
Sets the interval for dampening of med changes.
+
+
+ enforce_first_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enforce neighbor AS is the first AS in AS-PATH attribute (EBGP).
+
+
+ enhanced_error + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable BGP Enhanced error handling.
+
+
+ fabric_soo + +
+ string +
+ 		+ +
Fabric site of origin.
+
+
+ fast_external_fallover + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Immediately reset the session if the link to a directly connected BGP peer goes down.
+
+
+ flush_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Flush routes in RIB upon controlled restart.
+
+
+ graceful_restart + +
+ dictionary +
+ 		+ +
Configure Graceful Restart functionality.
+
+
+ helper + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure Graceful Restart Helper mode functionality.
+
+
+ restart_time + +
+ integer +
+ 		+ +
Maximum time for restart advertised to peers.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable graceful-restart.
+
+
+ stalepath_time + +
+ integer +
+ 		+ +
Maximum time to keep a restarting peer's stale routes.
+
+
+ graceful_shutdown + +
+ dictionary +
+ 		+ +
Graceful-shutdown for BGP protocol.
+
+
+ activate + +
+ dictionary +
+ 		+ +
Send graceful-shutdown community on all routes.
+
+
+ route_map + +
+ string +
+ 		+ +
Apply route-map to modify attributes for outbound.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Activiate graceful-shutdown.
+
+
+ aware + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Lower preference of routes carrying graceful-shutdown community.
+
+
+ isolate + +
+ dictionary +
+ 		+ +
Isolate this router from BGP perspective.
+
+
+ include_local + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Withdraw both local and remote BGP routes.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Withdraw remote BGP routes to isolate this router.
+
+
+ log_neighbor_changes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log a message for neighbor up/down event.
+
+
+ maxas_limit + +
+ integer +
+ 		+ +
Allow AS-PATH attribute from EBGP neighbor imposing a limit on number of ASes.
+
+
+ neighbor_down + +
+ dictionary +
+ 		+ +
Handle BGP neighbor down event, due to various reasons.
+
+
+ fib_accelerate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor.
+
+
+ neighbors + +
+ list + / elements=dictionary +
+ 		+ +
Configure BGP neighbors.
+
+
+ bfd + +
+ dictionary +
+ 		+ +
Bidirectional Fast Detection for the neighbor.
+
+
+ multihop + +
+ dictionary +
+ 		+ +
Multihop session.
+
+
+ interval + +
+ dictionary +
+ 		+ +
Configure BFD session interval parameters.
+
+
+ min_rx_interval + +
+ integer +
+ 		+ +
Minimum RX interval.
+
+
+ multiplier + +
+ integer +
+ 		+ +
Detect Multiplier.
+
+
+ tx_interval + +
+ integer +
+ 		+ +
TX interval in milliseconds.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD multihop.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD for this neighbor.
+
+
+ singlehop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Single-hop session.
+
+
+ bmp_activate_server + +
+ integer +
+ 		+ +
Specify server ID for activating BMP monitoring for the peer.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Capability.
+
+
+ suppress_4_byte_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress 4-byte AS Capability.
+
+
+ description + +
+ string +
+ 		+ +
Neighbor specific descripion.
+
+
+ disable_connected_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable check for directly connected peer.
+
+
+ dont_capability_negotiate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Don't negotiate capability with this neighbor.
+
+
+ dscp + +
+ string +
+ 		+ +
Set dscp value for tcp transport.
+
+
+ dynamic_capability + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Dynamic Capability
+
+
+ ebgp_multihop + +
+ integer +
+ 		+ +
Specify multihop TTL for remote peer.
+
+
+ graceful_shutdown + +
+ dictionary +
+ 		+ +
Graceful-shutdown for this neighbor.
+
+
+ activate + +
+ dictionary +
+ 		+ +
Send graceful-shutdown community.
+
+
+ route_map + +
+ string +
+ 		+ +
Apply route-map to modify attributes for outbound.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set activate.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a template.
+
+
+ peer + +
+ string +
+ 		+ +
Peer template to inherit.
+
+
+ peer_session + +
+ string +
+ 		+ +
Peer-session template to inherit.
+
+
+ local_as + +
+ string +
+ 		+ +
Specify the local-as number for the eBGP neighbor.
+
+
+ log_neighbor_changes + +
+ dictionary +
+ 		+ +
Log message for neighbor up/down event.
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable logging of neighbor up/down event.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set log-neighbor-changes.
+
+
+ low_memory + +
+ dictionary +
+ 		+ +
Behaviour in low memory situations.
+
+
+ exempt + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not shutdown this peer when under memory pressure.
+
+
+ neighbor_address + +
+ string + / required +
+ 		+ +
IP address/Prefix of the neighbor or interface.
+
+
+ neighbor_affinity_group + +
+ dictionary +
+ 		+ +
Configure an affinity group.
+
+
+ group_id + +
+ integer +
+ 		+ +
Affinity Group ID.
+
+
+ password + +
+ dictionary +
+ 		+ +
Configure a password for neighbor.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 specifies an UNENCRYPTED neighbor password.
+
3 specifies an 3DES ENCRYPTED neighbor password will follow.
+
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
+
+
+ key + +
+ string +
+ 		+ +
Authentication password.
+
+
+ path_attribute + +
+ list + / elements=dictionary +
+ 		+ +
BGP path attribute optional filtering.
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • discard
    • +
  • treat-as-withdraw
    • +
+ 		+
Action.
+
+
+ range + +
+ dictionary +
+ 		+ +
Path attribute range.
+
+
+ end + +
+ integer +
+ 		+ +
Path attribute range end value.
+
+
+ start + +
+ integer +
+ 		+ +
Path attribute range start value.
+
+
+ type + +
+ integer +
+ 		+ +
Path attribute type
+
+
+ peer_type + +
+ string +
+ 		+
    Choices: +
  • fabric-border-leaf
    • +
  • fabric-external
    • +
+ 		+
Neighbor facing
+
+
+ remote_as + +
+ string +
+ 		+ +
Specify Autonomous System Number of the neighbor.
+
+
+ remote_as_route_map + +
+ string +
+ 		+ +
Route-map to match prefix peer AS number.
+
+
+ remove_private_as + +
+ dictionary +
+ 		+ +
Remove private AS number from outbound updates.
+
+
+ all + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All.
+
+
+ replace_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Replace.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Remove private AS.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown this neighbor.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure keepalive and hold timers.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Holdtime (seconds).
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval (seconds).
+
+
+ transport + +
+ dictionary +
+ 		+ +
BGP transport connection.
+
+
+ connection_mode + +
+ dictionary +
+ 		+ +
Specify type of connection.
+
+
+ passive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Allow passive connection setup only.
+
+
+ ttl_security + +
+ dictionary +
+ 		+ +
Enable TTL Security Mechanism.
+
+
+ hops + +
+ integer +
+ 		+ +
Specify hop count for remote peer.
+
+
+ update_source + +
+ string +
+ 		+ +
Specify source of BGP session and updates.
+
+
+ nexthop + +
+ dictionary +
+ 		+ +
Nexthop resolution options.
+
+
+ suppress_default_resolution + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Prohibit use of default route for nexthop address resolution.
+
+
+ rd + +
+ dictionary +
+ 		+ +
Secondary Route Distinguisher for vxlan multisite border gateway.
+
+
+ dual + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Generate Secondary RD for all VRFs and L2VNIs.
+
+
+ id + +
+ integer +
+ 		+ +
Specify 2 byte value for ID.
+
+
+ reconnect_interval + +
+ integer +
+ 		+ +
Configure connection reconnect interval.
+
+
+ router_id + +
+ string +
+ 		+ +
Specify the IP address to use as router-id.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown BGP protocol.
+
+
+ suppress_fib_pending + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise only routes that are programmed in hardware to peers.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure bgp related timers.
+
+
+ bestpath_limit + +
+ dictionary +
+ 		+ +
Configure timeout for first bestpath after restart.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure update-delay-always option.
+
+
+ timeout + +
+ integer +
+ 		+ +
Bestpath timeout (seconds).
+
+
+ bgp + +
+ dictionary +
+ 		+ +
Configure different bgp keepalive and holdtimes.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Holdtime (seconds).
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval (seconds).
+
+
+ prefix_peer_timeout + +
+ integer +
+ 		+ +
Prefix Peer timeout (seconds).
+
+
+ prefix_peer_wait + +
+ integer +
+ 		+ +
Configure wait timer for a prefix peer.
+
+
+ vrfs + +
+ list + / elements=dictionary +
+ 		+ +
Virtual Router Context configurations.
+
+
+ allocate_index + +
+ integer +
+ 		+ +
Configure allocate-index.
+
+
+ bestpath + +
+ dictionary +
+ 		+ +
Define the default bestpath selection algorithm.
+
+
+ always_compare_med + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare MED on paths from different AS.
+
+
+ as_path + +
+ dictionary +
+ 		+ +
AS-Path.
+
+
+ ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore AS-Path during bestpath selection.
+
+
+ multipath_relax + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Relax AS-Path restriction when choosing multipaths.
+
+
+ compare_neighborid + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
When more paths are available than max path config, use neighborid as tie-breaker.
+
+
+ compare_routerid + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare router-id for identical EBGP paths.
+
+
+ cost_community_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore cost communities in bestpath selection.
+
+
+ igp_metric_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore IGP metric for next-hop during bestpath selection.
+
+
+ med + +
+ dictionary +
+ 		+ +
MED
+
+
+ confed + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare MED only from paths originated from within a confederation.
+
+
+ missing_as_worst + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Treat missing MED as highest MED.
+
+
+ non_deterministic + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Not always pick the best-MED path among paths from same AS.
+
+
+ cluster_id + +
+ string +
+ 		+ +
Configure Route Reflector Cluster-ID.
+
+
+ confederation + +
+ dictionary +
+ 		+ +
AS confederation parameters.
+
+
+ identifier + +
+ string +
+ 		+ +
Set routing domain confederation AS.
+
+
+ peers + +
+ list + / elements=string +
+ 		+ +
Peer ASs in BGP confederation.
+
+
+ graceful_restart + +
+ dictionary +
+ 		+ +
Configure Graceful Restart functionality.
+
+
+ helper + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure Graceful Restart Helper mode functionality.
+
+
+ restart_time + +
+ integer +
+ 		+ +
Maximum time for restart advertised to peers.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable graceful-restart.
+
+
+ stalepath_time + +
+ integer +
+ 		+ +
Maximum time to keep a restarting peer's stale routes.
+
+
+ local_as + +
+ string +
+ 		+ +
Specify the local-as for this vrf.
+
+
+ log_neighbor_changes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log a message for neighbor up/down event.
+
+
+ maxas_limit + +
+ integer +
+ 		+ +
Allow AS-PATH attribute from EBGP neighbor imposing a limit on number of ASes.
+
+
+ neighbor_down + +
+ dictionary +
+ 		+ +
Handle BGP neighbor down event, due to various reasons.
+
+
+ fib_accelerate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Accelerate the hardware updates for IP/IPv6 adjacencies for neighbor.
+
+
+ neighbors + +
+ list + / elements=dictionary +
+ 		+ +
Configure BGP neighbors.
+
+
+ bfd + +
+ dictionary +
+ 		+ +
Bidirectional Fast Detection for the neighbor.
+
+
+ multihop + +
+ dictionary +
+ 		+ +
Multihop session.
+
+
+ interval + +
+ dictionary +
+ 		+ +
Configure BFD session interval parameters.
+
+
+ min_rx_interval + +
+ integer +
+ 		+ +
Minimum RX interval.
+
+
+ multiplier + +
+ integer +
+ 		+ +
Detect Multiplier.
+
+
+ tx_interval + +
+ integer +
+ 		+ +
TX interval in milliseconds.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD multihop.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD for this neighbor.
+
+
+ singlehop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Single-hop session.
+
+
+ bmp_activate_server + +
+ integer +
+ 		+ +
Specify server ID for activating BMP monitoring for the peer.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Capability.
+
+
+ suppress_4_byte_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress 4-byte AS Capability.
+
+
+ description + +
+ string +
+ 		+ +
Neighbor specific descripion.
+
+
+ disable_connected_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable check for directly connected peer.
+
+
+ dont_capability_negotiate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Don't negotiate capability with this neighbor.
+
+
+ dscp + +
+ string +
+ 		+ +
Set dscp value for tcp transport.
+
+
+ dynamic_capability + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Dynamic Capability
+
+
+ ebgp_multihop + +
+ integer +
+ 		+ +
Specify multihop TTL for remote peer.
+
+
+ graceful_shutdown + +
+ dictionary +
+ 		+ +
Graceful-shutdown for this neighbor.
+
+
+ activate + +
+ dictionary +
+ 		+ +
Send graceful-shutdown community.
+
+
+ route_map + +
+ string +
+ 		+ +
Apply route-map to modify attributes for outbound.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set activate.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a template.
+
+
+ peer + +
+ string +
+ 		+ +
Peer template to inherit.
+
+
+ peer_session + +
+ string +
+ 		+ +
Peer-session template to inherit.
+
+
+ local_as + +
+ string +
+ 		+ +
Specify the local-as number for the eBGP neighbor.
+
+
+ log_neighbor_changes + +
+ dictionary +
+ 		+ +
Log message for neighbor up/down event.
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable logging of neighbor up/down event.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set log-neighbor-changes.
+
+
+ low_memory + +
+ dictionary +
+ 		+ +
Behaviour in low memory situations.
+
+
+ exempt + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not shutdown this peer when under memory pressure.
+
+
+ neighbor_address + +
+ string + / required +
+ 		+ +
IP address/Prefix of the neighbor or interface.
+
+
+ neighbor_affinity_group + +
+ dictionary +
+ 		+ +
Configure an affinity group.
+
+
+ group_id + +
+ integer +
+ 		+ +
Affinity Group ID.
+
+
+ password + +
+ dictionary +
+ 		+ +
Configure a password for neighbor.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 specifies an UNENCRYPTED neighbor password.
+
3 specifies an 3DES ENCRYPTED neighbor password will follow.
+
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
+
+
+ key + +
+ string +
+ 		+ +
Authentication password.
+
+
+ path_attribute + +
+ list + / elements=dictionary +
+ 		+ +
BGP path attribute optional filtering.
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • discard
    • +
  • treat-as-withdraw
    • +
+ 		+
Action.
+
+
+ range + +
+ dictionary +
+ 		+ +
Path attribute range.
+
+
+ end + +
+ integer +
+ 		+ +
Path attribute range end value.
+
+
+ start + +
+ integer +
+ 		+ +
Path attribute range start value.
+
+
+ type + +
+ integer +
+ 		+ +
Path attribute type
+
+
+ peer_type + +
+ string +
+ 		+
    Choices: +
  • fabric-border-leaf
    • +
  • fabric-external
    • +
+ 		+
Neighbor facing
+
+
+ remote_as + +
+ string +
+ 		+ +
Specify Autonomous System Number of the neighbor.
+
+
+ remote_as_route_map + +
+ string +
+ 		+ +
Route-map to match prefix peer AS number.
+
+
+ remove_private_as + +
+ dictionary +
+ 		+ +
Remove private AS number from outbound updates.
+
+
+ all + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All.
+
+
+ replace_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Replace.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Remove private AS.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown this neighbor.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure keepalive and hold timers.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Holdtime (seconds).
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval (seconds).
+
+
+ transport + +
+ dictionary +
+ 		+ +
BGP transport connection.
+
+
+ connection_mode + +
+ dictionary +
+ 		+ +
Specify type of connection.
+
+
+ passive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Allow passive connection setup only.
+
+
+ ttl_security + +
+ dictionary +
+ 		+ +
Enable TTL Security Mechanism.
+
+
+ hops + +
+ integer +
+ 		+ +
Specify hop count for remote peer.
+
+
+ update_source + +
+ string +
+ 		+ +
Specify source of BGP session and updates.
+
+
+ reconnect_interval + +
+ integer +
+ 		+ +
Configure connection reconnect interval.
+
+
+ router_id + +
+ string +
+ 		+ +
Specify the IP address to use as router-id.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure bgp related timers.
+
+
+ bestpath_limit + +
+ dictionary +
+ 		+ +
Configure timeout for first bestpath after restart.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure update-delay-always option.
+
+
+ timeout + +
+ integer +
+ 		+ +
Bestpath timeout (seconds).
+
+
+ bgp + +
+ dictionary +
+ 		+ +
Configure different bgp keepalive and holdtimes.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Holdtime (seconds).
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval (seconds).
+
+
+ prefix_peer_timeout + +
+ integer +
+ 		+ +
Prefix Peer timeout (seconds).
+
+
+ prefix_peer_wait + +
+ integer +
+ 		+ +
Configure wait timer for a prefix peer.
+
+
+ vrf + +
+ string +
+ 		+ +
VRF name.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^router bgp'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • purged
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
State purged removes all the BGP configurations from the target device. Use caution with this state.
+
State deleted only removes BGP attributes that this modules manages and does not negate the BGP process completely. Thereby, preserving address-family related configurations under BGP context.
+
Running states deleted and replaced will result in an error if there are address-family configuration lines present under a neighbor, or a vrf context that is to be removed. Please use the cisco.nxos.nxos_bgp_af or cisco.nxos.nxos_bgp_neighbor_af modules for prior cleanup.
+
States merged and replaced will result in a failure if BGP is already configured with a different ASN than what is provided in the task. In such cases, please use state purged to remove the existing BGP process and proceed further.
+
States replaced and overridden have the same behaviour for this module.
+
Refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # Nexus9000v# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_bgp_global: + config: + as_number: 65563 + router_id: 192.168.1.1 + bestpath: + as_path: + multipath_relax: true + compare_neighborid: true + cost_community_ignore: true + confederation: + identifier: 42 + peers: + - 65020 + - 65030 + - 65040 + log_neighbor_changes: true + maxas_limit: 20 + neighbors: + - neighbor_address: 192.168.1.100 + neighbor_affinity_group: + group_id: 160 + bmp_activate_server: 1 + remote_as: 65563 + description: NBR-1 + low_memory: + exempt: true + - neighbor_address: 192.168.1.101 + remote_as: 65563 + password: + encryption: 7 + key: 12090404011C03162E + neighbor_down: + fib_accelerate: true + vrfs: + - vrf: site-1 + allocate_index: 5000 + local_as: 200 + log_neighbor_changes: true + neighbors: + - neighbor_address: 198.51.100.1 + description: site-1-nbr-1 + password: + encryption: 3 + key: 13D4D3549493D2877B1DC116EE27A6BE + remote_as: 65562 + - neighbor_address: 198.51.100.2 + remote_as: 65562 + description: site-1-nbr-2 + - vrf: site-2 + local_as: 300 + log_neighbor_changes: true + neighbors: + - neighbor_address: 203.0.113.2 + description: site-2-nbr-1 + password: + encryption: 3 + key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + remote_as: 65568 + neighbor_down: + fib_accelerate: true + + # Task output: + # ------------ + # before: {} + # + # commands: + # - router bgp 65563 + # - bestpath as-path multipath-relax + # - bestpath compare-neighborid + # - bestpath cost-community ignore + # - confederation identifier 42 + # - log-neighbor-changes + # - maxas-limit 20 + # - neighbor-down fib-accelerate + # - router-id 192.168.1.1 + # - confederation peers 65020 65030 65040 + # - neighbor 192.168.1.100 + # - remote-as 65563 + # - affinity-group 160 + # - bmp-activate-server 1 + # - description NBR-1 + # - low-memory exempt + # - neighbor 192.168.1.101 + # - remote-as 65563 + # - password 7 12090404011C03162E + # - vrf site-1 + # - allocate-index 5000 + # - local-as 200 + # - log-neighbor-changes + # - neighbor 198.51.100.1 + # - remote-as 65562 + # - description site-1-nbr-1 + # - password 3 13D4D3549493D2877B1DC116EE27A6BE + # - neighbor 198.51.100.2 + # - remote-as 65562 + # - description site-1-nbr-2 + # - vrf site-2 + # - local-as 300 + # - log-neighbor-changes + # - neighbor-down fib-accelerate + # - neighbor 203.0.113.2 + # - remote-as 65568 + # - description site-2-nbr-1 + # - password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + # + # after: + # as_number: '65563' + # bestpath: + # as_path: + # multipath_relax: true + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65040' + # log_neighbor_changes: true + # maxas_limit: 20 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # - neighbor_address: 192.168.1.101 + # password: + # encryption: 7 + # key: 12090404011C03162E + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - allocate_index: 5000 + # local_as: '200' + # log_neighbor_changes: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 198.51.100.1 + # password: + # encryption: 3 + # key: 13D4D3549493D2877B1DC116EE27A6BE + # remote_as: '65562' + # - description: site-1-nbr-2 + # neighbor_address: 198.51.100.2 + # remote_as: '65562' + # vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - description: site-2-nbr-1 + # neighbor_address: 203.0.113.2 + # password: + # encryption: 3 + # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + # remote_as: '65568' + # vrf: site-2 + + + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65040 + # bestpath as-path multipath-relax + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 20 + # log-neighbor-changes + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # neighbor 192.168.1.101 + # remote-as 65563 + # password 7 12090404011C03162E + # vrf site-1 + # local-as 200 + # log-neighbor-changes + # allocate-index 5000 + # neighbor 198.51.100.1 + # remote-as 65562 + # description site-1-nbr-1 + # password 3 13D4D3549493D2877B1DC116EE27A6BE + # neighbor 198.51.100.2 + # remote-as 65562 + # description site-1-nbr-2 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # remote-as 65568 + # description site-2-nbr-1 + # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + # Using replaced + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65040 + # bestpath as-path multipath-relax + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 20 + # log-neighbor-changes + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # neighbor 192.168.1.101 + # remote-as 65563 + # password 7 12090404011C03162E + # vrf site-1 + # local-as 200 + # log-neighbor-changes + # allocate-index 5000 + # neighbor 198.51.100.1 + # remote-as 65562 + # description site-1-nbr-1 + # password 3 13D4D3549493D2877B1DC116EE27A6BE + # neighbor 198.51.100.2 + # remote-as 65562 + # description site-1-nbr-2 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # remote-as 65568 + # description site-2-nbr-1 + # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + - name: Replace BGP configuration with provided configuration + cisco.nxos.nxos_bgp_global: + config: + as_number: 65563 + router_id: 192.168.1.1 + bestpath: + compare_neighborid: true + cost_community_ignore: true + confederation: + identifier: 42 + peers: + - 65020 + - 65030 + - 65050 + maxas_limit: 40 + neighbors: + - neighbor_address: 192.168.1.100 + neighbor_affinity_group: + group_id: 160 + bmp_activate_server: 1 + remote_as: 65563 + description: NBR-1 + low_memory: + exempt: true + neighbor_down: + fib_accelerate: true + vrfs: + - vrf: site-2 + local_as: 300 + log_neighbor_changes: true + neighbors: + - neighbor_address: 203.0.113.2 + password: + encryption: 7 + key: 12090404011C03162E + neighbor_down: + fib_accelerate: true + state: replaced + + # Task output: + # ------------ + # before: + # as_number: '65563' + # bestpath: + # as_path: + # multipath_relax: true + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65040' + # log_neighbor_changes: true + # maxas_limit: 20 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # - neighbor_address: 192.168.1.101 + # password: + # encryption: 7 + # key: 12090404011C03162E + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - allocate_index: 5000 + # local_as: '200' + # log_neighbor_changes: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 198.51.100.1 + # password: + # encryption: 3 + # key: 13D4D3549493D2877B1DC116EE27A6BE + # remote_as: '65562' + # - description: site-1-nbr-2 + # neighbor_address: 198.51.100.2 + # remote_as: '65562' + # vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - description: site-2-nbr-1 + # neighbor_address: 203.0.113.2 + # password: + # encryption: 3 + # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + # remote_as: '65568' + # vrf: site-2 + # + # commands: + # - router bgp 65563 + # - no bestpath as-path multipath-relax + # - no log-neighbor-changes + # - maxas-limit 40 + # - no confederation peers 65020 65030 65040 + # - confederation peers 65020 65030 65050 + # - no neighbor 192.168.1.101 + # - vrf site-2 + # - neighbor 203.0.113.2 + # - no remote-as 65568 + # - no description site-2-nbr-1 + # - password 7 12090404011C03162E + # - no vrf site-1 + + # after: + # as_number: '65563' + # bestpath: + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65050' + # maxas_limit: 40 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - neighbor_address: 203.0.113.2 + # password: + # encryption: 7 + # key: 12090404011C03162E + # vrf: site-2 + # + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65050 + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 40 + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # password 7 12090404011C03162E + + # Using deleted + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65040 + # bestpath as-path multipath-relax + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 20 + # log-neighbor-changes + # address-family ipv4 unicast + # default-metric 400 + # suppress-inactive + # default-information originate + # address-family ipv6 multicast + # wait-igp-convergence + # redistribute eigrp eigrp-1 route-map site-1-rmap + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # neighbor 192.168.1.101 + # remote-as 65563 + # password 7 12090404011C03162E + # vrf site-1 + # local-as 200 + # log-neighbor-changes + # allocate-index 5000 + # address-family ipv4 multicast + # maximum-paths 40 + # dampen-igp-metric 1200 + # neighbor 198.51.100.1 + # remote-as 65562 + # description site-1-nbr-1 + # password 3 13D4D3549493D2877B1DC116EE27A6BE + # neighbor 198.51.100.2 + # remote-as 65562 + # description site-1-nbr-2 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # remote-as 65568 + # description site-1-nbr-1 + # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + - name: Delete BGP configurations handled by this module + cisco.nxos.nxos_bgp_global: + state: deleted + + # Task output: + # ------------ + + # before: + # as_number: '65563' + # bestpath: + # as_path: + # multipath_relax: true + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65040' + # log_neighbor_changes: true + # maxas_limit: 20 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # - neighbor_address: 192.168.1.101 + # password: + # encryption: 7 + # key: 12090404011C03162E + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - allocate_index: 5000 + # local_as: '200' + # log_neighbor_changes: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 198.51.100.1 + # password: + # encryption: 3 + # key: 13D4D3549493D2877B1DC116EE27A6BE + # remote_as: '65562' + # - description: site-1-nbr-2 + # neighbor_address: 198.51.100.2 + # remote_as: '65562' + # vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 203.0.113.2 + # password: + # encryption: 3 + # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + # remote_as: '65568' + # vrf: site-2 + # + # commands: + # - router bgp 65563 + # - no bestpath as-path multipath-relax + # - no bestpath compare-neighborid + # - no bestpath cost-community ignore + # - no confederation identifier 42 + # - no log-neighbor-changes + # - no maxas-limit 20 + # - no neighbor-down fib-accelerate + # - no router-id 192.168.1.1 + # - no confederation peers 65020 65030 65040 + # - no neighbor 192.168.1.100 + # - no neighbor 192.168.1.101 + # - no vrf site-1 + # - no vrf site-2 + # + # after: + # as_number: '65563' + # + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # address-family ipv4 unicast + # default-metric 400 + # suppress-inactive + # default-information originate + # address-family ipv6 multicast + # wait-igp-convergence + # redistribute eigrp eigrp-1 route-map site-1-rmap + # + + # Using purged + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65040 + # bestpath as-path multipath-relax + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 20 + # log-neighbor-changes + # address-family ipv4 unicast + # default-metric 400 + # suppress-inactive + # default-information originate + # address-family ipv6 multicast + # wait-igp-convergence + # redistribute eigrp eigrp-1 route-map site-1-rmap + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # neighbor 192.168.1.101 + # remote-as 65563 + # password 7 12090404011C03162E + # vrf site-1 + # local-as 200 + # log-neighbor-changes + # allocate-index 5000 + # address-family ipv4 multicast + # maximum-paths 40 + # dampen-igp-metric 1200 + # neighbor 198.51.100.1 + # remote-as 65562 + # description site-1-nbr-1 + # password 3 13D4D3549493D2877B1DC116EE27A6BE + # neighbor 198.51.100.2 + # remote-as 65562 + # description site-1-nbr-2 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # remote-as 65568 + # description site-1-nbr-1 + # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + - name: Purge all BGP configurations from the device + cisco.nxos.nxos_bgp_global: + state: purged + + # Task output: + # ------------ + + # before: + # as_number: '65563' + # bestpath: + # as_path: + # multipath_relax: true + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65040' + # log_neighbor_changes: true + # maxas_limit: 20 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # - neighbor_address: 192.168.1.101 + # password: + # encryption: 7 + # key: 12090404011C03162E + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - allocate_index: 5000 + # local_as: '200' + # log_neighbor_changes: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 198.51.100.1 + # password: + # encryption: 3 + # key: 13D4D3549493D2877B1DC116EE27A6BE + # remote_as: '65562' + # - description: site-1-nbr-2 + # neighbor_address: 198.51.100.2 + # remote_as: '65562' + # vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 203.0.113.2 + # password: + # encryption: 3 + # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + # remote_as: '65568' + # vrf: site-2 + # + # commands: + # - no router bgp 65563 + # + # after: {} + # + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # Nexus9000v# + + # Using rendered + + - name: Render platform specific configuration lines (without connecting to the device) + cisco.nxos.nxos_bgp_global: + config: + as_number: 65563 + router_id: 192.168.1.1 + bestpath: + as_path: + multipath_relax: true + compare_neighborid: true + cost_community_ignore: true + confederation: + identifier: 42 + peers: + - 65020 + - 65030 + - 65040 + log_neighbor_changes: true + maxas_limit: 20 + neighbors: + - neighbor_address: 192.168.1.100 + neighbor_affinity_group: + group_id: 160 + bmp_activate_server: 1 + remote_as: 65563 + description: NBR-1 + low_memory: + exempt: true + - neighbor_address: 192.168.1.101 + remote_as: 65563 + password: + encryption: 7 + key: 12090404011C03162E + neighbor_down: + fib_accelerate: true + vrfs: + - vrf: site-1 + allocate_index: 5000 + local_as: 200 + log_neighbor_changes: true + neighbors: + - neighbor_address: 198.51.100.1 + description: site-1-nbr-1 + password: + encryption: 3 + key: 13D4D3549493D2877B1DC116EE27A6BE + remote_as: 65562 + - neighbor_address: 198.51.100.2 + remote_as: 65562 + description: site-1-nbr-2 + - vrf: site-2 + local_as: 300 + log_neighbor_changes: true + neighbors: + - neighbor_address: 203.0.113.2 + description: site-1-nbr-1 + password: + encryption: 3 + key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + remote_as: 65568 + neighbor_down: + fib_accelerate: true + + # Task output: + # ------------ + # rendered: + # - router bgp 65563 + # - bestpath as-path multipath-relax + # - bestpath compare-neighborid + # - bestpath cost-community ignore + # - confederation identifier 42 + # - log-neighbor-changes + # - maxas-limit 20 + # - neighbor-down fib-accelerate + # - router-id 192.168.1.1 + # - confederation peers 65020 65030 65040 + # - neighbor 192.168.1.100 + # - remote-as 65563 + # - affinity-group 160 + # - bmp-activate-server 1 + # - description NBR-1 + # - low-memory exempt + # - neighbor 192.168.1.101 + # - remote-as 65563 + # - password 7 12090404011C03162E + # - vrf site-1 + # - allocate-index 5000 + # - local-as 200 + # - log-neighbor-changes + # - neighbor 198.51.100.1 + # - remote-as 65562 + # - description site-1-nbr-1 + # - password 3 13D4D3549493D2877B1DC116EE27A6BE + # - neighbor 198.51.100.2 + # - remote-as 65562 + # - description site-1-nbr-2 + # - vrf site-2 + # - local-as 300 + # - log-neighbor-changes + # - neighbor-down fib-accelerate + # - neighbor 203.0.113.2 + # - remote-as 65568 + # - description site-1-nbr-1 + # - password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + # Using parsed + + # parsed.cfg + # ------------ + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65040 + # bestpath as-path multipath-relax + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 20 + # log-neighbor-changes + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # neighbor 192.168.1.101 + # remote-as 65563 + # password 7 12090404011C03162E + # vrf site-1 + # local-as 200 + # log-neighbor-changes + # allocate-index 5000 + # neighbor 198.51.100.1 + # remote-as 65562 + # description site-1-nbr-1 + # password 3 13D4D3549493D2877B1DC116EE27A6BE + # neighbor 198.51.100.2 + # remote-as 65562 + # description site-1-nbr-2 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # remote-as 65568 + # description site-1-nbr-1 + # password 3 AF92F4C16A0A0EC5BDF56CF58BC030F6 + + - name: Parse externally provided BGP config + cisco.nxos.nxos_bgp_global: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output: + # ------------ + # parsed: + # as_number: '65563' + # bestpath: + # as_path: + # multipath_relax: true + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65040' + # log_neighbor_changes: true + # maxas_limit: 20 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # - neighbor_address: 192.168.1.101 + # password: + # encryption: 7 + # key: 12090404011C03162E + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - allocate_index: 5000 + # local_as: '200' + # log_neighbor_changes: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 198.51.100.1 + # password: + # encryption: 3 + # key: 13D4D3549493D2877B1DC116EE27A6BE + # remote_as: '65562' + # - description: site-1-nbr-2 + # neighbor_address: 198.51.100.2 + # remote_as: '65562' + # vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - description: site-1-nbr-1 + # neighbor_address: 203.0.113.2 + # password: + # encryption: 3 + # key: AF92F4C16A0A0EC5BDF56CF58BC030F6 + # remote_as: '65568' + # vrf: site-2 + + # Using gathered + + # existing config + # + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65563 + # router-id 192.168.1.1 + # confederation identifier 42 + # confederation peers 65020 65030 65050 + # bestpath cost-community ignore + # bestpath compare-neighborid + # neighbor-down fib-accelerate + # maxas-limit 40 + # neighbor 192.168.1.100 + # low-memory exempt + # bmp-activate-server 1 + # remote-as 65563 + # description NBR-1 + # affinity-group 160 + # vrf site-1 + # vrf site-2 + # local-as 300 + # neighbor-down fib-accelerate + # log-neighbor-changes + # neighbor 203.0.113.2 + # password 7 12090404011C03162E + + - name: Gather BGP facts using gathered + cisco.nxos.nxos_bgp_global: + state: gathered + + # Task output: + # ------------ + # gathered: + # as_number: '65563' + # bestpath: + # compare_neighborid: true + # cost_community_ignore: true + # confederation: + # identifier: '42' + # peers: + # - '65020' + # - '65030' + # - '65050' + # maxas_limit: 40 + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - bmp_activate_server: 1 + # description: NBR-1 + # low_memory: + # exempt: true + # neighbor_address: 192.168.1.100 + # neighbor_affinity_group: + # group_id: 160 + # remote_as: '65563' + # router_id: 192.168.1.1 + # vrfs: + # - vrf: site-1 + # - local_as: '300' + # log_neighbor_changes: true + # neighbor_down: + # fib_accelerate: true + # neighbors: + # - neighbor_address: 203.0.113.2 + # password: + # encryption: 7 + # key: 12090404011C03162E + # vrf: site-2 + + # Remove a neighbor having AF configurations with state replaced (will fail) + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # log-neighbor-changes + # maxas-limit 20 + # router-id 198.51.100.2 + # neighbor 203.0.113.2 + # address-family ipv4 unicast + # next-hop-self + # remote-as 65538 + # affinity-group 160 + # description NBR-1 + # low-memory exempt + # neighbor 192.0.2.1 + # remote-as 65537 + # password 7 12090404011C03162E + + - name: Remove a neighbor having AF configurations (should fail) + cisco.nxos.nxos_bgp_global: + config: + as_number: 65536 + router_id: 198.51.100.2 + maxas_limit: 20 + log_neighbor_changes: true + neighbors: + - neighbor_address: 192.0.2.1 + remote_as: 65537 + password: + encryption: 7 + key: 12090404011C03162E + state: replaced + + # Task output: + # ------------ + # fatal: [Nexus9000v]: FAILED! => changed=false + # msg: Neighbor 203.0.113.2 has address-family configurations. + # Please use the nxos_bgp_neighbor_af module to remove those first. + + # Remove a VRF having AF configurations with state replaced (will fail) + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # log-neighbor-changes + # maxas-limit 20 + # router-id 198.51.100.2 + # neighbor 192.0.2.1 + # remote-as 65537 + # password 7 12090404011C03162E + # vrf site-1 + # address-family ipv4 unicast + # default-information originate + # neighbor 203.0.113.2 + # remote-as 65538 + # affinity-group 160 + # description NBR-1 + # low-memory exempt + # vrf site-2 + # neighbor-down fib-accelerate + + - name: Remove a VRF having AF configurations (should fail) + cisco.nxos.nxos_bgp_global: + config: + as_number: 65536 + router_id: 198.51.100.2 + maxas_limit: 20 + log_neighbor_changes: true + neighbors: + - neighbor_address: 192.0.2.1 + remote_as: 65537 + password: + encryption: 7 + key: 12090404011C03162E + vrfs: + - vrf: site-2 + neighbor_down: + fib_accelerate: true + state: replaced + + # Task output: + # ------------ + # fatal: [Nexus9000v]: FAILED! => changed=false + # msg: VRF site-1 has address-family configurations. + # Please use the nxos_bgp_af module to remove those first. + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['router bgp 65563', 'maxas-limit 20', 'router-id 192.168.1.1', 'confederation peers 65020 65030 65040', 'neighbor 192.168.1.100', 'remote-as 65563', 'affinity-group 160', 'bmp-activate-server 1', 'description NBR-1', 'low-memory exempt', 'vrf site-1', 'log-neighbor-changes', 'neighbor 198.51.100.1', 'remote-as 65562', 'description site-1-nbr-1', 'password 3 13D4D3549493D2877B1DC116EE27A6BE']
+
+
+ gathered + +
+ dictionary +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ dictionary +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['router bgp 65563', 'maxas-limit 20', 'router-id 192.168.1.1']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst b/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst new file mode 100644 index 000000000..8668a0b9f --- /dev/null +++ b/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst @@ -0,0 +1,3575 @@ +.. _cisco.nxos.nxos_bgp_neighbor_address_family_module: + + +******************************************* +cisco.nxos.nxos_bgp_neighbor_address_family +******************************************* + +**BGP Neighbor Address Family resource module.** + + +Version added: 2.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages BGP Neighbor Address Family configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
BGP Neighbor AF configuration.
+
+
+ as_number + +
+ string +
+ 		+ +
Autonomous System Number of the router.
+
+
+ neighbors + +
+ list + / elements=dictionary +
+ 		+ +
A list of BGP Neighbor AF configuration.
+
+
+ address_family + +
+ list + / elements=dictionary +
+ 		+ +
BGP Neighbor Address Family related configurations.
+
+
+ advertise_map + +
+ dictionary +
+ 		+ +
Specify route-map for conditional advertisement.
+
+
+ exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition exists.
+
+
+ non_exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition does not exist.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
Route-map name.
+
+
+ advertisement_interval + +
+ integer +
+ 		+ +
Minimum interval between sending BGP routing updates.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
  • link-state
    • +
  • vpnv4
    • +
  • vpnv6
    • +
  • l2vpn
    • +
+ 		+
Address Family indicator.
+
+
+ allowas_in + +
+ dictionary +
+ 		+ +
Accept as-path with my AS present in it.
+
+
+ max_occurences + +
+ integer +
+ 		+ +
Number of occurrences of AS number, default is 3.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Activate allowas-in property.
+
+
+ as_override + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Override matching AS-number while sending update.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Advertise capability to the peer.
+
+
+ additional_paths + +
+ dictionary +
+ 		+ +
Additional paths capability.
+
+
+ receive + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Receive capability.
+
+
+ send + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Send capability.
+
+
+ default_originate + +
+ dictionary +
+ 		+ +
Originate a default toward this peer.
+
+
+ route_map + +
+ string +
+ 		+ +
Route-map to specify criteria for originating default.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set default-originate attribute.
+
+
+ disable_peer_as_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable checking of peer AS-number while advertising.
+
+
+ filter_list + +
+ dictionary +
+ 		+ +
Name of filter-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a template.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence number.
+
+
+ template + +
+ string +
+ 		+ +
Template name.
+
+
+ maximum_prefix + +
+ dictionary +
+ 		+ +
Maximum number of prefixes from this neighbor.
+
+
+ generate_warning_threshold + +
+ integer +
+ 		+ +
Threshold percentage at which to generate a warning.
+
+
+ max_prefix_limit + +
+ integer +
+ 		+ +
Maximum prefix limit.
+
+
+ restart_interval + +
+ integer +
+ 		+ +
Restart bgp connection after limit is exceeded.
+
+
+ warning_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Only give a warning message when limit is exceeded.
+
+
+ next_hop_self + +
+ dictionary +
+ 		+ +
Set our address as nexthop (non-reflected).
+
+
+ all_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set our address as nexthop for all routes.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set next-hop-self attribute.
+
+
+ next_hop_third_party + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compute a third-party nexthop if possible.
+
+
+ prefix_list + +
+ dictionary +
+ 		+ +
Apply prefix-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ rewrite_evpn_rt_asn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Auto generate RTs for EBGP neighbor.
+
+
+ rewrite_rt_asn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Auto generate RTs for EBGP neighbor.
+
+
+ route_map + +
+ dictionary +
+ 		+ +
Apply route-map to neighbor.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ route_reflector_client + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure a neighbor as Route reflector client.
+
+
+ safi + +
+ string +
+ 		+
    Choices: +
  • unicast
    • +
  • multicast
    • +
  • mvpn
    • +
  • evpn
    • +
+ 		+
Sub Address Family indicator.
+
+
+ send_community + +
+ dictionary +
+ 		+ +
Send Community attribute to this neighbor.
+
+
+ both + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Standard and Extended Community attributes.
+
+
+ extended + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Extended Community attribute.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set send-community attribute.
+
+
+ standard + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Standard Community attribute.
+
+
+ soft_reconfiguration_inbound + +
+ dictionary +
+ 		+ +
Soft reconfiguration.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always perform inbound soft reconfiguration.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set soft-reconfiguration inbound attribute.
+
+
+ soo + +
+ string +
+ 		+ +
Specify Site-of-origin extcommunity.
+
+
+ suppress_inactive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise only active routes to peer.
+
+
+ unsuppress_map + +
+ string +
+ 		+ +
Route-map to selectively unsuppress suppressed routes.
+
+
+ weight + +
+ integer +
+ 		+ +
Set default weight for routes from this neighbor.
+
+
+ neighbor_address + +
+ string + / required +
+ 		+ +
IP/IPv6 address of the neighbor.
+
+
+ vrfs + +
+ list + / elements=dictionary +
+ 		+ +
Virtual Router Context.
+
+
+ neighbors + +
+ list + / elements=dictionary +
+ 		+ +
A list of BGP Neighbor AF configuration.
+
+
+ address_family + +
+ list + / elements=dictionary +
+ 		+ +
BGP Neighbor Address Family related configurations.
+
+
+ advertise_map + +
+ dictionary +
+ 		+ +
Specify route-map for conditional advertisement.
+
+
+ exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition exists.
+
+
+ non_exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition does not exist.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
Route-map name.
+
+
+ advertisement_interval + +
+ integer +
+ 		+ +
Minimum interval between sending BGP routing updates.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
  • link-state
    • +
  • vpnv4
    • +
  • vpnv6
    • +
  • l2vpn
    • +
+ 		+
Address Family indicator.
+
+
+ allowas_in + +
+ dictionary +
+ 		+ +
Accept as-path with my AS present in it.
+
+
+ max_occurences + +
+ integer +
+ 		+ +
Number of occurrences of AS number, default is 3.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Activate allowas-in property.
+
+
+ as_override + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Override matching AS-number while sending update.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Advertise capability to the peer.
+
+
+ additional_paths + +
+ dictionary +
+ 		+ +
Additional paths capability.
+
+
+ receive + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Receive capability.
+
+
+ send + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Send capability.
+
+
+ default_originate + +
+ dictionary +
+ 		+ +
Originate a default toward this peer.
+
+
+ route_map + +
+ string +
+ 		+ +
Route-map to specify criteria for originating default.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set default-originate attribute.
+
+
+ disable_peer_as_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable checking of peer AS-number while advertising.
+
+
+ filter_list + +
+ dictionary +
+ 		+ +
Name of filter-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a template.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence number.
+
+
+ template + +
+ string +
+ 		+ +
Template name.
+
+
+ maximum_prefix + +
+ dictionary +
+ 		+ +
Maximum number of prefixes from this neighbor.
+
+
+ generate_warning_threshold + +
+ integer +
+ 		+ +
Threshold percentage at which to generate a warning.
+
+
+ max_prefix_limit + +
+ integer +
+ 		+ +
Maximum prefix limit.
+
+
+ restart_interval + +
+ integer +
+ 		+ +
Restart bgp connection after limit is exceeded.
+
+
+ warning_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Only give a warning message when limit is exceeded.
+
+
+ next_hop_self + +
+ dictionary +
+ 		+ +
Set our address as nexthop (non-reflected).
+
+
+ all_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set our address as nexthop for all routes.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set next-hop-self attribute.
+
+
+ next_hop_third_party + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compute a third-party nexthop if possible.
+
+
+ prefix_list + +
+ dictionary +
+ 		+ +
Apply prefix-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ rewrite_evpn_rt_asn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Auto generate RTs for EBGP neighbor.
+
+
+ rewrite_rt_asn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Auto generate RTs for EBGP neighbor.
+
+
+ route_map + +
+ dictionary +
+ 		+ +
Apply route-map to neighbor.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ route_reflector_client + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure a neighbor as Route reflector client.
+
+
+ safi + +
+ string +
+ 		+
    Choices: +
  • unicast
    • +
  • multicast
    • +
  • mvpn
    • +
  • evpn
    • +
+ 		+
Sub Address Family indicator.
+
+
+ send_community + +
+ dictionary +
+ 		+ +
Send Community attribute to this neighbor.
+
+
+ both + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Standard and Extended Community attributes.
+
+
+ extended + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Extended Community attribute.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set send-community attribute.
+
+
+ standard + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Standard Community attribute.
+
+
+ soft_reconfiguration_inbound + +
+ dictionary +
+ 		+ +
Soft reconfiguration.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always perform inbound soft reconfiguration.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set soft-reconfiguration inbound attribute.
+
+
+ soo + +
+ string +
+ 		+ +
Specify Site-of-origin extcommunity.
+
+
+ suppress_inactive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise only active routes to peer.
+
+
+ unsuppress_map + +
+ string +
+ 		+ +
Route-map to selectively unsuppress suppressed routes.
+
+
+ weight + +
+ integer +
+ 		+ +
Set default weight for routes from this neighbor.
+
+
+ neighbor_address + +
+ string + / required +
+ 		+ +
IP/IPv6 address of the neighbor.
+
+
+ vrf + +
+ string +
+ 		+ +
VRF name.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^router bgp'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
State deleted only removes BGP attributes that this modules manages and does not negate the BGP process completely.
+
Refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - For managing BGP address family configurations please use the :ref:`cisco.nxos.nxos_bgp_address_family ` module. + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # Nexus9000v# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_bgp_neighbor_address_family: &id001 + config: + as_number: 65536 + neighbors: + - neighbor_address: 192.0.2.32 + address_family: + - afi: ipv4 + safi: unicast + maximum_prefix: + max_prefix_limit: 20 + generate_warning_threshold: 75 + weight: 100 + prefix_list: + inbound: rmap1 + outbound: rmap2 + - afi: ipv6 + safi: unicast + - neighbor_address: 192.0.2.33 + address_family: + - afi: ipv4 + safi: multicast + inherit: + template: BasePolicy + sequence: 200 + vrfs: + - vrf: site-1 + neighbors: + - neighbor_address: 203.0.113.1 + address_family: + - afi: ipv4 + safi: unicast + suppress_inactive: true + next_hop_self: + set: true + - neighbor_address: 203.0.113.2 + address_family: + - afi: ipv6 + safi: unicast + - afi: ipv4 + safi: multicast + send_community: + set: true + + # Task output: + # ------------ + # before: {} + # + # commands: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - address-family ipv4 unicast + # - maximum-prefix 20 75 + # - weight 100 + # - prefix-list rmap1 in + # - prefix-list rmap2 out + # - address-family ipv6 unicast + # - neighbor 192.0.2.33 + # - address-family ipv4 multicast + # - inherit peer-policy BasePolicy 200 + # - vrf site-1 + # - neighbor 203.0.113.1 + # - address-family ipv4 unicast + # - suppress-inactive + # - next-hop-self + # - neighbor 203.0.113.2 + # - address-family ipv6 unicast + # - address-family ipv4 multicast + # - send-community + # + # after: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + # Using replaced + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + - name: Replace specified neighbor AFs with given configuration + cisco.nxos.nxos_bgp_neighbor_address_family: &replaced + config: + as_number: 65536 + neighbors: + - neighbor_address: 192.0.2.32 + address_family: + - afi: ipv4 + safi: unicast + weight: 110 + - afi: ipv6 + safi: unicast + - neighbor_address: 192.0.2.33 + address_family: + - afi: ipv4 + safi: multicast + inherit: + template: BasePolicy + sequence: 200 + vrfs: + - vrf: site-1 + neighbors: + - neighbor_address: 203.0.113.1 + address_family: + - afi: ipv4 + safi: unicast + - neighbor_address: 203.0.113.2 + address_family: + - afi: ipv6 + safi: unicast + - afi: ipv4 + safi: multicast + send_community: + set: true + state: replaced + + # Task output: + # ------------ + # before: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + # + # commands: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - address-family ipv4 unicast + # - no maximum-prefix 20 75 + # - weight 110 + # - no prefix-list rmap1 in + # - no prefix-list rmap2 out + # - vrf site-1 + # - neighbor 203.0.113.1 + # - address-family ipv4 unicast + # - no suppress-inactive + # - no next-hop-self + # + # after: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # weight: 110 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # weight 110 + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + # Using overridden + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + - name: Override all BGP AF configuration with provided configuration + cisco.nxos.nxos_bgp_neighbor_address_family: + config: + as_number: 65536 + neighbors: + - neighbor_address: 192.0.2.32 + address_family: + - afi: ipv4 + safi: unicast + vrfs: + - vrf: site-1 + neighbors: + - neighbor_address: 203.0.113.1 + address_family: + - afi: ipv4 + safi: unicast + suppress_inactive: true + next_hop_self: + set: true + state: overridden + + # Task output: + # ------------ + # before: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + # + # commands: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - address-family ipv4 unicast + # - no maximum-prefix 20 75 + # - no weight 100 + # - no prefix-list rmap1 in + # - no prefix-list rmap2 out + # - no address-family ipv6 unicast + # - neighbor 192.0.2.33 + # - no address-family ipv4 multicast + # - vrf site-1 + # - neighbor 203.0.113.2 + # - no address-family ipv4 multicast + # - no address-family ipv6 unicast + # + # after: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + + # Using deleted to remove specified neighbor AFs + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + - name: Delete BGP configs handled by this module + cisco.nxos.nxos_bgp_neighbor_address_family: + config: + as_number: 65536 + neighbors: + - neighbor_address: 192.0.2.32 + address_family: + - afi: ipv4 + safi: unicast + vrfs: + - vrf: site-1 + neighbors: + - neighbor_address: 203.0.113.2 + address_family: + - afi: ipv6 + safi: unicast + state: deleted + + # Task output: + # ------------ + # before: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + # + # commands: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - no address-family ipv4 unicast + # - vrf site-1 + # - neighbor 203.0.113.2 + # - no address-family ipv6 unicast + # + # after: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # + + # Using deleted to remove all neighbor AFs + + # Before state: + # ------------- + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + # + + - name: Delete all BGP neighbor AF configs handled by this module + cisco.nxos.nxos_bgp_neighbor_address_family: + state: deleted + + # Task output: + # ------------ + # before: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + # + # commands: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - no address-family ipv4 unicast + # - no address-family ipv6 unicast + # - neighbor 192.0.2.33 + # - no address-family ipv4 multicast + # - vrf site-1 + # - neighbor 203.0.113.1 + # - no address-family ipv4 unicast + # - neighbor 203.0.113.2 + # - no address-family ipv6 unicast + # - no address-family ipv4 multicast + # + # after: + # as_number: "65536" + # + # After state: + # ------------ + # Nexus9000v# show running-config | section "^router bgp" + # router bgp 65536 + # neighbor 192.0.2.32 + # neighbor 192.0.2.33 + # vrf site-1 + # neighbor 203.0.113.1 + # neighbor 203.0.113.2 + # + + # Using rendered + + - name: Render platform specific configuration lines with state rendered (without connecting to the device) + cisco.nxos.nxos_bgp_neighbor_address_family: + config: + as_number: 65536 + neighbors: + - neighbor_address: 192.0.2.32 + address_family: + - afi: ipv4 + safi: unicast + maximum_prefix: + max_prefix_limit: 20 + generate_warning_threshold: 75 + weight: 100 + prefix_list: + inbound: rmap1 + outbound: rmap2 + - afi: ipv6 + safi: unicast + - neighbor_address: 192.0.2.33 + address_family: + - afi: ipv4 + safi: multicast + inherit: + template: BasePolicy + sequence: 200 + vrfs: + - vrf: site-1 + neighbors: + - neighbor_address: 203.0.113.1 + address_family: + - afi: ipv4 + safi: unicast + suppress_inactive: true + next_hop_self: + set: true + - neighbor_address: 203.0.113.2 + address_family: + - afi: ipv6 + safi: unicast + - afi: ipv4 + safi: multicast + send_community: + set: true + state: rendered + + # Task output: + # ------------ + # rendered: + # - router bgp 65536 + # - neighbor 192.0.2.32 + # - address-family ipv4 unicast + # - maximum-prefix 20 75 + # - weight 100 + # - prefix-list rmap1 in + # - prefix-list rmap2 out + # - address-family ipv6 unicast + # - neighbor 192.0.2.33 + # - address-family ipv4 multicast + # - inherit peer-policy BasePolicy 200 + # - vrf site-1 + # - neighbor 203.0.113.1 + # - address-family ipv4 unicast + # - suppress-inactive + # - next-hop-self + # - neighbor 203.0.113.2 + # - address-family ipv6 unicast + # - address-family ipv4 multicast + # - send-community + + # Using parsed + + # parsed.cfg + # ------------ + # router bgp 65536 + # neighbor 192.0.2.32 + # address-family ipv4 unicast + # maximum-prefix 20 75 + # weight 100 + # prefix-list rmap1 in + # prefix-list rmap2 out + # address-family ipv6 unicast + # neighbor 192.0.2.33 + # address-family ipv4 multicast + # inherit peer-policy BasePolicy 200 + # vrf site-1 + # neighbor 203.0.113.1 + # address-family ipv4 unicast + # suppress-inactive + # next-hop-self + # neighbor 203.0.113.2 + # address-family ipv4 multicast + # send-community + # address-family ipv6 unicast + + - name: Parse externally provided BGP neighbor AF config + register: result + cisco.nxos.nxos_bgp_neighbor_address_family: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output: + # ------------ + # parsed: + # as_number: "65536" + # neighbors: + # - neighbor_address: 192.0.2.32 + # address_family: + # - afi: ipv4 + # safi: unicast + # maximum_prefix: + # max_prefix_limit: 20 + # generate_warning_threshold: 75 + # weight: 100 + # prefix_list: + # inbound: rmap1 + # outbound: rmap2 + # - afi: ipv6 + # safi: unicast + # - neighbor_address: 192.0.2.33 + # address_family: + # - afi: ipv4 + # safi: multicast + # inherit: + # template: BasePolicy + # sequence: 200 + # vrfs: + # - vrf: site-1 + # neighbors: + # - neighbor_address: 203.0.113.1 + # address_family: + # - afi: ipv4 + # safi: unicast + # suppress_inactive: true + # next_hop_self: + # set: true + # - neighbor_address: 203.0.113.2 + # address_family: + # - afi: ipv4 + # safi: multicast + # send_community: + # set: true + # - afi: ipv6 + # safi: unicast + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['router bgp 65536', 'neighbor 192.0.2.32', 'address-family ipv4 unicast']
+
+
+ gathered + +
+ dictionary +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ dictionary +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['router bgp 65536', 'neighbor 192.0.2.32', 'address-family ipv4 unicast']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_bgp_templates_module.rst b/docs/cisco.nxos.nxos_bgp_templates_module.rst new file mode 100644 index 000000000..9287d7a60 --- /dev/null +++ b/docs/cisco.nxos.nxos_bgp_templates_module.rst @@ -0,0 +1,2841 @@ +.. _cisco.nxos.nxos_bgp_templates_module: + + +***************************** +cisco.nxos.nxos_bgp_templates +***************************** + +**BGP Templates resource module.** + + +Version added: 4.2.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages BGP templates on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A list of BGP templates.
+
+
+ as_number + +
+ string +
+ 		+ +
Autonomous System Number of the router.
+
+
+ neighbor + +
+ list + / elements=dictionary +
+ 		+ +
Configure BGP peer templates.
+
+
+ address_family + +
+ list + / elements=dictionary +
+ 		+ +
Configure an address-family for peer.
+
+
+ advertise_map + +
+ dictionary +
+ 		+ +
Specify route-map for conditional advertisement.
+
+
+ exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition exists.
+
+
+ non_exist_map + +
+ string +
+ 		+ +
Condition route-map to advertise only when prefix in condition does not exist.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
Route-map name.
+
+
+ advertisement_interval + +
+ integer +
+ 		+ +
Minimum interval between sending BGP routing updates.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
  • link-state
    • +
  • l2vpn
    • +
+ 		+
Address Family indicator.
+
+
+ allowas_in + +
+ dictionary +
+ 		+ +
Accept as-path with my AS present in it.
+
+
+ max_occurences + +
+ integer +
+ 		+ +
Number of occurrences of AS number, default is 3.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Activate allowas-in property.
+
+
+ as_override + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Override matching AS-number while sending update.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Advertise capability to the peer.
+
+
+ additional_paths + +
+ dictionary +
+ 		+ +
Additional paths capability.
+
+
+ receive + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Receive capability.
+
+
+ send + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Additional paths Send capability.
+
+
+ default_originate + +
+ dictionary +
+ 		+ +
Originate a default toward this peer.
+
+
+ route_map + +
+ string +
+ 		+ +
Route-map to specify criteria for originating default.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set default-originate attribute.
+
+
+ disable_peer_as_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable checking of peer AS-number while advertising.
+
+
+ filter_list + +
+ dictionary +
+ 		+ +
Name of filter-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a peer-policy template.
+
+
+ peer_policy + +
+ string +
+ 		+ +
Peer-policy template to inherit.
+
+
+ maximum_prefix + +
+ dictionary +
+ 		+ +
Maximum number of prefixes from this neighbor.
+
+
+ generate_warning_threshold + +
+ integer +
+ 		+ +
Threshold percentage at which to generate a warning.
+
+
+ max_prefix_limit + +
+ integer +
+ 		+ +
Maximum prefix limit.
+
+
+ restart_interval + +
+ integer +
+ 		+ +
Restart bgp connection after limit is exceeded.
+
+
+ warning_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Only give a warning message when limit is exceeded.
+
+
+ next_hop_self + +
+ dictionary +
+ 		+ +
Set our address as nexthop (non-reflected).
+
+
+ all_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set our address as nexthop for all routes.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set next-hop-self attribute.
+
+
+ next_hop_third_party + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compute a third-party nexthop if possible.
+
+
+ prefix_list + +
+ dictionary +
+ 		+ +
Apply prefix-list.
+
+
+ inbound + +
+ string +
+ 		+ +
Apply policy to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Apply policy to outgoing routes.
+
+
+ route_map + +
+ dictionary +
+ 		+ +
Apply route-map to neighbor.
+
+
+ inbound + +
+ string +
+ 		+ +
Name of policy to apply to incoming routes.
+
+
+ outbound + +
+ string +
+ 		+ +
Name of policy to apply to outgoing routes.
+
+
+ route_reflector_client + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure a neighbor as Route reflector client.
+
+
+ safi + +
+ string +
+ 		+
    Choices: +
  • unicast
    • +
  • multicast
    • +
  • mvpn
    • +
  • evpn
    • +
+ 		+
Sub Address Family indicator.
+
+
+ send_community + +
+ string +
+ 		+
    Choices: +
  • standard
    • +
  • extended
    • +
  • both
    • +
+ 		+
Send Community attribute to this neighbor.
+
+
+ soft_reconfiguration_inbound + +
+ dictionary +
+ 		+ +
Soft reconfiguration.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always perform inbound soft reconfiguration.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set soft-reconfiguration inbound attribute.
+
+
+ soo + +
+ string +
+ 		+ +
Specify Site-of-origin extcommunity.
+
+
+ suppress_inactive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise only active routes to peer.
+
+
+ unsuppress_map + +
+ string +
+ 		+ +
Route-map to selectively unsuppress suppressed routes.
+
+
+ weight + +
+ integer +
+ 		+ +
Set default weight for routes from this neighbor.
+
+
+ bfd + +
+ dictionary +
+ 		+ +
Bidirectional Fast Detection for the neighbor.
+
+
+ multihop + +
+ dictionary +
+ 		+ +
Multihop session.
+
+
+ interval + +
+ dictionary +
+ 		+ +
Configure BFD session interval parameters.
+
+
+ min_rx_interval + +
+ integer + / required +
+ 		+ +
Minimum RX interval.
+
+
+ multiplier + +
+ integer + / required +
+ 		+ +
Detect Multiplier.
+
+
+ tx_interval + +
+ integer + / required +
+ 		+ +
TX interval in milliseconds.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD multihop.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set BFD for this neighbor.
+
+
+ singlehop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Single-hop session.
+
+
+ bmp_activate_server + +
+ integer +
+ 		+ +
Specify server ID for activating BMP monitoring for the peer.
+
+
+ capability + +
+ dictionary +
+ 		+ +
Capability.
+
+
+ suppress_4_byte_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress 4-byte AS Capability.
+
+
+ description + +
+ string +
+ 		+ +
Neighbor specific descripion.
+
+
+ disable_connected_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable check for directly connected peer.
+
+
+ dont_capability_negotiate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Don't negotiate capability with this neighbor.
+
+
+ dscp + +
+ string +
+ 		+ +
Set dscp value for tcp transport.
+
+
+ dynamic_capability + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Dynamic Capability
+
+
+ ebgp_multihop + +
+ integer +
+ 		+ +
Specify multihop TTL for remote peer.
+
+
+ graceful_shutdown + +
+ dictionary +
+ 		+ +
Graceful-shutdown for this neighbor.
+
+
+ activate + +
+ dictionary +
+ 		+ +
Send graceful-shutdown community.
+
+
+ route_map + +
+ string +
+ 		+ +
Apply route-map to modify attributes for outbound.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set activate.
+
+
+ inherit + +
+ dictionary +
+ 		+ +
Inherit a template.
+
+
+ peer_session + +
+ string +
+ 		+ +
Peer-session template to inherit.
+
+
+ local_as + +
+ string +
+ 		+ +
Specify the local-as number for the eBGP neighbor.
+
+
+ log_neighbor_changes + +
+ dictionary +
+ 		+ +
Log message for neighbor up/down event.
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable logging of neighbor up/down event.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set log-neighbor-changes.
+
+
+ low_memory + +
+ dictionary +
+ 		+ +
Behaviour in low memory situations.
+
+
+ exempt + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not shutdown this peer when under memory pressure.
+
+
+ name + +
+ string +
+ 		+ +
Name of the BGP peer template.
+
+
+ password + +
+ dictionary +
+ 		+ +
Configure a password for neighbor.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 specifies an UNENCRYPTED neighbor password.
+
3 specifies an 3DES ENCRYPTED neighbor password will follow.
+
7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
+
+
+ key + +
+ string +
+ 		+ +
Authentication password.
+
+
+ path_attribute + +
+ list + / elements=dictionary +
+ 		+ +
BGP path attribute optional filtering.
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • discard
    • +
  • treat-as-withdraw
    • +
+ 		+
Action.
+
+
+ range + +
+ dictionary +
+ 		+ +
Path attribute range.
+
+
+ end + +
+ integer +
+ 		+ +
Path attribute range end value.
+
+
+ start + +
+ integer +
+ 		+ +
Path attribute range start value.
+
+
+ type + +
+ integer +
+ 		+ +
Path attribute type
+
+
+ remote_as + +
+ string +
+ 		+ +
Specify Autonomous System Number of the neighbor.
+
+
+ remove_private_as + +
+ dictionary +
+ 		+ +
Remove private AS number from outbound updates.
+
+
+ all + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
All.
+
+
+ replace_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Replace.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Remove private AS.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown this neighbor.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure keepalive and hold timers.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Holdtime (seconds).
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval (seconds).
+
+
+ transport + +
+ dictionary +
+ 		+ +
BGP transport connection.
+
+
+ connection_mode + +
+ dictionary +
+ 		+ +
Specify type of connection.
+
+
+ passive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Allow passive connection setup only.
+
+
+ ttl_security + +
+ dictionary +
+ 		+ +
Enable TTL Security Mechanism.
+
+
+ hops + +
+ integer +
+ 		+ +
Specify hop count for remote peer.
+
+
+ update_source + +
+ string +
+ 		+ +
Specify source of BGP session and updates.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config bgp | section 'template'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
Refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # -------------- + # + # nxos9k# show running-config | section "^router bgp" + # nxos9k# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_bgp_templates: + config: + as_number: 65536 + neighbor: + - name: neighbor_tmplt_1 + address_family: + - afi: ipv4 + safi: unicast + advertise_map: + route_map: rmap1 + non_exist_map: nemap1 + advertisement_interval: 60 + disable_peer_as_check: true + bmp_activate_server: 2 + capability: + suppress_4_byte_as: true + description: Test_BGP_PEER_TEMPLATE_1 + local_as: 65536 + remote_as: 65001 + + - name: neighbor_tmplt_2 + description: Test_BGP_PEER_TEMPLATE_2 + address_family: + - afi: ipv4 + safi: multicast + advertise_map: + route_map: rmap1 + exist_map: emap1 + as_override: true + filter_list: + inbound: flist1 + outbound: flist2 + inherit: + peer_session: psession1 + timers: + holdtime: 100 + keepalive: 45 + # Task Output: + # ------------ + # before: {} + # + # commands: + # - router bgp 65536 + # - template peer neighbor_tmplt_1 + # - bmp-activate-server 2 + # - capability suppress 4-byte-as + # - description Test_BGP_PEER_TEMPLATE_1 + # - local-as 65536 + # - remote-as 65001 + # - address-family ipv4 unicast + # - advertise-map rmap1 non-exist-map nemap1 + # - advertisement-interval 60 + # - disable-peer-as-check + # - template peer neighbor_tmplt_2 + # - description Test_BGP_PEER_TEMPLATE_2 + # - inherit peer-session psession1 + # - timers 45 100 + # - address-family ipv4 multicast + # - advertise-map rmap1 exist-map emap1 + # - as-override + # - filter-list flist1 in + # - filter-list flist2 out + # + # after: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # bmp_activate_server: 2 + # capability: + # suppress_4_byte_as: true + # description: Test_BGP_PEER_TEMPLATE_1 + # local_as: "65536" + # remote_as: "65001" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + + # After state: + # -------------- + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # capability suppress 4-byte-as + # bmp-activate-server 2 + # description Test_BGP_PEER_TEMPLATE_1 + # local-as 65536 + # remote-as 65001 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + # Using replaced + + # Before state: + # ------------- + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # capability suppress 4-byte-as + # description Test_BGP_PEER_TEMPLATE_1 + # bmp-activate-server 2 + # local-as 65536 + # remote-as 65001 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + - name: Replace BGP templates configuration with provided configuration + cisco.nxos.nxos_bgp_templates: + config: + as_number: 65536 + neighbor: + - name: neighbor_tmplt_1 + address_family: + - afi: ipv4 + safi: unicast + advertise_map: + route_map: rmap1 + non_exist_map: nemap1 + advertisement_interval: 60 + disable_peer_as_check: true + inherit: + peer_session: psession1 + description: Test_BGP_PEER_TEMPLATE_1 + local_as: 65537 + state: replaced + + # Task output: + # ------------ + # + # before: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # bmp_activate_server: 2 + # capability: + # suppress_4_byte_as: true + # description: Test_BGP_PEER_TEMPLATE_1 + # local_as: "65536" + # remote_as: "65001" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + # + # commands: + # - router bgp 65536 + # - template peer neighbor_tmplt_1 + # - no bmp-activate-server 2 + # - no capability suppress 4-byte-as + # - inherit peer-session psession1 + # - local-as 65537 + # - no remote-as 65001 + # + # after: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # description: Test_BGP_PEER_TEMPLATE_1 + # inherit: + # peer_session: psession1 + # local_as: "65537" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + + # After state: + # ------------ + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # inherit peer-session psession1 + # description Test_BGP_PEER_TEMPLATE_1 + # local-as 65537 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # bmp-activate-server 2 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + # Using overridden + # + # Before state: + # ------------- + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # capability suppress 4-byte-as + # description Test_BGP_PEER_TEMPLATE_1 + # bmp-activate-server 2 + # local-as 65536 + # remote-as 65001 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + - name: Override BGP templates configuration with provided configuration + cisco.nxos.nxos_bgp_templates: + config: + as_number: 65536 + neighbor: + - name: neighbor_tmplt_1 + address_family: + - afi: ipv4 + safi: unicast + advertise_map: + route_map: rmap1 + non_exist_map: nemap1 + advertisement_interval: 60 + disable_peer_as_check: true + inherit: + peer_session: psession1 + description: Test_BGP_PEER_TEMPLATE_1 + local_as: 65537 + state: overridden + + # Task output: + # ------------ + # + # before: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # bmp_activate_server: 2 + # capability: + # suppress_4_byte_as: true + # description: Test_BGP_PEER_TEMPLATE_1 + # local_as: "65536" + # remote_as: "65001" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + # + # commands: + # - router bgp 65536 + # - template peer neighbor_tmplt_1 + # - no bmp-activate-server 2 + # - no capability suppress 4-byte-as + # - inherit peer-session psession1 + # - local-as 65537 + # - no remote-as 65001 + # - no template peer neighbor_tmplt_2 + # + # after: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # description: Test_BGP_PEER_TEMPLATE_1 + # inherit: + # peer_session: psession1 + # local_as: "65537" + + # After state: + # ------------ + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # inherit peer-session psession1 + # description Test_BGP_PEER_TEMPLATE_1 + # local-as 65537 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + + # Using deleted + + # Before state: + # -------------- + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # capability suppress 4-byte-as + # description Test_BGP_PEER_TEMPLATE_1 + # bmp-activate-server 2 + # local-as 65536 + # remote-as 65001 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + - name: Delete BGP configs handled by this module + cisco.nxos.nxos_bgp_templates: + state: deleted + + # Task output: + # ------------ + # + # before: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # bmp_activate_server: 2 + # capability: + # suppress_4_byte_as: true + # description: Test_BGP_PEER_TEMPLATE_1 + # local_as: "65536" + # remote_as: "65001" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + # + # commands: + # - router bgp 65536 + # - no template peer neighbor_tmplt_1 + # - no template peer neighbor_tmplt_2 + # + # after: {} + + # After state: + # ------------- + # nxos9k# show running-config | section "^router bgp" + # nxos9k# + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['router bgp 65536', 'template peer neighbor_tmplt_1', 'no bmp-activate-server 2', 'no capability suppress 4-byte-as', 'inherit peer-session psession1', 'local-as 65537', 'no remote-as 65001', 'no template peer neighbor_tmplt_2']
+
+
+ gathered + +
+ dictionary +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ dictionary +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['router bgp 65536', 'template peer neighbor_tmplt_1', 'bmp-activate-server 2', 'no capability suppress 4-byte-as', 'no template peer neighbor_tmplt_2']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_command_module.rst b/docs/cisco.nxos.nxos_command_module.rst new file mode 100644 index 000000000..4308a6582 --- /dev/null +++ b/docs/cisco.nxos.nxos_command_module.rst @@ -0,0 +1,258 @@ +.. _cisco.nxos.nxos_command_module: + + +*********************** +cisco.nxos.nxos_command +*********************** + +**Run arbitrary command on Cisco NXOS devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Sends an arbitrary command to an NXOS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ commands + +
+ list + / elements=raw + / required +
+ 		+ +
The commands to send to the remote NXOS device. The resulting output from the command is returned. If the wait_for argument is provided, the module is not returned until the condition is satisfied or the number of retires as expired.
+
The commands argument also accepts an alternative form that allows for complex values that specify the command to run and the output format to return. This can be done on a command by command basis. The complex argument supports the keywords command and output where command is the command to run and output is one of 'text' or 'json'.
+
If a command sent to the device requires answering a prompt, it is possible to pass a dict containing command, answer and prompt. Common answers are 'y' or "\r" (carriage return, must be double quotes). See examples.
+
+
+ interval + +
+ integer +
+ 		+ Default:
1
+ 		+
Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditional, the interval indicates how to long to wait before trying the command again.
+
+
+ match + +
+ string +
+ 		+
    Choices: +
  • any
    • +
  • all ←
    • +
+ 		+
The match argument is used in conjunction with the wait_for argument to specify the match policy. Valid values are all or any. If the value is set to all then all conditionals in the wait_for must be satisfied. If the value is set to any then only one of the values must be satisfied.
+
+
+ retries + +
+ integer +
+ 		+ Default:
9
+ 		+
Specifies the number of retries a command should by tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait_for conditionals.
+
The commands are run once when retries is set to 0.
+
+
+ wait_for + +
+ list + / elements=string +
+ 		+ +
Specifies what to evaluate from the output of the command and what conditionals to apply. This argument will cause the task to wait for a particular conditional to be true before moving forward. If the conditional is not true by the configured retries, the task fails. See examples.
+

aliases: waitfor
+
+
+ + +Notes +----- + +.. note:: + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: run show version on remote devices + cisco.nxos.nxos_command: + commands: show version + + - name: run show version and check to see if output contains Cisco + cisco.nxos.nxos_command: + commands: show version + wait_for: result[0] contains Cisco + + - name: run multiple commands on remote nodes + cisco.nxos.nxos_command: + commands: + - show version + - show interfaces + + - name: run multiple commands and evaluate the output + cisco.nxos.nxos_command: + commands: + - show version + - show interfaces + wait_for: + - result[0] contains Cisco + - result[1] contains loopback0 + + - name: run commands and specify the output format + cisco.nxos.nxos_command: + commands: + - command: show version + output: json + + - name: run commands that require answering a prompt + cisco.nxos.nxos_command: + commands: + - configure terminal + - command: no feature npv + prompt: Do you want to continue + answer: y + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ failed_conditions + +
+ list +
+ 		failed +
The list of conditionals that have failed
+
+
Sample:
+
['...', '...']
+
+
+ stdout + +
+ list +
+ 		always apart from low level errors (such as action plugin) +
The set of responses from the commands
+
+
Sample:
+
['...', '...']
+
+
+ stdout_lines + +
+ list +
+ 		always apart from low level errors (such as action plugin) +
The value of stdout split into a list
+
+
Sample:
+
[['...', '...'], ['...'], ['...']]
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_config_module.rst b/docs/cisco.nxos.nxos_config_module.rst new file mode 100644 index 000000000..3ead5ab50 --- /dev/null +++ b/docs/cisco.nxos.nxos_config_module.rst @@ -0,0 +1,566 @@ +.. _cisco.nxos.nxos_config_module: + + +********************** +cisco.nxos.nxos_config +********************** + +**Manage Cisco NXOS configuration sections** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- 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. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ after + +
+ list + / elements=string +
+ 		+ +
The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with before this allows the playbook designer to append a set of commands to be executed after the command set.
+
+
+ backup + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
This argument will cause the module to create a full backup of the current running-config from the remote device before any changes are made. If the backup_options value is not given, the backup file is written to the backup folder in the playbook root directory or role root directory, if playbook is part of an ansible role. If the directory does not exist, it is created.
+
+
+ backup_options + +
+ dictionary +
+ 		+ +
This is a dict object containing configurable options related to backup file path. The value of this option is read only when backup is set to True, if backup is set to false this option will be silently ignored.
+
+
+ dir_path + +
+ path +
+ 		+ +
This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be created and the filename is either the value of filename or default filename as described in filename options description. If the path value is not given in that case a backup directory will be created in the current working directory and backup configuration will be copied in filename within backup directory.
+
+
+ filename + +
+ string +
+ 		+ +
The filename to be used to store the backup configuration. If the filename is not given it will be generated based on the hostname, current time and date in format defined by <hostname>_config.<current-date>@<current-time>
+
+
+ before + +
+ list + / elements=string +
+ 		+ +
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.
+
+
+ defaults + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
The 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
+
+
+ diff_against + +
+ string +
+ 		+
    Choices: +
  • startup
    • +
  • intended
    • +
  • running
    • +
+ 		+
When using the ansible-playbook --diff command line argument the module can generate diffs against different sources.
+
When this option is configure as startup, the module will return the diff of the running-config against the startup-config.
+
When this option is configured as intended, the module will return the diff of the running-config against the configuration provided in the intended_config argument.
+
When this option is configured as running, the module will return the before and after diff of the running-config with respect to any changes made to the device configuration.
+
+
+ diff_ignore_lines + +
+ list + / elements=string +
+ 		+ +
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.
+
+
+ intended_config + +
+ string +
+ 		+ +
The 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 diff_against value and set it to intended. The configuration lines for this value should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure correct diff.
+
+
+ lines + +
+ list + / elements=string +
+ 		+ +
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 to ensure idempotency and correct diff. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser.
+

aliases: commands
+
+
+ match + +
+ string +
+ 		+
    Choices: +
  • line ←
    • +
  • strict
    • +
  • exact
    • +
  • none
    • +
+ 		+
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 line, commands are matched line by line. If match is set to strict, command lines are matched with respect to position. If match is set to exact, command lines must be an equal match. Finally, if match is set to none, the module will not attempt to compare the source configuration with the running configuration on the remote device.
+
+
+ parents + +
+ list + / elements=string +
+ 		+ +
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.
+
+
+ replace + +
+ string +
+ 		+
    Choices: +
  • line ←
    • +
  • block
    • +
  • config
    • +
+ 		+
Instructs the module on the way to perform the configuration on the device. If the replace argument is set to line then the modified lines are pushed to the device in configuration mode. If the replace argument is set to block then the entire command block is pushed to the device in configuration mode if any line is not correct. replace config will only work for NX-OS versions that support `config replace`.
+
+
+ replace_src + +
+ string +
+ 		+ +
The 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 replace with value config. This is mutually exclusive with the lines and src arguments. This argument will only work for NX-OS versions that support `config replace`. Use nxos_file_copy module to copy the flat file to remote device and then use the path with this argument. The configuration lines in the file should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure idempotency and correct diff.
+
+
+ running_config + +
+ string +
+ 		+ +
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 running_config argument allows the implementer to pass in the configuration to use as the base config for comparison. The configuration lines for this option should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure idempotency and correct diff.
+

aliases: config
+
+
+ save_when + +
+ string +
+ 		+
    Choices: +
  • always
    • +
  • never ←
    • +
  • modified
    • +
  • changed
    • +
+ 		+
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 always, then the running-config will always be copied to the startup-config and the modified flag will always be set to True. If the argument is set to 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 never, the running-config will never be copied to the startup-config. If the argument is set to changed, then the running-config will only be copied to the startup-config if the task has made a change. changed was added in Ansible 2.6.
+
+
+ src + +
+ path +
+ 		+ +
The 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 lines and parents arguments. The configuration lines in the source file should be similar to how it will appear if present in the running-configuration of the device including indentation to ensure idempotency and correct diff.
+
+
+ + +Notes +----- + +.. note:: + - Unsupported for Cisco MDS + - Abbreviated commands are NOT idempotent, see https://docs.ansible.com/ansible/latest/network/user_guide/faq.html#why-do-the-config-modules-always-return-changed-true-with-abbreviated-commands. + - To ensure idempotency and correct diff the configuration lines in the relevant module options should be similar to how they appear if present in the running configuration on device including the indentation. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: configure top level configuration and save it + cisco.nxos.nxos_config: + lines: hostname {{ inventory_hostname }} + save_when: modified + + - name: diff the running-config against a provided config + cisco.nxos.nxos_config: + diff_against: intended + intended_config: "{{ lookup('file', 'master.cfg') }}" + + - cisco.nxos.nxos_config: + lines: + - 10 permit ip 192.0.2.1/32 any log + - 20 permit ip 192.0.2.2/32 any log + - 30 permit ip 192.0.2.3/32 any log + - 40 permit ip 192.0.2.4/32 any log + - 50 permit ip 192.0.2.5/32 any log + parents: ip access-list test + before: no ip access-list test + match: exact + + - cisco.nxos.nxos_config: + lines: + - 10 permit ip 192.0.2.1/32 any log + - 20 permit ip 192.0.2.2/32 any log + - 30 permit ip 192.0.2.3/32 any log + - 40 permit ip 192.0.2.4/32 any log + parents: ip access-list test + before: no ip access-list test + replace: block + + - name: replace config with flat file + cisco.nxos.nxos_config: + replace_src: config.txt + replace: config + + - name: for idempotency, use full-form commands + cisco.nxos.nxos_config: + lines: + # - shut + - shutdown + # parents: int eth1/1 + parents: interface Ethernet1/1 + + - name: configurable backup path + cisco.nxos.nxos_config: + backup: true + backup_options: + filename: backup.cfg + dir_path: /home/user + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ backup_path + +
+ string +
+ 		when backup is yes +
The full path to the backup file
+
+
Sample:
+
/playbooks/ansible/backup/nxos_config.2016-07-16@22:28:34
+
+
+ commands + +
+ list +
+ 		always +
The set of commands that will be pushed to the remote device
+
+
Sample:
+
['hostname foo', 'vlan 1', 'name default']
+
+
+ date + +
+ string +
+ 		when backup is yes +
The date extracted from the backup file name
+
+
Sample:
+
2016-07-16
+
+
+ filename + +
+ string +
+ 		when backup is yes and filename is not specified in backup options +
The name of the backup file
+
+
Sample:
+
nxos_config.2016-07-16@22:28:34
+
+
+ shortname + +
+ string +
+ 		when backup is yes and filename is not specified in backup options +
The full path to the backup file excluding the timestamp
+
+
Sample:
+
/playbooks/ansible/backup/nxos_config
+
+
+ time + +
+ string +
+ 		when backup is yes +
The time extracted from the backup file name
+
+
Sample:
+
22:28:34
+
+
+ updates + +
+ list +
+ 		always +
The set of commands that will be pushed to the remote device
+
+
Sample:
+
['hostname foo', 'vlan 1', 'name default']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_devicealias_module.rst b/docs/cisco.nxos.nxos_devicealias_module.rst new file mode 100644 index 000000000..081c8759f --- /dev/null +++ b/docs/cisco.nxos.nxos_devicealias_module.rst @@ -0,0 +1,273 @@ +.. _cisco.nxos.nxos_devicealias_module: + + +*************************** +cisco.nxos.nxos_devicealias +*************************** + +**Configuration of device alias for Cisco NXOS MDS Switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Configuration of device alias for Cisco MDS NXOS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ da + +
+ list + / elements=dictionary +
+ 		+ +
List of device-alias to be added or removed
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the device-alias to be added or removed
+
+
+ pwwn + +
+ string +
+ 		+ +
pwwn to which the name needs to be associated with
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Removes the device-alias if set to True
+
+
+ distribute + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable device-alias distribution
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • basic
    • +
  • enhanced
    • +
+ 		+
Mode of devices-alias, basic or enhanced
+
+
+ rename + +
+ list + / elements=dictionary +
+ 		+ +
List of device-alias to be renamed
+
+
+ new_name + +
+ string + / required +
+ 		+ +
New name of the device-alias
+
+
+ old_name + +
+ string + / required +
+ 		+ +
Old name of the device-alias that needs to be renamed
+
+
+ + +Notes +----- + +.. note:: + - Tested against Cisco MDS NX-OS 8.4(1) + + + +Examples +-------- + +.. code-block:: yaml + + - name: Test that device alias module works + cisco.nxos.nxos_devicealias: + da: + - name: test1_add + pwwn: 56:2:22:11:22:88:11:67 + - name: test2_add + pwwn: 65:22:22:11:22:22:11:d + - name: dev1 + remove: true + - name: dev2 + remove: true + distribute: true + mode: enhanced + rename: + - new_name: bcd + old_name: abc + - new_name: bcd1 + old_name: abc1 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['terminal dont-ask', 'device-alias database', 'device-alias name somename pwwn 10:00:00:00:89:a1:01:03', 'device-alias name somename1 pwwn 10:00:00:00:89:a1:02:03', 'device-alias commit', 'no terminal dont-ask']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) diff --git a/docs/cisco.nxos.nxos_evpn_global_module.rst b/docs/cisco.nxos.nxos_evpn_global_module.rst new file mode 100644 index 000000000..d1b2a8241 --- /dev/null +++ b/docs/cisco.nxos.nxos_evpn_global_module.rst @@ -0,0 +1,122 @@ +.. _cisco.nxos.nxos_evpn_global_module: + + +*************************** +cisco.nxos.nxos_evpn_global +*************************** + +**Handles the EVPN control plane for VXLAN.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Handles the EVPN control plane for VXLAN. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ nv_overlay_evpn + +
+ boolean + / required +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
EVPN control plane.
+
+
+ + +Notes +----- + +.. note:: + - This module is not supported on Nexus 3000 series of switches. + - Unsupported for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_evpn_global: + nv_overlay_evpn: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The set of commands to be sent to the remote device
+
+
Sample:
+
['nv overlay evpn']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_evpn_vni_module.rst b/docs/cisco.nxos.nxos_evpn_vni_module.rst new file mode 100644 index 000000000..530a9ff18 --- /dev/null +++ b/docs/cisco.nxos.nxos_evpn_vni_module.rst @@ -0,0 +1,212 @@ +.. _cisco.nxos.nxos_evpn_vni_module: + + +************************ +cisco.nxos.nxos_evpn_vni +************************ + +**Manages Cisco EVPN VXLAN Network Identifier (VNI).** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages Cisco Ethernet Virtual Private Network (EVPN) VXLAN Network Identifier (VNI) configurations of a Nexus device. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ route_distinguisher + +
+ string +
+ 		+ +
The VPN Route Distinguisher (RD). The RD is combined with the IPv4 or IPv6 prefix learned by the PE router to create a globally unique address.
+
+
+ route_target_both + +
+ list + / elements=string +
+ 		+ +
Enables/Disables route-target settings for both import and export target communities using a single property.
+
+
+ route_target_export + +
+ list + / elements=string +
+ 		+ +
Sets the route-target 'export' extended communities.
+
+
+ route_target_import + +
+ list + / elements=string +
+ 		+ +
Sets the route-target 'import' extended communities.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Determines whether the config should be present or not on the device.
+
+
+ vni + +
+ string + / required +
+ 		+ +
The EVPN VXLAN Network Identifier.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - default, where supported, restores params default value. + - RD override is not permitted. You should set it to the default values first and then reconfigure it. + - ``route_target_both``, ``route_target_import`` and ``route_target_export valid`` values are a list of extended communities, (i.e. ['1.2.3.4:5', '33:55']) or the keywords 'auto' or 'default'. + - The ``route_target_both`` property is discouraged due to the inconsistent behavior of the property across Nexus platforms and image versions. For this reason it is recommended to use explicit ``route_target_export`` and ``route_target_import`` properties instead of ``route_target_both``. + - RD valid values are a string in one of the route-distinguisher formats, the keyword 'auto', or the keyword 'default'. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: vni configuration + cisco.nxos.nxos_evpn_vni: + vni: 6000 + route_distinguisher: 60:10 + route_target_import: + - "5000:10" + - "4100:100" + route_target_export: auto + route_target_both: default + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['evpn', 'vni 6000 l2', 'route-target import 5001:10']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_facts_module.rst b/docs/cisco.nxos.nxos_facts_module.rst new file mode 100644 index 000000000..3ce96abea --- /dev/null +++ b/docs/cisco.nxos.nxos_facts_module.rst @@ -0,0 +1,553 @@ +.. _cisco.nxos.nxos_facts_module: + + +********************* +cisco.nxos.nxos_facts +********************* + +**Gets facts about NX-OS switches** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Collects facts from Cisco Nexus devices running the NX-OS operating system. Fact collection is supported over both ``network_cli`` and ``httpapi``. This module prepends all of the base network fact keys with ``ansible_net_``. The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ available_network_resources + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
When set to true a list of network resources for which resource modules are available will be provided.
+
+
+ gather_network_resources + +
+ list + / elements=string +
+ 		+ +
When supplied, this argument will gather configuration facts only for the given subset. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
+
Valid subsets are all, bfd_interfaces, lag_interfaces, telemetry, vlans, lacp, lacp_interfaces, interfaces, l3_interfaces, l2_interfaces, lldp_global, acls, acl_interfaces, ospfv2, ospfv3, ospf_interfaces, bgp_global, bgp_address_family, route_maps, prefix_lists, logging_global, ntp_global, snmp_server, hostname.
+
+
+ gather_subset + +
+ list + / elements=string +
+ 		+ Default:
"min"
+ 		+
When supplied, this argument will gather operational facts only for the given subset. Possible values for this argument include all, hardware, config, legacy, interfaces, and min. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Gather all legacy facts + cisco.nxos.nxos_facts: + gather_subset: all + - name: Gather only the config and default facts + cisco.nxos.nxos_facts: + gather_subset: + - config + - name: Do not gather hardware facts + cisco.nxos.nxos_facts: + gather_subset: + - '!hardware' + - name: Gather legacy and resource facts + cisco.nxos.nxos_facts: + gather_subset: all + gather_network_resources: all + - name: Gather only the interfaces resource facts and no legacy facts + cisco.nxos.nxos_facts: + gather_subset: + - '!all' + - '!min' + gather_network_resources: + - interfaces + - name: Gather interfaces resource and minimal legacy facts + cisco.nxos.nxos_facts: + gather_subset: min + gather_network_resources: interfaces + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ ansible_net_all_ipv4_addresses + +
+ list +
+ 		when interfaces is configured +
All IPv4 addresses configured on the device
+
+
+
+ ansible_net_all_ipv6_addresses + +
+ list +
+ 		when interfaces is configured +
All IPv6 addresses configured on the device
+
+
+
+ ansible_net_api + +
+ string +
+ 		always +
The name of the transport
+
+
+
+ ansible_net_config + +
+ string +
+ 		when config is configured +
The current active config from the device
+
+
+
+ ansible_net_filesystems + +
+ list +
+ 		when hardware is configured +
All file system names available on the device
+
+
+
+ ansible_net_gather_network_resources + +
+ list +
+ 		when the resource is configured +
The list of fact for network resource subsets collected from the device
+
+
+
+ ansible_net_gather_subset + +
+ list +
+ 		always +
The list of fact subsets collected from the device
+
+
+
+ ansible_net_hostname + +
+ string +
+ 		always +
The configured hostname of the device
+
+
+
+ ansible_net_image + +
+ string +
+ 		always +
The image file the device is running
+
+
+
+ ansible_net_interfaces + +
+ dictionary +
+ 		when interfaces is configured +
A hash of all interfaces running on the system
+
+
+
+ ansible_net_license_hostid + +
+ string +
+ 		always +
The License host id of the device
+
+
+
+ ansible_net_memfree_mb + +
+ integer +
+ 		when hardware is configured +
The available free memory on the remote device in Mb
+
+
+
+ ansible_net_memtotal_mb + +
+ integer +
+ 		when hardware is configured +
The total memory on the remote device in Mb
+
+
+
+ ansible_net_model + +
+ string +
+ 		always +
The model name returned from the device
+
+
+
+ ansible_net_neighbors + +
+ dictionary +
+ 		when interfaces is configured +
The list of LLDP and CDP neighbors from the device. If both, CDP and LLDP neighbor data is present on one port, CDP is preferred.
+
+
+
+ ansible_net_python_version + +
+ string +
+ 		always +
The Python version Ansible controller is using
+
+
+
+ ansible_net_serialnum + +
+ string +
+ 		always +
The serial number of the remote device
+
+
+
+ ansible_net_version + +
+ string +
+ 		always +
The operating system version running on the remote device
+
+
+
+ fan_info + +
+ dictionary +
+ 		when legacy is configured +
A hash of facts about fans in the remote device
+
+
+
+ hostname + +
+ dictionary +
+ 		when legacy is configured +
The configured hostname of the remote device
+
+
+
+ interfaces_list + +
+ dictionary +
+ 		when legacy is configured +
The list of interface names on the remote device
+
+
+
+ kickstart + +
+ string +
+ 		when legacy is configured +
The software version used to boot the system
+
+
+
+ module + +
+ dictionary +
+ 		when legacy is configured +
A hash of facts about the modules in a remote device
+
+
+
+ platform + +
+ string +
+ 		when legacy is configured +
The hardware platform reported by the remote device
+
+
+
+ power_supply_info + +
+ string +
+ 		when legacy is configured +
A hash of facts about the power supplies in the remote device
+
+
+
+ vlan_list + +
+ list +
+ 		when legacy is configured +
The list of VLAN IDs configured on the remote device
+
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_feature_module.rst b/docs/cisco.nxos.nxos_feature_module.rst new file mode 100644 index 000000000..ee2539180 --- /dev/null +++ b/docs/cisco.nxos.nxos_feature_module.rst @@ -0,0 +1,150 @@ +.. _cisco.nxos.nxos_feature_module: + + +*********************** +cisco.nxos.nxos_feature +*********************** + +**Manage features in NX-OS switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Offers ability to enable and disable features in NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ feature + +
+ string + / required +
+ 		+ +
Name of feature.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • enabled ←
    • +
  • disabled
    • +
+ 		+
Desired state of the feature.
+
+
+ + +Notes +----- + +.. note:: + - Tested against Cisco MDS NX-OS 9.2(2) + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - 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 Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The set of commands to be sent to the remote device
+
+
Sample:
+
['nv overlay evpn']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) +- Suhas Bharadwaj (@srbharadwaj) diff --git a/docs/cisco.nxos.nxos_gir_module.rst b/docs/cisco.nxos.nxos_gir_module.rst new file mode 100644 index 000000000..61c809ea0 --- /dev/null +++ b/docs/cisco.nxos.nxos_gir_module.rst @@ -0,0 +1,302 @@ +.. _cisco.nxos.nxos_gir_module: + + +******************* +cisco.nxos.nxos_gir +******************* + +**Trigger a graceful removal or insertion (GIR) of the switch.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Trigger a graceful removal or insertion (GIR) of the switch. +- GIR processing may take more than 2 minutes. Timeout settings are automatically extended to 200s when user timeout settings are insufficient. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specify desired state of the resource.
+
+
+ system_mode_maintenance + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
When system_mode_maintenance=true it puts all enabled protocols in maintenance mode (using the isolate command). When system_mode_maintenance=false it puts all enabled protocols in normal mode (using the no isolate command).
+
+
+ system_mode_maintenance_dont_generate_profile + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
When system_mode_maintenance_dont_generate_profile=true it prevents the dynamic searching of enabled protocols and executes commands configured in a maintenance-mode profile. Use this option if you want the system to use a maintenance-mode profile that you have created. When system_mode_maintenance_dont_generate_profile=false it prevents the dynamic searching of enabled protocols and executes commands configured in a normal-mode profile. Use this option if you want the system to use a normal-mode profile that you have created.
+
+
+ system_mode_maintenance_on_reload_reset_reason + +
+ string +
+ 		+
    Choices: +
  • hw_error
    • +
  • svc_failure
    • +
  • kern_failure
    • +
  • wdog_timeout
    • +
  • fatal_error
    • +
  • lc_failure
    • +
  • match_any
    • +
  • manual_reload
    • +
  • any_other
    • +
  • maintenance
    • +
+ 		+
Boots the switch into maintenance mode automatically in the event of a specified system crash. Note that not all reset reasons are applicable for all platforms. Also if reset reason is set to match_any, it is not idempotent as it turns on all reset reasons. If reset reason is match_any and state is absent, it turns off all the reset reasons.
+
+
+ system_mode_maintenance_shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Shuts down all protocols, vPC domains, and interfaces except the management interface (using the shutdown command). This option is disruptive while system_mode_maintenance (which uses the isolate command) is not.
+
+
+ system_mode_maintenance_timeout + +
+ string +
+ 		+ +
Keeps the switch in maintenance mode for a specified number of minutes. Range is 5-65535.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - ``state`` has effect only in combination with ``system_mode_maintenance_timeout`` or ``system_mode_maintenance_on_reload_reset_reason``. + - Using ``system_mode_maintenance`` and ``system_mode_maintenance_dont_generate_profile`` would make the module fail, but the system mode will be triggered anyway. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Trigger system maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance: true + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Trigger system normal mode + - cisco.nxos.nxos_gir: + system_mode_maintenance: false + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Configure on-reload reset-reason for maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance_on_reload_reset_reason: manual_reload + state: present + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Add on-reload reset-reason for maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance_on_reload_reset_reason: hw_error + state: present + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Remove on-reload reset-reason for maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance_on_reload_reset_reason: manual_reload + state: absent + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Set timeout for maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance_timeout: 30 + state: present + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + # Remove timeout for maintenance mode + - cisco.nxos.nxos_gir: + system_mode_maintenance_timeout: 30 + state: absent + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ final_system_mode + +
+ string +
+ 		verbose mode +
describe the last system mode
+
+
Sample:
+
normal
+
+
+ updates + +
+ list +
+ 		verbose mode +
commands sent to the device
+
+
Sample:
+
['terminal dont-ask', 'system mode maintenance timeout 10']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_gir_profile_management_module.rst b/docs/cisco.nxos.nxos_gir_profile_management_module.rst new file mode 100644 index 000000000..95d85ae9b --- /dev/null +++ b/docs/cisco.nxos.nxos_gir_profile_management_module.rst @@ -0,0 +1,235 @@ +.. _cisco.nxos.nxos_gir_profile_management_module: + + +************************************** +cisco.nxos.nxos_gir_profile_management +************************************** + +**Create a maintenance-mode or normal-mode profile for GIR.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manage a maintenance-mode or normal-mode profile with configuration commands that can be applied during graceful removal or graceful insertion. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ commands + +
+ list + / elements=string +
+ 		+ +
List of commands to be included into the profile.
+
+
+ mode + +
+ string + / required +
+ 		+
    Choices: +
  • maintenance
    • +
  • normal
    • +
+ 		+
Configure the profile as Maintenance or Normal mode.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specify desired state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - ``state=absent`` removes the whole profile. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Create a maintenance-mode profile + - cisco.nxos.nxos_gir_profile_management: + mode: maintenance + commands: + - router eigrp 11 + - isolate + + # Remove the maintenance-mode profile + - cisco.nxos.nxos_gir_profile_management: + mode: maintenance + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ end_state + +
+ list +
+ 		verbose mode +
list of profile entries after module execution.
+
+
Sample:
+
['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete', 'router eigrp 11', 'isolate']
+
+
+ existing + +
+ list +
+ 		verbose mode +
list of existing profile commands.
+
+
Sample:
+
['router bgp 65535', 'isolate', 'router eigrp 10', 'isolate', 'diagnostic bootup level complete']
+
+
+ proposed + +
+ list +
+ 		verbose mode +
list of commands passed into module.
+
+
Sample:
+
['router eigrp 11', 'isolate']
+
+
+ updates + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['configure maintenance profile maintenance-mode', 'router eigrp 11', 'isolate']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_hostname_module.rst b/docs/cisco.nxos.nxos_hostname_module.rst new file mode 100644 index 000000000..c8a9ee45d --- /dev/null +++ b/docs/cisco.nxos.nxos_hostname_module.rst @@ -0,0 +1,344 @@ +.. _cisco.nxos.nxos_hostname_module: + + +************************ +cisco.nxos.nxos_hostname +************************ + +**Hostname resource module.** + + +Version added: 2.9.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages hostname configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A dictionary of hostname configuration.
+
+
+ hostname + +
+ string +
+ 		+ +
Hostname of the device.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section hostname.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
The states merged, replaced and overridden have identical behaviour for this module.
+
Refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged (replaced, overridden has the same behaviour) + + # Before state: + # ------------- + # nxos-9k-rdo# show running-config | section ^hostname + # nxos-9k-rdo# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_hostname: + config: + hostname: NXOSv-9k + + # Task output + # ------------- + # before: {} + # + # commands: + # - hostname NXOSv-9k + # + # after: + # hostname: NXOSv-9k + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section ^hostname + # hostname NXOSv-9k + # + + # Using deleted + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section ^hostname + # hostname NXOSv-9k + + - name: Delete hostname from running-config + cisco.nxos.nxos_hostname: + state: deleted + + # Task output + # ------------- + # before: + # hostname: NXOSv-9k + # + # commands: + # - no hostname NXOSv-9k + # + # after: {} + + # Using gathered + + - name: Gather hostname facts using gathered + cisco.nxos.nxos_hostname: + state: gathered + + # Task output (redacted) + # ----------------------- + # gathered: + # hostname: NXOSv-9k + + # Using rendered + + - name: Render platform specific configuration lines (without connecting to the device) + cisco.nxos.nxos_hostname: + config: + hostname: NXOSv-9k + + # Task Output (redacted) + # ----------------------- + # rendered: + # - hostname NXOSv-9k + + # Using parsed + + # parsed.cfg + # ------------ + # hostname NXOSv-9k + + - name: Parse externally provided hostname config + cisco.nxos.nxos_hostname: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # hostname: NXOSv-9k + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['hostname switch01']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['hostname switch01']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst b/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst new file mode 100644 index 000000000..163612413 --- /dev/null +++ b/docs/cisco.nxos.nxos_hsrp_interfaces_module.rst @@ -0,0 +1,344 @@ +.. _cisco.nxos.nxos_hsrp_interfaces_module: + + +******************************* +cisco.nxos.nxos_hsrp_interfaces +******************************* + +**HSRP interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages Hot Standby Router Protocol (HSRP) interface attributes. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
The provided configuration
+
+
+ bfd + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/Disable HSRP Bidirectional Forwarding Detection (BFD) on the interface.
+
+
+ name + +
+ string +
+ 		+ +
The name of the interface.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state the configuration should be left in
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 7.0(3)I5(1). + - Feature bfd should be enabled for this module. + - Unsupported for Cisco MDS + + + +Examples +-------- + +.. code-block:: yaml + + # Using deleted + + - name: Configure hsrp attributes on interfaces + cisco.nxos.nxos_hsrp_interfaces: + config: + - name: Ethernet1/1 + - name: Ethernet1/2 + operation: deleted + + + # Using merged + + - name: Configure hsrp attributes on interfaces + cisco.nxos.nxos_hsrp_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + - name: Ethernet1/2 + bfd: disable + operation: merged + + + # Using overridden + + - name: Configure hsrp attributes on interfaces + cisco.nxos.nxos_hsrp_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + - name: Ethernet1/2 + bfd: disable + operation: overridden + + + # Using replaced + + - name: Configure hsrp attributes on interfaces + cisco.nxos.nxos_hsrp_interfaces: + config: + - name: Ethernet1/1 + bfd: enable + - name: Ethernet1/2 + bfd: disable + operation: replaced + + # Using rendered + + - name: Use rendered state to convert task input to device specific commands + cisco.nxos.nxos_hsrp_interfaces: + config: + - name: Ethernet1/800 + bfd: enable + - name: Ethernet1/801 + bfd: enable + state: rendered + + # Task Output (redacted) + # ----------------------- + + # rendered: + # - "interface Ethernet1/800" + # - "hsrp bfd" + # - "interface Ethernet1/801" + # - "hsrp bfd" + + # Using parsed + + # parsed.cfg + # ------------ + # interface Ethernet1/800 + # no switchport + # hsrp bfd + # interface Ethernet1/801 + # no switchport + # hsrp bfd + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_hsrp_interfaces: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + + # parsed: + # - name: Ethernet1/800 + # bfd: enable + # - name: Ethernet1/801 + # bfd: enable + + # Using gathered + + # Existing device config state + # ------------------------------- + + # interface Ethernet1/1 + # no switchport + # hsrp bfd + # interface Ethernet1/2 + # no switchport + # hsrp bfd + # interface Ethernet1/3 + # no switchport + + - name: Gather hsrp_interfaces facts from the device using nxos_hsrp_interfaces + cisco.nxos.nxos_hsrp_interfaces: + state: gathered + + # Task output (redacted) + # ----------------------- + + # gathered: + # - name: Ethernet1/1 + # bfd: enable + # - name: Ethernet1/2 + # bfd: enable + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/1', 'hsrp bfd']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Chris Van Heuveln (@chrisvanheuveln) diff --git a/docs/cisco.nxos.nxos_hsrp_module.rst b/docs/cisco.nxos.nxos_hsrp_module.rst new file mode 100644 index 000000000..0a55a4423 --- /dev/null +++ b/docs/cisco.nxos.nxos_hsrp_module.rst @@ -0,0 +1,305 @@ +.. _cisco.nxos.nxos_hsrp_module: + + +******************** +cisco.nxos.nxos_hsrp +******************** + +**Manages HSRP configuration on NX-OS switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages HSRP configuration on NX-OS switches. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ auth_string + +
+ string +
+ 		+ +
Authentication string. If this needs to be hidden(for md5 type), the string should be 7 followed by the key string. Otherwise, it can be 0 followed by key string or just key string (for backward compatibility). For text type, this should be just be a key string. if this is 'default', authentication is removed.
+
+
+ auth_type + +
+ string +
+ 		+
    Choices: +
  • text
    • +
  • md5
    • +
+ 		+
Authentication type.
+
+
+ group + +
+ string + / required +
+ 		+ +
HSRP group number.
+
+
+ interface + +
+ string + / required +
+ 		+ +
Full name of interface that is being managed for HSRP.
+
+
+ preempt + +
+ string +
+ 		+
    Choices: +
  • enabled
    • +
  • disabled
    • +
+ 		+
Enable/Disable preempt.
+
+
+ priority + +
+ string +
+ 		+ +
HSRP priority or keyword 'default'.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specify desired state of the resource.
+
+
+ version + +
+ string +
+ 		+
    Choices: +
  • 1 ←
    • +
  • 2
    • +
+ 		+
HSRP version.
+
+
+ vip + +
+ string +
+ 		+ +
HSRP virtual IP address or keyword 'default'
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - HSRP feature needs to be enabled first on the system. + - SVIs must exist before using this module. + - Interface must be a L3 port before using this module. + - HSRP cannot be configured on loopback interfaces. + - MD5 authentication is only possible with HSRPv2 while it is ignored if HSRPv1 is used instead, while it will not raise any error. Here we allow MD5 authentication only with HSRPv2 in order to enforce better practice. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Ensure HSRP is configured with following params on a SVI + cisco.nxos.nxos_hsrp: + group: 10 + vip: 10.1.1.1 + priority: 150 + interface: vlan10 + preempt: enabled + + - name: Ensure HSRP is configured with following params on a SVI with clear text authentication + cisco.nxos.nxos_hsrp: + group: 10 + vip: 10.1.1.1 + priority: 150 + interface: vlan10 + preempt: enabled + auth_type: text + auth_string: CISCO + + - name: Ensure HSRP is configured with md5 authentication and clear authentication + string + cisco.nxos.nxos_hsrp: + group: 10 + vip: 10.1.1.1 + priority: 150 + interface: vlan10 + preempt: enabled + auth_type: md5 + auth_string: 0 1234 + + - name: Ensure HSRP is configured with md5 authentication and hidden authentication + string + cisco.nxos.nxos_hsrp: + group: 10 + vip: 10.1.1.1 + priority: 150 + interface: vlan10 + preempt: enabled + auth_type: md5 + auth_string: 7 1234 + + - name: Remove HSRP config for given interface, group, and VIP + cisco.nxos.nxos_hsrp: + group: 10 + interface: vlan10 + vip: 10.1.1.1 + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['interface vlan10', 'hsrp version 2', 'hsrp 30', 'ip 10.30.1.1']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_igmp_module.rst b/docs/cisco.nxos.nxos_igmp_module.rst new file mode 100644 index 000000000..dbb46206f --- /dev/null +++ b/docs/cisco.nxos.nxos_igmp_module.rst @@ -0,0 +1,191 @@ +.. _cisco.nxos.nxos_igmp_module: + + +******************** +cisco.nxos.nxos_igmp +******************** + +**Manages IGMP global configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages IGMP global configuration configuration settings. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ enforce_rtr_alert + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables or disables the enforce router alert option check for IGMPv2 and IGMPv3 packets.
+
+
+ flush_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Removes routes when the IGMP process is restarted. By default, routes are not flushed.
+
+
+ restart + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Restarts the igmp process (using an exec config command).
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • default
    • +
+ 		+
Manages desired state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - When ``state=default``, all supported params will be reset to a default state. + - If restart is set to true with other params set, the restart will happen last, i.e. after the configuration takes place. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Default igmp global params (all params except restart) + cisco.nxos.nxos_igmp: + state: default + + - name: Ensure the following igmp global config exists on the device + cisco.nxos.nxos_igmp: + flush_routes: true + enforce_rtr_alert: true + + - name: Restart the igmp process + cisco.nxos.nxos_igmp: + restart: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ updates + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['ip igmp flush-routes']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_igmp_snooping_module.rst b/docs/cisco.nxos.nxos_igmp_snooping_module.rst new file mode 100644 index 000000000..31af97509 --- /dev/null +++ b/docs/cisco.nxos.nxos_igmp_snooping_module.rst @@ -0,0 +1,225 @@ +.. _cisco.nxos.nxos_igmp_snooping_module: + + +***************************** +cisco.nxos.nxos_igmp_snooping +***************************** + +**Manages IGMP snooping global configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages IGMP snooping global configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ group_timeout + +
+ string +
+ 		+ +
Group membership timeout value for all VLANs on the device. Accepted values are integer in range 1-10080, never and default.
+
+
+ link_local_grp_supp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Global link-local groups suppression.
+
+
+ report_supp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Global IGMPv1/IGMPv2 Report Suppression.
+
+
+ snooping + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/disables IGMP snooping on the switch.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • default
    • +
+ 		+
Manage the state of the resource.
+
+
+ v3_report_supp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Global IGMPv3 Report Suppression and Proxy Reporting.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - When ``state=default``, params will be reset to a default state. + - ``group_timeout`` also accepts *never* as an input. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure igmp snooping params supported in this module are in there default state + - cisco.nxos.nxos_igmp_snooping: + state: default + + # ensure following igmp snooping params are in the desired state + - cisco.nxos.nxos_igmp_snooping: + group_timeout: never + snooping: true + link_local_grp_supp: false + optimize_mcast_flood: false + report_supp: true + v3_report_supp: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['ip igmp snooping link-local-groups-suppression', 'ip igmp snooping group-timeout 50', 'no ip igmp snooping report-suppression', 'no ip igmp snooping v3-report-suppression', 'no ip igmp snooping']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_install_os_module.rst b/docs/cisco.nxos.nxos_install_os_module.rst new file mode 100644 index 000000000..ddd630d01 --- /dev/null +++ b/docs/cisco.nxos.nxos_install_os_module.rst @@ -0,0 +1,183 @@ +.. _cisco.nxos.nxos_install_os_module: + + +************************** +cisco.nxos.nxos_install_os +************************** + +**Set boot options like boot, kickstart image and issu.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Install an operating system by setting the boot options like boot image and kickstart image and optionally select to install using ISSU (In Server Software Upgrade). + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ issu + +
+ string +
+ 		+
    Choices: +
  • required
    • +
  • desired
    • +
  • yes
    • +
  • no ←
    • +
+ 		+
Upgrade using In Service Software Upgrade (ISSU). (Supported on N5k, N7k, N9k platforms)
+
Selecting 'required' or 'yes' means that upgrades will only proceed if the switch is capable of ISSU.
+
Selecting 'desired' means that upgrades will use ISSU if possible but will fall back to disruptive upgrade if needed.
+
Selecting 'no' means do not use ISSU. Forced disruptive.
+
+
+ kickstart_image_file + +
+ string +
+ 		+ +
Name of the kickstart image file on flash. (Not required on all Nexus platforms)
+
+
+ system_image_file + +
+ string + / required +
+ 		+ +
Name of the system (or combined) image file on flash.
+
+
+ + +Notes +----- + +.. note:: + - Tested against the following platforms and images - N9k 7.0(3)I4(6), 7.0(3)I5(3), 7.0(3)I6(1), 7.0(3)I7(1), 7.0(3)F2(2), 7.0(3)F3(2) - N3k 6.0(2)A8(6), 6.0(2)A8(8), 7.0(3)I6(1), 7.0(3)I7(1) - N7k 7.3(0)D1(1), 8.0(1), 8.1(1), 8.2(1) + - Tested against Cisco MDS NX-OS 9.2(1) + - This module requires both the ANSIBLE_PERSISTENT_CONNECT_TIMEOUT and ANSIBLE_PERSISTENT_COMMAND_TIMEOUT timers to be set to 600 seconds or higher. The module will exit if the timers are not set properly. + - When using connection local, ANSIBLE_PERSISTENT_CONNECT_TIMEOUT and ANSIBLE_PERSISTENT_COMMAND_TIMEOUT can only be set using ENV variables or the ansible.cfg file. + - Do not include full file paths, just the name of the file(s) stored on the top level flash directory. + - This module attempts to install the software immediately, which may trigger a reboot. + - In check mode, the module will indicate if an upgrade is needed and whether or not the upgrade is disruptive or non-disruptive(ISSU). + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Install OS on N9k + check_mode: false + cisco.nxos.nxos_install_os: + system_image_file: nxos.7.0.3.I6.1.bin + issu: desired + + - name: Wait for device to come back up with new image + wait_for: + port: 22 + state: started + timeout: 500 + delay: 60 + host: '{{ inventory_hostname }}' + + - name: Check installed OS for newly installed version + nxos_command: + commands: [show version | json] + register: output + + - assert: + that: + - output['stdout'][0]['kickstart_ver_str'] == '7.0(3)I6(1)' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ install_state + +
+ dictionary +
+ 		always +
Boot and install information.
+
+
Sample:
+
{'install_state': ['Compatibility check is done:', 'Module bootable Impact Install-type Reason', '------ -------- -------------- ------------ ------', ' 1 yes non-disruptive reset ', 'Images will be upgraded according to following table:', 'Module Image Running-Version(pri:alt) New-Version Upg-Required', '------ ---------- ---------------------------------------- -------------------- ------------', ' 1 nxos 7.0(3)I6(1) 7.0(3)I7(1) yes', ' 1 bios v4.4.0(07/12/2017) v4.4.0(07/12/2017) no']}
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbibo (@GGabriele) diff --git a/docs/cisco.nxos.nxos_l2_interfaces_module.rst b/docs/cisco.nxos.nxos_l2_interfaces_module.rst new file mode 100644 index 000000000..bfad0cf31 --- /dev/null +++ b/docs/cisco.nxos.nxos_l2_interfaces_module.rst @@ -0,0 +1,648 @@ +.. _cisco.nxos.nxos_l2_interfaces_module: + + +***************************** +cisco.nxos.nxos_l2_interfaces +***************************** + +**L2 interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages Layer-2 interfaces attributes of NX-OS Interfaces. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary of Layer-2 interface options
+
+
+ access + +
+ dictionary +
+ 		+ +
Switchport mode access command to configure the interface as a Layer-2 access.
+
+
+ vlan + +
+ integer +
+ 		+ +
Configure given VLAN in access port. It's used as the access VLAN ID.
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • dot1q-tunnel
    • +
  • access
    • +
  • trunk
    • +
  • fex-fabric
    • +
  • fabricpath
    • +
+ 		+
Mode in which interface needs to be configured.
+
Access mode is not shown in interface facts, so idempotency will not be maintained for switchport mode access and every time the output will come as changed=True.
+
+
+ name + +
+ string + / required +
+ 		+ +
Full name of interface, i.e. Ethernet1/1.
+
+
+ trunk + +
+ dictionary +
+ 		+ +
Switchport mode trunk command to configure the interface as a Layer-2 trunk.
+
+
+ allowed_vlans + +
+ string +
+ 		+ +
List of allowed VLANs in a given trunk port. These are the only VLANs that will be configured on the trunk.
+
+
+ native_vlan + +
+ integer +
+ 		+ +
Native VLAN to be configured in trunk port. It is used as the trunk native VLAN ID.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section ^interface.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state of the configuration after module completion.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOS 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # interface Ethernet1/2 + # switchport trunk native vlan 20 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + - name: Merge provided configuration with device configuration + cisco.nxos.nxos_l2_interfaces: + config: + - name: Ethernet1/1 + trunk: + native_vlan: 10 + allowed_vlans: 2,4,15 + - name: Ethernet1/2 + access: + vlan: 30 + state: merged + + # Task Output + # ----------- + # + # before: + # - name: Loopback999 + # - name: Ethernet1/2 + # - name: mgmt0 + # - name: Ethernet1/1 + # commands: + # - interface Ethernet1/1 + # - switchport trunk allowed vlan 2,4,15 + # - switchport trunk native vlan 10 + # - interface Ethernet1/2 + # - switchport access vlan 30 + # after: + # - name: Ethernet1/1 + # trunk: + # allowed_vlans: 2,4,15 + # native_vlan: 10 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + # - name: Loopback999 + + # After state: + # ------------ + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # switchport trunk native vlan 10 + # switchport trunk allowed vlans 2,4,15 + # interface Ethernet1/2 + # switchport access vlan 30 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + # Using replaced + + # Before state: + # ------------- + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # switchport trunk native vlan 10 + # switchport trunk allowed vlans 2,4,15 + # interface Ethernet1/2 + # switchport access vlan 30 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + - name: Replace device configuration of specified L2 interfaces with provided configuration. + cisco.nxos.nxos_l2_interfaces: + config: + - name: Ethernet1/1 + trunk: + native_vlan: 20 + allowed_vlans: 5-10, 15 + state: replaced + + # Task Output + # ----------- + # + # before: + # - name: Ethernet1/1 + # trunk: + # allowed_vlans: 2,4,15 + # native_vlan: 10 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + # commands: + # - interface Ethernet1/1 + # - no switchport trunk native vlan + # - switchport trunk allowed vlan 5-10,15 + # - switchport trunk native vlan 20 + # after: + # - name: Ethernet1/1 + # trunk: + # allowed_vlans: 5-10,15 + # native_vlan: 20 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + + # After state: + # ------------ + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # switchport trunk native vlan 20 + # switchport trunk allowed vlan 5-10,15 + # interface Ethernet1/2 + # switchport trunk native vlan 20 + # switchport mode trunk + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + # Using overridden + + # Before state: + # ------------- + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # switchport trunk native vlan 20 + # switchport trunk allowed vlan 5-10,15 + # interface Ethernet1/2 + # switchport trunk native vlan 20 + # switchport mode trunk + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + - name: Override device configuration with provided configuration. + cisco.nxos.nxos_l2_interfaces: + config: + - name: Ethernet1/2 + access: + vlan: 30 + state: overridden + + # Task Output + # ----------- + # + # before: + # - name: Ethernet1/1 + # trunk: + # allowed_vlans: 5,6,7,8,9,10,15 + # native_vlan: 20 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + # commands: + # - interface Ethernet1/1 + # - no switchport trunk allowed vlan + # - no switchport trunk native vlan + # after: + # - name: Ethernet1/1 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + + # After state: + # ------------ + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # interface Ethernet1/2 + # switchport access vlan 30 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + + # Using deleted + + # Before state: + # ------------- + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # switchport trunk native vlan 10 + # switchport trunk allowed vlan 2,4,15 + # interface Ethernet1/2 + # switchport access vlan 30 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + - name: Delete L2 attributes of given interfaces (Note This won't delete the interface + itself). + cisco.nxos.nxos_l2_interfaces: + config: + - name: Ethernet1/1 + - name: Ethernet1/2 + state: deleted + + # Task Output + # ----------- + # + # before: + # - name: Ethernet1/1 + # trunk: + # allowed_vlans: 2,4,15 + # native_vlan: 10 + # - access: + # vlan: 30 + # name: Ethernet1/2 + # - name: mgmt0 + # commands: + # - interface Ethernet1/1 + # - no switchport trunk allowed vlan + # - no switchport trunk native vlan + # - interface Ethernet1/2 + # - no switchport access vlan + # after: + # - name: Ethernet1/1 + # - name: Ethernet1/2 + # - name: mgmt0 + + # After state: + # ------------ + # + # switch# show running-config | section interface + # interface Ethernet1/1 + # interface Ethernet1/2 + # interface mgmt0 + # ip address dhcp + # ipv6 address auto-config + + # Using rendered + + - name: Render platform specific configuration lines (without connecting to the device) + cisco.nxos.nxos_l2_interfaces: + config: + - name: Ethernet1/1 + trunk: + native_vlan: 10 + allowed_vlans: 2,4,15 + - name: Ethernet1/2 + access: + vlan: 30 + - name: Ethernet1/3 + trunk: + native_vlan: 20 + allowed_vlans: 5-10, 15 + state: rendered + + # Task Output + # ----------- + # + # rendered: + # - interface Ethernet1/1 + # - switchport trunk allowed vlan 2,4,15 + # - switchport trunk native vlan 10 + # - interface Ethernet1/2 + # - switchport access vlan 30 + # - interface Ethernet1/3 + # - switchport trunk allowed vlan 5-10,15 + # - switchport trunk native vlan 20 + + # Using parsed + + # parsed.cfg + # ------------ + # + # interface Ethernet1/800 + # switchport access vlan 18 + # switchport trunk allowed vlan 210 + # interface Ethernet1/801 + # switchport trunk allowed vlan 2,4,15 + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_l2_interfaces: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output + # ----------- + # + # parsed: + # - name: Ethernet1/800 + # access: + # vlan: 18 + # trunk: + # allowed_vlans: "210" + # - name: Ethernet1/801 + # trunk: + # allowed_vlans: "2,4,15" + + # Using gathered + + # Before state: + # ------------- + # + # switch# sh running-config | section ^interface + # interface Ethernet1/1 + # switchport access vlan 6 + # switchport trunk allowed vlan 200 + # interface Ethernet1/2 + # switchport trunk native vlan 10 + + - name: Gather l2_interfaces facts from the device using nxos_l2_interfaces + cisco.nxos.nxos_l2_interfaces: + state: gathered + + # Task output + # ----------- + # + # gathered: + # - name: "Ethernet1/1" + # access: + # vlan: 6 + # trunk: + # allowed_vlans: "200" + # - name: "Ethernet1/2" + # trunk: + # native_vlan: 10 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/1', 'switchport trunk allowed vlan 2,4,15', 'switchport trunk native vlan 10', 'interface Ethernet1/2', 'switchport access vlan 30', 'interface Ethernet1/3', 'switchport trunk allowed vlan 5,6,7,8,9,10,15', 'switchport trunk native vlan 20']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_l3_interfaces_module.rst b/docs/cisco.nxos.nxos_l3_interfaces_module.rst new file mode 100644 index 000000000..28a56bdf8 --- /dev/null +++ b/docs/cisco.nxos.nxos_l3_interfaces_module.rst @@ -0,0 +1,884 @@ +.. _cisco.nxos.nxos_l3_interfaces_module: + + +***************************** +cisco.nxos.nxos_l3_interfaces +***************************** + +**L3 interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages Layer-3 interfaces attributes of NX-OS Interfaces. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary of Layer-3 interface options
+
+
+ dot1q + +
+ integer +
+ 		+ +
Configures IEEE 802.1Q VLAN encapsulation on a subinterface.
+
+
+ evpn_multisite_tracking + +
+ string +
+
added in 1.1.0
+ 		+
    Choices: +
  • fabric-tracking
    • +
  • dci-tracking
    • +
+ 		+
VxLAN evpn multisite Interface tracking. Supported only on selected model.
+
+
+ ipv4 + +
+ list + / elements=dictionary +
+ 		+ +
IPv4 address and attributes of the L3 interface.
+
+
+ address + +
+ string +
+ 		+ +
IPV4 address of the L3 interface.
+
+
+ secondary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
A boolean attribute to manage addition of secondary IP address.
+
+
+ tag + +
+ integer +
+ 		+ +
URIB route tag value for local/direct routes.
+
+
+ ipv6 + +
+ list + / elements=dictionary +
+ 		+ +
IPv6 address and attributes of the L3 interface.
+
+
+ address + +
+ string +
+ 		+ +
IPV6 address of the L3 interface.
+
+
+ tag + +
+ integer +
+ 		+ +
URIB route tag value for local/direct routes.
+
+
+ ipv6_redirects + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/disables ipv6 redirects.
+
+
+ name + +
+ string + / required +
+ 		+ +
Full name of L3 interface, i.e. Ethernet1/1.
+
+
+ redirects + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/disables ipv4 redirects.
+
+
+ unreachables + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/disables ip redirects.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^interface'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state of the configuration after module completion.
+
The state overridden would override the IP address configuration of all interfaces on the device with the provided configuration in the task. Use caution with this state as you may loose access to the device.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOS 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no shutdown + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + - name: Merge provided configuration with device configuration. + cisco.nxos.nxos_l3_interfaces: + config: + - name: Ethernet1/6 + ipv4: + - address: 192.168.1.1/24 + tag: 5 + - address: 10.1.1.1/24 + secondary: true + tag: 10 + ipv6: + - address: fd5d:12c9:2201:2::1/64 + tag: 6 + - name: Ethernet1/7.42 + redirects: false + unreachables: false + state: merged + + # Task Output + # ----------- + # + # before: + # - name: Ethernet1/6 + # - name: Ethernet1/7 + # - ipv4: + # - address: dhcp + # name: mgmt0 + # commands: + # - interface Ethernet1/6 + # - ip address 192.168.1.1/24 tag 5 + # - ip address 10.1.1.1/24 secondary tag 10 + # - ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + # - interface Ethernet1/7 + # - no ip redirects + # after: + # - ipv4: + # - address: 192.168.1.1/24 + # tag: 5 + # - address: 10.1.1.1/24 + # secondary: true + # tag: 10 + # ipv6: + # - address: fd5d:12c9:2201:2::1/64 + # tag: 6 + # name: Ethernet1/6 + # redirects: false + # - name: Ethernet1/7 + # redirects: false + # - ipv4: + # - address: dhcp + # name: mgmt0 + + # After state: + # ------------ + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no ip redirects + # ip address 192.168.1.1/24 tag 5 + # ip address 10.1.1.1/24 secondary tag 10 + # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no ip redirects + # no shutdown + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + + # Using replaced + + # Before state: + # ------------- + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no ip redirects + # ip address 192.168.1.1/24 tag 5 + # ip address 10.1.1.1/24 secondary tag 10 + # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no ip redirects + # no shutdown + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + - name: Replace device configuration of specified L3 interfaces with provided configuration. + cisco.nxos.nxos_l3_interfaces: + config: + - name: Ethernet1/6 + ipv4: + - address: 192.168.22.3/24 + state: replaced + + # Task Output + # ----------- + # + # before: + # - ipv4: + # - address: 192.168.1.1/24 + # tag: 5 + # - address: 10.1.1.1/24 + # secondary: true + # tag: 10 + # ipv6: + # - address: fd5d:12c9:2201:2::1/64 + # tag: 6 + # name: Ethernet1/6 + # redirects: false + # - name: Ethernet1/7 + # redirects: false + # - ipv4: + # - address: dhcp + # name: mgmt0 + # commands: + # - interface Ethernet1/6 + # - ip address 192.168.22.3/24 + # - no ipv6 address fd5d:12c9:2201:2::1/64 + # - ip redirects + # after: + # - ipv4: + # - address: 192.168.22.3/24 + # - address: 10.1.1.1/24 + # secondary: true + # tag: 10 + # name: Ethernet1/6 + # redirects: false + # - name: Ethernet1/7 + # redirects: false + # - ipv4: + # - address: dhcp + # name: mgmt0 + + # After state: + # ------------ + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no ip redirects + # ip address 192.168.22.3/24 + # ip address 10.1.1.1/24 secondary tag 10 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no ip redirects + # no shutdown + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + # Using overridden + + # Before state: + # ------------- + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no ip redirects + # ip address 192.168.1.1/24 tag 5 + # ip address 10.1.1.1/24 secondary tag 10 + # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no ip redirects + # no shutdown + # interface Ethernet1/7.42 + # no ip redirects + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + - name: Override device configuration with provided configuration. + cisco.nxos.nxos_l3_interfaces: + config: + - ipv4: + - address: dhcp + name: mgmt0 + - name: Ethernet1/6 + ipv4: + - address: 192.168.22.3/24 + state: overridden + + # Task Output + # ----------- + # + # before: + # - ipv4: + # - address: 192.168.1.1/24 + # tag: 5 + # - address: 10.1.1.1/24 + # secondary: true + # tag: 10 + # ipv6: + # - address: fd5d:12c9:2201:2::1/64 + # tag: 6 + # name: Ethernet1/6 + # redirects: false + # - name: Ethernet1/7 + # redirects: false + # - name: Ethernet1/7.42 + # redirects: false + # - ipv4: + # - address: dhcp + # name: mgmt0 + # commands: + # - interface Ethernet1/6 + # - no ipv6 address fd5d:12c9:2201:2::1/64 + # - no ip address 10.1.1.1/24 secondary + # - ip address 192.168.22.3/24 + # - ip redirects + # - interface Ethernet1/7 + # - ip redirects + # - interface Ethernet1/7.42 + # - ip redirects + # after: + # - ipv4: + # - address: 192.168.22.3/24 + # name: Ethernet1/6 + # - name: Ethernet1/7 + # - name: Ethernet1/7.42 + # - ipv4: + # - address: dhcp + # name: mgmt0 + + # After state: + # ------------ + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # ip address 192.168.22.3/24 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no shutdown + # interface Ethernet1/7.42 + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + # Using deleted + + # Before state: + # ------------- + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # ip address 192.168.22.3/24 + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no shutdown + # interface Ethernet1/7.42 + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + - name: Delete L3 attributes of given interfaces (This won't delete the interface + itself). + cisco.nxos.nxos_l3_interfaces: + config: + - name: Ethernet1/6 + - name: Ethernet1/2 + state: deleted + + # Task Output + # ----------- + # + # before: + # - name: Ethernet1/2 + # - ipv4: + # - address: 192.168.22.3/24 + # name: Ethernet1/6 + # - name: Ethernet1/7 + # - name: Ethernet1/7.42 + # - ipv4: + # - address: dhcp + # name: mgmt0 + # commands: + # - interface Ethernet1/6 + # - no ip address + # after: + # - name: Ethernet1/2 + # - name: Ethernet1/7 + # - name: Ethernet1/7.42 + # - ipv4: + # - address: dhcp + # name: mgmt0 + + # After state: + # ------------ + # + # router# show running-config | section interface + # interface Ethernet1/6 + # description Configured by Ansible Network + # no switchport + # no shutdown + # interface Ethernet1/7 + # description Configured by Ansible + # no switchport + # no shutdown + # interface Ethernet1/7.42 + # interface mgmt0 + # description mgmt interface + # ip address dhcp + # vrf member management + + # Using rendered + + - name: Use rendered state to convert task input to device specific commands + cisco.nxos.nxos_l3_interfaces: + config: + - name: Ethernet1/800 + ipv4: + - address: 192.168.1.100/24 + tag: 5 + - address: 10.1.1.1/24 + secondary: true + tag: 10 + - name: Ethernet1/800 + ipv6: + - address: fd5d:12c9:2201:2::1/64 + tag: 6 + state: rendered + + # Task Output + # ----------- + # + # rendered: + # - interface Ethernet1/800 + # - ip address 192.168.1.100/24 tag 5 + # - ip address 10.1.1.1/24 secondary tag 10 + # - interface Ethernet1/800 + # - ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + + # Using parsed + + # parsed.cfg + # ---------- + # + # interface Ethernet1/800 + # ip address 192.168.1.100/24 tag 5 + # ip address 10.1.1.1/24 secondary tag 10 + # no ip redirects + # interface Ethernet1/801 + # ipv6 address fd5d:12c9:2201:2::1/64 tag 6 + # ip unreachables + # interface mgmt0 + # ip address dhcp + # vrf member management + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_l3_interfaces: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output + # ----------- + # + # parsed: + # - name: Ethernet1/800 + # ipv4: + # - address: 192.168.1.100/24 + # tag: 5 + # - address: 10.1.1.1/24 + # secondary: True + # tag: 10 + # redirects: False + # - name: Ethernet1/801 + # ipv6: + # - address: fd5d:12c9:2201:2::1/64 + # tag: 6 + # unreachables: True + + # Using gathered + + # Before state: + # ------------- + # + # interface Ethernet1/1 + # ip address 192.0.2.100/24 + # interface Ethernet1/2 + # no ip redirects + # ip address 203.0.113.10/24 + # ip unreachables + # ipv6 address 2001:db8::1/32 + + - name: Gather l3_interfaces facts from the device using nxos_l3_interfaces + cisco.nxos.nxos_l3_interfaces: + state: gathered + + # Task output + # ----------- + # + # gathered: + # - name: Ethernet1/1 + # ipv4: + # - address: 192.0.2.100/24 + # - name: Ethernet1/2 + # ipv4: + # - address: 203.0.113.10/24 + # ipv6: + # - address: 2001:db8::1/32 + # redirects: False + # unreachables: True + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/2', 'ip address 192.168.0.1/2']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_lacp_module.rst b/docs/cisco.nxos.nxos_lacp_module.rst new file mode 100644 index 000000000..b0410c783 --- /dev/null +++ b/docs/cisco.nxos.nxos_lacp_module.rst @@ -0,0 +1,402 @@ +.. _cisco.nxos.nxos_lacp_module: + + +******************** +cisco.nxos.nxos_lacp +******************** + +**LACP resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages Global Link Aggregation Control Protocol (LACP) on NX-OS devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
LACP global options.
+
+
+ system + +
+ dictionary +
+ 		+ +
LACP system options
+
+
+ mac + +
+ dictionary +
+ 		+ +
MAC address to be used for the LACP Protocol exchanges
+
+
+ address + +
+ string +
+ 		+ +
MAC-address (FORMAT :xxxx.xxxx.xxxx).
+
+
+ role + +
+ string +
+ 		+
    Choices: +
  • primary
    • +
  • secondary
    • +
+ 		+
The role for the Switch.
+
+
+ priority + +
+ integer +
+ 		+ +
The system priority to use in LACP negotiations.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | include lacp.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state of the configuration after module completion.
+
States replaced and overridden have the same behaviour for this module.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOS 7.3.(0)D1(1) on VIRL. + - Unsupported for Cisco MDS + - Feature lacp should be enabled for this module. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + + - name: Merge provided configuration with device configuration. + cisco.nxos.nxos_lacp: + config: + system: + priority: 10 + mac: + address: 00c1.4c00.bd15 + state: merged + + # After state: + # ------------ + # + # lacp system-priority 10 + # lacp system-mac 00c1.4c00.bd15 + + + # Using replaced + + # Before state: + # ------------- + # + # lacp system-priority 10 + + - name: Replace device global lacp configuration with the given configuration. + cisco.nxos.nxos_lacp: + config: + system: + mac: + address: 00c1.4c00.bd15 + state: replaced + + # After state: + # ------------ + # + # lacp system-mac 00c1.4c00.bd15 + + + # Using deleted + + # Before state: + # ------------- + # + # lacp system-priority 10 + + - name: Delete global LACP configurations. + cisco.nxos.nxos_lacp: + state: deleted + + # After state: + # ------------ + # + + # Using rendered + + - name: Render platform specific configuration lines (without connecting to the device) + cisco.nxos.nxos_lacp: + config: + system: + priority: 10 + mac: + address: 00c1.4c00.bd15 + role: secondary + state: rendered + + # Task Output (redacted) + # ----------------------- + + # rendered: + # - "lacp system-priority 10" + # - "lacp system-mac 00c1.4c00.bd15 role secondary" + + # Using parsed + + # parsed.cfg + # ------------ + # lacp system-priority 10 + # lacp system-mac 00c1.4c00.bd15 role secondary + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_lacp: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # system: + # priority: 10 + # mac: + # address: 00c1.4c00.bd15 + # role: secondary + + # Using gathered + + # Existing device config state + # ------------------------------- + # Nexus9000v# show running-config | include lacp + # lacp system-priority 11 + # lacp system-mac 00c1.4c00.bd15 role primary + + - name: Gather lacp facts from the device using nxos_lacp + cisco.nxos.nxos_lacp: + state: gathered + + # Task output (redacted) + # ----------------------- + # gathered: + # system: + # priority: 11 + # mac: + # address: 00c1.4c00.bd15 + # role: primary + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['lacp system-priority 15', 'lacp system-mac 00c1.4c00.bd15 role primary']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_lldp_interfaces_module.rst b/docs/cisco.nxos.nxos_lldp_interfaces_module.rst new file mode 100644 index 000000000..d634e9aa4 --- /dev/null +++ b/docs/cisco.nxos.nxos_lldp_interfaces_module.rst @@ -0,0 +1,407 @@ +.. _cisco.nxos.nxos_lldp_interfaces_module: + + +******************************* +cisco.nxos.nxos_lldp_interfaces +******************************* + +**LLDP interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages interfaces' configuration for Link Layer Discovery Protocol (LLDP) on NX-OS platforms. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of link layer discovery configurations for interfaces.
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the interface
+
+
+ receive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Used to enable or disable the reception of LLDP packets on that interface. By default, this is enabled after LLDP is enabled globally.
+
+
+ tlv_set + +
+ dictionary +
+ 		+ +
Used to configure TLV parameters on the interface
+
+
+ management_address + +
+ string +
+ 		+ +
Used to mention the IPv4 or IPv6 management address for the interface
+
+
+ vlan + +
+ integer +
+ 		+ +
Used to mention the VLAN for the interface
+
+
+ transmit + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Used to enable or disable the transmission of LLDP packets on that interface. By default, this is enabled after LLDP is enabled globally.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section ^interface.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state the configuration should be left in
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOS 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - The LLDP feature needs to be enabled before using this module + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + + - name: Merge provided configuration with device configuration + cisco.nxos.nxos_lldp_interfaces: + config: + - name: Ethernet1/4 + receive: false + transmit: true + tlv_set: + management_address: 192.168.122.64 + vlan: 12 + state: merged + + # After state: + # ------------- + # + # interface Ethernet1/4 + # no lldp receive + # lldp tlv-set management-address 192.168.122.64 + # lldp tlv-set vlan 12 + + + # Using replaced + + # Before state: + # ------------ + # + # interface Ethernet1/4 + # no lldp receive + # lldp tlv-set management-address 192.168.122.64 + # interface Ethernet1/5 + # no lldp transmit + # lldp tlv-set vlan 10 + + - name: Replace LLDP configuration on interfaces with given configuration + cisco.nxos.nxos_lldp_interfaces: + config: + - name: Ethernet1/4 + transmit: false + tlv_set: + vlan: 2 + state: replaced + + + # After state: + # ----------- + # + # interface Ethernet1/4 + # no lldp transmit + # lldp tlv_set vlan 2 + # interface Ethernet1/5 + # no lldp transmit + # lldp tlv-set vlan 10 + + + # Using overridden + + # Before state: + # ------------ + # + # interface Ethernet1/4 + # no lldp receive + # lldp tlv-set management-address 192.168.122.64 + # interface Ethernet1/5 + # no lldp transmit + # lldp tlv-set vlan 10 + + - name: Override LLDP configuration on all interfaces with given configuration + cisco.nxos.nxos_lldp_interfaces: + config: + - name: Ethernet1/7 + receive: false + tlv_set: + vlan: 12 + state: overridden + + + # After state: + # ----------- + # + # interface Ethernet1/7 + # no lldp receive + # lldp tlv_set vlan 12 + + + # Using deleted + + # Before state: + # ------------ + # + # interface Ethernet1/4 + # lldp tlv-set management vlan 24 + # no lldp transmit + # interface mgmt0 + # no lldp receive + + - name: Delete LLDP interfaces configuration + cisco.nxos.nxos_lldp_interfaces: + state: deleted + + # After state: + # ------------ + # + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/2', 'lldp receive', 'lldp tlv-set vlan 12']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Adharsh Srivats Rangarajan (@adharshsrivatsr) diff --git a/docs/cisco.nxos.nxos_logging_module.rst b/docs/cisco.nxos.nxos_logging_module.rst new file mode 100644 index 000000000..9dafd8e33 --- /dev/null +++ b/docs/cisco.nxos.nxos_logging_module.rst @@ -0,0 +1,458 @@ +.. _cisco.nxos.nxos_logging_module: + + +*********************** +cisco.nxos.nxos_logging +*********************** + +**Manage logging on network devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2023-08-01 +:Why: Updated module released with more functionality. +:Alternative: nxos_logging_global + + + +Synopsis +-------- +- This module provides declarative management of logging on Cisco NX-OS devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ aggregate + +
+ list + / elements=dictionary +
+ 		+ +
List of logging definitions.
+
+
+ dest + +
+ string +
+ 		+
    Choices: +
  • console
    • +
  • logfile
    • +
  • module
    • +
  • monitor
    • +
  • server
    • +
+ 		+
Destination of the logs.
+
+
+ dest_level + +
+ integer +
+ 		+ +
Set logging severity levels.
+

aliases: level
+
+
+ event + +
+ string +
+ 		+
    Choices: +
  • link-enable
    • +
  • link-default
    • +
  • trunk-enable
    • +
  • trunk-default
    • +
+ 		+
Link/trunk enable/default interface configuration logging
+
+
+ facility + +
+ string +
+ 		+ +
Facility name for logging.
+
+
+ facility_level + +
+ integer +
+ 		+ +
Set logging severity levels for facility based log messages.
+
+
+ facility_link_status + +
+ string +
+ 		+
    Choices: +
  • link-down-notif
    • +
  • link-down-error
    • +
  • link-up-notif
    • +
  • link-up-error
    • +
+ 		+
Set logging facility ethpm link status. Not idempotent with version 6.0 images.
+
+
+ file_size + +
+ integer +
+ 		+ +
Set logfile size
+
+
+ interface + +
+ string +
+ 		+ +
Interface to be used while configuring source-interface for logging (e.g., 'Ethernet1/2', 'mgmt0')
+
+
+ interface_message + +
+ string +
+ 		+
    Choices: +
  • add-interface-description
    • +
+ 		+
Add interface description to interface syslogs. Does not work with version 6.0 images using nxapi as a transport.
+
+
+ name + +
+ string +
+ 		+ +
If value of dest is logfile it indicates file-name.
+
+
+ purge + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Remove any switch logging configuration that does not match what has been configured Not supported for ansible_connection local. All nxos_logging tasks must use the same ansible_connection type.
+
+
+ remote_server + +
+ string +
+ 		+ +
Hostname or IP Address for remote logging (when dest is 'server').
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
State of the logging configuration.
+
+
+ timestamp + +
+ string +
+ 		+
    Choices: +
  • microseconds
    • +
  • milliseconds
    • +
  • seconds
    • +
+ 		+
Set logging timestamp format
+
+
+ use_vrf + +
+ string +
+ 		+ +
VRF to be used while configuring remote logging (when dest is 'server').
+
+
+ + +Notes +----- + +.. note:: + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: configure console logging with level + cisco.nxos.nxos_logging: + dest: console + level: 2 + state: present + - name: remove console logging configuration + cisco.nxos.nxos_logging: + dest: console + level: 2 + state: absent + - name: configure file logging with level + cisco.nxos.nxos_logging: + dest: logfile + name: testfile + dest_level: 3 + state: present + - name: Configure logging logfile with size + cisco.nxos.nxos_logging: + dest: logfile + name: testfile + dest_level: 3 + file_size: 16384 + - name: configure facility level logging + cisco.nxos.nxos_logging: + facility: daemon + facility_level: 0 + state: present + - name: remove facility level logging + cisco.nxos.nxos_logging: + facility: daemon + facility_level: 0 + state: absent + - name: Configure Remote Logging + cisco.nxos.nxos_logging: + dest: server + remote_server: test-syslogserver.com + facility: auth + facility_level: 1 + use_vrf: management + state: present + - name: Configure Source Interface for Logging + cisco.nxos.nxos_logging: + interface: mgmt0 + state: present + - name: Purge nxos_logging configuration not managed by this playbook + cisco.nxos.nxos_logging: + purge: true + - name: Configure logging timestamp + cisco.nxos.nxos_logging: + timestamp: milliseconds + state: present + - name: Configure logging facility ethpm link status + cisco.nxos.nxos_logging: + facility: ethpm + facility_link_status: link-up-notif + state: present + - name: Configure logging message ethernet description + cisco.nxos.nxos_logging: + interface_message: add-interface-description + state: present + - name: Configure logging event link enable + cisco.nxos.nxos_logging: + event: link-enable + state: present + - name: Configure logging using aggregate + cisco.nxos.nxos_logging: + aggregate: + - {dest: console, dest_level: 2} + - {dest: logfile, dest_level: 2, name: testfile} + - {facility: daemon, facility_level: 0} + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['logging console 2', 'logging logfile testfile 3', 'logging level daemon 0']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2023-08-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_ntp_auth_module.rst b/docs/cisco.nxos.nxos_ntp_auth_module.rst new file mode 100644 index 000000000..c825cd017 --- /dev/null +++ b/docs/cisco.nxos.nxos_ntp_auth_module.rst @@ -0,0 +1,224 @@ +.. _cisco.nxos.nxos_ntp_auth_module: + + +************************ +cisco.nxos.nxos_ntp_auth +************************ + +**Manages NTP authentication.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated module released with more functionality. +:Alternative: nxos_ntp_global + + + +Synopsis +-------- +- Manages NTP authentication. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ auth_type + +
+ string +
+ 		+
    Choices: +
  • text ←
    • +
  • encrypt
    • +
+ 		+
Whether the given md5string is in cleartext or has been encrypted. If in cleartext, the device will encrypt it before storing it.
+
+
+ authentication + +
+ string +
+ 		+
    Choices: +
  • on
    • +
  • off
    • +
+ 		+
Turns NTP authentication on or off.
+
+
+ key_id + +
+ string +
+ 		+ +
Authentication key identifier (numeric).
+
+
+ md5string + +
+ string +
+ 		+ +
MD5 String.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ trusted_key + +
+ string +
+ 		+
    Choices: +
  • false ←
    • +
  • true
    • +
+ 		+
Whether the given key is required to be supplied by a time source for the device to synchronize to the time source.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - If ``state=absent``, the module will remove the given key configuration if it exists. + - If ``state=absent`` and ``authentication=on``, authentication will be turned off. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Basic NTP authentication configuration + - cisco.nxos.nxos_ntp_auth: + key_id: 32 + md5string: hello + auth_type: text + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['ntp authentication-key 32 md5 helloWorld 0', 'ntp trusted-key 32']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_ntp_global_module.rst b/docs/cisco.nxos.nxos_ntp_global_module.rst new file mode 100644 index 000000000..b77fc9440 --- /dev/null +++ b/docs/cisco.nxos.nxos_ntp_global_module.rst @@ -0,0 +1,1411 @@ +.. _cisco.nxos.nxos_ntp_global_module: + + +************************** +cisco.nxos.nxos_ntp_global +************************** + +**NTP Global resource module.** + + +Version added: 2.6.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages ntp configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A dict of ntp configuration.
+
+
+ access_group + +
+ dictionary +
+ 		+ +
NTP access-group.
+
This option is unsupported on MDS switches.
+
+
+ match_all + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Scan ACLs present in all ntp access groups.
+
+
+ peer + +
+ list + / elements=dictionary +
+ 		+ +
Access-group peer.
+
+
+ access_list + +
+ string +
+ 		+ +
Name of access list.
+
+
+ query_only + +
+ list + / elements=dictionary +
+ 		+ +
Access-group query-only.
+
+
+ access_list + +
+ string +
+ 		+ +
Name of access list.
+
+
+ serve + +
+ list + / elements=dictionary +
+ 		+ +
Access-group serve.
+
+
+ access_list + +
+ string +
+ 		+ +
Name of access list.
+
+
+ serve_only + +
+ list + / elements=dictionary +
+ 		+ +
Access-group serve-only.
+
+
+ access_list + +
+ string +
+ 		+ +
Name of access list.
+
+
+ allow + +
+ dictionary +
+ 		+ +
Enable/Disable the packets.
+
+
+ control + +
+ dictionary +
+ 		+ +
Control mode packets.
+
+
+ rate_limit + +
+ integer +
+ 		+ +
Rate-limit delay.
+
+
+ private + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable Private mode packets.
+
+
+ authenticate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable authentication.
+
+
+ authentication_keys + +
+ list + / elements=dictionary +
+ 		+ +
NTP authentication key.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 for Clear text
+
7 for Encrypted
+
+
+ id + +
+ integer +
+ 		+ +
Authentication key number (range 1-65535).
+
+
+ key + +
+ string +
+ 		+ +
Authentication key.
+
+
+ logging + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable logging of NTPD Events.
+
+
+ master + +
+ dictionary +
+ 		+ +
Act as NTP master clock.
+
This option is unsupported on MDS switches.
+
+
+ stratum + +
+ integer +
+ 		+ +
Stratum number.
+
+
+ passive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
NTP passive command.
+
This option is unsupported on MDS switches.
+
+
+ peers + +
+ list + / elements=dictionary +
+ 		+ +
NTP Peers.
+
+
+ key_id + +
+ integer +
+ 		+ +
Keyid to be used while communicating to this server.
+
+
+ maxpoll + +
+ integer +
+ 		+ +
Maximum interval to poll a peer.
+
Poll interval in secs to a power of 2.
+
+
+ minpoll + +
+ integer +
+ 		+ +
Minimum interval to poll a peer.
+
Poll interval in secs to a power of 2.
+
+
+ peer + +
+ string +
+ 		+ +
Hostname/IP address of the NTP Peer.
+
+
+ prefer + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Preferred Server.
+
+
+ vrf + +
+ string +
+ 		+ +
Display per-VRF information.
+
This option is unsupported on MDS switches.
+

aliases: use_vrf
+
+
+ servers + +
+ list + / elements=dictionary +
+ 		+ +
NTP servers.
+
+
+ key_id + +
+ integer +
+ 		+ +
Keyid to be used while communicating to this server.
+
+
+ maxpoll + +
+ integer +
+ 		+ +
Maximum interval to poll a peer.
+
Poll interval in secs to a power of 2.
+
+
+ minpoll + +
+ integer +
+ 		+ +
Minimum interval to poll a peer.
+
Poll interval in secs to a power of 2.
+
+
+ prefer + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Preferred Server.
+
+
+ server + +
+ string +
+ 		+ +
Hostname/IP address of the NTP Peer.
+
+
+ vrf + +
+ string +
+ 		+ +
Display per-VRF information.
+
This option is not applicable for MDS switches.
+

aliases: use_vrf
+
+
+ source + +
+ string +
+ 		+ +
Source of NTP packets.
+
This option is unsupported on MDS switches.
+
+
+ source_interface + +
+ string +
+ 		+ +
Source interface sending NTP packets.
+
+
+ trusted_keys + +
+ list + / elements=dictionary +
+ 		+ +
NTP trusted-key number.
+
+
+ key_id + +
+ integer +
+ 		+ +
Trusted-Key number.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config ntp.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
The states replaced and overridden have identical behaviour for this module.
+
Please refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6 on Cisco Nexus Switches. + - This module works with connection ``network_cli`` and ``httpapi``. + - Tested against Cisco MDS NX-OS 9.2(2) with connection ``network_cli``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k-rdo# show running-config ntp + # nxos-9k-rdo# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_ntp_global: &id001 + config: + access_group: + peer: + - access_list: PeerAcl1 + serve: + - access_list: ServeAcl1 + authenticate: true + authentication_keys: + - id: 1001 + key: vagwwtKfkv + encryption: 7 + - id: 1002 + key: vagwwtKfkvgthz + encryption: 7 + logging: true + master: + stratum: 2 + peers: + - peer: 192.0.2.1 + key_id: 1 + maxpoll: 15 + minpoll: 5 + vrf: default + - peer: 192.0.2.2 + key_id: 2 + prefer: true + vrf: siteA + servers: + - server: 198.51.100.1 + key_id: 2 + vrf: default + - server: 203.0.113.1 + key_id: 1 + vrf: siteB + + # Task output + # ------------- + # before: {} + # + # commands: + # - "ntp authenticate" + # - "ntp logging" + # - "ntp master 2" + # - "ntp authentication-keys 1001 md5 vagwwtKfkv 7" + # - "ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" + # - "ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" + # - "ntp peer 192.0.2.2 prefer use-vrf siteA key 2" + # - "ntp server 198.51.100.1 use-vrf default key 2" + # - "ntp server 203.0.113.1 use-vrf siteB key 1" + # - "ntp access-group peer PeerAcl1" + # - "ntp access-group serve ServeAcl1" + # + # after: + # access_group: + # peer: + # - access_list: PeerAcl1 + # serve: + # - access_list: ServeAcl1 + # authenticate: true + # authentication_keys: + # - id: 1001 + # key: vagwwtKfkv + # encryption: 7 + # - id: 1002 + # key: vagwwtKfkvgthz + # encryption: 7 + # logging: true + # master: + # stratum: 2 + # peers: + # - peer: 192.0.2.1 + # key_id: 1 + # maxpoll: 15 + # minpoll: 5 + # vrf: default + # - peer: 192.0.2.2 + # key_id: 2 + # prefer: true + # vrf: siteA + # servers: + # - server: 198.51.100.1 + # key_id: 2 + # vrf: default + # - server: 203.0.113.1 + # key_id: 1 + # vrf: siteB + + # After state: + # ------------ + # nxos-9k-rdo# show running-config ntp + # ntp authenticate + # ntp logging + # ntp master 2 + # ntp authentication-keys 1001 md5 vagwwtKfkv 7 + # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 + # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 + # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 + # ntp server 198.51.100.1 use-vrf default key 2 + # ntp server 203.0.113.1 use-vrf siteB key 1 + # ntp access-group peer PeerAcl1 + # ntp access-group serve ServeAcl1 + + # Using replaced + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config ntp + # ntp authenticate + # ntp logging + # ntp master 2 + # ntp authentication-keys 1001 md5 vagwwtKfkv 7 + # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 + # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 + # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 + # ntp server 198.51.100.1 use-vrf default key 2 + # ntp server 203.0.113.1 use-vrf siteB key 1 + # ntp access-group peer PeerAcl1 + # ntp access-group serve ServeAcl1 + + - name: Replace logging global configurations of listed logging global with provided configurations + cisco.nxos.nxos_ntp_global: + config: + access_group: + peer: + - access_list: PeerAcl2 + serve: + - access_list: ServeAcl2 + logging: true + master: + stratum: 2 + peers: + - peer: 192.0.2.1 + key_id: 1 + maxpoll: 15 + minpoll: 5 + vrf: default + - peer: 192.0.2.5 + key_id: 2 + prefer: true + vrf: siteA + servers: + - server: 198.51.100.1 + key_id: 2 + vrf: default + state: replaced + + # Task output + # ------------- + # before: + # access_group: + # peer: + # - access_list: PeerAcl1 + # serve: + # - access_list: ServeAcl1 + # authenticate: true + # authentication_keys: + # - id: 1001 + # key: vagwwtKfkv + # encryption: 7 + # - id: 1002 + # key: vagwwtKfkvgthz + # encryption: 7 + # logging: true + # master: + # stratum: 2 + # peers: + # - peer: 192.0.2.1 + # key_id: 1 + # maxpoll: 15 + # minpoll: 5 + # vrf: default + # - peer: 192.0.2.2 + # key_id: 2 + # prefer: true + # vrf: siteA + # servers: + # - server: 198.51.100.1 + # key_id: 2 + # vrf: default + # - server: 203.0.113.1 + # key_id: 1 + # vrf: siteB + # + # commands: + # - "no ntp authenticate" + # - "no ntp authentication-keys 1001 md5 vagwwtKfkv 7" + # - "no ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" + # - "ntp peer 192.0.2.5 prefer use-vrf siteA key 2" + # - "no ntp peer 192.0.2.2 prefer use-vrf siteA key 2" + # - "no ntp server 203.0.113.1 use-vrf siteB key 1" + # - "ntp access-group peer PeerAcl2" + # - "no ntp access-group peer PeerAcl1" + # - "ntp access-group serve ServeAcl2" + # - "no ntp access-group serve ServeAcl1" + # + # after: + # access_group: + # peer: + # - access_list: PeerAcl2 + # serve: + # - access_list: ServeAcl2 + # logging: true + # master: + # stratum: 2 + # peers: + # - peer: 192.0.2.1 + # key_id: 1 + # maxpoll: 15 + # minpoll: 5 + # vrf: default + # - peer: 192.0.2.5 + # key_id: 2 + # prefer: true + # vrf: siteA + # servers: + # - server: 198.51.100.1 + # key_id: 2 + # vrf: default + + # After state: + # ------------ + # nxos-9k-rdo# show running-config ntp + # ntp logging + # ntp master 2 + # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 + # ntp peer 192.0.2.5 prefer use-vrf siteA key 2 + # ntp server 198.51.100.1 use-vrf default key 2 + # ntp access-group peer PeerAcl2 + # ntp access-group serve ServeAcl2 + + # Using deleted to delete all logging configurations + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config ntp + + - name: Delete all logging configuration + cisco.nxos.nxos_ntp_global: + state: deleted + + # Task output + # ------------- + # before: + # access_group: + # peer: + # - access_list: PeerAcl1 + # serve: + # - access_list: ServeAcl1 + # authenticate: true + # authentication_keys: + # - id: 1001 + # key: vagwwtKfkv + # encryption: 7 + # - id: 1002 + # key: vagwwtKfkvgthz + # encryption: 7 + # logging: true + # master: + # stratum: 2 + # peers: + # - peer: 192.0.2.1 + # key_id: 1 + # maxpoll: 15 + # minpoll: 5 + # vrf: default + # - peer: 192.0.2.2 + # key_id: 2 + # prefer: true + # vrf: siteA + # servers: + # - server: 198.51.100.1 + # key_id: 2 + # vrf: default + # - server: 203.0.113.1 + # key_id: 1 + # vrf: siteB + # + # commands: + # - "no ntp authenticate" + # - "no ntp logging" + # - "no ntp master 2" + # - "no ntp authentication-keys 1001 md5 vagwwtKfkv 7" + # - "no ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" + # - "no ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" + # - "no ntp peer 192.0.2.2 prefer use-vrf siteA key 2" + # - "no ntp server 198.51.100.1 use-vrf default key 2" + # - "no ntp server 203.0.113.1 use-vrf siteB key 1" + # - "no ntp access-group peer PeerAcl1" + # - "no ntp access-group serve ServeAcl1" + # + # after: {} + + # After state: + # ------------ + # nxos-9k-rdo# show running-config ntp + # nxos-9k-rdo# + + # Using rendered + + - name: Render platform specific configuration lines with state rendered (without connecting to the device) + cisco.nxos.nxos_ntp_global: + config: + access_group: + peer: + - access_list: PeerAcl1 + serve: + - access_list: ServeAcl1 + authenticate: true + authentication_keys: + - id: 1001 + key: vagwwtKfkv + encryption: 7 + - id: 1002 + key: vagwwtKfkvgthz + encryption: 7 + logging: true + master: + stratum: 2 + peers: + - peer: 192.0.2.1 + key_id: 1 + maxpoll: 15 + minpoll: 5 + vrf: default + - peer: 192.0.2.2 + key_id: 2 + prefer: true + vrf: siteA + servers: + - server: 198.51.100.1 + key_id: 2 + vrf: default + - server: 203.0.113.1 + key_id: 1 + vrf: siteB + state: rendered + + # Task Output (redacted) + # ----------------------- + # rendered: + # - "ntp authenticate" + # - "ntp logging" + # - "ntp master 2" + # - "ntp authentication-keys 1001 md5 vagwwtKfkv 7" + # - "ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" + # - "ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" + # - "ntp peer 192.0.2.2 prefer use-vrf siteA key 2" + # - "ntp server 198.51.100.1 use-vrf default key 2" + # - "ntp server 203.0.113.1 use-vrf siteB key 1" + # - "ntp access-group peer PeerAcl1" + # - "ntp access-group serve ServeAcl1" + + # Using parsed + + # parsed.cfg + # ------------ + # ntp authenticate + # ntp logging + # ntp master 2 + # ntp authentication-keys 1001 md5 vagwwtKfkv 7 + # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 + # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 + # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 + # ntp server 198.51.100.1 use-vrf default key 2 + # ntp server 203.0.113.1 use-vrf siteB key 1 + # ntp access-group peer PeerAcl1 + # ntp access-group serve ServeAcl1 + + - name: Parse externally provided ntp configuration + cisco.nxos.nxos_ntp_global: + running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # access_group: + # peer: + # - access_list: PeerAcl1 + # serve: + # - access_list: ServeAcl1 + # authenticate: true + # authentication_keys: + # - id: 1001 + # key: vagwwtKfkv + # encryption: 7 + # - id: 1002 + # key: vagwwtKfkvgthz + # encryption: 7 + # logging: true + # master: + # stratum: 2 + # peers: + # - peer: 192.0.2.1 + # key_id: 1 + # maxpoll: 15 + # minpoll: 5 + # vrf: default + # - peer: 192.0.2.2 + # key_id: 2 + # prefer: true + # vrf: siteA + # servers: + # - server: 198.51.100.1 + # key_id: 2 + # vrf: default + # - server: 203.0.113.1 + # key_id: 1 + # vrf: siteB + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['ntp master stratum 2', 'ntp peer 198.51.100.1 use-vrf test maxpoll 7', 'ntp authentication-key 10 md5 wawyhanx2 7', 'ntp access-group peer PeerAcl1', 'ntp access-group peer PeerAcl2', 'ntp access-group query-only QueryAcl1']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['ntp master stratum 2', 'ntp peer 198.51.100.1 use-vrf test maxpoll 7', 'ntp authentication-key 10 md5 wawyhanx2 7', 'ntp access-group peer PeerAcl1', 'ntp access-group peer PeerAcl2', 'ntp access-group query-only QueryAcl1']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_ntp_module.rst b/docs/cisco.nxos.nxos_ntp_module.rst new file mode 100644 index 000000000..3fa835a96 --- /dev/null +++ b/docs/cisco.nxos.nxos_ntp_module.rst @@ -0,0 +1,314 @@ +.. _cisco.nxos.nxos_ntp_module: + + +******************* +cisco.nxos.nxos_ntp +******************* + +**Manages core NTP configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated module released with more functionality. +:Alternative: nxos_ntp_global + + + +Synopsis +-------- +- Manages core NTP configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ key_id + +
+ string +
+ 		+ +
Authentication key identifier to use with given NTP server or peer or keyword 'default'.
+
+
+ peer + +
+ string +
+ 		+ +
Network address of NTP peer.
+
+
+ prefer + +
+ string +
+ 		+
    Choices: +
  • enabled
    • +
  • disabled
    • +
+ 		+
Makes given NTP server or peer the preferred NTP server or peer for the device.
+
+
+ server + +
+ string +
+ 		+ +
Network address of NTP server.
+
+
+ source_addr + +
+ string +
+ 		+ +
Local source address from which NTP messages are sent or keyword 'default'.
+
+
+ source_int + +
+ string +
+ 		+ +
Local source interface from which NTP messages are sent. Must be fully qualified interface name or keyword 'default'
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ vrf_name + +
+ string +
+ 		+ +
Makes the device communicate with the given NTP server or peer over a specific VRF or keyword 'default'.
+
+
+ + +Notes +----- + +.. note:: + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Set NTP Server with parameters + - cisco.nxos.nxos_ntp: + server: 1.2.3.4 + key_id: 32 + prefer: enabled + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ end_state + +
+ dictionary +
+ 		always +
k/v pairs of ntp info after module execution
+
+
Sample:
+
{'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'server', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'source'}
+
+
+ existing + +
+ dictionary +
+ 		always +
k/v pairs of existing ntp server/peer
+
+
Sample:
+
{'address': '192.0.2.2', 'key_id': '32', 'peer_type': 'server', 'prefer': 'enabled', 'source': 'ethernet2/1', 'source_type': 'source-interface'}
+
+
+ proposed + +
+ dictionary +
+ 		always +
k/v pairs of parameters passed into module
+
+
Sample:
+
{'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'server', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'source'}
+
+
+ updates + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['ntp server 192.0.2.2 prefer key 48', 'no ntp source-interface ethernet2/1', 'ntp source 192.0.2.3']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_ntp_options_module.rst b/docs/cisco.nxos.nxos_ntp_options_module.rst new file mode 100644 index 000000000..e99825641 --- /dev/null +++ b/docs/cisco.nxos.nxos_ntp_options_module.rst @@ -0,0 +1,192 @@ +.. _cisco.nxos.nxos_ntp_options_module: + + +*************************** +cisco.nxos.nxos_ntp_options +*************************** + +**Manages NTP options.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated module released with more functionality. +:Alternative: nxos_ntp_global + + + +Synopsis +-------- +- Manages NTP options, e.g. authoritative server and logging. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ logging + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Sets whether NTP logging is enabled on the device.
+
+
+ master + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Sets whether the device is an authoritative NTP server.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ stratum + +
+ string +
+ 		+ +
If master=true, an optional stratum can be supplied (1-15). The device default is 8.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - When ``state=absent``, master and logging will be set to False and stratum will be removed as well + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Basic NTP options configuration + - cisco.nxos.nxos_ntp_options: + master: true + stratum: 12 + logging: false + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ updates + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['no ntp logging', 'ntp master 12']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_nxapi_module.rst b/docs/cisco.nxos.nxos_nxapi_module.rst new file mode 100644 index 000000000..182fe1516 --- /dev/null +++ b/docs/cisco.nxos.nxos_nxapi_module.rst @@ -0,0 +1,300 @@ +.. _cisco.nxos.nxos_nxapi_module: + + +********************* +cisco.nxos.nxos_nxapi +********************* + +**Manage NXAPI configuration on an NXOS device.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Configures the NXAPI feature on devices running Cisco NXOS. The NXAPI feature is absent from the configuration by default. Since this module manages the NXAPI feature it only supports the use of the ``Cli`` transport. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ http + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
Controls the operating state of the HTTP protocol as one of the underlying transports for NXAPI. By default, NXAPI will enable the HTTP transport when the feature is first configured. To disable the use of the HTTP transport, set the value of this argument to False.
+

aliases: enable_http
+
+
+ http_port + +
+ integer +
+ 		+ Default:
80
+ 		+
Configure the port with which the HTTP server will listen on for requests. By default, NXAPI will bind the HTTP service to the standard HTTP port 80. This argument accepts valid port values in the range of 1 to 65535.
+
+
+ https + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Controls the operating state of the HTTPS protocol as one of the underlying transports for NXAPI. By default, NXAPI will disable the HTTPS transport when the feature is first configured. To enable the use of the HTTPS transport, set the value of this argument to True.
+

aliases: enable_https
+
+
+ https_port + +
+ integer +
+ 		+ Default:
443
+ 		+
Configure the port with which the HTTPS server will listen on for requests. By default, NXAPI will bind the HTTPS service to the standard HTTPS port 443. This argument accepts valid port values in the range of 1 to 65535.
+
+
+ sandbox + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
The NXAPI feature provides a web base UI for developers for entering commands. This feature is initially disabled when the NXAPI feature is configured for the first time. When the sandbox argument is set to True, the developer sandbox URL will accept requests and when the value is set to False, the sandbox URL is unavailable. This is supported on NX-OS 7K series.
+

aliases: enable_sandbox
+
+
+ ssl_strong_ciphers + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Controls the use of whether strong or weak ciphers are configured. By default, this feature is disabled and weak ciphers are configured. To enable the use of strong ciphers, set the value of this argument to True.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
The state argument controls whether or not the NXAPI feature is configured on the remote device. When the value is present the NXAPI feature configuration is present in the device running-config. When the values is absent the feature configuration is removed from the running-config.
+
+
+ tlsv1_0 + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
Controls the use of the Transport Layer Security version 1.0 is configured. By default, this feature is enabled. To disable the use of TLSV1.0, set the value of this argument to True.
+
+
+ tlsv1_1 + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Controls the use of the Transport Layer Security version 1.1 is configured. By default, this feature is disabled. To enable the use of TLSV1.1, set the value of this argument to True.
+
+
+ tlsv1_2 + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Controls the use of the Transport Layer Security version 1.2 is configured. By default, this feature is disabled. To enable the use of TLSV1.2, set the value of this argument to True.
+
+
+ + +Notes +----- + +.. note:: + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Enable NXAPI access with default configuration + cisco.nxos.nxos_nxapi: + state: present + + - name: Enable NXAPI with no HTTP, HTTPS at port 9443 and sandbox disabled + cisco.nxos.nxos_nxapi: + enable_http: false + https_port: 9443 + https: true + enable_sandbox: false + + - name: remove NXAPI configuration + cisco.nxos.nxos_nxapi: + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ updates + +
+ list +
+ 		always +
Returns the list of commands that need to be pushed into the remote device to satisfy the arguments
+
+
Sample:
+
['no feature nxapi']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_ospf_interfaces_module.rst b/docs/cisco.nxos.nxos_ospf_interfaces_module.rst new file mode 100644 index 000000000..ff69b6e71 --- /dev/null +++ b/docs/cisco.nxos.nxos_ospf_interfaces_module.rst @@ -0,0 +1,1732 @@ +.. _cisco.nxos.nxos_ospf_interfaces_module: + + +******************************* +cisco.nxos.nxos_ospf_interfaces +******************************* + +**OSPF Interfaces Resource Module.** + + +Version added: 1.3.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages OSPF(v2/v3) configuration of interfaces on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of OSPF configuration for interfaces.
+
+
+ address_family + +
+ list + / elements=dictionary +
+ 		+ +
OSPF settings on the interfaces in address-family context.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
Address Family Identifier (AFI) for OSPF settings on the interfaces.
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Authentication settings on the interface.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable authentication on the interface.
+
+
+ key_chain + +
+ string +
+ 		+ +
Authentication password key-chain.
+
+
+ message_digest + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use message-digest authentication.
+
+
+ null_auth + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use null(disable) authentication.
+
+
+ authentication_key + +
+ dictionary +
+ 		+ +
Configure the authentication key for the interface.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 Specifies an UNENCRYPTED authentication key will follow.
+
3 Specifies an 3DES ENCRYPTED authentication key will follow.
+
7 Specifies a Cisco type 7 ENCRYPTED authentication key will follow.
+
+
+ key + +
+ string + / required +
+ 		+ +
Authentication key.
+
Valid values are Cisco type 7 ENCRYPTED password, 3DES ENCRYPTED password and UNENCRYPTED (cleartext) password based on the value of encryption key.
+
+
+ cost + +
+ integer +
+ 		+ +
Cost associated with interface.
+
+
+ dead_interval + +
+ integer +
+ 		+ +
Dead interval value (in seconds).
+
+
+ default_passive_interface + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set passive-interface attribute on this interface to default.
+
This option is mutually exclusive with passive_interface.
+
+
+ hello_interval + +
+ integer +
+ 		+ +
Hello interval value (in seconds).
+
+
+ instance + +
+ integer +
+ 		+ +
Instance identifier.
+
+
+ message_digest_key + +
+ dictionary +
+ 		+ +
Message digest authentication password (key) settings.
+
+
+ encryption + +
+ integer +
+ 		+ +
0 Specifies an UNENCRYPTED ospf password (key) will follow.
+
3 Specifies an 3DES ENCRYPTED ospf password (key) will follow.
+
7 Specifies a Cisco type 7 ENCRYPTED the ospf password (key) will follow.
+
+
+ key + +
+ string + / required +
+ 		+ +
Authentication key.
+
Valid values are Cisco type 7 ENCRYPTED password, 3DES ENCRYPTED password and UNENCRYPTED (cleartext) password based on the value of encryption key.
+
+
+ key_id + +
+ integer + / required +
+ 		+ +
Key ID.
+
+
+ mtu_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable OSPF MTU mismatch detection.
+
+
+ multi_areas + +
+ list + / elements=string +
+ 		+ +
Multi-Areas associated with interface (not tied to OSPF process).
+
Valid values are Area Ids as an integer or IP address.
+
+
+ network + +
+ string +
+ 		+
    Choices: +
  • broadcast
    • +
  • point-to-point
    • +
+ 		+
Network type.
+
+
+ passive_interface + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress routing updates on the interface.
+
This option is mutually exclusive with default_passive_interface.
+
+
+ priority + +
+ integer +
+ 		+ +
Router priority.
+
+
+ processes + +
+ list + / elements=dictionary +
+ 		+ +
Interfaces configuration for an OSPF process.
+
+
+ area + +
+ dictionary +
+ 		+ +
Area associated with interface.
+
+
+ area_id + +
+ string + / required +
+ 		+ +
Area ID in IP address format.
+
+
+ secondaries + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not include secondary IPv4/IPv6 addresses.
+
+
+ multi_areas + +
+ list + / elements=string +
+ 		+ +
Multi-Areas associated with interface.
+
Valid values are Area Ids as an integer or IP address.
+
+
+ process_id + +
+ string + / required +
+ 		+ +
OSPF process tag.
+
+
+ retransmit_interval + +
+ integer +
+ 		+ +
Packet retransmission interval.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Shutdown OSPF on this interface.
+
+
+ transmit_delay + +
+ integer +
+ 		+ +
Packet transmission delay.
+
+
+ name + +
+ string + / required +
+ 		+ +
Name/Identifier of the interface.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section "^interface".
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • parsed
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
+
+ + +Notes +----- + +.. note:: + - Unsupported for Cisco MDS + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # interface Ethernet1/2 + # no switchport + # interface Ethernet1/3 + # no switchport + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_ospf_interfaces: + config: + - name: Ethernet1/1 + address_family: + - afi: ipv4 + processes: + - process_id: '100' + area: + area_id: 1.1.1.1 + secondaries: false + multi_areas: + - 11.11.11.11 + - afi: ipv6 + processes: + - process_id: '200' + area: + area_id: 2.2.2.2 + multi_areas: + - 21.0.0.0 + - process_id: '300' + multi_areas: + - 50.50.50.50 + multi_areas: + - 16.10.10.10 + - name: Ethernet1/2 + address_family: + - afi: ipv4 + authentication: + enable: true + key_chain: test-1 + message_digest_key: + key_id: 10 + encryption: 3 + key: abc01d272be25d29 + cost: 100 + - afi: ipv6 + network: broadcast + shutdown: true + - name: Ethernet1/3 + address_family: + - afi: ipv4 + authentication_key: + encryption: 7 + key: 12090404011C03162E + state: merged + + # Task output: + # ------------ + # before: + # - name: Ethernet1/1 + # - name: Ethernet1/2 + # - name: Ethernet1/3 + # + # commands: + # - interface Ethernet1/1 + # - ip router ospf multi-area 11.11.11.11 + # - ip router ospf 100 area 1.1.1.1 secondaries none + # - ipv6 router ospfv3 multi-area 16.10.10.10 + # - ipv6 router ospfv3 200 area 2.2.2.2 + # - ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - ipv6 router ospfv3 300 multi-area 50.50.50.50 + # - interface Ethernet1/2 + # - ip ospf authentication key-chain test-1 + # - ip ospf authentication + # - ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # - ip ospf cost 100 + # - ospfv3 network broadcast + # - ospfv3 shutdown + # - interface Ethernet1/3 + # - ip ospf authentication-key 7 12090404011C03162E + # + # after: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + + # After state: + # ------------ + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + + # Using replaced + + # Before state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + - name: Replace OSPF configurations of listed interfaces with provided configurations + cisco.nxos.nxos_ospf_interfaces: + config: + - name: Ethernet1/1 + address_family: + - afi: ipv4 + processes: + - process_id: "100" + area: + area_id: 1.1.1.1 + secondaries: false + multi_areas: + - 11.11.11.12 + - name: Ethernet1/3 + state: replaced + + # Task output: + # ------------ + # before: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + # + # commands: + # - interface Ethernet1/1 + # - ip router ospf multi-area 11.11.11.12 + # - no ip router ospf multi-area 11.11.11.11 + # - no ipv6 router ospfv3 multi-area 16.10.10.10 + # - no ipv6 router ospfv3 200 area 2.2.2.2 + # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 + # - interface Ethernet1/3 + # - no ip ospf authentication-key 7 12090404011C03162E + # + # after: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.12 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - name: Ethernet1/3 + # + # After state: + # ------------ + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.12 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + + + # Using overridden + + # Before state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + - name: Override all OSPF interfaces configuration with provided configuration + cisco.nxos.nxos_ospf_interfaces: + config: + - name: Ethernet1/1 + address_family: + - afi: ipv4 + processes: + - process_id: "100" + area: + area_id: 1.1.1.1 + secondaries: false + multi_areas: + - 11.11.11.12 + state: overridden + + # Task output: + # ------------ + # before: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + # + # commands: + # - interface Ethernet1/2 + # - no ip ospf authentication key-chain test-1 + # - no ip ospf authentication + # - no ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # - no ip ospf cost 100 + # - no ospfv3 network broadcast + # - no ospfv3 shutdown + # - interface Ethernet1/3 + # - no ip ospf authentication-key 7 12090404011C03162E + # - interface Ethernet1/1 + # - ip router ospf multi-area 11.11.11.12 + # - no ip router ospf multi-area 11.11.11.11 + # - no ipv6 router ospfv3 multi-area 16.10.10.10 + # - no ipv6 router ospfv3 200 area 2.2.2.2 + # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 + # + # after: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.12 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # name: Ethernet1/1 + # - name: Ethernet1/2 + # - name: Ethernet1/3 + + # After state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.12 + # interface Ethernet1/2 + # no switchport + # interface Ethernet1/3 + # no switchport + + # Using deleted to delete OSPF config of a single interface + + # Before state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + - name: Delete OSPF config from a single interface + cisco.nxos.nxos_ospf_interfaces: + config: + - name: Ethernet1/1 + state: deleted + + # Task output: + # ------------ + # before: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + # + # commands: + # - interface Ethernet1/1 + # - no ip router ospf multi-area 11.11.11.11 + # - no ip router ospf 100 area 1.1.1.1 secondaries none + # - no ipv6 router ospfv3 multi-area 16.10.10.10 + # - no ipv6 router ospfv3 200 area 2.2.2.2 + # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 + # + # after: + # - name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + + + # After state: + # ------------ + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + # Using deleted to delete OSPF config from all interfaces + + # Before state: + # ------------- + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + # ip ospf authentication-key 7 12090404011C03162E + + - name: Delete OSPF config from all interfaces + cisco.nxos.nxos_ospf_interfaces: + state: deleted + + # Task output: + # ------------ + # before: + # - name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + # + # commands: + # - interface Ethernet1/1 + # - no ip router ospf multi-area 11.11.11.11 + # - no ip router ospf 100 area 1.1.1.1 secondaries none + # - no ipv6 router ospfv3 multi-area 16.10.10.10 + # - no ipv6 router ospfv3 200 area 2.2.2.2 + # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 + # - interface Ethernet1/2 + # - no ip ospf authentication key-chain test-1 + # - no ip ospf authentication + # - no ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # - no ip ospf cost 100 + # - no ospfv3 network broadcast + # - no ospfv3 shutdown + # - interface Ethernet1/3 + # - no ip ospf authentication-key 7 12090404011C03162E + # + # after: + # - name: Ethernet1/1 + # - name: Ethernet1/2 + # - name: Ethernet1/3 + + # After state: + # ------------ + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # interface Ethernet1/2 + # no switchport + # interface Ethernet1/3 + # no switchport + + # Using rendered + + - name: >- + Render platform specific configuration lines with state rendered (without + connecting to the device) + cisco.nxos.nxos_ospf_interfaces: + config: + - name: Ethernet1/1 + address_family: + - afi: ipv4 + processes: + - process_id: '100' + area: + area_id: 1.1.1.1 + secondaries: false + multi_areas: + - 11.11.11.11 + - afi: ipv6 + processes: + - process_id: '200' + area: + area_id: 2.2.2.2 + multi_areas: + - 21.0.0.0 + - process_id: '300' + multi_areas: + - 50.50.50.50 + multi_areas: + - 16.10.10.10 + - name: Ethernet1/2 + address_family: + - afi: ipv4 + authentication: + enable: true + key_chain: test-1 + message_digest_key: + key_id: 10 + encryption: 3 + key: abc01d272be25d29 + cost: 100 + - afi: ipv6 + network: broadcast + shutdown: true + - name: Ethernet1/3 + address_family: + - afi: ipv4 + authentication_key: + encryption: 7 + key: 12090404011C03162E + state: rendered + + + # Task Output: + # ------------ + # rendered: + # - interface Ethernet1/1 + # - ip router ospf multi-area 11.11.11.11 + # - ip router ospf 100 area 1.1.1.1 secondaries none + # - ipv6 router ospfv3 multi-area 16.10.10.10 + # - ipv6 router ospfv3 200 area 2.2.2.2 + # - ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - ipv6 router ospfv3 300 multi-area 50.50.50.50 + # - interface Ethernet1/2 + # - ip ospf authentication key-chain test-1 + # - ip ospf authentication + # - ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # - ip ospf cost 100 + # - ospfv3 network broadcast + # - ospfv3 shutdown + # - interface Ethernet1/3 + # - ip ospf authentication-key 7 12090404011C03162E + + # Using parsed + + # parsed.cfg + # ------------ + # interface Ethernet1/1 + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.11 + # ipv6 router ospfv3 200 area 2.2.2.2 + # ipv6 router ospfv3 200 multi-area 21.0.0.0 + # ipv6 router ospfv3 300 multi-area 50.50.50.50 + # ipv6 router ospfv3 multi-area 16.10.10.10 + # interface Ethernet1/2 + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # ip ospf authentication-key 7 12090404011C03162E + + - name: arse externally provided OSPF interfaces config + cisco.nxos.nxos_ospf_interfaces: + running_config: "{{ lookup('file', 'ospf_interfaces.cfg') }}" + state: parsed + + # Task output: + # ------------ + # parsed: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + + # Using gathered + + # On-box config + + # NXOS# show running-config | section ^interface + # interface Ethernet1/1 + # no switchport + # ip router ospf 100 area 1.1.1.1 secondaries none + # ip router ospf multi-area 11.11.11.12 + # interface Ethernet1/2 + # no switchport + # ip ospf authentication + # ip ospf authentication key-chain test-1 + # ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # ip ospf cost 100 + # ospfv3 network broadcast + # ospfv3 shutdown + # interface Ethernet1/3 + # no switchport + + # Task output: + # ------------ + # gathered: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.12 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - name: Ethernet1/3 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ list +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ list +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['interface Ethernet1/1', 'ip router ospf multi-area 11.11.11.11', 'ip router ospf 100 area 1.1.1.1 secondaries none', 'no ipv6 router ospfv3 multi-area 16.10.10.10', 'ipv6 router ospfv3 200 area 2.2.2.2', 'ipv6 router ospfv3 200 multi-area 21.0.0.0', 'ipv6 router ospfv3 300 multi-area 50.50.50.50', 'interface Ethernet1/2', 'no ip ospf authentication key-chain test-1', 'ip ospf authentication']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['interface Ethernet1/1', 'ip router ospf multi-area 11.11.11.11', 'ip router ospf 100 area 1.1.1.1 secondaries none']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_ospfv2_module.rst b/docs/cisco.nxos.nxos_ospfv2_module.rst new file mode 100644 index 000000000..2115d34f2 --- /dev/null +++ b/docs/cisco.nxos.nxos_ospfv2_module.rst @@ -0,0 +1,5458 @@ +.. _cisco.nxos.nxos_ospfv2_module: + + +********************** +cisco.nxos.nxos_ospfv2 +********************** + +**OSPFv2 resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages OSPFv2 configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A list of OSPF process configuration.
+
+
+ processes + +
+ list + / elements=dictionary +
+ 		+ +
A list of OSPF instances' configurations.
+
+
+ areas + +
+ list + / elements=dictionary +
+ 		+ +
Configure properties of OSPF Areas.
+
+
+ area_id + +
+ string + / required +
+ 		+ +
The Area ID in IP Address format.
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Authentication settings for the Area.
+
+
+ message_digest + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use message-digest authentication.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set authentication for the area.
+
+
+ default_cost + +
+ integer +
+ 		+ +
Specify the default cost for default summary LSA.
+
+
+ filter_list + +
+ list + / elements=dictionary +
+ 		+ +
Filter prefixes between OSPF areas.
+
+
+ direction + +
+ string + / required +
+ 		+
    Choices: +
  • in
    • +
  • out
    • +
+ 		+
The direction to apply the route map.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
The Route-map name.
+
+
+ nssa + +
+ dictionary +
+ 		+ +
NSSA settings for the area.
+
+
+ default_information_originate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Originate Type-7 default LSA into NSSA area.
+
+
+ no_redistribution + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send redistributed LSAs into NSSA area.
+
+
+ no_summary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send summary LSAs into NSSA area.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure area as NSSA.
+
+
+ translate + +
+ dictionary +
+ 		+ +
Translate LSA.
+
+
+ type7 + +
+ dictionary +
+ 		+ +
Translate from Type 7 to Type 5.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always translate LSAs
+
+
+ never + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Never translate LSAs
+
+
+ supress_fa + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress forwarding address in translated LSAs.
+
+
+ ranges + +
+ list + / elements=dictionary +
+ 		+ +
Configure an address range for the area.
+
+
+ cost + +
+ integer +
+ 		+ +
Cost to use for the range.
+
+
+ not_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress advertising the specified range.
+
+
+ prefix + +
+ string + / required +
+ 		+ +
IP in Prefix format (x.x.x.x/len)
+
+
+ stub + +
+ dictionary +
+ 		+ +
Settings for configuring the area as a stub.
+
+
+ no_summary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Prevent ABR from sending summary LSAs into stub area.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure the area as a stub.
+
+
+ auto_cost + +
+ dictionary +
+ 		+ +
Calculate OSPF cost according to bandwidth.
+
+
+ reference_bandwidth + +
+ integer + / required +
+ 		+ +
Reference bandwidth used to assign OSPF cost.
+
+
+ unit + +
+ string + / required +
+ 		+
    Choices: +
  • Gbps
    • +
  • Mbps
    • +
+ 		+
Specify in which unit the reference bandwidth is specified.
+
+
+ bfd + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable BFD on all OSPF interfaces.
+
+
+ default_information + +
+ dictionary +
+ 		+ +
Control distribution of default routes.
+
+
+ originate + +
+ dictionary +
+ 		+ +
Distribute a default route.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always advertise a default route.
+
+
+ route_map + +
+ string +
+ 		+ +
Policy to control distribution of default routes
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable distribution of default route.
+
+
+ default_metric + +
+ integer +
+ 		+ +
Specify default metric for redistributed routes.
+
+
+ distance + +
+ integer +
+ 		+ +
Configure the OSPF administrative distance.
+
+
+ flush_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Flush routes on a non-graceful controlled restart.
+
+
+ graceful_restart + +
+ dictionary +
+ 		+ +
Configure graceful restart.
+
+
+ grace_period + +
+ integer +
+ 		+ +
Configure maximum interval to restart gracefully.
+
+
+ helper_disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable helper mode.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable graceful-restart.
+
+
+ isolate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Isolate this router from OSPF perspective.
+
+
+ log_adjacency_changes + +
+ dictionary +
+ 		+ +
Log changes in adjacency state.
+
+
+ detail + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Notify all state changes.
+
+
+ log + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable logging changes in adjacency state.
+
+
+ max_lsa + +
+ dictionary +
+ 		+ +
Feature to limit the number of non-self-originated LSAs.
+
+
+ ignore_count + +
+ integer +
+ 		+ +
Set count on how many times adjacencies can be suppressed.
+
+
+ ignore_time + +
+ integer +
+ 		+ +
Set time during which all adjacencies are suppressed.
+
+
+ max_non_self_generated_lsa + +
+ integer + / required +
+ 		+ +
Set the maximum number of non self-generated LSAs.
+
+
+ reset_time + +
+ integer +
+ 		+ +
Set number of minutes after which ignore-count is reset to zero.
+
+
+ threshold + +
+ integer +
+ 		+ +
Threshold value (%) at which to generate a warning message.
+
+
+ warning_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log a warning message when limit is exceeded.
+
+
+ max_metric + +
+ dictionary +
+ 		+ +
Maximize the cost metric.
+
+
+ router_lsa + +
+ dictionary +
+ 		+ +
Router LSA configuration.
+
+
+ external_lsa + +
+ dictionary +
+ 		+ +
External LSA configuration.
+
+
+ max_metric_value + +
+ integer +
+ 		+ +
Set max metric value for external LSAs.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set external-lsa attribute.
+
+
+ include_stub + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise Max metric for Stub links as well.
+
+
+ on_startup + +
+ dictionary +
+ 		+ +
Effective only at startup.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set on-startup attribute.
+
+
+ wait_for_bgp_asn + +
+ integer +
+ 		+ +
ASN of BGP to wait for.
+
+
+ wait_period + +
+ integer +
+ 		+ +
Wait period in seconds after startup.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set router-lsa attribute.
+
+
+ summary_lsa + +
+ dictionary +
+ 		+ +
Summary LSAs configuration.
+
+
+ max_metric_value + +
+ integer +
+ 		+ +
Max metric value for summary LSAs.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set summary-lsa attribute.
+
+
+ maximum_paths + +
+ integer +
+ 		+ +
Maximum paths per destination.
+
+
+ mpls + +
+ dictionary +
+ 		+ +
OSPF MPLS configuration settings.
+
+
+ traffic_eng + +
+ dictionary +
+ 		+ +
OSPF MPLS Traffic Engineering commands.
+
+
+ areas + +
+ list + / elements=dictionary +
+ 		+ +
List of Area IDs.
+
+
+ area_id + +
+ string +
+ 		+ +
Area Id in ip address format.
+
+
+ multicast_intact + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
MPLS TE multicast support.
+
+
+ router_id + +
+ string +
+ 		+ +
Router ID associated with TE.
+
+
+ name_lookup + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Display OSPF router ids as DNS names.
+
+
+ passive_interface + +
+ dictionary +
+ 		+ +
Suppress routing updates on the interface.
+
+
+ default + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Interfaces passive by default.
+
+
+ process_id + +
+ string + / required +
+ 		+ +
The OSPF process tag.
+
+
+ redistribute + +
+ list + / elements=dictionary +
+ 		+ +
Redistribute information from another routing protocol.
+
+
+ id + +
+ string +
+ 		+ +
The identifier for the protocol specified.
+
+
+ protocol + +
+ string + / required +
+ 		+
    Choices: +
  • bgp
    • +
  • direct
    • +
  • eigrp
    • +
  • isis
    • +
  • lisp
    • +
  • ospf
    • +
  • rip
    • +
  • static
    • +
+ 		+
The name of the protocol.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
The route map policy to constrain redistribution.
+
+
+ rfc1583compatibility + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure 1583 compatibility for external path preferences.
+
+
+ router_id + +
+ string +
+ 		+ +
Set OSPF process router-id.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Shutdown the OSPF protocol instance.
+
+
+ summary_address + +
+ list + / elements=dictionary +
+ 		+ +
Configure route summarization for redistribution.
+
+
+ not_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress advertising the specified summary.
+
+
+ prefix + +
+ string + / required +
+ 		+ +
IP prefix in format x.x.x.x/ml.
+
+
+ tag + +
+ integer +
+ 		+ +
A 32-bit tag value.
+
+
+ table_map + +
+ dictionary +
+ 		+ +
Policy for filtering/modifying OSPF routes before sending them to RIB.
+
+
+ filter + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Block the OSPF routes from being sent to RIB.
+
+
+ name + +
+ string + / required +
+ 		+ +
The Route Map name.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure timer related constants.
+
+
+ lsa_arrival + +
+ integer +
+ 		+ +
Mimimum interval between arrival of a LSA.
+
+
+ lsa_group_pacing + +
+ integer +
+ 		+ +
LSA group refresh/maxage interval.
+
+
+ throttle + +
+ dictionary +
+ 		+ +
Configure throttle related constants.
+
+
+ lsa + +
+ dictionary +
+ 		+ +
Set rate-limiting for LSA generation.
+
+
+ hold_interval + +
+ integer +
+ 		+ +
The hold interval.
+
+
+ max_interval + +
+ integer +
+ 		+ +
The max interval.
+
+
+ start_interval + +
+ integer +
+ 		+ +
The start interval.
+
+
+ spf + +
+ dictionary +
+ 		+ +
Set OSPF SPF timers.
+
+
+ initial_spf_delay + +
+ integer +
+ 		+ +
Initial SPF schedule delay in milliseconds.
+
+
+ max_wait_time + +
+ integer +
+ 		+ +
Maximum wait time between SPF calculations.
+
+
+ min_hold_time + +
+ integer +
+ 		+ +
Minimum hold time between SPF calculations.
+
+
+ vrfs + +
+ list + / elements=dictionary +
+ 		+ +
Configure VRF specific OSPF settings.
+
+
+ areas + +
+ list + / elements=dictionary +
+ 		+ +
Configure properties of OSPF Areas.
+
+
+ area_id + +
+ string + / required +
+ 		+ +
The Area ID in IP Address format.
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Authentication settings for the Area.
+
+
+ message_digest + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use message-digest authentication.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set authentication for the area.
+
+
+ default_cost + +
+ integer +
+ 		+ +
Specify the default cost for default summary LSA.
+
+
+ filter_list + +
+ list + / elements=dictionary +
+ 		+ +
Filter prefixes between OSPF areas.
+
+
+ direction + +
+ string + / required +
+ 		+
    Choices: +
  • in
    • +
  • out
    • +
+ 		+
The direction to apply the route map.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
The Route-map name.
+
+
+ nssa + +
+ dictionary +
+ 		+ +
NSSA settings for the area.
+
+
+ default_information_originate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Originate Type-7 default LSA into NSSA area.
+
+
+ no_redistribution + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send redistributed LSAs into NSSA area.
+
+
+ no_summary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send summary LSAs into NSSA area.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure area as NSSA.
+
+
+ translate + +
+ dictionary +
+ 		+ +
Translate LSA.
+
+
+ type7 + +
+ dictionary +
+ 		+ +
Translate from Type 7 to Type 5.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always translate LSAs
+
+
+ never + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Never translate LSAs
+
+
+ supress_fa + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress forwarding address in translated LSAs.
+
+
+ ranges + +
+ list + / elements=dictionary +
+ 		+ +
Configure an address range for the area.
+
+
+ cost + +
+ integer +
+ 		+ +
Cost to use for the range.
+
+
+ not_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress advertising the specified range.
+
+
+ prefix + +
+ string + / required +
+ 		+ +
IP in Prefix format (x.x.x.x/len)
+
+
+ stub + +
+ dictionary +
+ 		+ +
Settings for configuring the area as a stub.
+
+
+ no_summary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Prevent ABR from sending summary LSAs into stub area.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure the area as a stub.
+
+
+ auto_cost + +
+ dictionary +
+ 		+ +
Calculate OSPF cost according to bandwidth.
+
+
+ reference_bandwidth + +
+ integer + / required +
+ 		+ +
Reference bandwidth used to assign OSPF cost.
+
+
+ unit + +
+ string + / required +
+ 		+
    Choices: +
  • Gbps
    • +
  • Mbps
    • +
+ 		+
Specify in which unit the reference bandwidth is specified.
+
+
+ bfd + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable BFD on all OSPF interfaces.
+
+
+ capability + +
+ dictionary +
+ 		+ +
OSPF capability settings.
+
+
+ vrf_lite + +
+ dictionary +
+ 		+ +
Enable VRF-lite capability settings.
+
+
+ evpn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ethernet VPN.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable VRF-lite support.
+
+
+ default_information + +
+ dictionary +
+ 		+ +
Control distribution of default routes.
+
+
+ originate + +
+ dictionary +
+ 		+ +
Distribute a default route.
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always advertise a default route.
+
+
+ route_map + +
+ string +
+ 		+ +
Policy to control distribution of default routes
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable distribution of default route.
+
+
+ default_metric + +
+ integer +
+ 		+ +
Specify default metric for redistributed routes.
+
+
+ distance + +
+ integer +
+ 		+ +
Configure the OSPF administrative distance.
+
+
+ down_bit_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure a PE router to ignore the DN bit for network summary, external and NSSA external LSA.
+
+
+ graceful_restart + +
+ dictionary +
+ 		+ +
Configure graceful restart.
+
+
+ grace_period + +
+ integer +
+ 		+ +
Configure maximum interval to restart gracefully.
+
+
+ helper_disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable helper mode.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable graceful-restart.
+
+
+ log_adjacency_changes + +
+ dictionary +
+ 		+ +
Log changes in adjacency state.
+
+
+ detail + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Notify all state changes.
+
+
+ log + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable logging changes in adjacency state.
+
+
+ max_lsa + +
+ dictionary +
+ 		+ +
Feature to limit the number of non-self-originated LSAs.
+
+
+ ignore_count + +
+ integer +
+ 		+ +
Set count on how many times adjacencies can be suppressed.
+
+
+ ignore_time + +
+ integer +
+ 		+ +
Set time during which all adjacencies are suppressed.
+
+
+ max_non_self_generated_lsa + +
+ integer + / required +
+ 		+ +
Set the maximum number of non self-generated LSAs.
+
+
+ reset_time + +
+ integer +
+ 		+ +
Set number of minutes after which ignore-count is reset to zero.
+
+
+ threshold + +
+ integer +
+ 		+ +
Threshold value (%) at which to generate a warning message.
+
+
+ warning_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log a warning message when limit is exceeded.
+
+
+ max_metric + +
+ dictionary +
+ 		+ +
Maximize the cost metric.
+
+
+ router_lsa + +
+ dictionary +
+ 		+ +
Router LSA configuration.
+
+
+ external_lsa + +
+ dictionary +
+ 		+ +
External LSA configuration.
+
+
+ max_metric_value + +
+ integer +
+ 		+ +
Set max metric value for external LSAs.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set external-lsa attribute.
+
+
+ include_stub + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise Max metric for Stub links as well.
+
+
+ on_startup + +
+ dictionary +
+ 		+ +
Effective only at startup.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set on-startup attribute.
+
+
+ wait_for_bgp_asn + +
+ integer +
+ 		+ +
ASN of BGP to wait for.
+
+
+ wait_period + +
+ integer +
+ 		+ +
Wait period in seconds after startup.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set router-lsa attribute.
+
+
+ summary_lsa + +
+ dictionary +
+ 		+ +
Summary LSAs configuration.
+
+
+ max_metric_value + +
+ integer +
+ 		+ +
Max metric value for summary LSAs.
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set summary-lsa attribute.
+
+
+ maximum_paths + +
+ integer +
+ 		+ +
Maximum paths per destination.
+
+
+ name_lookup + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Display OSPF router ids as DNS names.
+
+
+ passive_interface + +
+ dictionary +
+ 		+ +
Suppress routing updates on the interface.
+
+
+ default + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Interfaces passive by default.
+
+
+ redistribute + +
+ list + / elements=dictionary +
+ 		+ +
Redistribute information from another routing protocol.
+
+
+ id + +
+ string +
+ 		+ +
The identifier for the protocol specified.
+
+
+ protocol + +
+ string + / required +
+ 		+
    Choices: +
  • bgp
    • +
  • direct
    • +
  • eigrp
    • +
  • isis
    • +
  • lisp
    • +
  • ospf
    • +
  • rip
    • +
  • static
    • +
+ 		+
The name of the protocol.
+
+
+ route_map + +
+ string + / required +
+ 		+ +
The route map policy to constrain redistribution.
+
+
+ rfc1583compatibility + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure 1583 compatibility for external path preferences.
+
+
+ router_id + +
+ string +
+ 		+ +
Set OSPF process router-id.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Shutdown the OSPF protocol instance.
+
+
+ summary_address + +
+ list + / elements=dictionary +
+ 		+ +
Configure route summarization for redistribution.
+
+
+ not_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress advertising the specified summary.
+
+
+ prefix + +
+ string + / required +
+ 		+ +
IP prefix in format x.x.x.x/ml.
+
+
+ tag + +
+ integer +
+ 		+ +
A 32-bit tag value.
+
+
+ table_map + +
+ dictionary +
+ 		+ +
Policy for filtering/modifying OSPF routes before sending them to RIB.
+
+
+ filter + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Block the OSPF routes from being sent to RIB.
+
+
+ name + +
+ string + / required +
+ 		+ +
The Route Map name.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure timer related constants.
+
+
+ lsa_arrival + +
+ integer +
+ 		+ +
Mimimum interval between arrival of a LSA.
+
+
+ lsa_group_pacing + +
+ integer +
+ 		+ +
LSA group refresh/maxage interval.
+
+
+ throttle + +
+ dictionary +
+ 		+ +
Configure throttle related constants.
+
+
+ lsa + +
+ dictionary +
+ 		+ +
Set rate-limiting for LSA generation.
+
+
+ hold_interval + +
+ integer +
+ 		+ +
The hold interval.
+
+
+ max_interval + +
+ integer +
+ 		+ +
The max interval.
+
+
+ start_interval + +
+ integer +
+ 		+ +
The start interval.
+
+
+ spf + +
+ dictionary +
+ 		+ +
Set OSPF SPF timers.
+
+
+ initial_spf_delay + +
+ integer +
+ 		+ +
Initial SPF schedule delay in milliseconds.
+
+
+ max_wait_time + +
+ integer +
+ 		+ +
Maximum wait time between SPF calculations.
+
+
+ min_hold_time + +
+ integer +
+ 		+ +
Minimum hold time between SPF calculations.
+
+
+ vrf + +
+ string + / required +
+ 		+ +
Name/Identifier of the VRF.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section "^router ospf .*".
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • parsed
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 7.0(3)I5(1). + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # nxos-9k-rdo# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_ospfv2: + config: + processes: + - process_id: 100 + router_id: 203.0.113.20 + - process_id: 102 + router_id: 198.51.100.1 + areas: + - area_id: 0.0.0.100 + filter_list: + - route_map: rmap_1 + direction: in + - route_map: rmap_2 + direction: out + ranges: + - prefix: 198.51.100.64/27 + not_advertise: true + - prefix: 198.51.100.96/27 + cost: 120 + - area_id: 0.0.0.101 + authentication: + message_digest: true + redistribute: + - protocol: eigrp + id: 120 + route_map: rmap_1 + - protocol: direct + route_map: ospf102-direct-connect + vrfs: + - vrf: zone1 + router_id: 198.51.100.129 + redistribute: + - protocol: static + route_map: zone1-static-connect + summary_address: + - prefix: 198.51.100.128/27 + tag: 121 + - prefix: 198.51.100.160/27 + areas: + - area_id: 0.0.0.102 + nssa: + default_information_originate: true + no_summary: true + - area_id: 0.0.0.103 + nssa: + no_summary: true + translate: + type7: + always: true + - vrf: zone2 + auto_cost: + reference_bandwidth: 45 + unit: Gbps + state: merged + + # Task output: + # ------------ + # before: {} + # + # commands: + # - router ospf 102 + # - router-id 198.51.100.1 + # - redistribute eigrp 120 route-map rmap_1 + # - redistribute direct route-map ospf102-direct-connect + # - area 0.0.0.100 filter-list route-map rmap_1 in + # - area 0.0.0.100 filter-list route-map rmap_2 out + # - area 0.0.0.100 range 198.51.100.64/27 not-advertise + # - area 0.0.0.100 range 198.51.100.96/27 cost 120 + # - area 0.0.0.101 authentication message-digest + # - vrf zone1 + # - router-id 198.51.100.129 + # - summary-address 198.51.100.128/27 tag 121 + # - summary-address 198.51.100.160/27 + # - redistribute static route-map zone1-static-connect + # - area 0.0.0.102 nssa no-summary default-information-originate + # - area 0.0.0.103 nssa no-summary + # - area 0.0.0.103 nssa translate type7 always + # - vrf zone2 + # - auto-cost reference-bandwidth 45 Gbps + # - router ospf 100 + # - router-id 203.0.113.20 + # + # after: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.100 + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # - cost: 120 + # prefix: 198.51.100.96/27 + # - area_id: 0.0.0.101 + # authentication: + # message_digest: true + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # - area_id: 0.0.0.103 + # nssa: + # no_summary: true + # translate: + # type7: + # always: true + # redistribute: + # - protocol: static + # route_map: zone1-static-connect + # router_id: 198.51.100.129 + # vrf: zone1 + # - auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # vrf: zone2 + # + + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # area 0.0.0.100 range 198.51.100.96/27 cost 120 + # area 0.0.0.101 authentication message-digest + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # area 0.0.0.103 nssa no-summary + # area 0.0.0.103 nssa translate type7 always + # redistribute static route-map zone1-static-connect + # summary-address 198.51.100.128/27 tag 121 + # summary-address 198.51.100.160/27 + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + + # Using replaced + + # Before state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # area 0.0.0.100 range 198.51.100.96/27 cost 120 + # area 0.0.0.101 authentication message-digest + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # area 0.0.0.103 nssa no-summary + # area 0.0.0.103 nssa translate type7 always + # redistribute static route-map zone1-static-connect + # summary-address 198.51.100.128/27 tag 121 + # summary-address 198.51.100.160/27 + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + + - name: >- + Replace device configurations of listed OSPF processes with provided + configurations + cisco.nxos.nxos_ospfv2: + config: + processes: + - process_id: 102 + router_id: 198.51.100.1 + areas: + - area_id: 0.0.0.100 + filter_list: + - route_map: rmap_8 + direction: in + ranges: + - prefix: 198.51.100.64/27 + not_advertise: true + - area_id: 0.0.0.101 + stub: + no_summary: true + redistribute: + - protocol: eigrp + id: 130 + route_map: rmap_1 + - protocol: direct + route_map: ospf102-direct-connect + vrfs: + - vrf: zone1 + router_id: 198.51.100.129 + redistribute: + - protocol: bgp + id: 65563 + route_map: zone1-bgp-connect + areas: + - area_id: 0.0.0.102 + nssa: + default_information_originate: true + no_summary: true + state: replaced + + + # Task output: + # ------------ + # before: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.100 + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # - cost: 120 + # prefix: 198.51.100.96/27 + # - area_id: 0.0.0.101 + # authentication: + # message_digest: true + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # - area_id: 0.0.0.103 + # nssa: + # no_summary: true + # translate: + # type7: + # always: true + # redistribute: + # - protocol: static + # route_map: zone1-static-connect + # router_id: 198.51.100.129 + # vrf: zone1 + # - auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # vrf: zone2 + # + # commands: + # - router ospf 102 + # - redistribute eigrp 130 route-map rmap_1 + # - no redistribute eigrp 120 route-map rmap_1 + # - area 0.0.0.100 filter-list route-map rmap_8 in + # - no area 0.0.0.100 filter-list route-map rmap_2 out + # - no area 0.0.0.100 range 198.51.100.96/27 + # - no area 0.0.0.101 authentication + # - area 0.0.0.101 stub no-summary + # - vrf zone1 + # - no summary-address 198.51.100.128/27 tag 121 + # - no summary-address 198.51.100.160/27 + # - redistribute bgp 65563 route-map zone1-bgp-connect + # - no redistribute static route-map zone1-static-connect + # - no area 0.0.0.103 nssa + # - no area 0.0.0.103 nssa translate type7 always + # - no vrf zone2 + # + # after: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.101 + # stub: + # no_summary: true + # - area_id: 0.0.0.100 + # filter_list: + # - direction: in + # route_map: rmap_8 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "130" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # redistribute: + # - id: "65563" + # protocol: bgp + # route_map: zone1-bgp-connect + # router_id: 198.51.100.129 + # vrf: zone1 + + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # area 0.0.0.101 stub no-summary + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 130 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_8 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # redistribute bgp 65563 route-map zone1-bgp-connect + + # Using overridden + + # Before state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # area 0.0.0.100 range 198.51.100.96/27 cost 120 + # area 0.0.0.101 authentication message-digest + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # area 0.0.0.103 nssa no-summary + # area 0.0.0.103 nssa translate type7 always + # redistribute static route-map zone1-static-connect + # summary-address 198.51.100.128/27 tag 121 + # summary-address 198.51.100.160/27 + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + + - name: Override all OSPF configuration with provided configuration + cisco.nxos.nxos_ospfv2: + config: + processes: + - process_id: 104 + router_id: 203.0.113.20 + - process_id: 102 + router_id: 198.51.100.1 + shutdown: true + state: overridden + + # Task output: + # ------------ + # before: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.100 + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # - cost: 120 + # prefix: 198.51.100.96/27 + # - area_id: 0.0.0.101 + # authentication: + # message_digest: true + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # - area_id: 0.0.0.103 + # nssa: + # no_summary: true + # translate: + # type7: + # always: true + # redistribute: + # - protocol: static + # route_map: zone1-static-connect + # router_id: 198.51.100.129 + # vrf: zone1 + # - auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # vrf: zone2 + # + # commands: + # - no router ospf 100 + # - router ospf 104 + # - router-id 203.0.113.20 + # - router ospf 102 + # - shutdown + # - no redistribute direct route-map ospf102-direct-connect + # - no redistribute eigrp 120 route-map rmap_1 + # - no area 0.0.0.100 filter-list route-map rmap_2 out + # - no area 0.0.0.100 filter-list route-map rmap_1 in + # - no area 0.0.0.100 range 198.51.100.64/27 + # - no area 0.0.0.100 range 198.51.100.96/27 + # - no area 0.0.0.101 authentication + # - no vrf zone1 + # - no vrf zone2 + # + # after: + # processes: + # - process_id: "102" + # router_id: 198.51.100.1 + # shutdown: true + # - process_id: "104" + # router_id: 203.0.113.20 + + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 102 + # router-id 198.51.100.1 + # shutdown + # router ospf 104 + # router-id 203.0.113.20 + + # Using deleted to delete a single OSPF process + + # Before state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # area 0.0.0.100 range 198.51.100.96/27 cost 120 + # area 0.0.0.101 authentication message-digest + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # area 0.0.0.103 nssa no-summary + # area 0.0.0.103 nssa translate type7 always + # redistribute static route-map zone1-static-connect + # summary-address 198.51.100.128/27 tag 121 + # summary-address 198.51.100.160/27 + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + + - name: Delete a single OSPF process + cisco.nxos.nxos_ospfv2: + config: + processes: + - process_id: 102 + state: deleted + + # Task output: + # ------------ + # before: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.100 + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # - cost: 120 + # prefix: 198.51.100.96/27 + # - area_id: 0.0.0.101 + # authentication: + # message_digest: true + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # - area_id: 0.0.0.103 + # nssa: + # no_summary: true + # translate: + # type7: + # always: true + # redistribute: + # - protocol: static + # route_map: zone1-static-connect + # router_id: 198.51.100.129 + # vrf: zone1 + # - auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # vrf: zone2 + # + # commands: + # - no router ospf 102 + # + # after: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + + # Using deleted all OSPF processes from the device + + # Before state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # router ospf 100 + # router-id 203.0.113.20 + # router ospf 102 + # router-id 198.51.100.1 + # redistribute direct route-map ospf102-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 198.51.100.64/27 not-advertise + # area 0.0.0.100 range 198.51.100.96/27 cost 120 + # area 0.0.0.101 authentication message-digest + # vrf zone1 + # router-id 198.51.100.129 + # area 0.0.0.102 nssa no-summary default-information-originate + # area 0.0.0.103 nssa no-summary + # area 0.0.0.103 nssa translate type7 always + # redistribute static route-map zone1-static-connect + # summary-address 198.51.100.128/27 tag 121 + # summary-address 198.51.100.160/27 + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + + - name: Delete all OSPF processes from the device + cisco.nxos.nxos_ospfv2: + state: deleted + + # Task output: + # ------------ + # before: + # processes: + # - process_id: "100" + # router_id: 203.0.113.20 + # - areas: + # - area_id: 0.0.0.100 + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # - cost: 120 + # prefix: 198.51.100.96/27 + # - area_id: 0.0.0.101 + # authentication: + # message_digest: true + # process_id: "102" + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # - area_id: 0.0.0.103 + # nssa: + # no_summary: true + # translate: + # type7: + # always: true + # redistribute: + # - protocol: static + # route_map: zone1-static-connect + # router_id: 198.51.100.129 + # vrf: zone1 + # - auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # vrf: zone2 + # + # commands: + # - no router ospf 100 + # - no router ospf 102 + # + # after: {} + + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^router ospf .*" + # nxos-9k-rdo# + + # Using rendered + + - name: >- + Render platform specific configuration lines (without connecting to the + device) + cisco.nxos.nxos_ospfv2: + config: + processes: + - process_id: 100 + router_id: 203.0.113.20 + - process_id: 102 + router_id: 198.51.100.1 + areas: + - area_id: 0.0.0.100 + filter_list: + - route_map: rmap_1 + direction: in + - route_map: rmap_2 + direction: out + ranges: + - prefix: 198.51.100.64/27 + not_advertise: true + - prefix: 198.51.100.96/27 + cost: 120 + - area_id: 0.0.0.101 + authentication: + message_digest: true + redistribute: + - protocol: eigrp + id: 120 + route_map: rmap_1 + - protocol: direct + route_map: ospf102-direct-connect + vrfs: + - vrf: zone1 + router_id: 198.51.100.129 + redistribute: + - protocol: static + route_map: zone1-static-connect + summary_address: + - prefix: 198.51.100.128/27 + tag: 121 + - prefix: 198.51.100.160/27 + areas: + - area_id: 0.0.0.102 + nssa: + default_information_originate: true + no_summary: true + - area_id: 0.0.0.103 + nssa: + no_summary: true + translate: + type7: + always: true + - vrf: zone2 + auto_cost: + reference_bandwidth: 45 + unit: Gbps + state: rendered + + + # Task output: + # ------------ + # rendered: + # - router ospf 100 + # - router-id 203.0.113.20 + # - router ospf 102 + # - router-id 198.51.100.1 + # - redistribute eigrp 120 route-map rmap_1 + # - redistribute direct route-map ospf102-direct-connect + # - area 0.0.0.100 filter-list route-map rmap_1 in + # - area 0.0.0.100 filter-list route-map rmap_2 out + # - area 0.0.0.100 range 198.51.100.64/27 not-advertise + # - area 0.0.0.100 range 198.51.100.96/27 cost 120 + # - area 0.0.0.101 authentication message-digest + # - vrf zone1 + # - router-id 198.51.100.129 + # - summary-address 198.51.100.128/27 tag 121 + # - summary-address 198.51.100.160/27 + # - redistribute static route-map zone1-static-connect + # - area 0.0.0.102 nssa no-summary default-information-originate + # - area 0.0.0.103 nssa no-summary + # - area 0.0.0.103 nssa translate type7 always + # - vrf zone2 + # - auto-cost reference-bandwidth 45 Gbps + + # Using parsed + + # parsed.cfg + # ------------ + # router ospf 100 + # router-id 192.0.100.1 + # area 0.0.0.101 nssa no-summary no-redistribution + # area 0.0.0.102 stub no-summary + # redistribute direct route-map ospf-direct-connect + # redistribute eigrp 120 route-map rmap_1 + # area 0.0.0.100 filter-list route-map rmap_2 out + # area 0.0.0.100 filter-list route-map rmap_1 in + # area 0.0.0.100 range 192.0.2.0/24 not-advertise + # area 0.0.0.100 range 192.0.3.0/24 cost 120 + # area 0.0.0.100 authentication message-digest + # vrf zone1 + # router-id 192.0.100.2 + # area 0.0.100.1 nssa no-summary no-redistribution + # redistribute static route-map zone1-direct-connect + # summary-address 10.0.0.0/24 tag 120 + # summary-address 11.0.0.0/24 not-advertise + # vrf zone2 + # auto-cost reference-bandwidth 45 Gbps + # down-bit-ignore + # capability vrf-lite evpn + # shutdown + # router ospf 102 + # router-id 198.54.100.1 + # shutdown + # vrf zone2 + # summary-address 192.0.8.0/24 tag 120 + # vrf zone4 + # shutdown + + - name: Parse externally provided OSPFv2 config + cisco.nxos.nxos_ospfv2: + running_config: "{{ lookup('file', 'ospfv2.cfg') }}" + state: parsed + + # Task output: + # ------------ + # parsed: + # processes: + # - process_id: "100" + # areas: + # - area_id: 0.0.0.101 + # nssa: + # no_redistribution: true + # no_summary: true + # - area_id: 0.0.0.102 + # stub: + # no_summary: true + # - area_id: 0.0.0.100 + # authentication: + # message_digest: true + # filter_list: + # - direction: out + # route_map: rmap_2 + # - direction: in + # route_map: rmap_1 + # ranges: + # - not_advertise: true + # prefix: 192.0.2.0/24 + # - cost: 120 + # prefix: 192.0.3.0/24 + # redistribute: + # - protocol: direct + # route_map: ospf-direct-connect + # - id: "120" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 192.0.100.1 + # vrfs: + # - vrf: zone1 + # areas: + # - area_id: 0.0.100.1 + # nssa: + # no_redistribution: true + # no_summary: true + # redistribute: + # - protocol: static + # route_map: zone1-direct-connect + # router_id: 192.0.100.2 + # summary_address: + # - prefix: 10.0.0.0/24 + # tag: 120 + # - not_advertise: true + # prefix: 11.0.0.0/24 + # - vrf: zone2 + # auto_cost: + # reference_bandwidth: 45 + # unit: Gbps + # capability: + # vrf_lite: + # evpn: true + # down_bit_ignore: true + # shutdown: true + # - process_id: "102" + # router_id: 198.54.100.1 + # shutdown: true + # vrfs: + # - vrf: zone2 + # summary_address: + # - prefix: 192.0.8.0/24 + # tag: 120 + # - vrf: zone4 + # shutdown: true + + # Using gathered + + - name: Gather OSPFv2 facts using gathered + cisco.nxos.nxos_ospfv2: + state: gathered + + # Task output: + # ------------ + # gathered: + # processes: + # - process_id: "102" + # areas: + # - area_id: 0.0.0.101 + # stub: + # no_summary: true + # - area_id: 0.0.0.100 + # filter_list: + # - direction: in + # route_map: rmap_8 + # ranges: + # - not_advertise: true + # prefix: 198.51.100.64/27 + # redistribute: + # - protocol: direct + # route_map: ospf102-direct-connect + # - id: "130" + # protocol: eigrp + # route_map: rmap_1 + # router_id: 198.51.100.1 + # vrfs: + # - vrf: zone1 + # areas: + # - area_id: 0.0.0.102 + # nssa: + # default_information_originate: true + # no_summary: true + # redistribute: + # - id: "65563" + # protocol: bgp + # route_map: zone1-bgp-connect + # router_id: 198.51.100.129 + # + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['router ospf 102', 'router-id 198.54.100.1', 'router ospf 100', 'router-id 192.0.100.1', 'redistribute eigrp 120 route-map rmap_1', 'redistribute direct route-map ospf-direct-connect', 'area 0.0.0.100 filter-list route-map rmap_1 in', 'area 0.0.0.100 filter-list route-map rmap_2 out', 'area 0.0.0.100 range 192.0.2.0/24 not-advertise', 'area 0.0.0.100 range 192.0.3.0/24 cost 120', 'vrf zone1', 'router-id 192.0.100.2', 'summary-address 10.0.0.0/24 tag 121', 'summary-address 11.0.0.0/24', 'redistribute static route-map zone1-direct-connect', 'vrf zone2', 'auto-cost reference-bandwidth 45 Gbps', 'capability vrf-lite evpn']
+
+
+ gathered + +
+ dictionary +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ dictionary +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['router ospf 102', 'router-id 198.54.100.1', 'router ospf 100']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_overlay_global_module.rst b/docs/cisco.nxos.nxos_overlay_global_module.rst new file mode 100644 index 000000000..1a1b8d975 --- /dev/null +++ b/docs/cisco.nxos.nxos_overlay_global_module.rst @@ -0,0 +1,120 @@ +.. _cisco.nxos.nxos_overlay_global_module: + + +****************************** +cisco.nxos.nxos_overlay_global +****************************** + +**Configures anycast gateway MAC of the switch.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Configures anycast gateway MAC of the switch. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ anycast_gateway_mac + +
+ string + / required +
+ 		+ +
Anycast gateway mac of the switch.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Default restores params default value + - Supported MAC address format are "E.E.E", "EE-EE-EE-EE-EE-EE", "EE:EE:EE:EE:EE:EE" and "EEEE.EEEE.EEEE" + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_overlay_global: + anycast_gateway_mac: b.b.b + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['fabric forwarding anycast-gateway-mac 000B.000B.000B']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_pim_module.rst b/docs/cisco.nxos.nxos_pim_module.rst new file mode 100644 index 000000000..e19eee567 --- /dev/null +++ b/docs/cisco.nxos.nxos_pim_module.rst @@ -0,0 +1,148 @@ +.. _cisco.nxos.nxos_pim_module: + + +******************* +cisco.nxos.nxos_pim +******************* + +**Manages configuration of a PIM instance.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages configuration of a Protocol Independent Multicast (PIM) instance. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ bfd + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enables BFD on all PIM interfaces.
+
Dependency: ''feature bfd''
+
+
+ ssm_range + +
+ list + / elements=string +
+ 		+ Default:
[]
+ 		+
Configure group ranges for Source Specific Multicast (SSM). Valid values are multicast addresses or the keyword none or keyword default. none removes all SSM group ranges. 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 default, otherwise use the default option.
+
+
+ + +Notes +----- + +.. note:: + - Unsupported for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - 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 Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['ip pim bfd', 'ip pim ssm range 224.0.0.0/8']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_ping_module.rst b/docs/cisco.nxos.nxos_ping_module.rst new file mode 100644 index 000000000..d0d805868 --- /dev/null +++ b/docs/cisco.nxos.nxos_ping_module.rst @@ -0,0 +1,311 @@ +.. _cisco.nxos.nxos_ping_module: + + +******************** +cisco.nxos.nxos_ping +******************** + +**Tests reachability using ping from Nexus switch.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Tests reachability using ping from switch to a remote destination. +- For a general purpose network module, see the :ref:`ansible.netcommon.net_ping ` module. +- For Windows targets, use the :ref:`ansible.windows.win_ping ` module instead. +- For targets running Python, use the :ref:`ansible.builtin.ping ` module instead. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ count + +
+ integer +
+ 		+ Default:
5
+ 		+
Number of packets to send.
+
+
+ dest + +
+ string + / required +
+ 		+ +
IP address or hostname (resolvable by switch) of remote node.
+
+
+ df_bit + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Set the DF bit.
+
+
+ size + +
+ integer +
+ 		+ +
Size of packets to send.
+
+
+ source + +
+ string +
+ 		+ +
Source IP Address or hostname (resolvable by switch)
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • absent
    • +
  • present ←
    • +
+ 		+
Determines if the expected result is success or fail.
+
+
+ vrf + +
+ string +
+ 		+ +
Outgoing VRF.
+
+
+ + +Notes +----- + +.. note:: + - Unsupported for Cisco MDS + - For a general purpose network module, see the :ref:`ansible.netcommon.net_ping ` module. + - For Windows targets, use the :ref:`ansible.windows.win_ping ` module instead. + - For targets running Python, use the :ref:`ansible.builtin.ping ` module instead. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Test reachability to 8.8.8.8 using mgmt vrf + cisco.nxos.nxos_ping: + dest: 8.8.8.8 + vrf: management + host: 68.170.147.165 + + - name: Test reachability to a few different public IPs using mgmt vrf + cisco.nxos.nxos_ping: + dest: "{{ item }}" + vrf: management + host: 68.170.147.165 + with_items: + - 8.8.8.8 + - 4.4.4.4 + - 198.6.1.4 + + - name: Test reachability to 8.8.8.8 using mgmt vrf, size and df-bit + cisco.nxos.nxos_ping: + dest: 8.8.8.8 + df_bit: true + size: 1400 + vrf: management + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
Show the command sent
+
+
Sample:
+
['ping 8.8.8.8 count 2 vrf management']
+
+
+ packet_loss + +
+ string +
+ 		always +
Percentage of packets lost
+
+
Sample:
+
0.00%
+
+
+ packets_rx + +
+ integer +
+ 		always +
Packets successfully received
+
+
Sample:
+
2
+
+
+ packets_tx + +
+ integer +
+ 		always +
Packets successfully transmitted
+
+
Sample:
+
2
+
+
+ rtt + +
+ dictionary +
+ 		always +
Show RTT stats
+
+
Sample:
+
{'avg': 6.264, 'max': 6.564, 'min': 5.978}
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_prefix_lists_module.rst b/docs/cisco.nxos.nxos_prefix_lists_module.rst new file mode 100644 index 000000000..25f343132 --- /dev/null +++ b/docs/cisco.nxos.nxos_prefix_lists_module.rst @@ -0,0 +1,1049 @@ +.. _cisco.nxos.nxos_prefix_lists_module: + + +**************************** +cisco.nxos.nxos_prefix_lists +**************************** + +**Prefix-Lists resource module.** + + +Version added: 2.4.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages prefix-lists configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of prefix-list configuration.
+
+
+ afi + +
+ string +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
The Address Family Identifier (AFI) for the prefix-lists.
+
+
+ prefix_lists + +
+ list + / elements=dictionary +
+ 		+ +
List of prefix-list configurations.
+
+
+ description + +
+ string +
+ 		+ +
Description of the prefix list
+
+
+ entries + +
+ list + / elements=dictionary +
+ 		+ +
List of configurations for the specified prefix-list
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • permit
    • +
  • deny
    • +
+ 		+
Prefix-List permit or deny.
+
+
+ eq + +
+ integer +
+ 		+ +
Exact prefix length to be matched.
+
+
+ ge + +
+ integer +
+ 		+ +
Minimum prefix length to be matched.
+
+
+ le + +
+ integer +
+ 		+ +
Maximum prefix length to be matched.
+
+
+ mask + +
+ string +
+ 		+ +
Explicit match mask.
+
+
+ prefix + +
+ string +
+ 		+ +
IP or IPv6 prefix in A.B.C.D/LEN or A:B::C:D/LEN format.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence Number.
+
+
+ name + +
+ string +
+ 		+ +
Name of the prefix-list.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^ip(.* prefix-list').
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
Refer to examples for more details.
+
With state replaced, for the listed prefix-lists, sequences that are in running-config but not in the task are negated.
+
With state overridden, all prefix-lists that are in running-config but not in the task are negated.
+
Please refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # nxos-9k-rdo# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_prefix_lists: + config: + - afi: ipv4 + prefix_lists: + - name: AllowPrefix + description: allows engineering IPv4 networks + entries: + - sequence: 10 + action: permit + prefix: 192.0.2.0/23 + eq: 24 + - sequence: 20 + action: permit + prefix: 198.51.100.128/26 + - name: DenyPrefix + description: denies lab IPv4 networks + entries: + - sequence: 20 + action: deny + prefix: 203.0.113.0/24 + le: 25 + + - afi: ipv6 + prefix_lists: + - name: AllowIPv6Prefix + description: allows engineering IPv6 networks + entries: + - sequence: 8 + action: permit + prefix: "2001:db8:400::/38" + - sequence: 20 + action: permit + prefix: "2001:db8:8000::/35" + le: 37 + + # Task output + # ------------- + # before: [] + # + # commands: + # - "ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks" + # - "ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38" + # - "ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37" + # - "ip prefix-list AllowPrefix description allows engineering IPv4 networks" + # - "ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" + # - "ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" + # - "ip prefix-list DenyPrefix description denies lab IPv4 networks" + # - "ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25" + # + # after: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + # Using replaced + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Replace prefix-lists configurations of listed prefix-lists with provided configurations + cisco.nxos.nxos_prefix_lists: + config: + - afi: ipv4 + prefix_lists: + - name: AllowPrefix + description: allows engineering IPv4 networks + entries: + - sequence: 10 + action: permit + prefix: 203.0.113.64/27 + + - sequence: 30 + action: permit + prefix: 203.0.113.96/27 + - name: AllowPrefix2Stub + description: allow other engineering IPv4 network + state: replaced + + # Task output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # commands: + # - "no ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" + # - "ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27" + # - "ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27" + # - "no ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" + # - "ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network" + # + # after: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 203.0.113.64/27 + # - sequence: 30 + # action: permit + # prefix: 203.0.113.96/27 + # name: AllowPrefix + # - description: allow other engineering IPv4 network + # name: AllowPrefix2Stub + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27 + # ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27 + # ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + # Using overridden + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Override all prefix-lists configuration with provided configuration + cisco.nxos.nxos_prefix_lists: &id003 + config: + - afi: ipv4 + prefix_lists: + - name: AllowPrefix + description: allows engineering IPv4 networks + entries: + - sequence: 10 + action: permit + prefix: 203.0.113.64/27 + + - sequence: 30 + action: permit + prefix: 203.0.113.96/27 + - name: AllowPrefix2Stub + description: allow other engineering IPv4 network + state: overridden + + # Task output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # commands: + # - "no ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24" + # - "ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27" + # - "ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27" + # - "no ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26" + # - "ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network" + # - "no ip prefix-list DenyPrefix" + # - "no ipv6 prefix-list AllowIPv6Prefix" + # + # after: + # - afi: ipv4 + # prefix_lists: + # - name: AllowPrefix + # description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 203.0.113.64/27 + # + # - sequence: 30 + # action: permit + # prefix: 203.0.113.96/27 + # - name: AllowPrefix2Stub + # description: allow other engineering IPv4 network + # + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 203.0.113.64/27 + # ip prefix-list AllowPrefix seq 30 permit 203.0.113.96/27 + # ip prefix-list AllowPrefix2Stub description allow other engineering IPv4 network + + # Using deleted to delete a all prefix lists for an AFI + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Delete all prefix-lists for an AFI + cisco.nxos.nxos_prefix_lists: + config: + - afi: ipv4 + state: deleted + register: result + + # Task output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # commands: + # - "no ip prefix-list AllowPrefix" + # - "no ip prefix-list DenyPrefix" + # + # after: + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + # Using deleted to delete a single prefix-list + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Delete a single prefix-list + cisco.nxos.nxos_prefix_lists: + config: + - afi: ipv4 + prefix_lists: + - name: AllowPrefix + state: deleted + + # Task output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # commands: + # - "no ip prefix-list AllowPrefix" + # + # after: + # - afi: ipv4 + # prefix_lists: + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + # Using deleted to delete all prefix-lists from the device + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Delete all prefix-lists + cisco.nxos.nxos_prefix_lists: + state: deleted + + # Task output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + # + # commands: + # - "no ip prefix-list AllowPrefix" + # - "no ip prefix-list DenyPrefix" + # - "no ipv6 prefix-list AllowIPv6Prefix" + # + # after: [] + # + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section 'ip(.*) prefix-list' + # nxos-9k-rdo# + + # Using rendered + + - name: Render platform specific configuration lines with state rendered (without connecting to the device) + cisco.nxos.nxos_prefix_lists: &id001 + config: + - afi: ipv4 + prefix_lists: + - name: AllowPrefix + description: allows engineering IPv4 networks + entries: + - sequence: 10 + action: permit + prefix: 192.0.2.0/23 + eq: 24 + - sequence: 20 + action: permit + prefix: 198.51.100.128/26 + - name: DenyPrefix + description: denies lab IPv4 networks + entries: + - sequence: 20 + action: deny + prefix: 203.0.113.0/24 + le: 25 + + - afi: ipv6 + prefix_lists: + - name: AllowIPv6Prefix + description: allows engineering IPv6 networks + entries: + - sequence: 8 + action: permit + prefix: "2001:db8:400::/38" + - sequence: 20 + action: permit + prefix: "2001:db8:8000::/35" + le: 37 + state: rendered + + # Task Output (redacted) + # ----------------------- + # rendered: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + + # Using parsed + + # parsed.cfg + # ------------ + # ip prefix-list AllowPrefix description allows engineering IPv4 networks + # ip prefix-list AllowPrefix seq 10 permit 192.0.2.0/23 eq 24 + # ip prefix-list AllowPrefix seq 20 permit 198.51.100.128/26 + # ip prefix-list DenyPrefix description denies lab IPv4 networks + # ip prefix-list DenyPrefix seq 20 deny 203.0.113.0/24 le 25 + # ipv6 prefix-list AllowIPv6Prefix description allows engineering IPv6 networks + # ipv6 prefix-list AllowIPv6Prefix seq 8 permit 2001:db8:400::/38 + # ipv6 prefix-list AllowIPv6Prefix seq 20 permit 2001:db8:8000::/35 le 37 + + - name: Parse externally provided prefix-lists configuration + register: result + cisco.nxos.nxos_prefix_lists: + running_config: "{{ lookup('file', './parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # - afi: ipv4 + # prefix_lists: + # - description: allows engineering IPv4 networks + # entries: + # - sequence: 10 + # action: permit + # prefix: 192.0.2.0/23 + # eq: 24 + # - sequence: 20 + # action: permit + # prefix: 198.51.100.128/26 + # name: AllowPrefix + # - description: denies lab IPv4 networks + # entries: + # - sequence: 20 + # action: deny + # prefix: 203.0.113.0/24 + # le: 25 + # name: DenyPrefix + # + # - afi: ipv6 + # prefix_lists: + # - description: allows engineering IPv6 networks + # entries: + # - sequence: 8 + # action: permit + # prefix: "2001:db8:400::/38" + # - sequence: 20 + # action: permit + # prefix: "2001:db8:8000::/35" + # le: 37 + # name: AllowIPv6Prefix + + + + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_reboot_module.rst b/docs/cisco.nxos.nxos_reboot_module.rst new file mode 100644 index 000000000..cc94a6762 --- /dev/null +++ b/docs/cisco.nxos.nxos_reboot_module.rst @@ -0,0 +1,123 @@ +.. _cisco.nxos.nxos_reboot_module: + + +********************** +cisco.nxos.nxos_reboot +********************** + +**Reboot a network device.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Reboot a network device. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ confirm + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Safeguard boolean. Set to true if you're sure you want to reboot.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Tested against Cisco MDS NX-OS 9.2(1) + - The module will fail due to timeout issues, but the reboot will be performed anyway. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_reboot: + confirm: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ rebooted + +
+ boolean +
+ 		success +
Whether the device was instructed to reboot.
+
+
Sample:
+
True
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_rollback_module.rst b/docs/cisco.nxos.nxos_rollback_module.rst new file mode 100644 index 000000000..c948e093a --- /dev/null +++ b/docs/cisco.nxos.nxos_rollback_module.rst @@ -0,0 +1,159 @@ +.. _cisco.nxos.nxos_rollback_module: + + +************************ +cisco.nxos.nxos_rollback +************************ + +**Set a checkpoint or rollback to a checkpoint.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module offers the ability to set a configuration checkpoint file or rollback to a configuration checkpoint file on Cisco NXOS switches. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ checkpoint_file + +
+ string +
+ 		+ +
Name of checkpoint file to create. Mutually exclusive with rollback_to.
+
+
+ rollback_to + +
+ string +
+ 		+ +
Name of checkpoint file to rollback to. Mutually exclusive with checkpoint_file.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Sometimes ``transport=nxapi`` may cause a timeout error. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_rollback: + checkpoint_file: backup.cfg + username: '{{ un }}' + password: '{{ pwd }}' + host: '{{ inventory_hostname }}' + - cisco.nxos.nxos_rollback: + rollback_to: backup.cfg + username: '{{ un }}' + password: '{{ pwd }}' + host: '{{ inventory_hostname }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ filename + +
+ string +
+ 		success +
The filename of the checkpoint/rollback file.
+
+
Sample:
+
backup.cfg
+
+
+ status + +
+ string +
+ 		success +
Which operation took place and whether it was successful.
+
+
Sample:
+
rollback executed
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_route_maps_module.rst b/docs/cisco.nxos.nxos_route_maps_module.rst new file mode 100644 index 000000000..bcdf6a426 --- /dev/null +++ b/docs/cisco.nxos.nxos_route_maps_module.rst @@ -0,0 +1,4368 @@ +.. _cisco.nxos.nxos_route_maps_module: + + +************************** +cisco.nxos.nxos_route_maps +************************** + +**Route Maps resource module.** + + +Version added: 2.2.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages route maps configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of route-map configuration.
+
+
+ entries + +
+ list + / elements=dictionary +
+ 		+ +
List of entries (identified by sequence number) for this route-map.
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • deny
    • +
  • permit
    • +
+ 		+
Route map denies or permits set operations.
+
+
+ continue_sequence + +
+ integer +
+ 		+ +
Continue on a different entry within the route-map.
+
+
+ description + +
+ string +
+ 		+ +
Description of the route-map.
+
+
+ match + +
+ dictionary +
+ 		+ +
Match values from routing table.
+
+
+ as_number + +
+ dictionary +
+ 		+ +
Match BGP peer AS number.
+
+
+ as_path_list + +
+ list + / elements=string +
+ 		+ +
AS path access list name.
+
+
+ asn + +
+ list + / elements=string +
+ 		+ +
AS number.
+
+
+ as_path + +
+ list + / elements=string +
+ 		+ +
Match BGP AS path access-list.
+
+
+ community + +
+ dictionary +
+ 		+ +
Match BGP community list.
+
+
+ community_list + +
+ list + / elements=string +
+ 		+ +
Community list.
+
+
+ exact_match + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do exact matching of communities.
+
+
+ evpn + +
+ dictionary +
+ 		+ +
Match BGP EVPN Routes.
+
+
+ route_types + +
+ list + / elements=string +
+ 		+ +
Match route type for evpn route.
+
+
+ extcommunity + +
+ dictionary +
+ 		+ +
Match BGP community list.
+
+
+ exact_match + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do exact matching of extended communities.
+
+
+ extcommunity_list + +
+ list + / elements=string +
+ 		+ +
Extended Community list.
+
+
+ interfaces + +
+ list + / elements=string +
+ 		+ +
Match first hop interface of route.
+
+
+ ip + +
+ dictionary +
+ 		+ +
Configure IP specific information.
+
+
+ address + +
+ dictionary +
+ 		+ +
Match address of route or match packet.
+
+
+ access_list + +
+ string +
+ 		+ +
IP access-list name (for use in route-maps for PBR only).
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ multicast + +
+ dictionary +
+ 		+ +
Match multicast attributes.
+
+
+ group + +
+ dictionary +
+ 		+ +
Multicast Group prefix.
+
Mutually exclusive with group_range.
+
+
+ prefix + +
+ string +
+ 		+ +
IPv4 group prefix.
+
+
+ group_range + +
+ dictionary +
+ 		+ +
Multicast Group address range.
+
Mutually exclusive with group.
+
+
+ first + +
+ string +
+ 		+ +
First Group address.
+
+
+ last + +
+ string +
+ 		+ +
Last Group address.
+
+
+ rp + +
+ dictionary +
+ 		+ +
Rendezvous point.
+
+
+ prefix + +
+ string +
+ 		+ +
IPv4 rendezvous prefix.
+
+
+ rp_type + +
+ string +
+ 		+
    Choices: +
  • ASM
    • +
  • Bidir
    • +
+ 		+
Multicast rendezvous point type.
+
+
+ source + +
+ string +
+ 		+ +
Multicast source address.
+
+
+ next_hop + +
+ dictionary +
+ 		+ +
Match next-hop address of route.
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ route_source + +
+ dictionary +
+ 		+ +
Match advertising source address of route.
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ ipv6 + +
+ dictionary +
+ 		+ +
Configure IPv6 specific information.
+
+
+ address + +
+ dictionary +
+ 		+ +
Match address of route or match packet.
+
+
+ access_list + +
+ string +
+ 		+ +
IP access-list name (for use in route-maps for PBR only).
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ multicast + +
+ dictionary +
+ 		+ +
Match multicast attributes.
+
+
+ group + +
+ dictionary +
+ 		+ +
Multicast Group prefix.
+
Mutually exclusive with group_range.
+
+
+ prefix + +
+ string +
+ 		+ +
IPv4 group prefix.
+
+
+ group_range + +
+ dictionary +
+ 		+ +
Multicast Group address range.
+
Mutually exclusive with group.
+
+
+ first + +
+ string +
+ 		+ +
First Group address.
+
+
+ last + +
+ string +
+ 		+ +
Last Group address.
+
+
+ rp + +
+ dictionary +
+ 		+ +
Rendezvous point.
+
+
+ prefix + +
+ string +
+ 		+ +
IPv4 rendezvous prefix.
+
+
+ rp_type + +
+ string +
+ 		+
    Choices: +
  • ASM
    • +
  • Bidir
    • +
+ 		+
Multicast rendezvous point type.
+
+
+ source + +
+ string +
+ 		+ +
Multicast source address.
+
+
+ next_hop + +
+ dictionary +
+ 		+ +
Match next-hop address of route.
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ route_source + +
+ dictionary +
+ 		+ +
Match advertising source address of route.
+
+
+ prefix_lists + +
+ list + / elements=string +
+ 		+ +
Match entries of prefix-lists.
+
+
+ mac_list + +
+ list + / elements=string +
+ 		+ +
Match entries of mac-lists.
+
+
+ metric + +
+ list + / elements=integer +
+ 		+ +
Match metric of route.
+
+
+ ospf_area + +
+ list + / elements=integer +
+ 		+ +
Match ospf area.
+
+
+ route_types + +
+ list + / elements=string +
+ 		+
    Choices: +
  • external
    • +
  • inter-area
    • +
  • internal
    • +
  • intra-area
    • +
  • level-1
    • +
  • level-2
    • +
  • local
    • +
  • nssa-external
    • +
  • type-1
    • +
  • type-2
    • +
+ 		+
Match route-type of route.
+
+
+ source_protocol + +
+ list + / elements=string +
+ 		+ +
Match source protocol.
+
+
+ tags + +
+ list + / elements=integer +
+ 		+ +
Match tag of route.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence to insert to/delete from existing route-map entry.
+
+
+ set + +
+ dictionary +
+ 		+ +
Set values in destination routing protocol.
+
+
+ as_path + +
+ dictionary +
+ 		+ +
Prepend string for a BGP AS-path attribute.
+
+
+ prepend + +
+ dictionary +
+ 		+ +
Prepend to the AS-Path.
+
+
+ as_number + +
+ list + / elements=string +
+ 		+ +
AS number.
+
+
+ last_as + +
+ integer +
+ 		+ +
Number of last-AS prepends.
+
+
+ tag + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set the tag as an AS-path attribute.
+
+
+ comm_list + +
+ string +
+ 		+ +
Set BGP community list (for deletion).
+
+
+ community + +
+ dictionary +
+ 		+ +
Set BGP community attribute.
+
+
+ additive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Add to existing community.
+
+
+ graceful_shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Graceful Shutdown (well-known community).
+
+
+ internet + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Internet (well-known community).
+
+
+ local_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send outside local AS (well-known community).
+
+
+ no_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not advertise to any peer (well-known community).
+
+
+ no_export + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not export to next AS (well-known community).
+
+
+ number + +
+ list + / elements=string +
+ 		+ +
Community number aa:nn format
+
+
+ dampening + +
+ dictionary +
+ 		+ +
Set BGP route flap dampening parameters.
+
+
+ half_life + +
+ integer +
+ 		+ +
Half-life time for the penalty.
+
+
+ max_suppress_time + +
+ integer +
+ 		+ +
Maximum suppress time for stable route.
+
+
+ start_reuse_route + +
+ integer +
+ 		+ +
Value to start reusing a route.
+
+
+ start_suppress_route + +
+ integer +
+ 		+ +
Value to start suppressing a route.
+
+
+ distance + +
+ dictionary +
+ 		+ +
Configure administrative distance.
+
+
+ igp_ebgp_routes + +
+ integer +
+ 		+ +
Administrative distance for IGP or EBGP routes
+
+
+ internal_routes + +
+ integer +
+ 		+ +
Distance for internal routes.
+
+
+ local_routes + +
+ integer +
+ 		+ +
Distance for local routes.
+
+
+ evpn + +
+ dictionary +
+ 		+ +
Set BGP EVPN Routes.
+
+
+ gateway_ip + +
+ dictionary +
+ 		+ +
Set gateway IP for type 5 EVPN routes.
+
Cannot set ip and use-nexthop in the same route-map sequence.
+
+
+ ip + +
+ string +
+ 		+ +
Gateway IP address.
+
+
+ use_nexthop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use nexthop address as gateway IP.
+
+
+ extcomm_list + +
+ string +
+ 		+ +
Set BGP extcommunity list (for deletion).
+
+
+ extcommunity + +
+ dictionary +
+ 		+ +
Set BGP extcommunity attribute.
+
+
+ rt + +
+ dictionary +
+ 		+ +
Route-Target.
+
+
+ additive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Add to existing rt extcommunity.
+
+
+ extcommunity_numbers + +
+ list + / elements=string +
+ 		+ +
Extcommunity number.
+
Supported formats are ASN2:NN, ASN4:NN, IPV4:NN.
+
+
+ forwarding_address + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set the forwarding address.
+
+
+ ip + +
+ dictionary +
+ 		+ +
Configure IP features.
+
+
+ address + +
+ dictionary +
+ 		+ +
Specify IP address.
+
+
+ prefix_list + +
+ string +
+ 		+ +
Name of prefix list (Max Size 63).
+
+
+ next_hop + +
+ dictionary +
+ 		+ +
Set next-hop IP address (for policy-based routing)
+
+
+ address + +
+ string +
+ 		+ +
Set space-separated list of next-hop IP addresses. Address ordering is important. Also don`t use unnecessary spaces.
+
+
+ drop_on_fail + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Drop packets instead of using default routing when the configured next hop becomes unreachable
+
+
+ force_order + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Enable next-hop ordering as specified in the address parameter.
+
+
+ load_share + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Enable traffic load balancing across a maximum of 32 next-hop addresses
+
+
+ peer_address + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
BGP prefix next hop is set to the local address of the peer.
+
If no next hop is set in the route map, the next hop is set to the one stored in the path.
+
+
+ redist_unchanged + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set for next-hop address conservation for non-local generated routes.
+
Used with redistribute command. Available to maintain BGP routing compliant with RFC 4271 on Nexus OS.
+
+
+ unchanged + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set for next-hop address conservation in eBGP outgoing updates
+
+
+ verify_availability + +
+ list + / elements=dictionary +
+ 		+ +
Set next-hop ip address tracking with IP SLA
+
+
+ address + +
+ string + / required +
+ 		+ +
Set one next-hop address
+
+
+ drop_on_fail + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Drop packets instead of using default routing when the configured next hop becomes unreachable
+
+
+ force_order + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Enable next-hop ordering as specified in the address parameter.
+
+
+ load_share + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Enable traffic load balancing across a maximum of 32 next-hop addresses
+
+
+ track + +
+ integer + / required +
+ 		+ +
Set track number
+
+
+ precedence + +
+ string +
+ 		+ +
Set precedence field.
+
+
+ ipv6 + +
+ dictionary +
+ 		+ +
Configure IPv6 features.
+
+
+ address + +
+ dictionary +
+ 		+ +
Specify IP address.
+
+
+ prefix_list + +
+ string +
+ 		+ +
Name of prefix list (Max Size 63).
+
+
+ precedence + +
+ string +
+ 		+ +
Set precedence field.
+
+
+ label_index + +
+ integer +
+ 		+ +
Set Segment Routing (SR) label index of route.
+
+
+ level + +
+ string +
+ 		+
    Choices: +
  • level-1
    • +
  • level-1-2
    • +
  • level-2
    • +
+ 		+
Where to import route.
+
+
+ local_preference + +
+ integer +
+ 		+ +
BGP local preference path attribute.
+
+
+ metric + +
+ dictionary +
+ 		+ +
Set metric for destination routing protocol.
+
+
+ bandwidth + +
+ integer +
+ 		+ +
Metric value or Bandwidth in Kbits per second (Max Size 11).
+
+
+ igrp_delay_metric + +
+ integer +
+ 		+ +
IGRP delay metric.
+
+
+ igrp_effective_bandwidth_metric + +
+ integer +
+ 		+ +
IGRP Effective bandwidth metric (Loading) 255 is 100%.
+
+
+ igrp_mtu + +
+ integer +
+ 		+ +
IGRP MTU of the path.
+
+
+ igrp_reliability_metric + +
+ integer +
+ 		+ +
IGRP reliability metric where 255 is 100 percent reliable.
+
+
+ metric_type + +
+ string +
+ 		+
    Choices: +
  • external
    • +
  • internal
    • +
  • type-1
    • +
  • type-2
    • +
+ 		+
Type of metric for destination routing protocol.
+
+
+ nssa_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
OSPF NSSA Areas.
+
+
+ null_interface + +
+ string +
+ 		+ +
Output Null interface.
+
+
+ origin + +
+ string +
+ 		+
    Choices: +
  • egp
    • +
  • igp
    • +
  • incomplete
    • +
+ 		+
BGP origin code.
+
+
+ path_selection + +
+ string +
+ 		+
    Choices: +
  • all
    • +
  • backup
    • +
  • best2
    • +
  • multipaths
    • +
+ 		+
Path selection criteria for BGP.
+
+
+ tag + +
+ integer +
+ 		+ +
Tag value for destination routing protocol.
+
+
+ weight + +
+ integer +
+ 		+ +
BGP weight for routing table.
+
+
+ route_map + +
+ string +
+ 		+ +
Route-map name.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^route-map'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
With state replaced, for the listed route-maps, sequences that are in running-config but not in the task are negated.
+
With state overridden, all route-maps that are in running-config but not in the task are negated.
+
Please refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k-rdo# show running-config | section "^route-map" + # nxos-9k-rdo# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_route_maps: + config: + - route_map: rmap1 + entries: + - sequence: 10 + action: permit + description: rmap1-10-permit + match: + ip: + address: + access_list: acl_1 + as_path: Allow40 + as_number: + asn: 65564 + + - sequence: 20 + action: deny + description: rmap1-20-deny + match: + community: + community_list: + - BGPCommunity1 + - BGPCommunity2 + ip: + address: + prefix_lists: + - AllowPrefix1 + - AllowPrefix2 + set: + dampening: + half_life: 30 + start_reuse_route: 1500 + start_suppress_route: 10000 + max_suppress_time: 120 + + - route_map: rmap2 + entries: + - sequence: 20 + action: permit + description: rmap2-20-permit + continue_sequence: 40 + match: + ipv6: + address: + prefix_lists: AllowIPv6Prefix + interfaces: "{{ nxos_int1 }}" + set: + as_path: + prepend: + as_number: + - 65563 + - 65568 + - 65569 + comm_list: BGPCommunity + + - sequence: 40 + action: deny + description: rmap2-40-deny + match: + route_types: + - level-1 + - level-2 + tags: 2 + ip: + multicast: + rp: + prefix: 192.0.2.0/24 + rp_type: ASM + source: 203.0.113.0/24 + group_range: + first: 239.0.0.1 + last: 239.255.255.255 + + - route_map: rmap3 + entries: + - sequence: 10 + description: "*** first stanza ***" + action: permit + set: + ip: + next_hop: + verify_availability: + - address: 3.3.3.3 + track: 1 + - address: 4.4.4.4 + track: 3 + + - sequence: 20 + description: "*** second stanza ***" + action: permit + set: + ip: + next_hop: + address: 6.6.6.6 2.2.2.2 + load_share: true + drop_on_fail: true + + - sequence: 30 + description: "*** third stanza ***" + action: permit + set: + ip: + next_hop: + peer_address: true + + - sequence: 40 + description: "*** fourth stanza ***" + action: permit + set: + ip: + next_hop: + unchanged: true + redist_unchanged: true + state: merged + + # Task output + # ------------- + # before: [] + # + # commands: + # - "route-map rmap1 permit 10" + # - "match as-number 65564" + # - "match as-path Allow40" + # - "match ip address acl_1" + # - "description rmap1-10-permit" + # - "route-map rmap1 deny 20" + # - "match community BGPCommunity1 BGPCommunity2" + # - "match ip address prefix-list AllowPrefix1 AllowPrefix2" + # - "description rmap1-20-deny" + # - "set dampening 30 1500 10000 120" + # - "route-map rmap2 permit 20" + # - "match interface Ethernet1/1" + # - "match ipv6 address prefix-list AllowIPv6Prefix" + # - "set as-path prepend 65563 65568 65569" + # - "description rmap2-20-permit" + # - "continue 40" + # - "set comm-list BGPCommunity delete" + # - "route-map rmap2 deny 40" + # - "match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM" + # - "match route-type level-1 level-2" + # - "match tag 2" + # - "description rmap2-40-deny" + # - "route-map rmap3 permit 10" + # - "description *** first stanza ***" + # - "set ip next-hop verify-availability 3.3.3.3 track 1" + # - "set ip next-hop verify-availability 4.4.4.4 track 3" + # - "route-map rmap3 permit 20" + # - "description *** second stanza ***" + # - "set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail" + # - "route-map rmap3 permit 30" + # - "description *** third stanza ***" + # - "set ip next-hop peer-address" + # - "route-map rmap3 permit 40" + # - "description *** fourth stanza ***" + # - "set ip next-hop unchanged" + # - "set ip next-hop redist-unchanged" + # + # after: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # - route_map: rmap3 + # entries: + # - sequence: 10 + # description: "*** first stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # verify_availability: + # - address: 3.3.3.3 + # track: 1 + # - address: 4.4.4.4 + # track: 3 + # + # - sequence: 20 + # description: "*** second stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # address: 6.6.6.6 2.2.2.2 + # load_share: true + # drop_on_fail: true + # + # - sequence: 30 + # description: "*** third stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # peer_address: true + # + # - sequence: 40 + # description: "*** fourth stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # unchanged: true + # redist_unchanged: true + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + # route-map rmap3 permit 10 + # description *** first stanza *** + # set ip next-hop verify-availability 3.3.3.3 track 1 + # set ip next-hop verify-availability 4.4.4.4 track 3 + # route-map rmap3 permit 20 + # description *** second stanza *** + # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail + # route-map rmap3 permit 30 + # description *** third stanza *** + # set ip next-hop peer-address + # route-map rmap3 permit 40 + # description *** fourth stanza *** + # set ip next-hop unchanged + # set ip next-hop redist-unchanged + # + # Using replaced + # (for the listed route-map(s), sequences that are in running-config but not in the task are negated) + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + # route-map rmap3 permit 10 + # description *** first stanza *** + # set ip next-hop verify-availability 3.3.3.3 track 1 + # set ip next-hop verify-availability 4.4.4.4 track 3 + # route-map rmap3 permit 20 + # description *** second stanza *** + # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail + # route-map rmap3 permit 30 + # description *** third stanza *** + # set ip next-hop peer-address + # route-map rmap3 permit 40 + # description *** fourth stanza *** + # set ip next-hop unchanged + # set ip next-hop redist-unchanged + # + - name: Replace route-maps configurations of listed route-maps with provided configurations + cisco.nxos.nxos_route_maps: + config: + - route_map: rmap1 + entries: + - sequence: 20 + action: deny + description: rmap1-20-deny + match: + community: + community_list: + - BGPCommunity4 + - BGPCommunity5 + ip: + address: + prefix_lists: + - AllowPrefix1 + set: + community: + local_as: true + + - route_map: rmap3 + entries: + - sequence: 10 + description: "*** first stanza ***" + action: permit + set: + ip: + next_hop: + verify_availability: + - address: 3.3.3.3 + track: 1 + - sequence: 20 + description: "*** second stanza ***" + action: permit + set: + ip: + next_hop: + peer_address: true + - sequence: 30 + description: "*** third stanza ***" + action: permit + set: + ip: + next_hop: + address: 6.6.6.6 2.2.2.2 + load_share: true + drop_on_fail: true + state: replaced + + # Task output + # ------------- + # before: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # - route_map: rmap3 + # entries: + # - sequence: 10 + # description: "*** first stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # verify_availability: + # - address: 3.3.3.3 + # track: 1 + # - address: 4.4.4.4 + # track: 3 + # + # - sequence: 20 + # description: "*** second stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # address: 6.6.6.6 2.2.2.2 + # load_share: true + # drop_on_fail: true + # + # - sequence: 30 + # description: "*** third stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # peer_address: true + # + # - sequence: 40 + # description: "*** fourth stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # unchanged: true + # redist_unchanged: true + # + # commands: + # - no route-map rmap1 permit 10 + # - route-map rmap1 deny 20 + # - no match community BGPCommunity1 BGPCommunity2 + # - match community BGPCommunity4 BGPCommunity5 + # - no match ip address prefix-list AllowPrefix1 AllowPrefix2 + # - match ip address prefix-list AllowPrefix1 + # - no set dampening 30 1500 10000 120 + # - set community local-AS + # - route-map rmap3 permit 10 + # - no set ip next-hop verify-availability 4.4.4.4 track 3 + # - route-map rmap3 permit 20 + # - no set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail + # - set ip next-hop peer-address + # - route-map rmap3 permit 30 + # - no set ip next-hop peer-address + # - set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail + # - no route-map rmap3 permit 40 + # + # after: + # - route_map: rmap1 + # entries: + # - sequence: 20 + # action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity4 + # - BGPCommunity5 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # set: + # community: + # local_as: true + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # - route_map: rmap3 + # entries: + # - sequence: 10 + # description: "*** first stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # verify_availability: + # - address: 3.3.3.3 + # track: 1 + # - sequence: 20 + # description: "*** second stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # peer_address: true + # - sequence: 30 + # description: "*** third stanza ***" + # action: permit + # set: + # ip: + # next_hop: + # address: 6.6.6.6 2.2.2.2 + # load_share: true + # drop_on_fail: true + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 deny 20 + # description rmap1-20-deny + # match community BGPCommunity4 BGPCommunity5 + # match ip address prefix-list AllowPrefix1 + # set community local-AS + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + # route-map rmap3 permit 10 + # description *** first stanza *** + # set ip next-hop verify-availability 3.3.3.3 track 1 + # route-map rmap3 permit 20 + # description *** second stanza *** + # set ip next-hop peer-address + # route-map rmap3 permit 30 + # description *** third stanza *** + # set ip next-hop 6.6.6.6 2.2.2.2 load-share drop-on-fail + + # Using overridden + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + + - name: Override all route-maps configuration with provided configuration + cisco.nxos.nxos_route_maps: + config: + - route_map: rmap1 + entries: + - sequence: 20 + action: deny + description: rmap1-20-deny + match: + community: + community_list: + - BGPCommunity4 + - BGPCommunity5 + ip: + address: + prefix_lists: + - AllowPrefix1 + set: + community: + local_as: true + state: overridden + + # Task output + # ------------- + # before: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # commands: + # - no route-map rmap1 permit 10 + # - route-map rmap1 deny 20 + # - no match community BGPCommunity1 BGPCommunity2 + # - match community BGPCommunity4 BGPCommunity5 + # - no match ip address prefix-list AllowPrefix1 AllowPrefix2 + # - match ip address prefix-list AllowPrefix1 + # - no set dampening 30 1500 10000 120 + # - set community local-AS + # - no route-map rmap2 permit 20 + # - no route-map rmap2 deny 40 + # + # after: + # - route_map: rmap1 + # entries: + # - sequence: 20 + # action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity4 + # - BGPCommunity5 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # set: + # community: + # local_as: true + # + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^route-map" + # route-map rmap1 deny 20 + # description rmap1-20-deny + # match community BGPCommunity4 BGPCommunity5 + # match ip address prefix-list AllowPrefix1 + # set community local-AS + + # Using deleted to delete a single route-map + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + + - name: Delete single route-map + cisco.nxos.nxos_route_maps: + config: + - route_map: rmap1 + state: deleted + + # Task output + # ------------- + # before: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # commands: + # - no route-map rmap1 permit 10 + # - no route-map rmap1 deny 20 + # + # after: + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^route-map" + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + + # Using deleted to delete all route-maps from the device running-config + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + + - name: Delete all route-maps + cisco.nxos.nxos_route_maps: + state: deleted + + # Task output + # ------------- + # before: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + # + # commands: + # - no route-map rmap1 permit 10 + # - no route-map rmap1 deny 20 + # - no route-map rmap2 permit 20 + # - no route-map rmap2 deny 40 + # + # after: [] + # + # After state: + # ------------ + # nxos-9k-rdo# sh running-config | section "^route-map" + + - name: Render platform specific configuration lines with state rendered (without connecting to the device) + cisco.nxos.nxos_route_maps: + config: + - route_map: rmap1 + entries: + - sequence: 10 + action: permit + description: rmap1-10-permit + match: + ip: + address: + access_list: acl_1 + as_path: Allow40 + as_number: + asn: 65564 + + - sequence: 20 + action: deny + description: rmap1-20-deny + match: + community: + community_list: + - BGPCommunity1 + - BGPCommunity2 + ip: + address: + prefix_lists: + - AllowPrefix1 + - AllowPrefix2 + set: + dampening: + half_life: 30 + start_reuse_route: 1500 + start_suppress_route: 10000 + max_suppress_time: 120 + + - route_map: rmap2 + entries: + - sequence: 20 + action: permit + description: rmap2-20-permit + continue_sequence: 40 + match: + ipv6: + address: + prefix_lists: AllowIPv6Prefix + interfaces: "{{ nxos_int1 }}" + set: + as_path: + prepend: + as_number: + - 65563 + - 65568 + - 65569 + comm_list: BGPCommunity + + - sequence: 40 + action: deny + description: rmap2-40-deny + match: + route_types: + - level-1 + - level-2 + tags: 2 + ip: + multicast: + rp: + prefix: 192.0.2.0/24 + rp_type: ASM + source: 203.0.113.0/24 + group_range: + first: 239.0.0.1 + last: 239.255.255.255 + state: rendered + + # Task Output (redacted) + # ----------------------- + # rendered: + # - "route-map rmap1 permit 10" + # - "match as-number 65564" + # - "match as-path Allow40" + # - "match ip address acl_1" + # - "description rmap1-10-permit" + # - "route-map rmap1 deny 20" + # - "match community BGPCommunity1 BGPCommunity2" + # - "match ip address prefix-list AllowPrefix1 AllowPrefix2" + # - "description rmap1-20-deny" + # - "set dampening 30 1500 10000 120" + # - "route-map rmap2 permit 20" + # - "match interface Ethernet1/1" + # - "match ipv6 address prefix-list AllowIPv6Prefix" + # - "set as-path prepend 65563 65568 65569" + # - "description rmap2-20-permit" + # - "continue 40" + # - "set comm-list BGPCommunity delete" + # - "route-map rmap2 deny 40" + # - "match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM" + # - "match route-type level-1 level-2" + # - "match tag 2" + # - "description rmap2-40-deny" + + # Using parsed + + # parsed.cfg + # ------------ + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap1 deny 20 + # match community BGPCommunity1 BGPCommunity2 + # match ip address prefix-list AllowPrefix1 AllowPrefix2 + # description rmap1-20-deny + # set dampening 30 1500 10000 120 + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + # route-map rmap2 deny 40 + # match ip multicast source 203.0.113.0/24 group-range 239.0.0.1 to 239.255.255.255 rp 192.0.2.0/24 rp-type ASM + # match route-type level-1 level-2 + # match tag 2 + # description rmap2-40-deny + + - name: Parse externally provided route-maps configuration + cisco.nxos.nxos_route_maps: + running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - action: deny + # description: rmap1-20-deny + # match: + # community: + # community_list: + # - BGPCommunity1 + # - BGPCommunity2 + # ip: + # address: + # prefix_lists: + # - AllowPrefix1 + # - AllowPrefix2 + # sequence: 20 + # set: + # dampening: + # half_life: 30 + # max_suppress_time: 120 + # start_reuse_route: 1500 + # start_suppress_route: 10000 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + # - action: deny + # description: rmap2-40-deny + # match: + # ip: + # multicast: + # group_range: + # first: 239.0.0.1 + # last: 239.255.255.255 + # rp: + # prefix: 192.0.2.0/24 + # rp_type: ASM + # source: 203.0.113.0/24 + # route_types: + # - level-1 + # - level-2 + # tags: + # - 2 + # sequence: 40 + + # Using gathered + + # Existing route-map config + # --------------------------- + # nxos-9k-rdo# show running-config | section "^route-map" + # route-map rmap1 permit 10 + # match as-number 65564 + # match as-path Allow40 + # match ip address acl_1 + # description rmap1-10-permit + # route-map rmap2 permit 20 + # match interface Ethernet1/1 + # match ipv6 address prefix-list AllowIPv6Prefix + # set as-path prepend 65563 65568 65569 + # description rmap2-20-permit + # continue 40 + # set comm-list BGPCommunity delete + + - name: Gather route-maps facts using gathered + cisco.nxos.nxos_route_maps: + state: gathered + + # gathered: + # - route_map: rmap1 + # entries: + # - action: permit + # description: rmap1-10-permit + # match: + # as_number: + # asn: + # - '65564' + # as_path: + # - Allow40 + # ip: + # address: + # access_list: acl_1 + # sequence: 10 + # + # - route_map: rmap2 + # entries: + # - action: permit + # continue_sequence: 40 + # description: rmap2-20-permit + # match: + # interfaces: + # - Ethernet1/1 + # ipv6: + # address: + # prefix_lists: + # - AllowIPv6Prefix + # sequence: 20 + # set: + # as_path: + # prepend: + # as_number: + # - '65563' + # - '65568' + # - '65569' + # comm_list: BGPCommunity + # + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ before + +
+ dictionary +
+ 		always +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format + of the parameters above.
+
+
+ commands + +
+ list +
+ 		always +
The set of commands pushed to the remote device.
+
+
Sample:
+
['route-map rmap1 permit 10', 'match as-number 65564', 'match as-path Allow40', 'match ip address acl_1', 'description rmap1-10-permit', 'route-map rmap1 deny 20', 'match community BGPCommunity1 BGPCommunity2']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_rpm_module.rst b/docs/cisco.nxos.nxos_rpm_module.rst new file mode 100644 index 000000000..79d616a59 --- /dev/null +++ b/docs/cisco.nxos.nxos_rpm_module.rst @@ -0,0 +1,226 @@ +.. _cisco.nxos.nxos_rpm_module: + + +******************* +cisco.nxos.nxos_rpm +******************* + +**Install patch or feature rpms on Cisco NX-OS devices.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Install software maintenance upgrade (smu) RPMS and 3rd party RPMS on Cisco NX-OS devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ aggregate + +
+ list + / elements=dictionary +
+ 		+ +
List of RPM/patch definitions.
+
+
+ file_system + +
+ string +
+ 		+ +
The remote file system of the device. If omitted, devices that support a file_system parameter will use their default values.
+
+
+ pkg + +
+ string + / required +
+ 		+ +
Name of the RPM package.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
If the state is present, the rpm will be installed, If the state is absent, it will be removed.
+
+
+ file_system + +
+ string +
+ 		+ Default:
"bootflash"
+ 		+
The remote file system of the device. If omitted, devices that support a file_system parameter will use their default values.
+
+
+ pkg + +
+ string +
+ 		+ +
Name of the RPM package.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
If the state is present, the rpm will be installed, If the state is absent, it will be removed.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.0(3)I2(5), 7.0(3)I4(6), 7.0(3)I5(3), 7.0(3)I6(1), 7.0(3)I7(3) + - Unsupported for Cisco MDS + - For patches, the minimum platform version needed is 7.0(3)I2(5) + - For feature rpms, the minimum platform version needed is 7.0(3)I6(1) + - The module manages the entire RPM lifecycle (Add, activate, commit, deactivate, remove) + - For reload patches, this module is NOT idempotent until the patch is committed. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_rpm: + pkg: nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000.rpm + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['install add bootflash:nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000.rpm forced', 'install activate nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000 forced', 'install commit nxos.sample-n9k_ALL-1.0.0-7.0.3.I7.3.lib32_n9000']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Sai Chintalapudi (@saichint) diff --git a/docs/cisco.nxos.nxos_snapshot_module.rst b/docs/cisco.nxos.nxos_snapshot_module.rst new file mode 100644 index 000000000..fe89b5b7b --- /dev/null +++ b/docs/cisco.nxos.nxos_snapshot_module.rst @@ -0,0 +1,363 @@ +.. _cisco.nxos.nxos_snapshot_module: + + +************************ +cisco.nxos.nxos_snapshot +************************ + +**Manage snapshots of the running states of selected features.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Create snapshots of the running states of selected features, add new show commands for snapshot creation, delete and compare existing snapshots. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ action + +
+ string + / required +
+ 		+
    Choices: +
  • add
    • +
  • compare
    • +
  • create
    • +
  • delete
    • +
  • delete_all
    • +
+ 		+
Define what snapshot action the module would perform.
+
+
+ compare_option + +
+ string +
+ 		+
    Choices: +
  • summary
    • +
  • ipv4routes
    • +
  • ipv6routes
    • +
+ 		+
Snapshot options to be used when action=compare.
+
+
+ comparison_results_file + +
+ string +
+ 		+ +
Name of the file where snapshots comparison will be stored when action=compare.
+
+
+ description + +
+ string +
+ 		+ +
Snapshot description to be used when action=create.
+
+
+ element_key1 + +
+ string +
+ 		+ +
Specify the tags used to distinguish among row entries, to be used when action=add.
+
+
+ element_key2 + +
+ string +
+ 		+ +
Specify the tags used to distinguish among row entries, to be used when action=add.
+
+
+ path + +
+ string +
+ 		+ Default:
"./"
+ 		+
Specify the path of the file where new created snapshot or snapshots comparison will be stored, to be used when action=create and save_snapshot_locally=true or action=compare.
+
+
+ row_id + +
+ string +
+ 		+ +
Specifies the tag of each row entry of the show command's XML output, to be used when action=add.
+
+
+ save_snapshot_locally + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Specify to locally store a new created snapshot, to be used when action=create.
+
+
+ section + +
+ string +
+ 		+ +
Used to name the show command output, to be used when action=add.
+
+
+ show_command + +
+ string +
+ 		+ +
Specify a new show command, to be used when action=add.
+
+
+ snapshot1 + +
+ string +
+ 		+ +
First snapshot to be used when action=compare.
+
+
+ snapshot2 + +
+ string +
+ 		+ +
Second snapshot to be used when action=compare.
+
+
+ snapshot_name + +
+ string +
+ 		+ +
Snapshot name, to be used when action=create or action=delete.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - ``transport=cli`` may cause timeout errors. + - The ``element_key1`` and ``element_key2`` parameter specify the tags used to distinguish among row entries. In most cases, only the element_key1 parameter needs to specified to be able to distinguish among row entries. + - ``action=compare`` will always store a comparison report on a local file. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Create a snapshot and store it locally + - cisco.nxos.nxos_snapshot: + action: create + snapshot_name: test_snapshot + description: Done with Ansible + save_snapshot_locally: true + path: /home/user/snapshots/ + + # Delete a snapshot + - cisco.nxos.nxos_snapshot: + action: delete + snapshot_name: test_snapshot + + # Delete all existing snapshots + - cisco.nxos.nxos_snapshot: + action: delete_all + + # Add a show command for snapshots creation + - cisco.nxos.nxos_snapshot: + section: myshow + show_command: show ip interface brief + row_id: ROW_intf + element_key1: intf-name + + # Compare two snapshots + - cisco.nxos.nxos_snapshot: + action: compare + snapshot1: pre_snapshot + snapshot2: post_snapshot + comparison_results_file: compare_snapshots.txt + compare_option: summary + path: ../snapshot_reports/ + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		verbose mode +
commands sent to the device
+
+
Sample:
+
['snapshot create post_snapshot Post-snapshot']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_community_module.rst b/docs/cisco.nxos.nxos_snmp_community_module.rst new file mode 100644 index 000000000..584d2d772 --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_community_module.rst @@ -0,0 +1,201 @@ +.. _cisco.nxos.nxos_snmp_community_module: + + +****************************** +cisco.nxos.nxos_snmp_community +****************************** + +**(deprecated, removed after 2024-01-01) Manages SNMP community configs.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated modules released with more functionality +:Alternative: nxos_snmp_server + + + +Synopsis +-------- +- Manages SNMP community configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ access + +
+ string +
+ 		+
    Choices: +
  • ro
    • +
  • rw
    • +
+ 		+
Access type for community.
+
+
+ acl + +
+ string +
+ 		+ +
ACL name to filter snmp requests or keyword 'default'.
+
+
+ community + +
+ string + / required +
+ 		+ +
Case-sensitive community string.
+
+
+ group + +
+ string +
+ 		+ +
Group to which the community belongs.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure snmp community is configured + - cisco.nxos.nxos_snmp_community: + community: TESTING7 + group: network-operator + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['snmp-server community TESTING7 group network-operator']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_host_module.rst b/docs/cisco.nxos.nxos_snmp_host_module.rst new file mode 100644 index 000000000..8aef0b21d --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_host_module.rst @@ -0,0 +1,288 @@ +.. _cisco.nxos.nxos_snmp_host_module: + + +************************* +cisco.nxos.nxos_snmp_host +************************* + +**(deprecated, removed after 2024-01-01) Manages SNMP host configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated modules released with more functionality +:Alternative: nxos_snmp_server + + + +Synopsis +-------- +- Manages SNMP host configuration parameters. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ community + +
+ string +
+ 		+ +
Community string or v3 username.
+
+
+ snmp_host + +
+ string + / required +
+ 		+ +
IP address of hostname of target host.
+
+
+ snmp_type + +
+ string +
+ 		+
    Choices: +
  • trap
    • +
  • inform
    • +
+ 		+
type of message to send to host. If this is not specified, trap type is used.
+
+
+ src_intf + +
+ string +
+ 		+ +
Source interface. Must be fully qualified interface name. If state = absent, the interface is removed.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource. If state = present, the host is added to the configuration. If only vrf and/or vrf_filter and/or src_intf are given, they will be added to the existing host configuration. If state = absent, the host is removed if community parameter is given. It is possible to remove only vrf and/or src_int and/or vrf_filter by providing only those parameters and no community parameter.
+
+
+ udp + +
+ string +
+ 		+ Default:
"162"
+ 		+
UDP port number (0-65535).
+
+
+ v3 + +
+ string +
+ 		+
    Choices: +
  • noauth
    • +
  • auth
    • +
  • priv
    • +
+ 		+
Use this when verion is v3. SNMPv3 Security level.
+
+
+ version + +
+ string +
+ 		+
    Choices: +
  • v1
    • +
  • v2c
    • +
  • v3
    • +
+ 		+
SNMP version. If this is not specified, v1 is used.
+
+
+ vrf + +
+ string +
+ 		+ +
VRF to use to source traffic to source. If state = absent, the vrf is removed.
+
+
+ vrf_filter + +
+ string +
+ 		+ +
Name of VRF to filter. If state = absent, the vrf is removed from the filter.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - ``state=absent`` removes the host configuration if it is configured. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure snmp host is configured + - cisco.nxos.nxos_snmp_host: + snmp_host: 192.0.2.3 + community: TESTING + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['snmp-server host 192.0.2.3 filter-vrf another_test_vrf']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_location_module.rst b/docs/cisco.nxos.nxos_snmp_location_module.rst new file mode 100644 index 000000000..06f564693 --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_location_module.rst @@ -0,0 +1,156 @@ +.. _cisco.nxos.nxos_snmp_location_module: + + +***************************** +cisco.nxos.nxos_snmp_location +***************************** + +**(deprecated, removed after 2024-01-01) Manages SNMP location information.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated modules released with more functionality +:Alternative: nxos_snmp_server + + + +Synopsis +-------- +- Manages SNMP location configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ location + +
+ string + / required +
+ 		+ +
Location information.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure snmp location is configured + - cisco.nxos.nxos_snmp_location: + location: Test + state: present + + # ensure snmp location is not configured + - cisco.nxos.nxos_snmp_location: + location: Test + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['snmp-server location New_Test']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_snmp_server_module.rst b/docs/cisco.nxos.nxos_snmp_server_module.rst new file mode 100644 index 000000000..126e16341 --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_server_module.rst @@ -0,0 +1,4474 @@ +.. _cisco.nxos.nxos_snmp_server_module: + + +*************************** +cisco.nxos.nxos_snmp_server +*************************** + +**SNMP Server resource module.** + + +Version added: 2.8.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages SNMP server configuration on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A dict of SNMP server configuration
+
+
+ aaa_user + +
+ dictionary +
+ 		+ +
Set duration for which aaa-cached snmp user exists.
+
+
+ cache_timeout + +
+ integer +
+ 		+ +
Timeout for which aaa-cached user exists(in secs).
+
+
+ communities + +
+ list + / elements=dictionary +
+ 		+ +
Set community string and access privs.
+
+
+ group + +
+ string +
+ 		+ +
Group to which the community belongs.
+
+
+ name + +
+ string +
+ 		+ +
SNMP community string (Max Size 32).
+

aliases: community
+
+
+ ro + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Read-only access with this community string.
+
+
+ rw + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Read-write access with this community string.
+
+
+ use_ipv4acl + +
+ string +
+ 		+ +
Specify IPv4 ACL, the ACL name specified must be IPv4 ACL.
+
This option is unsupported on MDS switches.
+
+
+ use_ipv6acl + +
+ string +
+ 		+ +
Specify IPv6 ACL, the ACL name specified after must be IPv6 ACL.
+
This option is unsupported on MDS switches.
+
+
+ contact + +
+ string +
+ 		+ +
Modify sysContact.
+
+
+ context + +
+ dictionary +
+ 		+ +
SNMP context to be mapped.
+
+
+ instance + +
+ string +
+ 		+ +
Name of the protocol instance (Max Size 32).
+
+
+ name + +
+ string +
+ 		+ +
Name of the SNMP context (Max Size 32).
+
+
+ topology + +
+ string +
+ 		+ +
Topology associated with the SNMP context.
+
+
+ vrf + +
+ string +
+ 		+ +
VRF associated with the SNMP context.
+
This option is unsupported on MDS switches.
+
+
+ counter + +
+ dictionary +
+ 		+ +
Configure port counter configuration.
+
This option is unsupported on MDS switches.
+
+
+ cache + +
+ dictionary +
+ 		+ +
Port stats cache.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable port stats cache.
+
+
+ timeout + +
+ integer +
+ 		+ +
Timeout for which cached port stats exists(in secs).
+
+
+ drop + +
+ dictionary +
+ 		+ +
Silently drop unknown v3 user packets.
+
This option is unsupported on MDS switches.
+
+
+ unknown_engine_id + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Unknown v3 engine id.
+
+
+ unknown_user + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Unknown v3 user.
+
+
+ engine_id + +
+ dictionary +
+ 		+ +
Configure a local SNMPv3 engineID.
+
This option is unsupported on MDS switches.
+
+
+ local + +
+ string +
+ 		+ +
EngineID of the local agent.
+
+
+ global_enforce_priv + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Globally enforce privacy for all the users.
+
+
+ hosts + +
+ list + / elements=dictionary +
+ 		+ +
Specify hosts to receive SNMP notifications.
+
SNMP hosts config lines that appear separately in running-config must be added as individual dictionaries.
+
+
+ auth + +
+ string +
+ 		+ +
Use the SNMPv3 authNoPriv Security Level.
+
+
+ community + +
+ string +
+ 		+ +
SNMP community string or SNMPv3 user name (Max Size 32).
+
+
+ filter_vrf + +
+ string +
+ 		+ +
Filters notifications to the notification host receiver based on the configured VRF.
+
This option is unsupported on MDS switches.
+
+
+ host + +
+ string +
+ 		+ +
IPv4 or IPv6 address or DNS Name of SNMP notification host.
+
+
+ informs + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Inform messages to this host.
+
+
+ priv + +
+ string +
+ 		+ +
Use the SNMPv3 authPriv Security Level.
+
+
+ source_interface + +
+ string +
+ 		+ +
Source interface to be used for sending out SNMP notifications to this host.
+
+
+ traps + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Send Traps messages to this host.
+
+
+ udp_port + +
+ integer +
+ 		+ +
The notification host's UDP port number.
+
+
+ use_vrf + +
+ string +
+ 		+ +
Configures SNMP to use the selected VRF to communicate with the host receiver.
+
This option is unsupported on MDS switches.
+
+
+ version + +
+ string +
+ 		+
    Choices: +
  • 1
    • +
  • 2c
    • +
  • 3
    • +
+ 		+
SNMP version to use for notification messages.
+
+
+ location + +
+ string +
+ 		+ +
Modify sysLocation.
+
+
+ mib + +
+ dictionary +
+ 		+ +
Mib access parameters.
+
+
+ community_map + +
+ dictionary +
+ 		+ +
SNMP community.
+
+
+ community + +
+ string +
+ 		+ +
SNMP community string (Max Size 32).
+
+
+ context + +
+ string +
+ 		+ +
Name of the SNMP context (Max Size 32).
+
+
+ packetsize + +
+ integer +
+ 		+ +
Largest SNMP packet size
+
+
+ protocol + +
+ dictionary +
+ 		+ +
Snmp protocol operations.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable snmp protocol operations.
+
+
+ source_interface + +
+ dictionary +
+ 		+ +
Source interface to be used for sending out SNMP notifications.
+
This option is unsupported on MDS switches.
+
+
+ informs + +
+ string +
+ 		+ +
SNMP Inform notifications for which this source interface needs to be used.
+
+
+ traps + +
+ string +
+ 		+ +
SNMP Trap notifications for which this source interface needs to be used.
+
+
+ system_shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure snmp-server for reload(2).
+
+
+ tcp_session + +
+ dictionary +
+ 		+ +
Enable one time authentication for snmp over tcp session.
+
+
+ auth + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable one time authentication for snmp over tcp session.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable tcp-session.
+
This option is unsupported on MDS switches.
+
+
+ traps + +
+ dictionary +
+ 		+ +
Enable SNMP Traps
+
+
+ aaa + +
+ dictionary +
+ 		+ +
AAA traps
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable AAA traps.
+
+
+ server_state_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
AAA server state change notification.
+
+
+ bgp + +
+ dictionary +
+ 		+ +
SNMP BGP traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP BGP traps.
+
+
+ bridge + +
+ dictionary +
+ 		+ +
Bridge traps.
+
This option is unsupported on MDS switches.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable bridge traps.
+
+
+ newroot + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP STP Bridge MIB newroot traps.
+
+
+ topologychange + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP STP Bridge MIB topologychange traps.
+
+
+ callhome + +
+ dictionary +
+ 		+ +
Callhome traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable callhome traps.
+
This option is unsupported on MDS switches.
+
+
+ event_notify + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Callhome External Event Notification.
+
+
+ smtp_send_fail + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
SMTP Message Send Fail notification.
+
+
+ cfs + +
+ dictionary +
+ 		+ +
CFS traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable cfs traps.
+
This option is unsupported on MDS switches.
+
+
+ merge_failure + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Merge failure notification.
+
+
+ state_change_notif + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
State change notification.
+
+
+ config + +
+ dictionary +
+ 		+ +
Config traps.
+
+
+ ccmCLIRunningConfigChanged + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Running config change trap.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable config traps.
+
This option is unsupported on MDS switches.
+
+
+ entity + +
+ dictionary +
+ 		+ +
Entity traps.
+
+
+ cefcMIBEnableStatusNotification + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
CefcMIBEnableStatusNotification.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable entity traps.
+
+
+ entity_fan_status_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Fan Status Change.
+
+
+ entity_mib_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity MIB change.
+
+
+ entity_module_inserted + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Module Inserted.
+
+
+ entity_module_removed + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Module Removed.
+
+
+ entity_module_status_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Module Status Change.
+
+
+ entity_power_out_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Power Out Change.
+
+
+ entity_power_status_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Power Status Change.
+
+
+ entity_sensor + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity sensor.
+
+
+ entity_unrecognised_module + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Entity Unrecognised Module.
+
+
+ feature_control + +
+ dictionary +
+ 		+ +
Feature-Control traps.
+
+
+ ciscoFeatOpStatusChange + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Feature operation status change Notification.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable feature-control traps.
+
This option is unsupported on MDS switches.
+
+
+ featureOpStatusChange + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Feature operation status change notification.
+
+
+ generic + +
+ dictionary +
+ 		+ +
Generic traps.
+
+
+ coldStart + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Generic coldStart trap.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable generic traps.
+
This option is unsupported on MDS switches.
+
+
+ warmStart + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Generic warmStart trap.
+
+
+ license + +
+ dictionary +
+ 		+ +
License traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable license traps.
+
This option is unsupported on MDS switches.
+
+
+ notify_license_expiry + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
License Expiry Notification.
+
+
+ notify_license_expiry_warning + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
License Expiry Warning Notification.
+
+
+ notify_licensefile_missing + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
License File Missing Notification.
+
+
+ notify_no_license_for_feature + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
No License installed for feature Notification.
+
+
+ link + +
+ dictionary +
+ 		+ +
Link traps.
+
+
+ cErrDisableInterfaceEventRev1 + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Err-disable state notification.
+
This option is unsupported on MDS switches.
+
+
+ cieLinkDown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Cisco extended link state down notification.
+
+
+ cieLinkUp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Cisco extended link state up notification.
+
+
+ cisco_xcvr_mon_status_chg + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Cisco interface transceiver monitor status change notification.
+
+
+ cmn_mac_move_notification + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Mac addr move trap.
+
This option is unsupported on MDS switches.
+
+
+ delayed_link_state_change + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Delayed link state change.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable link traps.
+
This option is unsupported on MDS switches.
+
+
+ extended_linkDown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
IETF extended link state down notification.
+
+
+ extended_linkUp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
IETF extended link state up notification.
+
+
+ linkDown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
IETF Link state down notification.
+
+
+ linkUp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
IETF Link state up notification.
+
+
+ mmode + +
+ dictionary +
+ 		+ +
MMode traps.
+
This option is unsupported on MDS switches.
+
+
+ cseMaintModeChangeNotify + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Maint Mode Change Notification.
+
+
+ cseNormalModeChangeNotify + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Normal Mode Change Notification.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable mmode traps.
+
+
+ ospf + +
+ dictionary +
+ 		+ +
SNMP OSPF traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP OSPF traps.
+
+
+ ospfv3 + +
+ dictionary +
+ 		+ +
SNMP OSPFv3 traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP OSPFv3 traps.
+
+
+ rf + +
+ dictionary +
+ 		+ +
RF traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable rf traps.
+
This option is unsupported on MDS switches.
+
+
+ redundancy_framework + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Redundancy_Framework (RF) Sup switchover MIB.
+
+
+ rmon + +
+ dictionary +
+ 		+ +
RMON traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable rmon traps.
+
This option is unsupported on MDS switches.
+
+
+ fallingAlarm + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Rmon falling alarm.
+
+
+ hcFallingAlarm + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
High capacity Rmon falling alarm.
+
+
+ hcRisingAlarm + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
High capacity Rmon rising alarm.
+
+
+ risingAlarm + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Rmon rising alarm.
+
+
+ snmp + +
+ dictionary +
+ 		+ +
SNMP traps.
+
+
+ authentication + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
SNMP authentication trap.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable snmp traps.
+
This option is unsupported on MDS switches.
+
+
+ storm_control + +
+ dictionary +
+ 		+ +
Storm-Control traps.
+
+
+ cpscEventRev1 + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Port-Storm-Control-Event.
+
This option is unsupported on MDS switches.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable storm-control traps.
+
This option is unsupported on MDS switches.
+
+
+ trap_rate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Number of traps per minute.
+
+
+ stpx + +
+ dictionary +
+ 		+ +
Stpx traps.
+
This option is unsupported on MDS switches.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable stpx traps.
+
+
+ inconsistency + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP STPX MIB InconsistencyUpdate traps.
+
+
+ loop_inconsistency + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP STPX MIB LoopInconsistencyUpdate traps.
+
+
+ root_inconsistency + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable SNMP STPX MIB RootInconsistencyUpdate traps.
+
+
+ syslog + +
+ dictionary +
+ 		+ +
Enable syslog traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable syslog traps.
+
This option is unsupported on MDS switches.
+
+
+ message_generated + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Message Generated Notification.
+
+
+ sysmgr + +
+ dictionary +
+ 		+ +
Sysmgr traps.
+
+
+ cseFailSwCoreNotifyExtended + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Software Core Notification.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable sysmgr traps.
+
This option is unsupported on MDS switches.
+
+
+ system + +
+ dictionary +
+ 		+ +
System traps.
+
+
+ clock_change_notification + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Clock-change-notification traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable system traps.
+
This option is unsupported on MDS switches.
+
+
+ upgrade + +
+ dictionary +
+ 		+ +
Upgrade traps.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable upgrade traps.
+
This option is unsupported on MDS switches.
+
+
+ upgradeJobStatusNotify + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Upgrade Job Status Notification.
+
+
+ upgradeOpNotifyOnCompletion + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Upgrade Global Status Notification.
+
+
+ vtp + +
+ dictionary +
+ 		+ +
VTP traps.
+
This option is unsupported on MDS switches.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable VTP traps.
+
+
+ notifs + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable vtpConfigRevNumberError vtpConfigDigestEnable vtpConfigRevNumberError vtpConfigDigestError vtpServerDisabled vtpVersionOneDeviceDetected vlanTrunkPortDynamicStatusChange vtpLocalModeChanged vtpVersionInUseChanged notification.
+
+
+ vlancreate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable vtpVlanCreated notification.
+
+
+ vlandelete + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable vtpVlanDeleted notification.
+
+
+ users + +
+ dictionary +
+ 		+ +
Define users who can access the SNMP engine.
+
+
+ auth + +
+ list + / elements=dictionary +
+ 		+ +
SNMP User authentication related settings
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Authentication parameters for the user.
+
+
+ algorithm + +
+ string +
+ 		+
    Choices: +
  • md5
    • +
  • sha
    • +
  • sha-256
    • +
+ 		+
Select algorithm for authentication.
+
+
+ engine_id + +
+ string +
+ 		+ +
EngineID for configuring notif target user (for V3 informs).
+
This value needs to be enclosed in quotes in the task.
+
+
+ localized_key + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specifies whether the passwords are in localized key format.
+
+
+ localizedv2_key + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specifies whether the passwords are in localized V2 key format.
+
+
+ password + +
+ string +
+ 		+ +
Authentication password for user (Max Size 127).
+
If this value is localized, it has to be enclosed in quotes in the task.
+
+
+ priv + +
+ dictionary +
+ 		+ +
Encryption parameters for the user.
+
+
+ aes_128 + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use 128-bit AES algorithm for privacy.
+
+
+ privacy_password + +
+ string +
+ 		+ +
Privacy password for user (Max Size 130).
+
If this value is localized, it has to be enclosed in quotes in the task.
+
+
+ group + +
+ string +
+ 		+ +
Group name (ignored for notif target user) (Max Size 28).
+
+
+ user + +
+ string +
+ 		+ +
Name of the user (Max Size 28).
+
+
+ use_acls + +
+ list + / elements=dictionary +
+ 		+ +
Set IPv4 and IPv6 ACL to use.
+
+
+ ipv4 + +
+ string +
+ 		+ +
Specify IPv4 ACL, the ACL name specified after must be IPv4 ACL.
+
+
+ ipv6 + +
+ string +
+ 		+ +
Specify IPv6 ACL, the ACL name specified after must be IPv6 ACL.
+
+
+ user + +
+ string +
+ 		+ +
Name of the user (Max Size 28).
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section '^snmp-server'.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state the configuration should be left in.
+
The states replaced and overridden have identical behaviour for this module.
+
Please refer to examples for more details.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6 on Cisco Nexus Switches. + - This module works with connection ``network_cli`` and ``httpapi``. + - Tested against Cisco MDS NX-OS 9.2(2) with connection ``network_cli``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_snmp_server: + config: + aaa_user: + cache_timeout: 36000 + communities: + - community: public + group: network-operator + - community: private + group: network-admin + contact: nxosswitchadmin@localhost + location: serverroom-1 + traps: + aaa: + server_state_change: true + system: + clock_change_notification: true + hosts: + - host: 192.0.2.1 + traps: true + version: '1' + community: public + - host: 192.0.2.1 + source_interface: Ethernet1/1 + - host: 192.0.2.2 + informs: true + version: '3' + auth: NMS + users: + auth: + - user: snmp_user_1 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + - user: snmp_user_2 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + priv: + privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' + aes_128: true + use_acls: + - user: snmp_user_1 + ipv4: acl1 + ipv6: acl2 + - user: snmp_user_2 + ipv4: acl3 + ipv6: acl4 + + # Task output + # ------------- + # before: + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # + # commands: + # - snmp-server contact nxosswitchadmin@localhost + # - snmp-server location serverroom-1 + # - snmp-server aaa-user cache-timeout 36000 + # - snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # - snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # - snmp-server host 192.0.2.1 traps version 1 public + # - snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # - snmp-server host 192.0.2.2 informs version 3 auth NMS + # - snmp-server community private group network-admin + # - snmp-server community public group network-operator + # - snmp-server enable traps aaa server-state-change + # - snmp-server enable traps system Clock-change-notification + # + # after: + # aaa_user: + # cache_timeout: 36000 + # communities: + # - community: private + # group: network-admin + # - community: public + # group: network-operator + # contact: nxosswitchadmin@localhost + # location: serverroom-1 + # traps: + # aaa: + # server_state_change: true + # system: + # clock_change_notification: true + # hosts: + # - host: 192.0.2.1 + # traps: true + # version: "1" + # community: public + # + # - host: 192.0.2.1 + # source_interface: Ethernet1/1 + # + # - host: 192.0.2.2 + # informs: true + # version: "3" + # auth: NMS + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # + # - user: snmp_user_1 + # group: network-operator + # authentication: + # algorithm: md5 + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # localized_key: true + # + # - authentication: + # algorithm: md5 + # localized_key: true + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # priv: + # aes_128: true + # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" + # group: network-operator + # user: snmp_user_2 + # + # use_acls: + # - user: snmp_user_1 + # ipv4: acl1 + # ipv6: acl2 + # - user: snmp_user_2 + # ipv4: acl3 + # ipv6: acl4 + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server contact nxosswitchadmin@localhost + # snmp-server location serverroom-1 + # snmp-server aaa-user cache-timeout 36000 + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # snmp-server host 192.0.2.1 traps version 1 public + # snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # snmp-server host 192.0.2.2 informs version 3 auth NMS + # snmp-server community private group network-admin + # snmp-server community public group network-operator + # snmp-server enable traps aaa server-state-change + # snmp-server enable traps system Clock-change-notification + + # Using replaced + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server contact nxosswitchadmin@localhost + # snmp-server location serverroom-1 + # snmp-server aaa-user cache-timeout 36000 + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # snmp-server host 192.0.2.1 traps version 1 public + # snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # snmp-server host 192.0.2.2 informs version 3 auth NMS + # snmp-server community private group network-admin + # snmp-server community public group network-operator + # snmp-server enable traps aaa server-state-change + # snmp-server enable traps system Clock-change-notification + + - name: Replace snmp-server configurations of listed snmp-server with provided configurations + cisco.nxos.nxos_snmp_server: + config: + aaa_user: + cache_timeout: 36000 + communities: + - community: public + group: network-operator + - community: secret + group: network-operator + contact: nxosswitchadmin2@localhost + location: serverroom-2 + traps: + aaa: + server_state_change: true + hosts: + - host: 192.0.2.1 + traps: true + version: '1' + community: public + - host: 192.0.2.1 + source_interface: Ethernet1/1 + - host: 192.0.3.2 + informs: true + version: '3' + auth: NMS + users: + auth: + - user: admin + group: network-admin + authentication: + algorithm: md5 + password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + localized_key: true + priv: + privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + + - user: snmp_user_1 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + + - user: snmp_user_2 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + priv: + privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' + aes_128: true + use_acls: + - user: snmp_user_1 + ipv4: acl1 + ipv6: acl2 + state: replaced + + # Task output + # ------------- + # before: + # aaa_user: + # cache_timeout: 36000 + # communities: + # - community: private + # group: network-admin + # - community: public + # group: network-operator + # contact: nxosswitchadmin@localhost + # location: serverroom-1 + # traps: + # aaa: + # server_state_change: true + # system: + # clock_change_notification: true + # hosts: + # - host: 192.0.2.1 + # traps: true + # version: "1" + # community: public + # + # - host: 192.0.2.1 + # source_interface: Ethernet1/1 + # + # - host: 192.0.2.2 + # informs: true + # version: "3" + # auth: NMS + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # + # - user: snmp_user_1 + # group: network-operator + # authentication: + # algorithm: md5 + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # localized_key: true + # + # - authentication: + # algorithm: md5 + # localized_key: true + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # priv: + # aes_128: true + # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" + # group: network-operator + # user: snmp_user_2 + # + # use_acls: + # - user: snmp_user_1 + # ipv4: acl1 + # ipv6: acl2 + # - user: snmp_user_2 + # ipv4: acl3 + # ipv6: acl4 + # + # commands: + # - snmp-server contact nxosswitchadmin2@localhost + # - no snmp-server enable traps system Clock-change-notification + # - snmp-server location serverroom-2 + # - no snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # - no snmp-server host 192.0.2.2 informs version 3 auth NMS + # - snmp-server host 192.0.3.2 informs version 3 auth NMS + # - no snmp-server community private group network-admin + # - snmp-server community secret group network-operator + # + # after: + # aaa_user: + # cache_timeout: 36000 + # communities: + # - community: public + # group: network-operator + # - community: secret + # group: network-operator + # contact: nxosswitchadmin2@localhost + # location: serverroom-2 + # traps: + # aaa: + # server_state_change: true + # hosts: + # - host: 192.0.2.1 + # traps: true + # version: '1' + # community: public + # - host: 192.0.2.1 + # source_interface: Ethernet1/1 + # - host: 192.0.3.2 + # informs: true + # version: '3' + # auth: NMS + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # + # - user: snmp_user_1 + # group: network-operator + # authentication: + # algorithm: md5 + # password: '0x5632724fb8ac3699296af26281e1d0f1' + # localized_key: true + # + # - user: snmp_user_2 + # group: network-operator + # authentication: + # algorithm: md5 + # password: '0x5632724fb8ac3699296af26281e1d0f1' + # localized_key: true + # priv: + # privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' + # aes_128: true + # + # use_acls: + # - user: snmp_user_1 + # ipv4: acl1 + # ipv6: acl2 + # + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server contact nxosswitchadmin2@localhost + # snmp-server location serverroom-2 + # snmp-server aaa-user cache-timeout 36000 + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # snmp-server host 192.0.2.1 traps version 1 public + # snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # snmp-server host 192.0.2.2 informs version 3 auth NMS + # snmp-server community secret group network-operator + # snmp-server community public group network-operator + # snmp-server enable traps aaa server-state-change + # snmp-server enable traps system Clock-change-notification + + # Using deleted + + # Before state: + # ------------ + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server contact nxosswitchadmin@localhost + # snmp-server location serverroom-1 + # snmp-server aaa-user cache-timeout 36000 + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # snmp-server host 192.0.2.1 traps version 1 public + # snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # snmp-server host 192.0.2.2 informs version 3 auth NMS + # snmp-server community private group network-admin + # snmp-server community public group network-operator + # snmp-server enable traps aaa server-state-change + # snmp-server enable traps system Clock-change-notification + + - name: Delete SNMP Server configurations from the device (admin user will not be deleted) + cisco.nxos.nxos_snmp_server: + state: deleted + + # Task output + # ------------- + # before: + # aaa_user: + # cache_timeout: 36000 + # communities: + # - community: private + # group: network-admin + # - community: public + # group: network-operator + # contact: nxosswitchadmin@localhost + # location: serverroom-1 + # traps: + # aaa: + # server_state_change: true + # system: + # clock_change_notification: true + # hosts: + # - host: 192.0.2.1 + # traps: true + # version: "1" + # community: public + # + # - host: 192.0.2.1 + # source_interface: Ethernet1/1 + # + # - host: 192.0.2.2 + # informs: true + # version: "3" + # auth: NMS + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # + # - user: snmp_user_1 + # group: network-operator + # authentication: + # algorithm: md5 + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # localized_key: true + # + # - authentication: + # algorithm: md5 + # localized_key: true + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # priv: + # aes_128: true + # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" + # group: network-operator + # user: snmp_user_2 + # + # use_acls: + # - user: snmp_user_1 + # ipv4: acl1 + # ipv6: acl2 + # - user: snmp_user_2 + # ipv4: acl3 + # ipv6: acl4 + # + # commands: + # - no snmp-server contact nxosswitchadmin@localhost + # - no snmp-server location serverroom-1 + # - no snmp-server aaa-user cache-timeout 36000 + # - no snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + # - no snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - no snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - no snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # - no snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # - no snmp-server host 192.0.2.1 traps version 1 public + # - no snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # - no snmp-server host 192.0.2.2 informs version 3 auth NMS + # - no snmp-server community private group network-admin + # - no snmp-server community public group network-operator + # - no snmp-server enable traps aaa server-state-change + # - no snmp-server enable traps system Clock-change-notification + # + # after: + # users: + # auth: + # - user: admin + # group: network-admin + # authentication: + # algorithm: md5 + # password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + # localized_key: true + # priv: + # privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9" + + # After state: + # ------------ + # nxos-9k-rdo# show running-config | section "^snmp-server" + # snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey + + # Using rendered + # --------------- + + - name: Render platform specific configuration lines with state rendered (without connecting to the device) + cisco.nxos.nxos_snmp_server: + config: + aaa_user: + cache_timeout: 36000 + communities: + - community: public + group: network-operator + - community: private + group: network-admin + contact: nxosswitchadmin@localhost + location: serverroom-1 + traps: + aaa: + server_state_change: true + system: + clock_change_notification: true + hosts: + - host: 192.0.2.1 + traps: true + version: '1' + community: public + - host: 192.0.2.1 + source_interface: Ethernet1/1 + - host: 192.0.2.2 + informs: true + version: '3' + auth: NMS + users: + auth: + - user: snmp_user_1 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + - user: snmp_user_2 + group: network-operator + authentication: + algorithm: md5 + password: '0x5632724fb8ac3699296af26281e1d0f1' + localized_key: true + priv: + privacy_password: '0x5632724fb8ac3699296af26281e1d0f1' + aes_128: true + use_acls: + - user: snmp_user_1 + ipv4: acl1 + ipv6: acl2 + - user: snmp_user_2 + ipv4: acl3 + ipv6: acl4 + state: rendered + + + # Task Output (redacted) + # ----------------------- + # rendered: + # - snmp-server contact nxosswitchadmin@localhost + # - snmp-server location serverroom-1 + # - snmp-server aaa-user cache-timeout 36000 + # - snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # - snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # - snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # - snmp-server host 192.0.2.1 traps version 1 public + # - snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # - snmp-server host 192.0.2.2 informs version 3 auth NMS + # - snmp-server community private group network-admin + # - snmp-server community public group network-operator + # - snmp-server enable traps aaa server-state-change + # - snmp-server enable traps system Clock-change-notification + + # Using parsed + + # parsed.cfg + # ------------ + # snmp-server contact nxosswitchadmin@localhost + # snmp-server location serverroom-1 + # snmp-server aaa-user cache-timeout 36000 + # snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey + # snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2 + # snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4 + # snmp-server host 192.0.2.1 traps version 1 public + # snmp-server host 192.0.2.1 source-interface Ethernet1/1 + # snmp-server host 192.0.2.2 informs version 3 auth NMS + # snmp-server community private group network-admin + # snmp-server community public group network-operator + # snmp-server enable traps aaa server-state-change + # snmp-server enable traps system Clock-change-notification + + - name: Parse externally provided snmp-server configuration + cisco.nxos.nxos_snmp_server: + running_config: "{{ lookup('file', './parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # parsed: + # aaa_user: + # cache_timeout: 36000 + # communities: + # - community: private + # group: network-admin + # - community: public + # group: network-operator + # contact: nxosswitchadmin@localhost + # location: serverroom-1 + # traps: + # aaa: + # server_state_change: true + # system: + # clock_change_notification: true + # hosts: + # - host: 192.0.2.1 + # traps: true + # version: "1" + # community: public + # + # - host: 192.0.2.1 + # source_interface: Ethernet1/1 + # + # - host: 192.0.2.2 + # informs: true + # version: "3" + # auth: NMS + # users: + # auth: + # - user: snmp_user_1 + # group: network-operator + # authentication: + # algorithm: md5 + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # localized_key: true + # + # - authentication: + # algorithm: md5 + # localized_key: true + # password: "0x5632724fb8ac3699296af26281e1d0f1" + # priv: + # aes_128: true + # privacy_password: "0x5632724fb8ac3699296af26281e1d0f1" + # group: network-operator + # user: snmp_user_2 + # + # use_acls: + # - user: snmp_user_1 + # ipv4: acl1 + # ipv6: acl2 + # - user: snmp_user_2 + # ipv4: acl3 + # ipv6: acl4 + # + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ after + +
+ dictionary +
+ 		when changed +
The resulting configuration after module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ before + +
+ dictionary +
+ 		when state is merged, replaced, overridden, deleted or purged +
The configuration prior to the module execution.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ commands + +
+ list +
+ 		when state is merged, replaced, overridden, deleted or purged +
The set of commands pushed to the remote device.
+
+
Sample:
+
['sample command 1', 'sample command 2', 'sample command 3']
+
+
+ gathered + +
+ list +
+ 		when state is gathered +
Facts about the network resource gathered from the remote device as structured data.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ parsed + +
+ list +
+ 		when state is parsed +
The device native config provided in running_config option parsed into structured data as per module argspec.
+
+
Sample:
+
This output will always be in the same format as the module argspec.
+
+
+ rendered + +
+ list +
+ 		when state is rendered +
The provided configuration in the task rendered in device-native format (offline).
+
+
Sample:
+
['sample command 1', 'sample command 2', 'sample command 3']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/docs/cisco.nxos.nxos_snmp_traps_module.rst b/docs/cisco.nxos.nxos_snmp_traps_module.rst new file mode 100644 index 000000000..726a4d5fe --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_traps_module.rst @@ -0,0 +1,189 @@ +.. _cisco.nxos.nxos_snmp_traps_module: + + +************************** +cisco.nxos.nxos_snmp_traps +************************** + +**(deprecated, removed after 2024-01-01) Manages SNMP traps.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated modules released with more functionality +:Alternative: nxos_snmp_server + + + +Synopsis +-------- +- Manages SNMP traps configurations. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ group + +
+ string + / required +
+ 		+
    Choices: +
  • aaa
    • +
  • bfd
    • +
  • bgp
    • +
  • bridge
    • +
  • callhome
    • +
  • cfs
    • +
  • config
    • +
  • eigrp
    • +
  • entity
    • +
  • feature-control
    • +
  • generic
    • +
  • hsrp
    • +
  • license
    • +
  • link
    • +
  • lldp
    • +
  • mmode
    • +
  • ospf
    • +
  • pim
    • +
  • rf
    • +
  • rmon
    • +
  • snmp
    • +
  • storm-control
    • +
  • stpx
    • +
  • switchfabric
    • +
  • syslog
    • +
  • sysmgr
    • +
  • system
    • +
  • upgrade
    • +
  • vtp
    • +
  • all
    • +
+ 		+
Case sensitive group.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • enabled ←
    • +
  • disabled
    • +
+ 		+
Manage the state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - This module works at the group level for traps. If you need to only enable/disable 1 specific trap within a group, use the :ref:`cisco.nxos.nxos_command ` module. + - Be aware that you can set a trap only for an enabled feature. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure lldp trap configured + - cisco.nxos.nxos_snmp_traps: + group: lldp + state: enabled + + # ensure lldp trap is not configured + - cisco.nxos.nxos_snmp_traps: + group: lldp + state: disabled + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
snmp-server enable traps lldp ;
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_snmp_user_module.rst b/docs/cisco.nxos.nxos_snmp_user_module.rst new file mode 100644 index 000000000..2d3f6f26c --- /dev/null +++ b/docs/cisco.nxos.nxos_snmp_user_module.rst @@ -0,0 +1,235 @@ +.. _cisco.nxos.nxos_snmp_user_module: + + +************************* +cisco.nxos.nxos_snmp_user +************************* + +**(deprecated, removed after 2024-01-01) Manages SNMP users for monitoring.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2024-01-01 +:Why: Updated modules released with more functionality +:Alternative: nxos_snmp_server + + + +Synopsis +-------- +- Manages SNMP user configuration. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ authentication + +
+ string +
+ 		+
    Choices: +
  • md5
    • +
  • sha
    • +
+ 		+
Authentication parameters for the user.
+
+
+ encrypt + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables AES-128 bit encryption when using privacy password.
+
+
+ group + +
+ string +
+ 		+ +
Group to which the user will belong to. If state = present, and the user is existing, the group is added to the user. If the user is not existing, user entry is created with this group argument. If state = absent, only the group is removed from the user entry. However, to maintain backward compatibility, if the existing user belongs to only one group, and if group argument is same as the existing user's group, then the user entry also is deleted.
+
+
+ privacy + +
+ string +
+ 		+ +
Privacy password for the user. This is not idempotent
+
+
+ pwd + +
+ string +
+ 		+ +
Authentication password when using md5 or sha. This is not idempotent
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ user + +
+ string + / required +
+ 		+ +
Name of the user.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Limited Support for Cisco MDS + - Authentication parameters not idempotent. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_snmp_user: + user: ntc + group: network-operator + authentication: md5 + pwd: test_password + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['snmp-server user ntc network-operator auth md5 test_password']
+
+

+ + +Status +------ + + +- This module will be removed in a release after 2024-01-01. *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_udld_interface_module.rst b/docs/cisco.nxos.nxos_udld_interface_module.rst new file mode 100644 index 000000000..cba2733c0 --- /dev/null +++ b/docs/cisco.nxos.nxos_udld_interface_module.rst @@ -0,0 +1,250 @@ +.. _cisco.nxos.nxos_udld_interface_module: + + +****************************** +cisco.nxos.nxos_udld_interface +****************************** + +**Manages UDLD interface configuration params.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages UDLD interface configuration params. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ interface + +
+ string + / required +
+ 		+ +
FULL name of the interface, i.e. Ethernet1/1-
+
+
+ mode + +
+ string + / required +
+ 		+
    Choices: +
  • enabled
    • +
  • disabled
    • +
  • aggressive
    • +
+ 		+
Manages UDLD mode for an interface.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Feature UDLD must be enabled on the device to use this module. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure Ethernet1/1 is configured to be in aggressive mode + - cisco.nxos.nxos_udld_interface: + interface: Ethernet1/1 + mode: aggressive + state: present + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + # Remove the aggressive config only if it's currently in aggressive mode and then disable udld (switch default) + - cisco.nxos.nxos_udld_interface: + interface: Ethernet1/1 + mode: aggressive + state: absent + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + # ensure Ethernet1/1 has aggressive mode enabled + - cisco.nxos.nxos_udld_interface: + interface: Ethernet1/1 + mode: enabled + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ end_state + +
+ dictionary +
+ 		always +
k/v pairs of configuration after module execution
+
+
Sample:
+
{'mode': 'enabled'}
+
+
+ existing + +
+ dictionary +
+ 		always +
k/v pairs of existing configuration
+
+
Sample:
+
{'mode': 'aggressive'}
+
+
+ proposed + +
+ dictionary +
+ 		always +
k/v pairs of parameters passed into module
+
+
Sample:
+
{'mode': 'enabled'}
+
+
+ updates + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['interface ethernet1/33', 'no udld aggressive ; no udld disable']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_udld_module.rst b/docs/cisco.nxos.nxos_udld_module.rst new file mode 100644 index 000000000..dc461bc89 --- /dev/null +++ b/docs/cisco.nxos.nxos_udld_module.rst @@ -0,0 +1,256 @@ +.. _cisco.nxos.nxos_udld_module: + + +******************** +cisco.nxos.nxos_udld +******************** + +**Manages UDLD global configuration params.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages UDLD global configuration params. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ aggressive + +
+ string +
+ 		+
    Choices: +
  • enabled
    • +
  • disabled
    • +
+ 		+
Toggles aggressive mode.
+
+
+ msg_time + +
+ string +
+ 		+ +
Message time in seconds for UDLD packets or keyword 'default'.
+
+
+ reset + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ability to reset all ports shut down by UDLD. 'state' parameter cannot be 'absent' when this is present.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manage the state of the resource. When set to 'absent', aggressive and msg_time are set to their default values.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Module will fail if the udld feature has not been previously enabled. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # ensure udld aggressive mode is globally disabled and se global message interval is 20 + - cisco.nxos.nxos_udld: + aggressive: disabled + msg_time: 20 + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + # Ensure agg mode is globally enabled and msg time is 15 + - cisco.nxos.nxos_udld: + aggressive: enabled + msg_time: 15 + host: '{{ inventory_hostname }}' + username: '{{ un }}' + password: '{{ pwd }}' + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
check to see if a change was made on the device
+
+
Sample:
+
True
+
+
+ end_state + +
+ dictionary +
+ 		always +
k/v pairs of udld configuration after module execution
+
+
Sample:
+
{'aggressive': 'enabled', 'msg_time': '40'}
+
+
+ existing + +
+ dictionary +
+ 		always +
k/v pairs of existing udld configuration
+
+
Sample:
+
{'aggressive': 'disabled', 'msg_time': '15'}
+
+
+ proposed + +
+ dictionary +
+ 		always +
k/v pairs of parameters passed into module
+
+
Sample:
+
{'aggressive': 'enabled', 'msg_time': '40'}
+
+
+ updates + +
+ list +
+ 		always +
command sent to the device
+
+
Sample:
+
['udld message-time 40', 'udld aggressive']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) diff --git a/docs/cisco.nxos.nxos_user_module.rst b/docs/cisco.nxos.nxos_user_module.rst new file mode 100644 index 000000000..a03a23a03 --- /dev/null +++ b/docs/cisco.nxos.nxos_user_module.rst @@ -0,0 +1,390 @@ +.. _cisco.nxos.nxos_user_module: + + +******************** +cisco.nxos.nxos_user +******************** + +**Manage the collection of local users on Nexus devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module provides declarative management of the local usernames configured on Cisco Nexus devices. It allows playbooks to manage either individual usernames or the collection of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ aggregate + +
+ list + / elements=dictionary +
+ 		+ +
The set of username objects to be configured on the remote Cisco Nexus device. The list entries can either be the username or a hash of username and properties. This argument is mutually exclusive with the name argument.
+

aliases: users, collection
+
+
+ configured_password + +
+ string +
+ 		+ +
The password to be configured on the network device. The password needs to be provided in cleartext and it will be encrypted on the device.
+
+
+ hashed_password + +
+ string +
+ 		+ +
The hashed password to be configured on the network device. The password needs to already be encrypted.
+
+
+ name + +
+ string +
+ 		+ +
The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
+
+
+ roles + +
+ list + / elements=string +
+ 		+ +
The role argument configures the role for the username in the device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device.
+

aliases: role
+
+
+ sshkey + +
+ string +
+ 		+ +
The sshkey argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
The state argument configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
+
+
+ update_password + +
+ string +
+ 		+
    Choices: +
  • on_create
    • +
  • always
    • +
+ 		+
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
+
+
+ configured_password + +
+ string +
+ 		+ +
The password to be configured on the network device. The password needs to be provided in cleartext and it will be encrypted on the device.
+
+
+ hashed_password + +
+ string +
+ 		+ +
The hashed password to be configured on the network device. The password needs to already be encrypted.
+
+
+ name + +
+ string +
+ 		+ +
The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
+
+
+ purge + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
The purge argument instructs the module to consider the resource definition absolute. It will remove any previously configured usernames on the device with the exception of the `admin` user which cannot be deleted per nxos constraints.
+
+
+ roles + +
+ list + / elements=string +
+ 		+ +
The role argument configures the role for the username in the device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device.
+

aliases: role
+
+
+ sshkey + +
+ string +
+ 		+ +
The sshkey argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
The state argument configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
+
+
+ update_password + +
+ string +
+ 		+
    Choices: +
  • on_create
    • +
  • always ←
    • +
+ 		+
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
+
+
+ + +Notes +----- + +.. note:: + - Limited Support for Cisco MDS + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: create a new user + cisco.nxos.nxos_user: + name: ansible + sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}" + state: present + + - name: remove all users except admin + cisco.nxos.nxos_user: + purge: true + + - name: set multiple users role + cisco.nxos.nxos_user: + aggregate: + - name: netop + - name: netend + role: network-operator + state: present + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['name ansible', 'name ansible password password']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Peter Sprygada (@privateip) diff --git a/docs/cisco.nxos.nxos_vpc_module.rst b/docs/cisco.nxos.nxos_vpc_module.rst new file mode 100644 index 000000000..9e0ca3c29 --- /dev/null +++ b/docs/cisco.nxos.nxos_vpc_module.rst @@ -0,0 +1,352 @@ +.. _cisco.nxos.nxos_vpc_module: + + +******************* +cisco.nxos.nxos_vpc +******************* + +**Manages global VPC configuration** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages global VPC configuration + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ auto_recovery + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/Disables auto recovery on platforms that support disable
+
timers are not modifiable with this attribute
+
mutually exclusive with auto_recovery_reload_delay
+
+
+ auto_recovery_reload_delay + +
+ string +
+ 		+ +
Manages auto-recovery reload-delay timer in seconds
+
mutually exclusive with auto_recovery
+
+
+ delay_restore + +
+ string +
+ 		+ +
manages delay restore command and config value in seconds
+
+
+ delay_restore_interface_vlan + +
+ string +
+ 		+ +
manages delay restore interface-vlan command and config value in seconds
+
not supported on all platforms
+
+
+ delay_restore_orphan_port + +
+ string +
+ 		+ +
manages delay restore orphan-port command and config value in seconds
+
not supported on all platforms
+
+
+ domain + +
+ string + / required +
+ 		+ +
VPC domain
+
+
+ peer_gw + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables/Disables peer gateway
+
+
+ pkl_dest + +
+ string +
+ 		+ +
Destination (remote) IP address used for peer keepalive link
+
pkl_dest is required whenever pkl options are used.
+
+
+ pkl_src + +
+ string +
+ 		+ +
Source IP address used for peer keepalive link
+
+
+ pkl_vrf + +
+ string +
+ 		+ +
VRF used for peer keepalive link
+
The VRF must exist on the device before using pkl_vrf.
+
(Note) 'default' is an overloaded term: Default vrf context for pkl_vrf is 'management'; 'pkl_vrf: default' refers to the literal 'default' rib.
+
+
+ role_priority + +
+ string +
+ 		+ +
Role priority for device. Remember lower is better.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manages desired state of the resource
+
+
+ system_priority + +
+ string +
+ 		+ +
System priority device. Remember they must match between peers.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - The feature vpc must be enabled before this module can be used + - If not using management vrf, vrf must be globally on the device before using in the pkl config + - Although source IP isn't required on the command line it is required when using this module. The PKL VRF must also be configured prior to using this module. + - Both pkl_src and pkl_dest are needed when changing PKL VRF. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: configure a simple asn + cisco.nxos.nxos_vpc: + domain: 100 + role_priority: 1000 + system_priority: 2000 + pkl_dest: 192.168.100.4 + pkl_src: 10.1.100.20 + peer_gw: true + auto_recovery: true + + - name: configure + cisco.nxos.nxos_vpc: + domain: 100 + role_priority: 32667 + system_priority: 2000 + peer_gw: true + pkl_src: 10.1.100.2 + pkl_dest: 192.168.100.4 + auto_recovery: true + + - name: Configure VPC with delay restore and existing keepalive VRF + cisco.nxos.nxos_vpc: + domain: 10 + role_priority: 28672 + system_priority: 2000 + delay_restore: 180 + peer_gw: true + pkl_src: 1.1.1.2 + pkl_dest: 1.1.1.1 + pkl_vrf: vpckeepalive + auto_recovery: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['vpc domain 100', 'peer-keepalive destination 192.168.100.4 source 10.1.100.20 vrf management', 'auto-recovery', 'peer-gateway']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vrf_af_module.rst b/docs/cisco.nxos.nxos_vrf_af_module.rst new file mode 100644 index 000000000..236991587 --- /dev/null +++ b/docs/cisco.nxos.nxos_vrf_af_module.rst @@ -0,0 +1,300 @@ +.. _cisco.nxos.nxos_vrf_af_module: + + +********************** +cisco.nxos.nxos_vrf_af +********************** + +**Manages VRF AF.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages VRF AF + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
Address-Family Identifier (AFI).
+
+
+ route_target_both_auto_evpn + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable the EVPN route-target 'auto' setting for both import and export target communities.
+
+
+ route_targets + +
+ list + / elements=dictionary +
+ 		+ +
Specify the route-targets which should be imported and/or exported under the AF. This argument accepts a list of dicts that specify the route-target, the direction (import|export|both) and state of each route-target. Default direction is direction=both. See examples.
+
+
+ direction + +
+ string +
+ 		+
    Choices: +
  • import
    • +
  • export
    • +
  • both ←
    • +
+ 		+
Indicates the direction of the route-target (import|export|both)
+
+
+ rt + +
+ string + / required +
+ 		+ +
Defines the route-target itself
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Determines whether the route-target with the given direction should be present or not on the device.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Determines whether the config should be present or not on the device.
+
+
+ vrf + +
+ string + / required +
+ 		+ +
Name of the VRF.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Default, where supported, restores params default value. + - In case of ``state=absent`` the address-family configuration will be absent. Therefore the options ``route_target_both_auto_evpn`` and ``route_targets`` are ignored. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_target_both_auto_evpn: true + state: present + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_targets: + - rt: '65000:1000' + direction: import + - rt: '65001:1000' + direction: import + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_targets: + - rt: '65000:1000' + direction: import + - rt: '65001:1000' + state: absent + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_targets: + - rt: '65000:1000' + direction: export + - rt: '65001:1000' + direction: export + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_targets: + - rt: '65000:1000' + direction: export + state: absent + - cisco.nxos.nxos_vrf_af: + vrf: ntc + afi: ipv4 + route_targets: + - rt: '65000:1000' + direction: both + state: present + - rt: '65001:1000' + direction: import + state: present + - rt: '65002:1000' + direction: both + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['vrf context ntc', 'address-family ipv4 unicast']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vrf_module.rst b/docs/cisco.nxos.nxos_vrf_module.rst new file mode 100644 index 000000000..6765f78b5 --- /dev/null +++ b/docs/cisco.nxos.nxos_vrf_module.rst @@ -0,0 +1,494 @@ +.. _cisco.nxos.nxos_vrf_module: + + +******************* +cisco.nxos.nxos_vrf +******************* + +**Manages global VRF configuration.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module provides declarative management of VRFs on CISCO NXOS network devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ admin_state + +
+ string +
+ 		+
    Choices: +
  • up ←
    • +
  • down
    • +
+ 		+
Administrative state of the VRF.
+
+
+ aggregate + +
+ list + / elements=dictionary +
+ 		+ +
List of VRFs definitions.
+
+
+ admin_state + +
+ string +
+ 		+
    Choices: +
  • up
    • +
  • down
    • +
+ 		+
Administrative state of the VRF.
+
+
+ associated_interfaces + +
+ list + / elements=string +
+ 		+ +
This is a intent option and checks the operational state of the for given vrf name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vrf interfaces on device it will result in failure.
+
+
+ delay + +
+ integer +
+ 		+ +
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
+
+
+ description + +
+ string +
+ 		+ +
Description of the VRF or keyword 'default'.
+
+
+ interfaces + +
+ list + / elements=string +
+ 		+ +
List of interfaces to check the VRF has been configured correctly or keyword 'default'.
+
+
+ name + +
+ string +
+ 		+ +
Name of VRF to be managed.
+

aliases: vrf
+
+
+ rd + +
+ string +
+ 		+ +
VPN Route Distinguisher (RD). Valid values are a string in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword 'auto', or the keyword 'default'.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
Manages desired state of the resource.
+
+
+ vni + +
+ string +
+ 		+ +
Specify virtual network identifier. Valid values are Integer or keyword 'default'.
+
+
+ associated_interfaces + +
+ list + / elements=string +
+ 		+ +
This is a intent option and checks the operational state of the for given vrf name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vrf interfaces on device it will result in failure.
+
+
+ delay + +
+ integer +
+ 		+ Default:
10
+ 		+
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
+
+
+ description + +
+ string +
+ 		+ +
Description of the VRF or keyword 'default'.
+
+
+ interfaces + +
+ list + / elements=string +
+ 		+ +
List of interfaces to check the VRF has been configured correctly or keyword 'default'.
+
+
+ name + +
+ string +
+ 		+ +
Name of VRF to be managed.
+

aliases: vrf
+
+
+ purge + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Purge VRFs not defined in the aggregate parameter.
+
+
+ rd + +
+ string +
+ 		+ +
VPN Route Distinguisher (RD). Valid values are a string in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword 'auto', or the keyword 'default'.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Manages desired state of the resource.
+
+
+ vni + +
+ string +
+ 		+ +
Specify virtual network identifier. Valid values are Integer or keyword 'default'.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - Cisco NX-OS creates the default VRF by itself. Therefore, you're not allowed to use default as *vrf* name in this module. + - ``vrf`` name must be shorter than 32 chars. + - VRF names are not case sensible in NX-OS. Anyway, the name is stored just like it's inserted by the user and it'll not be changed again unless the VRF is removed and re-created. i.e. ``vrf=NTC`` will create a VRF named NTC, but running it again with ``vrf=ntc`` will not cause a configuration change. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Ensure ntc VRF exists on switch + cisco.nxos.nxos_vrf: + name: ntc + description: testing + state: present + - name: Aggregate definition of VRFs + cisco.nxos.nxos_vrf: + aggregate: + - name: test1 + description: Testing + admin_state: down + - name: test2 + interfaces: Ethernet1/2 + - name: Aggregate definitions of VRFs with Purge + cisco.nxos.nxos_vrf: + aggregate: + - name: ntc1 + description: purge test1 + - name: ntc2 + description: purge test2 + state: present + purge: true + - name: Delete VRFs exist on switch + cisco.nxos.nxos_vrf: + aggregate: + - name: ntc1 + - name: ntc2 + state: absent + - name: Assign interfaces to VRF declaratively + cisco.nxos.nxos_vrf: + name: test1 + interfaces: + - Ethernet2/3 + - Ethernet2/5 + - name: Check interfaces assigned to VRF + cisco.nxos.nxos_vrf: + name: test1 + associated_interfaces: + - Ethernet2/3 + - Ethernet2/5 + - name: >- + Ensure VRF is tagged with interface Ethernet2/5 only (Removes from + Ethernet2/3) + cisco.nxos.nxos_vrf: + name: test1 + interfaces: + - Ethernet2/5 + - name: Delete VRF + cisco.nxos.nxos_vrf: + name: ntc + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['vrf context ntc', 'no shutdown', 'interface Ethernet1/2', 'no switchport', 'vrf member test2']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) +- Trishna Guha (@trishnaguha) diff --git a/docs/cisco.nxos.nxos_vrrp_module.rst b/docs/cisco.nxos.nxos_vrrp_module.rst new file mode 100644 index 000000000..88183c5af --- /dev/null +++ b/docs/cisco.nxos.nxos_vrrp_module.rst @@ -0,0 +1,277 @@ +.. _cisco.nxos.nxos_vrrp_module: + + +******************** +cisco.nxos.nxos_vrrp +******************** + +**Manages VRRP configuration on NX-OS switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages VRRP configuration on NX-OS switches. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ admin_state + +
+ string +
+ 		+
    Choices: +
  • shutdown ←
    • +
  • no shutdown
    • +
  • default
    • +
+ 		+
Used to enable or disable the VRRP process.
+
+
+ authentication + +
+ string +
+ 		+ +
Clear text authentication string or 'default' keyword
+
+
+ group + +
+ string + / required +
+ 		+ +
VRRP group number.
+
+
+ interface + +
+ string + / required +
+ 		+ +
Full name of interface that is being managed for VRRP.
+
+
+ interval + +
+ string +
+ 		+ +
Time interval between advertisement or 'default' keyword
+
+
+ preempt + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable preempt.
+
+
+ priority + +
+ string +
+ 		+ +
VRRP priority or 'default' keyword
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specify desired state of the resource.
+
+
+ vip + +
+ string +
+ 		+ +
VRRP virtual IP address or 'default' keyword
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - VRRP feature needs to be enabled first on the system. + - SVIs must exist before using this module. + - Interface must be a L3 port before using this module. + - ``state=absent`` removes the VRRP group if it exists on the device. + - VRRP cannot be configured on loopback interfaces. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: Ensure vrrp group 100 and vip 10.1.100.1 is on vlan10 + cisco.nxos.nxos_vrrp: + interface: vlan10 + group: 100 + vip: 10.1.100.1 + + - name: Ensure removal of the vrrp group config + cisco.nxos.nxos_vrrp: + interface: vlan10 + group: 100 + vip: 10.1.100.1 + state: absent + + - name: Re-config with more params + cisco.nxos.nxos_vrrp: + interface: vlan10 + group: 100 + vip: 10.1.100.1 + preempt: false + priority: 130 + authentication: AUTHKEY + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['interface vlan10', 'vrrp 150', 'address 10.1.15.1', 'authentication text testing', 'no shutdown']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jason Edelman (@jedelman8) +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_vsan_module.rst b/docs/cisco.nxos.nxos_vsan_module.rst new file mode 100644 index 000000000..9baa64c68 --- /dev/null +++ b/docs/cisco.nxos.nxos_vsan_module.rst @@ -0,0 +1,225 @@ +.. _cisco.nxos.nxos_vsan_module: + + +******************** +cisco.nxos.nxos_vsan +******************** + +**Configuration of vsan for Cisco NXOS MDS Switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Configuration of vsan for Cisco MDS NXOS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ vsan + +
+ list + / elements=dictionary +
+ 		+ +
List of vsan details to be added or removed
+
+
+ id + +
+ integer + / required +
+ 		+ +
Vsan id
+
+
+ interface + +
+ list + / elements=string +
+ 		+ +
List of vsan's interfaces to be added
+
+
+ name + +
+ string +
+ 		+ +
Name of the vsan
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Removes the vsan if True
+
+
+ suspend + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
suspend the vsan if True
+
+
+ + +Notes +----- + +.. note:: + - Tested against Cisco MDS NX-OS 8.4(1) + + + +Examples +-------- + +.. code-block:: yaml + + - name: Test that vsan module works + cisco.nxos.nxos_vsan: + vsan: + - id: 922 + interface: + - fc1/1 + - fc1/2 + - port-channel 1 + name: vsan-SAN-A + remove: false + suspend: false + - id: 923 + interface: + - fc1/11 + - fc1/21 + - port-channel 2 + name: vsan-SAN-B + remove: false + suspend: true + - id: 1923 + name: vsan-SAN-Old + remove: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['terminal dont-ask', 'vsan database', 'vsan 922 interface fc1/40', 'vsan 922 interface port-channel 155', 'no terminal dont-ask']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) diff --git a/docs/cisco.nxos.nxos_vxlan_vtep_module.rst b/docs/cisco.nxos.nxos_vxlan_vtep_module.rst new file mode 100644 index 000000000..57fdc14a3 --- /dev/null +++ b/docs/cisco.nxos.nxos_vxlan_vtep_module.rst @@ -0,0 +1,332 @@ +.. _cisco.nxos.nxos_vxlan_vtep_module: + + +************************** +cisco.nxos.nxos_vxlan_vtep +************************** + +**Manages VXLAN Network Virtualization Endpoint (NVE).** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages VXLAN Network Virtualization Endpoint (NVE) overlay interface that terminates VXLAN tunnels. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ advertise_virtual_rmac + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
The advertise_virtual_rmac parameter lets BGP to use the VMAC with VIP as next-hop when advertising type-2 routes. Should be used together with advertise_pip parameter from cisco.nxos.nxos_bgp_address_family module.
+
+
+ description + +
+ string +
+ 		+ +
Description of the NVE interface.
+
+
+ global_ingress_replication_bgp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configures ingress replication protocol as bgp for all VNIs. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
+
+
+ global_mcast_group_L2 + +
+ string +
+ 		+ +
Global multicast IP prefix for L2 VNIs or the keyword 'default'. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
+
+
+ global_mcast_group_L3 + +
+ string +
+ 		+ +
Global multicast IP prefix for L3 VNIs or the keyword 'default'. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher.
+
+
+ global_suppress_arp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables ARP suppression for all VNIs. This is available on NX-OS 9K series running 9.2.x or higher.
+
+
+ host_reachability + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specify mechanism for host reachability advertisement. A Boolean value of 'true' indicates that BGP will be used for host reachability advertisement. A Boolean value of 'false' indicates that no protocol is used for host reachability advertisement. Other host reachability advertisement protocols (e.g. OpenFlow, controller, etc.) are not supported.
+
+
+ interface + +
+ string + / required +
+ 		+ +
Interface name for the VXLAN Network Virtualization Endpoint.
+
+
+ multisite_border_gateway_interface + +
+ string +
+
added in 1.1.0
+ 		+ +
Specify the loopback interface whose IP address should be used for the NVE Multisite Border-gateway Interface. This is available on specific Nexus 9000 series switches running NX-OS 7.0(3)I7(x) or higher. Specify "default" to remove an existing gateway config.
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown the NVE interface.
+
+
+ source_interface + +
+ string +
+ 		+ +
Specify the loopback interface whose IP address should be used for the NVE interface.
+
+
+ source_interface_hold_down_time + +
+ string +
+ 		+ +
Suppresses advertisement of the NVE loopback address until the overlay has converged.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Determines whether the config should be present or not on the device.
+
+
+ + +Notes +----- + +.. note:: + - Tested against NXOSv 7.3.(0)D1(1) on VIRL + - Unsupported for Cisco MDS + - The module is used to manage NVE properties, not to create NVE interfaces. Use :ref:`cisco.nxos.nxos_interfaces ` if you wish to do so. + - ``state=absent`` removes the interface. + - Default, where supported, restores params default value. + - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide ` + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + - cisco.nxos.nxos_vxlan_vtep: + interface: nve1 + description: default + host_reachability: true + source_interface: Loopback0 + source_interface_hold_down_time: 30 + shutdown: default + multisite_border_gateway_interface: Loopback0 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['interface nve1', 'source-interface loopback0', 'source-interface hold-down-time 30', 'description simple description', 'shutdown', 'host-reachability protocol bgp', 'multisite border-gateway interface loopback0']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Gabriele Gerbino (@GGabriele) diff --git a/docs/cisco.nxos.nxos_zone_zoneset_module.rst b/docs/cisco.nxos.nxos_zone_zoneset_module.rst new file mode 100644 index 000000000..95ef4972a --- /dev/null +++ b/docs/cisco.nxos.nxos_zone_zoneset_module.rst @@ -0,0 +1,537 @@ +.. _cisco.nxos.nxos_zone_zoneset_module: + + +**************************** +cisco.nxos.nxos_zone_zoneset +**************************** + +**Configuration of zone/zoneset for Cisco NXOS MDS Switches.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Configuration of zone/zoneset for Cisco MDS NXOS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ zone_zoneset_details + +
+ list + / elements=dictionary +
+ 		+ +
List of zone/zoneset details to be added or removed
+
+
+ default_zone + +
+ string +
+ 		+
    Choices: +
  • permit
    • +
  • deny
    • +
+ 		+
default zone behaviour for the vsan
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • enhanced
    • +
  • basic
    • +
+ 		+
mode of the zone for the vsan
+
+
+ smart_zoning + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Removes the vsan if True
+
+
+ vsan + +
+ integer + / required +
+ 		+ +
vsan id
+
+
+ zone + +
+ list + / elements=dictionary +
+ 		+ +
List of zone options for that vsan
+
+
+ members + +
+ list + / elements=dictionary +
+ 		+ +
Members of the zone that needs to be removed or added
+
+
+ devtype + +
+ string +
+ 		+
    Choices: +
  • initiator
    • +
  • target
    • +
  • both
    • +
+ 		+
devtype of the zone member used along with Smart zoning config
+
+
+ pwwn + +
+ string + / required +
+ 		+ +
pwwn member of the zone, use alias 'device_alias' as option for device_alias member
+

aliases: device_alias
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Removes member from the zone if True
+
+
+ name + +
+ string + / required +
+ 		+ +
name of the zone
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Deletes the zone if True
+
+
+ zoneset + +
+ list + / elements=dictionary +
+ 		+ +
List of zoneset options for the vsan
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • activate
    • +
  • deactivate
    • +
+ 		+
activates/de-activates the zoneset
+
+
+ members + +
+ list + / elements=dictionary +
+ 		+ +
Members of the zoneset that needs to be removed or added
+
+
+ name + +
+ string + / required +
+ 		+ +
name of the zone that needs to be added to the zoneset or removed from the zoneset
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Removes zone member from the zoneset
+
+
+ name + +
+ string + / required +
+ 		+ +
name of the zoneset
+
+
+ remove + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Removes zoneset if True
+
+
+ + +Notes +----- + +.. note:: + - Tested against Cisco MDS NX-OS 8.4(1) + + + +Examples +-------- + +.. code-block:: yaml + + - name: Test that zone/zoneset module works + cisco.nxos.nxos_zone_zoneset: + zone_zoneset_details: + - mode: enhanced + vsan: 22 + zone: + - members: + - pwwn: 31314874576271 + - device_alias: test123 + - pwwn: '61:61:62:62:12:12:12:12' + remove: true + name: zoneA + - members: + - pwwn: 28515514576271 + - pwwn: '62:62:62:62:21:21:21:21' + name: zoneB + - name: zoneC + remove: true + zoneset: + - action: activate + members: + - name: zoneA + - name: zoneB + - name: zoneC + remove: true + name: zsetname1 + - action: deactivate + name: zsetTestExtra + remove: true + - mode: basic + smart_zoning: true + vsan: 21 + zone: + - members: + - devtype: both + pwwn: 31314874576271 + - pwwn: '62:62:62:62:12:12:12:12' + - devtype: both + pwwn: '92:62:62:62:12:12:1a:1a' + remove: true + name: zone21A + - members: + - pwwn: 28515514576271 + - pwwn: '62:62:62:62:21:21:21:21' + name: zone21B + zoneset: + - action: activate + members: + - name: zone21A + - name: zone21B + name: zsetname212 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
commands sent to the device
+
+
Sample:
+
['terminal dont-ask', 'zone name zoneA vsan 923', 'member pwwn 11:11:11:11:11:11:11:11', 'no member device-alias test123', 'zone commit vsan 923', 'no terminal dont-ask']
+
+
+ messages + +
+ list +
+ 		always +
debug messages
+
+
Sample:
+
['zone mode is already enhanced ,no change in zone mode configuration for vsan 922', "zone member '11:11:11:11:11:11:11:11' is already present in zone 'zoneA' in vsan 922 hence nothing to add", "zone member 'test123' is already present in zone 'zoneA' in vsan 922 hence nothing to add", "zone member '61:61:62:62:12:12:12:12' is not present in zone 'zoneA' in vsan 922 hence nothing to remove", "zone member '10:11:11:11:11:11:11:11' is already present in zone 'zoneB' in vsan 922 hence nothing to add", "zone member '62:62:62:62:21:21:21:21' is already present in zone 'zoneB' in vsan 922 hence nothing to add", "zone 'zoneC' is not present in vsan 922 , so nothing to remove"]
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Suhas Bharadwaj (@srbharadwaj) (subharad@cisco.com) From 392fa792a96fee953f051c707e805e8896fc6099 Mon Sep 17 00:00:00 2001 From: Vinay Mulugund Date: Fri, 8 Mar 2024 18:14:06 +0530 Subject: [PATCH 16/30] new parsers --- .../spanning_tree_global.py | 8 ++- .../module_utils/network/nxos/facts/facts.py | 4 ++ .../spanning_tree_global.py | 10 +-- .../nxos/rm_templates/spanning_tree_global.py | 71 +++++++------------ plugins/modules/nxos_spanning_tree_global.py | 8 ++- 5 files changed, 44 insertions(+), 57 deletions(-) diff --git a/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py index 1c4663861..1cfa7fa14 100644 --- a/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py @@ -28,8 +28,8 @@ dict_merge, ) -from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.facts.facts import Facts -from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.rm_templates.spanning_tree_global import ( +from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.facts.facts import Facts +from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.rm_templates.spanning_tree_global import ( Spanning_tree_globalTemplate, ) @@ -47,7 +47,9 @@ def __init__(self, module): resource="spanning_tree_global", tmplt=Spanning_tree_globalTemplate(), ) - self.parsers = [] + self.parsers = [ + "bridge.bridge_assurance", + ] def execute_module(self): """Execute the module diff --git a/plugins/module_utils/network/nxos/facts/facts.py b/plugins/module_utils/network/nxos/facts/facts.py index a7c2ab350..0ed28d4a2 100644 --- a/plugins/module_utils/network/nxos/facts/facts.py +++ b/plugins/module_utils/network/nxos/facts/facts.py @@ -102,6 +102,9 @@ from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.facts.snmp_server.snmp_server import ( Snmp_serverFacts, ) +from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.facts.spanning_tree_global.spanning_tree_global import ( + Spanning_tree_globalFacts, +) from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.facts.static_routes.static_routes import ( Static_routesFacts, ) @@ -150,6 +153,7 @@ snmp_server=Snmp_serverFacts, hostname=HostnameFacts, bgp_templates=Bgp_templatesFacts, + spanning_tree_global=Spanning_tree_globalFacts, ) MDS_FACT_RESOURCE_SUBSETS = dict( fc_interfaces=Fc_interfacesFacts, diff --git a/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py index 971c68cbd..6cbd3d7b6 100644 --- a/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py @@ -20,10 +20,10 @@ from ansible.module_utils.six import iteritems from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import utils -from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.argspec.spanning_tree_global.spanning_tree_global import ( +from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.argspec.spanning_tree_global.spanning_tree_global import ( Spanning_tree_globalArgs, ) -from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.rm_templates.spanning_tree_global import ( +from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.rm_templates.spanning_tree_global import ( Spanning_tree_globalTemplate, ) @@ -39,7 +39,9 @@ def get_config(self, connection): """Wrapper method for `connection.get()` This method exists solely to allow the unit test framework to mock device connection calls. """ - return connection.get("show running-config | section '^spanning-tree'") + summary = connection.get("show spanning-tree summary") + general = connection.get("show running-config | section '^spanning-tree'") + return summary + general def populate_facts(self, connection, ansible_facts, data=None): """Populate the facts for Spanning_tree_global network resource @@ -62,7 +64,7 @@ def populate_facts(self, connection, ansible_facts, data=None): lines=data.splitlines(), module=self._module, ) - objs = list(spanning_tree_global_parser.parse().values()) + objs = spanning_tree_global_parser.parse() ansible_facts["ansible_network_resources"].pop("spanning_tree_global", None) diff --git a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py index d2ceb8ee7..997f69e10 100644 --- a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py @@ -29,83 +29,60 @@ def __init__(self, lines=None, module=None): # fmt: off PARSERS = [ { - "name": "bridge_assurance", + "name": "bridge.bridge_assurance", "getval": re.compile( r""" - ^spanning-tree - \sbridge\s(?Passurance) + ^Bridge\sAssurance + \s*(?Pis\senabled|is\sdisabled) $""", re.VERBOSE, ), "setval": "spanning-tree bridge assurance", "result": { - "bridge_assurance": "{{ True if assurance is defined else None }}", + "bridge": { + "bridge_assurance": "{{ True if 'enabled' in is_enabled else False }}", + }, }, }, { - "name": "bridge_domain", - "getval": re.compile( - r""" - ^spanning-tree - \sbridge-domain\s(?P\S+) - $""", re.VERBOSE, - ), - "setval": "spanning-tree bridge-domain {{ range }}", - "result": { - "bridge_domain": "{{ range }}", - }, - }, - { - "name": "fcoe", - "getval": re.compile( - r""" - ^spanning-tree - \s(?Pfcoe) - $""", re.VERBOSE, - ), - "setval": "spanning-tree fcoe", - "result": { - "fcoe": "{{ True if fcoe is defined else None }}", - }, - }, - { - "name": "lc_issu", + "name": "loopguard_default", "getval": re.compile( r""" - ^spanning-tree - \slc-issu\s(?Pauto|disruptive|non-disruptive) + ^Loopguard\sDefault + \s*(?Pis\senabled|is\sdisabled) $""", re.VERBOSE, ), - "setval": "spanning-tree lc-issu {{ lc_issu }}", + "setval": "spanning-tree loopguard default", "result": { - "lc_issu": "{{ lc_issu }}", + "loopguard_default": "{{ True if 'enabled' in is_enabled else False }}", }, }, { - "name": "loopguard_default", + "name": "mode", "getval": re.compile( r""" - ^spanning-tree - \sloopguard - \s(?Pdefault) + ^Switch\sis\sin + \s(?Pmst|rapid-pvst) + \smode + (\s\(IEEE\sStandard\))? $""", re.VERBOSE, ), - "setval": "spanning-tree loopguard default", + "setval": "spanning-tree mode {{ mode }}", "result": { - "loopguard_default": "{{ True if default is defined else None }}", + "mode": "{{ mode_val }}", }, }, { - "name": "mode", + "name": "pathcost_method", "getval": re.compile( r""" - ^spanning-tree - (\smode\s(?Pmst|rapid-pvst)) + ^Pathcost\smethod\sused + \s*is\s(?Plong|short) $""", re.VERBOSE, ), - "setval": "spanning-tree mode {{ mode }}", + "setval": "spanning-tree pathcost method {{ pathcost_method }}", "result": { - "mode": "{{ mode }}", + "pathcost_method": "{{ pc_method }}", }, - }, + } ] # fmt: on diff --git a/plugins/modules/nxos_spanning_tree_global.py b/plugins/modules/nxos_spanning_tree_global.py index 3b83b37bb..40e00f65e 100644 --- a/plugins/modules/nxos_spanning_tree_global.py +++ b/plugins/modules/nxos_spanning_tree_global.py @@ -381,14 +381,16 @@ from ansible.module_utils.basic import AnsibleModule -from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.argspec.spanning_tree_global.spanning_tree_global import ( +from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.argspec.spanning_tree_global.spanning_tree_global import ( Spanning_tree_globalArgs, ) -from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.config.spanning_tree_global.spanning_tree_global import ( +from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.config.spanning_tree_global.spanning_tree_global import ( Spanning_tree_global, ) - +import debugpy +debugpy.listen(3000) +debugpy.wait_for_client() def main(): """ Main entry point for module execution From 89acdf3f576d7afabcbc7184c34e558ca3c19204 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 8 Mar 2024 12:45:05 +0000 Subject: [PATCH 17/30] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .../network/nxos/rm_templates/spanning_tree_global.py | 2 +- plugins/modules/nxos_spanning_tree_global.py | 6 +++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py index 997f69e10..2c28f9248 100644 --- a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py @@ -83,6 +83,6 @@ def __init__(self, lines=None, module=None): "result": { "pathcost_method": "{{ pc_method }}", }, - } + }, ] # fmt: on diff --git a/plugins/modules/nxos_spanning_tree_global.py b/plugins/modules/nxos_spanning_tree_global.py index 40e00f65e..322d787e9 100644 --- a/plugins/modules/nxos_spanning_tree_global.py +++ b/plugins/modules/nxos_spanning_tree_global.py @@ -379,6 +379,8 @@ module argspec. """ +import debugpy + from ansible.module_utils.basic import AnsibleModule from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.argspec.spanning_tree_global.spanning_tree_global import ( @@ -388,9 +390,11 @@ Spanning_tree_global, ) -import debugpy + debugpy.listen(3000) debugpy.wait_for_client() + + def main(): """ Main entry point for module execution From 089243e833a3ff8e095be57792737ba25475a838 Mon Sep 17 00:00:00 2001 From: Vinay Mulugund Date: Fri, 8 Mar 2024 19:16:44 +0530 Subject: [PATCH 18/30] argspec changes --- ....nxos.nxos_spanning_tree_global_module.rst | 9 +++++---- .../spanning_tree_global.py | 9 +++++---- plugins/modules/nxos_spanning_tree_global.py | 19 +++++++------------ 3 files changed, 17 insertions(+), 20 deletions(-) diff --git a/docs/cisco.nxos.nxos_spanning_tree_global_module.rst b/docs/cisco.nxos.nxos_spanning_tree_global_module.rst index 003169da0..d3633c0a1 100644 --- a/docs/cisco.nxos.nxos_spanning_tree_global_module.rst +++ b/docs/cisco.nxos.nxos_spanning_tree_global_module.rst @@ -93,7 +93,8 @@ Parameters bridge_domain
- dictionary + list + / elements=dictionary
@@ -582,8 +583,7 @@ Parameters configure_mst
- list - / elements=dictionary + dictionary
@@ -1139,7 +1139,8 @@ Parameters vlan
- dictionary + list + / elements=dictionary
diff --git a/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py index 0c8604dd0..7a093303d 100644 --- a/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py @@ -41,7 +41,8 @@ class Spanning_tree_globalArgs(object): # pylint: disable=R0903 "options": { "bridge_assurance": {"type": "bool"}, "bridge_domain": { - "type": "dict", + "type": "list", + "elements": "dict", "options": { "bd_list_range": {"type": "str"}, "forward_time": {"type": "int"}, @@ -102,8 +103,7 @@ class Spanning_tree_globalArgs(object): # pylint: disable=R0903 "max_hops": {"type": "int"}, "simulate_pvst_global": {"type": "bool"}, "configure_mst": { - "type": "list", - "elements": "dict", + "type": "dict", "options": { "name": {"type": "str"}, "revision": {"type": "int"}, @@ -165,7 +165,8 @@ class Spanning_tree_globalArgs(object): # pylint: disable=R0903 }, }, "vlan": { - "type": "dict", + "type": "list", + "elements": "dict", "options": { "vlan_range": {"type": "str"}, "forward_time": {"type": "int"}, diff --git a/plugins/modules/nxos_spanning_tree_global.py b/plugins/modules/nxos_spanning_tree_global.py index 322d787e9..57aa90869 100644 --- a/plugins/modules/nxos_spanning_tree_global.py +++ b/plugins/modules/nxos_spanning_tree_global.py @@ -39,7 +39,8 @@ type: bool bridge_domain: decsription: Bridge-Domain Spanning Trees range. - type: dict + type: list + elements: dict suboptions: bd_list_range: description: Bridge-Domain Spanning Trees range. @@ -144,8 +145,7 @@ type: bool configure_mst: description: MST configuration submode options. - type: list - elements: dict + type: dict suboptions: name: description: MST configuration submode instance name. @@ -238,7 +238,8 @@ type: int vlan: description: VLAN Switch Spanning Trees. - type: dict + type: list + elements: dict suboptions: vlan_range: description: VLAN range for spanning tree. @@ -379,22 +380,16 @@ module argspec. """ -import debugpy - from ansible.module_utils.basic import AnsibleModule -from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.argspec.spanning_tree_global.spanning_tree_global import ( +from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.argspec.spanning_tree_global.spanning_tree_global import ( Spanning_tree_globalArgs, ) -from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.config.spanning_tree_global.spanning_tree_global import ( +from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.config.spanning_tree_global.spanning_tree_global import ( Spanning_tree_global, ) -debugpy.listen(3000) -debugpy.wait_for_client() - - def main(): """ Main entry point for module execution From 873885351b4f1c2dfc2cf347ff1823a3ae6f23e5 Mon Sep 17 00:00:00 2001 From: Vinay Mulugund Date: Mon, 11 Mar 2024 00:23:22 +0530 Subject: [PATCH 19/30] Added more parsers --- ....nxos.nxos_spanning_tree_global_module.rst | 7 +- plugins/cache/__init__.py | 0 plugins/lookup/__init__.py | 0 plugins/module_utils/common/__init__.py | 0 .../spanning_tree_global.py | 7 +- .../spanning_tree_global.py | 2 +- .../nxos/rm_templates/spanning_tree_global.py | 325 ++++++++++++++++++ plugins/modules/nxos_spanning_tree_global.py | 7 +- 8 files changed, 338 insertions(+), 10 deletions(-) delete mode 100644 plugins/cache/__init__.py delete mode 100644 plugins/lookup/__init__.py delete mode 100644 plugins/module_utils/common/__init__.py diff --git a/docs/cisco.nxos.nxos_spanning_tree_global_module.rst b/docs/cisco.nxos.nxos_spanning_tree_global_module.rst index d3633c0a1..614256649 100644 --- a/docs/cisco.nxos.nxos_spanning_tree_global_module.rst +++ b/docs/cisco.nxos.nxos_spanning_tree_global_module.rst @@ -601,7 +601,8 @@ Parameters instance_vlan
- dictionary + list + / elements=dictionary
@@ -713,7 +714,7 @@ Parameters
- forward-time + forward_time
integer @@ -730,7 +731,7 @@ Parameters
- hello-time + hello_time
integer diff --git a/plugins/cache/__init__.py b/plugins/cache/__init__.py deleted file mode 100644 index e69de29bb..000000000 diff --git a/plugins/lookup/__init__.py b/plugins/lookup/__init__.py deleted file mode 100644 index e69de29bb..000000000 diff --git a/plugins/module_utils/common/__init__.py b/plugins/module_utils/common/__init__.py deleted file mode 100644 index e69de29bb..000000000 diff --git a/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py index 7a093303d..59b027672 100644 --- a/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py @@ -97,8 +97,8 @@ class Spanning_tree_globalArgs(object): # pylint: disable=R0903 "mst": { "type": "dict", "options": { - "forward-time": {"type": "int"}, - "hello-time": {"type": "int"}, + "forward_time": {"type": "int"}, + "hello_time": {"type": "int"}, "max_age": {"type": "int"}, "max_hops": {"type": "int"}, "simulate_pvst_global": {"type": "bool"}, @@ -109,7 +109,8 @@ class Spanning_tree_globalArgs(object): # pylint: disable=R0903 "revision": {"type": "int"}, "private_vlan_sync": {"type": "bool"}, "instance_vlan": { - "type": "dict", + "type": "list", + "elements": "dict", "options": { "instance_id": {"type": "int"}, "vlan_range": {"type": "str"}, diff --git a/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py index 6cbd3d7b6..206d9fb1a 100644 --- a/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py @@ -40,7 +40,7 @@ def get_config(self, connection): This method exists solely to allow the unit test framework to mock device connection calls. """ summary = connection.get("show spanning-tree summary") - general = connection.get("show running-config | section '^spanning-tree'") + general = connection.get("show running-config spanning-tree") return summary + general def populate_facts(self, connection, ansible_facts, data=None): diff --git a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py index 2c28f9248..b4d3b7532 100644 --- a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py @@ -43,6 +43,185 @@ def __init__(self, lines=None, module=None): }, }, }, + { + "name": "bridge.bridge_domain", + "getval": re.compile( + r""" + ^spanning-tree\sbridge-domain + \s(?P\d+) + (\sforward-time\s(?P\d+))? + (\shello-time\s(?P\d+))? + (\smax-age\s(?P\d+))? + (\spriority\s(?P\d+))? + $""", re.VERBOSE, + ), + "setval": "spanning-tree bridge-domain {{ bd_list_range }}" + "{{ (' forward-time ' + forward_time|string) if forward_time is defined else '' }}" + "{{ (' hello-time ' + hello_time|string) if hello_time is defined else '' }}" + "{{ (' max-age ' + max_age|string) if max_age is defined else '' }}" + "{{ (' priority ' + priority|string) if priority is defined else ''}}", + "result": { + "bridge": { + "bridge_domain": { + "{{ b_domain_range }}": { + "bd_list_range": "{{ b_domain_range }}", + "forward_time": "{{ forward_time }}", + "hello_time": "{{ hello_time }}", + "max_age": "{{ max_age }}", + "priority": "{{ priority }}", + }, + }, + }, + }, + }, + { + "name": "bridge.bridge_domain.root.primary", + "getval": re.compile( + r""" + ^spanning-tree\sbridge-domain + \s(?P\d+) + \sroot\sprimary + (\sdiameter\s(?P\d+))? + (\shello-time\s(?P\d+))? + $""", re.VERBOSE, + ), + "setval": "spanning-tree bridge-domain {{ bd_list_range }}" + " root primary" + "{{ (' diameter ' + root.primary.diameter|string) if root.primary.diameter is defined else '' }}" + "{{ (' hello-time ' + root.primary.hello_time|string) if root.primary.hello_time is defined else '' }}", + "result": { + "bridge": { + "bridge_domain": { + "{{ b_domain_range }}": { + "bd_list_range": "{{ b_domain_range }}", + "root": { + "primary": { + "diameter": "{{ diameter }}", + "hello_time": "{{ hello_time }}", + }, + }, + }, + }, + }, + }, + }, + { + "name": "bridge.bridge_domain.root.secondary", + "getval": re.compile( + r""" + ^spanning-tree\sbridge-domain + \s(?P\d+) + \sroot\ssecondary + (\sdiameter\s(?P\d+))? + (\shello-time\s(?P\d+))? + $""", re.VERBOSE, + ), + "setval": "spanning-tree bridge-domain {{ bd_list_range }}" + " root secondary" + "{{ (' diameter ' + root.secondary.diameter|string) if root.secondary.diameter is defined else '' }}" + "{{ (' hello-time ' + root.secondary.hello_time|string) if root.secondary.hello_time is defined else '' }}", + "result": { + "bridge": { + "bridge_domain": { + "{{ b_domain_range }}": { + "bd_list_range": "{{ b_domain_range }}", + "root": { + "secondary": { + "diameter": "{{ diameter }}", + "hello_time": "{{ hello_time }}", + }, + }, + }, + }, + }, + }, + }, + { + "name": "domain.identifier", + "getval": re.compile( + r""" + ^spanning-tree\domain + \s(?P\d+) + $""", re.VERBOSE, + ), + "setval": "spanning-tree domain {{ identifier }}", + "result": { + "domain": { + "identifier": "{{ identifier }}", + }, + }, + }, + { + "name": "domain.disable", + "getval": re.compile( + r""" + ^spanning-tree\domain + \s(?Pdisable) + $""", re.VERBOSE, + ), + "setval": "spanning-tree domain disable", + "result": { + "domain": { + "disable": "{{ True if disable is defined else False }}", + }, + }, + }, + { + "name": "domain.enable", + "getval": re.compile( + r""" + ^spanning-tree\domain + \s(?Penable) + $""", re.VERBOSE, + ), + "setval": "spanning-tree domain enable", + "result": { + "domain": { + "enable": "{{ True if enable is defined else False }}", + }, + }, + }, + { + "name": "domain.clear_stats", + "getval": re.compile( + r""" + ^spanning-tree\domain + \s(?Pclear\sstatistics) + $""", re.VERBOSE, + ), + "setval": "spanning-tree domain enable", + "result": { + "domain": { + "clear_stats": "{{ True if clear is defined else False }}", + }, + }, + }, + { + "name": "fcoe", + "getval": re.compile( + r""" + ^no\sspanning-tree + \s(?Pfcoe) + $""", re.VERBOSE, + ), + "setval": "spanning-tree fcoe", + "result": { + "fcoe": "{{ False if fcoe is defined else True }}", + }, + }, + { + "name": "lc_issu", + "getval": re.compile( + r""" + ^spanning-tree\slc-issu + \s(?Pauto|disruptive|non-disruptive) + $""", re.VERBOSE, + ), + "setval": "spanning-tree lc-issu {{ lc_issu }}", + "result": { + "lc_issu": "{{ lc_issu }}", + }, + }, { "name": "loopguard_default", "getval": re.compile( @@ -71,6 +250,152 @@ def __init__(self, lines=None, module=None): "mode": "{{ mode_val }}", }, }, + { + "name": "mst.forward_time", + "getval": re.compile( + r""" + ^spanning-tree\smst + \sforward-time\s(?P\d+) + $""", re.VERBOSE, + ), + "setval": "spanning-tree mst forward-time {{ forward_time }}", + "result": { + "mst": { + "forward_time": "{{ forward_time }}", + }, + }, + }, + { + "name": "mst.hello_time", + "getval": re.compile( + r""" + ^spanning-tree\smst + \shello-time\s(?P\d+) + $""", re.VERBOSE, + ), + "setval": "spanning-tree mst hello-time {{ hello_time }}", + "result": { + "mst": { + "hello_time": "{{ hello_time }}", + }, + }, + }, + { + "name": "mst.max_age", + "getval": re.compile( + r""" + ^spanning-tree\smst + \smax-age\s(?P\d+) + $""", re.VERBOSE, + ), + "setval": "spanning-tree mst max-age {{ max_age }}", + "result": { + "mst": { + "max_age": "{{ max_age }}", + }, + }, + }, + { + "name": "mst.max_hops", + "getval": re.compile( + r""" + ^spanning-tree\smst + \smax-hops\s(?P\d+) + $""", re.VERBOSE, + ), + "setval": "spanning-tree mst max-hops {{ max_hops }}", + "result": { + "mst": { + "max_hops": "{{ max_hops }}", + }, + }, + }, + { + "name": "mst.simulate_pvst_global", + "getval": re.compile( + r""" + ^PVST\sSimulation + \s+is\s(?Penabled|disabled) + $""", re.VERBOSE, + ), + "setval": "spanning-tree mst simulate pvst global", + "result": { + "mst": { + "simulate_pvst_global": "{{ True if 'enabled' in simulate_pvst_global else False }}", + }, + }, + }, + { + "name": "mst.configure_mst.name", + "getval": re.compile( + r""" + ^\s+name\s(?P\S+) + $""", re.VERBOSE, + ), + "setval": "name {{ configure_mst.name }}", + "result": { + "mst": { + "configure_mst": { + "name": "{{ name }}", + }, + }, + }, + }, + { + "name": "mst.configure_mst.revision", + "getval": re.compile( + r""" + ^\s+revision\s(?P\S+) + $""", re.VERBOSE, + ), + "setval": "revision {{ configure_mst.revision }}", + "result": { + "mst": { + "configure_mst": { + "revision": "{{ revision }}", + }, + }, + }, + }, + { + "name": "mst.configure_mst.private_vlan_sync", + "getval": re.compile( + r""" + ^\s+private-vlan\s(?Psynchronize) + $""", re.VERBOSE, + ), + "setval": "private-vlan synchronize", + "result": { + "mst": { + "configure_mst": { + "private_vlan_sync": "{{ True if synchronize is defined else False }}", + }, + }, + }, + }, + { + "name": "mst.configure_mst.instance_vlan", + "getval": re.compile( + r""" + ^\s+instance + \s(?P\d+) + \svlan\s(?P\d+) + $""", re.VERBOSE, + ), + "setval": "private-vlan synchronize", + "result": { + "mst": { + "configure_mst": { + "instance_vlan": { + "{{ instance_id }}": { + "instance_id": "{{ instance_id }}", + "vlan_range": "{{ vlan_range }}", + }, + }, + }, + }, + }, + }, { "name": "pathcost_method", "getval": re.compile( diff --git a/plugins/modules/nxos_spanning_tree_global.py b/plugins/modules/nxos_spanning_tree_global.py index 57aa90869..befe12359 100644 --- a/plugins/modules/nxos_spanning_tree_global.py +++ b/plugins/modules/nxos_spanning_tree_global.py @@ -128,10 +128,10 @@ description: Multiple spanning tree configuration. type: dict suboptions: - forward-time: + forward_time: description: Forward time for MST. type: int - hello-time: + hello_time: description: Hello time for MST. type: int max_age: @@ -158,7 +158,8 @@ type: bool instance_vlan: description: MST configuration submode instance. - type: dict + type: list + elements: dict suboptions: instance_id: description: MST configuration submode instance id. From b214e07f265b6b5bd1e40fadf57d4043da479066 Mon Sep 17 00:00:00 2001 From: Vinay Mulugund Date: Mon, 11 Mar 2024 09:33:28 +0530 Subject: [PATCH 20/30] fixed port type argspec --- ....nxos.nxos_spanning_tree_global_module.rst | 45 +++++++++++++------ .../spanning_tree_global.py | 11 ++--- plugins/modules/nxos_spanning_tree_global.py | 24 +++++----- 3 files changed, 51 insertions(+), 29 deletions(-) diff --git a/docs/cisco.nxos.nxos_spanning_tree_global_module.rst b/docs/cisco.nxos.nxos_spanning_tree_global_module.rst index 614256649..b2cc200bc 100644 --- a/docs/cisco.nxos.nxos_spanning_tree_global_module.rst +++ b/docs/cisco.nxos.nxos_spanning_tree_global_module.rst @@ -840,20 +840,20 @@ Parameters
- default + default_type
- boolean + string
    Choices: -
  • no
    • -
  • yes
    • +
  • network
    • +
  • edge
-
Enable default port type.
+
Select default port type.
@@ -864,26 +864,44 @@ Parameters edge
- string + dictionary +
+ + + + +
Configure edge port type.
+ + + + + + + +
+ bpdufilter + +
+ boolean
    Choices: -
  • bpdufilter
    • -
  • bpduguard
    • -
  • default
    • +
  • no
    • +
  • yes
-
Enable edge port type.
+
Enable edge bpdufilter.
- + +
- network + bpduguard
boolean @@ -896,10 +914,11 @@ Parameters -
Enable network port type.
+
Enable edge bpduguard.
+ diff --git a/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py index 59b027672..d7c7e0047 100644 --- a/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py @@ -123,14 +123,15 @@ class Spanning_tree_globalArgs(object): # pylint: disable=R0903 "pathcost_method": {"type": "str", "choices": ["long", "short"]}, "port_type": { "type": "dict", - "mutually_exclusive": [["edge", "network", "default"]], "options": { "edge": { - "type": "str", - "choices": ["bpdufilter", "bpduguard", "default"], + "type": "dict", + "options": { + "bpduguard": {"type": "bool"}, + "bpdufilter": {"type": "bool"}, + }, }, - "network": {"type": "bool"}, - "default": {"type": "bool"}, + "default_type": {"type": "str", "choices": ["edge", "network"]}, }, }, "pseudo_info": { diff --git a/plugins/modules/nxos_spanning_tree_global.py b/plugins/modules/nxos_spanning_tree_global.py index befe12359..4b2db9e2b 100644 --- a/plugins/modules/nxos_spanning_tree_global.py +++ b/plugins/modules/nxos_spanning_tree_global.py @@ -176,21 +176,23 @@ port_type: description: Spanning tree port type. type: dict - mutually_exclusive: [["edge", "network", "default"]] suboptions: edge: - description: Enable edge port type. + description: Configure edge port type. + type: dict + suboptions: + bpdufilter: + description: Enable edge bpdufilter. + type: bool + bpduguard: + description: Enable edge bpduguard. + type: bool + default_type: + description: Select default port type. type: str choices: - - bpdufilter - - bpduguard - - default - network: - description: Enable network port type. - type: bool - default: - description: Enable default port type. - type: bool + - network + - edge pseudo_info: description: Configure spanning tree pseudo information type: dict From 429255bc148b8d18334cfca1a317083d3a61c580 Mon Sep 17 00:00:00 2001 From: Vinay Mulugund Date: Mon, 11 Mar 2024 15:50:56 +0530 Subject: [PATCH 21/30] All parsers --- ....nxos.nxos_spanning_tree_global_module.rst | 9 +- .../spanning_tree_global.py | 9 +- .../nxos/rm_templates/spanning_tree_global.py | 398 +++++++++++++++++- plugins/modules/nxos_spanning_tree_global.py | 9 +- 4 files changed, 401 insertions(+), 24 deletions(-) diff --git a/docs/cisco.nxos.nxos_spanning_tree_global_module.rst b/docs/cisco.nxos.nxos_spanning_tree_global_module.rst index b2cc200bc..935a518dc 100644 --- a/docs/cisco.nxos.nxos_spanning_tree_global_module.rst +++ b/docs/cisco.nxos.nxos_spanning_tree_global_module.rst @@ -943,7 +943,8 @@ Parameters bridge_domain_info
- dictionary + list + / elements=dictionary
@@ -1015,7 +1016,8 @@ Parameters mst_info
- dictionary + list + / elements=dictionary
@@ -1087,7 +1089,8 @@ Parameters vlan_info
- dictionary + list + / elements=dictionary
diff --git a/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py index d7c7e0047..f7fd77c0c 100644 --- a/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py @@ -138,7 +138,8 @@ class Spanning_tree_globalArgs(object): # pylint: disable=R0903 "type": "dict", "options": { "bridge_domain_info": { - "type": "dict", + "type": "list", + "elements": "dict", "mutually_exclusive": [["designated", "root"]], "options": { "range": {"type": "str"}, @@ -147,7 +148,8 @@ class Spanning_tree_globalArgs(object): # pylint: disable=R0903 }, }, "mst_info": { - "type": "dict", + "type": "list", + "elements": "dict", "mutually_exclusive": [["designated", "root"]], "options": { "range": {"type": "str"}, @@ -156,7 +158,8 @@ class Spanning_tree_globalArgs(object): # pylint: disable=R0903 }, }, "vlan_info": { - "type": "dict", + "type": "list", + "elements": "dict", "mutually_exclusive": [["designated", "root"]], "options": { "range": {"type": "str"}, diff --git a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py index b4d3b7532..1640ff865 100644 --- a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py @@ -44,31 +44,84 @@ def __init__(self, lines=None, module=None): }, }, { - "name": "bridge.bridge_domain", + "name": "bridge.bridge_domain.forward_time", "getval": re.compile( r""" ^spanning-tree\sbridge-domain \s(?P\d+) - (\sforward-time\s(?P\d+))? - (\shello-time\s(?P\d+))? - (\smax-age\s(?P\d+))? - (\spriority\s(?P\d+))? + \sforward-time\s(?P\d+) $""", re.VERBOSE, ), - "setval": "spanning-tree bridge-domain {{ bd_list_range }}" - "{{ (' forward-time ' + forward_time|string) if forward_time is defined else '' }}" - "{{ (' hello-time ' + hello_time|string) if hello_time is defined else '' }}" - "{{ (' max-age ' + max_age|string) if max_age is defined else '' }}" - "{{ (' priority ' + priority|string) if priority is defined else ''}}", + "setval": "spanning-tree bridge-domain {{ bd_list_range }} forward-time {{ forward_time }}", + "result": { + "bridge": { + "bridge_domain": { + "{{ b_domain_range }}": { + "bd_list_range": "{{ b_domain_range }}", + "forward_time": "{{ forward_time }}" + }, + }, + }, + }, + }, + { + "name": "bridge.bridge_domain.hello_time", + "getval": re.compile( + r""" + ^spanning-tree\sbridge-domain + \s(?P\d+) + \shello-time\s(?P\d+) + $""", re.VERBOSE, + ), + "setval": "spanning-tree bridge-domain {{ bd_list_range }} hello-time {{ hello_time }}", + "result": { + "bridge": { + "bridge_domain": { + "{{ b_domain_range }}": { + "bd_list_range": "{{ b_domain_range }}", + "hello_time": "{{ hello_time }}" + }, + }, + }, + }, + }, + { + "name": "bridge.bridge_domain.max_age", + "getval": re.compile( + r""" + ^spanning-tree\sbridge-domain + \s(?P\d+) + \smax-age\s(?P\d+) + $""", re.VERBOSE, + ), + "setval": "spanning-tree bridge-domain {{ bd_list_range }} max-age {{ max_age }}", + "result": { + "bridge": { + "bridge_domain": { + "{{ b_domain_range }}": { + "bd_list_range": "{{ b_domain_range }}", + "max_age": "{{ max_age }}" + }, + }, + }, + }, + }, + { + "name": "bridge.bridge_domain.priority", + "getval": re.compile( + r""" + ^spanning-tree\sbridge-domain + \s(?P\d+) + \spriority\s(?P\d+) + $""", re.VERBOSE, + ), + "setval": "spanning-tree bridge-domain {{ bd_list_range }} priority {{ priority }}", "result": { "bridge": { "bridge_domain": { "{{ b_domain_range }}": { "bd_list_range": "{{ b_domain_range }}", - "forward_time": "{{ forward_time }}", - "hello_time": "{{ hello_time }}", - "max_age": "{{ max_age }}", - "priority": "{{ priority }}", + "priority": "{{ priority }}" }, }, }, @@ -382,7 +435,7 @@ def __init__(self, lines=None, module=None): \svlan\s(?P\d+) $""", re.VERBOSE, ), - "setval": "private-vlan synchronize", + "setval": "instance {{ instance_id }} vlan {{ vlan_range }}", "result": { "mst": { "configure_mst": { @@ -409,5 +462,320 @@ def __init__(self, lines=None, module=None): "pathcost_method": "{{ pc_method }}", }, }, + { + "name": "port_type.edge.bpdufilter", + "getval": re.compile( + r""" + ^spanning-tree + \sport\stype\sedge + \sbpdufilter\s(?Pdefault) + $""", re.VERBOSE, + ), + "setval": "spanning-tree port type edge bpdufilter default", + "result": { + "port_type": { + "edge": { + "bpdufilter": "{{ True if bpdufilter is defined else False }}", + }, + }, + }, + }, + { + "name": "port_type.edge.bpduguard", + "getval": re.compile( + r""" + ^spanning-tree + \sport\stype\sedge + \sbpduguard\s(?Pdefault) + $""", re.VERBOSE, + ), + "setval": "spanning-tree port type edge bpduguard default", + "result": { + "port_type": { + "edge": { + "bpduguard": "{{ True if bpduguard is defined else False }}", + }, + }, + }, + }, + { + "name": "port_type.default_type", + "getval": re.compile( + r""" + ^spanning-tree + \sport\stype + \s(?Pedge|network) + \sdefault + $""", re.VERBOSE, + ), + "setval": "spanning-tree port type {{ default_type }} default", + "result": { + "port_type": { + "default_type": "{{ default_type }}", + }, + }, + }, + { + "name": "pseudo_info.bridge_domain_info.designated_priority", + "getval": re.compile( + r""" + ^s+bridge-domain + \s(?P\S+) + \sdesignated\spriority + \s(?P\d+) + $""", re.VERBOSE, + ), + "setval": "bridge-domain {{ bridge_domain_info.range }} designated priority {{ bridge_domain_info.designated_priority }}", + "result": { + "pseudo_info": { + "bridge_domain_info": { + "{{ range }}": { + "range": "{{ range }}", + "designated_priority": "{{ designated_priority }}", + }, + } + }, + }, + }, + { + "name": "pseudo_info.bridge_domain_info.root_priority", + "getval": re.compile( + r""" + ^s+bridge-domain + \s(?P\S+) + \sroot\spriority + \s(?P\d+) + $""", re.VERBOSE, + ), + "setval": "bridge-domain {{ bridge_domain_info.range }} root priority {{ bridge_domain_info.root_priority }}", + "result": { + "pseudo_info": { + "bridge_domain_info": { + "{{ range }}": { + "range": "{{ range }}", + "root_priority": "{{ root_priority }}", + }, + } + }, + }, + }, + { + "name": "pseudo_info.mst_info.designated_priority", + "getval": re.compile( + r""" + ^s+mst\s(?P\S+) + \sdesignated\spriority + \s(?P\d+) + $""", re.VERBOSE, + ), + "setval": "mst {{ mst_info.range }} designated priority {{ mst_info.designated_priority }}", + "result": { + "pseudo_info": { + "mst_info": { + "{{ range }}": { + "range": "{{ range }}", + "designated_priority": "{{ designated_priority }}", + }, + } + }, + }, + }, + { + "name": "pseudo_info.mst_info.root_priority", + "getval": re.compile( + r""" + ^s+mst\s(?P\S+) + \sroot\spriority + \s(?P\d+) + $""", re.VERBOSE, + ), + "setval": "mst {{ mst_info.range }} root priority {{ mst_info.root_priority }}", + "result": { + "pseudo_info": { + "mst_info": { + "{{ range }}": { + "range": "{{ range }}", + "root_priority": "{{ root_priority }}", + }, + } + }, + }, + }, + { + "name": "pseudo_info.vlan_info.designated_priority", + "getval": re.compile( + r""" + ^s+vlan\s(?P\S+) + \sdesignated\spriority + \s(?P\d+) + $""", re.VERBOSE, + ), + "setval": "vlan {{ vlan_info.range }} designated priority {{ vlan_info.designated_priority }}", + "result": { + "pseudo_info": { + "vlan_info": { + "{{ range }}": { + "range": "{{ range }}", + "designated_priority": "{{ designated_priority }}", + }, + } + }, + }, + }, + { + "name": "pseudo_info.vlan_info.root_priority", + "getval": re.compile( + r""" + ^s+vlan\s(?P\S+) + \sroot\spriority + \s(?P\d+) + $""", re.VERBOSE, + ), + "setval": "vlan {{ vlan_info.range }} root priority {{ vlan_info.root_priority }}", + "result": { + "pseudo_info": { + "vlan_info": { + "{{ range }}": { + "range": "{{ range }}", + "root_priority": "{{ root_priority }}", + }, + } + }, + }, + }, + { + "name": "vlan.forward_time", + "getval": re.compile( + r""" + ^spanning-tree\svlan + \s(?P\d+) + \sforward-time\s(?P\d+) + $""", re.VERBOSE, + ), + "setval": "spanning-tree vlan {{ vlan_range }} forward-time {{ forward_time }}", + "result": { + "vlan": { + "{{ vlan_range }}": { + "vlan_range": "{{ vlan_range }}", + "forward_time": "{{ forward_time }}", + }, + }, + }, + }, + { + "name": "vlan.hello_time", + "getval": re.compile( + r""" + ^spanning-tree\svlan + \s(?P\d+) + \shello-time\s(?P\d+) + $""", re.VERBOSE, + ), + "setval": "spanning-tree vlan {{ vlan_range }} hello-time {{ hello_time }}", + "result": { + "vlan": { + "{{ vlan_range }}": { + "vlan_range": "{{ vlan_range }}", + "hello_time": "{{ hello_time }}", + }, + }, + }, + }, + { + "name": "vlan.max_age", + "getval": re.compile( + r""" + ^spanning-tree\svlan + \s(?P\d+) + \smax-age\s(?P\d+) + $""", re.VERBOSE, + ), + "setval": "spanning-tree vlan {{ vlan_range }} max-age {{ max_age }}", + "result": { + "vlan": { + "{{ vlan_range }}": { + "vlan_range": "{{ vlan_range }}", + "max_age": "{{ max_age }}", + }, + }, + }, + }, + { + "name": "vlan.priority", + "getval": re.compile( + r""" + ^spanning-tree\svlan + \s(?P\d+) + \spriority\s(?P\d+) + $""", re.VERBOSE, + ), + "setval": "spanning-tree vlan {{ vlan_range }} priority {{ priority }}", + "result": { + "vlan": { + "{{ vlan_range }}": { + "vlan_range": "{{ vlan_range }}", + "priority": "{{ priority }}", + }, + }, + }, + }, + { + "name": "vlan.root.primary", + "getval": re.compile( + r""" + ^spanning-tree\svlan + \s(?P\d+) + \sroot\sprimary + (\sdiameter\s(?P\d+))? + (\shello-time\s(?P\d+))? + $""", re.VERBOSE, + ), + "setval": "spanning-tree vlan {{ vlan_range }}" + " root primary" + "{{ (' diameter ' + root.primary.diameter|string) if root.primary.diameter is defined else '' }}" + "{{ (' hello-time ' + root.primary.hello_time|string) if root.primary.hello_time is defined else '' }}", + "result": { + "vlan": { + "{{ vlan_range }}": { + "vlan_range": "{{ vlan_range }}", + "root": { + "primary": { + "diameter": "{{ diameter }}", + "hello_time": "{{ hello_time }}", + }, + }, + }, + }, + }, + }, + { + "name": "vlan.root.secondary", + "getval": re.compile( + r""" + ^spanning-tree\svlan + \s(?P\d+) + \sroot\ssecondary + (\sdiameter\s(?P\d+))? + (\shello-time\s(?P\d+))? + $""", re.VERBOSE, + ), + "setval": "spanning-tree vlan {{ vlan_range }}" + " root secondary" + "{{ (' diameter ' + root.secondary.diameter|string) if root.secondary.diameter is defined else '' }}" + "{{ (' hello-time ' + root.secondary.hello_time|string) if root.secondary.hello_time is defined else '' }}", + "result": { + "vlan": { + "{{ vlan_range }}": { + "vlan_range": "{{ vlan_range }}", + "root": { + "secondary": { + "diameter": "{{ diameter }}", + "hello_time": "{{ hello_time }}", + }, + }, + }, + }, + }, + }, ] # fmt: on diff --git a/plugins/modules/nxos_spanning_tree_global.py b/plugins/modules/nxos_spanning_tree_global.py index 4b2db9e2b..18bac7e72 100644 --- a/plugins/modules/nxos_spanning_tree_global.py +++ b/plugins/modules/nxos_spanning_tree_global.py @@ -199,7 +199,8 @@ suboptions: bridge_domain_info: description: Pseudo information bridge domain. - type: dict + type: list + elements: dict mutually_exclusive: [["designated", "root"]] suboptions: range: @@ -213,7 +214,8 @@ type: int mst_info: description: Pseudo information MST. - type: dict + type: list + elements: dict mutually_exclusive: [["designated", "root"]] suboptions: range: @@ -227,7 +229,8 @@ type: int vlan_info: description: Pseudo information MST. - type: dict + type: list + elements: dict mutually_exclusive: [["designated", "root"]] suboptions: range: From e3d477cda8c0990020df8675caf2367013f1c0b5 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 11 Mar 2024 10:23:27 +0000 Subject: [PATCH 22/30] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .../nxos/rm_templates/spanning_tree_global.py | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py index 1640ff865..aa599c8c0 100644 --- a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py @@ -58,7 +58,7 @@ def __init__(self, lines=None, module=None): "bridge_domain": { "{{ b_domain_range }}": { "bd_list_range": "{{ b_domain_range }}", - "forward_time": "{{ forward_time }}" + "forward_time": "{{ forward_time }}", }, }, }, @@ -79,7 +79,7 @@ def __init__(self, lines=None, module=None): "bridge_domain": { "{{ b_domain_range }}": { "bd_list_range": "{{ b_domain_range }}", - "hello_time": "{{ hello_time }}" + "hello_time": "{{ hello_time }}", }, }, }, @@ -100,7 +100,7 @@ def __init__(self, lines=None, module=None): "bridge_domain": { "{{ b_domain_range }}": { "bd_list_range": "{{ b_domain_range }}", - "max_age": "{{ max_age }}" + "max_age": "{{ max_age }}", }, }, }, @@ -121,7 +121,7 @@ def __init__(self, lines=None, module=None): "bridge_domain": { "{{ b_domain_range }}": { "bd_list_range": "{{ b_domain_range }}", - "priority": "{{ priority }}" + "priority": "{{ priority }}", }, }, }, @@ -533,7 +533,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "designated_priority": "{{ designated_priority }}", }, - } + }, }, }, }, @@ -555,7 +555,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "root_priority": "{{ root_priority }}", }, - } + }, }, }, }, @@ -576,7 +576,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "designated_priority": "{{ designated_priority }}", }, - } + }, }, }, }, @@ -597,7 +597,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "root_priority": "{{ root_priority }}", }, - } + }, }, }, }, @@ -618,7 +618,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "designated_priority": "{{ designated_priority }}", }, - } + }, }, }, }, @@ -639,7 +639,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "root_priority": "{{ root_priority }}", }, - } + }, }, }, }, @@ -659,7 +659,7 @@ def __init__(self, lines=None, module=None): "vlan_range": "{{ vlan_range }}", "forward_time": "{{ forward_time }}", }, - }, + }, }, }, { @@ -678,7 +678,7 @@ def __init__(self, lines=None, module=None): "vlan_range": "{{ vlan_range }}", "hello_time": "{{ hello_time }}", }, - }, + }, }, }, { @@ -697,7 +697,7 @@ def __init__(self, lines=None, module=None): "vlan_range": "{{ vlan_range }}", "max_age": "{{ max_age }}", }, - }, + }, }, }, { @@ -716,7 +716,7 @@ def __init__(self, lines=None, module=None): "vlan_range": "{{ vlan_range }}", "priority": "{{ priority }}", }, - }, + }, }, }, { From c9d5c199add5724a4b9ecfdb3a77735adf6324fa Mon Sep 17 00:00:00 2001 From: Vinay Mulugund Date: Mon, 11 Mar 2024 23:39:42 +0530 Subject: [PATCH 23/30] gathered state --- .../spanning_tree_global.py | 52 +--- .../spanning_tree_global.py | 19 +- .../nxos/rm_templates/spanning_tree_global.py | 240 ++---------------- plugins/modules/nxos_spanning_tree_global.py | 80 +----- 4 files changed, 48 insertions(+), 343 deletions(-) diff --git a/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py index f7fd77c0c..4897282e0 100644 --- a/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/argspec/spanning_tree_global/spanning_tree_global.py @@ -36,47 +36,7 @@ class Spanning_tree_globalArgs(object): # pylint: disable=R0903 "config": { "type": "dict", "options": { - "bridge": { - "type": "dict", - "options": { - "bridge_assurance": {"type": "bool"}, - "bridge_domain": { - "type": "list", - "elements": "dict", - "options": { - "bd_list_range": {"type": "str"}, - "forward_time": {"type": "int"}, - "hello_time": {"type": "int"}, - "max_age": {"type": "int"}, - "priority": {"type": "int"}, - "root": { - "type": "dict", - "mutually_exclusive": [ - ["primary", "secondary"], - ], - "options": { - "primary": { - "type": "dict", - "options": { - "enable": {"type": "bool"}, - "diameter": {"type": "int"}, - "hello_time": {"type": "int"}, - }, - }, - "secondary": { - "type": "dict", - "options": { - "enable": {"type": "bool"}, - "diameter": {"type": "int"}, - "hello_time": {"type": "int"}, - }, - }, - }, - }, - }, - }, - }, - }, + "bridge_assurance": {"type": "bool"}, "domain": { "type": "dict", "mutually_exclusive": [["identifier", "disable", "enable"]], @@ -137,16 +97,6 @@ class Spanning_tree_globalArgs(object): # pylint: disable=R0903 "pseudo_info": { "type": "dict", "options": { - "bridge_domain_info": { - "type": "list", - "elements": "dict", - "mutually_exclusive": [["designated", "root"]], - "options": { - "range": {"type": "str"}, - "designated_priority": {"type": "int"}, - "root_priority": {"type": "int\\"}, - }, - }, "mst_info": { "type": "list", "elements": "dict", diff --git a/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py index 206d9fb1a..69c7ba20a 100644 --- a/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py @@ -42,6 +42,21 @@ def get_config(self, connection): summary = connection.get("show spanning-tree summary") general = connection.get("show running-config spanning-tree") return summary + general + + def _dict_to_list(self, objs): + """Convert a dict to a list of dicts + """ + + mst_obj = objs.get("mst", {}) + configure_mst_obj = mst_obj.get("configure_mst", {}) + instance_vlan_obj = configure_mst_obj.get("instance_vlan", {}) + + if instance_vlan_obj: + objs["mst"]["configure_mst"]["instance_vlan"] = list(instance_vlan_obj.values()) + + if "vlan" in objs: + objs["vlan"] = list(objs["vlan"].values()) + return objs def populate_facts(self, connection, ansible_facts, data=None): """Populate the facts for Spanning_tree_global network resource @@ -66,12 +81,14 @@ def populate_facts(self, connection, ansible_facts, data=None): ) objs = spanning_tree_global_parser.parse() + facts_output = self._dict_to_list(objs) + ansible_facts["ansible_network_resources"].pop("spanning_tree_global", None) params = utils.remove_empties( spanning_tree_global_parser.validate_config( self.argument_spec, - {"config": objs}, + {"config": facts_output}, redact=True, ), ) diff --git a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py index aa599c8c0..7103cbf5a 100644 --- a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py @@ -29,7 +29,7 @@ def __init__(self, lines=None, module=None): # fmt: off PARSERS = [ { - "name": "bridge.bridge_assurance", + "name": "bridge_assurance", "getval": re.compile( r""" ^Bridge\sAssurance @@ -38,155 +38,7 @@ def __init__(self, lines=None, module=None): ), "setval": "spanning-tree bridge assurance", "result": { - "bridge": { - "bridge_assurance": "{{ True if 'enabled' in is_enabled else False }}", - }, - }, - }, - { - "name": "bridge.bridge_domain.forward_time", - "getval": re.compile( - r""" - ^spanning-tree\sbridge-domain - \s(?P\d+) - \sforward-time\s(?P\d+) - $""", re.VERBOSE, - ), - "setval": "spanning-tree bridge-domain {{ bd_list_range }} forward-time {{ forward_time }}", - "result": { - "bridge": { - "bridge_domain": { - "{{ b_domain_range }}": { - "bd_list_range": "{{ b_domain_range }}", - "forward_time": "{{ forward_time }}", - }, - }, - }, - }, - }, - { - "name": "bridge.bridge_domain.hello_time", - "getval": re.compile( - r""" - ^spanning-tree\sbridge-domain - \s(?P\d+) - \shello-time\s(?P\d+) - $""", re.VERBOSE, - ), - "setval": "spanning-tree bridge-domain {{ bd_list_range }} hello-time {{ hello_time }}", - "result": { - "bridge": { - "bridge_domain": { - "{{ b_domain_range }}": { - "bd_list_range": "{{ b_domain_range }}", - "hello_time": "{{ hello_time }}", - }, - }, - }, - }, - }, - { - "name": "bridge.bridge_domain.max_age", - "getval": re.compile( - r""" - ^spanning-tree\sbridge-domain - \s(?P\d+) - \smax-age\s(?P\d+) - $""", re.VERBOSE, - ), - "setval": "spanning-tree bridge-domain {{ bd_list_range }} max-age {{ max_age }}", - "result": { - "bridge": { - "bridge_domain": { - "{{ b_domain_range }}": { - "bd_list_range": "{{ b_domain_range }}", - "max_age": "{{ max_age }}", - }, - }, - }, - }, - }, - { - "name": "bridge.bridge_domain.priority", - "getval": re.compile( - r""" - ^spanning-tree\sbridge-domain - \s(?P\d+) - \spriority\s(?P\d+) - $""", re.VERBOSE, - ), - "setval": "spanning-tree bridge-domain {{ bd_list_range }} priority {{ priority }}", - "result": { - "bridge": { - "bridge_domain": { - "{{ b_domain_range }}": { - "bd_list_range": "{{ b_domain_range }}", - "priority": "{{ priority }}", - }, - }, - }, - }, - }, - { - "name": "bridge.bridge_domain.root.primary", - "getval": re.compile( - r""" - ^spanning-tree\sbridge-domain - \s(?P\d+) - \sroot\sprimary - (\sdiameter\s(?P\d+))? - (\shello-time\s(?P\d+))? - $""", re.VERBOSE, - ), - "setval": "spanning-tree bridge-domain {{ bd_list_range }}" - " root primary" - "{{ (' diameter ' + root.primary.diameter|string) if root.primary.diameter is defined else '' }}" - "{{ (' hello-time ' + root.primary.hello_time|string) if root.primary.hello_time is defined else '' }}", - "result": { - "bridge": { - "bridge_domain": { - "{{ b_domain_range }}": { - "bd_list_range": "{{ b_domain_range }}", - "root": { - "primary": { - "diameter": "{{ diameter }}", - "hello_time": "{{ hello_time }}", - }, - }, - }, - }, - }, - }, - }, - { - "name": "bridge.bridge_domain.root.secondary", - "getval": re.compile( - r""" - ^spanning-tree\sbridge-domain - \s(?P\d+) - \sroot\ssecondary - (\sdiameter\s(?P\d+))? - (\shello-time\s(?P\d+))? - $""", re.VERBOSE, - ), - "setval": "spanning-tree bridge-domain {{ bd_list_range }}" - " root secondary" - "{{ (' diameter ' + root.secondary.diameter|string) if root.secondary.diameter is defined else '' }}" - "{{ (' hello-time ' + root.secondary.hello_time|string) if root.secondary.hello_time is defined else '' }}", - "result": { - "bridge": { - "bridge_domain": { - "{{ b_domain_range }}": { - "bd_list_range": "{{ b_domain_range }}", - "root": { - "secondary": { - "diameter": "{{ diameter }}", - "hello_time": "{{ hello_time }}", - }, - }, - }, - }, - }, + "bridge_assurance": "{{ True if 'enabled' in is_enabled else False }}", }, }, { @@ -432,7 +284,7 @@ def __init__(self, lines=None, module=None): r""" ^\s+instance \s(?P\d+) - \svlan\s(?P\d+) + \svlan\s(?P\S+) $""", re.VERBOSE, ), "setval": "instance {{ instance_id }} vlan {{ vlan_range }}", @@ -515,50 +367,6 @@ def __init__(self, lines=None, module=None): }, }, }, - { - "name": "pseudo_info.bridge_domain_info.designated_priority", - "getval": re.compile( - r""" - ^s+bridge-domain - \s(?P\S+) - \sdesignated\spriority - \s(?P\d+) - $""", re.VERBOSE, - ), - "setval": "bridge-domain {{ bridge_domain_info.range }} designated priority {{ bridge_domain_info.designated_priority }}", - "result": { - "pseudo_info": { - "bridge_domain_info": { - "{{ range }}": { - "range": "{{ range }}", - "designated_priority": "{{ designated_priority }}", - }, - }, - }, - }, - }, - { - "name": "pseudo_info.bridge_domain_info.root_priority", - "getval": re.compile( - r""" - ^s+bridge-domain - \s(?P\S+) - \sroot\spriority - \s(?P\d+) - $""", re.VERBOSE, - ), - "setval": "bridge-domain {{ bridge_domain_info.range }} root priority {{ bridge_domain_info.root_priority }}", - "result": { - "pseudo_info": { - "bridge_domain_info": { - "{{ range }}": { - "range": "{{ range }}", - "root_priority": "{{ root_priority }}", - }, - }, - }, - }, - }, { "name": "pseudo_info.mst_info.designated_priority", "getval": re.compile( @@ -576,7 +384,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "designated_priority": "{{ designated_priority }}", }, - }, + } }, }, }, @@ -597,7 +405,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "root_priority": "{{ root_priority }}", }, - }, + } }, }, }, @@ -618,7 +426,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "designated_priority": "{{ designated_priority }}", }, - }, + } }, }, }, @@ -639,7 +447,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "root_priority": "{{ root_priority }}", }, - }, + } }, }, }, @@ -648,18 +456,18 @@ def __init__(self, lines=None, module=None): "getval": re.compile( r""" ^spanning-tree\svlan - \s(?P\d+) + \s(?P\S+) \sforward-time\s(?P\d+) $""", re.VERBOSE, ), "setval": "spanning-tree vlan {{ vlan_range }} forward-time {{ forward_time }}", "result": { "vlan": { - "{{ vlan_range }}": { + "{{ vlan_range | string }}": { "vlan_range": "{{ vlan_range }}", "forward_time": "{{ forward_time }}", }, - }, + }, }, }, { @@ -667,18 +475,18 @@ def __init__(self, lines=None, module=None): "getval": re.compile( r""" ^spanning-tree\svlan - \s(?P\d+) + \s(?P\S+) \shello-time\s(?P\d+) $""", re.VERBOSE, ), "setval": "spanning-tree vlan {{ vlan_range }} hello-time {{ hello_time }}", "result": { "vlan": { - "{{ vlan_range }}": { + "{{ vlan_range | string }}": { "vlan_range": "{{ vlan_range }}", "hello_time": "{{ hello_time }}", }, - }, + }, }, }, { @@ -686,18 +494,18 @@ def __init__(self, lines=None, module=None): "getval": re.compile( r""" ^spanning-tree\svlan - \s(?P\d+) + \s(?P\S+) \smax-age\s(?P\d+) $""", re.VERBOSE, ), "setval": "spanning-tree vlan {{ vlan_range }} max-age {{ max_age }}", "result": { "vlan": { - "{{ vlan_range }}": { + "{{ vlan_range | string }}": { "vlan_range": "{{ vlan_range }}", "max_age": "{{ max_age }}", }, - }, + }, }, }, { @@ -705,18 +513,18 @@ def __init__(self, lines=None, module=None): "getval": re.compile( r""" ^spanning-tree\svlan - \s(?P\d+) + \s(?P\S+) \spriority\s(?P\d+) $""", re.VERBOSE, ), "setval": "spanning-tree vlan {{ vlan_range }} priority {{ priority }}", "result": { "vlan": { - "{{ vlan_range }}": { - "vlan_range": "{{ vlan_range }}", + "{{ vlan_range | string }}": { + "vlan_range": "{{ vlan_range | string }}", "priority": "{{ priority }}", }, - }, + }, }, }, { @@ -724,7 +532,7 @@ def __init__(self, lines=None, module=None): "getval": re.compile( r""" ^spanning-tree\svlan - \s(?P\d+) + \s(?P\S+) \sroot\sprimary (\sdiameter\s(?P\d+))? (\shello-time\s(?P\d+))? @@ -736,7 +544,7 @@ def __init__(self, lines=None, module=None): "{{ (' hello-time ' + root.primary.hello_time|string) if root.primary.hello_time is defined else '' }}", "result": { "vlan": { - "{{ vlan_range }}": { + "{{ vlan_range | string }}": { "vlan_range": "{{ vlan_range }}", "root": { "primary": { @@ -753,7 +561,7 @@ def __init__(self, lines=None, module=None): "getval": re.compile( r""" ^spanning-tree\svlan - \s(?P\d+) + \s(?P\S+) \sroot\ssecondary (\sdiameter\s(?P\d+))? (\shello-time\s(?P\d+))? @@ -765,7 +573,7 @@ def __init__(self, lines=None, module=None): "{{ (' hello-time ' + root.secondary.hello_time|string) if root.secondary.hello_time is defined else '' }}", "result": { "vlan": { - "{{ vlan_range }}": { + "{{ vlan_range | string }}": { "vlan_range": "{{ vlan_range }}", "root": { "secondary": { diff --git a/plugins/modules/nxos_spanning_tree_global.py b/plugins/modules/nxos_spanning_tree_global.py index 18bac7e72..e882caf35 100644 --- a/plugins/modules/nxos_spanning_tree_global.py +++ b/plugins/modules/nxos_spanning_tree_global.py @@ -30,64 +30,9 @@ description: A dict of Spanning-tree options. type: dict suboptions: - bridge: - description: Bridge options in spanning-tree. - type: dict - suboptions: - bridge_assurance: - description: Enable bridge assurance. - type: bool - bridge_domain: - decsription: Bridge-Domain Spanning Trees range. - type: list - elements: dict - suboptions: - bd_list_range: - description: Bridge-Domain Spanning Trees range. - type: str - forward_time: - description: Forward time for bridge domain. - type: int - hello_time: - description: Hello time for bridge domain. - type: int - max_age: - description: Max age for bridge domain. - type: int - priority: - description: Priority for bridge domain. - type: int - root: - description: Configure switch as root. - type: dict - mutually_exclusive: [["primary", "secondary"]] - suboptions: - primary: - description: Configure primary root. - type: dict - suboptions: - enable: - description: Enable primary root. - type: bool - diameter: - description: Priority for primary root. - type: int - hello_time: - description: Configure secondary root. - type: int - secondary: - description: Configure secondary root. - type: dict - suboptions: - enable: - description: Enable primary root. - type: bool - diameter: - description: Priority for primary root. - type: int - hello_time: - description: Configure secondary root. - type: int + bridge_assurance: + description: Enable bridge assurance. + type: bool domain: description: Spanning tree domain options. type: dict @@ -197,21 +142,6 @@ description: Configure spanning tree pseudo information type: dict suboptions: - bridge_domain_info: - description: Pseudo information bridge domain. - type: list - elements: dict - mutually_exclusive: [["designated", "root"]] - suboptions: - range: - description: Pseudo information bridge domain range. - type: str - designated_priority: - description: Pseudo information bridge domain designated priority. - type: int - root_priority: - description: Pseudo information bridge domain root priority. - type: int mst_info: description: Pseudo information MST. type: list @@ -388,10 +318,10 @@ from ansible.module_utils.basic import AnsibleModule -from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.argspec.spanning_tree_global.spanning_tree_global import ( +from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.argspec.spanning_tree_global.spanning_tree_global import ( Spanning_tree_globalArgs, ) -from ansible_collections.cisco.nxos.nxos.plugins.module_utils.network.nxos.config.spanning_tree_global.spanning_tree_global import ( +from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.config.spanning_tree_global.spanning_tree_global import ( Spanning_tree_global, ) From cbb8eb8071c7f934a63527884bae933bf9a4fae6 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 11 Mar 2024 18:10:55 +0000 Subject: [PATCH 24/30] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- ....nxos.nxos_spanning_tree_global_module.rst | 494 ++---------------- .../spanning_tree_global.py | 7 +- .../nxos/rm_templates/spanning_tree_global.py | 16 +- 3 files changed, 65 insertions(+), 452 deletions(-) diff --git a/docs/cisco.nxos.nxos_spanning_tree_global_module.rst b/docs/cisco.nxos.nxos_spanning_tree_global_module.rst index 935a518dc..8ce362d21 100644 --- a/docs/cisco.nxos.nxos_spanning_tree_global_module.rst +++ b/docs/cisco.nxos.nxos_spanning_tree_global_module.rst @@ -29,12 +29,12 @@ Parameters - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterParameter Choices/Defaults Comments
+
config @@ -50,23 +50,6 @@ Parameters
-
- bridge - -
- dictionary -
- 		- -
Bridge options in spanning-tree.
-
bridge_assurance @@ -87,303 +70,7 @@ Parameters
-
- bridge_domain - -
- list - / elements=dictionary -
- 		- -
-
- bd_list_range - -
- string -
- 		- -
Bridge-Domain Spanning Trees range.
-
-
- forward_time - -
- integer -
- 		- -
Forward time for bridge domain.
-
-
- hello_time - -
- integer -
- 		- -
Hello time for bridge domain.
-
-
- max_age - -
- integer -
- 		- -
Max age for bridge domain.
-
-
- priority - -
- integer -
- 		- -
Priority for bridge domain.
-
-
- root - -
- dictionary -
- 		- -
Configure switch as root.
-
-
- primary - -
- dictionary -
- 		- -
Configure primary root.
-
-
- diameter - -
- integer -
- 		- -
Priority for primary root.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable primary root.
-
-
- hello_time - -
- integer -
- 		- -
Configure secondary root.
-
-
- secondary - -
- dictionary -
- 		- -
Configure secondary root.
-
-
- diameter - -
- integer -
- 		- -
Priority for primary root.
-
-
- enable - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable primary root.
-
-
- hello_time - -
- integer -
- 		- -
Configure secondary root.
-
domain @@ -400,7 +87,7 @@ Parameters
+
clear_stats @@ -421,7 +108,7 @@ Parameters
+
disable @@ -442,7 +129,7 @@ Parameters
+
enable @@ -463,7 +150,7 @@ Parameters
+
identifier @@ -480,7 +167,7 @@ Parameters
+
fcoe @@ -500,7 +187,7 @@ Parameters
+
lc_issu @@ -521,7 +208,7 @@ Parameters
+
loopguard_default @@ -541,7 +228,7 @@ Parameters
+
mode @@ -561,7 +248,7 @@ Parameters
+
mst @@ -578,7 +265,7 @@ Parameters
+
configure_mst @@ -596,7 +283,7 @@ Parameters 		+
instance_vlan @@ -616,7 +303,7 @@ Parameters 		+
instance_id @@ -635,7 +322,7 @@ Parameters 		+
vlan_range @@ -654,7 +341,7 @@ Parameters 		+
name @@ -672,7 +359,7 @@ Parameters 		+
private_vlan_sync @@ -694,7 +381,7 @@ Parameters 		+
revision @@ -712,7 +399,7 @@ Parameters
+
forward_time @@ -729,7 +416,7 @@ Parameters
+
hello_time @@ -746,7 +433,7 @@ Parameters
+
max_age @@ -763,7 +450,7 @@ Parameters
+
max_hops @@ -780,7 +467,7 @@ Parameters
+
simulate_pvst_global @@ -801,7 +488,7 @@ Parameters
+
pathcost_method @@ -821,7 +508,7 @@ Parameters
+
port_type @@ -838,7 +525,7 @@ Parameters
+
default_type @@ -859,7 +546,7 @@ Parameters
+
edge @@ -877,7 +564,7 @@ Parameters 		+
bpdufilter @@ -899,7 +586,7 @@ Parameters 		+
bpduguard @@ -921,7 +608,7 @@ Parameters
+
pseudo_info @@ -938,80 +625,7 @@ Parameters
-
- bridge_domain_info - -
- list - / elements=dictionary -
- 		- -
Pseudo information bridge domain.
-
-
- designated_priority - -
- integer -
- 		- -
Pseudo information bridge domain designated priority.
-
-
- range - -
- string -
- 		- -
Pseudo information bridge domain range.
-
-
- root_priority - -
- integer -
- 		- -
Pseudo information bridge domain root priority.
-
mst_info @@ -1030,7 +644,7 @@ Parameters 		+
designated_priority @@ -1048,7 +662,7 @@ Parameters 		+
range @@ -1066,7 +680,7 @@ Parameters 		+
root_priority @@ -1084,7 +698,7 @@ Parameters
+
vlan_info @@ -1103,7 +717,7 @@ Parameters 		+
designated_priority @@ -1121,7 +735,7 @@ Parameters 		+
range @@ -1139,7 +753,7 @@ Parameters 		+
root_priority @@ -1157,7 +771,7 @@ Parameters
+
vlan @@ -1175,7 +789,7 @@ Parameters
+
forward_time @@ -1192,7 +806,7 @@ Parameters
+
hello_time @@ -1209,7 +823,7 @@ Parameters
+
max_age @@ -1226,7 +840,7 @@ Parameters
+
priority @@ -1243,7 +857,7 @@ Parameters
+
root @@ -1261,7 +875,7 @@ Parameters 		+
primary @@ -1280,7 +894,7 @@ Parameters 		+
diameter @@ -1299,7 +913,7 @@ Parameters 		+
enable @@ -1322,7 +936,7 @@ Parameters 		+
hello_time @@ -1341,7 +955,7 @@ Parameters 		+
secondary @@ -1360,7 +974,7 @@ Parameters 		+
diameter @@ -1379,7 +993,7 @@ Parameters 		+
enable @@ -1402,7 +1016,7 @@ Parameters 		+
hello_time @@ -1421,7 +1035,7 @@ Parameters
+
vlan_range @@ -1438,7 +1052,7 @@ Parameters
+
running_config @@ -1455,7 +1069,7 @@ Parameters
+
state diff --git a/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py index 69c7ba20a..a28ad0dc0 100644 --- a/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py @@ -42,11 +42,10 @@ def get_config(self, connection): summary = connection.get("show spanning-tree summary") general = connection.get("show running-config spanning-tree") return summary + general - + def _dict_to_list(self, objs): - """Convert a dict to a list of dicts - """ - + """Convert a dict to a list of dicts""" + mst_obj = objs.get("mst", {}) configure_mst_obj = mst_obj.get("configure_mst", {}) instance_vlan_obj = configure_mst_obj.get("instance_vlan", {}) diff --git a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py index 7103cbf5a..cd6e87aad 100644 --- a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py @@ -384,7 +384,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "designated_priority": "{{ designated_priority }}", }, - } + }, }, }, }, @@ -405,7 +405,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "root_priority": "{{ root_priority }}", }, - } + }, }, }, }, @@ -426,7 +426,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "designated_priority": "{{ designated_priority }}", }, - } + }, }, }, }, @@ -447,7 +447,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "root_priority": "{{ root_priority }}", }, - } + }, }, }, }, @@ -467,7 +467,7 @@ def __init__(self, lines=None, module=None): "vlan_range": "{{ vlan_range }}", "forward_time": "{{ forward_time }}", }, - }, + }, }, }, { @@ -486,7 +486,7 @@ def __init__(self, lines=None, module=None): "vlan_range": "{{ vlan_range }}", "hello_time": "{{ hello_time }}", }, - }, + }, }, }, { @@ -505,7 +505,7 @@ def __init__(self, lines=None, module=None): "vlan_range": "{{ vlan_range }}", "max_age": "{{ max_age }}", }, - }, + }, }, }, { @@ -524,7 +524,7 @@ def __init__(self, lines=None, module=None): "vlan_range": "{{ vlan_range | string }}", "priority": "{{ priority }}", }, - }, + }, }, }, { From 37639a7363ec5b6a9c21671115c60be60def394c Mon Sep 17 00:00:00 2001 From: Vinay Mulugund Date: Tue, 12 Mar 2024 17:08:26 +0530 Subject: [PATCH 25/30] facts code --- .../spanning_tree_global.py | 32 ++++++++++++++++- .../nxos/rm_templates/spanning_tree_global.py | 36 +++++++++---------- 2 files changed, 49 insertions(+), 19 deletions(-) diff --git a/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py index a28ad0dc0..51ff0cf16 100644 --- a/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py @@ -43,8 +43,21 @@ def get_config(self, connection): general = connection.get("show running-config spanning-tree") return summary + general + def _convert_to_str(self, config_list, key_name): + """Convert range values to strings + """ + + for obj in config_list: + if isinstance(obj.get(key_name), list) or isinstance(obj.get(key_name), tuple): + vals = [str(x) for x in obj[key_name]] + obj[key_name] = ",".join(vals) + if isinstance(obj.get(key_name), int): + obj[key_name] = str(obj[key_name]) + return config_list + def _dict_to_list(self, objs): - """Convert a dict to a list of dicts""" + """Convert a dict to a list of dicts + """ mst_obj = objs.get("mst", {}) configure_mst_obj = mst_obj.get("configure_mst", {}) @@ -52,9 +65,26 @@ def _dict_to_list(self, objs): if instance_vlan_obj: objs["mst"]["configure_mst"]["instance_vlan"] = list(instance_vlan_obj.values()) + objs["mst"]["configure_mst"]["instance_vlan"] = self._convert_to_str( + objs["mst"]["configure_mst"]["instance_vlan"], "vlan_range" + ) + + pseudo_obj = objs.get("pseudo_info", {}) + pseudo_mst_obj = pseudo_obj.get("mst_info", {}) + pseudo_vlan_obj = pseudo_obj.get("vlan_info", {}) + + if pseudo_mst_obj: + objs["pseudo_info"]["mst_info"] = list(pseudo_mst_obj.values()) + objs["pseudo_info"]["mst_info"] = self._convert_to_str(objs["pseudo_info"]["mst_info"], "range") + + if pseudo_vlan_obj: + objs["pseudo_info"]["vlan_info"] = list(pseudo_vlan_obj.values()) + objs["pseudo_info"]["vlan_info"] = self._convert_to_str(objs["pseudo_info"]["vlan_info"], "range") if "vlan" in objs: objs["vlan"] = list(objs["vlan"].values()) + objs["vlan"] = self._convert_to_str(objs["vlan"], "vlan_range") + return objs def populate_facts(self, connection, ansible_facts, data=None): diff --git a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py index cd6e87aad..ca06aa5b7 100644 --- a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py @@ -294,7 +294,7 @@ def __init__(self, lines=None, module=None): "instance_vlan": { "{{ instance_id }}": { "instance_id": "{{ instance_id }}", - "vlan_range": "{{ vlan_range }}", + "vlan_range": "{{ vlan_range | string }}", }, }, }, @@ -371,7 +371,7 @@ def __init__(self, lines=None, module=None): "name": "pseudo_info.mst_info.designated_priority", "getval": re.compile( r""" - ^s+mst\s(?P\S+) + ^\s+mst\s(?P\S+) \sdesignated\spriority \s(?P\d+) $""", re.VERBOSE, @@ -384,7 +384,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "designated_priority": "{{ designated_priority }}", }, - }, + } }, }, }, @@ -392,7 +392,7 @@ def __init__(self, lines=None, module=None): "name": "pseudo_info.mst_info.root_priority", "getval": re.compile( r""" - ^s+mst\s(?P\S+) + ^\s+mst\s(?P\S+) \sroot\spriority \s(?P\d+) $""", re.VERBOSE, @@ -405,7 +405,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "root_priority": "{{ root_priority }}", }, - }, + } }, }, }, @@ -413,7 +413,7 @@ def __init__(self, lines=None, module=None): "name": "pseudo_info.vlan_info.designated_priority", "getval": re.compile( r""" - ^s+vlan\s(?P\S+) + ^\s+vlan\s(?P\S+) \sdesignated\spriority \s(?P\d+) $""", re.VERBOSE, @@ -426,7 +426,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "designated_priority": "{{ designated_priority }}", }, - }, + } }, }, }, @@ -434,7 +434,7 @@ def __init__(self, lines=None, module=None): "name": "pseudo_info.vlan_info.root_priority", "getval": re.compile( r""" - ^s+vlan\s(?P\S+) + ^\s+vlan\s(?P\S+) \sroot\spriority \s(?P\d+) $""", re.VERBOSE, @@ -447,7 +447,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "root_priority": "{{ root_priority }}", }, - }, + } }, }, }, @@ -464,10 +464,10 @@ def __init__(self, lines=None, module=None): "result": { "vlan": { "{{ vlan_range | string }}": { - "vlan_range": "{{ vlan_range }}", + "vlan_range": "{{ vlan_range | string }}", "forward_time": "{{ forward_time }}", }, - }, + }, }, }, { @@ -483,10 +483,10 @@ def __init__(self, lines=None, module=None): "result": { "vlan": { "{{ vlan_range | string }}": { - "vlan_range": "{{ vlan_range }}", + "vlan_range": "{{ vlan_range | string }}", "hello_time": "{{ hello_time }}", }, - }, + }, }, }, { @@ -502,10 +502,10 @@ def __init__(self, lines=None, module=None): "result": { "vlan": { "{{ vlan_range | string }}": { - "vlan_range": "{{ vlan_range }}", + "vlan_range": "{{ vlan_range | string }}", "max_age": "{{ max_age }}", }, - }, + }, }, }, { @@ -524,7 +524,7 @@ def __init__(self, lines=None, module=None): "vlan_range": "{{ vlan_range | string }}", "priority": "{{ priority }}", }, - }, + }, }, }, { @@ -545,7 +545,7 @@ def __init__(self, lines=None, module=None): "result": { "vlan": { "{{ vlan_range | string }}": { - "vlan_range": "{{ vlan_range }}", + "vlan_range": "{{ vlan_range | string }}", "root": { "primary": { "diameter": "{{ diameter }}", @@ -574,7 +574,7 @@ def __init__(self, lines=None, module=None): "result": { "vlan": { "{{ vlan_range | string }}": { - "vlan_range": "{{ vlan_range }}", + "vlan_range": "{{ vlan_range | string }}", "root": { "secondary": { "diameter": "{{ diameter }}", From 0a1d8a1840dedcbe026671408bb5aa0b207fa194 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 12 Mar 2024 11:39:07 +0000 Subject: [PATCH 26/30] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .../spanning_tree_global.py | 21 +++++++++++-------- .../nxos/rm_templates/spanning_tree_global.py | 16 +++++++------- 2 files changed, 20 insertions(+), 17 deletions(-) diff --git a/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py index 51ff0cf16..c8091103b 100644 --- a/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py @@ -44,8 +44,7 @@ def get_config(self, connection): return summary + general def _convert_to_str(self, config_list, key_name): - """Convert range values to strings - """ + """Convert range values to strings""" for obj in config_list: if isinstance(obj.get(key_name), list) or isinstance(obj.get(key_name), tuple): @@ -56,8 +55,7 @@ def _convert_to_str(self, config_list, key_name): return config_list def _dict_to_list(self, objs): - """Convert a dict to a list of dicts - """ + """Convert a dict to a list of dicts""" mst_obj = objs.get("mst", {}) configure_mst_obj = mst_obj.get("configure_mst", {}) @@ -66,20 +64,25 @@ def _dict_to_list(self, objs): if instance_vlan_obj: objs["mst"]["configure_mst"]["instance_vlan"] = list(instance_vlan_obj.values()) objs["mst"]["configure_mst"]["instance_vlan"] = self._convert_to_str( - objs["mst"]["configure_mst"]["instance_vlan"], "vlan_range" + objs["mst"]["configure_mst"]["instance_vlan"], + "vlan_range", ) - + pseudo_obj = objs.get("pseudo_info", {}) pseudo_mst_obj = pseudo_obj.get("mst_info", {}) pseudo_vlan_obj = pseudo_obj.get("vlan_info", {}) if pseudo_mst_obj: objs["pseudo_info"]["mst_info"] = list(pseudo_mst_obj.values()) - objs["pseudo_info"]["mst_info"] = self._convert_to_str(objs["pseudo_info"]["mst_info"], "range") - + objs["pseudo_info"]["mst_info"] = self._convert_to_str( + objs["pseudo_info"]["mst_info"], "range" + ) + if pseudo_vlan_obj: objs["pseudo_info"]["vlan_info"] = list(pseudo_vlan_obj.values()) - objs["pseudo_info"]["vlan_info"] = self._convert_to_str(objs["pseudo_info"]["vlan_info"], "range") + objs["pseudo_info"]["vlan_info"] = self._convert_to_str( + objs["pseudo_info"]["vlan_info"], "range" + ) if "vlan" in objs: objs["vlan"] = list(objs["vlan"].values()) diff --git a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py index ca06aa5b7..274792ee1 100644 --- a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py @@ -384,7 +384,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "designated_priority": "{{ designated_priority }}", }, - } + }, }, }, }, @@ -405,7 +405,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "root_priority": "{{ root_priority }}", }, - } + }, }, }, }, @@ -426,7 +426,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "designated_priority": "{{ designated_priority }}", }, - } + }, }, }, }, @@ -447,7 +447,7 @@ def __init__(self, lines=None, module=None): "range": "{{ range }}", "root_priority": "{{ root_priority }}", }, - } + }, }, }, }, @@ -467,7 +467,7 @@ def __init__(self, lines=None, module=None): "vlan_range": "{{ vlan_range | string }}", "forward_time": "{{ forward_time }}", }, - }, + }, }, }, { @@ -486,7 +486,7 @@ def __init__(self, lines=None, module=None): "vlan_range": "{{ vlan_range | string }}", "hello_time": "{{ hello_time }}", }, - }, + }, }, }, { @@ -505,7 +505,7 @@ def __init__(self, lines=None, module=None): "vlan_range": "{{ vlan_range | string }}", "max_age": "{{ max_age }}", }, - }, + }, }, }, { @@ -524,7 +524,7 @@ def __init__(self, lines=None, module=None): "vlan_range": "{{ vlan_range | string }}", "priority": "{{ priority }}", }, - }, + }, }, }, { From 7aec4f9f7183c177284d904b7c62b9f78b59293e Mon Sep 17 00:00:00 2001 From: Vinay Mulugund Date: Fri, 15 Mar 2024 21:29:16 +0530 Subject: [PATCH 27/30] config side code --- .../spanning_tree_global.py | 119 ++++++++++++++++-- .../nxos/rm_templates/spanning_tree_global.py | 83 ++++++------ plugins/modules/nxos_spanning_tree_global.py | 3 + 3 files changed, 158 insertions(+), 47 deletions(-) diff --git a/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py index 1cfa7fa14..c50cc1686 100644 --- a/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py @@ -26,6 +26,7 @@ ) from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import ( dict_merge, + get_from_dict, ) from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.facts.facts import Facts @@ -48,9 +49,49 @@ def __init__(self, module): tmplt=Spanning_tree_globalTemplate(), ) self.parsers = [ - "bridge.bridge_assurance", + "bridge_assurance", + "domain.identifier", + "domain.disable", + "domain.enable", + "domain.clear_stats", + "fcoe", + "lc_issu", + "loopguard_default", + "mode", + "mst.forward_time", + "mst.hello_time", + "mst.max_age", + "mst.max_hops", + "mst.simulate_pvst_global", + "pathcost_method", + "port_type.edge.bpdufilter", + "port_type.edge.bpduguard", + "port_type.default_type", ] + self.configure_mst_parsers = [ + "mst.configure_mst.name", + "mst.configure_mst.revision", + "mst.configure_mst.private_vlan_sync", + ] + + self.vlan_parsers = [ + "forward_time", + "hello_time", + "max_age", + "priority", + "root.primary", + "root.secondary", + ] + + self.pseudo_info_parsers = [ + "mst_info.designated_priority", + "mst_info.root_priority", + "vlan_info.designated_priority", + "vlan_info.root_priority", + ] + + def execute_module(self): """Execute the module @@ -66,8 +107,8 @@ def generate_commands(self): """Generate configuration commands to send based on want, have and desired state. """ - wantd = {entry["name"]: entry for entry in self.want} - haved = {entry["name"]: entry for entry in self.have} + wantd = self._sptg_list_to_dict(self.want) + haved = self._sptg_list_to_dict(self.have) # if state is merged, merge want onto have and then compare if self.state == "merged": @@ -75,17 +116,9 @@ def generate_commands(self): # if state is deleted, empty out wantd and set haved to wantd if self.state == "deleted": - haved = {k: v for k, v in iteritems(haved) if k in wantd or not wantd} wantd = {} - # remove superfluous config for overridden and deleted - if self.state in ["overridden", "deleted"]: - for k, have in iteritems(haved): - if k not in wantd: - self._compare(want={}, have=have) - - for k, want in iteritems(wantd): - self._compare(want=want, have=haved.pop(k, {})) + self._compare(want=wantd, have=haved) def _compare(self, want, have): """Leverages the base class `compare()` method and @@ -94,3 +127,65 @@ def _compare(self, want, have): for the Spanning_tree_global network resource. """ self.compare(parsers=self.parsers, want=want, have=have) + self._vlans_compare(want=want, have=have) + self._compare_pesudo_info_items(want=want, have=have) + + + def _compare_pesudo_info_items(self, want, have): + begin = len(self.commands) + for ty in ["mst_info", "vlan_info"]: + i_want = want.get("pseudo_info", {}).get(ty, {}) + i_have = have.get("pseudo_info", {}).get(ty, {}) + for k, v in iteritems(i_want): + inner_want = {ty: v} + inner_have = {ty: i_have.pop(k, {})} + self._complex_compare( + want=inner_want, + have=inner_have, + parserlist=self.pseudo_info_parsers + ) + for k, v in iteritems(i_have): + inner_have = {ty: v} + self._complex_compare( + parserlist=self.pseudo_info_parsers, + want={}, have=inner_have + ) + + if begin != len(self.commands): + self.commands.insert(begin, "spanning-tree pseudo-information") + + def _vlans_compare(self, want, have): + wareas = want.get("vlan", {}) + hareas = have.get("vlan", {}) + for name, entry in iteritems(wareas): + self._complex_compare( + want=entry, + have=hareas.pop(name, {}), + parserlist=self.vlan_parsers + ) + for name, entry in iteritems(hareas): + self._complex_compare( + want={}, have=entry, + parserlist=self.vlan_parsers + ) + + def _complex_compare(self, want, have, parserlist): + self.compare(parsers=parserlist, want=want, have=have) + + def _sptg_list_to_dict(self, data): + """Convert all list of dicts to dicts of dicts""" + p_key = { + "vlan": "vlan_range", + "mst_info": "range", + "vlan_info": "range", + "instance_vlan": "vlan_range" + } + tmp_data = deepcopy(data) + for k, _v in p_key.items(): + if k in tmp_data and k == "vlan": + tmp_data[k] = {str(i[p_key[k]]): i for i in tmp_data[k]} + if tmp_data.get("pseudo_info", {}).get(k) and k in ["mst_info", "vlan_info"]: + tmp_data["pseudo_info"][k] = {str(i[p_key[k]]): i for i in tmp_data["pseudo_info"][k]} + if tmp_data.get("mst", {}).get("configure_mst", {}).get("instance_vlan", {}) and k == "instance_vlan": + tmp_data["mst"]["configure_mst"][k] = {str(i[p_key[k]]): i for i in tmp_data["mst"]["configure_mst"][k]} + return tmp_data \ No newline at end of file diff --git a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py index 274792ee1..31def41a7 100644 --- a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py @@ -38,18 +38,18 @@ def __init__(self, lines=None, module=None): ), "setval": "spanning-tree bridge assurance", "result": { - "bridge_assurance": "{{ True if 'enabled' in is_enabled else False }}", + "bridge_assurance": "{{ True if 'enabled' in is_enabled else None }}", }, }, { "name": "domain.identifier", "getval": re.compile( r""" - ^spanning-tree\domain + ^spanning-tree\sdomain \s(?P\d+) $""", re.VERBOSE, ), - "setval": "spanning-tree domain {{ identifier }}", + "setval": "spanning-tree domain {{ domain.identifier }}", "result": { "domain": { "identifier": "{{ identifier }}", @@ -60,14 +60,14 @@ def __init__(self, lines=None, module=None): "name": "domain.disable", "getval": re.compile( r""" - ^spanning-tree\domain + ^spanning-tree\sdomain \s(?Pdisable) $""", re.VERBOSE, ), "setval": "spanning-tree domain disable", "result": { "domain": { - "disable": "{{ True if disable is defined else False }}", + "disable": "{{ True }}", }, }, }, @@ -75,14 +75,14 @@ def __init__(self, lines=None, module=None): "name": "domain.enable", "getval": re.compile( r""" - ^spanning-tree\domain + ^spanning-tree\sdomain \s(?Penable) $""", re.VERBOSE, ), "setval": "spanning-tree domain enable", "result": { "domain": { - "enable": "{{ True if enable is defined else False }}", + "enable": "{{ True }}", }, }, }, @@ -90,14 +90,14 @@ def __init__(self, lines=None, module=None): "name": "domain.clear_stats", "getval": re.compile( r""" - ^spanning-tree\domain - \s(?Pclear\sstatistics) + ^spanning-tree\sdomain + \sclear\s(?Pstatistics) $""", re.VERBOSE, ), "setval": "spanning-tree domain enable", "result": { "domain": { - "clear_stats": "{{ True if clear is defined else False }}", + "clear_stats": "{{ True }}", }, }, }, @@ -137,7 +137,7 @@ def __init__(self, lines=None, module=None): ), "setval": "spanning-tree loopguard default", "result": { - "loopguard_default": "{{ True if 'enabled' in is_enabled else False }}", + "loopguard_default": "{{ True if 'enabled' in is_enabled else None }}", }, }, { @@ -163,7 +163,7 @@ def __init__(self, lines=None, module=None): \sforward-time\s(?P\d+) $""", re.VERBOSE, ), - "setval": "spanning-tree mst forward-time {{ forward_time }}", + "setval": "spanning-tree mst forward-time {{ mst.forward_time }}", "result": { "mst": { "forward_time": "{{ forward_time }}", @@ -178,7 +178,7 @@ def __init__(self, lines=None, module=None): \shello-time\s(?P\d+) $""", re.VERBOSE, ), - "setval": "spanning-tree mst hello-time {{ hello_time }}", + "setval": "spanning-tree mst hello-time {{ mst.hello_time }}", "result": { "mst": { "hello_time": "{{ hello_time }}", @@ -193,7 +193,7 @@ def __init__(self, lines=None, module=None): \smax-age\s(?P\d+) $""", re.VERBOSE, ), - "setval": "spanning-tree mst max-age {{ max_age }}", + "setval": "spanning-tree mst max-age {{ mst.max_age }}", "result": { "mst": { "max_age": "{{ max_age }}", @@ -208,7 +208,7 @@ def __init__(self, lines=None, module=None): \smax-hops\s(?P\d+) $""", re.VERBOSE, ), - "setval": "spanning-tree mst max-hops {{ max_hops }}", + "setval": "spanning-tree mst max-hops {{ mst.max_hops }}", "result": { "mst": { "max_hops": "{{ max_hops }}", @@ -226,7 +226,7 @@ def __init__(self, lines=None, module=None): "setval": "spanning-tree mst simulate pvst global", "result": { "mst": { - "simulate_pvst_global": "{{ True if 'enabled' in simulate_pvst_global else False }}", + "simulate_pvst_global": "{{ True if 'enabled' in simulate_pvst_global else None }}", }, }, }, @@ -237,7 +237,7 @@ def __init__(self, lines=None, module=None): ^\s+name\s(?P\S+) $""", re.VERBOSE, ), - "setval": "name {{ configure_mst.name }}", + "setval": "name {{ mst.configure_mst.name }}", "result": { "mst": { "configure_mst": { @@ -253,7 +253,7 @@ def __init__(self, lines=None, module=None): ^\s+revision\s(?P\S+) $""", re.VERBOSE, ), - "setval": "revision {{ configure_mst.revision }}", + "setval": "revision {{ mst.configure_mst.revision }}", "result": { "mst": { "configure_mst": { @@ -273,7 +273,7 @@ def __init__(self, lines=None, module=None): "result": { "mst": { "configure_mst": { - "private_vlan_sync": "{{ True if synchronize is defined else False }}", + "private_vlan_sync": "{{ True }}", }, }, }, @@ -327,7 +327,7 @@ def __init__(self, lines=None, module=None): "result": { "port_type": { "edge": { - "bpdufilter": "{{ True if bpdufilter is defined else False }}", + "bpdufilter": "{{ True if bpdufilter is defined else None }}", }, }, }, @@ -345,7 +345,7 @@ def __init__(self, lines=None, module=None): "result": { "port_type": { "edge": { - "bpduguard": "{{ True if bpduguard is defined else False }}", + "bpduguard": "{{ True if bpduguard is defined else None }}", }, }, }, @@ -367,8 +367,20 @@ def __init__(self, lines=None, module=None): }, }, }, + # pseudo_info parsers { - "name": "pseudo_info.mst_info.designated_priority", + "name": "pseudo_info", + "getval": re.compile( + r""" + ^spanning-tree + \spseudo-information + $""", re.VERBOSE, + ), + "setval": "spanning-tree pseudo-information", + "result": {} + }, + { + "name": "mst_info.designated_priority", "getval": re.compile( r""" ^\s+mst\s(?P\S+) @@ -389,7 +401,7 @@ def __init__(self, lines=None, module=None): }, }, { - "name": "pseudo_info.mst_info.root_priority", + "name": "mst_info.root_priority", "getval": re.compile( r""" ^\s+mst\s(?P\S+) @@ -398,6 +410,7 @@ def __init__(self, lines=None, module=None): $""", re.VERBOSE, ), "setval": "mst {{ mst_info.range }} root priority {{ mst_info.root_priority }}", + "compval": "mst_info", "result": { "pseudo_info": { "mst_info": { @@ -410,7 +423,7 @@ def __init__(self, lines=None, module=None): }, }, { - "name": "pseudo_info.vlan_info.designated_priority", + "name": "vlan_info.designated_priority", "getval": re.compile( r""" ^\s+vlan\s(?P\S+) @@ -431,7 +444,7 @@ def __init__(self, lines=None, module=None): }, }, { - "name": "pseudo_info.vlan_info.root_priority", + "name": "vlan_info.root_priority", "getval": re.compile( r""" ^\s+vlan\s(?P\S+) @@ -452,7 +465,7 @@ def __init__(self, lines=None, module=None): }, }, { - "name": "vlan.forward_time", + "name": "forward_time", "getval": re.compile( r""" ^spanning-tree\svlan @@ -460,7 +473,7 @@ def __init__(self, lines=None, module=None): \sforward-time\s(?P\d+) $""", re.VERBOSE, ), - "setval": "spanning-tree vlan {{ vlan_range }} forward-time {{ forward_time }}", + "setval": "spanning-tree vlan {{ vlan_range }} forward-time {{ forward_time|string }}", "result": { "vlan": { "{{ vlan_range | string }}": { @@ -471,7 +484,7 @@ def __init__(self, lines=None, module=None): }, }, { - "name": "vlan.hello_time", + "name": "hello_time", "getval": re.compile( r""" ^spanning-tree\svlan @@ -479,7 +492,7 @@ def __init__(self, lines=None, module=None): \shello-time\s(?P\d+) $""", re.VERBOSE, ), - "setval": "spanning-tree vlan {{ vlan_range }} hello-time {{ hello_time }}", + "setval": "spanning-tree vlan {{ vlan_range }} hello-time {{ hello_time|string }}", "result": { "vlan": { "{{ vlan_range | string }}": { @@ -490,7 +503,7 @@ def __init__(self, lines=None, module=None): }, }, { - "name": "vlan.max_age", + "name": "max_age", "getval": re.compile( r""" ^spanning-tree\svlan @@ -498,7 +511,7 @@ def __init__(self, lines=None, module=None): \smax-age\s(?P\d+) $""", re.VERBOSE, ), - "setval": "spanning-tree vlan {{ vlan_range }} max-age {{ max_age }}", + "setval": "spanning-tree vlan {{ vlan_range }} max-age {{ max_age|string }}", "result": { "vlan": { "{{ vlan_range | string }}": { @@ -509,7 +522,7 @@ def __init__(self, lines=None, module=None): }, }, { - "name": "vlan.priority", + "name": "priority", "getval": re.compile( r""" ^spanning-tree\svlan @@ -517,7 +530,7 @@ def __init__(self, lines=None, module=None): \spriority\s(?P\d+) $""", re.VERBOSE, ), - "setval": "spanning-tree vlan {{ vlan_range }} priority {{ priority }}", + "setval": "spanning-tree vlan {{ vlan_range }} priority {{ priority|string }}", "result": { "vlan": { "{{ vlan_range | string }}": { @@ -528,7 +541,7 @@ def __init__(self, lines=None, module=None): }, }, { - "name": "vlan.root.primary", + "name": "root.primary", "getval": re.compile( r""" ^spanning-tree\svlan @@ -557,7 +570,7 @@ def __init__(self, lines=None, module=None): }, }, { - "name": "vlan.root.secondary", + "name": "root.secondary", "getval": re.compile( r""" ^spanning-tree\svlan diff --git a/plugins/modules/nxos_spanning_tree_global.py b/plugins/modules/nxos_spanning_tree_global.py index e882caf35..c505352e5 100644 --- a/plugins/modules/nxos_spanning_tree_global.py +++ b/plugins/modules/nxos_spanning_tree_global.py @@ -325,6 +325,9 @@ Spanning_tree_global, ) +import debugpy +debugpy.listen(3000) +debugpy.wait_for_client() def main(): """ From fbc3772836644c19b39c755ec68fe4552f829cbf Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 15 Mar 2024 15:59:58 +0000 Subject: [PATCH 28/30] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .../spanning_tree_global.py | 41 +++++++++++-------- .../spanning_tree_global.py | 6 ++- .../nxos/rm_templates/spanning_tree_global.py | 2 +- plugins/modules/nxos_spanning_tree_global.py | 5 ++- 4 files changed, 33 insertions(+), 21 deletions(-) diff --git a/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py index c50cc1686..1eb213a8f 100644 --- a/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py @@ -91,7 +91,6 @@ def __init__(self, module): "vlan_info.root_priority", ] - def execute_module(self): """Execute the module @@ -130,7 +129,6 @@ def _compare(self, want, have): self._vlans_compare(want=want, have=have) self._compare_pesudo_info_items(want=want, have=have) - def _compare_pesudo_info_items(self, want, have): begin = len(self.commands) for ty in ["mst_info", "vlan_info"]: @@ -140,17 +138,18 @@ def _compare_pesudo_info_items(self, want, have): inner_want = {ty: v} inner_have = {ty: i_have.pop(k, {})} self._complex_compare( - want=inner_want, + want=inner_want, have=inner_have, - parserlist=self.pseudo_info_parsers + parserlist=self.pseudo_info_parsers, ) for k, v in iteritems(i_have): inner_have = {ty: v} self._complex_compare( - parserlist=self.pseudo_info_parsers, - want={}, have=inner_have + parserlist=self.pseudo_info_parsers, + want={}, + have=inner_have, ) - + if begin != len(self.commands): self.commands.insert(begin, "spanning-tree pseudo-information") @@ -159,14 +158,15 @@ def _vlans_compare(self, want, have): hareas = have.get("vlan", {}) for name, entry in iteritems(wareas): self._complex_compare( - want=entry, - have=hareas.pop(name, {}), - parserlist=self.vlan_parsers + want=entry, + have=hareas.pop(name, {}), + parserlist=self.vlan_parsers, ) for name, entry in iteritems(hareas): self._complex_compare( - want={}, have=entry, - parserlist=self.vlan_parsers + want={}, + have=entry, + parserlist=self.vlan_parsers, ) def _complex_compare(self, want, have, parserlist): @@ -178,14 +178,21 @@ def _sptg_list_to_dict(self, data): "vlan": "vlan_range", "mst_info": "range", "vlan_info": "range", - "instance_vlan": "vlan_range" + "instance_vlan": "vlan_range", } tmp_data = deepcopy(data) for k, _v in p_key.items(): if k in tmp_data and k == "vlan": tmp_data[k] = {str(i[p_key[k]]): i for i in tmp_data[k]} if tmp_data.get("pseudo_info", {}).get(k) and k in ["mst_info", "vlan_info"]: - tmp_data["pseudo_info"][k] = {str(i[p_key[k]]): i for i in tmp_data["pseudo_info"][k]} - if tmp_data.get("mst", {}).get("configure_mst", {}).get("instance_vlan", {}) and k == "instance_vlan": - tmp_data["mst"]["configure_mst"][k] = {str(i[p_key[k]]): i for i in tmp_data["mst"]["configure_mst"][k]} - return tmp_data \ No newline at end of file + tmp_data["pseudo_info"][k] = { + str(i[p_key[k]]): i for i in tmp_data["pseudo_info"][k] + } + if ( + tmp_data.get("mst", {}).get("configure_mst", {}).get("instance_vlan", {}) + and k == "instance_vlan" + ): + tmp_data["mst"]["configure_mst"][k] = { + str(i[p_key[k]]): i for i in tmp_data["mst"]["configure_mst"][k] + } + return tmp_data diff --git a/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py index c8091103b..fdc32b37c 100644 --- a/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/facts/spanning_tree_global/spanning_tree_global.py @@ -75,13 +75,15 @@ def _dict_to_list(self, objs): if pseudo_mst_obj: objs["pseudo_info"]["mst_info"] = list(pseudo_mst_obj.values()) objs["pseudo_info"]["mst_info"] = self._convert_to_str( - objs["pseudo_info"]["mst_info"], "range" + objs["pseudo_info"]["mst_info"], + "range", ) if pseudo_vlan_obj: objs["pseudo_info"]["vlan_info"] = list(pseudo_vlan_obj.values()) objs["pseudo_info"]["vlan_info"] = self._convert_to_str( - objs["pseudo_info"]["vlan_info"], "range" + objs["pseudo_info"]["vlan_info"], + "range", ) if "vlan" in objs: diff --git a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py index 31def41a7..0e8613fba 100644 --- a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py @@ -377,7 +377,7 @@ def __init__(self, lines=None, module=None): $""", re.VERBOSE, ), "setval": "spanning-tree pseudo-information", - "result": {} + "result": {}, }, { "name": "mst_info.designated_priority", diff --git a/plugins/modules/nxos_spanning_tree_global.py b/plugins/modules/nxos_spanning_tree_global.py index c505352e5..ce5a1954c 100644 --- a/plugins/modules/nxos_spanning_tree_global.py +++ b/plugins/modules/nxos_spanning_tree_global.py @@ -316,6 +316,8 @@ module argspec. """ +import debugpy + from ansible.module_utils.basic import AnsibleModule from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.argspec.spanning_tree_global.spanning_tree_global import ( @@ -325,10 +327,11 @@ Spanning_tree_global, ) -import debugpy + debugpy.listen(3000) debugpy.wait_for_client() + def main(): """ Main entry point for module execution From 61cbe14d9f842bb9c1059f870441055f7cb3b86e Mon Sep 17 00:00:00 2001 From: Vinay Mulugund Date: Fri, 15 Mar 2024 23:43:46 +0530 Subject: [PATCH 29/30] added all action states --- .../spanning_tree_global.py | 84 ++++++++++++------- .../nxos/rm_templates/spanning_tree_global.py | 14 +++- plugins/modules/nxos_spanning_tree_global.py | 5 -- 3 files changed, 67 insertions(+), 36 deletions(-) diff --git a/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py index 1eb213a8f..d040afe21 100644 --- a/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py @@ -113,7 +113,7 @@ def generate_commands(self): if self.state == "merged": wantd = dict_merge(haved, wantd) - # if state is deleted, empty out wantd and set haved to wantd + # if state is deleted, empty out wantd if self.state == "deleted": wantd = {} @@ -126,47 +126,71 @@ def _compare(self, want, have): for the Spanning_tree_global network resource. """ self.compare(parsers=self.parsers, want=want, have=have) - self._vlans_compare(want=want, have=have) + self._list_compare( + want=want.get("vlan", {}), + have=have.get("vlan", {}), + parserlist=self.vlan_parsers, + ) self._compare_pesudo_info_items(want=want, have=have) + self._compare_mst_configure(want=want, have=have) + + def _compare_mst_configure(self, want, have): + begin = len(self.commands) + self._complex_compare(want=want, have=have, parserlist=self.configure_mst_parsers) + + iv_want = want.get("mst", {}).get("configure_mst", {}).get("instance_vlan", {}) + iv_have = have.get("mst", {}).get("configure_mst", {}).get("instance_vlan", {}) + + for want_key, want_entry in iteritems(iv_want): + have_entry = iv_have.pop(want_key, {}) + if want_entry != have_entry: + if have_entry and self.state in ["overridden", "replaced"]: + self.addcmd(have_entry, "instance_vlan", negate=True) + self.addcmd(want_entry, "instance_vlan", False) + + for _k, hv in iteritems(iv_have): + self.addcmd(hv, "instance_vlan", negate=True) + + if begin != len(self.commands): + self.commands.insert(begin, "spanning-tree mst configuration") def _compare_pesudo_info_items(self, want, have): begin = len(self.commands) - for ty in ["mst_info", "vlan_info"]: - i_want = want.get("pseudo_info", {}).get(ty, {}) - i_have = have.get("pseudo_info", {}).get(ty, {}) - for k, v in iteritems(i_want): - inner_want = {ty: v} - inner_have = {ty: i_have.pop(k, {})} - self._complex_compare( - want=inner_want, - have=inner_have, - parserlist=self.pseudo_info_parsers, - ) - for k, v in iteritems(i_have): - inner_have = {ty: v} - self._complex_compare( - parserlist=self.pseudo_info_parsers, - want={}, - have=inner_have, - ) + for typex in ["mst_info", "vlan_info"]: + i_want = want.get("pseudo_info", {}).get(typex, {}) + i_have = have.get("pseudo_info", {}).get(typex, {}) + self._list_compare( + want=i_want, + have=i_have, + parserlist=self.pseudo_info_parsers, + typex=typex, + ) if begin != len(self.commands): self.commands.insert(begin, "spanning-tree pseudo-information") - def _vlans_compare(self, want, have): - wareas = want.get("vlan", {}) - hareas = have.get("vlan", {}) - for name, entry in iteritems(wareas): + def _list_compare(self, want, have, parserlist, typex = None): + for name, entry in iteritems(want): + if typex: + i_want = {typex: entry} + i_have = {typex: have.pop(name, {})} + else: + i_want = entry + i_have = have.pop(name, {}) self._complex_compare( - want=entry, - have=hareas.pop(name, {}), - parserlist=self.vlan_parsers, + want=i_want, + have=i_have, + parserlist=parserlist, ) - for name, entry in iteritems(hareas): + for name, entry in iteritems(have): + if typex: + ix_have = {typex: entry} + else: + ix_have = entry self._complex_compare( want={}, - have=entry, - parserlist=self.vlan_parsers, + have=ix_have, + parserlist=parserlist, ) def _complex_compare(self, want, have, parserlist): diff --git a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py index 0e8613fba..b61dcff12 100644 --- a/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/rm_templates/spanning_tree_global.py @@ -230,6 +230,18 @@ def __init__(self, lines=None, module=None): }, }, }, + # configure_mst parsers + { + "name": "configure_mst", + "getval": re.compile( + r""" + ^spanning-tree\smst + \sconfiguration + $""", re.VERBOSE, + ), + "setval": "spanning-tree mst configuration", + "result": {}, + }, { "name": "mst.configure_mst.name", "getval": re.compile( @@ -279,7 +291,7 @@ def __init__(self, lines=None, module=None): }, }, { - "name": "mst.configure_mst.instance_vlan", + "name": "instance_vlan", "getval": re.compile( r""" ^\s+instance diff --git a/plugins/modules/nxos_spanning_tree_global.py b/plugins/modules/nxos_spanning_tree_global.py index ce5a1954c..ad2713554 100644 --- a/plugins/modules/nxos_spanning_tree_global.py +++ b/plugins/modules/nxos_spanning_tree_global.py @@ -316,7 +316,6 @@ module argspec. """ -import debugpy from ansible.module_utils.basic import AnsibleModule @@ -328,10 +327,6 @@ ) -debugpy.listen(3000) -debugpy.wait_for_client() - - def main(): """ Main entry point for module execution From f1b564dd9ffeccb7dc406f93f29eec3eeae19139 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 15 Mar 2024 18:14:29 +0000 Subject: [PATCH 30/30] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .../config/spanning_tree_global/spanning_tree_global.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py b/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py index d040afe21..23f71d200 100644 --- a/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py +++ b/plugins/module_utils/network/nxos/config/spanning_tree_global/spanning_tree_global.py @@ -127,7 +127,7 @@ def _compare(self, want, have): """ self.compare(parsers=self.parsers, want=want, have=have) self._list_compare( - want=want.get("vlan", {}), + want=want.get("vlan", {}), have=have.get("vlan", {}), parserlist=self.vlan_parsers, ) @@ -140,7 +140,7 @@ def _compare_mst_configure(self, want, have): iv_want = want.get("mst", {}).get("configure_mst", {}).get("instance_vlan", {}) iv_have = have.get("mst", {}).get("configure_mst", {}).get("instance_vlan", {}) - + for want_key, want_entry in iteritems(iv_want): have_entry = iv_have.pop(want_key, {}) if want_entry != have_entry: @@ -150,7 +150,7 @@ def _compare_mst_configure(self, want, have): for _k, hv in iteritems(iv_have): self.addcmd(hv, "instance_vlan", negate=True) - + if begin != len(self.commands): self.commands.insert(begin, "spanning-tree mst configuration") @@ -169,7 +169,7 @@ def _compare_pesudo_info_items(self, want, have): if begin != len(self.commands): self.commands.insert(begin, "spanning-tree pseudo-information") - def _list_compare(self, want, have, parserlist, typex = None): + def _list_compare(self, want, have, parserlist, typex=None): for name, entry in iteritems(want): if typex: i_want = {typex: entry}