From a453ac31f3428614cceb99027f8efbdb9258a40b Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Tue, 14 May 2024 22:03:01 +0200 Subject: Adding upstream version 2.10.7+merged+base+2.10.8+dfsg. Signed-off-by: Daniel Baumann --- .../cisco.iosxr.iosxr_acl_interfaces_module.rst | 774 ++ .../iosxr/docs/cisco.iosxr.iosxr_acls_module.rst | 4731 +++++++++ .../iosxr/docs/cisco.iosxr.iosxr_banner_module.rst | 331 + .../iosxr/docs/cisco.iosxr.iosxr_bgp_module.rst | 718 ++ .../cisco/iosxr/docs/cisco.iosxr.iosxr_cliconf.rst | 43 + .../docs/cisco.iosxr.iosxr_command_module.rst | 382 + .../iosxr/docs/cisco.iosxr.iosxr_config_module.rst | 649 ++ .../iosxr/docs/cisco.iosxr.iosxr_facts_module.rst | 533 + .../docs/cisco.iosxr.iosxr_interface_module.rst | 748 ++ .../docs/cisco.iosxr.iosxr_interfaces_module.rst | 697 ++ .../cisco.iosxr.iosxr_l2_interfaces_module.rst | 879 ++ .../cisco.iosxr.iosxr_l3_interfaces_module.rst | 803 ++ .../cisco.iosxr.iosxr_lacp_interfaces_module.rst | 802 ++ .../iosxr/docs/cisco.iosxr.iosxr_lacp_module.rst | 500 + .../cisco.iosxr.iosxr_lag_interfaces_module.rst | 1033 ++ .../docs/cisco.iosxr.iosxr_lldp_global_module.rst | 692 ++ .../cisco.iosxr.iosxr_lldp_interfaces_module.rst | 849 ++ .../docs/cisco.iosxr.iosxr_logging_module.rst | 633 ++ .../cisco/iosxr/docs/cisco.iosxr.iosxr_netconf.rst | 76 + .../docs/cisco.iosxr.iosxr_netconf_module.rst | 296 + .../cisco.iosxr.iosxr_ospf_interfaces_module.rst | 3089 ++++++ .../iosxr/docs/cisco.iosxr.iosxr_ospfv2_module.rst | 7069 +++++++++++++ .../iosxr/docs/cisco.iosxr.iosxr_ospfv3_module.rst | 10348 +++++++++++++++++++ .../cisco.iosxr.iosxr_static_routes_module.rst | 1141 ++ .../iosxr/docs/cisco.iosxr.iosxr_system_module.rst | 427 + .../iosxr/docs/cisco.iosxr.iosxr_user_module.rst | 651 ++ 26 files changed, 38894 insertions(+) create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_acl_interfaces_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_acls_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_banner_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_bgp_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_cliconf.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_command_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_config_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_facts_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_interface_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_interfaces_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_l2_interfaces_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_l3_interfaces_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_lacp_interfaces_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_lacp_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_lag_interfaces_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_lldp_global_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_lldp_interfaces_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_logging_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_netconf.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_netconf_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_ospf_interfaces_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_ospfv2_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_ospfv3_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_static_routes_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_system_module.rst create mode 100644 collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_user_module.rst (limited to 'collections-debian-merged/ansible_collections/cisco/iosxr/docs') diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_acl_interfaces_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_acl_interfaces_module.rst new file mode 100644 index 00000000..7097b018 --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_acl_interfaces_module.rst @@ -0,0 +1,774 @@ +.. _cisco.iosxr.iosxr_acl_interfaces_module: + + +******************************** +cisco.iosxr.iosxr_acl_interfaces +******************************** + +**ACL interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages adding and removing Access Control Lists (ACLs) from interfaces on devices running IOS-XR software. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary of ACL options for interfaces.
+
+
+ access_groups + +
+ list + / elements=dictionary +
+ 		+ +
Specifies ACLs attached to the interfaces.
+
+
+ acls + +
+ list + / elements=dictionary +
+ 		+ +
Specifies the ACLs for the provided AFI.
+
+
+ direction + +
+ string + / required +
+ 		+
    Choices: +
  • in
    • +
  • out
    • +
+ 		+
Specifies the direction of packets that the ACL will be applied on.
+
+
+ name + +
+ string + / required +
+ 		+ +
Specifies the name of the IPv4/IPv6 ACL for the interface.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
Specifies the AFI for the ACL(s) to be configured on this interface.
+
+
+ name + +
+ string + / required +
+ 		+ +
Name/Identifier for 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 IOS-XR device by executing the command show running-config 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.
+
+
+ + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + # RP/0/RP0/CPU0:ios#sh running-config interface + # Wed Jan 15 12:22:32.911 UTC + # interface MgmtEth0/RP0/CPU0/0 + # ipv4 address dhcp + # ! + # interface GigabitEthernet0/0/0/0 + # shutdown + # ! + # interface GigabitEthernet0/0/0/1 + # shutdown + # ! + + - name: Merge the provided configuration with the existing running configuration + cisco.iosxr.iosxr_acl_interfaces: + config: + - name: GigabitEthernet0/0/0/0 + access_groups: + - afi: ipv4 + acls: + - name: acl_1 + direction: in + - name: acl_2 + direction: out + - afi: ipv6 + acls: + - name: acl6_1 + direction: in + - name: acl6_2 + direction: out + + - name: GigabitEthernet0/0/0/1 + access_groups: + - afi: ipv4 + acls: + - name: acl_1 + direction: out + state: merged + + # After state: + # ------------- + # + # RP/0/RP0/CPU0:ios#sh running-config interface + # Wed Jan 15 12:27:49.378 UTC + # interface MgmtEth0/RP0/CPU0/0 + # ipv4 address dhcp + # ! + # interface GigabitEthernet0/0/0/0 + # shutdown + # ipv4 access-group acl_1 ingress + # ipv4 access-group acl_2 egress + # ipv6 access-group acl6_1 ingress + # ipv6 access-group acl6_2 egress + # ! + # interface GigabitEthernet0/0/0/1 + # shutdown + # ipv4 access-group acl_1 egress + # ! + + # Using merged to update interface ACL configuration + + # Before state: + # ------------- + # + # RP/0/RP0/CPU0:ios#sh running-config interface + # Wed Jan 15 12:27:49.378 UTC + # interface MgmtEth0/RP0/CPU0/0 + # ipv4 address dhcp + # ! + # interface GigabitEthernet0/0/0/0 + # shutdown + # ipv4 access-group acl_1 ingress + # ipv4 access-group acl_2 egress + # ipv6 access-group acl6_1 ingress + # ipv6 access-group acl6_2 egress + # ! + # interface GigabitEthernet0/0/0/1 + # shutdown + # ipv4 access-group acl_1 egress + # ! + # + + - name: Update acl_interfaces configuration using merged + cisco.iosxr.iosxr_acl_interfaces: + config: + - name: GigabitEthernet0/0/0/1 + access_groups: + - afi: ipv4 + acls: + - name: acl_2 + direction: out + - name: acl_1 + direction: in + state: merged + + # After state: + # ------------- + # + # RP/0/RP0/CPU0:ios#sh running-config interface + # Wed Jan 15 12:27:49.378 UTC + # interface MgmtEth0/RP0/CPU0/0 + # ipv4 address dhcp + # ! + # interface GigabitEthernet0/0/0/0 + # shutdown + # ipv4 access-group acl_1 ingress + # ipv4 access-group acl_2 egress + # ipv6 access-group acl6_1 ingress + # ipv6 access-group acl6_2 egress + # ! + # interface GigabitEthernet0/0/0/1 + # shutdown + # ipv4 access-group acl_1 ingress + # ipv4 access-group acl_2 egress + # ! + # + + # Using replaced + + # Before state: + # ------------- + # + # RP/0/RP0/CPU0:ios#sh running-config interface + # Wed Jan 15 12:34:56.689 UTC + # interface MgmtEth0/RP0/CPU0/0 + # ipv4 address dhcp + # ! + # interface GigabitEthernet0/0/0/0 + # shutdown + # ipv4 access-group acl_1 ingress + # ipv4 access-group acl_2 egress + # ipv6 access-group acl6_1 ingress + # ipv6 access-group acl6_2 egress + # ! + # interface GigabitEthernet0/0/0/1 + # shutdown + # ipv4 access-group acl_1 egress + # ! + + - name: Replace device configurations of listed interface with provided configurations + cisco.iosxr.iosxr_acl_interfaces: + config: + - name: GigabitEthernet0/0/0/0 + access_groups: + - afi: ipv6 + acls: + - name: acl6_3 + direction: in + state: replaced + + # After state: + # ------------- + # + # RP/0/RP0/CPU0:ios#sh running-config interface + # Wed Jan 15 12:34:56.689 UTC + # interface MgmtEth0/RP0/CPU0/0 + # ipv4 address dhcp + # ! + # interface GigabitEthernet0/0/0/0 + # shutdown + # ipv6 access-group acl6_3 ingress + # ! + # interface GigabitEthernet0/0/0/1 + # shutdown + # ipv4 access-group acl_1 egress + # ! + # + + # Using overridden + + # Before state: + # ------------- + # + # RP/0/RP0/CPU0:ios#sh running-config interface + # Wed Jan 15 12:34:56.689 UTC + # interface MgmtEth0/RP0/CPU0/0 + # ipv4 address dhcp + # ! + # interface GigabitEthernet0/0/0/0 + # shutdown + # ipv4 access-group acl_1 ingress + # ipv4 access-group acl_2 egress + # ipv6 access-group acl6_1 ingress + # ipv6 access-group acl6_2 egress + # ! + # interface GigabitEthernet0/0/0/1 + # shutdown + # ipv4 access-group acl_1 egress + # ! + # + + - name: Overridde all interface ACL configuration with provided configuration + cisco.iosxr.iosxr_acl_interfaces: + config: + - name: GigabitEthernet0/0/0/1 + access_groups: + - afi: ipv4 + acls: + - name: acl_2 + direction: in + - afi: ipv6 + acls: + - name: acl6_3 + direction: out + state: overridden + + # After state: + # ------------- + # + # RP/0/RP0/CPU0:ios#sh running-config interface + # Wed Jan 15 12:34:56.689 UTC + # interface MgmtEth0/RP0/CPU0/0 + # ipv4 address dhcp + # ! + # interface GigabitEthernet0/0/0/0 + # shutdown + # ! + # interface GigabitEthernet0/0/0/1 + # shutdown + # ipv4 access-group acl_2 ingress + # ipv6 access-group acl6_3 egress + # ! + # + + # Using 'deleted' to delete all ACL attributes of a single interface + + # Before state: + # ------------- + # + # RP/0/RP0/CPU0:ios#sh running-config interface + # Wed Jan 15 12:34:56.689 UTC + # interface MgmtEth0/RP0/CPU0/0 + # ipv4 address dhcp + # ! + # interface GigabitEthernet0/0/0/0 + # shutdown + # ipv4 access-group acl_1 ingress + # ipv4 access-group acl_2 egress + # ipv6 access-group acl6_1 ingress + # ipv6 access-group acl6_2 egress + # ! + # interface GigabitEthernet0/0/0/1 + # shutdown + # ipv4 access-group acl_1 egress + # ! + # + + - name: Delete all ACL attributes of GigabitEthernet0/0/0/1 + cisco.iosxr.iosxr_acl_interfaces: + config: + - name: GigabitEthernet0/0/0/1 + state: deleted + + # After state: + # ------------- + # + # RP/0/RP0/CPU0:ios#sh running-config interface + # Wed Jan 15 12:34:56.689 UTC + # interface MgmtEth0/RP0/CPU0/0 + # ipv4 address dhcp + # ! + # interface GigabitEthernet0/0/0/0 + # shutdown + # ipv4 access-group acl_1 ingress + # ipv4 access-group acl_2 egress + # ipv6 access-group acl6_1 ingress + # ipv6 access-group acl6_2 egress + # ! + # interface GigabitEthernet0/0/0/1 + # shutdown + # ! + # + + # Using 'deleted' to remove all ACLs attached to all the interfaces in the device + + # Before state: + # ------------- + # + # RP/0/RP0/CPU0:ios#sh running-config interface + # Wed Jan 15 12:34:56.689 UTC + # interface MgmtEth0/RP0/CPU0/0 + # ipv4 address dhcp + # ! + # interface GigabitEthernet0/0/0/0 + # shutdown + # ipv4 access-group acl_1 ingress + # ipv4 access-group acl_2 egress + # ipv6 access-group acl6_1 ingress + # ipv6 access-group acl6_2 egress + # ! + # interface GigabitEthernet0/0/0/1 + # shutdown + # ipv4 access-group acl_1 egress + # ! + # + + - name: Delete all ACL interfaces configuration from the device + cisco.iosxr.iosxr_acl_interfaces: + state: deleted + + # After state: + # ------------- + # + # RP/0/RP0/CPU0:ios#sh running-config interface + # Wed Jan 15 12:34:56.689 UTC + # interface MgmtEth0/RP0/CPU0/0 + # ipv4 address dhcp + # ! + # interface GigabitEthernet0/0/0/0 + # shutdown + # ! + # interface GigabitEthernet0/0/0/1 + # shutdown + # ! + # + + # Using parsed + + # parsed.cfg + # ------------ + # + # interface MgmtEth0/RP0/CPU0/0 + # ipv4 address dhcp + # ! + # interface GigabitEthernet0/0/0/0 + # shutdown + # ipv4 access-group acl_1 ingress + # ipv4 access-group acl_2 egress + # ipv6 access-group acl6_1 ingress + # ipv6 access-group acl6_2 egress + # ! + # interface GigabitEthernet0/0/0/1 + # shutdown + # ipv4 access-group acl_1 egress + # ! + + # - name: Convert ACL interfaces config to argspec without connecting to the appliance + # cisco.iosxr.iosxr_acl_interfaces: + # running_config: "{{ lookup('file', './parsed.cfg') }}" + # state: parsed + + + # Task Output (redacted) + # ----------------------- + + # "parsed": [ + # { + # "name": "MgmtEth0/RP0/CPU0/0" + # }, + # { + # "access_groups": [ + # { + # "acls": [ + # { + # "direction": "in", + # "name": "acl_1" + # }, + # { + # "direction": "out", + # "name": "acl_2" + # } + # ], + # "afi": "ipv4" + # }, + # { + # "acls": [ + # { + # "direction": "in", + # "name": "acl6_1" + # }, + # { + # "direction": "out", + # "name": "acl6_2" + # } + # ], + # "afi": "ipv6" + # } + # ], + # "name": "GigabitEthernet0/0/0/0" + # }, + # { + # "access_groups": [ + # { + # "acls": [ + # { + # "direction": "out", + # "name": "acl_1" + # } + # ], + # "afi": "ipv4" + # } + # ], + # "name": "GigabitEthernet0/0/0/1" + # } + # ] + # } + + + # Using gathered + + - name: Gather ACL interfaces facts using gathered state + cisco.iosxr.iosxr_acl_interfaces: + state: gathered + + + # Task Output (redacted) + # ----------------------- + # + # "gathered": [ + # { + # "name": "MgmtEth0/RP0/CPU0/0" + # }, + # { + # "access_groups": [ + # { + # "acls": [ + # { + # "direction": "in", + # "name": "acl_1" + # }, + # { + # "direction": "out", + # "name": "acl_2" + # } + # ], + # "afi": "ipv4" + # } + # "name": "GigabitEthernet0/0/0/0" + # }, + # { + # "access_groups": [ + # { + # "acls": [ + # { + # "direction": "in", + # "name": "acl6_1" + # } + # ], + # "afi": "ipv6" + # } + # "name": "GigabitEthernet0/0/0/1" + # } + # ] + + + # Using rendered + + - name: Render platform specific commands from task input using rendered state + cisco.iosxr.iosxr_acl_interfaces: + config: + - name: GigabitEthernet0/0/0/0 + access_groups: + - afi: ipv4 + acls: + - name: acl_1 + direction: in + - name: acl_2 + direction: out + state: rendered + + # Task Output (redacted) + # ----------------------- + + # "rendered": [ + # "interface GigabitEthernet0/0/0/0", + # "ipv4 access-group acl_1 ingress", + # "ipv4 access-group acl_2 egress" + # ] + + + +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 GigabitEthernet0/0/0/1', 'ipv4 access-group acl_1 ingress', 'ipv4 access-group acl_2 egress', 'ipv6 access-group acl6_1 ingress', 'interface GigabitEthernet0/0/0/2', 'no ipv4 access-group acl_3 ingress', 'ipv4 access-group acl_4 egress']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_acls_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_acls_module.rst new file mode 100644 index 00000000..a03f2a21 --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_acls_module.rst @@ -0,0 +1,4731 @@ +.. _cisco.iosxr.iosxr_acls_module: + + +********************** +cisco.iosxr.iosxr_acls +********************** + +**ACLs resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages Access Control Lists (ACLs) on devices running IOS-XR. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A list of dictionaries specifying ACL configurations.
+
+
+ acls + +
+ list + / elements=dictionary +
+ 		+ +
A list of Access Control Lists (ACLs).
+
+
+ aces + +
+ list + / elements=dictionary +
+ 		+ +
List of Access Control Entries (ACEs) for this Access Control List (ACL).
+
+
+ authen + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match if authentication header is present.
+
+
+ capture + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Capture matched packet.
+
+
+ destination + +
+ dictionary +
+ 		+ +
Specifies the packet destination.
+
+
+ address + +
+ string +
+ 		+ +
The destination IP address to match.
+
+
+ any + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match any destination address.
+
+
+ host + +
+ string +
+ 		+ +
The host IP address to match.
+
+
+ port_protocol + +
+ dictionary +
+ 		+ +
Specify the source port or protocol.
+
+
+ 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.
+
+
+ wildcard_bits + +
+ string +
+ 		+ +
The Wildcard bits to apply to destination address.
+
+
+ destopts + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match if destination opts header is present.
+
+
+ dscp + +
+ dictionary +
+ 		+ +
Match packets with given DSCP value.
+
+
+ eq + +
+ string +
+ 		+ +
Match only packets on a given dscp value
+
+
+ gt + +
+ string +
+ 		+ +
Match only packets with a greater dscp value
+
+
+ lt + +
+ string +
+ 		+ +
Match only packets with a lower dscp value
+
+
+ neq + +
+ string +
+ 		+ +
Match only packets not on a given dscp value
+
+
+ range + +
+ dictionary +
+ 		+ +
Match only packets in the range of dscp values
+
+
+ end + +
+ string +
+ 		+ +
End of the dscp range
+
+
+ start + +
+ string +
+ 		+ +
Start of the dscp range
+
+
+ fragments + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Check non-intial fragments.
+
+
+ grant + +
+ string +
+ 		+
    Choices: +
  • permit
    • +
  • deny
    • +
+ 		+
Forward or drop packets matching the Access Control Entry (ACE).
+
+
+ hop_by_hop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match if hop-by-hop opts header is present.
+
+
+ icmp_off + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable the ICMP message for this entry.
+
+
+ line + +
+ string +
+ 		+ +
An ACE excluding the sequence number.
+
This key is mutually exclusive with all the other attributes except 'sequence'.
+
When used with other attributes, the value of this key will get precedence and the other keys will be ignored.
+
This should only be used when an attribute doesn't exist in the argspec but is valid for the device.
+
For fact gathering, any ACE that is not fully parsed, will show up as a value of this attribute, excluding the sequence number, which will be populated as value of the sequence key.
+

aliases: ace
+
+
+ log + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable log matches against this entry.
+
+
+ log_input + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable log matches against this entry, including input interface.
+
+
+ packet_length + +
+ dictionary +
+ 		+ +
Match packets given packet length.
+
+
+ eq + +
+ integer +
+ 		+ +
Match only packets on a given packet length
+
+
+ gt + +
+ integer +
+ 		+ +
Match only packets with a greater packet length
+
+
+ lt + +
+ integer +
+ 		+ +
Match only packets with a lower packet length
+
+
+ neq + +
+ integer +
+ 		+ +
Match only packets not on a given packet length
+
+
+ range + +
+ dictionary +
+ 		+ +
Match only packets in the range of packet lengths
+
+
+ end + +
+ integer +
+ 		+ +
End of the packet length range
+
+
+ start + +
+ integer +
+ 		+ +
Start of the packet length range
+
+
+ precedence + +
+ string +
+ 		+ +
Match packets with given precedence value
+
+
+ protocol + +
+ string +
+ 		+ +
Specify the protocol to match.
+
Refer to vendor documentation for valid values.
+
+
+ protocol_options + +
+ dictionary +
+ 		+ +
Additional suboptions for the protocol.
+
+
+ icmp + +
+ dictionary +
+ 		+ +
Internet Control Message Protocol settings.
+
+
+ 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
+
+
+ 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
+
+
+ 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 exceededs
+
+
+ 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 +
+ 		+ +
Internet Control Message Protocol settings for IPv6.
+
+
+ address_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Address Unreachable
+
+
+ administratively_prohibited + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively Prohibited
+
+
+ beyond_scope_of_source_address + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively Prohibited
+
+
+ destination_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Destination Unreachable
+
+
+ echo + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo
+
+
+ echo_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Echo Reply
+
+
+ erroneous_header_field + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Erroneous Header Field
+
+
+ group_membership_query + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Group Membership Query
+
+
+ group_membership_report + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Group Membership Report
+
+
+ group_membership_termination + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Group Membership Termination
+
+
+ host_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Host Unreachable
+
+
+ nd_na + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor Discovery - Neighbor Advertisement
+
+
+ nd_ns + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor Discovery - Neighbor Solicitation
+
+
+ neighbor_redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor Redirect
+
+
+ no_route_to_destination + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
No Route To Destination
+
+
+ node_information_request_is_refused + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Node Information Request Is Refused
+
+
+ node_information_successful_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Node Information Successful Reply
+
+
+ packet_too_big + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Packet Too Big
+
+
+ parameter_problem + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Parameter Problem
+
+
+ port_unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Port Unreachable
+
+
+ query_subject_is_domainname + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Query Subject Is Domain name
+
+
+ query_subject_is_IPv4address + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Query Subject Is IPv4 address
+
+
+ query_subject_is_IPv6address + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Query Subject Is IPv6 address
+
+
+ reassembly_timeout + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Reassembly Timeout
+
+
+ redirect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Redirect
+
+
+ router_advertisement + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router Advertisement
+
+
+ router_renumbering + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router Renumbering
+
+
+ router_solicitation + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Router Solicitation
+
+
+ rr_command + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
RR Command
+
+
+ rr_result + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
RR Result
+
+
+ rr_seqnum_reset + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
RR Seqnum Reset
+
+
+ time_exceeded + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Time Exceeded
+
+
+ ttl_exceeded + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
TTL Exceeded
+
+
+ unknown_query_type + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Unknown Query Type
+
+
+ unreachable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Unreachable
+
+
+ unrecognized_next_header + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Unrecognized Next Header
+
+
+ unrecognized_option + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Unrecognized Option
+
+
+ whoareyou_reply + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Whoareyou Reply
+
+
+ whoareyou_request + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Whoareyou Request
+
+
+ igmp + +
+ dictionary +
+ 		+ +
Internet Group Management Protocol (IGMP) settings.
+
+
+ dvmrp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match Distance Vector Multicast Routing Protocol
+
+
+ host_query + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match Host Query
+
+
+ host_report + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match Host Report
+
+
+ mtrace + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match mtrace
+
+
+ mtrace_response + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match mtrace response
+
+
+ pim + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match Protocol Independent Multicast
+
+
+ trace + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Multicast trace
+
+
+ tcp + +
+ dictionary +
+ 		+ +
Match TCP packet 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 +
+ 		+ +
Comments or a description for the access list.
+
+
+ routing + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match if routing header is present.
+
+
+ sequence + +
+ integer +
+ 		+ +
Sequence number for the Access Control Entry (ACE).
+
+
+ source + +
+ dictionary +
+ 		+ +
Specifies the packet source.
+
+
+ address + +
+ string +
+ 		+ +
The source IP address to match.
+
+
+ any + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Match any source address.
+
+
+ host + +
+ string +
+ 		+ +
The host IP address to match.
+
+
+ port_protocol + +
+ dictionary +
+ 		+ +
Specify the source port or protocol.
+
+
+ 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.
+
+
+ wildcard_bits + +
+ string +
+ 		+ +
The Wildcard bits to apply to source address.
+
+
+ ttl + +
+ dictionary +
+ 		+ +
Match against specified TTL value.
+
+
+ eq + +
+ integer +
+ 		+ +
Match only packets with exact TTL value.
+
+
+ gt + +
+ integer +
+ 		+ +
Match only packets with a greater TTL value.
+
+
+ lt + +
+ integer +
+ 		+ +
Match only packets with a lower TTL value.
+
+
+ neq + +
+ integer +
+ 		+ +
Match only packets that won't have the given TTL value.
+
+
+ range + +
+ dictionary +
+ 		+ +
Match only packets in the range of given TTL values.
+
+
+ end + +
+ integer +
+ 		+ +
End of the TTL range.
+
+
+ start + +
+ integer +
+ 		+ +
Start of the TTL range.
+
+
+ name + +
+ string +
+ 		+ +
The name of the Access Control List (ACL).
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
The Address Family Indicator (AFI) for the Access Control Lists (ACL).
+
+
+ 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. This value of this option should be the output received from device by executing command show running-config router static.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ 		+
The state the configuration should be left in.
+
+
+ + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged to add new ACLs + + # Before state: + # ------------- + + # RP/0/RP0/CPU0:ios#sh access-lists afi-all + # Thu Feb 20 05:07:45.767 UTC + # RP/0/RP0/CPU0:ios# + + - name: Merge the provided configuration with the exisiting running configuration + cisco.iosxr.iosxr_acls: + config: + - afi: ipv6 + acls: + - name: acl6_1 + aces: + - sequence: 10 + grant: deny + protocol: tcp + source: + prefix: 2001:db8:1234::/48 + port_protocol: + range: + start: ftp + end: telnet + destination: + any: true + protocol_options: + tcp: + syn: true + ttl: + range: + start: 180 + end: 250 + routing: true + authen: true + log: true + + - sequence: 20 + grant: permit + protocol: icmpv6 + source: + any: true + destination: + any: true + protocol_options: + icmpv6: + router_advertisement: true + precedence: network + destopts: true + + - afi: ipv4 + acls: + - name: acl_1 + aces: + - sequence: 16 + remark: TEST_ACL_1_REMARK + + - sequence: 21 + grant: permit + protocol: tcp + source: + host: 192.0.2.10 + port_protocol: + range: + start: pop3 + end: 121 + destination: + address: 198.51.100.0 + wildcard_bits: 0.0.0.15 + protocol_options: + tcp: + rst: true + + - sequence: 23 + grant: deny + protocol: icmp + source: + any: true + destination: + prefix: 198.51.100.0/28 + protocol_options: + icmp: + reassembly_timeout: true + dscp: + lt: af12 + + - name: acl_2 + aces: + - sequence: 10 + remark: TEST_ACL_2_REMARK + state: merged + + # After state: + # ------------- + + # RP/0/RP0/CPU0:ios#sh access-lists afi-all + # Thu Feb 20 05:22:57.021 UTC + # ipv4 access-list acl_1 + # 16 remark TEST_ACL_1_REMARK + # 21 permit tcp host 192.0.2.10 range pop3 121 198.51.100.0 0.0.0.15 rst + # 23 deny icmp any 198.51.100.0 0.0.0.15 reassembly-timeout dscp lt af12 + # ipv4 access-list acl_2 + # 10 remark TEST_ACL_2_REMARK + # ipv6 access-list acl6_1 + # 10 deny tcp 2001:db8:1234::/48 range ftp telnet any syn ttl range 180 250 routing authen log + # 20 permit icmpv6 any any router-advertisement precedence network destopts + + # Using merged to update existing ACLs + + # Before state: + # ------------- + + # RP/0/RP0/CPU0:ios#sh access-lists afi-all + # Thu Feb 20 05:22:57.021 UTC + # ipv4 access-list acl_1 + # 16 remark TEST_ACL_1_REMARK + # 21 permit tcp host 192.0.2.10 range pop3 121 198.51.100.0 0.0.0.15 rst + # 23 deny icmp any 198.51.100.0 0.0.0.15 reassembly-timeout dscp lt af12 + # ipv4 access-list acl_2 + # 10 remark TEST_ACL_2_REMARK + # ipv6 access-list acl6_1 + # 10 deny tcp 2001:db8:1234::/48 range ftp telnet any syn ttl range 180 250 routing authen log + # 20 permit icmpv6 any any router-advertisement precedence network destopts + + - name: Update existing ACEs + cisco.iosxr.iosxr_acls: + config: + - afi: ipv4 + acls: + - name: acl_1 + aces: + - sequence: 21 + source: + prefix: 198.51.100.32/28 + port_protocol: + range: + start: pop3 + end: 121 + protocol_options: + tcp: + syn: true + + - sequence: 23 + protocol_options: + icmp: + router_advertisement: true + dscp: + eq: af23 + + # After state: + # ------------- + + # RP/0/RP0/CPU0:ios#sh access-lists afi-all + # Thu Feb 20 05:47:18.711 UTC + # ipv4 access-list acl_1 + # 16 remark TEST_ACL_1_REMARK + # 21 permit tcp 198.51.100.32 0.0.0.15 range pop3 121 198.51.100.0 0.0.0.15 syn + # 23 deny icmp any 198.51.100.0 0.0.0.15 router-advertisement dscp eq af23 + # ipv4 access-list acl_2 + # 10 remark TEST_ACL_2_REMARK + # ipv6 access-list acl6_1 + # 10 deny tcp 2001:db8:1234::/48 range ftp telnet any syn ttl range 180 250 routing authen log + # 20 permit icmpv6 any any router-advertisement precedence network destopts + + # Using replaced to replace a whole ACL + + # Before state: + # ------------- + + # RP/0/RP0/CPU0:ios#sh access-lists afi-all + # Thu Feb 20 05:22:57.021 UTC + # ipv4 access-list acl_1 + # 16 remark TEST_ACL_1_REMARK + # 21 permit tcp host 192.0.2.10 range pop3 121 198.51.100.0 0.0.0.15 rst + # 23 deny icmp any 198.51.100.0 0.0.0.15 reassembly-timeout dscp lt af12 + # ipv4 access-list acl_2 + # 10 remark TEST_ACL_2_REMARK + # ipv6 access-list acl6_1 + # 10 deny tcp 2001:db8:1234::/48 range ftp telnet any syn ttl range 180 250 routing authen log + # 20 permit icmpv6 any any router-advertisement precedence network destopts + + - name: Replace device configurations of listed ACL with provided configurations + cisco.iosxr.iosxr_acls: + config: + - afi: ipv4 + acls: + - name: acl_2 + aces: + - sequence: 11 + grant: permit + protocol: igmp + source: + host: 198.51.100.130 + destination: + any: true + ttl: + eq: 100 + + - sequence: 12 + grant: deny + source: + any: true + destination: + any: true + protocol: icmp + state: replaced + + # After state: + # ------------- + + # RP/0/RP0/CPU0:ios#sh access-lists afi-all + # Thu Feb 20 06:19:51.496 UTC + # ipv4 access-list acl_1 + # 16 remark TEST_ACL_1_REMARK + # 21 permit tcp 198.51.100.32 0.0.0.15 range pop3 121 198.51.100.0 0.0.0.15 syn + # 23 deny icmp any 198.51.100.0 0.0.0.15 router-advertisement dscp eq af23 + # ipv4 access-list acl_2 + # 11 permit igmp host 198.51.100.130 any ttl eq 100 + # 12 deny icmp any any + # ipv6 access-list acl6_1 + # 10 deny tcp 2001:db8:1234::/48 range ftp telnet any syn ttl range 180 250 routing authen log + # 20 permit icmpv6 any any router-advertisement precedence network destopts + + # Using overridden to override all ACLs in the device + + # Before state: + # ------------- + + # RP/0/RP0/CPU0:ios#sh access-lists afi-all + # Thu Feb 20 05:22:57.021 UTC + # ipv4 access-list acl_1 + # 16 remark TEST_ACL_1_REMARK + # 21 permit tcp host 192.0.2.10 range pop3 121 198.51.100.0 0.0.0.15 rst + # 23 deny icmp any 198.51.100.0 0.0.0.15 reassembly-timeout dscp lt af12 + # ipv4 access-list acl_2 + # 10 remark TEST_ACL_2_REMARK + # ipv6 access-list acl6_1 + # 10 deny tcp 2001:db8:1234::/48 range ftp telnet any syn ttl range 180 250 routing authen log + # 20 permit icmpv6 any any router-advertisement precedence network destopts + + - name: Overridde all ACLs configuration with provided configuration + cisco.iosxr.iosxr_acls: + config: + - afi: ipv4 + acls: + - name: acl_1 + aces: + - sequence: 10 + grant: permit + source: + any: true + destination: + any: true + protocol: tcp + + - name: acl_2 + aces: + - sequence: 20 + grant: permit + source: + any: true + destination: + any: true + protocol: igmp + state: overridden + + # After state: + # ------------- + + # RP/0/RP0/CPU0:ios#sh access-lists afi-all + # Thu Feb 20 06:31:22.178 UTC + # ipv4 access-list acl_1 + # 10 permit tcp any any + # ipv4 access-list acl_2 + # 20 permit igmp any any + + # Using deleted to delete an entire ACL + + # Before state: + # ------------- + + # RP/0/RP0/CPU0:ios#sh access-lists afi-all + # Thu Feb 20 05:22:57.021 UTC + # ipv4 access-list acl_1 + # 16 remark TEST_ACL_1_REMARK + # 21 permit tcp host 192.0.2.10 range pop3 121 198.51.100.0 0.0.0.15 rst + # 23 deny icmp any 198.51.100.0 0.0.0.15 reassembly-timeout dscp lt af12 + # ipv4 access-list acl_2 + # 10 remark TEST_ACL_2_REMARK + # ipv6 access-list acl6_1 + # 10 deny tcp 2001:db8:1234::/48 range ftp telnet any syn ttl range 180 250 routing authen log + # 20 permit icmpv6 any any router-advertisement precedence network destopts + + - name: Delete a single ACL + cisco.iosxr.iosxr_acls: + config: + - afi: ipv6 + acls: + - name: acl6_1 + state: deleted + + # After state: + # ------------- + + # RP/0/RP0/CPU0:ios#sh access-lists afi-all + # Thu Feb 20 05:22:57.021 UTC + # ipv4 access-list acl_1 + # 16 remark TEST_ACL_1_REMARK + # 21 permit tcp host 192.0.2.10 range pop3 121 198.51.100.0 0.0.0.15 rst + # 23 deny icmp any 198.51.100.0 0.0.0.15 reassembly-timeout dscp lt af12 + # ipv4 access-list acl_2 + # 10 remark TEST_ACL_2_REMARK + + # Using deleted to delete all ACLs under one AFI + + # Before state: + # ------------- + + # RP/0/RP0/CPU0:ios#sh access-lists afi-all + # Thu Feb 20 05:22:57.021 UTC + # ipv4 access-list acl_1 + # 16 remark TEST_ACL_1_REMARK + # 21 permit tcp host 192.0.2.10 range pop3 121 198.51.100.0 0.0.0.15 rst + # 23 deny icmp any 198.51.100.0 0.0.0.15 reassembly-timeout dscp lt af12 + # ipv4 access-list acl_2 + # 10 remark TEST_ACL_2_REMARK + # ipv6 access-list acl6_1 + # 10 deny tcp 2001:db8:1234::/48 range ftp telnet any syn ttl range 180 250 routing authen log + # 20 permit icmpv6 any any router-advertisement precedence network destopts + + - name: Delete all ACLs under one AFI + cisco.iosxr.iosxr_acls: + config: + - afi: ipv4 + state: deleted + + # After state: + # ------------- + + # RP/0/RP0/CPU0:ios#sh access-lists afi-all + # Thu Feb 20 05:22:57.021 UTC + # ipv6 access-list acl6_1 + # 10 deny tcp 2001:db8:1234::/48 range ftp telnet any syn ttl range 180 250 routing authen log + # 20 permit icmpv6 any any router-advertisement precedence network destopts + + # Using deleted to delete all ACLs from the device + + # Before state: + # ------------- + + # RP/0/RP0/CPU0:ios#sh access-lists afi-all + # Thu Feb 20 05:22:57.021 UTC + # ipv4 access-list acl_1 + # 16 remark TEST_ACL_1_REMARK + # 21 permit tcp host 192.0.2.10 range pop3 121 198.51.100.0 0.0.0.15 rst + # 23 deny icmp any 198.51.100.0 0.0.0.15 reassembly-timeout dscp lt af12 + # ipv4 access-list acl_2 + # 10 remark TEST_ACL_2_REMARK + # ipv6 access-list acl6_1 + # 10 deny tcp 2001:db8:1234::/48 range ftp telnet any syn ttl range 180 250 routing authen log + # 20 permit icmpv6 any any router-advertisement precedence network destopts + + - name: Delete all ACLs from the device + cisco.iosxr.iosxr_acls: + state: deleted + + # After state: + # ------------- + + # RP/0/RP0/CPU0:ios#sh access-lists afi-all + # Thu Feb 20 05:07:45.767 UTC + # RP/0/RP0/CPU0:ios# + + # Using gathered to gather ACL facts from the device + + - name: Gather ACL interfaces facts using gathered state + cisco.iosxr.iosxr_acls: + state: gathered + + # Task Output (redacted) + # ----------------------- + # + + # "gathered": [ + # { + # "acls": [ + # { + # "aces": [ + # { + # "remark": "TEST_ACL_1_REMARK", + # "sequence": 16 + # }, + # { + # "destination": { + # "address": "198.51.100.0", + # "wildcard_bits": "0.0.0.15" + # }, + # "grant": "permit", + # "protocol": "tcp", + # "protocol_options": { + # "tcp": { + # "rst": true + # } + # }, + # "sequence": 21, + # "source": { + # "host": "192.0.2.10", + # "port_protocol": { + # "range": { + # "end": "121", + # "start": "pop3" + # } + # } + # } + # }, + # { + # "destination": { + # "address": "198.51.100.0", + # "wildcard_bits": "0.0.0.15" + # }, + # "dscp": { + # "lt": "af12" + # }, + # "grant": "deny", + # "protocol": "icmp", + # "protocol_options": { + # "icmp": { + # "reassembly_timeout": true + # } + # }, + # "sequence": 23, + # "source": { + # "any": true + # } + # } + # ], + # "name": "acl_1" + # }, + # { + # "aces": [ + # { + # "remark": "TEST_ACL_2_REMARK", + # "sequence": 10 + # } + # ], + # "name": "acl_2" + # } + # ], + # "afi": "ipv4" + # }, + # { + # "acls": [ + # { + # "aces": [ + # { + # "authen": true, + # "destination": { + # "any": true + # }, + # "grant": "deny", + # "log": true, + # "protocol": "tcp", + # "protocol_options": { + # "tcp": { + # "syn": true + # } + # }, + # "routing": true, + # "sequence": 10, + # "source": { + # "port_protocol": { + # "range": { + # "end": "telnet", + # "start": "ftp" + # } + # }, + # "prefix": "2001:db8:1234::/48" + # }, + # "ttl": { + # "range": { + # "end": 250, + # "start": 180 + # } + # } + # }, + # { + # "destination": { + # "any": true + # }, + # "destopts": true, + # "grant": "permit", + # "precedence": "network", + # "protocol": "icmpv6", + # "protocol_options": { + # "icmpv6": { + # "router_advertisement": true + # } + # }, + # "sequence": 20, + # "source": { + # "any": true + # } + # } + # ], + # "name": "acl6_1" + # } + # ], + # "afi": "ipv6" + # } + # ] + + # Using rendered + + - name: Render platform specific commands (without connecting to the device) + cisco.iosxr.iosxr_acls: + config: + - afi: ipv4 + acls: + - name: acl_2 + aces: + - sequence: 11 + grant: permit + protocol: igmp + source: + host: 198.51.100.130 + destination: + any: true + ttl: + eq: 100 + + - sequence: 12 + grant: deny + source: + any: true + destination: + any: true + protocol: icmp + state: rendered + + # Task Output (redacted) + # ----------------------- + + # "rendered": [ + # "ipv4 access-list acl_2", + # "11 permit igmp host 198.51.100.130 any ttl eq 100", + # "12 deny icmp any any" + + # Using parsed + + # parsed.cfg + # ------------ + # + # ipv4 access-list acl_1 + # 10 remark TEST_ACL_2_REMARK + # ipv4 access-list acl_2 + # 11 deny tcp 2001:db8:1234::/48 range ftp telnet any syn ttl range 180 250 authen routing log + # 21 permit icmpv6 any any router-advertisement precedence network packet-length eq 576 destopts + # ipv6 access-list acl6_1 + # 10 deny tcp 2001:db8:1234::/48 range ftp telnet any syn ttl range 180 250 routing authen log + # 20 permit icmpv6 any any router-advertisement precedence network packet-length eq 576 destopts + + - name: Parse externally provided ACL config to agnostic model + cisco.iosxr.iosxr_acls: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task Output (redacted) + # ----------------------- + # "parsed": [ + # { + # "acls": [ + # { + # "aces": [ + # { + # "remark": "TEST_ACL_2_REMARK", + # "sequence": 10 + # } + # ], + # "name": "acl_1" + # }, + # { + # "aces": [ + # { + # "authen": true, + # "destination": { + # "any": true + # }, + # "grant": "deny", + # "log": true, + # "protocol": "tcp", + # "protocol_options": { + # "tcp": { + # "syn": true + # } + # }, + # "routing": true, + # "sequence": 11, + # "source": { + # "port_protocol": { + # "range": { + # "end": "telnet", + # "start": "ftp" + # } + # }, + # "prefix": "2001:db8:1234::/48" + # }, + # "ttl": { + # "range": { + # "end": 250, + # "start": 180 + # } + # } + # }, + # { + # "destination": { + # "any": true + # }, + # "destopts": true, + # "grant": "permit", + # "packet_length": { + # "eq": 576 + # }, + # "precedence": "network", + # "protocol": "icmpv6", + # "protocol_options": { + # "icmpv6": { + # "router_advertisement": true + # } + # }, + # "sequence": 21, + # "source": { + # "any": true + # } + # } + # ], + # "name": "acl_2" + # } + # ], + # "afi": "ipv4" + # }, + # { + # "acls": [ + # { + # "aces": [ + # { + # "authen": true, + # "destination": { + # "any": true + # }, + # "grant": "deny", + # "log": true, + # "protocol": "tcp", + # "protocol_options": { + # "tcp": { + # "syn": true + # } + # }, + # "routing": true, + # "sequence": 10, + # "source": { + # "port_protocol": { + # "range": { + # "end": "telnet", + # "start": "ftp" + # } + # }, + # "prefix": "2001:db8:1234::/48" + # }, + # "ttl": { + # "range": { + # "end": 250, + # "start": 180 + # } + # } + # }, + # { + # "destination": { + # "any": true + # }, + # "destopts": true, + # "grant": "permit", + # "packet_length": { + # "eq": 576 + # }, + # "precedence": "network", + # "protocol": "icmpv6", + # "protocol_options": { + # "icmpv6": { + # "router_advertisement": true + # } + # }, + # "sequence": 20, + # "source": { + # "any": true + # } + # } + # ], + # "name": "acl6_1" + # } + # ], + # "afi": "ipv6" + # } + # ] + + + +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:
+
['ipv6 access-list acl6_1', '10 deny tcp 2001:db8:1234::/48 range ftp telnet any syn ttl range 180 250 authen routing log', '20 permit icmpv6 any any router-advertisement precedence network destopts', 'ipv4 access-list acl_1', '16 remark TEST_ACL_1_REMARK', '21 permit tcp host 192.0.2.10 range pop3 121 198.51.100.0 0.0.0.15 rst', '23 deny icmp any 198.51.100.0 0.0.0.15 reassembly-timeout dscp lt af12']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_banner_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_banner_module.rst new file mode 100644 index 00000000..1790f614 --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_banner_module.rst @@ -0,0 +1,331 @@ +.. _cisco.iosxr.iosxr_banner_module: + + +************************ +cisco.iosxr.iosxr_banner +************************ + +**Manage multiline banners on Cisco IOS XR devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module will configure both exec and motd banners on remote device running Cisco IOS XR. It allows playbooks to add or remove banner text from the running configuration. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- ncclient >= 0.5.3 when using netconf +- lxml >= 4.1.1 when using netconf + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ banner + +
+ string + / required +
+ 		+
    Choices: +
  • login
    • +
  • motd
    • +
+ 		+
Specifies the type of banner to configure on remote device.
+
+
+ provider + +
+ dictionary +
+ 		+ +
Deprecated
+
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
For more information please see the Network Guide.
+
+
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ port + +
+ integer +
+ 		+ +
Specifies the port to use when building the connection to the remote device.
+
+
+ ssh_keyfile + +
+ path +
+ 		+ +
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
+
+
+ timeout + +
+ integer +
+ 		+ +
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
+
+
+ transport + +
+ string +
+ 		+
    Choices: +
  • cli ←
    • +
  • netconf
    • +
+ 		+
Specifies the type of connection based transport.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Existential state of the configuration on the device.
+
+
+ text + +
+ string +
+ 		+ +
Banner text to be configured. Accepts multi line string, without empty lines. When using a multi line string, the first and last characters must be the start and end delimiters for the banner Requires state=present.
+
+
+ + +Notes +----- + +.. note:: + - Tested against IOS XRv 6.1.3. + - This module works with connection ``network_cli`` and ``netconf``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_. + - For more information on using Ansible to manage network devices see 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 login banner + cisco.iosxr.iosxr_banner: + banner: login + text: | + @this is my login banner + that contains a multiline + string@ + state: present + - name: remove the motd banner + cisco.iosxr.iosxr_banner: + banner: motd + state: absent + - name: Configure banner from file + cisco.iosxr.iosxr_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 (empty list when no commands to send) +
The list of configuration mode commands sent to device with transport cli
+
+
Sample:
+
['banner login', '@this is my login banner', 'that contains a multiline', 'string@']
+
+
+ xml + +
+ list +
+ 		always (empty list when no xml rpc to send) +
NetConf rpc xml sent to device with transport netconf
+
+
Sample:
+
['<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0"> <banners xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-infra-infra-cfg"> <banner xc:operation="merge"> <banner-name>motd</banner-name> <banner-text>Ansible banner example</banner-text> </banner> </banners> </config>']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) +- Kedar Kekan (@kedarX) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_bgp_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_bgp_module.rst new file mode 100644 index 00000000..57486f68 --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_bgp_module.rst @@ -0,0 +1,718 @@ +.. _cisco.iosxr.iosxr_bgp_module: + + +********************* +cisco.iosxr.iosxr_bgp +********************* + +**Configure global BGP protocol settings on Cisco IOS-XR** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module provides configuration management of global BGP parameters on devices running Cisco IOS-XR + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
Specifies the BGP related configuration.
+
+
+ address_family + +
+ list + / elements=dictionary +
+ 		+ +
Specifies BGP address family related configurations.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
Type of address family to configure.
+
+
+ networks + +
+ list + / elements=dictionary +
+ 		+ +
Specify networks to announce via BGP.
+
For operation replace, this option is mutually exclusive with root level networks option.
+
+
+ masklen + +
+ integer + / required +
+ 		+ +
Subnet mask length for the network to announce(e.g, 8, 16, 24, etc.).
+
+
+ network + +
+ string + / required +
+ 		+ +
Network ID to announce via BGP.
+

aliases: prefix
+
+
+ route_map + +
+ string +
+ 		+ +
Route map to modify the attributes.
+
+
+ redistribute + +
+ list + / elements=dictionary +
+ 		+ +
Specifies the redistribute information from another routing protocol.
+
+
+ id + +
+ string +
+ 		+ +
Identifier for the routing protocol for configuring redistribute information.
+
Valid for protocols 'ospf', 'eigrp', 'isis' and 'ospfv3'.
+
+
+ metric + +
+ integer +
+ 		+ +
Specifies the metric for redistributed routes.
+
+
+ protocol + +
+ string + / required +
+ 		+
    Choices: +
  • ospf
    • +
  • ospfv3
    • +
  • eigrp
    • +
  • isis
    • +
  • static
    • +
  • connected
    • +
  • lisp
    • +
  • mobile
    • +
  • rip
    • +
  • subscriber
    • +
+ 		+
Specifies the protocol for configuring redistribute information.
+
+
+ route_map + +
+ string +
+ 		+ +
Specifies the route map reference.
+
+
+ safi + +
+ string +
+ 		+
    Choices: +
  • flowspec
    • +
  • unicast ←
    • +
  • multicast
    • +
  • labeled-unicast
    • +
+ 		+
Specifies the type of cast for the address family.
+
+
+ bgp_as + +
+ integer + / required +
+ 		+ +
Specifies the BGP Autonomous System (AS) number to configure on the device.
+
+
+ log_neighbor_changes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable logging neighbor up/down and reset reason.
+
+
+ neighbors + +
+ list + / elements=dictionary +
+ 		+ +
Specifies BGP neighbor related configurations.
+
+
+ advertisement_interval + +
+ integer +
+ 		+ +
Specifies the minimum interval (in seconds) between sending BGP routing updates.
+
The range is from 0 to 600.
+
+
+ description + +
+ string +
+ 		+ +
Neighbor specific description.
+
+
+ ebgp_multihop + +
+ integer +
+ 		+ +
Specifies the maximum hop count for EBGP neighbors not on directly connected networks.
+
The range is from 0 to 255.
+
+
+ enabled + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shutdown or enable a neighbor.
+
+
+ neighbor + +
+ string + / required +
+ 		+ +
Neighbor router address.
+
+
+ password + +
+ string +
+ 		+ +
Password to authenticate the BGP peer connection.
+
+
+ remote_as + +
+ integer + / required +
+ 		+ +
Remote AS of the BGP neighbor to configure.
+
+
+ tcp_mss + +
+ integer +
+ 		+ +
Specifies the TCP initial maximum segment size to use.
+
The range is from 68 to 10000.
+
+
+ timers + +
+ dictionary +
+ 		+ +
Specifies BGP neighbor timer related configurations.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Interval after not receiving a keepalive message that the software declares a peer dead.
+
The range is from 3 to 65535.
+
+
+ keepalive + +
+ integer +
+ 		+ +
Frequency with which the Cisco IOS-XR software sends keepalive messages to its peer.
+
The range is from 0 to 65535.
+
+
+ min_neighbor_holdtime + +
+ integer +
+ 		+ +
Interval specifying the minimum acceptable hold-time from a BGP neighbor.
+
The minimum acceptable hold-time must be less than, or equal to, the interval specified in the holdtime argument.
+
The range is from 3 to 65535.
+
+
+ update_source + +
+ string +
+ 		+ +
Source of the routing updates.
+
+
+ router_id + +
+ string +
+ 		+ +
Configures the BGP routing process router-id value.
+
+
+ operation + +
+ string +
+ 		+
    Choices: +
  • merge ←
    • +
  • replace
    • +
  • override
    • +
  • delete
    • +
+ 		+
Specifies the operation to be performed on the BGP process configured on the device.
+
In case of merge, the input configuration will be merged with the existing BGP configuration on the device.
+
In case of replace, if there is a diff between the existing configuration and the input configuration, the existing configuration will be replaced by the input configuration for every option that has the diff.
+
In case of override, all the existing BGP configuration will be removed from the device and replaced with the input configuration.
+
In case of delete the existing BGP configuration will be removed from the device.
+
+
+ + +Notes +----- + +.. note:: + - Tested against Cisco IOS XR Software Version 6.1.3 + - This module works with connection ``network_cli``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_. + + + +Examples +-------- + +.. code-block:: yaml + + - name: configure global bgp as 65000 + cisco.iosxr.iosxr_bgp: + bgp_as: 65000 + router_id: 1.1.1.1 + neighbors: + - neighbor: 182.168.10.1 + remote_as: 500 + description: PEER_1 + - neighbor: 192.168.20.1 + remote_as: 500 + update_source: GigabitEthernet 0/0/0/0 + address_family: + - name: ipv4 + cast: unicast + networks: + - network: 192.168.2.0/23 + - network: 10.0.0.0/8 + redistribute: + - protocol: ospf + id: 400 + metric: 110 + + - name: remove bgp as 65000 from config + ios_bgp: + bgp_as: 65000 + 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 +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['router bgp 65000', 'bgp router-id 1.1.1.1', 'neighbor 182.168.10.1 remote-as 500', 'neighbor 182.168.10.1 description PEER_1', 'neighbor 192.168.20.1 remote-as 500', 'neighbor 192.168.20.1 update-source GigabitEthernet0/0/0/0', 'address-family ipv4 unicast', 'redistribute ospf 400 metric 110', 'network 192.168.2.0/23', 'network 10.0.0.0/8', 'exit']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_cliconf.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_cliconf.rst new file mode 100644 index 00000000..9f5dab9b --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_cliconf.rst @@ -0,0 +1,43 @@ +.. _cisco.iosxr.iosxr_cliconf: + + +***************** +cisco.iosxr.iosxr +***************** + +**Use iosxr cliconf to run command on Cisco IOS XR platform** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This iosxr plugin provides low level abstraction apis for sending and receiving CLI commands from Cisco IOS XR network devices. + + + + + + + + + + + +Status +------ + + +Authors +~~~~~~~ + +- Ansible Networking Team + + +.. hint:: + Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_command_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_command_module.rst new file mode 100644 index 00000000..679e3b4d --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_command_module.rst @@ -0,0 +1,382 @@ +.. _cisco.iosxr.iosxr_command_module: + + +************************* +cisco.iosxr.iosxr_command +************************* + +**Run commands on remote devices running Cisco IOS XR** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Sends arbitrary commands to an IOS XR 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. +- This module does not support running commands in configuration mode. Please use :ref:`iosxr_config ` to configure iosxr devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ commands + +
+ list + / elements=raw + / required +
+ 		+ +
List of commands to send to the remote iosxr device over the configured provider. 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 retries has expired.
+
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 conditions, the interval indicates how 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.
+
+
+ provider + +
+ dictionary +
+ 		+ +
Deprecated
+
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
For more information please see the Network Guide.
+
+
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ port + +
+ integer +
+ 		+ +
Specifies the port to use when building the connection to the remote device.
+
+
+ ssh_keyfile + +
+ path +
+ 		+ +
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
+
+
+ timeout + +
+ integer +
+ 		+ +
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
+
+
+ transport + +
+ string +
+ 		+
    Choices: +
  • cli ←
    • +
  • netconf
    • +
+ 		+
Specifies the type of connection based transport.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ retries + +
+ integer +
+ 		+ Default:
10
+ 		+
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 conditions.
+
+
+ wait_for + +
+ list + / elements=string +
+ 		+ +
List of conditions to evaluate against the output of the command. The task will wait for each condition to be true before moving forward. If the conditional is not true within the configured number of retries, the task fails. See examples.
+

aliases: waitfor
+
+
+ + +Notes +----- + +.. note:: + - Make sure the user has been authorized to execute commands terminal length 0, terminal width 512 and terminal exec prompt no-timestamp. + - This module works with ``network_cli``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_. + - This module does not support ``netconf`` connection. + - Tested against IOS XR 6.1.3 + - For more information on using Ansible to manage network devices see 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.iosxr.iosxr_command: + commands: show version + + - name: run show version and check to see if output contains iosxr + cisco.iosxr.iosxr_command: + commands: show version + wait_for: result[0] contains IOS-XR + + - name: run multiple commands on remote nodes + cisco.iosxr.iosxr_command: + commands: + - show version + - show interfaces + - {command: example command that prompts, prompt: expected prompt, answer: yes} + + - name: run multiple commands and evaluate the output + cisco.iosxr.iosxr_command: + commands: + - show version + - show interfaces + wait_for: + - result[0] contains IOS-XR + - result[1] contains Loopback0 + + + +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 +~~~~~~~ + +- Ricardo Carrillo Cruz (@rcarrillocruz) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_config_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_config_module.rst new file mode 100644 index 00000000..85523490 --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_config_module.rst @@ -0,0 +1,649 @@ +.. _cisco.iosxr.iosxr_config_module: + + +************************ +cisco.iosxr.iosxr_config +************************ + +**Manage Cisco IOS XR configuration sections** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Cisco IOS XR configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with IOS XR configuration sections in a deterministic way. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ admin + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Enters into administration configuration mode for making config changes to the device.
+
+
+ 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 yes, if backup is set to no 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 first 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.
+
+
+ comment + +
+ string +
+ 		+ Default:
"configured by iosxr_config"
+ 		+
Allows a commit description to be specified to be included when the configuration is committed. If the configuration is not changed or committed, this argument is ignored.
+
+
+ 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 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 to ensure idempotency and correct diff.
+
+
+ exclusive + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Enters into exclusive configuration mode that locks out all users from committing configuration changes until the exclusive session ends.
+
+
+ force + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
The force argument instructs the module to not consider the current devices running-config. When set to true, this will cause the module to push the contents of src into the device without first checking if already configured.
+
Note this argument should be considered deprecated. To achieve the equivalent, set the match=none which is idempotent. This argument will be removed in a future release.
+
+
+ label + +
+ string +
+ 		+ +
Allows a commit label to be specified to be included when the configuration is committed. A valid label must begin with an alphabet and not exceed 30 characters, only alphabets, digits, hyphens and underscores are allowed. If the configuration is not changed or committed, this argument is ignored.
+
+
+ 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 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.
+
+
+ provider + +
+ dictionary +
+ 		+ +
Deprecated
+
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
For more information please see the Network Guide.
+
+
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ port + +
+ integer +
+ 		+ +
Specifies the port to use when building the connection to the remote device.
+
+
+ ssh_keyfile + +
+ path +
+ 		+ +
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
+
+
+ timeout + +
+ integer +
+ 		+ +
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
+
+
+ transport + +
+ string +
+ 		+
    Choices: +
  • cli ←
    • +
  • netconf
    • +
+ 		+
Specifies the type of connection based transport.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ 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.
+
+
+ src + +
+ path +
+ 		+ +
Specifies the source path to the file that contains the configuration or configuration template to load. The path to the source file can either be the full path on the Ansible control host or a relative path from the playbook or role root directory. This argument is mutually exclusive with lines, parents. The configuration lines in the source file should be similar to how it will appear if present in the running-configuration of the device to ensure idempotency and correct diff.
+
+
+ + +Notes +----- + +.. note:: + - This module works with connection ``network_cli``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_. + - Tested against IOS XRv 6.1.3. + - This module does not support ``netconf`` connection + - Abbreviated commands are NOT idempotent, see L(Network FAQ,../network/user_guide/faq.html + - Avoid service disrupting changes (viz. Management IP) from config replace. + - Do not use ``end`` in the replace config file. + - 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 more information on using Ansible to manage network devices see 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 + cisco.iosxr.iosxr_config: + lines: hostname {{ inventory_hostname }} + + - name: configure interface settings + cisco.iosxr.iosxr_config: + lines: + - description test interface + - ip address 172.31.1.1 255.255.255.0 + parents: interface GigabitEthernet0/0/0/0 + + - name: load a config from disk and replace the current config + cisco.iosxr.iosxr_config: + src: config.cfg + replace: config + backup: yes + + - name: for idempotency, use full-form commands + cisco.iosxr.iosxr_config: + lines: + # - shut + - shutdown + # parents: int g0/0/0/1 + parents: interface GigabitEthernet0/0/0/1 + + - name: configurable backup path + cisco.iosxr.iosxr_config: + src: config.cfg + backup: yes + 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/iosxr01_config.2016-07-16@22:28:34
+
+
+ commands + +
+ list +
+ 		If there are commands to run against the host +
The set of commands that will be pushed to the remote device
+
+
Sample:
+
['hostname foo', 'router ospf 1', 'router-id 1.1.1.1']
+
+
+ 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:
+
iosxr01_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/iosxr01_config
+
+
+ time + +
+ string +
+ 		when backup is yes +
The time extracted from the backup file name
+
+
Sample:
+
22:28:34
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Ricardo Carrillo Cruz (@rcarrillocruz) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_facts_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_facts_module.rst new file mode 100644 index 00000000..be3701fc --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_facts_module.rst @@ -0,0 +1,533 @@ +.. _cisco.iosxr.iosxr_facts_module: + + +*********************** +cisco.iosxr.iosxr_facts +*********************** + +**Get facts about iosxr devices.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Collects facts from network devices running the iosxr operating system. This module places the facts gathered in the fact tree keyed by the respective resource name. 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
+
+ gather_network_resources + +
+ list + / elements=string +
+ 		+ +
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all and the resources like interfaces, lacp etc. 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', 'lacp', 'lacp_interfaces', 'lldp_global', 'lldp_interfaces', 'interfaces', 'l2_interfaces', 'l3_interfaces', 'lag_interfaces', 'acls', 'acl_interfaces', 'static_routes', 'ospfv2'.
+
+
+ gather_subset + +
+ list + / elements=string +
+ 		+ Default:
"!config"
+ 		+
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, hardware, config, and interfaces. 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.
+
+
+ provider + +
+ dictionary +
+ 		+ +
Deprecated
+
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
For more information please see the Network Guide.
+
+
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ port + +
+ integer +
+ 		+ +
Specifies the port to use when building the connection to the remote device.
+
+
+ ssh_keyfile + +
+ path +
+ 		+ +
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
+
+
+ timeout + +
+ integer +
+ 		+ +
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
+
+
+ transport + +
+ string +
+ 		+
    Choices: +
  • cli ←
    • +
  • netconf
    • +
+ 		+
Specifies the type of connection based transport.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ + +Notes +----- + +.. note:: + - Tested against IOS-XR 6.1.3. + - This module works with connection ``network_cli``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_. + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. + + + +Examples +-------- + +.. code-block:: yaml + + # Gather all facts + - cisco.iosxr.iosxr_facts: + gather_subset: all + gather_network_resources: all + + # Collect only the config and default facts + - cisco.iosxr.iosxr_facts: + gather_subset: + - config + + # Do not collect hardware facts + - cisco.iosxr.iosxr_facts: + gather_subset: + - '!hardware' + + # Collect only the lacp facts + - cisco.iosxr.iosxr_facts: + gather_subset: + - '!all' + - '!min' + gather_network_resources: + - lacp + + # Do not collect lacp_interfaces facts + - cisco.iosxr.iosxr_facts: + gather_network_resources: + - '!lacp_interfaces' + + # Collect lacp and minimal default facts + - cisco.iosxr.iosxr_facts: + gather_subset: min + gather_network_resources: lacp + + # Collect only the interfaces facts + - cisco.iosxr.iosxr_facts: + gather_subset: + - '!all' + - '!min' + gather_network_resources: + - interfaces + - l2_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 +
+ 		always +
The list of fact 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_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 neighbors from the remote device
+
+
+
+ ansible_net_python_version + +
+ string +
+ 		always +
The Python version Ansible controller is using
+
+
+
+ ansible_net_version + +
+ string +
+ 		always +
The operating system version running on the remote device
+
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Ricardo Carrillo Cruz (@rcarrillocruz) +- Nilashish Chakraborty (@Nilashishc) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_interface_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_interface_module.rst new file mode 100644 index 00000000..977e369c --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_interface_module.rst @@ -0,0 +1,748 @@ +.. _cisco.iosxr.iosxr_interface_module: + + +*************************** +cisco.iosxr.iosxr_interface +*************************** + +**(deprecated, removed after 2022-06-01) Manage Interface on Cisco IOS XR network devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + +DEPRECATED +---------- +:Removed in collection release after 2022-06-01 +:Why: Newer and updated modules released with more functionality in Ansible 2.9 +:Alternative: iosxr_interfaces + + + +Synopsis +-------- +- This module provides declarative management of Interfaces on Cisco IOS XR network devices. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- ncclient >= 0.5.3 when using netconf +- lxml >= 4.1.1 when using netconf + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ active + +
+ string +
+ 		+
    Choices: +
  • active ←
    • +
  • preconfigure
    • +
+ 		+
Whether the interface is active or preconfigured. Preconfiguration allows you to configure modular services cards before they are inserted into the router. When the cards are inserted, they are instantly configured. Active cards are the ones already inserted.
+
+
+ aggregate + +
+ list + / elements=dictionary +
+ 		+ +
List of interfaces definition
+
+
+ active + +
+ string +
+ 		+
    Choices: +
  • active
    • +
  • preconfigure
    • +
+ 		+
Whether the interface is active or preconfigured. Preconfiguration allows you to configure modular services cards before they are inserted into the router. When the cards are inserted, they are instantly configured. Active cards are the ones already inserted.
+
+
+ delay + +
+ integer +
+ 		+ +
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values up/down, tx_rate and rx_rate.
+
+
+ description + +
+ string +
+ 		+ +
Description of Interface being configured.
+
+
+ duplex + +
+ string +
+ 		+
    Choices: +
  • full
    • +
  • half
    • +
+ 		+
Configures the interface duplex mode. Default is auto-negotiation when not configured.
+
+
+ enabled + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Removes the shutdown configuration, which removes the forced administrative down on the interface, enabling it to move to an up or down state.
+
+
+ mtu + +
+ string +
+ 		+ +
Sets the MTU value for the interface. Range is between 64 and 65535'
+
+
+ name + +
+ string +
+ 		+ +
Name of the interface to configure in type + path format. e.g. GigabitEthernet0/0/0/0
+
+
+ rx_rate + +
+ string +
+ 		+ +
Receiver rate in bits per second (bps).
+
This is state check parameter only.
+
Supports conditionals, see Conditionals in Networking Modules
+
+
+ speed + +
+ string +
+ 		+
    Choices: +
  • 10
    • +
  • 100
    • +
  • 1000
    • +
+ 		+
Configure the speed for an interface. Default is auto-negotiation when not configured.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
  • up
    • +
  • down
    • +
+ 		+
State of the Interface configuration, up means present and operationally up and down means present and operationally down
+
+
+ tx_rate + +
+ string +
+ 		+ +
Transmit rate in bits per second (bps).
+
This is state check parameter only.
+
Supports conditionals, see Conditionals in Networking Modules
+
+
+ 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 argument which are state with values up/down, tx_rate and rx_rate.
+
+
+ description + +
+ string +
+ 		+ +
Description of Interface being configured.
+
+
+ duplex + +
+ string +
+ 		+
    Choices: +
  • full
    • +
  • half
    • +
+ 		+
Configures the interface duplex mode. Default is auto-negotiation when not configured.
+
+
+ enabled + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
Removes the shutdown configuration, which removes the forced administrative down on the interface, enabling it to move to an up or down state.
+
+
+ mtu + +
+ string +
+ 		+ +
Sets the MTU value for the interface. Range is between 64 and 65535'
+
+
+ name + +
+ string + / required +
+ 		+ +
Name of the interface to configure in type + path format. e.g. GigabitEthernet0/0/0/0
+
+
+ provider + +
+ dictionary +
+ 		+ +
Deprecated
+
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
For more information please see the Network Guide.
+
+
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ port + +
+ integer +
+ 		+ +
Specifies the port to use when building the connection to the remote device.
+
+
+ ssh_keyfile + +
+ path +
+ 		+ +
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
+
+
+ timeout + +
+ integer +
+ 		+ +
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
+
+
+ transport + +
+ string +
+ 		+
    Choices: +
  • cli ←
    • +
  • netconf
    • +
+ 		+
Specifies the type of connection based transport.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ rx_rate + +
+ string +
+ 		+ +
Receiver rate in bits per second (bps).
+
This is state check parameter only.
+
Supports conditionals, see Conditionals in Networking Modules
+
+
+ speed + +
+ string +
+ 		+
    Choices: +
  • 10
    • +
  • 100
    • +
  • 1000
    • +
+ 		+
Configure the speed for an interface. Default is auto-negotiation when not configured.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
  • up
    • +
  • down
    • +
+ 		+
State of the Interface configuration, up means present and operationally up and down means present and operationally down
+
+
+ tx_rate + +
+ string +
+ 		+ +
Transmit rate in bits per second (bps).
+
This is state check parameter only.
+
Supports conditionals, see Conditionals in Networking Modules
+
+
+ + +Notes +----- + +.. note:: + - This module works with connection ``network_cli`` and ``netconf``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_. + - Tested against IOS XRv 6.1.3. + - Preconfiguration of physical interfaces is not supported with ``netconf`` transport. + - For more information on using Ansible to manage network devices see 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 interface + cisco.iosxr.iosxr_interface: + name: GigabitEthernet0/0/0/2 + description: test-interface + speed: 100 + duplex: half + mtu: 512 + + - name: remove interface + cisco.iosxr.iosxr_interface: + name: GigabitEthernet0/0/0/2 + state: absent + + - name: make interface up + cisco.iosxr.iosxr_interface: + name: GigabitEthernet0/0/0/2 + enabled: true + + - name: make interface down + cisco.iosxr.iosxr_interface: + name: GigabitEthernet0/0/0/2 + enabled: false + + - name: Create interface using aggregate + cisco.iosxr.iosxr_interface: + aggregate: + - name: GigabitEthernet0/0/0/3 + - name: GigabitEthernet0/0/0/2 + speed: 100 + duplex: full + mtu: 512 + state: present + + - name: Create interface using aggregate along with additional params in aggregate + cisco.iosxr.iosxr_interface: + aggregate: + - {name: GigabitEthernet0/0/0/3, description: test-interface 3} + - {name: GigabitEthernet0/0/0/2, description: test-interface 2} + speed: 100 + duplex: full + mtu: 512 + state: present + + - name: Delete interface using aggregate + cisco.iosxr.iosxr_interface: + aggregate: + - name: GigabitEthernet0/0/0/3 + - name: GigabitEthernet0/0/0/2 + state: absent + + - name: Check intent arguments + cisco.iosxr.iosxr_interface: + name: GigabitEthernet0/0/0/5 + state: up + delay: 20 + + - name: Config + intent + cisco.iosxr.iosxr_interface: + name: GigabitEthernet0/0/0/5 + enabled: false + state: down + delay: 20 + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always (empty list when no commands to send) +
The list of configuration mode commands sent to device with transport cli
+
+
Sample:
+
['interface GigabitEthernet0/0/0/2', 'description test-interface', 'duplex half', 'mtu 512']
+
+
+ xml + +
+ list +
+ 		always (empty list when no xml rpc to send) +
NetConf rpc xml sent to device with transport netconf
+
+
Sample:
+
['<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0"> <interface-configurations xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg"> <interface-configuration xc:operation="merge"> <active>act</active> <interface-name>GigabitEthernet0/0/0/0</interface-name> <description>test-interface-0</description> <mtus><mtu> <owner>GigabitEthernet</owner> <mtu>512</mtu> </mtu></mtus> <ethernet xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-drivers-media-eth-cfg"> <speed>100</speed> <duplex>half</duplex> </ethernet> </interface-configuration> </interface-configurations></config>']
+
+

+ + +Status +------ + + +- This module will be removed in version . *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Ganesh Nalawade (@ganeshrn) +- Kedar Kekan (@kedarX) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_interfaces_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_interfaces_module.rst new file mode 100644 index 00000000..6afcf871 --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_interfaces_module.rst @@ -0,0 +1,697 @@ +.. _cisco.iosxr.iosxr_interfaces_module: + + +**************************** +cisco.iosxr.iosxr_interfaces +**************************** + +**Interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages the interface attributes on Cisco IOS-XR network devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary of interface options
+
+
+ description + +
+ string +
+ 		+ +
Interface description.
+
+
+ duplex + +
+ string +
+ 		+
    Choices: +
  • full
    • +
  • half
    • +
+ 		+
Configures the interface duplex mode. Default is auto-negotiation when not configured.
+
+
+ enabled + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
Administrative state of the interface.
+
Set the value to True to administratively enable the interface or False to disable it.
+
+
+ mtu + +
+ integer +
+ 		+ +
Sets the MTU value for the interface. Applicable for Ethernet interfaces only.
+
Refer to vendor documentation for valid values.
+
+
+ name + +
+ string + / required +
+ 		+ +
Full name of the interface to configure in type + path format. e.g. GigabitEthernet0/0/0/0
+
+
+ speed + +
+ integer +
+ 		+ +
Configure the speed for an interface. Default is auto-negotiation when not configured.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the IOS-XR device by executing the command show running-config 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 ←
    • +
  • parsed
    • +
  • deleted
    • +
  • replaced
    • +
  • rendered
    • +
  • gathered
    • +
  • overridden
    • +
+ 		+
The state of the configuration after module completion
+
+
+ + +Notes +----- + +.. note:: + - Tested against Cisco IOS-XRv Version 6.1.3 on VIRL. + - This module works with connection ``network_cli``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + # Before state: + # ------------- + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/1 + # shutdown + # ! + # interface GigabitEthernet0/0/0/2 + # vrf custB + # ipv4 address 178.18.169.23 255.255.255.0 + # dot1q native vlan 30 + # ! + # interface GigabitEthernet0/0/0/3 + # description Replaced by Ansible Team + # mtu 2000 + # vrf custB + # ipv4 address 10.10.0.2 255.255.255.0 + # dot1q native vlan 1021 + # ! + - name: Configure Ethernet interfaces + cisco.iosxr.iosxr_interfaces: + config: + - name: GigabitEthernet0/0/0/2 + description: Configured by Ansible + enabled: true + - name: GigabitEthernet0/0/0/3 + description: Configured by Ansible Network + enabled: false + duplex: full + state: merged + # After state: + # ------------ + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/1 + # shutdown + # ! + # interface GigabitEthernet0/0/0/2 + # description Configured and Merged by Ansible Network + # vrf custB + # ipv4 address 178.18.169.23 255.255.255.0 + # dot1q native vlan 30 + # ! + # interface GigabitEthernet0/0/0/3 + # description Configured and Merged by Ansible Network + # mtu 2600 + # vrf custB + # ipv4 address 10.10.0.2 255.255.255.0 + # duplex full + # shutdown + # dot1q native vlan 1021 + # ! + # Using replaced + # Before state: + # ------------ + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/1 + # description Configured by Ansible + # shutdown + # ! + # interface GigabitEthernet0/0/0/2 + # description Test + # vrf custB + # ipv4 address 178.18.169.23 255.255.255.0 + # dot1q native vlan 30 + # ! + # interface GigabitEthernet0/0/0/3 + # vrf custB + # ipv4 address 10.10.0.2 255.255.255.0 + # dot1q native vlan 1021 + # ! + - name: Configure following interfaces and replace their existing config + cisco.iosxr.iosxr_interfaces: + config: + - name: GigabitEthernet0/0/0/2 + description: Configured by Ansible + enabled: true + mtu: 2000 + - name: GigabitEthernet0/0/0/3 + description: Configured by Ansible Network + enabled: false + duplex: auto + state: replaced + # After state: + # ------------ + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/1 + # description Configured by Ansible + # shutdown + # ! + # interface GigabitEthernet0/0/0/2 + # description Configured and Replaced by Ansible + # mtu 2000 + # vrf custB + # ipv4 address 178.18.169.23 255.255.255.0 + # dot1q native vlan 30 + # ! + # interface GigabitEthernet0/0/0/3 + # description Configured and Replaced by Ansible Network + # vrf custB + # ipv4 address 10.10.0.2 255.255.255.0 + # duplex half + # shutdown + # dot1q native vlan 1021 + # ! + # Using overridden + # Before state: + # ------------ + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/1 + # shutdown + # ! + # interface GigabitEthernet0/0/0/2 + # description Configured by Ansible + # vrf custB + # ipv4 address 178.18.169.23 255.255.255.0 + # dot1q native vlan 30 + # ! + # interface GigabitEthernet0/0/0/3 + # description Configured by Ansible + # mtu 2600 + # vrf custB + # ipv4 address 10.10.0.2 255.255.255.0 + # duplex full + # shutdown + # dot1q native vlan 1021 + # ! + - name: Override interfaces + cisco.iosxr.iosxr_interfaces: + config: + - name: GigabitEthernet0/0/0/2 + description: Configured by Ansible + enabled: true + duplex: auto + - name: GigabitEthernet0/0/0/3 + description: Configured by Ansible Network + enabled: false + speed: 1000 + state: overridden + # After state: + # ------------ + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/1 + # shutdown + # ! + # interface GigabitEthernet0/0/0/2 + # description Configured and Overridden by Ansible Network + # vrf custB + # ipv4 address 178.18.169.23 255.255.255.0 + # speed 1000 + # dot1q native vlan 30 + # ! + # interface GigabitEthernet0/0/0/3 + # description Configured and Overridden by Ansible Network + # mtu 2000 + # vrf custB + # ipv4 address 10.10.0.2 255.255.255.0 + # duplex full + # shutdown + # dot1q native vlan 1021 + # ! + # Using deleted + # Before state: + # ------------ + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/1 + # shutdown + # ! + # interface GigabitEthernet0/0/0/2 + # description Configured and Overridden by Ansible Network + # vrf custB + # ipv4 address 178.18.169.23 255.255.255.0 + # speed 1000 + # dot1q native vlan 30 + # ! + # interface GigabitEthernet0/0/0/3 + # description Configured and Overridden by Ansible Network + # mtu 2000 + # vrf custB + # ipv4 address 10.10.0.2 255.255.255.0 + # duplex full + # shutdown + # dot1q native vlan 1021 + # ! + - name: Delete IOSXR interfaces as in given arguments + cisco.iosxr.iosxr_interfaces: + config: + - name: GigabitEthernet0/0/0/2 + - name: GigabitEthernet0/0/0/3 + state: deleted + # After state: + # ------------ + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/1 + # shutdown + # ! + # interface GigabitEthernet0/0/0/2 + # vrf custB + # ipv4 address 178.18.169.23 255.255.255.0 + # dot1q native vlan 30 + # ! + # interface GigabitEthernet0/0/0/3 + # vrf custB + # ipv4 address 10.10.0.2 255.255.255.0 + # dot1q native vlan 1021 + # ! + # Using parsed + # parsed.cfg + # ------------ + # + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 10.8.38.70 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/0 + # description Configured and Merged by Ansible-Network + # mtu 110 + # ipv4 address 172.31.1.1 255.255.255.0 + # duplex half + # ! + # interface GigabitEthernet0/0/0/3 + # shutdown + # ! + # interface GigabitEthernet0/0/0/4 + # shutdown + # ! + # - name: Convert ACL interfaces config to argspec without connecting to the appliance + # cisco.iosxr.iosxr_interfaces: + # running_config: "{{ lookup('file', './parsed.cfg') }}" + # state: parsed + # Task Output (redacted) + # ----------------------- + # "parsed": [ + # { + # "name": "MgmtEth0/RP0/CPU0/0" + # }, + # { + # "access_groups": [ + # { + # "acls": [ + # { + # "direction": "in", + # "name": "acl_1" + # }, + # { + # "direction": "out", + # "name": "acl_2" + # } + # ], + # "afi": "ipv4" + # }, + # { + # "acls": [ + # { + # "direction": "in", + # "name": "acl6_1" + # }, + # { + # "direction": "out", + # "name": "acl6_2" + # } + # ], + # "afi": "ipv6" + # } + # ], + # "name": "GigabitEthernet0/0/0/0" + # }, + # { + # "access_groups": [ + # { + # "acls": [ + # { + # "direction": "out", + # "name": "acl_1" + # } + # ], + # "afi": "ipv4" + # } + # ], + # "name": "GigabitEthernet0/0/0/1" + # } + # ] + # } + # Using rendered + - name: Render platform specific commands from task input using rendered state + cisco.iosxr.iosxr_interfaces: + config: + - name: GigabitEthernet0/0/0/0 + description: Configured and Merged by Ansible-Network + mtu: 110 + enabled: true + duplex: half + - name: GigabitEthernet0/0/0/1 + description: Configured and Merged by Ansible-Network + mtu: 2800 + enabled: false + speed: 100 + duplex: full + state: rendered + # Task Output (redacted) + # ----------------------- + # "rendered": [ + # "interface GigabitEthernet0/0/0/0", + # "description Configured and Merged by Ansible-Network", + # "mtu 110", + # "duplex half", + # "no shutdown", + # "interface GigabitEthernet0/0/0/1", + # "description Configured and Merged by Ansible-Network", + # "mtu 2800", + # "speed 100", + # "duplex full", + # "shutdown" + # ] + # Using gathered + # Before state: + # ------------ + # + # RP/0/0/CPU0:an-iosxr-02#show running-config interface + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 10.8.38.70 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/0 + # description Configured and Merged by Ansible-Network + # mtu 110 + # ipv4 address 172.31.1.1 255.255.255.0 + # duplex half + # ! + # interface GigabitEthernet0/0/0/3 + # shutdown + # ! + # interface GigabitEthernet0/0/0/4 + # shutdown + # ! + - name: Gather IOSXR interfaces as in given arguments + cisco.iosxr.iosxr_interfaces: + config: + state: gathered + # Task Output (redacted) + # ----------------------- + # + # "gathered": [ + # { + # "description": "test for ansible", + # "enabled": false, + # "name": "Loopback888" + # }, + # { + # "description": "Configured and Merged by Ansible-Network", + # "duplex": "half", + # "enabled": true, + # "mtu": 110, + # "name": "GigabitEthernet0/0/0/0" + # }, + # { + # "enabled": false, + # "name": "GigabitEthernet0/0/0/3" + # }, + # { + # "enabled": false, + # "name": "GigabitEthernet0/0/0/4" + # } + # ] + # After state: + # ------------ + # + # RP/0/0/CPU0:an-iosxr-02#show running-config interface + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 10.8.38.70 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/0 + # description Configured and Merged by Ansible-Network + # mtu 110 + # ipv4 address 172.31.1.1 255.255.255.0 + # duplex half + # ! + # interface GigabitEthernet0/0/0/3 + # shutdown + # ! + # interface GigabitEthernet0/0/0/4 + # shutdown + # ! + + + +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 GigabitEthernet0/0/0/2', 'description: Configured by Ansible', 'shutdown']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Sumit Jaiswal (@justjais) +- Rohit Thakur (@rohitthakur2590) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_l2_interfaces_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_l2_interfaces_module.rst new file mode 100644 index 00000000..e9d2bd66 --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_l2_interfaces_module.rst @@ -0,0 +1,879 @@ +.. _cisco.iosxr.iosxr_l2_interfaces_module: + + +******************************* +cisco.iosxr.iosxr_l2_interfaces +******************************* + +**L2 interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages the Layer-2 interface attributes on Cisco IOS-XR devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary of Layer-2 interface options
+
+
+ l2protocol + +
+ list + / elements=dictionary +
+ 		+ +
Configures Layer 2 protocol tunneling and protocol data unit (PDU) filtering on an interface.
+
+
+ cdp + +
+ string +
+ 		+
    Choices: +
  • drop
    • +
  • forward
    • +
  • tunnel
    • +
+ 		+
Cisco Discovery Protocol (CDP) tunneling and data unit parameters.
+
+
+ pvst + +
+ string +
+ 		+
    Choices: +
  • drop
    • +
  • forward
    • +
  • tunnel
    • +
+ 		+
Configures the per-VLAN Spanning Tree Protocol (PVST) tunneling and data unit parameters.
+
+
+ stp + +
+ string +
+ 		+
    Choices: +
  • drop
    • +
  • forward
    • +
  • tunnel
    • +
+ 		+
Spanning Tree Protocol (STP) tunneling and data unit parameters.
+
+
+ vtp + +
+ string +
+ 		+
    Choices: +
  • drop
    • +
  • forward
    • +
  • tunnel
    • +
+ 		+
VLAN Trunk Protocol (VTP) tunneling and data unit parameters.
+
+
+ l2transport + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Switchport mode access command to configure the interface as a layer 2 access
+
+
+ name + +
+ string + / required +
+ 		+ +
Full name of the interface/sub-interface excluding any logical unit number, e.g. GigabitEthernet0/0/0/1 or GigabitEthernet0/0/0/1.100.
+
+
+ native_vlan + +
+ integer +
+ 		+ +
Configure a native VLAN ID for the trunk
+
+
+ propagate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Propagate Layer 2 transport events. Note that it will work only when the l2tranport option is set to TRUE
+
+
+ q_vlan + +
+ list + / elements=integer +
+ 		+ +
802.1Q VLAN configuration. Note that it can accept either 2 VLAN IDs when configuring Q-in-Q VLAN, or it will accept 1 VLAN ID and 'any' as input list when configuring Q-in-any vlan as input. Note, that this option is valid only with respect to Sub-Interface and is not valid when configuring for Interface.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the IOS-XR device by executing the command show running-config 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
    • +
  • rendered
    • +
  • gathered
    • +
  • parsed
    • +
+ 		+
The state of the configuration after module completion
+
+
+ + +Notes +----- + +.. note:: + - Tested against Cisco IOS-XRv Version 6.1.3 on VIRL. + - This module works with connection ``network_cli``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + # + # Before state: + # ------------- + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/3 + # description Ansible Network + # vrf custB + # ipv4 address 10.10.0.2 255.255.255.0 + # duplex half + # shutdown + # ! + # interface GigabitEthernet0/0/0/4 + # description Test description + # ! + + - name: Merge provided configuration with device configuration + cisco.iosxr.iosxr_l2_interfaces: + config: + - name: GigabitEthernet0/0/0/3 + native_vlan: 20 + - name: GigabitEthernet0/0/0/4 + native_vlan: 40 + l2transport: true + l2protocol: + - stp: tunnel + - name: GigabitEthernet0/0/0/3.900 + l2transport: true + q_vlan: + - 20 + - 40 + state: merged + + # After state: + # ------------ + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/3 + # description Ansible Network + # vrf custB + # ipv4 address 10.10.0.2 255.255.255.0 + # duplex half + # shutdown + # dot1q native vlan 20 + # ! + # interface GigabitEthernet0/0/0/4 + # description Test description + # dot1q native vlan 10 + # l2transport + # l2protocol stp tunnel + # ! + # ! + # interface GigabitEthernet0/0/0/3.900 l2transport + # dot1q vlan 20 40 + # ! + + # Using replaced + # + # Before state: + # ------------- + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/3 + # description Ansible Network + # vrf custB + # ipv4 address 10.10.0.2 255.255.255.0 + # duplex half + # shutdown + # dot1q native vlan 20 + # ! + # interface GigabitEthernet0/0/0/4 + # description Test description + # dot1q native vlan 10 + # l2transport + # l2protocol stp tunnel + # ! + # ! + # interface GigabitEthernet0/0/0/3.900 l2transport + # dot1q vlan 20 40 + # ! + + - name: Replaces device configuration of listed interfaces with provided configuration + cisco.iosxr.iosxr_l2_interfaces: + config: + - name: GigabitEthernet0/0/0/4 + native_vlan: 40 + l2transport: true + l2protocol: + - stp: forward + - name: GigabitEthernet0/0/0/3.900 + q_vlan: + - 20 + - any + state: replaced + + # After state: + # ------------- + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/3 + # description Ansible Network + # vrf custB + # ipv4 address 10.10.0.2 255.255.255.0 + # duplex half + # shutdown + # dot1q native vlan 20 + # ! + # interface GigabitEthernet0/0/0/4 + # description Test description + # dot1q native vlan 40 + # l2transport + # l2protocol stp forward + # ! + # ! + # interface GigabitEthernet0/0/0/3.900 l2transport + # dot1q vlan 20 any + # ! + + # Using overridden + # + # Before state: + # ------------- + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/3 + # description Ansible Network + # vrf custB + # ipv4 address 10.10.0.2 255.255.255.0 + # duplex half + # shutdown + # dot1q native vlan 20 + # ! + # interface GigabitEthernet0/0/0/4 + # description Test description + # dot1q native vlan 10 + # l2transport + # l2protocol stp tunnel + # ! + # ! + # interface GigabitEthernet0/0/0/3.900 l2transport + # dot1q vlan 20 40 + # ! + + - name: Override device configuration of all interfaces with provided configuration + cisco.iosxr.iosxr_l2_interfaces: + config: + - name: GigabitEthernet0/0/0/4 + native_vlan: 40 + l2transport: true + l2protocol: + - stp: forward + - name: GigabitEthernet0/0/0/3.900 + q_vlan: + - 20 + - any + state: overridden + + # After state: + # ------------- + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/3 + # description Ansible Network + # vrf custB + # ipv4 address 10.10.0.2 255.255.255.0 + # duplex half + # shutdown + # ! + # interface GigabitEthernet0/0/0/4 + # description Test description + # dot1q native vlan 40 + # l2transport + # l2protocol stp forward + # ! + # ! + # interface GigabitEthernet0/0/0/3.900 + # dot1q vlan 20 any + # ! + + # Using deleted + # + # Before state: + # ------------- + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/3 + # description Ansible Network + # vrf custB + # ipv4 address 10.10.0.2 255.255.255.0 + # duplex half + # shutdown + # dot1q native vlan 20 + # ! + # interface GigabitEthernet0/0/0/4 + # description Test description + # dot1q native vlan 10 + # l2transport + # l2protocol stp tunnel + # ! + # ! + # + + - name: "Delete L2 attributes of given interfaces (Note: This won't delete the interface itself)" + cisco.iosxr.iosxr_l2_interfaces: + config: + - name: GigabitEthernet0/0/0/4 + state: deleted + + # After state: + # ------------ + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/3 + # description Ansible Network + # vrf custB + # ipv4 address 10.10.0.2 255.255.255.0 + # duplex half + # shutdown + # dot1q native vlan 20 + # ! + # interface GigabitEthernet0/0/0/4 + # description Test description + # ! + + # Using Deleted without any config passed + # "(NOTE: This will delete all of configured resource module attributes from each configured interface)" + # + # Before state: + # ------------- + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/3 + # description Ansible Network + # vrf custB + # ipv4 address 10.10.0.2 255.255.255.0 + # duplex half + # shutdown + # dot1q native vlan 20 + # ! + # interface GigabitEthernet0/0/0/4 + # description Test description + # dot1q native vlan 10 + # l2transport + # l2protocol stp tunnel + # ! + # ! + + - name: "Delete L2 attributes of all interfaces (Note: This won't delete the interface itself)" + cisco.iosxr.iosxr_l2_interfaces: + state: deleted + + # After state: + # ------------ + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/3 + # description Ansible Network + # vrf custB + # ipv4 address 10.10.0.2 255.255.255.0 + # duplex half + # shutdown + # ! + # interface GigabitEthernet0/0/0/4 + # description Test description + # ! + + + # Using parsed + # parsed.cfg + # ------------ + # + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 10.8.38.70 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/0 + # description Configured and Merged by Ansible-Network + # mtu 110 + # ipv4 address 172.31.1.1 255.255.255.0 + # duplex half + # ! + # interface GigabitEthernet0/0/0/1 + # dot1q native vlan 10 + # l2transport + # l2protocol cdp forward + # l2protocol pvst tunnel + # propagate remote-status + # ! + # ! + # interface GigabitEthernet0/0/0/3 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3.900 + # encapsulation dot1q 20 second-dot1q 40 + # ! + # interface GigabitEthernet0/0/0/4 + # shutdown + # dot1q native vlan 40 + # ! + - name: Convert L2 interfaces config to argspec without connecting to the appliance + cisco.iosxr.iosxr_l2_interfaces: + running_config: "{{ lookup('file', './parsed.cfg') }}" + state: parsed + # Task Output (redacted) + # ----------------------- + # "parsed": [ + # { + # "name": "GigabitEthernet0/0/0/0" + # }, + # { + # "l2protocol": [ + # { + # "cdp": "forward" + # }, + # { + # "pvst": "tunnel" + # } + # ], + # "l2transport": true, + # "name": "GigabitEthernet0/0/0/1", + # "native_vlan": 10, + # "propagate": true + # }, + # { + # "name": "GigabitEthernet0/0/0/3" + # }, + # { + # "name": "GigabitEthernet0/0/0/3.900", + # "q_vlan": [ + # 20, + # 40 + # ] + # }, + # { + # "name": "GigabitEthernet0/0/0/4", + # "native_vlan": 40 + # } + # ] + + + # Using rendered + - name: Render platform specific commands from task input using rendered state + cisco.iosxr.iosxr_l2_interfaces: + config: + + - name: GigabitEthernet0/0/0/1 + native_vlan: 10 + l2transport: true + l2protocol: + + - pvst: tunnel + + - cdp: forward + propagate: true + + - name: GigabitEthernet0/0/0/3.900 + q_vlan: + - 20 + - 40 + + - name: GigabitEthernet0/0/0/4 + native_vlan: 40 + state: rendered + # Task Output (redacted) + # ----------------------- + # "rendered": [ + # "interface GigabitEthernet0/0/0/1", + # "dot1q native vlan 10", + # "l2transport l2protocol pvst tunnel", + # "l2transport l2protocol cdp forward", + # "l2transport propagate remote-status", + # "interface GigabitEthernet0/0/0/3.900", + # "dot1q vlan 20 40", + # "interface GigabitEthernet0/0/0/4", + # "dot1q native vlan 40" + # ] + + + # Using gathered + # Before state: + # ------------ + # + # RP/0/0/CPU0:an-iosxr-02#show running-config interface + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 10.8.38.70 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/0 + # description Configured and Merged by Ansible-Network + # mtu 110 + # ipv4 address 172.31.1.1 255.255.255.0 + # duplex half + # ! + # interface GigabitEthernet0/0/0/1 + # dot1q native vlan 10 + # l2transport + # l2protocol cdp forward + # l2protocol pvst tunnel + # propagate remote-status + # ! + # ! + # interface GigabitEthernet0/0/0/3 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3.900 + # encapsulation dot1q 20 second-dot1q 40 + # ! + # interface GigabitEthernet0/0/0/4 + # shutdown + # dot1q native vlan 40 + # ! + - name: Gather IOSXR l2 interfaces as in given arguments + cisco.iosxr.iosxr_l2_interfaces: + config: + state: gathered + # Task Output (redacted) + # ----------------------- + # + # "gathered": [ + # { + # "name": "GigabitEthernet0/0/0/0" + # }, + # { + # "l2protocol": [ + # { + # "cdp": "forward" + # }, + # { + # "pvst": "tunnel" + # } + # ], + # "l2transport": true, + # "name": "GigabitEthernet0/0/0/1", + # "native_vlan": 10, + # "propagate": true + # }, + # { + # "name": "GigabitEthernet0/0/0/3" + # }, + # { + # "name": "GigabitEthernet0/0/0/3.900", + # "q_vlan": [ + # 20, + # 40 + # ] + # }, + # { + # "name": "GigabitEthernet0/0/0/4", + # "native_vlan": 40 + # } + # ] + # After state: + # ------------ + # + # RP/0/0/CPU0:an-iosxr-02#show running-config interface + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 10.8.38.70 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/0 + # description Configured and Merged by Ansible-Network + # mtu 110 + # ipv4 address 172.31.1.1 255.255.255.0 + # duplex half + # ! + # interface GigabitEthernet0/0/0/1 + # dot1q native vlan 10 + # l2transport + # l2protocol cdp forward + # l2protocol pvst tunnel + # propagate remote-status + # ! + # ! + # interface GigabitEthernet0/0/0/3 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3.900 + # encapsulation dot1q 20 second-dot1q 40 + # ! + # interface GigabitEthernet0/0/0/4 + # shutdown + # dot1q native vlan 40 + # ! + + + +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 GigabitEthernet0/0/0/2', 'l2transport l2protocol pvst tunnel']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Sumit Jaiswal (@justjais) +- Rohit Thakur (@rohitthakur2590) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_l3_interfaces_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_l3_interfaces_module.rst new file mode 100644 index 00000000..a13faf8d --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_l3_interfaces_module.rst @@ -0,0 +1,803 @@ +.. _cisco.iosxr.iosxr_l3_interfaces_module: + + +******************************* +cisco.iosxr.iosxr_l3_interfaces +******************************* + +**L3 interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module provides declarative management of Layer-3 interface on Cisco IOS-XR devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary of Layer-3 interface options
+
+
+ ipv4 + +
+ list + / elements=dictionary +
+ 		+ +
IPv4 address to be set for the Layer-3 interface mentioned in name option.
+
The address format is <ipv4 address>/<mask>, the mask is number in range 0-32 eg. 192.168.0.1/24
+
+
+ address + +
+ string +
+ 		+ +
Configures the IPv4 address for Interface.
+
+
+ secondary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configures the IP address as a secondary address.
+
+
+ ipv6 + +
+ list + / elements=dictionary +
+ 		+ +
IPv6 address to be set for the Layer-3 interface mentioned in name option.
+
The address format is <ipv6 address>/<mask>, the mask is number in range 0-128 eg. fd5d:12c9:2201:1::1/64
+
+
+ address + +
+ string +
+ 		+ +
Configures the IPv6 address for Interface.
+
+
+ name + +
+ string + / required +
+ 		+ +
Full name of the interface excluding any logical unit number, i.e. GigabitEthernet0/1.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the IOS-XR device by executing the command show running-config 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
    • +
  • parsed
    • +
  • rendered
    • +
  • gathered
    • +
+ 		+
The state of the configuration after module completion
+
+
+ + +Notes +----- + +.. note:: + - Tested against Cisco IOS-XRv Version 6.1.3 on VIRL. + - This module works with connection ``network_cli``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/1 + # shutdown + # ! + # interface GigabitEthernet0/0/0/2 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3 + # ipv4 address 192.168.0.2 255.255.255.0 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3.700 + # ! + # interface GigabitEthernet0/0/0/4 + # ipv6 address fd5d:12c9:2201:1::1/64 + # shutdown + # ! + + - name: Merge provided configuration with device configuration + cisco.iosxr.iosxr_l3_interfaces: + config: + - name: GigabitEthernet0/0/0/2 + ipv4: + - address: 192.168.0.1/24 + - name: GigabitEthernet0/0/0/3 + ipv4: + - address: 192.168.2.1/24 + secondary: true + state: merged + + # After state: + # ------------ + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/1 + # shutdown + # ! + # interface GigabitEthernet0/0/0/2 + # ipv4 address 192.168.0.1 255.255.255.0 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3 + # ipv4 address 192.168.1.0 255.255.255.0 + # ipv4 address 192.168.2.1 255.255.255.0 secondary + # shutdown + # ! + # interface GigabitEthernet0/0/0/3.700 + # ! + # interface GigabitEthernet0/0/0/4 + # ipv6 address fd5d:12c9:2201:1::1/64 + # shutdown + # ! + + # Using overridden + + # Before state: + # ------------- + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/1 + # shutdown + # ! + # interface GigabitEthernet0/0/0/2 + # ipv4 address 192.168.0.1 255.255.255.0 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3 + # ipv4 address 192.168.1.0 255.255.255.0 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3.700 + # ! + # interface GigabitEthernet0/0/0/4 + # ipv6 address fd5d:12c9:2201:1::1/64 + # shutdown + # ! + + - name: Override device configuration of all interfaces with provided configuration + cisco.iosxr.iosxr_l3_interfaces: + config: + - name: GigabitEthernet0/0/0/3 + ipv4: + - address: 192.168.0.1/24 + - name: GigabitEthernet0/0/0/3.700 + ipv4: + - address: 192.168.0.2/24 + - address: 192.168.2.1/24 + secondary: true + state: overridden + + # After state: + # ------------- + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/1 + # shutdown + # ! + # interface GigabitEthernet0/0/0/2 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3 + # ipv4 address 192.168.0.1 255.255.255.0 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3.700 + # ipv4 address 192.168.0.2 255.255.255.0 + # ipv4 address 192.168.2.1 255.255.255.0 secondary + # ! + # interface GigabitEthernet0/0/0/4 + # shutdown + # ! + + # Using replaced + + # Before state: + # ------------- + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/1 + # shutdown + # ! + # interface GigabitEthernet0/0/0/2 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3 + # ipv4 address 192.168.0.2 255.255.255.0 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3.700 + # ipv4 address 192.168.0.1 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/4 + # ipv6 address fd5d:12c9:2201:1::1/64 + # shutdown + # ! + + - name: Replaces device configuration of listed interfaces with provided configuration + cisco.iosxr.iosxr_l3_interfaces: + config: + - name: GigabitEthernet0/0/0/3 + ipv6: + - address: fd5d:12c9:2201:1::1/64 + - name: GigabitEthernet0/0/0/4 + ipv4: + - address: 192.168.0.2/24 + state: replaced + + # After state: + # ------------- + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/1 + # shutdown + # ! + # interface GigabitEthernet0/0/0/2 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3 + # ipv6 address fd5d:12c9:2201:1::1/64 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3.700 + # ipv4 address 192.168.0.1 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/4 + # ipv4 address 192.168.0.2 255.255.255.0 + # shutdown + # ! + + # Using deleted + + # Before state: + # ------------- + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/1 + # ipv4 address 192.168.2.1 255.255.255.0 + # shutdown + # ! + # interface GigabitEthernet0/0/0/2 + # ipv4 address 192.168.3.1 255.255.255.0 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3 + # ipv4 address 192.168.0.2 255.255.255.0 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3.700 + # ipv4 address 192.168.0.1 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/4 + # ipv6 address fd5d:12c9:2201:1::1/64 + # shutdown + # ! + + - name: "Delete L3 attributes of given interfaces (Note: This won't delete the interface itself)" + cisco.iosxr.iosxr_l3_interfaces: + config: + - name: GigabitEthernet0/0/0/3 + - name: GigabitEthernet0/0/0/4 + - name: GigabitEthernet0/0/0/3.700 + state: deleted + + # After state: + # ------------- + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/1 + # ipv4 address 192.168.2.1 255.255.255.0 + # shutdown + # ! + # interface GigabitEthernet0/0/0/2 + # ipv4 address 192.168.3.1 255.255.255.0 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3.700 + # ! + # interface GigabitEthernet0/0/0/4 + # shutdown + # ! + + # Using Deleted without any config passed + # "(NOTE: This will delete all of configured resource module attributes from each configured interface)" + + # Before state: + # ------------- + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/1 + # ipv4 address 192.168.2.1 255.255.255.0 + # shutdown + # ! + # interface GigabitEthernet0/0/0/2 + # ipv4 address 192.168.3.1 255.255.255.0 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3 + # ipv4 address 192.168.0.2 255.255.255.0 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3.700 + # ipv4 address 192.168.0.1 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/4 + # ipv6 address fd5d:12c9:2201:1::1/64 + # shutdown + # ! + + + - name: "Delete L3 attributes of all interfaces (Note: This won't delete the interface itself)" + cisco.iosxr.iosxr_l3_interfaces: + state: deleted + + # After state: + # ------------- + # + # viosxr#show running-config interface + # interface GigabitEthernet0/0/0/1 + # shutdown + # ! + # interface GigabitEthernet0/0/0/2 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3.700 + # ! + # interface GigabitEthernet0/0/0/4 + # shutdown + # ! + + + # Using parsed + # parsed.cfg + # ------------ + # + # nterface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 10.8.38.70 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/0 + # description Configured and Merged by Ansible-Network + # mtu 66 + # ipv4 address 192.0.2.1 255.255.255.0 + # ipv4 address 192.0.2.2 255.255.255.0 secondary + # ipv6 address 2001:db8:0:3::/64 + # duplex half + # ! + # interface GigabitEthernet0/0/0/1 + # description Configured and Merged by Ansible-Network + # mtu 66 + # speed 100 + # duplex full + # dot1q native vlan 10 + # l2transport + # l2protocol cdp forward + # l2protocol pvst tunnel + # propagate remote-status + # ! + # ! + # interface GigabitEthernet0/0/0/3 + # ipv4 address 192.0.22.1 255.255.255.0 + # ipv4 address 192.0.23.1 255.255.255.0 + # ! + # - name: Convert L3 interfaces config to argspec without connecting to the appliance + # cisco.iosxr.iosxr_l3_interfaces: + # running_config: "{{ lookup('file', './parsed.cfg') }}" + # state: parsed + # Task Output (redacted) + # ----------------------- + # "parsed": [ + # { + # "ipv4": [ + # { + # "address": "192.0.2.1 255.255.255.0" + # }, + # { + # "address": "192.0.2.2 255.255.255.0", + # "secondary": true + # } + # ], + # "ipv6": [ + # { + # "address": "2001:db8:0:3::/64" + # } + # ], + # "name": "GigabitEthernet0/0/0/0" + # }, + # { + # "name": "GigabitEthernet0/0/0/1" + # }, + # { + # "ipv4": [ + # { + # "address": "192.0.22.1 255.255.255.0" + # }, + # { + # "address": "192.0.23.1 255.255.255.0" + # } + # ], + # "name": "GigabitEthernet0/0/0/3" + # } + # ] + + + # Using rendered + - name: Render platform specific commands from task input using rendered state + cisco.iosxr.iosxr_l3_interfaces: + config: + + - name: GigabitEthernet0/0/0/0 + ipv4: + + - address: 198.51.100.1/24 + + - name: GigabitEthernet0/0/0/1 + ipv6: + + - address: 2001:db8:0:3::/64 + ipv4: + + - address: 192.0.2.1/24 + + - address: 192.0.2.2/24 + secondary: true + state: rendered + # Task Output (redacted) + # ----------------------- + # "rendered": [ + # "interface GigabitEthernet0/0/0/0", + # "ipv4 address 198.51.100.1 255.255.255.0", + # "interface GigabitEthernet0/0/0/1", + # "ipv4 address 192.0.2.2 255.255.255.0 secondary", + # "ipv4 address 192.0.2.1 255.255.255.0", + # "ipv6 address 2001:db8:0:3::/64" + # ] + # Using gathered + # Before state: + # ------------ + # + # RP/0/0/CPU0:an-iosxr-02#show running-config interface + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 10.8.38.70 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/0 + # description Configured and Merged by Ansible-Network + # mtu 66 + # ipv4 address 192.0.2.1 255.255.255.0 + # ipv4 address 192.0.2.2 255.255.255.0 secondary + # ipv6 address 2001:db8:0:3::/64 + # duplex half + # ! + # interface GigabitEthernet0/0/0/1 + # description Configured and Merged by Ansible-Network + # mtu 66 + # speed 100 + # duplex full + # dot1q native vlan 10 + # l2transport + # l2protocol cdp forward + # l2protocol pvst tunnel + # propagate remote-status + # ! + # ! + # interface GigabitEthernet0/0/0/3 + # shutdown + # ! + # interface GigabitEthernet0/0/0/4 + # shutdown + # dot1q native vlan 40 + # ! + - name: Gather IOSXR l3 interfaces as in given arguments + cisco.iosxr.iosxr_l3_interfaces: + config: + state: gathered + # Task Output (redacted) + # ----------------------- + # + # "gathered": [ + # { + # "name": "Loopback888" + # }, + # { + # "ipv4": [ + # { + # "address": "192.0.2.1 255.255.255.0" + # }, + # { + # "address": "192.0.2.2 255.255.255.0", + # "secondary": true + # } + # ], + # "ipv6": [ + # { + # "address": "2001:db8:0:3::/64" + # } + # ], + # "name": "GigabitEthernet0/0/0/0" + # }, + # { + # "name": "GigabitEthernet0/0/0/1" + # }, + # { + # "name": "GigabitEthernet0/0/0/3" + # }, + # { + # "name": "GigabitEthernet0/0/0/4" + # } + # ] + # After state: + # ------------ + # + # RP/0/0/CPU0:an-iosxr-02#show running-config interface + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 10.8.38.70 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/0 + # description Configured and Merged by Ansible-Network + # mtu 66 + # ipv4 address 192.0.2.1 255.255.255.0 + # ipv4 address 192.0.2.2 255.255.255.0 secondary + # ipv6 address 2001:db8:0:3::/64 + # duplex half + # ! + # interface GigabitEthernet0/0/0/1 + # description Configured and Merged by Ansible-Network + # mtu 66 + # speed 100 + # duplex full + # dot1q native vlan 10 + # l2transport + # l2protocol cdp forward + # l2protocol pvst tunnel + # propagate remote-status + # ! + # ! + # interface GigabitEthernet0/0/0/3 + # shutdown + # ! + # interface GigabitEthernet0/0/0/4 + # shutdown + # dot1q native vlan 40 + # ! + + + +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 GigabitEthernet0/0/0/1', 'ipv4 address 192.168.0.1 255.255.255.0']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Sumit Jaiswal (@justjais) +- Rohit Thakur (@rohitthakur2590) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_lacp_interfaces_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_lacp_interfaces_module.rst new file mode 100644 index 00000000..badc6eb8 --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_lacp_interfaces_module.rst @@ -0,0 +1,802 @@ +.. _cisco.iosxr.iosxr_lacp_interfaces_module: + + +********************************* +cisco.iosxr.iosxr_lacp_interfaces +********************************* + +**LACP interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages Link Aggregation Control Protocol (LACP) attributes of interfaces on IOS-XR devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary of LACP interfaces options.
+
+
+ churn_logging + +
+ string +
+ 		+
    Choices: +
  • actor
    • +
  • partner
    • +
  • both
    • +
+ 		+
Specifies the parameter for logging of LACP churn events.
+
Valid only for ether-bundles.
+
Mode 'actor' logs actor churn events only.
+
Mode 'partner' logs partner churn events only.
+
Mode 'both' logs actor and partner churn events only.
+
+
+ collector_max_delay + +
+ integer +
+ 		+ +
Specifies the collector max delay to be signaled to the LACP partner.
+
Valid only for ether-bundles.
+
Refer to vendor documentation for valid values.
+
+
+ name + +
+ string +
+ 		+ +
Name/Identifier of the interface or Ether-Bundle.
+
+
+ period + +
+ integer +
+ 		+ +
Specifies the rate at which packets are sent or received.
+
For ether-bundles, this specifies the period to be used by its member links.
+
Refer to vendor documentation for valid values.
+
+
+ switchover_suppress_flaps + +
+ integer +
+ 		+ +
Specifies the time for which to suppress flaps during a LACP switchover.
+
Valid only for ether-bundles.
+
Refer to vendor documentation for valid values.
+
+
+ system + +
+ dictionary +
+ 		+ +
This dict object contains configurable options related to LACP system parameters for ether-bundles.
+
+
+ mac + +
+ string +
+ 		+ +
Specifies the system ID to use in LACP negotiations for the bundle, encoded as a MAC address.
+
+
+ priority + +
+ integer +
+ 		+ +
Specifies the system priority to use in LACP negotiations for the bundle.
+
Refer to vendor documentation for valid values.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the IOS-XR device by executing the command show running-config int.
+
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 of the configuration after module completion.
+
+
+ + +Notes +----- + +.. note:: + - Tested against IOS-XR 6.1.3. + - This module works with connection ``network_cli``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + # + # + # ------------ + # Before state + # ------------ + # + # + # + # RP/0/0/CPU0:an-iosxr#sh running-config interface + # Sun Jul 21 18:01:35.079 UTC + # interface Bundle-Ether10 + # ! + # interface Bundle-Ether11 + # ! + # interface Bundle-Ether12 + # ! + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 192.0.2.11 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/1 + # description 'GigabitEthernet - 1' + # ! + # interface GigabitEthernet0/0/0/2 + # description "GigabitEthernet - 2" + # ! + # interface GigabitEthernet0/0/0/3 + # description "GigabitEthernet - 3" + # ! + # interface GigabitEthernet0/0/0/4 + # description "GigabitEthernet - 4" + # ! + # + # + + - name: Merge provided configuration with device configuration + cisco.iosxr.iosxr_lacp_interfaces: + config: + - name: Bundle-Ether10 + churn_logging: actor + collector_max_delay: 100 + switchover_suppress_flaps: 500 + + - name: Bundle-Ether11 + system: + mac: 00c2.4c00.bd15 + + - name: GigabitEthernet0/0/0/1 + period: 200 + state: merged + + # + # + # ----------- + # After state + # ----------- + # + # + # RP/0/0/CPU0:an-iosxr#sh run int + # Sun Jul 21 18:24:52.413 UTC + # interface Bundle-Ether10 + # lacp churn logging actor + # lacp switchover suppress-flaps 500 + # lacp collector-max-delay 100 + # ! + # interface Bundle-Ether11 + # lacp system mac 00c2.4c00.bd15 + # ! + # interface Bundle-Ether12 + # ! + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 192.0.2.11 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/1 + # description 'GigabitEthernet - 1" + # lacp period 200 + # ! + # interface GigabitEthernet0/0/0/2 + # description "GigabitEthernet - 2" + # ! + # interface GigabitEthernet0/0/0/3 + # description "GigabitEthernet - 3" + # ! + # interface GigabitEthernet0/0/0/4 + # description "GigabitEthernet - 4" + # ! + # + + + # Using replaced + # + # + # ------------ + # Before state + # ------------ + # + # + # RP/0/0/CPU0:an-iosxr#sh run int + # Sun Jul 21 18:24:52.413 UTC + # interface Bundle-Ether10 + # lacp churn logging actor + # lacp switchover suppress-flaps 500 + # lacp collector-max-delay 100 + # ! + # interface Bundle-Ether11 + # lacp system mac 00c2.4c00.bd15 + # ! + # interface Bundle-Ether12 + # ! + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 192.0.2.11 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/1 + # description 'GigabitEthernet - 1" + # lacp period 200 + # ! + # interface GigabitEthernet0/0/0/2 + # description "GigabitEthernet - 2" + # ! + # interface GigabitEthernet0/0/0/3 + # description "GigabitEthernet - 3" + # ! + # interface GigabitEthernet0/0/0/4 + # description "GigabitEthernet - 4" + # ! + # + + - name: Replace LACP configuration of listed interfaces with provided configuration + cisco.iosxr.iosxr_lacp_interfaces: + config: + - name: Bundle-Ether10 + churn_logging: partner + + - name: GigabitEthernet0/0/0/2 + period: 300 + state: replaced + + # + # + # ----------- + # After state + # ----------- + # + # + # RP/0/0/CPU0:an-iosxr#sh run int + # Sun Jul 21 18:50:21.929 UTC + # interface Bundle-Ether10 + # lacp churn logging partner + # ! + # interface Bundle-Ether11 + # lacp system mac 00c2.4c00.bd15 + # ! + # interface Bundle-Ether12 + # ! + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 192.0.2.11 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/1 + # description 'GigabitEthernet - 1" + # lacp period 200 + # ! + # interface GigabitEthernet0/0/0/2 + # description "GigabitEthernet - 2" + # lacp period 300 + # ! + # interface GigabitEthernet0/0/0/3 + # description "GigabitEthernet - 3" + # ! + # interface GigabitEthernet0/0/0/4 + # description "GigabitEthernet - 4" + # ! + # + # + + + # Using overridden + # + # + # ------------ + # Before state + # ------------ + # + # + # RP/0/0/CPU0:an-iosxr#sh run int + # Sun Jul 21 18:24:52.413 UTC + # interface Bundle-Ether10 + # lacp churn logging actor + # lacp switchover suppress-flaps 500 + # lacp collector-max-delay 100 + # ! + # interface Bundle-Ether11 + # lacp system mac 00c2.4c00.bd15 + # ! + # interface Bundle-Ether12 + # ! + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 192.0.2.11 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/1 + # description 'GigabitEthernet - 1" + # lacp period 200 + # ! + # interface GigabitEthernet0/0/0/2 + # description "GigabitEthernet - 2" + # lacp period 200 + # ! + # interface GigabitEthernet0/0/0/3 + # description "GigabitEthernet - 3" + # ! + # interface GigabitEthernet0/0/0/4 + # description "GigabitEthernet - 4" + # ! + # + # + + - name: Override all interface LACP configuration with provided configuration + cisco.iosxr.iosxr_lacp_interfaces: + config: + - name: Bundle-Ether12 + churn_logging: both + collector_max_delay: 100 + switchover_suppress_flaps: 500 + + - name: GigabitEthernet0/0/0/1 + period: 300 + state: overridden + + # + # + # ----------- + # After state + # ----------- + # + # + # RP/0/0/CPU0:an-iosxr(config-if)#do sh run int + # Sun Jul 21 19:32:36.115 UTC + # interface Bundle-Ether10 + # ! + # interface Bundle-Ether11 + # ! + # interface Bundle-Ether12 + # lacp churn logging both + # lacp switchover suppress-flaps 500 + # lacp collector-max-delay 100 + # ! + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 192.0.2.11 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/1 + # description 'GigabitEthernet - 1" + # lacp period 300 + # ! + # interface GigabitEthernet0/0/0/2 + # description "GigabitEthernet - 2" + # ! + # interface GigabitEthernet0/0/0/3 + # description "GigabitEthernet - 3" + # ! + # interface GigabitEthernet0/0/0/4 + # description "GigabitEthernet - 4" + # ! + # + + + # Using deleted + # + # + # ------------ + # Before state + # ------------ + # + # + # RP/0/0/CPU0:an-iosxr#sh run int + # Sun Jul 21 18:24:52.413 UTC + # interface Bundle-Ether10 + # lacp churn logging actor + # lacp switchover suppress-flaps 500 + # lacp collector-max-delay 100 + # ! + # interface Bundle-Ether11 + # lacp non-revertive + # ! + # interface Bundle-Ether12 + # ! + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 192.0.2.11 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/1 + # description 'GigabitEthernet - 1" + # lacp period 200 + # ! + # interface GigabitEthernet0/0/0/2 + # description "GigabitEthernet - 2" + # lacp period 300 + # ! + # interface GigabitEthernet0/0/0/3 + # description "GigabitEthernet - 3" + # ! + # interface GigabitEthernet0/0/0/4 + # description "GigabitEthernet - 4" + # ! + # + + - name: Deleted LACP configurations of provided interfaces (Note - This won't delete + the interface itself) + cisco.iosxr.iosxr_lacp_interfaces: + config: + - name: Bundle-Ether10 + - name: Bundle-Ether11 + - name: GigabitEthernet0/0/0/1 + - name: GigabitEthernet0/0/0/2 + state: deleted + + # + # + # ----------- + # After state + # ----------- + # + # + # Using parsed: + + # parsed.cfg + # interface Bundle-Ether10 + # lacp churn logging actor + # lacp switchover suppress-flaps 500 + # lacp collector-max-delay 100 + # ! + # interface Bundle-Ether11 + # lacp system mac 00c2.4c00.bd15 + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 192.0.2.11 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/1 + # lacp period 200 + # ! + # + + - name: Convert lacp interfaces config to argspec without connecting to the appliance + cisco.iosxr.iosxr_lacp_interfaces: + running_config: "{{ lookup('file', './parsed.cfg') }}" + state: parsed + + # -------------- + # Output: + # -------------- + + # parsed: + # - name: Bundle-Ether10 + # churn_logging: actor + # collector_max_delay: 100 + # switchover_suppress_flaps: 500 + # + # - name: Bundle-Ether11 + # system: + # mac: 00c2.4c00.bd15 + # + # - name: GigabitEthernet0/0/0/1 + # period: 200 + # + # + + # Using gathered: + + # Native config: + # interface Bundle-Ether10 + # lacp churn logging actor + # lacp switchover suppress-flaps 500 + # lacp collector-max-delay 100 + # ! + # interface Bundle-Ether11 + # lacp system mac 00c2.4c00.bd15 + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 192.0.2.11 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/1 + # lacp period 200 + # ! + # + + - name: Gather IOSXR lacp interfaces configuration + cisco.iosxr.iosxr_lacp_interfaces: + config: + state: gathered + + # ---------- + # Output + # --------- + # gathered: + # - name: Bundle-Ether10 + # churn_logging: actor + # collector_max_delay: 100 + # switchover_suppress_flaps: 500 + # + # - name: Bundle-Ether11 + # system: + # mac: 00c2.4c00.bd15 + # + # - name: GigabitEthernet0/0/0/1 + # period: 200 + + # Using rendered: + + - name: Render platform specific commands from task input using rendered state + cisco.iosxr.iosxr_lacp_interfaces: + config: + - name: Bundle-Ether10 + churn_logging: actor + collector_max_delay: 100 + switchover_suppress_flaps: 500 + + - name: Bundle-Ether11 + system: + mac: 00c2.4c00.bd15 + + - name: GigabitEthernet0/0/0/1 + period: 200 + state: rendered + + # ------------- + # Output + # ------------- + # rendered: [ + # - "interface Bundle-Ether10" + # - " lacp churn logging actor" + # - " lacp switchover suppress-flaps 500" + # - " lacp collector-max-delay 100" + # - "interface Bundle-Ether11" + # - " lacp system mac 00c2.4c00.bd15" + # - "interface MgmtEth0/0/CPU0/0" + # - " ipv4 address 192.0.2.11 255.255.255.0" + # - "interface GigabitEthernet0/0/0/1" + # - " lacp period 200" + # + + + +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 Bundle-Ether10', 'lacp churn logging partner', 'lacp period 150']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@nilashishc) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_lacp_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_lacp_module.rst new file mode 100644 index 00000000..a42ae0d6 --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_lacp_module.rst @@ -0,0 +1,500 @@ +.. _cisco.iosxr.iosxr_lacp_module: + + +********************** +cisco.iosxr.iosxr_lacp +********************** + +**LACP resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages Global Link Aggregation Control Protocol (LACP) on IOS-XR devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
The provided configurations.
+
+
+ system + +
+ dictionary +
+ 		+ +
This option sets the default system parameters for LACP bundles.
+
+
+ mac + +
+ dictionary +
+ 		+ +
The system MAC related configuration for LACP.
+
+
+ address + +
+ string +
+ 		+ +
The system ID to use in LACP negotiations.
+
+
+ priority + +
+ integer +
+ 		+ +
The system priority to use in LACP negotiations.
+
Lower value is higher priority.
+
Refer to vendor documentation for valid values.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the IOS-XR device by executing the command show running-config 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
    • +
  • deleted
    • +
  • parsed
    • +
  • rendered
    • +
  • gathered
    • +
+ 		+
The state of the configuration after module completion.
+
+
+ + +Notes +----- + +.. note:: + - Tested against IOS-XR 6.1.3. + - This module works with connection ``network_cli``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + # + # + # ------------ + # Before state + # ------------ + # + # + # RP/0/0/CPU0:iosxr01#show running-config lacp + # Tue Jul 16 17:46:08.147 UTC + # % No such configuration item(s) + # + # + + - name: Merge provided configuration with device configuration + cisco.iosxr.iosxr_lacp: + config: + system: + priority: 10 + mac: + address: 00c1.4c00.bd15 + state: merged + + # + # + # ----------------------- + # Module Execution Result + # ----------------------- + # + # "before": {} + # + # + # "commands": [ + # "lacp system priority 10", + # "lacp system mac 00c1.4c00.bd15" + # ] + # + # + # "after": { + # "system": { + # "mac": { + # "address": "00c1.4c00.bd15" + # }, + # "priority": 10 + # } + # } + # + # ----------- + # After state + # ----------- + # + # + # RP/0/0/CPU0:iosxr01#sh run lacp + # Tue Jul 16 17:51:29.365 UTC + # lacp system mac 00c1.4c00.bd15 + # lacp system priority 10 + # + # + + # Using replaced + # + # + # ------------- + # Before state + # ------------- + # + # + # RP/0/0/CPU0:iosxr01#sh run lacp + # Tue Jul 16 17:53:59.904 UTC + # lacp system mac 00c1.4c00.bd15 + # lacp system priority 10 + # + + - name: Replace device global lacp configuration with the given configuration + cisco.iosxr.iosxr_lacp: + config: + system: + priority: 11 + state: replaced + # + # + # ----------------------- + # Module Execution Result + # ----------------------- + # "before": { + # "system": { + # "mac": { + # "address": "00c1.4c00.bd15" + # }, + # "priority": 10 + # } + # } + # + # + # "commands": [ + # "no lacp system mac", + # "lacp system priority 11" + # ] + # + # + # "after": { + # "system": { + # "priority": 11 + # } + # } + # + # ----------- + # After state + # ----------- + # + # + # RP/0/0/CPU0:iosxr01#sh run lacp + # Tue Jul 16 18:02:40.379 UTC + # lacp system priority 11 + # + # + + # Using deleted + # + # + # ------------ + # Before state + # ------------ + # + # + # RP/0/0/CPU0:iosxr01#sh run lacp + # Tue Jul 16 18:37:09.727 UTC + # lacp system mac 00c1.4c00.bd15 + # lacp system priority 11 + # + # + + - name: Delete global LACP configurations from the device + cisco.iosxr.iosxr_lacp: + state: deleted + + # + # + # ----------------------- + # Module Execution Result + # ----------------------- + # "before": { + # "system": { + # "mac": { + # "address": "00c1.4c00.bd15" + # }, + # "priority": 11 + # } + # } + # + # + # "commands": [ + # "no lacp system mac", + # "no lacp system priority" + # ] + # + # + # "after": {} + # + # ------------ + # After state + # ------------ + # + # + # RP/0/0/CPU0:iosxr01#sh run lacp + # Tue Jul 16 18:39:44.116 UTC + # % No such configuration item(s) + # + # + + + # Using parsed + # parsed.cfg + # ------------ + # + # lacp system mac 00c1.4c00.bd15 + # lacp system priority 11 + # - name: Convert LACP config to argspec without connecting to the appliance + # cisco.iosxr.iosxr_lacp: + # running_config: "{{ lookup('file', './parsed.cfg') }}" + # state: parsed + # Task Output (redacted) + # ----------------------- + # "parsed": { + # "system": { + # "mac": { + # "address": "00c1.4c00.bd15" + # }, + # "priority": 11 + # } + # } + + + # Using rendered + - name: Render platform specific commands from task input using rendered state + cisco.iosxr.iosxr_lacp: + config: + system: + priority: 11 + mac: + address: 00c1.4c00.bd15 + state: rendered + # Task Output (redacted) + # ----------------------- + # "rendered": [ + # "lacp system priority 11", + # "lacp system mac 00c1.4c00.bd15" + # ] + + + # Using gathered + # Before state: + # ------------ + # + # RP/0/0/CPU0:an-iosxr-02#show running-config lacp + # lacp system mac 00c1.4c00.bd15 + # lacp system priority 11 + - name: Gather IOSXR LACP configuration + cisco.iosxr.iosxr_lacp: + config: + state: gathered + # Task Output (redacted) + # ----------------------- + # + # "gathered": { + # "system": { + # "mac": { + # "address": "00c1.4c00.bd15" + # }, + # "priority": 11 + # } + # } + # After state: + # ------------ + # + # RP/0/0/CPU0:an-iosxr-02#show running-config lacp + # lacp system mac 00c1.4c00.bd15 + # lacp system priority + + + +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 10', 'lacp system mac 00c1.4c00.bd15']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@nilashishc) +- Rohit Thakur (@rohitthakur2590) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_lag_interfaces_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_lag_interfaces_module.rst new file mode 100644 index 00000000..12463e21 --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_lag_interfaces_module.rst @@ -0,0 +1,1033 @@ +.. _cisco.iosxr.iosxr_lag_interfaces_module: + + +******************************** +cisco.iosxr.iosxr_lag_interfaces +******************************** + +**LAG interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages the attributes of LAG/Ether-Bundle interfaces on IOS-XR devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A provided Link Aggregation Group (LAG) configuration.
+
+
+ links + +
+ dictionary +
+ 		+ +
This dict contains configurable options related to LAG/Ether-Bundle links.
+
+
+ max_active + +
+ integer +
+ 		+ +
Specifies the limit on the number of links that can be active in the LAG/Ether-Bundle.
+
Refer to vendor documentation for valid values.
+
+
+ min_active + +
+ integer +
+ 		+ +
Specifies the minimum number of active links needed to bring up the LAG/Ether-Bundle.
+
Refer to vendor documentation for valid values.
+
+
+ load_balancing_hash + +
+ string +
+ 		+
    Choices: +
  • dst-ip
    • +
  • src-ip
    • +
+ 		+
Specifies the hash function used for traffic forwarded over the LAG/Ether-Bundle.
+
Option 'dst-ip' uses the destination IP as the hash function.
+
Option 'src-ip' uses the source IP as the hash function.
+
+
+ members + +
+ list + / elements=dictionary +
+ 		+ +
List of member interfaces for the LAG/Ether-Bundle.
+
+
+ member + +
+ string +
+ 		+ +
Name of the member interface.
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • on
    • +
  • active
    • +
  • passive
    • +
  • inherit
    • +
+ 		+
Specifies the mode of the operation for the member interface.
+
Mode 'active' runs LACP in active mode.
+
Mode 'on' does not run LACP over the port.
+
Mode 'passive' runs LACP in passive mode over the port.
+
Mode 'inherit' runs LACP as configured in the bundle.
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • on
    • +
  • active
    • +
  • passive
    • +
+ 		+
LAG mode.
+
Mode 'active' runs LACP in active mode over the port.
+
Mode 'on' does not run LACP over the port.
+
Mode 'passive' runs LACP in passive mode over the port.
+
+
+ name + +
+ string + / required +
+ 		+ +
Name/Identifier of the LAG/Ether-Bundle to configure.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the IOS-XR device by executing the command show running-config int.
+
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
    • +
  • rendered
    • +
  • gathered
    • +
+ 		+
The state of the configuration after module completion.
+
+
+ + +Notes +----- + +.. note:: + - Tested against IOS-XR 6.1.3. + - This module works with connection ``network_cli``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + # + # + # ------------ + # Before state + # ------------ + # + # RP/0/0/CPU0:iosxr01#show run int + # Sun Jul 7 19:42:59.416 UTC + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 192.0.2.11 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/1 + # description "GigabitEthernet - 1" + # ! + # interface GigabitEthernet0/0/0/2 + # description "GigabitEthernet - 2" + # ! + # interface GigabitEthernet0/0/0/3 + # description "GigabitEthernet - 3" + # ! + # interface GigabitEthernet0/0/0/4 + # description "GigabitEthernet - 4" + # ! + # + # + - name: Merge provided configuration with device configuration + cisco.iosxr.iosxr_lag_interfaces: + config: + - name: Bundle-Ether10 + members: + - member: GigabitEthernet0/0/0/1 + mode: inherit + - member: GigabitEthernet0/0/0/3 + mode: inherit + mode: active + links: + max_active: 5 + min_active: 2 + load_balancing_hash: src-ip + + - name: Bundle-Ether12 + members: + - member: GigabitEthernet0/0/0/2 + mode: passive + - member: GigabitEthernet0/0/0/4 + mode: passive + load_balancing_hash: dst-ip + state: merged + # + # + # ----------- + # After state + # ----------- + # + # RP/0/0/CPU0:iosxr01#show run int + # Sun Jul 7 20:51:17.685 UTC + # interface Bundle-Ether10 + # lacp mode active + # bundle load-balancing hash src-ip + # bundle maximum-active links 5 + # bundle minimum-active links 2 + # ! + # interface Bundle-Ether12 + # bundle load-balancing hash dst-ip + # ! + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 192.0.2.11 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/1 + # description 'GigabitEthernet - 1" + # bundle id 10 mode inherit + # ! + # interface GigabitEthernet0/0/0/2 + # description "GigabitEthernet - 2" + # bundle id 12 mode passive + # ! + # interface GigabitEthernet0/0/0/3 + # description "GigabitEthernet - 3" + # bundle id 10 mode inherit + # ! + # interface GigabitEthernet0/0/0/4 + # description "GigabitEthernet - 4" + # bundle id 12 mode passive + # ! + # + + + # Using replaced + # + # + # ------------- + # Before state + # ------------- + # + # + # RP/0/0/CPU0:iosxr01#sho run int + # Sun Jul 7 20:58:06.527 UTC + # interface Bundle-Ether10 + # lacp mode active + # bundle load-balancing hash src-ip + # bundle maximum-active links 5 + # bundle minimum-active links 2 + # ! + # interface Bundle-Ether12 + # bundle load-balancing hash dst-ip + # ! + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 192.0.2.11 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/1 + # description 'GigabitEthernet - 1" + # bundle id 10 mode inherit + # ! + # interface GigabitEthernet0/0/0/2 + # description "GigabitEthernet - 2" + # bundle id 12 mode passive + # ! + # interface GigabitEthernet0/0/0/3 + # description "GigabitEthernet - 3" + # bundle id 10 mode inherit + # ! + # interface GigabitEthernet0/0/0/4 + # description "GigabitEthernet - 4" + # bundle id 12 mode passive + # ! + # + # + - name: Replace device configuration of listed Bundles with provided configurations + cisco.iosxr.iosxr_lag_interfaces: + config: + - name: Bundle-Ether12 + members: + - name: GigabitEthernet0/0/0/2 + mode: passive + + - name: Bundle-Ether11 + members: + - name: GigabitEthernet0/0/0/4 + load_balancing_hash: src-ip + state: replaced + # + # + # ----------- + # After state + # ----------- + # + # + # RP/0/0/CPU0:iosxr01#sh run int + # Sun Jul 7 21:22:27.397 UTC + # interface Bundle-Ether10 + # lacp mode active + # bundle load-balancing hash src-ip + # bundle maximum-active links 5 + # bundle minimum-active links 2 + # ! + # interface Bundle-Ether11 + # bundle load-balancing hash src-ip + # ! + # interface Bundle-Ether12 + # lacp mode passive + # ! + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 192.0.2.11 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/1 + # description 'GigabitEthernet - 1" + # bundle id 10 mode inherit + # ! + # interface GigabitEthernet0/0/0/2 + # description "GigabitEthernet - 2" + # bundle id 12 mode on + # ! + # interface GigabitEthernet0/0/0/3 + # description "GigabitEthernet - 3" + # bundle id 10 mode inherit + # ! + # interface GigabitEthernet0/0/0/4 + # description "GigabitEthernet - 4" + # bundle id 11 mode on + # ! + # + # + + + # Using overridden + # + # + # ------------ + # Before state + # ------------ + # + # + # RP/0/0/CPU0:iosxr01#sh run int + # Sun Jul 7 21:22:27.397 UTC + # interface Bundle-Ether10 + # lacp mode active + # bundle load-balancing hash src-ip + # bundle maximum-active links 5 + # bundle minimum-active links 2 + # ! + # interface Bundle-Ether11 + # bundle load-balancing hash src-ip + # ! + # interface Bundle-Ether12 + # lacp mode passive + # ! + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 192.0.2.11 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/1 + # description 'GigabitEthernet - 1" + # bundle id 10 mode inherit + # ! + # interface GigabitEthernet0/0/0/2 + # description "GigabitEthernet - 2" + # bundle id 12 mode on + # ! + # interface GigabitEthernet0/0/0/3 + # description "GigabitEthernet - 3" + # bundle id 10 mode inherit + # ! + # interface GigabitEthernet0/0/0/4 + # description "GigabitEthernet - 4" + # bundle id 11 mode on + # ! + # + # + + - name: Overrides all device configuration with provided configuration + cisco.iosxr.iosxr_lag_interfaces: + config: + - name: Bundle-Ether10 + members: + - member: GigabitEthernet0/0/0/1 + mode: inherit + - member: GigabitEthernet0/0/0/2 + mode: inherit + mode: active + load_balancing_hash: dst-ip + state: overridden + # + # + # ------------ + # After state + # ------------ + # + # + # RP/0/0/CPU0:iosxr01#sh run int + # Sun Jul 7 21:43:04.802 UTC + # interface Bundle-Ether10 + # lacp mode active + # bundle load-balancing hash dst-ip + # ! + # interface Bundle-Ether11 + # ! + # interface Bundle-Ether12 + # ! + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 192.0.2.11 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/1 + # description 'GigabitEthernet - 1" + # bundle id 10 mode inherit + # ! + # interface GigabitEthernet0/0/0/2 + # description "GigabitEthernet - 2" + # bundle id 10 mode inherit + # ! + # interface GigabitEthernet0/0/0/3 + # description "GigabitEthernet - 3" + # ! + # interface GigabitEthernet0/0/0/4 + # description "GigabitEthernet - 4" + # ! + # + # + + + # Using deleted + # + # + # ------------ + # Before state + # ------------ + # + # RP/0/0/CPU0:iosxr01#sh run int + # Sun Jul 7 21:22:27.397 UTC + # interface Bundle-Ether10 + # lacp mode active + # bundle load-balancing hash src-ip + # bundle maximum-active links 5 + # bundle minimum-active links 2 + # ! + # interface Bundle-Ether11 + # bundle load-balancing hash src-ip + # ! + # interface Bundle-Ether12 + # lacp mode passive + # ! + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 192.0.2.11 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/1 + # description 'GigabitEthernet - 1" + # bundle id 10 mode inherit + # ! + # interface GigabitEthernet0/0/0/2 + # description "GigabitEthernet - 2" + # bundle id 12 mode on + # !n + # interface GigabitEthernet0/0/0/3 + # description "GigabitEthernet - 3" + # bundle id 10 mode inherit + # ! + # interface GigabitEthernet0/0/0/4 + # description "GigabitEthernet - 4" + # bundle id 11 mode on + # ! + # + # + + - name: Delete attributes of given bundles and removes member interfaces from them + (Note - This won't delete the bundles themselves) + cisco.iosxr.iosxr_lag_interfaces: + config: + - name: Bundle-Ether10 + - name: Bundle-Ether11 + - name: Bundle-Ether12 + state: deleted + + # + # + # ------------ + # After state + # ------------ + # + # RP/0/0/CPU0:iosxr01#sh run int + # Sun Jul 7 21:49:50.004 UTC + # interface Bundle-Ether10 + # ! + # interface Bundle-Ether11 + # ! + # interface Bundle-Ether12 + # ! + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 192.0.2.11 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/1 + # description 'GigabitEthernet - 1" + # ! + # interface GigabitEthernet0/0/0/2 + # description "GigabitEthernet - 2" + # ! + # interface GigabitEthernet0/0/0/3 + # description "GigabitEthernet - 3" + # ! + # interface GigabitEthernet0/0/0/4 + # description "GigabitEthernet - 4" + # ! + # + # + + # Using deleted (without config) + # + # + # ------------ + # Before state + # ------------ + # + # RP/0/0/CPU0:an-iosxr#sh run int + # Sun Aug 18 19:49:51.908 UTC + # interface Bundle-Ether10 + # lacp mode active + # bundle load-balancing hash src-ip + # bundle maximum-active links 10 + # bundle minimum-active links 2 + # ! + # interface Bundle-Ether11 + # bundle load-balancing hash dst-ip + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 192.0.2.11 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/0 + # shutdown + # ! + # interface GigabitEthernet0/0/0/1 + # bundle id 10 mode inherit + # shutdown + # ! + # interface GigabitEthernet0/0/0/2 + # bundle id 10 mode passive + # shutdown + # ! + # interface GigabitEthernet0/0/0/3 + # bundle id 11 mode passive + # shutdown + # ! + # interface GigabitEthernet0/0/0/4 + # bundle id 11 mode passive + # shutdown + # ! + # + + - name: Delete attributes of all bundles and removes member interfaces from them (Note + - This won't delete the bundles themselves) + cisco.iosxr.iosxr_lag_interfaces: + state: deleted + + # + # + # ------------ + # After state + # ------------ + # + # + # RP/0/0/CPU0:an-iosxr#sh run int + # Sun Aug 18 19:54:22.389 UTC + # interface Bundle-Ether10 + # ! + # interface Bundle-Ether11 + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 10.8.38.69 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/0 + # shutdown + # ! + # interface GigabitEthernet0/0/0/1 + # shutdown + # ! + # interface GigabitEthernet0/0/0/2 + # shutdown + # ! + # interface GigabitEthernet0/0/0/3 + # shutdown + # ! + # interface GigabitEthernet0/0/0/4 + # shutdown + # ! + + # Using parsed: + + # parsed.cfg + + # interface Bundle-Ether10 + # lacp mode active + # bundle load-balancing hash src-ip + # bundle maximum-active links 5 + # bundle minimum-active links 2 + # ! + # interface Bundle-Ether12 + # bundle load-balancing hash dst-ip + # ! + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 192.0.2.11 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/1 + # description 'GigabitEthernet - 1" + # bundle id 10 mode inherit + # ! + # interface GigabitEthernet0/0/0/2 + # description "GigabitEthernet - 2" + # bundle id 12 mode passive + # ! + # interface GigabitEthernet0/0/0/3 + # description "GigabitEthernet - 3" + # bundle id 10 mode inherit + # ! + # interface GigabitEthernet0/0/0/4 + # description "GigabitEthernet - 4" + # bundle id 12 mode passive + # ! + # + - name: Convert lag interfaces config to argspec without connecting to the appliance + cisco.iosxr.iosxr_lag_interfaces: + running_config: "{{ lookup('file', './parsed.cfg') }}" + state: parsed + + # -------------- + # Output + # -------------- + # parsed: + # - name: Bundle-Ether10 + # members: + # - member: GigabitEthernet0/0/0/1 + # mode: inherit + # - member: GigabitEthernet0/0/0/3 + # mode: inherit + # mode: active + # links: + # max_active: 5 + # min_active: 2 + # load_balancing_hash: src-ip + + # - name: Bundle-Ether12 + # members: + # - member: GigabitEthernet0/0/0/2 + # mode: passive + # - member: GigabitEthernet0/0/0/4 + # mode: passive + # load_balancing_hash: dst-ip + + # using gathered + + # Device Config: + # ------------- + + # interface Bundle-Ether10 + # lacp mode active + # bundle load-balancing hash src-ip + # bundle maximum-active links 5 + # bundle minimum-active links 2 + # ! + # interface Bundle-Ether12 + # bundle load-balancing hash dst-ip + # ! + # interface Loopback888 + # description test for ansible + # shutdown + # ! + # interface MgmtEth0/0/CPU0/0 + # ipv4 address 192.0.2.11 255.255.255.0 + # ! + # interface GigabitEthernet0/0/0/1 + # description 'GigabitEthernet - 1" + # bundle id 10 mode inherit + # ! + # interface GigabitEthernet0/0/0/2 + # description "GigabitEthernet - 2" + # bundle id 12 mode passive + # ! + # interface GigabitEthernet0/0/0/3 + # description "GigabitEthernet - 3" + # bundle id 10 mode inherit + # ! + # interface GigabitEthernet0/0/0/4 + # description "GigabitEthernet - 4" + # bundle id 12 mode passive + # ! + # + + - name: Gather IOSXR lag interfaces configuration + cisco.iosxr.iosxr_lag_interfaces: + config: + state: gathered + + # -------------- + # Output + # -------------- + # gathered: + # - name: Bundle-Ether10 + # members: + # - member: GigabitEthernet0/0/0/1 + # mode: inherit + # - member: GigabitEthernet0/0/0/3 + # mode: inherit + # mode: active + # links: + # max_active: 5 + # min_active: 2 + # load_balancing_hash: src-ip + + # - name: Bundle-Ether12 + # members: + # - member: GigabitEthernet0/0/0/2 + # mode: passive + # - member: GigabitEthernet0/0/0/4 + # mode: passive + # load_balancing_hash: dst-ip + + # Using rendered: + - name: Render platform specific commands from task input using rendered state + cisco.iosxr.iosxr_lag_interfaces: + config: + - name: Bundle-Ether10 + members: + - member: GigabitEthernet0/0/0/1 + mode: inherit + - member: GigabitEthernet0/0/0/3 + mode: inherit + mode: active + links: + max_active: 5 + min_active: 2 + load_balancing_hash: src-ip + + - name: Bundle-Ether12 + members: + - member: GigabitEthernet0/0/0/2 + mode: passive + - member: GigabitEthernet0/0/0/4 + mode: passive + load_balancing_hash: dst-ip + state: rendered + + # Output: + + # rendered: + # [ + # - "interface Bundle-Ether10" + # - " lacp mode active" + # - " bundle load-balancing hash src-ip" + # - " bundle maximum-active links 5" + # - " bundle minimum-active links 2" + # - "interface Bundle-Ether12" + # - " bundle load-balancing hash dst-ip" + # - "interface Loopback888" + # - " description test for ansible" + # - " shutdown" + # - "interface MgmtEth0/0/CPU0/0" + # - " ipv4 address 192.0.2.11 255.255.255.0" + # - "interface GigabitEthernet0/0/0/1" + # - " description 'GigabitEthernet - 1"" + # - " bundle id 10 mode inherit" + # - "interface GigabitEthernet0/0/0/2" + # - " description "GigabitEthernet - 2"" + # - " bundle id 12 mode passive" + # - "interface GigabitEthernet0/0/0/3" + # - " description "GigabitEthernet - 3"" + # - " bundle id 10 mode inherit" + # - "interface GigabitEthernet0/0/0/4" + # - " description "GigabitEthernet - 4"" + # - " bundle id 12 mode passive" + # ] + # + # + + + +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 Bundle-Ether10', 'bundle minimum-active links 2', 'bundle load-balancing hash src-ip']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_lldp_global_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_lldp_global_module.rst new file mode 100644 index 00000000..a667db37 --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_lldp_global_module.rst @@ -0,0 +1,692 @@ +.. _cisco.iosxr.iosxr_lldp_global_module: + + +***************************** +cisco.iosxr.iosxr_lldp_global +***************************** + +**LLDP resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages Global Link Layer Discovery Protocol (LLDP) settings on IOS-XR devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
The provided global LLDP configuration.
+
+
+ holdtime + +
+ integer +
+ 		+ +
Specifies the holdtime (in sec) to be sent in packets.
+
+
+ reinit + +
+ integer +
+ 		+ +
Specifies the delay (in sec) for LLDP initialization on any interface.
+
+
+ subinterfaces + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable or disable LLDP over sub-interfaces.
+
+
+ timer + +
+ integer +
+ 		+ +
Specifies the rate at which LLDP packets are sent (in sec).
+
+
+ tlv_select + +
+ dictionary +
+ 		+ +
Specifies the LLDP TLVs to enable or disable.
+
+
+ management_address + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable or disable management address TLV.
+
+
+ port_description + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable or disable port description TLV.
+
+
+ system_capabilities + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable or disable system capabilities TLV.
+
+
+ system_description + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable or disable system description TLV.
+
+
+ system_name + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable or disable system name TLV.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the IOS-XR device by executing the command show running-config lldp.
+
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
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ 		+
The state of the configuration after module completion.
+
+
+ + +Notes +----- + +.. note:: + - Tested against IOS-XR 6.1.3. + - This module works with connection ``network_cli``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + # + # + # ------------- + # Before State + # ------------- + # + # + # RP/0/0/CPU0:an-iosxr#sh run lldp + # Tue Aug 6 19:27:54.933 UTC + # % No such configuration item(s) + # + # + + - name: Merge provided LLDP configuration with the existing configuration + cisco.iosxr.iosxr_lldp_global: + config: + holdtime: 100 + reinit: 2 + timer: 3000 + subinterfaces: true + tlv_select: + management_address: false + system_description: false + state: merged + + # + # + # ------------------------ + # Module Execution Result + # ------------------------ + # + # "before": {} + # + # "commands": [ + # "lldp subinterfaces enable", + # "lldp holdtime 100", + # "lldp reinit 2", + # "lldp tlv-select system-description disable", + # "lldp tlv-select management-address disable", + # "lldp timer 3000" + # ] + # + # "after": { + # "holdtime": 100, + # "reinit": 2, + # "subinterfaces": true, + # "timer": 3000, + # "tlv_select": { + # "management_address": false, + # "system_description": false + # } + # } + # + # + # ------------ + # After state + # ------------ + # + # + # RP/0/0/CPU0:an-iosxr#sh run lldp + # Tue Aug 6 21:31:10.587 UTC + # lldp + # timer 3000 + # reinit 2 + # subinterfaces enable + # holdtime 100 + # tlv-select + # management-address disable + # system-description disable + # ! + # ! + # + # + + + # Using replaced + # + # + # ------------- + # Before State + # ------------- + # + # RP/0/0/CPU0:an-iosxr#sh run lldp + # Tue Aug 6 21:31:10.587 UTC + # lldp + # timer 3000 + # reinit 2 + # subinterfaces enable + # holdtime 100 + # tlv-select + # management-address disable + # system-description disable + # ! + # ! + # + # + + - name: Replace existing LLDP device configuration with provided configuration + cisco.iosxr.iosxr_lldp_global: + config: + holdtime: 100 + tlv_select: + port_description: false + system_description: true + management_description: true + state: replaced + + # + # + # ------------------------ + # Module Execution Result + # ------------------------ + # + # "before": { + # "holdtime": 100, + # "reinit": 2, + # "subinterfaces": true, + # "timer": 3000, + # "tlv_select": { + # "management_address": false, + # "system_description": false + # } + # } + # + # "commands": [ + # "no lldp reinit 2", + # "no lldp subinterfaces enable", + # "no lldp timer 3000", + # "no lldp tlv-select management-address disable", + # "no lldp tlv-select system-description disable", + # "lldp tlv-select port-description disable" + # ] + # + # "after": { + # "holdtime": 100, + # "tlv_select": { + # "port_description": false + # } + # } + # + # + # ------------ + # After state + # ------------ + # + # RP/0/0/CPU0:an-iosxr#sh run lldp + # Tue Aug 6 21:53:08.407 UTC + # lldp + # holdtime 100 + # tlv-select + # port-description disable + # ! + # ! + # + # + + + # Using deleted + # + # ------------ + # Before state + # ------------ + # + # + # RP/0/0/CPU0:an-iosxr#sh run lldp + # Tue Aug 6 21:31:10.587 UTC + # lldp + # timer 3000 + # reinit 2 + # subinterfaces enable + # holdtime 100 + # tlv-select + # management-address disable + # system-description disable + # ! + # ! + # + # + + - name: Deleted existing LLDP configurations from the device + cisco.iosxr.iosxr_lldp_global: + state: deleted + + # + # + # ------------------------ + # Module Execution Result + # ------------------------ + # + # "before": { + # "holdtime": 100, + # "reinit": 2, + # "subinterfaces": true, + # "timer": 3000, + # "tlv_select": { + # "management_address": false, + # "system_description": false + # } + # }, + # + # "commands": [ + # "no lldp holdtime 100", + # "no lldp reinit 2", + # "no lldp subinterfaces enable", + # "no lldp timer 3000", + # "no lldp tlv-select management-address disable", + # "no lldp tlv-select system-description disable" + # ] + # + # "after": {} + # + # + # ----------- + # After state + # ----------- + # + # RP/0/0/CPU0:an-iosxr#sh run lldp + # Tue Aug 6 21:38:31.187 UTC + # lldp + # ! + # + # Using parsed: + + # parsed.cfg + # lldp + # timer 3000 + # reinit 2 + # subinterfaces enable + # holdtime 100 + # tlv-select + # management-address disable + # system-description disable + # ! + # ! + + - name: Convert lldp global config to argspec without connecting to the appliance + cisco.iosxr.iosxr_lldp_global: + running_config: "{{ lookup('file', './parsed.cfg') }}" + state: parsed + + # ------------------------ + # Module Execution Result + # ------------------------ + # parsed: + # holdtime: 100 + # reinit: 2 + # timer: 3000 + # subinterfaces: True + # tlv_select: + # management_address: False + # system_description: False + + # using gathered: + + # Device config: + # lldp + # timer 3000 + # reinit 2 + # subinterfaces enable + # holdtime 100 + # tlv-select + # management-address disable + # system-description disable + # ! + # ! + + - name: Gather IOSXR lldp global configuration + cisco.iosxr.iosxr_lldp_global: + config: + state: gathered + + + # ------------------------ + # Module Execution Result + # ------------------------ + # gathered: + # holdtime: 100 + # reinit: 2 + # timer: 3000 + # subinterfaces: True + # tlv_select: + # management_address: False + # system_description: False + + # using rendered: + + - name: Render platform specific commands from task input using rendered state + cisco.iosxr.iosxr_lldp_global: + config: + holdtime: 100 + reinit: 2 + timer: 3000 + subinterfaces: true + tlv_select: + management_address: false + system_description: false + state: rendered + + # + # + # ------------------------ + # Module Execution Result + # ------------------------ + # + # "rendered": [ + # "lldp subinterfaces enable", + # "lldp holdtime 100", + # "lldp reinit 2", + # "lldp tlv-select system-description disable", + # "lldp tlv-select management-address disable", + # "lldp timer 3000" + # ] + + + +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:
+
['lldp subinterfaces enable', 'lldp holdtime 100', 'no lldp tlv-select management-address disable']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_lldp_interfaces_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_lldp_interfaces_module.rst new file mode 100644 index 00000000..1ecb8fa5 --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_lldp_interfaces_module.rst @@ -0,0 +1,849 @@ +.. _cisco.iosxr.iosxr_lldp_interfaces_module: + + +********************************* +cisco.iosxr.iosxr_lldp_interfaces +********************************* + +**LLDP interfaces resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages Link Layer Discovery Protocol (LLDP) attributes of interfaces on IOS-XR devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary of LLDP interfaces options.
+
+
+ destination + +
+ dictionary +
+ 		+ +
Specifies LLDP destination configuration on the interface.
+
+
+ mac_address + +
+ string +
+ 		+
    Choices: +
  • ieee-nearest-bridge
    • +
  • ieee-nearest-non-tmpr-bridge
    • +
+ 		+
Specifies the LLDP destination mac address on the interface.
+
+
+ name + +
+ string +
+ 		+ +
Name/Identifier of the interface or Ether-Bundle.
+
+
+ receive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable LLDP RX on an interface.
+
+
+ transmit + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/disable LLDP TX on an interface.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the IOS-XR device by executing the command show running-config int.
+
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
    • +
  • rendered
    • +
  • gathered
    • +
+ 		+
The state of the configuration after module completion.
+
+
+ + +Notes +----- + +.. note:: + - Tested against IOS-XR 6.1.3. + - This module works with connection ``network_cli``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + # + # + # ------------ + # Before state + # ------------ + # + # + # RP/0/RP0/CPU0:ios#sh run int + # Mon Aug 12 12:40:23.104 UTC + # interface TenGigE0/0/0/0 + # ipv4 address 192.0.2.11 255.255.255.192 + # ! + # interface preconfigure GigabitEthernet0/0/0/1 + # ! + # interface preconfigure GigabitEthernet0/0/0/2 + # ! + # + # + + - name: Merge provided configuration with running configuration + cisco.iosxr.iosxr_lldp_interfaces: + config: + - name: GigabitEthernet0/0/0/1 + destination: + mac_address: ieee-nearest-non-tmpr-bridge + transmit: false + + - name: GigabitEthernet0/0/0/2 + destination: + mac_address: ieee-nearest-bridge + receive: false + state: merged + + # + # + # ------------------------ + # Module Execution Result + # ------------------------ + # + # + # "before": [ + # { + # "name": "TenGigE0/0/0/0" + # }, + # { + # "name": "GigabitEthernet0/0/0/1" + # }, + # { + # "name": "GigabitEthernet0/0/0/2" + # } + # ] + # + # "commands": [ + # "interface GigabitEthernet0/0/0/2", + # "lldp destination mac-address ieee-nearest-non-tmpr-bridge", + # "lldp transmit disable", + # "interface GigabitEthernet0/0/0/1", + # "lldp receive disable", + # "lldp destination mac-address ieee-nearest-bridge" + # ] + # + # "after": [ + # { + # "name": "TenGigE0/0/0/0" + # }, + # { + # "destination": { + # "mac_address": "ieee-nearest-bridge" + # }, + # "name": "GigabitEthernet0/0/0/1", + # "receive": false + # }, + # { + # "destination": { + # "mac_address": "ieee-nearest-non-tmpr-bridge" + # }, + # "name": "GigabitEthernet0/0/0/2", + # "transmit": false + # } + # ] + # + # + # ------------ + # After state + # ------------ + # + # + # RP/0/RP0/CPU0:ios#sh run int + # Mon Aug 12 12:49:51.517 UTC + # interface TenGigE0/0/0/0 + # ipv4 address 192.0.2.11 255.255.255.192 + # ! + # interface preconfigure GigabitEthernet0/0/0/1 + # lldp + # receive disable + # destination mac-address + # ieee-nearest-bridge + # ! + # ! + # ! + # interface preconfigure GigabitEthernet0/0/0/2 + # lldp + # transmit disable + # destination mac-address + # ieee-nearest-non-tmpr-bridge + # ! + # ! + # ! + # + # + + + # Using replaced + # + # + # ------------- + # Before state + # ------------- + # + # + # RP/0/RP0/CPU0:ios#sh run int + # Mon Aug 12 12:49:51.517 UTC + # interface TenGigE0/0/0/0 + # ipv4 address 192.0.2.11 255.255.255.192 + # ! + # interface preconfigure GigabitEthernet0/0/0/1 + # lldp + # receive disable + # destination mac-address + # ieee-nearest-bridge + # ! + # ! + # ! + # interface preconfigure GigabitEthernet0/0/0/2 + # lldp + # transmit disable + # destination mac-address + # ieee-nearest-non-tmpr-bridge + # ! + # ! + # ! + # + # + + - name: Replace existing LLDP configurations of specified interfaces with provided + configuration + cisco.iosxr.iosxr_lldp_interfaces: + config: + - name: GigabitEthernet0/0/0/1 + destination: + mac_address: ieee-nearest-non-tmpr-bridge + state: replaced + + # + # + # ------------------------ + # Module Execution Result + # ------------------------ + # + # "before": [ + # { + # "name": "TenGigE0/0/0/0" + # }, + # { + # "destination": { + # "mac_address": "ieee-nearest-bridge" + # }, + # "name": "GigabitEthernet0/0/0/1", + # "receive": false + # }, + # { + # "destination": { + # "mac_address": "ieee-nearest-non-tmpr-bridge" + # }, + # "name": "GigabitEthernet0/0/0/2", + # "transmit": false + # } + # ] + # + # + # "commands": [ + # "interface GigabitEthernet0/0/0/1", + # "no lldp receive disable", + # "lldp destination mac-address ieee-nearest-non-tmpr-bridge" + # ] + # + # + # "after": [ + # { + # "name": "TenGigE0/0/0/0" + # }, + # { + # "destination": { + # "mac_address": "ieee-nearest-non-tmpr-bridge" + # }, + # "name": "GigabitEthernet0/0/0/1" + # }, + # { + # "destination": { + # "mac_address": "ieee-nearest-non-tmpr-bridge" + # }, + # "name": "GigabitEthernet0/0/0/2", + # "transmit": false + # } + # ] + # + # + # ------------ + # After state + # ------------ + # + # + # RP/0/RP0/CPU0:ios#sh run int + # Mon Aug 12 13:02:57.062 UTC + # interface TenGigE0/0/0/0 + # ipv4 address 192.0.2.11 255.255.255.192 + # ! + # interface preconfigure GigabitEthernet0/0/0/1 + # lldp + # destination mac-address + # ieee-nearest-non-tmpr-bridge + # ! + # ! + # ! + # interface preconfigure GigabitEthernet0/0/0/2 + # lldp + # transmit disable + # destination mac-address + # ieee-nearest-non-tmpr-bridge + # ! + # ! + # ! + # + # + + + # Using overridden + # + # + # ------------- + # Before state + # ------------- + # + # + # RP/0/RP0/CPU0:ios#sh run int + # Mon Aug 12 13:15:40.465 UTC + # interface TenGigE0/0/0/0 + # ipv4 address 192.0.2.11 255.255.255.192 + # ! + # interface preconfigure GigabitEthernet0/0/0/1 + # lldp + # receive disable + # destination mac-address + # ieee-nearest-bridge + # ! + # ! + # ! + # interface preconfigure GigabitEthernet0/0/0/2 + # lldp + # transmit disable + # destination mac-address + # ieee-nearest-non-tmpr-bridge + # ! + # ! + # ! + # + # + + - name: Override the LLDP configurations of all the interfaces with provided configurations + cisco.iosxr.iosxr_lldp_interfaces: + config: + - name: GigabitEthernet0/0/0/1 + transmit: false + state: overridden + + # + # + # ------------------------ + # Module Execution Result + # ------------------------ + # + # + # "before": [ + # { + # "name": "TenGigE0/0/0/0" + # }, + # { + # "destination": { + # "mac_address": "ieee-nearest-bridge" + # }, + # "name": "GigabitEthernet0/0/0/1", + # "receive": false + # }, + # { + # "destination": { + # "mac_address": "ieee-nearest-non-tmpr-bridge" + # }, + # "name": "GigabitEthernet0/0/0/2", + # "transmit": false + # } + # ] + # + # "commands": [ + # "interface GigabitEthernet0/0/0/2", + # "no lldp destination mac-address ieee-nearest-non-tmpr-bridge", + # "no lldp transmit disable", + # "interface GigabitEthernet0/0/0/1", + # "no lldp destination mac-address ieee-nearest-bridge", + # "no lldp receive disable", + # "lldp transmit disable" + # ] + # + # + # "after": [ + # { + # "name": "TenGigE0/0/0/0" + # }, + # { + # "name": "GigabitEthernet0/0/0/1", + # "transmit": false + # }, + # { + # "name": "GigabitEthernet0/0/0/2" + # } + # ] + # + # + # ------------ + # After state + # ------------ + # + # + # RP/0/RP0/CPU0:ios#sh run int + # Mon Aug 12 13:22:25.604 UTC + # interface TenGigE0/0/0/0 + # ipv4 address 192.0.2.11 255.255.255.192 + # ! + # interface preconfigure GigabitEthernet0/0/0/1 + # lldp + # transmit disable + # ! + # ! + # interface preconfigure GigabitEthernet0/0/0/2 + # ! + # + # + + + # Using deleted + # + # + # ------------- + # Before state + # ------------- + # + # + # RP/0/RP0/CPU0:ios#sh run int + # Mon Aug 12 13:26:21.498 UTC + # interface TenGigE0/0/0/0 + # ipv4 address 192.0.2.11 255.255.255.192 + # ! + # interface preconfigure GigabitEthernet0/0/0/1 + # lldp + # receive disable + # destination mac-address + # ieee-nearest-bridge + # ! + # ! + # ! + # interface preconfigure GigabitEthernet0/0/0/2 + # lldp + # transmit disable + # destination mac-address + # ieee-nearest-non-tmpr-bridge + # ! + # ! + # ! + # + # + + - name: Delete LLDP configurations of all interfaces (Note - This won't delete the + interfaces themselves) + cisco.iosxr.iosxr_lldp_interfaces: + state: deleted + + # + # + # + # ------------------------ + # Module Execution Result + # ------------------------ + # + # + # "before": [ + # { + # "name": "TenGigE0/0/0/0" + # }, + # { + # "destination": { + # "mac_address": "ieee-nearest-bridge" + # }, + # "name": "GigabitEthernet0/0/0/1", + # "receive": false + # }, + # { + # "destination": { + # "mac_address": "ieee-nearest-non-tmpr-bridge" + # }, + # "name": "GigabitEthernet0/0/0/2", + # "transmit": false + # } + # ] + # + # + # "commands": [ + # "interface GigabitEthernet0/0/0/1", + # "no lldp destination mac-address ieee-nearest-bridge", + # "no lldp receive disable", + # "interface GigabitEthernet0/0/0/2", + # "no lldp destination mac-address ieee-nearest-non-tmpr-bridge", + # "no lldp transmit disable" + # ] + # + # + # "after": [ + # { + # "name": "TenGigE0/0/0/0" + # }, + # { + # "name": "GigabitEthernet0/0/0/1" + # }, + # { + # "name": "GigabitEthernet0/0/0/2" + # } + # ] + # + # + # ------------ + # After state + # ------------ + # + # + # RP/0/RP0/CPU0:ios#sh run int + # Mon Aug 12 13:30:14.618 UTC + # interface TenGigE0/0/0/0 + # ipv4 address 192.0.2.11 255.255.255.192 + # ! + # interface preconfigure GigabitEthernet0/0/0/1 + # ! + # interface preconfigure GigabitEthernet0/0/0/2 + # ! + # + # + # Using parsed: + # parsed.cfg + + # interface TenGigE0/0/0/0 + # ipv4 address 192.0.2.11 255.255.255.192 + # ! + # interface preconfigure GigabitEthernet0/0/0/1 + # lldp + # receive disable + # destination mac-address + # ieee-nearest-bridge + # ! + # ! + # ! + # interface preconfigure GigabitEthernet0/0/0/2 + # lldp + # transmit disable + # destination mac-address + # ieee-nearest-non-tmpr-bridge + + - name: Convert lacp interfaces config to argspec without connecting to the appliance + cisco.iosxr.iosxr_lldp_interfaces: + running_config: "{{ lookup('file', './parsed.cfg') }}" + state: parsed + + # ------------------------ + # Module Execution Result + # ------------------------ + + # parsed: [ + # - name: GigabitEthernet0/0/0/1 + # destination: + # mac_address: ieee-nearest-non-tmpr-bridge + # transmit: False + + # - name: GigabitEthernet0/0/0/2 + # destination: + # mac_address: ieee-nearest-bridge + # receive: False + # ] + + # Using gathered: + # Device config: + + # RP/0/RP0/CPU0:ios#sh run int + # Mon Aug 12 12:49:51.517 UTC + # interface TenGigE0/0/0/0 + # ipv4 address 192.0.2.11 255.255.255.192 + # ! + # interface preconfigure GigabitEthernet0/0/0/1 + # lldp + # receive disable + # destination mac-address + # ieee-nearest-bridge + # ! + # ! + # ! + # interface preconfigure GigabitEthernet0/0/0/2 + # lldp + # transmit disable + # destination mac-address + # ieee-nearest-non-tmpr-bridge + + - name: Gather IOSXR lldp interfaces configuration + cisco.iosxr.iosxr_lldp_interfaces: + config: + state: gathered + + # ------------------------ + # Module Execution Result + # ------------------------ + + # gathered: + # - name: GigabitEthernet0/0/0/1 + # destination: + # mac_address: ieee-nearest-non-tmpr-bridge + # transmit: False + + # - name: GigabitEthernet0/0/0/2 + # destination: + # mac_address: ieee-nearest-bridge + # receive: False + + # Using rendred: + - name: Render platform specific commands from task input using rendered state + cisco.iosxr.iosxr_lldp_interfaces: + config: + - name: GigabitEthernet0/0/0/1 + destination: + mac_address: ieee-nearest-non-tmpr-bridge + transmit: false + + - name: GigabitEthernet0/0/0/2 + destination: + mac_address: ieee-nearest-bridge + receive: false + state: rendered + + # ------------------------ + # Module Execution Result + # ------------------------ + + # "rendered": [ + # "interface GigabitEthernet0/0/0/2", + # "lldp destination mac-address ieee-nearest-non-tmpr-bridge", + # "lldp transmit disable", + # "interface GigabitEthernet0/0/0/1", + # "lldp receive disable", + # "lldp destination mac-address ieee-nearest-bridge" + # ] + + + +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 GigabitEthernet0/0/0/1', 'lldp destination mac-address ieee-nearest-non-tmpr-bridge', 'no lldp transmit disable']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@nilashishc) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_logging_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_logging_module.rst new file mode 100644 index 00000000..f361af44 --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_logging_module.rst @@ -0,0 +1,633 @@ +.. _cisco.iosxr.iosxr_logging_module: + + +************************* +cisco.iosxr.iosxr_logging +************************* + +**Configuration management of system logging services on network devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module provides declarative management configuration of system logging (syslog) on Cisco IOS XR devices. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- ncclient >= 0.5.3 when using netconf +- lxml >= 4.1.1 when using netconf + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ aggregate + +
+ list + / elements=dictionary +
+ 		+ +
List of syslog logging configuration definitions.
+
+
+ dest + +
+ string +
+ 		+
    Choices: +
  • host
    • +
  • console
    • +
  • monitor
    • +
  • buffered
    • +
  • file
    • +
+ 		+
Destination for system logging (syslog) messages.
+
+
+ facility + +
+ string +
+ 		+ +
To configure the type of syslog facility in which system logging (syslog) messages are sent to syslog servers Optional config for dest = host
+
+
+ hostnameprefix + +
+ string +
+ 		+ +
To append a hostname prefix to system logging (syslog) messages logged to syslog servers. Optional config for dest = host
+
+
+ level + +
+ string +
+ 		+
    Choices: +
  • emergencies
    • +
  • alerts
    • +
  • critical
    • +
  • errors
    • +
  • warning
    • +
  • notifications
    • +
  • informational
    • +
  • debugging
    • +
+ 		+
Specifies the severity level for the logging.
+

aliases: severity
+
+
+ name + +
+ string +
+ 		+ +
When dest = file name indicates file-name
+
When dest = host name indicates the host-name or ip-address of syslog server.
+
+
+ size + +
+ integer +
+ 		+ +
Size of buffer when dest = buffered. The acceptable value is in the range 307200 to 125000000 bytes. Default 307200
+
Size of file when dest = file. The acceptable value is in the range 1 to 2097152KB. Default 2 GB
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
Existential state of the logging configuration on the node.
+
+
+ vrf + +
+ string +
+ 		+ +
vrf name when syslog server is configured, dest = host
+
+
+ dest + +
+ string +
+ 		+
    Choices: +
  • host
    • +
  • console
    • +
  • monitor
    • +
  • buffered
    • +
  • file
    • +
+ 		+
Destination for system logging (syslog) messages.
+
+
+ facility + +
+ string +
+ 		+ Default:
"local7"
+ 		+
To configure the type of syslog facility in which system logging (syslog) messages are sent to syslog servers Optional config for dest = host
+
+
+ hostnameprefix + +
+ string +
+ 		+ +
To append a hostname prefix to system logging (syslog) messages logged to syslog servers. Optional config for dest = host
+
+
+ level + +
+ string +
+ 		+
    Choices: +
  • emergencies
    • +
  • alerts
    • +
  • critical
    • +
  • errors
    • +
  • warning
    • +
  • notifications
    • +
  • informational
    • +
  • debugging ←
    • +
+ 		+
Specifies the severity level for the logging.
+

aliases: severity
+
+
+ name + +
+ string +
+ 		+ +
When dest = file name indicates file-name
+
When dest = host name indicates the host-name or ip-address of syslog server.
+
+
+ provider + +
+ dictionary +
+ 		+ +
Deprecated
+
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
For more information please see the Network Guide.
+
+
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ port + +
+ integer +
+ 		+ +
Specifies the port to use when building the connection to the remote device.
+
+
+ ssh_keyfile + +
+ path +
+ 		+ +
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
+
+
+ timeout + +
+ integer +
+ 		+ +
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
+
+
+ transport + +
+ string +
+ 		+
    Choices: +
  • cli ←
    • +
  • netconf
    • +
+ 		+
Specifies the type of connection based transport.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ size + +
+ integer +
+ 		+ +
Size of buffer when dest = buffered. The acceptable value is in the range 307200 to 125000000 bytes. Default 307200
+
Size of file when dest = file. The acceptable value is in the range 1 to 2097152KB. Default 2 GB
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Existential state of the logging configuration on the node.
+
+
+ vrf + +
+ string +
+ 		+ Default:
"default"
+ 		+
vrf name when syslog server is configured, dest = host
+
+
+ + +Notes +----- + +.. note:: + - This module works with connection ``network_cli`` and ``netconf``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_. + - Tested against IOS XRv 6.1.3 + - For more information on using Ansible to manage network devices see 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 logging for syslog server host + cisco.iosxr.iosxr_logging: + dest: host + name: 10.10.10.1 + level: critical + state: present + + - name: add hostnameprefix configuration + cisco.iosxr.iosxr_logging: + hostnameprefix: host1 + state: absent + + - name: add facility configuration + cisco.iosxr.iosxr_logging: + facility: local1 + state: present + + - name: configure console logging level + cisco.iosxr.iosxr_logging: + dest: console + level: debugging + state: present + + - name: configure monitor logging level + cisco.iosxr.iosxr_logging: + dest: monitor + level: errors + state: present + + - name: configure syslog to a file + cisco.iosxr.iosxr_logging: + dest: file + name: file_name + size: 2048 + level: errors + state: present + + - name: configure buffered logging with size + cisco.iosxr.iosxr_logging: + dest: buffered + size: 5100000 + + - name: Configure logging using aggregate + cisco.iosxr.iosxr_logging: + aggregate: + - {dest: console, level: warning} + - {dest: buffered, size: 4800000} + - {dest: file, name: file3, size: 2048} + - {dest: host, name: host3, level: critical} + + - name: Delete logging using aggregate + cisco.iosxr.iosxr_logging: + aggregate: + - {dest: console, level: warning} + - {dest: buffered, size: 4800000} + - {dest: file, name: file3, size: 2048} + - {dest: host, name: host3, level: critical} + 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 (empty list when no commands to send) +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['logging 10.10.10.1 vrf default severity debugging', 'logging facility local7', 'logging hostnameprefix host1', 'logging console critical', 'logging buffered 2097153', 'logging buffered warnings', 'logging monitor errors', 'logging file log_file maxfilesize 1024 severity info']
+
+
+ xml + +
+ list +
+ 		always (empty list when no xml rpc to send) +
NetConf rpc xml sent to device with transport netconf
+
+
Sample:
+
['<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0"> <syslog xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-infra-syslog-cfg"> <files> <file xc:operation="delete"> <file-name>file1</file-name> <file-log-attributes> <max-file-size>2097152</max-file-size> <severity>2</severity> </file-log-attributes> </file> </files> </syslog> </config>']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) +- Kedar Kekan (@kedarX) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_netconf.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_netconf.rst new file mode 100644 index 00000000..927cb82a --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_netconf.rst @@ -0,0 +1,76 @@ +.. _cisco.iosxr.iosxr_netconf: + + +***************** +cisco.iosxr.iosxr +***************** + +**Use iosxr netconf plugin to run netconf commands on Cisco IOSXR platform** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This iosxr plugin provides low level abstraction apis for sending and receiving netconf commands from Cisco iosxr network devices. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + +
ParameterChoices/DefaultsConfigurationComments
+
+ ncclient_device_handler + +
+ string +
+ 		+ Default:
"iosxr"
+ 		+ +
Specifies the ncclient device handler name for Cisco iosxr network os. To identify the ncclient device handler name refer ncclient library documentation.
+
+
+ + + + + + + + +Status +------ + + +Authors +~~~~~~~ + +- Ansible Networking Team + + +.. hint:: + Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_netconf_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_netconf_module.rst new file mode 100644 index 00000000..a1078284 --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_netconf_module.rst @@ -0,0 +1,296 @@ +.. _cisco.iosxr.iosxr_netconf_module: + + +************************* +cisco.iosxr.iosxr_netconf +************************* + +**Configures NetConf sub-system service on Cisco IOS-XR devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module provides an abstraction that enables and configures the netconf system service running on Cisco IOS-XR Software. This module can be used to easily enable the Netconf API. Netconf provides a programmatic interface for working with configuration and state resources as defined in RFC 6242. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ netconf_port + +
+ integer +
+ 		+ Default:
830
+ 		+
This argument specifies the port the netconf service should listen on for SSH connections. The default port as defined in RFC 6242 is 830.
+

aliases: listens_on
+
+
+ netconf_vrf + +
+ string +
+ 		+ Default:
"default"
+ 		+
netconf vrf name
+

aliases: vrf
+
+
+ provider + +
+ dictionary +
+ 		+ +
Deprecated
+
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
For more information please see the Network Guide.
+
+
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ port + +
+ integer +
+ 		+ +
Specifies the port to use when building the connection to the remote device.
+
+
+ ssh_keyfile + +
+ path +
+ 		+ +
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
+
+
+ timeout + +
+ integer +
+ 		+ +
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
+
+
+ transport + +
+ string +
+ 		+
    Choices: +
  • cli ←
    • +
  • netconf
    • +
+ 		+
Specifies the type of connection based transport.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specifies the state of the iosxr_netconf resource on the remote device. If the state argument is set to present the netconf service will be configured. If the state argument is set to absent the netconf service will be removed from the configuration.
+
+
+ + +Notes +----- + +.. note:: + - This module works with connection ``network_cli``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_. + - Tested against Cisco IOS XR Software, Version 6.1.3 + - For more information on using Ansible to manage network devices see 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 netconf service on port 830 + cisco.iosxr.iosxr_netconf: + listens_on: 830 + state: present + + - name: disable netconf service + cisco.iosxr.iosxr_netconf: + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ string +
+ 		when changed is True +
Returns the command sent to the remote device
+
+
Sample:
+
ssh server netconf port 830
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Kedar Kekan (@kedarX) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_ospf_interfaces_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_ospf_interfaces_module.rst new file mode 100644 index 00000000..d7497835 --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_ospf_interfaces_module.rst @@ -0,0 +1,3089 @@ +.. _cisco.iosxr.iosxr_ospf_interfaces_module: + + +********************************* +cisco.iosxr.iosxr_ospf_interfaces +********************************* + +**OSPF Interfaces Resource Module.** + + +Version added: 1.2.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages OSPF(v2/v3) configuration of interfaces on devices running Cisco IOS-XR. + + + + +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.
+
+
+ apply_group_option + +
+ dictionary +
+ 		+ +
Specify configuration from a group
+
+
+ group_name + +
+ string +
+ 		+ +
Specify the name of the group
+
+
+ operation + +
+ string +
+ 		+
    Choices: +
  • add
    • +
  • remove
    • +
  • append
    • +
+ 		+
Specify the group config operation
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Enable authentication
+
+
+ message_digest + +
+ dictionary +
+ 		+ +
Use message-digest authentication
+
+
+ keychain + +
+ string +
+ 		+ +
Specify keychain name
+
+
+ null_auth + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use no authentication
+
+
+ authentication_key + +
+ dictionary +
+ 		+ +
Specify authentication password (key)
+
+
+ clear + +
+ string +
+ 		+ +
Specifies an UNENCRYPTED password (key) will follow
+
+
+ encrypted + +
+ string +
+ 		+ +
Specifies an ENCRYPTED password (key) will follow
+
+
+ password + +
+ string +
+ 		+ +
The OSPFv2 password (key)
+
+
+ bfd + +
+ dictionary +
+ 		+ +
Configure BFD parameters
+
+
+ fast_detect + +
+ dictionary +
+ 		+ +
Configure fast detection
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable fast detection only
+
+
+ strict_mode + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Hold down neighbor session until BFD session is up
+
+
+ minimum_interval + +
+ integer +
+ 		+ +
Hello interval in milli-seconds
+
+
+ multiplier + +
+ integer +
+ 		+ +
Detect multiplier
+
+
+ cost + +
+ integer +
+ 		+ +
Specify Interface cost
+
+
+ cost_fallback + +
+ dictionary +
+ 		+ +
Specify Cost when cumulative bandwidth goes below the theshold
+
+
+ cost + +
+ integer +
+ 		+ +
Specify cost w.r.t cummulative bandwidth
+
+
+ threshold + +
+ integer +
+ 		+ +
Specify threshold bandwidth when cost-fallback is applied
+
+
+ database_filter + +
+ dictionary +
+ 		+ +
Filter OSPF LSAs during synchronization and flooding
+
+
+ all_outgoing_lsa + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Filter all outgoing LSA
+
+
+ dead_interval + +
+ integer +
+ 		+ +
Specify interval after which a neighbor is declared dead
+
+
+ demand_circuit + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable demand circuits
+
+
+ fast_reroute + +
+ dictionary +
+ 		+ +
Specify IP Fast Reroute
+
+
+ disabled + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable IP fast reroute
+
+
+ per_link + +
+ dictionary +
+ 		+ +
Specify per-prefix computation
+
+
+ information_type + +
+ string +
+ 		+
    Choices: +
  • exclude
    • +
  • lfa_candidate
    • +
+ 		+
Specify per-link LFA exclusion or FRR LFA candidate information
+
+
+ interface + +
+ dictionary +
+ 		+ +
Specify Per-link LFA exclusion information
+
+
+ bundle_ether + +
+ list + / elements=dictionary +
+ 		+ +
Specify Aggregated Ethernet interface(s)
+
+
+ name + +
+ integer +
+ 		+ +
Specify the interface id
+
+
+ bvi + +
+ list + / elements=dictionary +
+ 		+ +
Specify Bridge-Group Virtual Interface
+
+
+ name + +
+ integer +
+ 		+ +
Specify the interface id
+
+
+ fast_ethernet + +
+ list + / elements=dictionary +
+ 		+ +
Specify FastEthernet/IEEE 802.3 interface(s)
+
+
+ name + +
+ string +
+ 		+ +
Specify the interface id
+
+
+ fiftygige + +
+ list + / elements=dictionary +
+ 		+ +
Specify FiftyGigE/IEEE 802.3 interface(s)
+
+
+ name + +
+ string +
+ 		+ +
Specify the interface id
+
+
+ fortygige + +
+ list + / elements=dictionary +
+ 		+ +
Specify FortyGigE/IEEE 802.3 interface(s)
+
+
+ name + +
+ string +
+ 		+ +
Specify the interface id
+
+
+ fourhundredgige + +
+ list + / elements=dictionary +
+ 		+ +
Specify FourHundredGigE/IEEE 802.3 interface(s)
+
+
+ name + +
+ string +
+ 		+ +
Specify the interface id
+
+
+ gigabitethernet + +
+ list + / elements=dictionary +
+ 		+ +
Specify GigabitEthernet/IEEE 802.3 interface(s)
+
+
+ name + +
+ string +
+ 		+ +
Specify the interface id
+
+
+ hundredgige + +
+ list + / elements=dictionary +
+ 		+ +
Specify HundredGigE/IEEE 802.3 interface(s)
+
+
+ name + +
+ string +
+ 		+ +
Specify the interface id
+
+
+ mgmteth + +
+ list + / elements=dictionary +
+ 		+ +
Specify MgmtEth/IEEE 802.3 interface(s)
+
+
+ name + +
+ string +
+ 		+ +
Specify the interface id
+
+
+ multilink + +
+ list + / elements=dictionary +
+ 		+ +
Specify Multilink network interface(s)
+
+
+ name + +
+ string +
+ 		+ +
Specify the interface id
+
+
+ nve + +
+ list + / elements=dictionary +
+ 		+ +
Specify Network Virtualization Endpoint Interface(s)
+
+
+ name + +
+ integer +
+ 		+ +
Specify the interface id
+
+
+ pos_int + +
+ list + / elements=dictionary +
+ 		+ +
Specify Aggregated pos interface(s)
+
+
+ name + +
+ integer +
+ 		+ +
Specify the interface id
+
+
+ pw_ether + +
+ list + / elements=dictionary +
+ 		+ +
Specify PWHE Ethernet Interface
+
+
+ name + +
+ integer +
+ 		+ +
Specify the interface id
+
+
+ pw_iw + +
+ list + / elements=dictionary +
+ 		+ +
Specify PWHE VC11 IP Interworking Interface
+
+
+ name + +
+ integer +
+ 		+ +
Specify the interface id
+
+
+ serial + +
+ list + / elements=dictionary +
+ 		+ +
Specify Serial network interface(s)
+
+
+ name + +
+ string +
+ 		+ +
Specify the interface id
+
+
+ srp + +
+ list + / elements=dictionary +
+ 		+ +
Specify SRP interface(s)
+
+
+ name + +
+ string +
+ 		+ +
Specify the interface id
+
+
+ tengige + +
+ list + / elements=dictionary +
+ 		+ +
Specify TenGigabitEthernet/IEEE 802.3 interface(s)
+
+
+ name + +
+ string +
+ 		+ +
Specify the interface id
+
+
+ tunnel_ip + +
+ list + / elements=dictionary +
+ 		+ +
Specify GRE/IPinIP Tunnel Interface(s)
+
+
+ name + +
+ integer +
+ 		+ +
Specify the interface id
+
+
+ tunnel_ipsec + +
+ list + / elements=dictionary +
+ 		+ +
Specify IPSec Tunnel interface(s)
+
+
+ name + +
+ integer +
+ 		+ +
Specify the interface id
+
+
+ tunnel_mpls + +
+ list + / elements=dictionary +
+ 		+ +
MPLS Transport Protocol Tunnel interface
+
+
+ name + +
+ string +
+ 		+ +
Specify the interface id
+
+
+ tunnel_mte + +
+ list + / elements=dictionary +
+ 		+ +
Specify MPLS Traffic Engineering P2MP Tunnel interface(s)
+
+
+ name + +
+ integer +
+ 		+ +
Specify the interface id
+
+
+ twentyfivegige + +
+ list + / elements=dictionary +
+ 		+ +
Specify TwentyFiveGigabitEthernet/IEEE 802.3 interface(s)
+
+
+ name + +
+ string +
+ 		+ +
Specify the interface id
+
+
+ twohundredgige + +
+ list + / elements=dictionary +
+ 		+ +
Specify TwoHundredGigE/IEEE 802.3 interface(s)
+
+
+ name + +
+ string +
+ 		+ +
Specify the interface id
+
+
+ use_candidate_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable backup selection from candidate-list only
+
+
+ flood_reduction + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable flood reduction
+
+
+ hello_interval + +
+ integer +
+ 		+ +
Specify Time between HELLO packets
+
+
+ link_down_fast_detect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure interface down parameters
+
+
+ message_digest_key + +
+ dictionary +
+ 		+ +
Message digest authentication password (key)
+
+
+ id + +
+ integer + / required +
+ 		+ +
Key ID
+
+
+ md5 + +
+ dictionary + / required +
+ 		+ +
Use MD5 Algorithm
+
+
+ clear + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specifies an UNENCRYPTED password (key) will follow
+
+
+ encrypted + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specifies an ENCRYPTED password (key) will follow
+
+
+ password + +
+ string +
+ 		+ +
The OSPFv2 password (key)
+
+
+ mpls_ldp_sync + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable MPLS LDP Sync
+
+
+ mtu_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable ignoring of MTU in DBD packets
+
+
+ neighbors + +
+ list + / elements=dictionary +
+ 		+ +
Specify a neighbor routers
+
+
+ cost + +
+ integer +
+ 		+ +
Specify OSPF cost for point-to-multipoint neighbor
+
+
+ db_filter_all_out + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specify Filter OSPF LSA during synchronization and flooding for point-to-multipoint neighbor
+
+
+ neighbor_id + +
+ string +
+ 		+ +
Specify Neighbor address (name)
+
+
+ poll_interval + +
+ integer +
+ 		+ +
Specify OSPF dead-router polling interval
+
+
+ priority + +
+ integer +
+ 		+ +
Specify OSPF priority of non-broadcast neighbor
+
+
+ network + +
+ string +
+ 		+
    Choices: +
  • broadcast
    • +
  • non-broadcast
    • +
  • point-to-multipoint
    • +
  • point-to-point
    • +
+ 		+
Specify Network type
+
+
+ packet_size + +
+ integer +
+ 		+ +
Customize size of OSPF packets upto MTU
+
+
+ passive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable passive
+
+
+ prefix_suppression + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress advertisement of the prefixes
+
+
+ priority + +
+ integer +
+ 		+ +
Specify Router priority
+
+
+ processes + +
+ list + / elements=dictionary +
+ 		+ +
Interfaces configuration for an OSPF process.
+
+
+ area + +
+ dictionary +
+ 		+ +
Specify the area-id
+
+
+ area_id + +
+ string +
+ 		+ +
OSPF interfaces area ID as a decimal value. Please refer vendor documentation of Valid values.
+
OSPF interfaces area ID in IP address format(e.g. A.B.C.D)
+
+
+ process_id + +
+ string + / required +
+ 		+ +
OSPF process tag.
+
+
+ retransmit_interval + +
+ integer +
+ 		+ +
Specify time between retransmitting lost link state advertisements
+
+
+ security_ttl + +
+ dictionary +
+ 		+ +
Enable security
+
+
+ hops + +
+ integer +
+ 		+ +
Maximum number of IP hops allowed <1-254>
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable ttl security
+
+
+ transmit_delay + +
+ integer +
+ 		+ +
Specify estimated time needed to send link-state update packet
+
+
+ name + +
+ string + / required +
+ 		+ +
Name/Identifier of the interface.
+
+
+ type + +
+ string + / required +
+ 		+ +
Type 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 IOS-XR device by executing the command show running-config 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 IOS-XR 6.1.3 + - This module works with connection ``network_cli``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_ + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + # RP/0/RP0/CPU0:anton#show running-config router ospf + # % No such configuration item(s) + # + + - name: Merge provided OSPF interfaces configuration with the existing configuration + cisco.iosxr.iosxr_ospf_interfaces: + config: + - name: GigabitEthernet0/0/0/0 + type: gigabitethernet + address_family: + - afi: ipv4 + processes: + - process_id: "LAB3" + area: + area_id: 0.0.0.3 + cost: 20 + authentication: + message_digest: + keychain: cisco + - afi: ipv6 + processes: + - process_id: "LAB3" + area: + area_id: 0.0.0.2 + cost: 30 + state: merged + + # + # + # ------------------------ + # Module Execution Result + # ------------------------ + # + # "before": [] + # + # "commands": [ + # "router ospf LAB3 area 0.0.0.3 interface GigabitEthernet 0/0/0/0 cost 20", + # "router ospf LAB3 area 0.0.0.3 interface GigabitEthernet 0/0/0/0 authentication message-digest", + # "router ospf LAB3 area 0.0.0.3 interface GigabitEthernet 0/0/0/0 authentication message-digest keychain cisco", + # "router ospfv3 LAB3 area 0.0.0.2 interface GigabitEthernet 0/0/0/0 cost 30" + # ] + # + # "after": [ + # { + # "address_family": [ + # { + # "afi": "ipv4", + # "authentication": { + # "message_digest": { + # "keychain": "cisco" + # } + # }, + # "cost": 20, + # "processes": [ + # { + # "area": { + # "area_id": "0.0.0.3" + # }, + # "process_id": "LAB3" + # } + # ] + # }, + # { + # "afi": "ipv6", + # "cost": 30, + # "processes": [ + # { + # "area": { + # "area_id": "0.0.0.2" + # }, + # "process_id": "LAB3" + # } + # ] + # } + # ], + # "name": "GigabitEthernet0/0/0/0", + # "type": "gigabitethernet" + # } + # ] + # + # + # ------------ + # After state + # ------------ + # + # RP/0/0/CPU0:an-iosxr-02#show running-config router ospf + # Thu Oct 23 06:00:57.217 UTC + # router ospf LAB + # area 0.0.0.0 + # ! + # area 0.0.0.9 + # ! + # ! + # router ospf LAB1 + # area 0.0.0.1 + # ! + # area 0.0.0.3 + # ! + # ! + # router ospf LAB3 + # area 0.0.0.3 + # interface GigabitEthernet0/0/0/0 + # cost 20 + # authentication message-digest keychain cisco + # ! + # ! + # ! + # router ospf ipv4 + # ! + + # Using replaced + # + # ------------ + # Before state + # ------------ + # + # + # RP/0/0/CPU0:an-iosxr-02#show running-config router ospf + # Thu Oct 23 06:00:57.217 UTC + # router ospf LAB + # area 0.0.0.0 + # ! + # area 0.0.0.9 + # ! + # ! + # router ospf LAB1 + # area 0.0.0.1 + # ! + # area 0.0.0.3 + # ! + # ! + # router ospf LAB3 + # area 0.0.0.3 + # interface GigabitEthernet0/0/0/0 + # cost 20 + # authentication message-digest keychain cisco + # ! + # ! + # ! + # router ospf ipv4 + # ! + + - name: Replace OSPF interfaces configuration + cisco.iosxr.iosxr_ospf_interfaces: + config: + - name: GigabitEthernet0/0/0/0 + type: gigabitethernet + address_family: + - afi: ipv4 + processes: + - process_id: "LAB3" + area: + area_id: 0.0.0.3 + cost: 30 + authentication: + message_digest: + keychain: ciscoiosxr + - afi: ipv6 + processes: + - process_id: "LAB3" + area: + area_id: 0.0.0.2 + cost: 30 + state: replaced + + # + # + # ------------------------ + # Module Execution Result + # ------------------------ + # + # "before": [ + # { + # "address_family": [ + # { + # "afi": "ipv4", + # "authentication": { + # "message_digest": { + # "keychain": "cisco" + # } + # }, + # "cost": 20, + # "processes": [ + # { + # "area": { + # "area_id": "0.0.0.3" + # }, + # "process_id": "LAB3" + # } + # ] + # }, + # { + # "afi": "ipv6", + # "cost": 30, + # "processes": [ + # { + # "area": { + # "area_id": "0.0.0.2" + # }, + # "process_id": "LAB3" + # } + # ] + # } + # ], + # "name": "GigabitEthernet0/0/0/0", + # "type": "gigabitethernet" + # } + # ] + # + # "commands": [ + # "router ospf LAB3 area 0.0.0.3 interface GigabitEthernet 0/0/0/0 cost 30", + # "router ospf LAB3 area 0.0.0.3 interface GigabitEthernet 0/0/0/0 authentication message-digest", + # "router ospf LAB3 area 0.0.0.3 interface GigabitEthernet 0/0/0/0 authentication message-digest keychain ciscoiosxr" + # ] + # + # "after": [ + # { + # "address_family": [ + # { + # "afi": "ipv4", + # "authentication": { + # "message_digest": { + # "keychain": "ciscoiosxr" + # } + # }, + # "cost": 30, + # "processes": [ + # { + # "area": { + # "area_id": "0.0.0.3" + # }, + # "process_id": "LAB3" + # } + # ] + # }, + # { + # "afi": "ipv6", + # "cost": 30, + # "processes": [ + # { + # "area": { + # "area_id": "0.0.0.2" + # }, + # "process_id": "LAB3" + # } + # ] + # } + # ], + # "name": "GigabitEthernet0/0/0/0", + # "type": "gigabitethernet" + # } + # ] + # + # + # ----------- + # After state + # ----------- + # + # RP/0/0/CPU0:an-iosxr-02#show running-config router ospf + # Thu Oct 23 06:10:39.827 UTC + # router ospf LAB + # area 0.0.0.0 + # ! + # area 0.0.0.9 + # ! + # ! + # router ospf LAB1 + # area 0.0.0.1 + # ! + # area 0.0.0.3 + # ! + # ! + # router ospf LAB3 + # area 0.0.0.3 + # interface GigabitEthernet0/0/0/0 + # cost 30 + # authentication message-digest keychain ciscoiosxr + # ! + # ! + # ! + # router ospf ipv4 + # ! + + - name: Override existing OSPF interfaces configuration + cisco.iosxr.iosxr_ospf_interfaces: + config: + - name: GigabitEthernet0/0/0/1 + type: gigabitethernet + address_family: + - afi: ipv4 + processes: + - process_id: "LAB1" + area: + area_id: 0.0.0.3 + cost: 10 + authentication: + message_digest: + keychain: iosxr + state: overridden + + # + # + # ------------------------ + # Module Execution Result + # ------------------------ + # + # "before": [ + # { + # "address_family": [ + # { + # "afi": "ipv4", + # "authentication": { + # "message_digest": { + # "keychain": "ciscoiosxr" + # } + # }, + # "cost": 30, + # "processes": [ + # { + # "area": { + # "area_id": "0.0.0.3" + # }, + # "process_id": "LAB3" + # } + # ] + # }, + # { + # "afi": "ipv6", + # "cost": 30, + # "processes": [ + # { + # "area": { + # "area_id": "0.0.0.2" + # }, + # "process_id": "LAB3" + # } + # ] + # } + # ], + # "name": "GigabitEthernet0/0/0/0", + # "type": "gigabitethernet" + # } + # ] + # + # "commands": [ + # "no router ospf LAB3 area 0.0.0.3 interface GigabitEthernet 0/0/0/0", + # "no router ospfv3 LAB3 area 0.0.0.2 interface GigabitEthernet 0/0/0/0", + # "router ospf LAB1 area 0.0.0.3 interface GigabitEthernet 0/0/0/1 cost 10", + # "router ospf LAB1 area 0.0.0.3 interface GigabitEthernet 0/0/0/1 authentication message-digest", + # "router ospf LAB1 area 0.0.0.3 interface GigabitEthernet 0/0/0/1 authentication message-digest keychain iosxr" + # ] + # + # "after": [ + # { + # "address_family": [ + # { + # "afi": "ipv4", + # "authentication": { + # "message_digest": { + # "keychain": "iosxr" + # } + # }, + # "cost": 10, + # "processes": [ + # { + # "area": { + # "area_id": "0.0.0.3" + # }, + # "process_id": "LAB1" + # } + # ] + # } + # ], + # "name": "GigabitEthernet0/0/0/1", + # "type": "gigabitethernet" + # } + # ] + # + # + # ----------- + # After state + # ----------- + # + # RP/0/0/CPU0:an-iosxr-02#show running-config router ospf + # Thu Oct 23 06:28:15.025 UTC + # router ospf LAB + # area 0.0.0.0 + # ! + # area 0.0.0.9 + # ! + # ! + # router ospf LAB1 + # area 0.0.0.1 + # ! + # area 0.0.0.3 + # interface GigabitEthernet0/0/0/1 + # cost 10 + # authentication message-digest keychain iosxr + # ! + # ! + # ! + # router ospf LAB3 + # area 0.0.0.3 + # ! + # ! + # router ospf ipv4 + # ! + + # Using deleted + # + # ------------ + # Before state + # ------------ + # + # + # RP/0/0/CPU0:an-iosxr-02#show running-config router ospf + # Thu Oct 23 06:28:15.025 UTC + # router ospf LAB + # area 0.0.0.0 + # ! + # area 0.0.0.9 + # ! + # ! + # router ospf LAB1 + # area 0.0.0.1 + # ! + # area 0.0.0.3 + # interface GigabitEthernet0/0/0/1 + # cost 10 + # authentication message-digest keychain iosxr + # ! + # ! + # ! + # router ospf LAB3 + # area 0.0.0.3 + # ! + # ! + # router ospf ipv4 + # ! + + - name: Deleted existing OSPF interfaces from the device + cisco.iosxr.iosxr_ospf_interfaces: + config: + - name: GigabitEthernet0/0/0/1 + type: gigabitethernet + state: deleted + + # + # + # ------------------------ + # Module Execution Result + # ------------------------ + # + # "before": [ + # { + # "address_family": [ + # { + # "afi": "ipv4", + # "authentication": { + # "message_digest": { + # "keychain": "iosxr" + # } + # }, + # "cost": 10, + # "processes": [ + # { + # "area": { + # "area_id": "0.0.0.3" + # }, + # "process_id": "LAB1" + # } + # ] + # } + # ], + # "name": "GigabitEthernet0/0/0/1", + # "type": "gigabitethernet" + # } + # ], + # + # "commands": [ + # "no router ospf LAB1 area 0.0.0.3 interface GigabitEthernet 0/0/0/1" + # ] + # + # "after": [] + # + # + # ----------- + # After state + # ----------- + # + # RP/0/0/CPU0:an-iosxr-02#show running-config router ospf + # Thu Oct 23 06:34:38.319 UTC + # router ospf LAB + # area 0.0.0.0 + # ! + # area 0.0.0.9 + # ! + # ! + # router ospf LAB1 + # area 0.0.0.1 + # ! + # area 0.0.0.3 + # ! + # ! + # router ospf LAB3 + # area 0.0.0.3 + # ! + # ! + # router ospf ipv4 + # ! + + # Using parsed + # parsed.cfg + # ------------ + # router ospf LAB + # area 0.0.0.0 + # ! + # area 0.0.0.9 + # ! + # ! + # router ospf LAB1 + # area 0.0.0.1 + # ! + # area 0.0.0.3 + # ! + # ! + # router ospf LAB3 + # area 0.0.0.3 + # interface GigabitEthernet0/0/0/0 + # cost 20 + # authentication message-digest keychain cisco + # ! + # ! + # ! + # router ospf ipv4 + # ! + - name: Parsed the device configuration to get output commands + cisco.iosxr.iosxr_ospf_interfaces: + running_config: "{{ lookup('file', './parsed.cfg') }}" + state: parsed + # + # + # ------------------------- + # Module Execution Result + # ------------------------- + # + # + # "parsed": [ + # { + # "address_family": [ + # { + # "afi": "ipv4", + # "authentication": { + # "message_digest": { + # "keychain": "cisco" + # } + # }, + # "cost": 20, + # "processes": [ + # { + # "area": { + # "area_id": "0.0.0.3" + # }, + # "process_id": "LAB3" + # } + # ] + # } + # ], + # "name": "GigabitEthernet0/0/0/0", + # "type": "gigabitethernet" + # } + # ] + # + # Using rendered + # + # + - name: Render the commands for provided configuration + cisco.iosxr.iosxr_ospf_interfaces: + config: + - name: GigabitEthernet0/0/0/0 + type: gigabitethernet + address_family: + - afi: ipv4 + processes: + - process_id: "LAB3" + area: + area_id: 0.0.0.3 + cost: 20 + authentication: + message_digest: + keychain: cisco + - afi: ipv6 + processes: + - process_id: "LAB3" + area: + area_id: 0.0.0.2 + cost: 30 + state: rendered + + # + # + # ------------------------- + # Module Execution Result + # ------------------------- + # + # + # "rendered": [ + # "router ospf LAB3 area 0.0.0.3 interface GigabitEthernet 0/0/0/0 cost 20", + # "router ospf LAB3 area 0.0.0.3 interface GigabitEthernet 0/0/0/0 authentication message-digest", + # "router ospf LAB3 area 0.0.0.3 interface GigabitEthernet 0/0/0/0 authentication message-digest keychain cisco", + # "router ospfv3 LAB3 area 0.0.0.2 interface GigabitEthernet 0/0/0/0 cost 30" + # ] + + + # Using gathered + # + # Before state: + # ------------- + # + # RP/0/0/CPU0:an-iosxr-02#show running-config router ospf + # Thu Oct 23 06:50:38.743 UTC + # router ospf LAB + # area 0.0.0.0 + # ! + # area 0.0.0.9 + # ! + # ! + # router ospf LAB1 + # area 0.0.0.1 + # ! + # area 0.0.0.3 + # ! + # ! + # router ospf LAB3 + # area 0.0.0.3 + # interface GigabitEthernet0/0/0/0 + # cost 20 + # authentication message-digest keychain cisco + # ! + # ! + # ! + # router ospf ipv4 + # ! + + + - name: Gather ospf_interfaces routes configuration + cisco.iosxr.iosxr_ospf_interfaces: + state: gathered + # + # + # ------------------------- + # Module Execution Result + # ------------------------- + # + # "gathered": [ + # { + # "address_family": [ + # { + # "afi": "ipv4", + # "authentication": { + # "message_digest": { + # "keychain": "cisco" + # } + # }, + # "cost": 20, + # "processes": [ + # { + # "area": { + # "area_id": "0.0.0.3" + # }, + # "process_id": "LAB3" + # } + # ] + # }, + # { + # "afi": "ipv6", + # "cost": 30, + # "processes": [ + # { + # "area": { + # "area_id": "0.0.0.2" + # }, + # "process_id": "LAB3" + # } + # ] + # } + # ], + # "name": "GigabitEthernet0/0/0/0", + # "type": "gigabitethernet" + # } + # ] + # + + + + +Status +------ + + +Authors +~~~~~~~ + +- Rohit Thakur (@rohitthakur2590) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_ospfv2_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_ospfv2_module.rst new file mode 100644 index 00000000..5cdfbd84 --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_ospfv2_module.rst @@ -0,0 +1,7069 @@ +.. _cisco.iosxr.iosxr_ospfv2_module: + + +************************ +cisco.iosxr.iosxr_ospfv2 +************************ + +**OSPFv2 resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages global OSPFv2 configuration on devices running Cisco IOS-XR + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A list of OSPFv2 process configuration
+
+
+ processes + +
+ list + / elements=dictionary +
+ 		+ +
A list of OSPFv2 instances configuration
+
+
+ address_family_unicast + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable unicast topology for ipv4 address family
+
+
+ adjacency_stagger + +
+ dictionary +
+ 		+ +
Stagger OSPFv2 adjacency bring up
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable stagger OSPFv2 adjacency
+
+
+ max_adjacency + +
+ integer +
+ 		+ +
Maximum simultaneous neighbors to bring up
+
+
+ min_adjacency + +
+ integer +
+ 		+ +
Initial number of neighbors to bring up per area (default 2)
+
+
+ apply_weight + +
+ dictionary +
+ 		+ +
Enable weights configured under interfaces for load sharing
+
+
+ bandwidth + +
+ integer +
+ 		+ +
Reference bandwidth to use for calculation (Mbits/sec)
+
+
+ default_weight + +
+ integer +
+ 		+ +
Specify default weight value to use when it is not configured under interface
+
+
+ areas + +
+ list + / elements=dictionary +
+ 		+ +
Configure OSPFv2 areas' properties
+
+
+ area_id + +
+ string + / required +
+ 		+ +
Area ID as IP address or integer
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Enable authentication
+
+
+ keychain + +
+ string +
+ 		+ +
Specify keychain name
+
+
+ message_digest + +
+ dictionary +
+ 		+ +
Use message-digest authentication
+
+
+ keychain + +
+ string +
+ 		+ +
Specify keychain name
+
+
+ no_auth + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use no authentication
+
+
+ authentication_key + +
+ dictionary +
+ 		+ +
Used to mention authentication password (key)
+
+
+ clear + +
+ string +
+ 		+ +
Specifies an UNENCRYPTED password (key) will follow
+
+
+ encrypted + +
+ string +
+ 		+ +
Specifies an ENCRYPTED password (key) will follow
+
+
+ password + +
+ string +
+ 		+ +
The OSPFv2 password (key)
+
+
+ bfd + +
+ dictionary +
+ 		+ +
Configure BFD parameters
+
+
+ fast_detect + +
+ dictionary +
+ 		+ +
Configure fast detection
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable fast detection only
+
+
+ strict_mode + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Hold down neighbor session until BFD session is up
+
+
+ minimum_interval + +
+ integer +
+ 		+ +
Hello interval in milli-seconds
+
+
+ multiplier + +
+ integer +
+ 		+ +
Detect multiplier
+
+
+ cost + +
+ integer +
+ 		+ +
Interface cost
+
+
+ dead_interval + +
+ integer +
+ 		+ +
Interval after which a neighbor is declared dead
+
+
+ default_cost + +
+ integer +
+ 		+ +
Set the summary default-cost of a NSSA/stub area. Stub's advertised external route metric
+
+
+ hello_interval + +
+ integer +
+ 		+ +
Time between HELLO packets
+
+
+ mpls + +
+ dictionary +
+ 		+ +
Configure MPLS routing protocol parameters
+
+
+ ldp + +
+ dictionary +
+ 		+ +
Configure LDP parameters
+
+
+ auto_config + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable LDP IGP interface auto-configuration
+
+
+ sync + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable LDP IGP synchronization
+
+
+ sync_igp_shortcuts + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
LDP sync for igp-shortcut tunnels
+
+
+ traffic_eng + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure an ospf area to run MPLS Traffic Engineering
+
+
+ mtu_ignore + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/Disable ignoring of MTU in DBD packets
+
+
+ nssa + +
+ dictionary +
+ 		+ +
NSSA settings for the area
+
+
+ default_information_originate + +
+ dictionary +
+ 		+ +
Originate default Type 7 LSA
+
+
+ metric + +
+ integer +
+ 		+ +
OSPFv2 default metric
+
+
+ metric_type + +
+ integer +
+ 		+ +
Metric type for default routes
+
+
+ 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
+
+
+ ranges + +
+ list + / elements=dictionary +
+ 		+ +
Summarize routes matching address/mask (border routers only)
+
+
+ address + +
+ string + / required +
+ 		+ +
IP in Prefix format (x.x.x.x/len)
+
+
+ advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise this range (default)
+
+
+ not_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
DoNotAdvertise this range
+
+
+ route_policy + +
+ list + / elements=dictionary +
+ 		+ +
Specify the route-policy to filter type 3 LSAs (list can have one inbound and/or one outbound policy only)
+
+
+ direction + +
+ string +
+ 		+
    Choices: +
  • in
    • +
  • out
    • +
+ 		+
Specify inbound or outbound
+
+
+ parameters + +
+ list + / elements=string +
+ 		+ +
Specify parameter values for the policy
+
+
+ stub + +
+ dictionary +
+ 		+ +
Settings for configuring the area as a stub
+
+
+ no_summary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send summary LSA into stub area
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure the area as a stub
+
+
+ transmit_delay + +
+ integer +
+ 		+ +
Estimated time needed to send link-state update packet
+
+
+ virtual_link + +
+ list + / elements=dictionary +
+ 		+ +
Define a virtual link
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Enable authentication
+
+
+ keychain + +
+ string +
+ 		+ +
Specify keychain name
+
+
+ message_digest + +
+ dictionary +
+ 		+ +
Use message-digest authentication
+
+
+ keychain + +
+ string +
+ 		+ +
Specify keychain name
+
+
+ no_auth + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use no authentication
+
+
+ authentication_key + +
+ dictionary +
+ 		+ +
Used to mention authentication password (key)
+
+
+ clear + +
+ string +
+ 		+ +
Specifies an UNENCRYPTED password (key) will follow
+
+
+ encrypted + +
+ string +
+ 		+ +
Specifies an ENCRYPTED password (key) will follow
+
+
+ password + +
+ string +
+ 		+ +
The OSPFv2 password (key)
+
+
+ dead_interval + +
+ integer +
+ 		+ +
Interval after which a neighbor is declared dead
+
+
+ hello_interval + +
+ integer +
+ 		+ +
Time between HELLO packets
+
+
+ id + +
+ string + / required +
+ 		+ +
Router-ID of virtual link neighbor (A.B.C.D)
+
+
+ message_digest_key + +
+ dictionary +
+ 		+ +
Message digest authentication password (key)
+
+
+ id + +
+ integer + / required +
+ 		+ +
Key ID (1-255)
+
+
+ md5 + +
+ dictionary +
+ 		+ +
Use MD5 Algorithm
+
+
+ clear + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specifies an UNENCRYPTED password (key) will follow
+
+
+ encrypted + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specifies an ENCRYPTED password (key) will follow
+
+
+ password + +
+ string +
+ 		+ +
The OSPFv2 password (key)
+
+
+ retransmit_interval + +
+ integer +
+ 		+ +
Delay between LSA retransmissions
+
+
+ transmit_delay + +
+ integer +
+ 		+ +
Link state transmit delay
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Enable authentication
+
+
+ keychain + +
+ string +
+ 		+ +
Specify keychain name
+
+
+ message_digest + +
+ dictionary +
+ 		+ +
Use message-digest authentication
+
+
+ keychain + +
+ string +
+ 		+ +
Specify keychain name
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specify message-digest selection
+
+
+ no_auth + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Use no authentication
+
+
+ authentication_key + +
+ dictionary +
+ 		+ +
Used to mention authentication password (key)
+
+
+ clear + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specifies an UNENCRYPTED password (key) will follow
+
+
+ encrypted + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specifies an ENCRYPTED password (key) will follow
+
+
+ password + +
+ string +
+ 		+ +
The OSPFv2 password (key)
+
+
+ auto_cost + +
+ dictionary +
+ 		+ +
Calculate OSPFv2 interface cost according to bandwidth
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Assign OSPFv2 cost based on interface type
+
+
+ reference_bandwidth + +
+ integer +
+ 		+ +
Specify reference bandwidth in megabits per sec
+
+
+ bfd + +
+ dictionary +
+ 		+ +
Configure BFD parameters
+
+
+ fast_detect + +
+ dictionary +
+ 		+ +
Configure fast detection
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable fast detection only
+
+
+ strict_mode + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Hold down neighbor session until BFD session is up
+
+
+ minimum_interval + +
+ integer +
+ 		+ +
Hello interval in milli-seconds
+
+
+ multiplier + +
+ integer +
+ 		+ +
Detect multiplier
+
+
+ capability + +
+ dictionary +
+ 		+ +
Enable specific OSPFv2 feature
+
+
+ opaque + +
+ dictionary +
+ 		+ +
Configure opaque LSA
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable Opaque LSA capability
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable opaque LSA
+
+
+ type7 + +
+ string +
+ 		+ +
NSSA capability
+
+
+ cost + +
+ integer +
+ 		+ +
Interface cost (1-65535)
+
+
+ database_filter + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Filter OSPFv2 LSA during synchronization and flooding (all outgoing LSA). Enable/Disable filtering
+
+
+ dead_interval + +
+ integer +
+ 		+ +
Interval after which a neighbor is declared dead
+
+
+ default_information_originate + +
+ dictionary +
+ 		+ +
Distribute default route
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always advertise default route
+
+
+ metric + +
+ integer +
+ 		+ +
OSPFv2 default metric
+
+
+ metric_type + +
+ integer +
+ 		+ +
OSPFv2 metric type for default routes
+
+
+ route_policy + +
+ string +
+ 		+ +
Apply route-policy to default-information origination
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable distribution of default route
+
+
+ default_metric + +
+ integer +
+ 		+ +
Set metric of redistributed routes
+
+
+ demand_circuit + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/Disable OSPFv2 demand circuit
+
+
+ distance + +
+ dictionary +
+ 		+ +
Define an administrative distance
+
+
+ admin_distance + +
+ list + / elements=dictionary +
+ 		+ +
Administrative distance
+
+
+ access_list + +
+ string +
+ 		+ +
Access list name
+
+
+ source + +
+ string +
+ 		+ +
Source IP address
+
+
+ value + +
+ integer +
+ 		+ +
Distance value
+
+
+ wildcard + +
+ string +
+ 		+ +
IP wild card bits (A.B.C.D)
+
+
+ ospf_distance + +
+ dictionary +
+ 		+ +
OSPFv2 administrative distance
+
+
+ external + +
+ integer +
+ 		+ +
Distance for external routes
+
+
+ inter_area + +
+ integer +
+ 		+ +
Distance for inter-area routes
+
+
+ intra_area + +
+ integer +
+ 		+ +
Distance for intra-area routes
+
+
+ distribute_bgp_ls + +
+ dictionary +
+ 		+ +
Enable Distribution of LSAs to external services
+
+
+ instance_id + +
+ integer +
+ 		+ +
Set distribution process instance identifier
+
+
+ throttle + +
+ integer +
+ 		+ +
Throttle time between successive LSA updates
+
+
+ distribute_link_state + +
+ dictionary +
+ 		+ +
Enable Distribution of LSAs to external services
+
+
+ instance_id + +
+ integer +
+ 		+ +
Set distribution process instance identifier
+
+
+ throttle + +
+ integer +
+ 		+ +
Throttle time between successive LSA updates
+
+
+ distribute_list + +
+ list + / elements=dictionary +
+ 		+ +
Filter networks in routing updates (list can have one inbound and/or one outbound policy only)
+
+
+ access_list + +
+ string +
+ 		+ +
Inbound/outbound access-list
+
+
+ direction + +
+ string +
+ 		+
    Choices: +
  • in
    • +
  • out
    • +
+ 		+
Filter incoming/outgoing routing updates
+
+
+ outgoing_params + +
+ dictionary +
+ 		+ +
Specify additional parameters for outgoing updates only
+
+
+ id + +
+ string +
+ 		+ +
For BGP, specify AS number. 2-byte AS number (or) 4-byte AS number in asdot (X.Y) format (or) 4-byte AS number in asplain format
+
For OSPF, specify OSPFv2 instance name
+
+
+ route_type + +
+ string +
+ 		+
    Choices: +
  • bgp
    • +
  • connected
    • +
  • dagr
    • +
  • ospf
    • +
  • static
    • +
+ 		+
Type of routes
+
+
+ route_policy + +
+ string +
+ 		+ +
Route Policy to filter OSPFv2 prefixes (for incoming updates only)
+
+
+ external_out + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/Disable advertisement of intra-area prefixes as external
+
+
+ flood_reduction + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/Disable OSPFv2 Flood Reduction
+
+
+ hello_interval + +
+ integer +
+ 		+ +
Time between HELLO packets (<1-65535> seconds)
+
+
+ ignore_lsa_mospf + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not complain upon receiving MOSPFv2 Type 6 LSA
+
+
+ link_down_fast_detect + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable fast or early detection of link-down events
+
+
+ log_adjacency_changes + +
+ dictionary +
+ 		+ +
Log adjacency state changes
+
+
+ detail + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log all state changes
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable log adjacency changes
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set log adjacency
+
+
+ loopback_stub_network + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Advertise loopback as a stub network
+
+
+ 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 number of minutes during which all adjacencies are suppressed
+
+
+ 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 +
+ 		+ +
Set maximum metric
+
+
+ router_lsa + +
+ dictionary +
+ 		+ +
Maximum metric in self-originated router-LSAs
+
+
+ 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
+
+
+ message_digest_key + +
+ dictionary +
+ 		+ +
Message digest authentication password (key)
+
+
+ id + +
+ integer + / required +
+ 		+ +
Key ID
+
+
+ md5 + +
+ dictionary + / required +
+ 		+ +
Use MD5 Algorithm
+
+
+ clear + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specifies an UNENCRYPTED password (key) will follow
+
+
+ encrypted + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specifies an ENCRYPTED password (key) will follow
+
+
+ password + +
+ string +
+ 		+ +
The OSPFv2 password (key)
+
+
+ microloop_avoidance + +
+ dictionary +
+ 		+ +
Avoid microloops
+
+
+ protected + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Avoid microloops for protected prefixes only)
+
+
+ rib_update_delay + +
+ integer +
+ 		+ +
Delay to introduce between SPF and RIB updates
+
+
+ segment_routing + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable segment routing microloop avoidance
+
+
+ monitor_convergence + +
+ dictionary +
+ 		+ +
Enables OSPFv2 route convergence monitoring
+
+
+ prefix_list + +
+ string +
+ 		+ +
Enables Individual Prefix Monitoring
+
+
+ track_external_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables Tracking External(Type-5/7) Prefix monitoring
+
+
+ track_ip_frr + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables Tracking IP-Frr Convergence
+
+
+ track_summary_routes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enables Tracking Summary(Inter-Area) Prefix monitoring
+
+
+ mpls + +
+ dictionary +
+ 		+ +
Configure MPLS routing protocol parameters
+
+
+ ldp + +
+ dictionary +
+ 		+ +
Configure LDP parameters
+
+
+ auto_config + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable LDP IGP interface auto-configuration
+
+
+ sync + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable LDP IGP synchronization
+
+
+ sync_igp_shortcuts + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
LDP sync for igp-shortcut tunnels
+
+
+ traffic_eng + +
+ dictionary +
+ 		+ +
Routing protocol commands for MPLS Traffic Engineering
+
+
+ autoroute_exclude + +
+ dictionary +
+ 		+ +
Exclude IP address destinations from using TE tunnels
+
+
+ parameters + +
+ list + / elements=string +
+ 		+ +
Specify parameter values for the policy
+
+
+ route_policy + +
+ string +
+ 		+ +
Policy name
+
+
+ igp_intact + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Retain one or more IPv4 nexthops with tunnel nexthops
+
+
+ ldp_sync_update + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable LDP sync induced metric propagation
+
+
+ multicast_intact + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Publish multicast-intact paths to RIB
+
+
+ router_id + +
+ string +
+ 		+ +
Traffic Engineering stable IP address for system
+
+
+ mtu_ignore + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/Disable ignoring of MTU in DBD packets
+
+
+ network + +
+ dictionary +
+ 		+ +
Network type
+
+
+ broadcast + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specify OSPFv2 broadcast multi-access network
+
+
+ non_broadcast + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specify OSPFv2 NBMA network
+
+
+ point_to_multipoint + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specify OSPFv2 point-to-multipoint network
+
+
+ point_to_point + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Specify OSPFv2 point-to-point network
+
+
+ nsf + +
+ dictionary +
+ 		+ +
Non-stop forwarding
+
+
+ cisco + +
+ dictionary +
+ 		+ +
Cisco Non-stop forwarding
+
+
+ enforce_global + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Cancel NSF restart when non-NSF-aware neighbors detected for the whole OSPFv2 process
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable Cisco NSF
+
+
+ flush_delay_time + +
+ integer +
+ 		+ +
Maximum time allowed for external route learning
+
+
+ ietf + +
+ dictionary +
+ 		+ +
IETF graceful restart
+
+
+ helper_disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable router's helper support level
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Only enable ietf option
+
+
+ interval + +
+ integer +
+ 		+ +
Minimum interval between NSF restarts (<90-3600> seconds)
+
+
+ lifetime + +
+ integer +
+ 		+ +
Maximum route lifetime following restart (<90-1800> seconds)
+
+
+ nsr + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable NSR for all VRFs in this process. 'False' option to disable NSR for all VRFs in this process
+
+
+ packet_size + +
+ integer +
+ 		+ +
Size of OSPFv2 packets to use. min=576 max=MTU bytes
+
+
+ passive + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/Disable passive
+
+
+ prefix_suppression + +
+ dictionary +
+ 		+ +
Suppress advertisement of the prefixes
+
+
+ secondary_address + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable secondary address suppression
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set the suppression option
+
+
+ priority + +
+ integer +
+ 		+ +
Router priority
+
+
+ process_id + +
+ string + / required +
+ 		+ +
The OSPFv2 Process ID
+
+
+ protocol_shutdown + +
+ dictionary +
+ 		+ +
Protocol specific configuration
+
+
+ host_mode + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Only traffic destined for this box allowed(cisco-support)
+
+
+ limit + +
+ dictionary +
+ 		+ +
High watermark for incoming priority events
+
+
+ high + +
+ integer +
+ 		+ +
Hello events are dropped when incoming event queue exceeds this value
+
+
+ low + +
+ integer +
+ 		+ +
DBD/LS Update/Req packets are dropped when incoming event queue exceeds this value
+
+
+ medium + +
+ integer +
+ 		+ +
LSA ACKs are dropped when incoming event queue exceeds this value
+
+
+ on_reload + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Shutdown post reload only
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Shutdown the OSPFv2 Protocol
+
+
+ redistribute + +
+ dictionary +
+ 		+ +
Redistribute information from another routing Protocol
+
+
+ id + +
+ string +
+ 		+ +
OnePK application name for application routes (or) AS number for bgp and eigrp (or) instance name for isis and ospf
+
+
+ level + +
+ integer +
+ 		+
    Choices: +
  • 1
    • +
  • 2
    • +
  • 12
    • +
+ 		+
ISIS levels
+
+
+ lsa_type_summary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
LSA type 3 for redistributed routes
+
+
+ match + +
+ string +
+ 		+ +
Redistribution of routes. For OSPFv2 - external/internal/nssa-external 1/2. For EIGRP - external/internal
+
+
+ metric + +
+ integer +
+ 		+ +
Metric for redistributed routes
+
+
+ metric_type + +
+ integer +
+ 		+
    Choices: +
  • 1
    • +
  • 2
    • +
+ 		+
OSPFv2 exterior metric type for redistributed routes
+
+
+ nssa_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Redistribute to NSSA areas only
+
+
+ preserve_med + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Preserve med of BGP routes
+
+
+ route_policy + +
+ dictionary +
+ 		+ +
Apply route-policy to redistribution
+
+
+ name + +
+ string +
+ 		+ +
Name of the policy
+
+
+ parameters + +
+ list + / elements=string +
+ 		+ +
Specify parameter values for the policy
+
+
+ route_type + +
+ string +
+ 		+
    Choices: +
  • application
    • +
  • bgp
    • +
  • connected
    • +
  • dagr
    • +
  • eigrp
    • +
  • isis
    • +
  • mobile
    • +
  • ospf
    • +
  • rip
    • +
  • static
    • +
  • subscriber
    • +
+ 		+
Route type to redistribute
+
+
+ tag + +
+ integer +
+ 		+ +
Set tag for routes redistributed into OSPFv2
+
+
+ retransmit_interval + +
+ integer +
+ 		+ +
Delay between LSA retransmissions
+
+
+ router_id + +
+ string +
+ 		+ +
OSPFv2 router-id in IPv4 address format (A.B.C.D)
+
+
+ security_ttl + +
+ dictionary +
+ 		+ +
Enable security
+
+
+ hops + +
+ integer +
+ 		+ +
Maximum number of IP hops allowed <1-254>
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable ttl security
+
+
+ summary_in + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
Enable/Disable advertisement of external prefixes as inter-area
+
+
+ summary_prefix + +
+ list + / elements=dictionary +
+ 		+ +
Configure IP address summaries
+
+
+ not_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress routes that match the specified prefix/mask pair
+
+
+ prefix + +
+ string + / required +
+ 		+ +
IP summary address/mask (A.B.C.D/prefix)
+
+
+ tag + +
+ integer +
+ 		+ +
Set tag
+
+
+ timers + +
+ dictionary +
+ 		+ +
Configure timer related constants
+
+
+ graceful_shutdown + +
+ dictionary +
+ 		+ +
Timers for graceful shutdown(cisco-support)
+
+
+ initial_delay + +
+ integer +
+ 		+ +
Delay before starting graceful shutdown
+
+
+ retain_routes + +
+ integer +
+ 		+ +
Time to keep routes active after graceful shutdown
+
+
+ lsa + +
+ dictionary +
+ 		+ +
OSPFv2 global LSA timers
+
+
+ group_pacing + +
+ integer +
+ 		+ +
OSPFv2 LSA group pacing timer. Interval between group of LSA being refreshed or maxaged
+
+
+ min_arrival + +
+ integer +
+ 		+ +
OSPFv2 MinLSArrival timer. The minimum interval in millisec between accepting the same LSA
+
+
+ refresh + +
+ integer +
+ 		+ +
OSPFv2 LSA refresh interval. How often self-originated LSAs should be refreshed, in seconds
+
+
+ pacing_flood + +
+ integer +
+ 		+ +
OSPFv2 flood pacing timer. Interval in msec to pace flooding on all interfaces
+
+
+ throttle + +
+ dictionary +
+ 		+ +
OSPFv2 throttle timers
+
+
+ fast_reroute + +
+ integer +
+ 		+ +
Fast-reroute throttle timer. Delay between end of SPF and start of the fast-reroute computation in milliseconds
+
+
+ lsa_all + +
+ dictionary +
+ 		+ +
LSA throttle timers for all types of OSPFv2 LSAs
+
+
+ initial_delay + +
+ integer +
+ 		+ +
Delay to generate first occurance of LSA in milliseconds
+
+
+ max_delay + +
+ integer +
+ 		+ +
Maximum delay between originating the same LSA in milliseconds
+
+
+ min_delay + +
+ integer +
+ 		+ +
Minimum delay between originating the same LSA in milliseconds
+
+
+ spf + +
+ dictionary +
+ 		+ +
OSPFv2 SPF throttle timers
+
+
+ change_delay + +
+ integer +
+ 		+ +
Delay between receiving a change to SPF calculation in milliseconds
+
+
+ max_wait + +
+ integer +
+ 		+ +
Maximum wait time in milliseconds for SPF calculations
+
+
+ second_delay + +
+ integer +
+ 		+ +
Delay between first and second SPF calculation in milliseconds
+
+
+ transmit_delay + +
+ integer +
+ 		+ +
Estimated time needed to send link-state update packet
+
+
+ weight + +
+ integer +
+ 		+ +
Interface weight
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the IOS-XR device by executing the command show running-config 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
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
  • overridden
    • +
+ 		+
The state the configuration should be left in.
+
+
+ + +Notes +----- + +.. note:: + - Tested against IOS-XR 6.1.3 + - This module works with connection ``network_cli``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_ + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + # RP/0/RP0/CPU0:anton#show running-config router ospf + # Thu Jun 11 15:54:44.569 UTC + # % No such configuration item(s) + # + + - name: Merge provided OSPFv2 configuration with the existing configuration + cisco.iosxr.iosxr_ospfv2: + config: + processes: + - process_id: '27' + areas: + - area_id: '10' + hello_interval: 2 + authentication: + keychain: ansi11393 + - process_id: '26' + adjacency_stagger: + max_adjacency: 20 + min_adjacency: 10 + - process_id: '10' + authentication: + keychain: ansible_test1102 + areas: + - area_id: '11' + default_cost: 5 + cost: 11 + - area_id: 22 + default_cost: 6 + - process_id: '30' + areas: + - area_id: 11 + default_cost: 5 + - area_id: 22 + default_cost: 6 + + cost: 2 + default_metric: 10 + transmit_delay: 2 + hello_interval: 1 + dead_interval: 2 + retransmit_interval: 2 + weight: 2 + packet_size: 577 + priority: 1 + router_id: 2.2.2.2 + demand_circuit: enable + passive: disable + summary_in: enable + flood_reduction: disable + mtu_ignore: enable + external_out: disable + state: merged + + # + # + # ------------------------ + # Module Execution Result + # ------------------------ + # + # "before": {} + # + # "commands": [ + # "router ospf 30", + # "cost 2", + # "weight 2", + # "passive disable", + # "priority 1", + # "flood-reduction disable", + # "default-metric 10", + # "router-id 2.2.2.2", + # "demand-circuit enable", + # "packet-size 577", + # "transmit-delay 2", + # "summary-in enable", + # "external-out disable", + # "dead-interval 2", + # "hello-interval 1", + # "retransmit-interval 2", + # "mtu-ignore enable", + # "area 11 default-cost 5", + # "area 22 default-cost 6", + # "router ospf 26", + # "adjacency stagger 10 20", + # "authentication message-digest keychain ansible1101pass", + # "router ospf 27", + # "area 10 authentication keychain ansi11393", + # "area 10 hello-interval 2", + # "router ospf 10", + # "authentication keychain ansible_test1102", + # "area 11 default-cost 5", + # "area 11 cost 11", + # "area 22 default-cost 6" + # ] + # + # "after": { + # "processes": [ + # { + # "areas": [ + # { + # "area_id": "11", + # "cost": 11, + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "authentication": { + # "keychain": "ansible_test1102" + # }, + # "process_id": "10" + # }, + # { + # "adjacency_stagger": { + # "max_adjacency": 20, + # "min_adjacency": 10 + # }, + # "authentication": { + # "message_digest": { + # "keychain": "ansible1101pass" + # } + # }, + # "process_id": "26" + # }, + # { + # "areas": [ + # { + # "area_id": "10", + # "authentication": { + # "keychain": "ansi11393" + # }, + # "hello_interval": 2 + # } + # ], + # "process_id": "27" + # }, + # { + # "areas": [ + # { + # "area_id": "11", + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "cost": 2, + # "dead_interval": 2, + # "default_metric": 10, + # "demand_circuit": "enable", + # "external_out": "disable", + # "flood_reduction": "disable", + # "hello_interval": 1, + # "mtu_ignore": "enable", + # "packet_size": 577, + # "passive": "disable", + # "priority": 1, + # "process_id": "30", + # "retransmit_interval": 2, + # "router_id": "2.2.2.2", + # "summary_in": "enable", + # "transmit_delay": 2, + # "weight": 2 + # } + # ] + # } + # + # + # ------------ + # After state + # ------------ + # + # RP/0/RP0/CPU0:anton#show running-config router ospf + # Thu Jun 11 16:06:44.406 UTC + # router ospf 10 + # authentication keychain ansible_test1102 + # area 11 + # cost 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # router ospf 26 + # authentication message-digest keychain ansible1101pass + # adjacency stagger 10 20 + # ! + # router ospf 27 + # area 10 + # authentication keychain ansi11393 + # hello-interval 2 + # ! + # ! + # router ospf 30 + # router-id 2.2.2.2 + # summary-in enable + # external-out disable + # cost 2 + # packet-size 577 + # weight 2 + # passive disable + # priority 1 + # mtu-ignore enable + # flood-reduction disable + # dead-interval 2 + # retransmit-interval 2 + # demand-circuit enable + # hello-interval 1 + # transmit-delay 2 + # default-metric 10 + # area 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # + + + # Using replaced + # + # ------------ + # Before state + # ------------ + # + # + # RP/0/RP0/CPU0:anton#show running-config router ospf + # Thu Jun 11 16:06:44.406 UTC + # router ospf 10 + # authentication keychain ansible_test1102 + # area 11 + # cost 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # router ospf 26 + # authentication message-digest keychain ansible1101pass + # adjacency stagger 10 20 + # ! + # router ospf 27 + # area 10 + # authentication keychain ansi11393 + # hello-interval 2 + # ! + # ! + # router ospf 30 + # router-id 2.2.2.2 + # summary-in enable + # external-out disable + # cost 2 + # packet-size 577 + # weight 2 + # passive disable + # priority 1 + # mtu-ignore enable + # flood-reduction disable + # dead-interval 2 + # retransmit-interval 2 + # demand-circuit enable + # hello-interval 1 + # transmit-delay 2 + # default-metric 10 + # area 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # + + - name: Replace OSPFv2 routes configurations from the device + cisco.iosxr.iosxr_ospfv2: + config: + processes: + - process_id: 27 + areas: + - area_id: 10 + hello_interval: 2 + - area_id: 20 + cost: 2 + default_cost: 2 + authentication: + keychain: ansi11393 + - process_id: 26 + adjacency_stagger: + min_adjacency: 10 + max_adjacency: 20 + state: replaced + + # + # + # ------------------------ + # Module Execution Result + # ------------------------ + # + # "before": { + # "processes": [ + # { + # "areas": [ + # { + # "area_id": "11", + # "cost": 11, + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "authentication": { + # "keychain": "ansible_test1102" + # }, + # "process_id": "10" + # }, + # { + # "adjacency_stagger": { + # "max_adjacency": 20, + # "min_adjacency": 10 + # }, + # "authentication": { + # "message_digest": { + # "keychain": "ansible1101pass" + # } + # }, + # "process_id": "26" + # }, + # { + # "areas": [ + # { + # "area_id": "10", + # "authentication": { + # "keychain": "ansi11393" + # }, + # "hello_interval": 2 + # } + # ], + # "process_id": "27" + # }, + # { + # "areas": [ + # { + # "area_id": "11", + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "cost": 2, + # "dead_interval": 2, + # "default_metric": 10, + # "demand_circuit": "enable", + # "external_out": "disable", + # "flood_reduction": "disable", + # "hello_interval": 1, + # "mtu_ignore": "enable", + # "packet_size": 577, + # "passive": "disable", + # "priority": 1, + # "process_id": "30", + # "retransmit_interval": 2, + # "router_id": "2.2.2.2", + # "summary_in": "enable", + # "transmit_delay": 2, + # "weight": 2 + # } + # ] + # } + # + # "commands": [ + # "router ospf 27", + # "no area 10 authentication keychain ansi11393", + # "area 20 authentication keychain ansi11393", + # "area 20 default-cost 2", + # "area 20 cost 2" + # ] + # + # "after": { + # "processes": [ + # { + # "areas": [ + # { + # "area_id": "11", + # "cost": 11, + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "authentication": { + # "keychain": "ansible_test1102" + # }, + # "process_id": "10" + # }, + # { + # "adjacency_stagger": { + # "max_adjacency": 20, + # "min_adjacency": 10 + # }, + # "authentication": { + # "message_digest": { + # "keychain": "ansible1101pass" + # } + # }, + # "process_id": "26" + # }, + # { + # "areas": [ + # { + # "area_id": "10", + # "hello_interval": 2 + # }, + # { + # "area_id": "20", + # "authentication": { + # "keychain": "ansi11393" + # }, + # "cost": 2, + # "default_cost": 2 + # } + # ], + # "process_id": "27" + # }, + # { + # "areas": [ + # { + # "area_id": "11", + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "cost": 2, + # "dead_interval": 2, + # "default_metric": 10, + # "demand_circuit": "enable", + # "external_out": "disable", + # "flood_reduction": "disable", + # "hello_interval": 1, + # "mtu_ignore": "enable", + # "packet_size": 577, + # "passive": "disable", + # "priority": 1, + # "process_id": "30", + # "retransmit_interval": 2, + # "router_id": "2.2.2.2", + # "summary_in": "enable", + # "transmit_delay": 2, + # "weight": 2 + # } + # ] + # } + # + # + # ----------- + # After state + # ----------- + # + # RP/0/RP0/CPU0:anton(config)#do show running-config router ospf + # Thu Jun 11 16:40:31.038 UTC + # router ospf 10 + # authentication keychain ansible_test1102 + # area 11 + # cost 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # router ospf 26 + # authentication message-digest keychain ansible1101pass + # adjacency stagger 10 20 + # ! + # router ospf 27 + # area 10 + # hello-interval 2 + # ! + # area 20 + # cost 2 + # authentication keychain ansi11393 + # default-cost 2 + # ! + # ! + # router ospf 30 + # router-id 2.2.2.2 + # summary-in enable + # external-out disable + # cost 2 + # packet-size 577 + # weight 2 + # passive disable + # priority 1 + # mtu-ignore enable + # flood-reduction disable + # dead-interval 2 + # retransmit-interval 2 + # demand-circuit enable + # hello-interval 1 + # transmit-delay 2 + # default-metric 10 + # area 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # + + + # Using overridden + # + # ------------ + # Before state + # ------------ + # + # + # RP/0/RP0/CPU0:anton#show running-config router ospf + # Thu Jun 11 16:06:44.406 UTC + # router ospf 10 + # authentication keychain ansible_test1102 + # area 11 + # cost 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # router ospf 26 + # authentication message-digest keychain ansible1101pass + # adjacency stagger 10 20 + # ! + # router ospf 27 + # area 10 + # authentication keychain ansi11393 + # hello-interval 2 + # ! + # ! + # router ospf 30 + # router-id 2.2.2.2 + # summary-in enable + # external-out disable + # cost 2 + # packet-size 577 + # weight 2 + # passive disable + # priority 1 + # mtu-ignore enable + # flood-reduction disable + # dead-interval 2 + # retransmit-interval 2 + # demand-circuit enable + # hello-interval 1 + # transmit-delay 2 + # default-metric 10 + # area 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # + + - name: Override existing OSPFv2 configurations from the device + cisco.iosxr.iosxr_ospfv2: + config: + processes: + - process_id: 27 + areas: + - area_id: 10 + hello_interval: 2 + authentication: + keychain: ansi11393 + - area_id: 20 + cost: 2 + default_cost: 2 + authentication: + keychain: ansi11393 + - process_id: 26 + adjacency_stagger: + min_adjacency: 10 + max_adjacency: 20 + state: overridden + + # + # + # ------------------------ + # Module Execution Result + # ------------------------ + # + # "before": { + # "processes": [ + # { + # "areas": [ + # { + # "area_id": "11", + # "cost": 11, + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "authentication": { + # "keychain": "ansible_test1102" + # }, + # "process_id": "10" + # }, + # { + # "adjacency_stagger": { + # "max_adjacency": 20, + # "min_adjacency": 10 + # }, + # "authentication": { + # "message_digest": { + # "keychain": "ansible1101pass" + # } + # }, + # "process_id": "26" + # }, + # { + # "areas": [ + # { + # "area_id": "10", + # "authentication": { + # "keychain": "ansi11393" + # }, + # "hello_interval": 2 + # } + # ], + # "process_id": "27" + # }, + # { + # "areas": [ + # { + # "area_id": "11", + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "cost": 2, + # "dead_interval": 2, + # "default_metric": 10, + # "demand_circuit": "enable", + # "external_out": "disable", + # "flood_reduction": "disable", + # "hello_interval": 1, + # "mtu_ignore": "enable", + # "packet_size": 577, + # "passive": "disable", + # "priority": 1, + # "process_id": "30", + # "retransmit_interval": 2, + # "router_id": "2.2.2.2", + # "summary_in": "enable", + # "transmit_delay": 2, + # "weight": 2 + # } + # ] + # } + # + # "commands": [ + # "router ospf 10", + # "no authentication keychain ansible_test1102", + # "no area 11 default-cost 5", + # "no area 11 cost 11", + # "no area 22 default-cost 6", + # "router ospf 30", + # "no cost 2", + # "no weight 2", + # "no passive disable", + # "no priority 1", + # "no flood-reduction disable", + # "no default-metric 10", + # "no router-id 2.2.2.2", + # "no demand-circuit enable", + # "no packet-size 577", + # "no transmit-delay 2", + # "no summary-in enable", + # "no external-out disable", + # "no dead-interval 2", + # "no hello-interval 1", + # "no retransmit-interval 2", + # "no mtu-ignore enable", + # "no area 11 default-cost 5", + # "no area 22 default-cost 6", + # "router ospf 27", + # "area 20 authentication keychain ansi11393", + # "area 20 default-cost 2", + # "area 20 cost 2" + # ] + # + # "after": { + # "processes": [ + # { + # "process_id": "10" + # }, + # { + # "adjacency_stagger": { + # "max_adjacency": 20, + # "min_adjacency": 10 + # }, + # "authentication": { + # "message_digest": { + # "keychain": "ansible1101pass" + # } + # }, + # "process_id": "26" + # }, + # { + # "areas": [ + # { + # "area_id": "10", + # "authentication": { + # "keychain": "ansi11393" + # }, + # "hello_interval": 2 + # }, + # { + # "area_id": "20", + # "authentication": { + # "keychain": "ansi11393" + # }, + # "cost": 2, + # "default_cost": 2 + # } + # ], + # "process_id": "27" + # }, + # { + # "process_id": "30" + # } + # ] + # } + # + # + # ----------- + # After state + # ----------- + # + # RP/0/RP0/CPU0:anton#show running-config router ospf + # Thu Jun 11 16:50:36.332 UTC + # router ospf 10 + # ! + # router ospf 26 + # authentication message-digest keychain ansible1101pass + # adjacency stagger 10 20 + # ! + # router ospf 27 + # area 10 + # authentication keychain ansi11393 + # hello-interval 2 + # ! + # area 20 + # cost 2 + # authentication keychain ansi11393 + # default-cost 2 + # ! + # ! + # router ospf 30 + # ! + # + + + # Using deleted + # + # ------------ + # Before state + # ------------ + # + # + # RP/0/RP0/CPU0:anton#show running-config router ospf + # Thu Jun 11 16:06:44.406 UTC + # router ospf 10 + # authentication keychain ansible_test1102 + # area 11 + # cost 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # router ospf 26 + # authentication message-digest keychain ansible1101pass + # adjacency stagger 10 20 + # ! + # router ospf 27 + # area 10 + # authentication keychain ansi11393 + # hello-interval 2 + # ! + # ! + # router ospf 30 + # router-id 2.2.2.2 + # summary-in enable + # external-out disable + # cost 2 + # packet-size 577 + # weight 2 + # passive disable + # priority 1 + # mtu-ignore enable + # flood-reduction disable + # dead-interval 2 + # retransmit-interval 2 + # demand-circuit enable + # hello-interval 1 + # transmit-delay 2 + # default-metric 10 + # area 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # + + - name: Deleted existing OSPFv2 configurations from the device + cisco.iosxr.iosxr_ospfv2: + config: + processes: + - process_id: '10' + - process_id: '26' + - process_id: '27' + - process_id: '30' + state: deleted + + # + # + # ------------------------ + # Module Execution Result + # ------------------------ + # + # "before": { + # "processes": [ + # { + # "areas": [ + # { + # "area_id": "11", + # "cost": 11, + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "authentication": { + # "keychain": "ansible_test1102" + # }, + # "process_id": "10" + # }, + # { + # "adjacency_stagger": { + # "max_adjacency": 20, + # "min_adjacency": 10 + # }, + # "authentication": { + # "message_digest": { + # "keychain": "ansible1101pass" + # } + # }, + # "process_id": "26" + # }, + # { + # "areas": [ + # { + # "area_id": "10", + # "authentication": { + # "keychain": "ansi11393" + # }, + # "hello_interval": 2 + # } + # ], + # "process_id": "27" + # }, + # { + # "areas": [ + # { + # "area_id": "11", + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "cost": 2, + # "dead_interval": 2, + # "default_metric": 10, + # "demand_circuit": "enable", + # "external_out": "disable", + # "flood_reduction": "disable", + # "hello_interval": 1, + # "mtu_ignore": "enable", + # "packet_size": 577, + # "passive": "disable", + # "priority": 1, + # "process_id": "30", + # "retransmit_interval": 2, + # "router_id": "2.2.2.2", + # "summary_in": "enable", + # "transmit_delay": 2, + # "weight": 2 + # } + # ] + # }, + # + # "commands": [ + # "router ospf 10", + # "no authentication keychain ansible_test1102", + # "no area 11 default-cost 5", + # "no area 11 cost 11", + # "no area 22 default-cost 6", + # "router ospf 26", + # "no adjacency stagger 10 20", + # "no authentication message-digest keychain ansible1101pass", + # "router ospf 27", + # "no area 10 authentication keychain ansi11393", + # "no area 10 hello-interval 2", + # "router ospf 30", + # "no cost 2", + # "no weight 2", + # "no passive disable", + # "no priority 1", + # "no flood-reduction disable", + # "no default-metric 10", + # "no router-id 2.2.2.2", + # "no demand-circuit enable", + # "no packet-size 577", + # "no transmit-delay 2", + # "no summary-in enable", + # "no external-out disable", + # "no dead-interval 2", + # "no hello-interval 1", + # "no retransmit-interval 2", + # "no mtu-ignore enable", + # "no area 11 default-cost 5", + # "no area 22 default-cost 6" + # ] + # + # "after": { + # "processes": [ + # { + # "process_id": "10" + # }, + # { + # "process_id": "26" + # }, + # { + # "process_id": "27" + # }, + # { + # "process_id": "30" + # } + # ] + # } + # + # + # ----------- + # After state + # ----------- + # + # RP/0/RP0/CPU0:anton(config)#show running-config router ospf + # Thu Jun 11 17:07:34.218 UTC + # router ospf 10 + # ! + # router ospf 26 + # ! + # router ospf 27 + # ! + # router ospf 30 + # ! + + + # Using parsed + # parsed.cfg + # ------------ + # Thu Jun 11 17:28:51.918 UTC + # router ospf 10 + # authentication keychain ansible_test1102 + # area 11 + # cost 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # router ospf 26 + # authentication message-digest keychain ansible1101pass + # adjacency stagger 10 20 + # ! + # router ospf 27 + # area 10 + # authentication keychain ansi11393 + # hello-interval 2 + # ! + # ! + # router ospf 30 + # router-id 2.2.2.2 + # summary-in enable + # external-out disable + # cost 2 + # packet-size 577 + # weight 2 + # passive disable + # priority 1 + # mtu-ignore enable + # flood-reduction disable + # dead-interval 2 + # retransmit-interval 2 + # demand-circuit enable + # hello-interval 1 + # transmit-delay 2 + # default-metric 10 + # area 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + - name: Parsed the device configuration to get output commands + cisco.iosxr.iosxr_ospfv2: + running_config: "{{ lookup('file', './parsed.cfg') }}" + state: parsed + # + # + # ------------------------- + # Module Execution Result + # ------------------------- + # + # + # "parsed": { + # "processes": [ + # { + # "areas": [ + # { + # "area_id": "11", + # "cost": 11, + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "authentication": { + # "keychain": "ansible_test1102" + # }, + # "process_id": "10" + # }, + # { + # "adjacency_stagger": { + # "max_adjacency": 20, + # "min_adjacency": 10 + # }, + # "authentication": { + # "message_digest": { + # "keychain": "ansible1101pass" + # } + # }, + # "process_id": "26" + # }, + # { + # "areas": [ + # { + # "area_id": "10", + # "authentication": { + # "keychain": "ansi11393" + # }, + # "hello_interval": 2 + # } + # ], + # "process_id": "27" + # }, + # { + # "areas": [ + # { + # "area_id": "11", + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "cost": 2, + # "dead_interval": 2, + # "default_metric": 10, + # "demand_circuit": "enable", + # "external_out": "disable", + # "flood_reduction": "disable", + # "hello_interval": 1, + # "mtu_ignore": "enable", + # "packet_size": 577, + # "passive": "disable", + # "priority": 1, + # "process_id": "30", + # "retransmit_interval": 2, + # "router_id": "2.2.2.2", + # "summary_in": "enable", + # "transmit_delay": 2, + # "weight": 2 + # } + # ] + # } + + + + # Using rendered + # + # + - name: Render the commands for provided configuration + cisco.iosxr.iosxr_ospfv2: + config: + processes: + - process_id: 27 + areas: + - area_id: 10 + hello_interval: 2 + authentication: + keychain: ansi11393 + - process_id: 26 + adjacency_stagger: + min_adjacency: 10 + max_adjacency: 20 + - process_id: 10 + authentication: + keychain: ansible_test1102 + areas: + - area_id: 11 + default_cost: 5 + cost: 11 + - area_id: 22 + default_cost: 6 + - process_id: 30 + areas: + - area_id: 11 + default_cost: 5 + - area_id: 22 + default_cost: 6 + + cost: 2 + default_metric: 10 + transmit_delay: 2 + hello_interval: 1 + dead_interval: 2 + retransmit_interval: 2 + weight: 2 + packet_size: 577 + priority: 1 + router_id: 2.2.2.2 + demand_circuit: enable + passive: disable + summary_in: enable + flood_reduction: disable + mtu_ignore: enable + external_out: disable + state: rendered + + # + # + # ------------------------- + # Module Execution Result + # ------------------------- + # + # + # "rendered": [ + # "router ospf 27", + # "area 10 authentication keychain ansi11393", + # "area 10 hello-interval 2", + # "router ospf 26", + # "adjacency stagger 10 20", + # "authentication message-digest keychain ansible1101pass", + # "router ospf 10", + # "authentication keychain ansible_test1102", + # "area 11 default-cost 5", + # "area 11 cost 11", + # "area 22 default-cost 6", + # "router ospf 30", + # "cost 2", + # "weight 2", + # "passive disable", + # "priority 1", + # "flood-reduction disable", + # "default-metric 10", + # "router-id 2.2.2.2", + # "demand-circuit enable", + # "packet-size 577", + # "transmit-delay 2", + # "summary-in enable", + # "external-out disable", + # "dead-interval 2", + # "hello-interval 1", + # "retransmit-interval 2", + # "mtu-ignore enable", + # "area 11 default-cost 5", + # "area 22 default-cost 6" + # ] + + + # Using gathered + # + # Before state: + # ------------- + # + # RP/0/RP0/CPU0:anton#show running-config router ospf + # Thu Jun 11 16:06:44.406 UTC + # router ospf 10 + # authentication keychain ansible_test1102 + # area 11 + # cost 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # router ospf 26 + # authentication message-digest keychain ansible1101pass + # adjacency stagger 10 20 + # ! + # router ospf 27 + # area 10 + # authentication keychain ansi11393 + # hello-interval 2 + # ! + # ! + # router ospf 30 + # router-id 2.2.2.2 + # summary-in enable + # external-out disable + # cost 2 + # packet-size 577 + # weight 2 + # passive disable + # priority 1 + # mtu-ignore enable + # flood-reduction disable + # dead-interval 2 + # retransmit-interval 2 + # demand-circuit enable + # hello-interval 1 + # transmit-delay 2 + # default-metric 10 + # area 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # + - name: Gather ospfv2 routes configuration + cisco.iosxr.iosxr_ospfv2: + state: gathered + # + # + # ------------------------- + # Module Execution Result + # ------------------------- + # + # "gathered": { + # "processes": [ + # { + # "areas": [ + # { + # "area_id": "11", + # "cost": 11, + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "authentication": { + # "keychain": "ansible_test1102" + # }, + # "process_id": "10" + # }, + # { + # "adjacency_stagger": { + # "max_adjacency": 20, + # "min_adjacency": 10 + # }, + # "authentication": { + # "message_digest": { + # "keychain": "ansible1101pass" + # } + # }, + # "process_id": "26" + # }, + # { + # "areas": [ + # { + # "area_id": "10", + # "authentication": { + # "keychain": "ansi11393" + # }, + # "hello_interval": 2 + # } + # ], + # "process_id": "27" + # }, + # { + # "areas": [ + # { + # "area_id": "11", + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "cost": 2, + # "dead_interval": 2, + # "default_metric": 10, + # "demand_circuit": "enable", + # "external_out": "disable", + # "flood_reduction": "disable", + # "hello_interval": 1, + # "mtu_ignore": "enable", + # "packet_size": 577, + # "passive": "disable", + # "priority": 1, + # "process_id": "30", + # "retransmit_interval": 2, + # "router_id": "2.2.2.2", + # "summary_in": "enable", + # "transmit_delay": 2, + # "weight": 2 + # } + # ] + # } + # + # After state: + # ------------- + # + # RP/0/RP0/CPU0:anton#show running-config router ospf + # Thu Jun 11 16:06:44.406 UTC + # router ospf 10 + # authentication keychain ansible_test1102 + # area 11 + # cost 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # router ospf 26 + # authentication message-digest keychain ansible1101pass + # adjacency stagger 10 20 + # ! + # router ospf 27 + # area 10 + # authentication keychain ansi11393 + # hello-interval 2 + # ! + # ! + # router ospf 30 + # router-id 2.2.2.2 + # summary-in enable + # external-out disable + # cost 2 + # packet-size 577 + # weight 2 + # passive disable + # priority 1 + # mtu-ignore enable + # flood-reduction disable + # dead-interval 2 + # retransmit-interval 2 + # demand-circuit enable + # hello-interval 1 + # transmit-delay 2 + # default-metric 10 + # area 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # + # + + + +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 30', "authentication message-digest keychain 'ansible1101pass'"]
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Rohit Thakur (@rohitthakur2590) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_ospfv3_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_ospfv3_module.rst new file mode 100644 index 00000000..f9fa3d0c --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_ospfv3_module.rst @@ -0,0 +1,10348 @@ +.. _cisco.iosxr.iosxr_ospfv3_module: + + +************************ +cisco.iosxr.iosxr_ospfv3 +************************ + +**ospfv3 resource module** + + +Version added: 1.1.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages global ospfv3 configuration on devices running Cisco IOS-XR + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A list of ospfv3 process configuration
+
+
+ processes + +
+ list + / elements=dictionary +
+ 		+ +
A list of ospfv3 instances configuration
+
+
+ address_family_unicast + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable unicast topology for ipv4 address family
+
+
+ areas + +
+ list + / elements=dictionary +
+ 		+ +
Configure ospfv3 areas' properties
+
+
+ area_id + +
+ string + / required +
+ 		+ +
Area ID as IP address or integer
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Enable authentication
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Do not authenticate OSPFv3 packets
+
+
+ ipsec + +
+ dictionary +
+ 		+ +
Specify IPSec AH authentication attributes
+
+
+ algorithim_type + +
+ string +
+ 		+
    Choices: +
  • md5
    • +
  • sha1
    • +
+ 		+
Specify the type of algorithim
+
+
+ clear_key + +
+ string +
+ 		+ +
Specify key in cleartext form
+
+
+ key + +
+ string +
+ 		+ +
Specify key
+
+
+ password_key + +
+ string +
+ 		+ +
Specify key in encrypted form
+
+
+ spi + +
+ integer +
+ 		+ +
Specify the Security Parameter Index value
+
+
+ bfd + +
+ dictionary +
+ 		+ +
Configure BFD parameters
+
+
+ fast_detect + +
+ dictionary +
+ 		+ +
Configure fast detection
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable fast detection only
+
+
+ strict_mode + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Hold down neighbor session until BFD session is up
+
+
+ minimum_interval + +
+ integer +
+ 		+ +
Hello interval in milli-seconds
+
+
+ multiplier + +
+ integer +
+ 		+ +
Detect multiplier
+
+
+ cost + +
+ integer +
+ 		+ +
Interface cost
+
+
+ database_filter + +
+ dictionary +
+ 		+ +
Filter LSAs during synchronization and flooding
+
+
+ all_outgoing_lsa + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Filter all outgoing LSA
+
+
+ dead_interval + +
+ integer +
+ 		+ +
Interval after which a neighbor is declared dead
+
+
+ default_cost + +
+ integer +
+ 		+ +
Set the summary default-cost of a NSSA/stub area. Stub's advertised external route metric
+
+
+ demand_circuit + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable ospfv3 demand circuit
+
+
+ distrinbute_rib_prefix_list_name + +
+ string +
+ 		+ +
Filter LSAs during synchronization and flooding
+
+
+ encryption + +
+ dictionary +
+ 		+ +
Encrypt and authenticate OSPFv3 packets
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Do not encrypt OSPFv3 packets
+
+
+ ipsec + +
+ dictionary +
+ 		+ +
Specify IPSec ESP encryption and authentication
+
+
+ esp + +
+ dictionary +
+ 		+ +
Specify encryption parameters
+
+
+ aes + +
+ dictionary +
+ 		+ +
This specify the aes algorithim
+
+
+ algorithim_type + +
+ string +
+ 		+
    Choices: +
  • 192
    • +
  • 256
    • +
+ 		+
Specify the bit encryption for aes algorithim
+
+
+ clear_key + +
+ string +
+ 		+ +
Specify AES key in cleartext form
+
+
+ key + +
+ string +
+ 		+ +
Cleartext AES key
+
+
+ password_key + +
+ string +
+ 		+ +
Specify AES key in encrypted form
+
+
+ des + +
+ dictionary +
+ 		+ +
This specify the des algorithim
+
+
+ clear_key + +
+ string +
+ 		+ +
Specify AES key in cleartext form
+
+
+ key + +
+ string +
+ 		+ +
Cleartext AES key
+
+
+ password_key + +
+ string +
+ 		+ +
Specify AES key in encrypted form
+
+
+ null_encryption + +
+ dictionary +
+ 		+ +
Specify null encryption attributes
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Specify authentication parameters
+
+
+ algorithim_type + +
+ string +
+ 		+
    Choices: +
  • md5
    • +
  • sha1
    • +
+ 		+
Specify the type of algorithim
+
+
+ clear_key + +
+ string +
+ 		+ +
Specify key in cleartext form
+
+
+ key + +
+ string +
+ 		+ +
Specify key
+
+
+ password_key + +
+ string +
+ 		+ +
Specify key in encrypted form
+
+
+ triple_des + +
+ dictionary +
+ 		+ +
This specify the triple DES algorithim
+
+
+ clear_key + +
+ string +
+ 		+ +
Specify 3DES key in cleartext form
+
+
+ key + +
+ string +
+ 		+ +
Cleartext 3DES key
+
+
+ password_key + +
+ string +
+ 		+ +
Specify 3DES key in encrypted form
+
+
+ spi + +
+ integer +
+ 		+ +
Specify the Security Parameter Index value
+
+
+ fast_reroute + +
+ dictionary +
+ 		+ +
Specify IP Fast Reroute
+
+
+ disabled + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable IP fast reroute
+
+
+ per_link + +
+ dictionary +
+ 		+ +
Specify per-prefix computation
+
+
+ information_type + +
+ string +
+ 		+
    Choices: +
  • exclude
    • +
  • lfa_candidate
    • +
+ 		+
Specify per-link LFA exclusion or FRR LFA candidate information
+
+
+ interface + +
+ dictionary +
+ 		+ +
Specify Per-link LFA exclusion information
+
+
+ bundle_ether + +
+ list + / elements=integer +
+ 		+ +
Specify Aggregated Ethernet interface(s)
+
+
+ bvi + +
+ list + / elements=integer +
+ 		+ +
Specify Bridge-Group Virtual Interface
+
+
+ fast_ethernet + +
+ list + / elements=string +
+ 		+ +
Specify FastEthernet/IEEE 802.3 interface(s)
+
+
+ fiftygige + +
+ list + / elements=string +
+ 		+ +
Specify FiftyGigE/IEEE 802.3 interface(s)
+
+
+ fortygige + +
+ list + / elements=string +
+ 		+ +
Specify FortyGigE/IEEE 802.3 interface(s)
+
+
+ fourhundredgige + +
+ list + / elements=string +
+ 		+ +
Specify FourHundredGigE/IEEE 802.3 interface(s)
+
+
+ gigabitethernet + +
+ list + / elements=string +
+ 		+ +
Specify GigabitEthernet/IEEE 802.3 interface(s)
+
+
+ hundredgige + +
+ list + / elements=string +
+ 		+ +
Specify HundredGigE/IEEE 802.3 interface(s)
+
+
+ mgmteth + +
+ list + / elements=string +
+ 		+ +
Specify MgmtEth/IEEE 802.3 interface(s)
+
+
+ multilink + +
+ list + / elements=string +
+ 		+ +
Specify Multilink network interface(s)
+
+
+ nve + +
+ list + / elements=integer +
+ 		+ +
Specify Network Virtualization Endpoint Interface(s)
+
+
+ pos_int + +
+ list + / elements=integer +
+ 		+ +
Specify Aggregated pos interface(s)
+
+
+ pw_ether + +
+ list + / elements=integer +
+ 		+ +
Specify PWHE Ethernet Interface
+
+
+ pw_iw + +
+ list + / elements=integer +
+ 		+ +
Specify PWHE VC11 IP Interworking Interface
+
+
+ serial + +
+ list + / elements=string +
+ 		+ +
Specify Serial network interface(s)
+
+
+ srp + +
+ list + / elements=string +
+ 		+ +
Specify SRP interface(s)
+
+
+ tengige + +
+ list + / elements=string +
+ 		+ +
Specify TenGigabitEthernet/IEEE 802.3 interface(s)
+
+
+ tunnel_ip + +
+ list + / elements=integer +
+ 		+ +
Specify GRE/IPinIP Tunnel Interface(s)
+
+
+ tunnel_ipsec + +
+ list + / elements=integer +
+ 		+ +
Specify IPSec Tunnel interface(s)
+
+
+ tunnel_mpls + +
+ integer +
+ 		+ +
MPLS Transport Protocol Tunnel interface
+
+
+ tunnel_mte + +
+ list + / elements=integer +
+ 		+ +
Specify MPLS Traffic Engineering P2MP Tunnel interface(s)
+
+
+ twentyfivegige + +
+ list + / elements=string +
+ 		+ +
Specify TwentyFiveGigabitEthernet/IEEE 802.3 interface(s)
+
+
+ twohundredgige + +
+ list + / elements=string +
+ 		+ +
Specify TwoHundredGigE/IEEE 802.3 interface(s)
+
+
+ use_candidate_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable backup selection from candidate-list only
+
+
+ per_prefix + +
+ dictionary +
+ 		+ +
Specify per-prefix computation
+
+
+ information_type + +
+ string +
+ 		+
    Choices: +
  • exclude
    • +
  • lfa_candidate
    • +
+ 		+
Specify per_prefix LFA exclusion or FRR LFA candidate information
+
+
+ interface + +
+ dictionary +
+ 		+ +
Specify Per-link LFA exclusion information
+
+
+ bundle_ether + +
+ list + / elements=integer +
+ 		+ +
Specify Aggregated Ethernet interface(s)
+
+
+ bvi + +
+ list + / elements=integer +
+ 		+ +
Specify Bridge-Group Virtual Interface
+
+
+ fast_ethernet + +
+ list + / elements=string +
+ 		+ +
Specify FastEthernet/IEEE 802.3 interface(s)
+
+
+ fiftygige + +
+ list + / elements=string +
+ 		+ +
Specify FiftyGigE/IEEE 802.3 interface(s)
+
+
+ fortygige + +
+ list + / elements=string +
+ 		+ +
Specify FortyGigE/IEEE 802.3 interface(s)
+
+
+ fourhundredgige + +
+ list + / elements=string +
+ 		+ +
Specify FourHundredGigE/IEEE 802.3 interface(s)
+
+
+ gigabitethernet + +
+ list + / elements=string +
+ 		+ +
Specify GigabitEthernet/IEEE 802.3 interface(s)
+
+
+ hundredgige + +
+ list + / elements=string +
+ 		+ +
Specify HundredGigE/IEEE 802.3 interface(s)
+
+
+ mgmteth + +
+ list + / elements=string +
+ 		+ +
Specify MgmtEth/IEEE 802.3 interface(s)
+
+
+ multilink + +
+ list + / elements=string +
+ 		+ +
Specify Multilink network interface(s)
+
+
+ nve + +
+ list + / elements=integer +
+ 		+ +
Specify Network Virtualization Endpoint Interface(s)
+
+
+ pos_int + +
+ list + / elements=integer +
+ 		+ +
Specify Aggregated pos interface(s)
+
+
+ pw_ether + +
+ list + / elements=integer +
+ 		+ +
Specify PWHE Ethernet Interface
+
+
+ pw_iw + +
+ list + / elements=integer +
+ 		+ +
Specify PWHE VC11 IP Interworking Interface
+
+
+ serial + +
+ list + / elements=string +
+ 		+ +
Specify Serial network interface(s)
+
+
+ srp + +
+ list + / elements=string +
+ 		+ +
Specify SRP interface(s)
+
+
+ tengige + +
+ list + / elements=string +
+ 		+ +
Specify TenGigabitEthernet/IEEE 802.3 interface(s)
+
+
+ tunnel_ip + +
+ list + / elements=integer +
+ 		+ +
Specify GRE/IPinIP Tunnel Interface(s)
+
+
+ tunnel_ipsec + +
+ list + / elements=integer +
+ 		+ +
Specify IPSec Tunnel interface(s)
+
+
+ tunnel_mpls + +
+ integer +
+ 		+ +
MPLS Transport Protocol Tunnel interface
+
+
+ tunnel_mte + +
+ list + / elements=integer +
+ 		+ +
Specify MPLS Traffic Engineering P2MP Tunnel interface(s)
+
+
+ twentyfivegige + +
+ list + / elements=string +
+ 		+ +
Specify TwentyFiveGigabitEthernet/IEEE 802.3 interface(s)
+
+
+ twohundredgige + +
+ list + / elements=string +
+ 		+ +
Specify TwoHundredGigE/IEEE 802.3 interface(s)
+
+
+ use_candidate_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable backup selection from candidate-list only
+
+
+ flood_reduction + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable flood reduction
+
+
+ hello_interval + +
+ integer +
+ 		+ +
Specify Time between HELLO packets
+
+
+ instance_id + +
+ integer +
+ 		+ +
Specify instance ID
+
+
+ mpls_ldp_sync + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable MPLS LDP Sync
+
+
+ mtu_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable ignoring of MTU in DBD packets
+
+
+ network + +
+ string +
+ 		+
    Choices: +
  • broadcast
    • +
  • non-broadcast
    • +
  • point-to-multipoint
    • +
  • point-to-point
    • +
+ 		+
Specify Network type
+
+
+ nssa + +
+ dictionary +
+ 		+ +
NSSA settings for the area
+
+
+ default_information_originate + +
+ dictionary +
+ 		+ +
Originate default Type 7 LSA
+
+
+ metric + +
+ integer +
+ 		+ +
ospfv3 default metric
+
+
+ metric_type + +
+ integer +
+ 		+ +
Metric type for default routes
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set nssa to default information originate
+
+
+ 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 + / required +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always translate LSAs
+
+
+ packet_size + +
+ integer +
+ 		+ +
Specify limit size of OSPFv3 packets
+
+
+ passive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable routing updates on an interface
+
+
+ prefix_suppression + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Hide all transit addresses on this interface
+
+
+ priority + +
+ integer +
+ 		+ +
Specify Router priority
+
+
+ ranges + +
+ list + / elements=dictionary +
+ 		+ +
Summarize routes matching address/mask (border routers only)
+
+
+ address + +
+ string + / required +
+ 		+ +
IP in Prefix format (X:X::X/length)
+
+
+ advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise this range (default)
+
+
+ cost + +
+ integer +
+ 		+ +
Specify user specified metric for this range
+
+
+ not_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
DoNotAdvertise this range
+
+
+ retransmit_interval + +
+ integer +
+ 		+ +
Specify Delay between LSA retransmissions
+
+
+ stub + +
+ dictionary +
+ 		+ +
Settings for configuring the area as a stub
+
+
+ no_summary + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not send summary LSA into stub area
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Configure the area as a stub
+
+
+ transmit_delay + +
+ integer +
+ 		+ +
Specify estimated time needed to send link-state update packet
+
+
+ virtual_link + +
+ list + / elements=dictionary +
+ 		+ +
Define a virtual link
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Enable authentication
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Do not authenticate OSPFv3 packets
+
+
+ ipsec + +
+ dictionary +
+ 		+ +
Specify IPSec AH authentication attributes
+
+
+ algorithim_type + +
+ string +
+ 		+
    Choices: +
  • md5
    • +
  • sha1
    • +
+ 		+
Specify the type of algorithim
+
+
+ clear_key + +
+ string +
+ 		+ +
Specify key in cleartext form
+
+
+ key + +
+ string +
+ 		+ +
Specify key
+
+
+ password_key + +
+ string +
+ 		+ +
Specify key in encrypted form
+
+
+ spi + +
+ integer +
+ 		+ +
Specify the Security Parameter Index value
+
+
+ dead_interval + +
+ integer +
+ 		+ +
Interval after which a neighbor is declared dead
+
+
+ encryption + +
+ dictionary +
+ 		+ +
Encrypt and authenticate OSPFv3 packets
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Do not encrypt OSPFv3 packets
+
+
+ ipsec + +
+ dictionary +
+ 		+ +
Specify IPSec ESP encryption and authentication
+
+
+ esp + +
+ dictionary +
+ 		+ +
Specify encryption parameters
+
+
+ aes + +
+ dictionary +
+ 		+ +
This specify the aes algorithim
+
+
+ algorithim_type + +
+ string +
+ 		+
    Choices: +
  • 192
    • +
  • 256
    • +
+ 		+
Specify the bit encryption for aes algorithim
+
+
+ clear_key + +
+ string +
+ 		+ +
Specify AES key in cleartext form
+
+
+ key + +
+ string +
+ 		+ +
Cleartext AES key
+
+
+ password_key + +
+ string +
+ 		+ +
Specify AES key in encrypted form
+
+
+ des + +
+ dictionary +
+ 		+ +
This specify the des algorithim
+
+
+ clear_key + +
+ string +
+ 		+ +
Specify AES key in cleartext form
+
+
+ key + +
+ string +
+ 		+ +
Cleartext AES key
+
+
+ password_key + +
+ string +
+ 		+ +
Specify AES key in encrypted form
+
+
+ null_encryption + +
+ dictionary +
+ 		+ +
Specify null encryption attributes
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Specify authentication parameters
+
+
+ algorithim_type + +
+ string +
+ 		+
    Choices: +
  • md5
    • +
  • sha1
    • +
+ 		+
Specify the type of algorithim
+
+
+ clear_key + +
+ string +
+ 		+ +
Specify key in cleartext form
+
+
+ key + +
+ string +
+ 		+ +
Specify key
+
+
+ password_key + +
+ string +
+ 		+ +
Specify key in encrypted form
+
+
+ triple_des + +
+ dictionary +
+ 		+ +
This specify the triple DES algorithim
+
+
+ clear_key + +
+ string +
+ 		+ +
Specify 3DES key in cleartext form
+
+
+ key + +
+ string +
+ 		+ +
Cleartext 3DES key
+
+
+ password_key + +
+ string +
+ 		+ +
Specify 3DES key in encrypted form
+
+
+ spi + +
+ integer +
+ 		+ +
Specify the Security Parameter Index value
+
+
+ hello_interval + +
+ integer +
+ 		+ +
Time between HELLO packets
+
+
+ id + +
+ string + / required +
+ 		+ +
Router-ID of virtual link neighbor (A.B.C.D)
+
+
+ retransmit_interval + +
+ integer +
+ 		+ +
Delay between LSA retransmissions
+
+
+ transmit_delay + +
+ integer +
+ 		+ +
Link state transmit delay
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Enable authentication
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Do not authenticate OSPFv3 packets
+
+
+ ipsec + +
+ dictionary +
+ 		+ +
Specify IPSec AH authentication attributes
+
+
+ algorithim_type + +
+ string +
+ 		+
    Choices: +
  • md5
    • +
  • sha1
    • +
+ 		+
Specify the type of algorithim
+
+
+ clear_key + +
+ string +
+ 		+ +
Specify key in cleartext form
+
+
+ key + +
+ string +
+ 		+ +
Specify key
+
+
+ password_key + +
+ string +
+ 		+ +
Specify key in encrypted form
+
+
+ spi + +
+ integer +
+ 		+ +
Specify the Security Parameter Index value
+
+
+ auto_cost + +
+ dictionary +
+ 		+ +
Calculate ospfv3 interface cost according to bandwidth
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Assign ospfv3 cost based on interface type
+
+
+ reference_bandwidth + +
+ integer +
+ 		+ +
Specify reference bandwidth in megabits per sec
+
+
+ bfd + +
+ dictionary +
+ 		+ +
Configure BFD parameters
+
+
+ fast_detect + +
+ dictionary +
+ 		+ +
Configure fast detection
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable fast detection only
+
+
+ strict_mode + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Hold down neighbor session until BFD session is up
+
+
+ minimum_interval + +
+ integer +
+ 		+ +
Hello interval in milli-seconds
+
+
+ multiplier + +
+ integer +
+ 		+ +
Detect multiplier
+
+
+ capability + +
+ dictionary +
+ 		+ +
Enable specific OSPFv3 feature
+
+
+ type7 + +
+ dictionary +
+ 		+ +
Specify type7 nssa capability
+
+
+ prefer + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Prefer type7 externals over type5
+
+
+ translate + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Translate type7 to type5
+
+
+ cost + +
+ integer +
+ 		+ +
Specify Interface cost
+
+
+ database_filter + +
+ dictionary +
+ 		+ +
Filter LSAs during synchronization and flooding
+
+
+ all_outgoing_lsa + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Filter all outgoing LSA
+
+
+ dead_interval + +
+ integer +
+ 		+ +
Interval after which a neighbor is declared dead
+
+
+ default_information_originate + +
+ dictionary +
+ 		+ +
Control distribution of default information
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always advertise default route
+
+
+ metric + +
+ integer +
+ 		+ +
ospfv3 default metric
+
+
+ metric_type + +
+ integer +
+ 		+ +
ospfv3 metric type for default routes
+
+
+ route_policy + +
+ string +
+ 		+ +
Apply route-policy to default-information origination
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable distribution of default route
+
+
+ tag + +
+ integer +
+ 		+ +
Set tag for default route
+
+
+ default_metric + +
+ integer +
+ 		+ +
Set metric of redistributed routes
+
+
+ demand_circuit + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable ospfv3 demand circuit
+
+
+ distance + +
+ dictionary +
+ 		+ +
Define an administrative distance
+
+
+ admin_distance + +
+ integer +
+ 		+ +
Administrative distance
+
+
+ ospfv3_distance + +
+ dictionary +
+ 		+ +
ospfv3 administrative distance
+
+
+ external + +
+ integer +
+ 		+ +
Distance for external routes
+
+
+ inter_area + +
+ integer +
+ 		+ +
Distance for inter-area routes
+
+
+ intra_area + +
+ integer +
+ 		+ +
Distance for intra-area routes
+
+
+ distribute_list + +
+ dictionary +
+ 		+ +
Filter prefixes to/from RIB
+
+
+ prefix_list + +
+ list + / elements=string +
+ 		+ +
Filter prefixes based on an IPv6 prefix-list
+
+
+ in + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Filter prefixes installed to RIB
+
+
+ name + +
+ string +
+ 		+ +
Specify Prefix-list name
+
+
+ out + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Filter prefixes redistributed from RIB
+
+
+ encryption + +
+ dictionary +
+ 		+ +
Encrypt and authenticate OSPFv3 packets
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Do not encrypt OSPFv3 packets
+
+
+ ipsec + +
+ dictionary +
+ 		+ +
Specify IPSec ESP encryption and authentication
+
+
+ esp + +
+ dictionary +
+ 		+ +
Specify encryption parameters
+
+
+ aes + +
+ dictionary +
+ 		+ +
This specify the aes algorithim
+
+
+ algorithim_type + +
+ string +
+ 		+
    Choices: +
  • 192
    • +
  • 256
    • +
+ 		+
Specify the bit encryption for aes algorithim
+
+
+ clear_key + +
+ string +
+ 		+ +
Specify AES key in cleartext form
+
+
+ key + +
+ string +
+ 		+ +
Cleartext AES key
+
+
+ password_key + +
+ string +
+ 		+ +
Specify AES key in encrypted form
+
+
+ des + +
+ dictionary +
+ 		+ +
This specify the des algorithim
+
+
+ clear_key + +
+ string +
+ 		+ +
Specify AES key in cleartext form
+
+
+ key + +
+ string +
+ 		+ +
Cleartext AES key
+
+
+ password_key + +
+ string +
+ 		+ +
Specify AES key in encrypted form
+
+
+ null_encryption + +
+ dictionary +
+ 		+ +
Specify null encryption attributes
+
+
+ authentication + +
+ dictionary +
+ 		+ +
Specify authentication parameters
+
+
+ algorithim_type + +
+ string +
+ 		+
    Choices: +
  • md5
    • +
  • sha1
    • +
+ 		+
Specify the type of algorithim
+
+
+ clear_key + +
+ string +
+ 		+ +
Specify key in cleartext form
+
+
+ key + +
+ string +
+ 		+ +
Specify key
+
+
+ password_key + +
+ string +
+ 		+ +
Specify key in encrypted form
+
+
+ triple_des + +
+ dictionary +
+ 		+ +
This specify the triple DES algorithim
+
+
+ clear_key + +
+ string +
+ 		+ +
Specify 3DES key in cleartext form
+
+
+ key + +
+ string +
+ 		+ +
Cleartext 3DES key
+
+
+ password_key + +
+ string +
+ 		+ +
Specify 3DES key in encrypted form
+
+
+ spi + +
+ integer +
+ 		+ +
Specify the Security Parameter Index value
+
+
+ fast_reroute + +
+ dictionary +
+ 		+ +
Specify IP Fast Reroute
+
+
+ disabled + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable IP fast reroute
+
+
+ per_link + +
+ dictionary +
+ 		+ +
Specify per-prefix computation
+
+
+ information_type + +
+ string +
+ 		+
    Choices: +
  • exclude
    • +
  • lfa_candidate
    • +
+ 		+
Specify per-link LFA exclusion or FRR LFA candidate information
+
+
+ interface + +
+ dictionary +
+ 		+ +
Specify Per-link LFA exclusion information
+
+
+ bundle_ether + +
+ list + / elements=integer +
+ 		+ +
Specify Aggregated Ethernet interface(s)
+
+
+ bvi + +
+ list + / elements=integer +
+ 		+ +
Specify Bridge-Group Virtual Interface
+
+
+ fast_ethernet + +
+ list + / elements=string +
+ 		+ +
Specify FastEthernet/IEEE 802.3 interface(s)
+
+
+ fiftygige + +
+ list + / elements=string +
+ 		+ +
Specify FiftyGigE/IEEE 802.3 interface(s)
+
+
+ fortygige + +
+ list + / elements=string +
+ 		+ +
Specify FortyGigE/IEEE 802.3 interface(s)
+
+
+ fourhundredgige + +
+ list + / elements=string +
+ 		+ +
Specify FourHundredGigE/IEEE 802.3 interface(s)
+
+
+ gigabitethernet + +
+ list + / elements=string +
+ 		+ +
Specify GigabitEthernet/IEEE 802.3 interface(s)
+
+
+ hundredgige + +
+ list + / elements=string +
+ 		+ +
Specify HundredGigE/IEEE 802.3 interface(s)
+
+
+ mgmteth + +
+ list + / elements=string +
+ 		+ +
Specify MgmtEth/IEEE 802.3 interface(s)
+
+
+ multilink + +
+ list + / elements=string +
+ 		+ +
Specify Multilink network interface(s)
+
+
+ nve + +
+ list + / elements=integer +
+ 		+ +
Specify Network Virtualization Endpoint Interface(s)
+
+
+ pos_int + +
+ list + / elements=integer +
+ 		+ +
Specify Aggregated pos interface(s)
+
+
+ pw_ether + +
+ list + / elements=integer +
+ 		+ +
Specify PWHE Ethernet Interface
+
+
+ pw_iw + +
+ list + / elements=integer +
+ 		+ +
Specify PWHE VC11 IP Interworking Interface
+
+
+ serial + +
+ list + / elements=string +
+ 		+ +
Specify Serial network interface(s)
+
+
+ srp + +
+ list + / elements=string +
+ 		+ +
Specify SRP interface(s)
+
+
+ tengige + +
+ list + / elements=string +
+ 		+ +
Specify TenGigabitEthernet/IEEE 802.3 interface(s)
+
+
+ tunnel_ip + +
+ list + / elements=integer +
+ 		+ +
Specify GRE/IPinIP Tunnel Interface(s)
+
+
+ tunnel_ipsec + +
+ list + / elements=integer +
+ 		+ +
Specify IPSec Tunnel interface(s)
+
+
+ tunnel_mpls + +
+ integer +
+ 		+ +
MPLS Transport Protocol Tunnel interface
+
+
+ tunnel_mte + +
+ list + / elements=integer +
+ 		+ +
Specify MPLS Traffic Engineering P2MP Tunnel interface(s)
+
+
+ twentyfivegige + +
+ list + / elements=string +
+ 		+ +
Specify TwentyFiveGigabitEthernet/IEEE 802.3 interface(s)
+
+
+ twohundredgige + +
+ list + / elements=string +
+ 		+ +
Specify TwoHundredGigE/IEEE 802.3 interface(s)
+
+
+ use_candidate_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable backup selection from candidate-list only
+
+
+ per_prefix + +
+ dictionary +
+ 		+ +
Specify per-prefix computation
+
+
+ information_type + +
+ string +
+ 		+
    Choices: +
  • exclude
    • +
  • lfa_candidate
    • +
+ 		+
Specify per_prefix LFA exclusion or FRR LFA candidate information
+
+
+ interface + +
+ dictionary +
+ 		+ +
Specify Per-link LFA exclusion information
+
+
+ bundle_ether + +
+ list + / elements=integer +
+ 		+ +
Specify Aggregated Ethernet interface(s)
+
+
+ bvi + +
+ list + / elements=integer +
+ 		+ +
Specify Bridge-Group Virtual Interface
+
+
+ fast_ethernet + +
+ list + / elements=string +
+ 		+ +
Specify FastEthernet/IEEE 802.3 interface(s)
+
+
+ fiftygige + +
+ list + / elements=string +
+ 		+ +
Specify FiftyGigE/IEEE 802.3 interface(s)
+
+
+ fortygige + +
+ list + / elements=string +
+ 		+ +
Specify FortyGigE/IEEE 802.3 interface(s)
+
+
+ fourhundredgige + +
+ list + / elements=string +
+ 		+ +
Specify FourHundredGigE/IEEE 802.3 interface(s)
+
+
+ gigabitethernet + +
+ list + / elements=string +
+ 		+ +
Specify GigabitEthernet/IEEE 802.3 interface(s)
+
+
+ hundredgige + +
+ list + / elements=string +
+ 		+ +
Specify HundredGigE/IEEE 802.3 interface(s)
+
+
+ mgmteth + +
+ list + / elements=string +
+ 		+ +
Specify MgmtEth/IEEE 802.3 interface(s)
+
+
+ multilink + +
+ list + / elements=string +
+ 		+ +
Specify Multilink network interface(s)
+
+
+ nve + +
+ list + / elements=integer +
+ 		+ +
Specify Network Virtualization Endpoint Interface(s)
+
+
+ post_int + +
+ list + / elements=integer +
+ 		+ +
Specify Aggregated pos interface(s)
+
+
+ pw_ether + +
+ list + / elements=integer +
+ 		+ +
Specify PWHE Ethernet Interface
+
+
+ pw_iw + +
+ list + / elements=integer +
+ 		+ +
Specify PWHE VC11 IP Interworking Interface
+
+
+ serial + +
+ list + / elements=string +
+ 		+ +
Specify Serial network interface(s)
+
+
+ srp + +
+ list + / elements=string +
+ 		+ +
Specify SRP interface(s)
+
+
+ tengige + +
+ list + / elements=string +
+ 		+ +
Specify TenGigabitEthernet/IEEE 802.3 interface(s)
+
+
+ tunnel_ip + +
+ list + / elements=integer +
+ 		+ +
Specify GRE/IPinIP Tunnel Interface(s)
+
+
+ tunnel_ipsec + +
+ list + / elements=integer +
+ 		+ +
Specify IPSec Tunnel interface(s)
+
+
+ tunnel_mpls + +
+ integer +
+ 		+ +
MPLS Transport Protocol Tunnel interface
+
+
+ tunnel_mte + +
+ list + / elements=integer +
+ 		+ +
Specify MPLS Traffic Engineering P2MP Tunnel interface(s)
+
+
+ twentyfivegige + +
+ list + / elements=string +
+ 		+ +
Specify TwentyFiveGigabitEthernet/IEEE 802.3 interface(s)
+
+
+ twohundredgige + +
+ list + / elements=string +
+ 		+ +
Specify TwoHundredGigE/IEEE 802.3 interface(s)
+
+
+ use_candidate_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable backup selection from candidate-list only
+
+
+ flood_reduction + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable flood reduction
+
+
+ graceful_restart + +
+ dictionary +
+ 		+ +
Enable Graceful-Restart
+
+
+ helper_disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable router's helper support level
+
+
+ max_interval + +
+ integer +
+ 		+ +
Maximum route lifetime following restart
+
+
+ min_interval + +
+ integer +
+ 		+ +
Minimum interval between Graceful Restarts
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set graceful restart
+
+
+ hello_interval + +
+ integer +
+ 		+ +
Specify Time between HELLO packets
+
+
+ ignore_mospf_type6_lsa + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore MOSPF Type 6 LSA
+
+
+ instance_id + +
+ integer +
+ 		+ +
Specify instance ID
+
+
+ log_adjacency_changes + +
+ dictionary +
+ 		+ +
Log adjacency state changes
+
+
+ detail + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log all state changes
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable log adjacency changes
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set log adjacency
+
+
+ maximum + +
+ dictionary +
+ 		+ +
Set OSPFv3 limits
+
+
+ interfaces + +
+ integer +
+ 		+ +
Specify limit for number of interfaces
+
+
+ paths + +
+ integer +
+ 		+ +
Specify limit for number of paths
+
+
+ redistributed_prefixes + +
+ integer +
+ 		+ +
Specify limit for number of redistributed prefixes
+
+
+ mpls_ldp_sync + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable MPLS LDP Sync
+
+
+ mtu_ignore + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable ignoring of MTU in DBD packets
+
+
+ network + +
+ string +
+ 		+
    Choices: +
  • broadcast
    • +
  • non-broadcast
    • +
  • point-to-multipoint
    • +
  • point-to-point
    • +
+ 		+
Specify Network type
+
+
+ nsr + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable NSR for all VRFs in this process
+
+
+ packet_size + +
+ integer +
+ 		+ +
Specify limit size of OSPFv3 packets
+
+
+ passive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable/Disable routing updates on an interface
+
+
+ prefix_suppression + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Hide all transit addresses on this interface
+
+
+ priority + +
+ integer +
+ 		+ +
Specify Router priority
+
+
+ process_id + +
+ string + / required +
+ 		+ +
The OSPFv3 Process ID
+
+
+ protocol_shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Gracefully shutdown the OSPFv3 protocol
+
+
+ redistribute + +
+ dictionary +
+ 		+ +
Redistribute information from another routing Protocol
+
+
+ application + +
+ list + / elements=dictionary +
+ 		+ +
Specify application routes
+
+
+ id + +
+ string + / required +
+ 		+ +
OnePK Application name
+
+
+ metric + +
+ integer +
+ 		+ +
Specify metric for redistributed routes
+
+
+ metric_type + +
+ integer +
+ 		+ +
Specify OSPFv3 exterior metric type for redistributed routes
+
+
+ route_policy + +
+ string +
+ 		+ +
Apply route policy to redistribution
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set application route
+
+
+ tag + +
+ integer +
+ 		+ +
Set tag for routes redistributed into OSPFv3
+
+
+ bgp + +
+ list + / elements=dictionary +
+ 		+ +
Specify bgp routes
+
+
+ id + +
+ integer + / required +
+ 		+ +
BGP process name
+
+
+ metric + +
+ integer +
+ 		+ +
Specify metric for redistributed routes
+
+
+ metric_type + +
+ integer +
+ 		+ +
Specify OSPFv3 exterior metric type for redistributed routes
+
+
+ preserved_med + +
+ string +
+ 		+ +
Specify preserve med of BGP routes
+
+
+ route_policy + +
+ string +
+ 		+ +
Apply route policy to redistribution
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set bgp route number
+
+
+ tag + +
+ integer +
+ 		+ +
Set tag for routes redistributed into OSPFv3
+
+
+ connected + +
+ dictionary +
+ 		+ +
Specify connected routes
+
+
+ metric + +
+ integer +
+ 		+ +
Specify metric for redistributed routes
+
+
+ metric_type + +
+ integer +
+ 		+ +
Specify OSPFv3 exterior metric type for redistributed routes
+
+
+ route_policy + +
+ string +
+ 		+ +
Apply route policy to redistribution
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set connected route
+
+
+ tag + +
+ integer +
+ 		+ +
Set tag for routes redistributed into OSPFv3
+
+
+ eigrp + +
+ list + / elements=dictionary +
+ 		+ +
Specify eigrp routes
+
+
+ id + +
+ integer + / required +
+ 		+ +
EIGRP process name
+
+
+ match + +
+ string +
+ 		+
    Choices: +
  • external
    • +
  • internal
    • +
+ 		+
Redistribution of EIGRP routes
+
+
+ metric + +
+ integer +
+ 		+ +
Specify metric for redistributed routes
+
+
+ metric_type + +
+ integer +
+ 		+ +
Specify OSPFv3 exterior metric type for redistributed routes
+
+
+ route_policy + +
+ string +
+ 		+ +
Apply route policy to redistribution
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set bgp route number
+
+
+ tag + +
+ integer +
+ 		+ +
Set tag for routes redistributed into OSPFv3
+
+
+ isis + +
+ list + / elements=dictionary +
+ 		+ +
Specify IS-IS routes
+
+
+ id + +
+ string + / required +
+ 		+ +
IS-IS name
+
+
+ level + +
+ string +
+ 		+
    Choices: +
  • level-1
    • +
  • level-1-2
    • +
  • level-2
    • +
+ 		+
Specify IS-IS level routes
+
+
+ metric + +
+ integer +
+ 		+ +
Specify metric for redistributed routes
+
+
+ metric_type + +
+ integer +
+ 		+ +
Specify OSPFv3 exterior metric type for redistributed routes
+
+
+ route_policy + +
+ string +
+ 		+ +
Apply route policy to redistribution
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set IS-IS route number
+
+
+ tag + +
+ integer +
+ 		+ +
Set tag for routes redistributed into OSPFv3
+
+
+ mobile + +
+ dictionary +
+ 		+ +
Specify mobile routes
+
+
+ metric + +
+ integer +
+ 		+ +
Specify metric for redistributed routes
+
+
+ metric_type + +
+ integer +
+ 		+ +
Specify OSPFv3 exterior metric type for redistributed routes
+
+
+ route_policy + +
+ string +
+ 		+ +
Apply route policy to redistribution
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set mobile route number
+
+
+ tag + +
+ integer +
+ 		+ +
Set tag for routes redistributed into OSPFv3
+
+
+ ospfv3 + +
+ list + / elements=dictionary +
+ 		+ +
Specify ospfv3 routes
+
+
+ id + +
+ string + / required +
+ 		+ +
OSPFv3 process name
+
+
+ match + +
+ dictionary +
+ 		+ +
Redistribution of OSPFv3 routes
+
+
+ external + +
+ integer +
+ 		+
    Choices: +
  • 1
    • +
  • 2
    • +
+ 		+
Redistribute OSPFv3 external routes
+
+
+ internal + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Redistribute OSPFv3 internal routes
+
+
+ nssa_external + +
+ integer +
+ 		+
    Choices: +
  • 1
    • +
  • 2
    • +
+ 		+
Redistribute NSSA OSPFv3 external routes
+
+
+ metric + +
+ integer +
+ 		+ +
Specify metric for redistributed routes
+
+
+ metric_type + +
+ integer +
+ 		+ +
Specify OSPFv3 exterior metric type for redistributed routes
+
+
+ route_policy + +
+ string +
+ 		+ +
Apply route policy to redistribution
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set ospfv3 route number
+
+
+ tag + +
+ integer +
+ 		+ +
Set tag for routes redistributed into OSPFv3
+
+
+ static + +
+ dictionary +
+ 		+ +
Specify static routes
+
+
+ metric + +
+ integer +
+ 		+ +
Specify metric for redistributed routes
+
+
+ metric_type + +
+ integer +
+ 		+ +
Specify OSPFv3 exterior metric type for redistributed routes
+
+
+ route_policy + +
+ string +
+ 		+ +
Apply route policy to redistribution
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set static route
+
+
+ tag + +
+ integer +
+ 		+ +
Set tag for routes redistributed into OSPFv3
+
+
+ subscriber + +
+ dictionary +
+ 		+ +
Specify subscriber routes
+
+
+ metric + +
+ integer +
+ 		+ +
Specify metric for redistributed routes
+
+
+ metric_type + +
+ integer +
+ 		+ +
Specify OSPFv3 exterior metric type for redistributed routes
+
+
+ route_policy + +
+ string +
+ 		+ +
Apply route policy to redistribution
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set static route
+
+
+ tag + +
+ integer +
+ 		+ +
Set tag for routes redistributed into OSPFv3
+
+
+ retransmit_interval + +
+ integer +
+ 		+ +
Delay between LSA retransmissions
+
+
+ router_id + +
+ string +
+ 		+ +
ospfv3 router-id in IPv4 address format (A.B.C.D)
+
+
+ spf_prefix_priority + +
+ dictionary +
+ 		+ +
Specify SPF configuration
+
+
+ disable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable SPF prefix priority
+
+
+ route_policy + +
+ list + / elements=dictionary +
+ 		+ +
Specify the route-policy to prioritize route install
+
+
+ name + +
+ string +
+ 		+ +
Specify name of the policy
+
+
+ value + +
+ string +
+ 		+ +
Specify parameter values for the policy ()
+
+
+ stub_router + +
+ dictionary +
+ 		+ +
Enter stub router configuration submode
+
+
+ router_lsa + +
+ dictionary +
+ 		+ +
Modify self originated router LSAs
+
+
+ advertise_with + +
+ string +
+ 		+
    Choices: +
  • max-metric
    • +
  • r-bit
    • +
  • v6-bit
    • +
+ 		+
Advertise LSAs with specified type
+
+
+ always + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Force ospfv3 stub router mode unconditionally
+
+
+ external_lsa + +
+ dictionary +
+ 		+ +
Override External LSA metric in stub router mode
+
+
+ metric + +
+ integer +
+ 		+ +
Metric to use while in stub router mode
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set external lsa
+
+
+ include_stub + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Set maximum metric for stub links in stub router mode
+
+
+ on_proc_migration + +
+ integer +
+ 		+ +
Enter stub router mode on ospfv3 process migration
+
+
+ on_proc_restart + +
+ integer +
+ 		+ +
Enter stub router mode on ospfv3 process restart
+
+
+ on_startup + +
+ dictionary +
+ 		+ +
Enter stub router mode on startup
+
+
+ time + +
+ integer +
+ 		+ +
Time in seconds to stay in stub router mode
+
+
+ wait_for_bgp + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Exit stub router mode when BGP converges
+
+
+ on_switchover + +
+ integer +
+ 		+ +
Enter stub router mode on RP switchover
+
+
+ summary_lsa + +
+ dictionary +
+ 		+ +
Override Summary LSA metric in stub router mode
+
+
+ metric + +
+ integer +
+ 		+ +
Metric to use while in stub router mode
+
+
+ set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable summary LSA
+
+
+ summary_prefix + +
+ list + / elements=dictionary +
+ 		+ +
Configure IP address summaries
+
+
+ not_advertise + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Suppress routes that match the specified prefix/mask pair
+
+
+ prefix + +
+ string + / required +
+ 		+ +
IP summary address/mask (A.B.C.D/prefix)
+
+
+ tag + +
+ integer +
+ 		+ +
Set tag
+
+
+ timers + +
+ dictionary +
+ 		+ +
Adjust routing timers
+
+
+ lsa_arrival + +
+ integer +
+ 		+ +
Specify LSA arrival timers
+
+
+ pacing + +
+ dictionary +
+ 		+ +
Specify pacing timers
+
+
+ flood + +
+ integer +
+ 		+ +
Flood pacing timer
+
+
+ lsa_group + +
+ integer +
+ 		+ +
LSA group pacing timer
+
+
+ retransmission + +
+ integer +
+ 		+ +
LSA group pacing timer
+
+
+ throttle + +
+ dictionary +
+ 		+ +
Adjust throttle timers
+
+
+ lsa + +
+ dictionary +
+ 		+ +
Specify LSA throttle timers
+
+
+ all_lsa_initial + +
+ integer +
+ 		+ +
Delay to generate first occurrence of LSA in milliseconds
+
+
+ all_lsa_minimum + +
+ integer +
+ 		+ +
Minimum delay between originating the same LSA in milliseconds
+
+
+ spf + +
+ dictionary +
+ 		+ +
Specify SPF throttle timers
+
+
+ spf_initial + +
+ integer +
+ 		+ +
Delay to generate first occurrence of SPF in ms
+
+
+ spf_minimum + +
+ integer +
+ 		+ +
Minimum delay between originating the same SPF in ms
+
+
+ trace + +
+ dictionary +
+ 		+ +
Specify OSPF tracing options
+
+
+ size + +
+ string +
+ 		+ +
Delete existing buffer and create one with N entries
+
+
+ value + +
+ integer +
+ 		+ +
Specify trace entry
+
+
+ transmit_delay + +
+ integer +
+ 		+ +
Estimated time needed to send link-state update packet
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the IOS-XR device by executing the command show running-config router ospfv3.
+
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 IOS-XR 6.1.3 + - This module works with connection ``network_cli``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_ + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + # RP/0/RP0/CPU0:anton#show running-config router ospfv3 + # Thu Jun 11 15:54:44.569 UTC + # % No such configuration item(s) + # + + - name: Merge provided OSPFv3 configuration with the existing configuration + cisco.iosxr.iosxr_ospfv3: + config: + processes: + - process_id: 27 + areas: + - area_id: 10 + hello_interval: 2 + - process_id: 26 + authentication: + disable: true + - process_id: 10 + areas: + - area_id: 11 + default_cost: 5 + cost: 11 + - area_id: 22 + default_cost: 6 + - process_id: 30 + areas: + - area_id: 11 + default_cost: 5 + - area_id: 22 + default_cost: 6 + cost: 2 + default_metric: 10 + transmit_delay: 2 + hello_interval: 1 + dead_interval: 2 + retransmit_interval: 2 + packet_size: 577 + priority: 1 + router_id: '2.2.2.2' + demand_circuit: true + mtu_ignore: true + state: merged + + # + # + # ------------------------ + # Module Execution Result + # ------------------------ + # + # "before": {} + # + # "commands": [ + # "router ospfv3 10", + # "area 11 default-cost 5", + # "area 11 cost 11", + # "area 22 default-cost 6", + # "router ospfv3 26", + # "authentication disable", + # "router ospfv3 27", + # "area 10 hello-interval 2", + # "router ospfv3 30", + # "cost 2", + # "priority 1", + # "default-metric 10", + # "router-id 2.2.2.2", + # "demand-circuit", + # "packet-size 577", + # "transmit-delay 2", + # "dead-interval 2", + # "hello-interval 1", + # "retransmit-interval 2", + # "mtu-ignore", + # "area 11 default-cost 5", + # "area 22 default-cost 6" + # ] + # + # "after": { + # "processes": [ + # { + # "areas": [ + # { + # "area_id": "11", + # "cost": 11, + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "process_id": "10" + # }, + # { + # "authentication": { + # "disable": true + # }, + # "process_id": "26" + # }, + # { + # "areas": [ + # { + # "area_id": "10", + # "hello_interval": 2 + # } + # ], + # "process_id": "27" + # }, + # { + # "areas": [ + # { + # "area_id": "11", + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "cost": 2, + # "dead_interval": 2, + # "default_metric": 10, + # "demand_circuit": true, + # "hello_interval": 1, + # "mtu_ignore": true, + # "packet_size": 577, + # "priority": 1, + # "process_id": "30", + # "retransmit_interval": 2, + # "router_id": "2.2.2.2", + # "transmit_delay": 2 + # } + # ] + # } + # + # + # ------------ + # After state + # ------------ + # + # RP/0/RP0/CPU0:anton#show running-config router ospfv3 + # router ospfv3 10 + # area 11 + # cost 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # router ospfv3 26 + # authentication disable + # ! + # router ospfv3 27 + # area 10 + # hello-interval 2 + # ! + # area 20 + # ! + # area 30 + # ! + # ! + # router ospfv3 30 + # cost 2 + # priority 1 + # mtu-ignore + # packet-size 577 + # dead-interval 2 + # retransmit-interval 2 + # demand-circuit + # hello-interval 1 + # transmit-delay 2 + # router-id 2.2.2.2 + # default-metric 10 + # area 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # router ospfv3 10 + # area 11 + # cost 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # router ospfv3 26 + # authentication disable + # ! + # router ospfv3 27 + # area 10 + # hello-interval 2 + # ! + # area 20 + # ! + # area 30 + # ! + # ! + # router ospfv3 30 + # cost 2 + # priority 1 + # mtu-ignore + # packet-size 577 + # dead-interval 2 + # retransmit-interval 2 + # demand-circuit + # hello-interval 1 + # transmit-delay 2 + # router-id 2.2.2.2 + # default-metric 10 + # area 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + + + + # Using replaced + # + # ------------ + # Before state + # ------------ + # + # + # RP/0/RP0/CPU0:anton#show running-config router ospf + # router ospfv3 10 + # area 11 + # cost 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # router ospfv3 26 + # authentication disable + # ! + # router ospfv3 27 + # area 10 + # hello-interval 2 + # ! + # area 20 + # ! + # area 30 + # ! + # ! + # router ospfv3 30 + # cost 2 + # priority 1 + # mtu-ignore + # packet-size 577 + # dead-interval 2 + # retransmit-interval 2 + # demand-circuit + # hello-interval 1 + # transmit-delay 2 + # router-id 2.2.2.2 + # default-metric 10 + # area 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # router ospfv3 10 + # area 11 + # cost 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # router ospfv3 26 + # authentication disable + # ! + # router ospfv3 27 + # area 10 + # hello-interval 2 + # ! + # area 20 + # ! + # area 30 + # ! + # ! + # router ospfv3 30 + # cost 2 + # priority 1 + # mtu-ignore + # packet-size 577 + # dead-interval 2 + # retransmit-interval 2 + # demand-circuit + # hello-interval 1 + # transmit-delay 2 + # router-id 2.2.2.2 + # default-metric 10 + # area 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + + - name: Replace OSPFv3 routes configurations from the device + cisco.iosxr.iosxr_ospfv3: + config: + processes: + - process_id: 27 + areas: + - area_id: 10 + hello_interval: 2 + - area_id: 20 + cost: 2 + default_cost: 2 + - process_id: 26 + authentication: + disable: true + state: replaced + + # + # + # ------------------------ + # Module Execution Result + # ------------------------ + # + # "before": { + # "processes": [ + # { + # "areas": [ + # { + # "area_id": "11", + # "cost": 11, + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "process_id": "10" + # }, + # { + # "authentication": { + # "disable": true + # }, + # "process_id": "26" + # }, + # { + # "areas": [ + # { + # "area_id": "10", + # "hello_interval": 2 + # } + # ], + # "process_id": "27" + # }, + # { + # "areas": [ + # { + # "area_id": "11", + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "cost": 2, + # "dead_interval": 2, + # "default_metric": 10, + # "demand_circuit": true, + # "hello_interval": 1, + # "mtu_ignore": true, + # "packet_size": 577, + # "priority": 1, + # "process_id": "30", + # "retransmit_interval": 2, + # "router_id": "2.2.2.2", + # "transmit_delay": 2 + # } + # ] + # } + # + # "commands": [ + # "router ospfv3 27", + # "area 20 default-cost 2", + # "area 20 cost 2" + # ] + # + # "after": { + # "processes": [ + # { + # "areas": [ + # { + # "area_id": "11", + # "cost": 11, + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "process_id": "10" + # }, + # { + # "authentication": { + # "disable": true + # }, + # "process_id": "26" + # }, + # { + # "areas": [ + # { + # "area_id": "10", + # "hello_interval": 2 + # }, + # { + # "area_id": "20", + # "cost": 2, + # "default_cost": 2 + # } + # ], + # "process_id": "27" + # }, + # { + # "areas": [ + # { + # "area_id": "11", + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "cost": 2, + # "dead_interval": 2, + # "default_metric": 10, + # "demand_circuit": true, + # "hello_interval": 1, + # "mtu_ignore": true, + # "packet_size": 577, + # "priority": 1, + # "process_id": "30", + # "retransmit_interval": 2, + # "router_id": "2.2.2.2", + # "transmit_delay": 2 + # } + # ] + # } + # + # + # ----------- + # After state + # ----------- + # + # RP/0/RP0/CPU0:anton(config)#do show running-config router ospfv3 + # router ospfv3 10 + # area 11 + # cost 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # router ospfv3 26 + # authentication disable + # ! + # router ospfv3 27 + # area 10 + # hello-interval 2 + # ! + # area 20 + # cost 2 + # default-cost 2 + # ! + # area 30 + # ! + # ! + # router ospfv3 30 + # cost 2 + # priority 1 + # mtu-ignore + # packet-size 577 + # dead-interval 2 + # retransmit-interval 2 + # demand-circuit + # hello-interval 1 + # transmit-delay 2 + # router-id 2.2.2.2 + # default-metric 10 + # area 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + + + - name: Override existing OSPFv3 configurations from the device + cisco.iosxr.iosxr_ospfv3: + config: + processes: + - process_id: 27 + areas: + - area_id: 10 + hello_interval: 2 + authentication: + disable: true + - area_id: 20 + cost: 2 + default_cost: 2 + authentication: + disable: true + - process_id: 26 + areas: + - area_id: 10 + hello_interval: 2 + authentication: + disable: true + state: overridden + + # + # + # ------------------------ + # Module Execution Result + # ------------------------ + # + # "before": { + # "processes": [ + # { + # "areas": [ + # { + # "area_id": "11", + # "cost": 11, + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "process_id": "10" + # }, + # { + # "authentication": { + # "disable": true + # }, + # "process_id": "26" + # }, + # { + # "areas": [ + # { + # "area_id": "10", + # "hello_interval": 2 + # }, + # { + # "area_id": "20", + # "cost": 2, + # "default_cost": 2 + # } + # ], + # "process_id": "27" + # }, + # { + # "areas": [ + # { + # "area_id": "11", + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "cost": 2, + # "dead_interval": 2, + # "default_metric": 10, + # "demand_circuit": true, + # "hello_interval": 1, + # "mtu_ignore": true, + # "packet_size": 577, + # "priority": 1, + # "process_id": "30", + # "retransmit_interval": 2, + # "router_id": "2.2.2.2", + # "transmit_delay": 2 + # } + # ] + # } + # + # "commands": [ + # "router ospfv3 10", + # "no area 11 default-cost 5", + # "no area 11 cost 11", + # "no area 22 default-cost 6", + # "router ospfv3 30", + # "no cost 2", + # "no priority 1", + # "no default-metric 10", + # "no router-id 2.2.2.2", + # "no demand-circuit", + # "no packet-size 577", + # "no transmit-delay 2", + # "no dead-interval 2", + # "no hello-interval 1", + # "no retransmit-interval 2", + # "no mtu-ignore", + # "no area 11 default-cost 5", + # "no area 22 default-cost 6", + # "router ospfv3 26", + # "area 10 hello-interval 4" + # ] + # + # "after": { + # "processes": [ + # { + # "process_id": "10" + # }, + # { + # "areas": [ + # { + # "area_id": "10", + # "hello_interval": 4 + # } + # ], + # "authentication": { + # "disable": true + # }, + # "process_id": "26" + # }, + # { + # "areas": [ + # { + # "area_id": "10", + # "hello_interval": 2 + # }, + # { + # "area_id": "20", + # "cost": 2, + # "default_cost": 2 + # } + # ], + # "process_id": "27" + # }, + # { + # "process_id": "30" + # } + # ] + # } + # + # + # ----------- + # After state + # ----------- + # + # RP/0/RP0/CPU0:anton#show running-config router ospfv3 + # router ospfv3 10 + # area 11 + # ! + # area 22 + # ! + # ! + # router ospfv3 26 + # authentication disable + # area 10 + # hello-interval 4 + # ! + # ! + # router ospfv3 27 + # area 10 + # hello-interval 2 + # ! + # area 20 + # cost 2 + # default-cost 2 + # ! + # area 30 + # ! + # ! + # router ospfv3 30 + # area 11 + # ! + # area 22 + # ! + # ! + + + + # Using deleted + # + # ------------ + # Before state + # ------------ + # + # + # RP/0/RP0/CPU0:anton#show running-config router ospfv3 + # router ospfv3 10 + # area 11 + # ! + # area 22 + # ! + # ! + # router ospfv3 26 + # authentication disable + # area 10 + # hello-interval 4 + # ! + # ! + # router ospfv3 27 + # area 10 + # hello-interval 2 + # ! + # area 20 + # cost 2 + # default-cost 2 + # ! + # area 30 + # ! + # ! + # router ospfv3 30 + # area 11 + # ! + # area 22 + # ! + # ! + + - name: Deleted existing OSPFv3 configurations from the device + cisco.iosxr.iosxr_ospfv3: + config: + processes: + - process_id: '10' + - process_id: '26' + - process_id: '27' + - process_id: '30' + state: deleted + + # + # + # ------------------------ + # Module Execution Result + # ------------------------ + # + # "before": { + # "processes": [ + # { + # "process_id": "10" + # }, + # { + # "areas": [ + # { + # "area_id": "10", + # "hello_interval": 4 + # } + # ], + # "authentication": { + # "disable": true + # }, + # "process_id": "26" + # }, + # { + # "areas": [ + # { + # "area_id": "10", + # "hello_interval": 2 + # }, + # { + # "area_id": "20", + # "cost": 2, + # "default_cost": 2 + # } + # ], + # "process_id": "27" + # }, + # { + # "process_id": "30" + # } + # ] + # }, + # + # "commands": [ + # "router ospfv3 26", + # "no authentication disable", + # "no area 10 hello-interval 4", + # "router ospfv3 27", + # "no area 10 hello-interval 2", + # "no area 20 default-cost 2", + # "no area 20 cost 2" + # ] + # + # "after": { + # "processes": [ + # { + # "process_id": "10" + # }, + # { + # "process_id": "26" + # }, + # { + # "process_id": "27" + # }, + # { + # "process_id": "30" + # } + # ] + # } + # + # + # ----------- + # After state + # ----------- + # + # RP/0/RP0/CPU0:anton(config)#show running-config router ospfv3 + # router ospfv3 10 + # ! + # router ospfv3 26 + # ! + # router ospfv3 27 + # ! + # router ospfv3 30 + # ! + + + # Using parsed + # parsed.cfg + # ------------ + # router ospfv3 10 + # area 11 + # cost 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # router ospfv3 26 + # authentication disable + # ! + # router ospfv3 27 + # area 10 + # hello-interval 2 + # ! + # ! + # router ospfv3 30 + # router-id 2.2.2.2 + # cost 2 + # packet-size 577 + # priority 1 + # mtu-ignore + # dead-interval 2 + # retransmit-interval 2 + # demand-circuit + # hello-interval 1 + # transmit-delay 2 + # default-metric 10 + # area 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + - name: Parsed the device configuration to get output commands + cisco.iosxr.iosxr_ospfv3: + running_config: "{{ lookup('file', './parsed.cfg') }}" + state: parsed + # + # + # ------------------------- + # Module Execution Result + # ------------------------- + # + # + # "parsed": { + # "processes": [ + # { + # "areas": [ + # { + # "area_id": "11", + # "cost": 11, + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "process_id": "10" + # }, + # { + # "authentication": { + # "disable": true + # }, + # "process_id": "26" + # }, + # { + # "areas": [ + # { + # "area_id": "10", + # "hello_interval": 2 + # } + # ], + # "process_id": "27" + # }, + # { + # "areas": [ + # { + # "area_id": "11", + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "cost": 2, + # "dead_interval": 2, + # "default_metric": 10, + # "demand_circuit": true, + # "hello_interval": 1, + # "mtu_ignore": true, + # "packet_size": 577, + # "priority": 1, + # "process_id": "30", + # "retransmit_interval": 2, + # "router_id": "2.2.2.2", + # "transmit_delay": 2 + # } + # ] + # } + # + # Using rendered + # + # + - name: Render the commands for provided configuration + cisco.iosxr.iosxr_ospfv3: + config: + processes: + - process_id: 27 + areas: + - area_id: 10 + hello_interval: 2 + - process_id: 26 + authentication: + disable: true + - process_id: 10 + areas: + - area_id: 11 + default_cost: 5 + cost: 11 + - area_id: 22 + default_cost: 6 + - process_id: 30 + areas: + - area_id: 11 + default_cost: 5 + - area_id: 22 + default_cost: 6 + cost: 2 + default_metric: 10 + transmit_delay: 2 + hello_interval: 1 + dead_interval: 2 + retransmit_interval: 2 + packet_size: 577 + priority: 1 + router_id: '2.2.2.2' + demand_circuit: true + mtu_ignore: true + state: rendered + + # + # + # ------------------------- + # Module Execution Result + # ------------------------- + # + # + # "rendered": [ + # "router ospfv3 27", + # "area 10 hello-interval 2", + # "router ospfv3 26", + # "authentication disable", + # "router ospfv3 10", + # "area 11 default-cost 5", + # "area 11 cost 11", + # "area 22 default-cost 6", + # "router ospfv3 30", + # "cost 2", + # "priority 1", + # "default-metric 10", + # "router-id 2.2.2.2", + # "demand-circuit", + # "packet-size 577", + # "transmit-delay 2", + # "dead-interval 2", + # "hello-interval 1", + # "retransmit-interval 2", + # "mtu-ignore", + # "area 11 default-cost 5", + # "area 22 default-cost 6" + # ] + + + # Using gathered + # + # Before state: + # ------------- + # + # RP/0/RP0/CPU0:anton#show running-config router ospf + # router ospfv3 10 + # area 11 + # cost 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + # router ospfv3 26 + # authentication disable + # area 10 + # ! + # ! + # router ospfv3 27 + # area 10 + # hello-interval 2 + # ! + # area 20 + # ! + # area 30 + # ! + # ! + # router ospfv3 30 + # cost 2 + # priority 1 + # mtu-ignore + # packet-size 577 + # dead-interval 2 + # retransmit-interval 2 + # demand-circuit + # hello-interval 1 + # transmit-delay 2 + # router-id 2.2.2.2 + # default-metric 10 + # area 11 + # default-cost 5 + # ! + # area 22 + # default-cost 6 + # ! + # ! + + - name: Gather ospfv3 routes configuration + cisco.iosxr.iosxr_ospfv3: + state: gathered + # + # + # ------------------------- + # Module Execution Result + # ------------------------- + # + # "gathered": { + # "processes": [ + # { + # "areas": [ + # { + # "area_id": "11", + # "cost": 11, + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "process_id": "10" + # }, + # { + # "authentication": { + # "disable": true + # }, + # "process_id": "26" + # }, + # { + # "areas": [ + # { + # "area_id": "10", + # "hello_interval": 2 + # } + # ], + # "process_id": "27" + # }, + # { + # "areas": [ + # { + # "area_id": "11", + # "default_cost": 5 + # }, + # { + # "area_id": "22", + # "default_cost": 6 + # } + # ], + # "cost": 2, + # "dead_interval": 2, + # "default_metric": 10, + # "demand_circuit": true, + # "hello_interval": 1, + # "mtu_ignore": true, + # "packet_size": 577, + # "priority": 1, + # "process_id": "30", + # "retransmit_interval": 2, + # "router_id": "2.2.2.2", + # "transmit_delay": 2 + # } + # ] + # } + # + + + + +Status +------ + + +Authors +~~~~~~~ + +- Rohit Thakur (@rohitthakur2590) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_static_routes_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_static_routes_module.rst new file mode 100644 index 00000000..266e6fcc --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_static_routes_module.rst @@ -0,0 +1,1141 @@ +.. _cisco.iosxr.iosxr_static_routes_module: + + +******************************* +cisco.iosxr.iosxr_static_routes +******************************* + +**Static routes resource module** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages static routes on devices running Cisco IOS-XR. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary of static route options.
+
+
+ address_families + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary specifying the address family to which the static route(s) belong.
+
+
+ afi + +
+ string + / required +
+ 		+
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ 		+
Specifies the top level address family indicator.
+
+
+ routes + +
+ list + / elements=dictionary +
+ 		+ +
A dictionary that specifies the static route configurations.
+
+
+ dest + +
+ string + / required +
+ 		+ +
An IPv4 or IPv6 address in CIDR notation that specifies the destination network for the static route.
+
+
+ next_hops + +
+ list + / elements=dictionary +
+ 		+ +
Next hops to the specified destination.
+
+
+ admin_distance + +
+ integer +
+ 		+ +
The administrative distance for this static route.
+
Refer to vendor documentation for valid values.
+
+
+ description + +
+ string +
+ 		+ +
Specifies the description for this static route.
+
+
+ dest_vrf + +
+ string +
+ 		+ +
The destination VRF.
+
+
+ forward_router_address + +
+ string +
+ 		+ +
The IP address of the next hop that can be used to reach the destination network.
+
+
+ interface + +
+ string +
+ 		+ +
The interface to use to reach the destination.
+
+
+ metric + +
+ integer +
+ 		+ +
Specifes the metric for this static route.
+
Refer to vendor documentation for valid values.
+
+
+ tag + +
+ integer +
+ 		+ +
Specifies a numeric tag for this static route.
+
Refer to vendor documentation for valid values.
+
+
+ track + +
+ string +
+ 		+ +
Specifies the object to be tracked.
+
This enables object tracking for static routes.
+
+
+ tunnel_id + +
+ integer +
+ 		+ +
Specifies a tunnel id for the route.
+
Refer to vendor documentation for valid values.
+
+
+ vrflabel + +
+ integer +
+ 		+ +
Specifies the VRF label for this static route.
+
Refer to vendor documentation for valid values.
+
+
+ safi + +
+ string + / required +
+ 		+
    Choices: +
  • unicast
    • +
  • multicast
    • +
+ 		+
Specifies the subsequent address family indicator.
+
+
+ vrf + +
+ string +
+ 		+ +
The VRF to which the static route(s) belong.
+
+
+ running_config + +
+ string +
+ 		+ +
This option is used only with state parsed.
+
The value of this option should be the output received from the IOS-XR device by executing the command show running-config router static.
+
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.
+
+
+ + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state + # ------------- + # RP/0/RP0/CPU0:ios#show running-config router static + # Sat Feb 22 07:46:30.089 UTC + # % No such configuration item(s) + # + - name: Merge the provided configuration with the exisiting running configuration + cisco.iosxr.iosxr_static_routes: + config: + - address_families: + - afi: ipv4 + safi: unicast + routes: + - dest: 192.0.2.16/28 + next_hops: + - forward_router_address: 192.0.2.10 + interface: FastEthernet0/0/0/1 + description: LAB + metric: 120 + tag: 10 + + - interface: FastEthernet0/0/0/5 + track: ip_sla_1 + + - dest: 192.0.2.32/28 + next_hops: + - forward_router_address: 192.0.2.11 + admin_distance: 100 + + - afi: ipv6 + safi: unicast + routes: + - dest: 2001:db8:1000::/36 + next_hops: + - interface: FastEthernet0/0/0/7 + description: DC + + - interface: FastEthernet0/0/0/8 + forward_router_address: 2001:db8:2000:2::1 + + - vrf: DEV_SITE + address_families: + - afi: ipv4 + safi: unicast + routes: + - dest: 192.0.2.48/28 + next_hops: + - forward_router_address: 192.0.2.12 + description: DEV + dest_vrf: test_1 + + - dest: 192.0.2.80/28 + next_hops: + - interface: FastEthernet0/0/0/2 + forward_router_address: 192.0.2.14 + dest_vrf: test_1 + track: ip_sla_2 + vrflabel: 124 + state: merged + + # After state + # ------------- + # RP/0/RP0/CPU0:ios#show running-config router static + # Sat Feb 22 07:49:11.754 UTC + # router static + # address-family ipv4 unicast + # 192.0.2.16/28 FastEthernet0/0/0/1 192.0.2.10 tag 10 description LAB metric 120 + # 192.0.2.16/28 FastEthernet0/0/0/5 track ip_sla_1 + # 192.0.2.32/28 192.0.2.11 100 + # ! + # address-family ipv6 unicast + # 2001:db8:1000::/36 FastEthernet0/0/0/7 description DC + # 2001:db8:1000::/36 FastEthernet0/0/0/8 2001:db8:2000:2::1 + # ! + # vrf DEV_SITE + # address-family ipv4 unicast + # 192.0.2.48/28 vrf test_1 192.0.2.12 description DEV + # 192.0.2.80/28 vrf test_1 FastEthernet0/0/0/2 192.0.2.14 vrflabel 124 track ip_sla_2 + # ! + # ! + # ! + + # Using merged to update existing static routes + + # Before state + # ------------- + # RP/0/RP0/CPU0:ios#show running-config router static + # Sat Feb 22 07:49:11.754 UTC + # router static + # address-family ipv4 unicast + # 192.0.2.16/28 FastEthernet0/0/0/1 192.0.2.10 tag 10 description LAB metric 120 + # 192.0.2.16/28 FastEthernet0/0/0/5 track ip_sla_1 + # 192.0.2.32/28 192.0.2.11 100 + # ! + # address-family ipv6 unicast + # 2001:db8:1000::/36 FastEthernet0/0/0/7 description DC + # 2001:db8:1000::/36 FastEthernet0/0/0/8 2001:db8:2000:2::1 + # ! + # vrf DEV_SITE + # address-family ipv4 unicast + # 192.0.2.48/28 vrf test_1 192.0.2.12 description DEV + # 192.0.2.80/28 vrf test_1 FastEthernet0/0/0/2 192.0.2.14 vrflabel 124 track ip_sla_2 + # ! + # ! + # ! + + - name: Update existing static routes configuration using merged + cisco.iosxr.iosxr_static_routes: + config: + - vrf: DEV_SITE + address_families: + - afi: ipv4 + safi: unicast + routes: + - dest: 192.0.2.48/28 + next_hops: + - forward_router_address: 192.0.2.12 + vrflabel: 2301 + dest_vrf: test_1 + + - dest: 192.0.2.80/28 + next_hops: + - interface: FastEthernet0/0/0/2 + forward_router_address: 192.0.2.14 + dest_vrf: test_1 + description: rt_test_1 + state: merged + + # After state + # ------------- + # RP/0/RP0/CPU0:ios#show running-config router static + # Sat Feb 22 07:49:11.754 UTC + # router static + # address-family ipv4 unicast + # 192.0.2.16/28 FastEthernet0/0/0/1 192.0.2.10 tag 10 description LAB metric 120 + # 192.0.2.16/28 FastEthernet0/0/0/5 track ip_sla_1 + # 192.0.2.32/28 192.0.2.11 100 + # ! + # address-family ipv6 unicast + # 2001:db8:1000::/36 FastEthernet0/0/0/7 description DC + # 2001:db8:1000::/36 FastEthernet0/0/0/8 2001:db8:2000:2::1 + # ! + # vrf DEV_SITE + # address-family ipv4 unicast + # 192.0.2.48/28 vrf test_1 192.0.2.12 description DEV vrflabel 2301 + # 192.0.2.80/28 vrf test_1 192.0.2.14 FastEthernet0/0/0/2 description rt_test_1 track ip_sla_2 vrflabel 124 + # ! + # ! + # ! + + # Using replaced to replace all next hop entries for a single destination network + + # Before state + # -------------- + + # RP/0/RP0/CPU0:ios#sh running-config router static + # Sat Feb 22 07:59:08.669 UTC + # router static + # address-family ipv4 unicast + # 192.0.2.16/28 FastEthernet0/0/0/1 192.0.2.10 tag 10 description LAB metric 120 + # 192.0.2.16/28 FastEthernet0/0/0/5 track ip_sla_1 + # 192.0.2.32/28 192.0.2.11 100 + # ! + # address-family ipv6 unicast + # 2001:db8:1000::/36 FastEthernet0/0/0/7 description DC + # 2001:db8:1000::/36 FastEthernet0/0/0/8 2001:db8:2000:2::1 + # ! + # vrf DEV_SITE + # address-family ipv4 unicast + # 192.0.2.48/28 vrf test_1 192.0.2.12 description DEV + # 192.0.2.48/28 GigabitEthernet0/0/0/1 192.0.3.24 vrflabel 2302 + # 192.0.2.80/28 vrf test_1 FastEthernet0/0/0/2 192.0.2.14 vrflabel 124 track ip_sla_2 + # ! + # ! + # ! + + - name: Replace device configurations of static routes with provided configurations + cisco.iosxr.iosxr_static_routes: + config: + - vrf: DEV_SITE + address_families: + - afi: ipv4 + safi: unicast + routes: + - dest: 192.0.2.48/28 + next_hops: + - forward_router_address: 192.0.2.15 + interface: FastEthernet0/0/0/3 + description: DEV_NEW + dest_vrf: dev_test_2 + state: replaced + + # After state + # ------------ + # RP/0/RP0/CPU0:ios#sh running-config router static + # Sat Feb 22 08:04:07.085 UTC + # router static + # address-family ipv4 unicast + # 192.0.2.16/28 FastEthernet0/0/0/1 192.0.2.10 tag 10 description LAB metric 120 + # 192.0.2.16/28 FastEthernet0/0/0/5 track ip_sla_1 + # 192.0.2.32/28 192.0.2.11 100 + # ! + # address-family ipv6 unicast + # 2001:db8:1000::/36 FastEthernet0/0/0/7 description DC + # 2001:db8:1000::/36 FastEthernet0/0/0/8 2001:db8:2000:2::1 + # ! + # vrf DEV_SITE + # address-family ipv4 unicast + # 192.0.2.48/28 vrf dev_test_2 FastEthernet0/0/0/3 192.0.2.15 description DEV_NEW + # 192.0.2.80/28 vrf test_1 FastEthernet0/0/0/2 192.0.2.14 vrflabel 124 track ip_sla_2 + # ! + # ! + # ! + + # Using overridden to override all static route entries on the device + + # Before state + # ------------- + # RP/0/RP0/CPU0:ios#sh running-config router static + # Sat Feb 22 07:59:08.669 UTC + # router static + # address-family ipv4 unicast + # 192.0.2.16/28 FastEthernet0/0/0/1 192.0.2.10 tag 10 description LAB metric 120 + # 192.0.2.16/28 FastEthernet0/0/0/5 track ip_sla_1 + # 192.0.2.32/28 192.0.2.11 100 + # ! + # address-family ipv6 unicast + # 2001:db8:1000::/36 FastEthernet0/0/0/7 description DC + # 2001:db8:1000::/36 FastEthernet0/0/0/8 2001:db8:2000:2::1 + # ! + # vrf DEV_SITE + # address-family ipv4 unicast + # 192.0.2.48/28 vrf test_1 192.0.2.12 description DEV + # 192.0.2.48/28 GigabitEthernet0/0/0/1 192.0.3.24 vrflabel 2302 + # 192.0.2.80/28 vrf test_1 FastEthernet0/0/0/2 192.0.2.14 vrflabel 124 track ip_sla_2 + # ! + # ! + # ! + + - name: Overridde all static routes configuration with provided configuration + cisco.iosxr.iosxr_static_routes: + config: + - vrf: DEV_NEW + address_families: + - afi: ipv4 + safi: unicast + routes: + - dest: 192.0.2.48/28 + next_hops: + - forward_router_address: 192.0.2.15 + interface: FastEthernet0/0/0/3 + description: DEV1 + - afi: ipv6 + safi: unicast + routes: + - dest: 2001:db8:3000::/36 + next_hops: + - interface: FastEthernet0/0/0/4 + forward_router_address: 2001:db8:2000:2::2 + description: PROD1 + track: ip_sla_1 + state: overridden + + # After state + # ------------- + # RP/0/RP0/CPU0:ios#sh running-config router static + # Sat Feb 22 08:07:41.516 UTC + # router static + # vrf DEV_NEW + # address-family ipv4 unicast + # 192.0.2.48/28 FastEthernet0/0/0/3 192.0.2.15 description DEV1 + # ! + # address-family ipv6 unicast + # 2001:db8:3000::/36 FastEthernet0/0/0/4 2001:db8:2000:2::2 description PROD1 track ip_sla_1 + # ! + # ! + # ! + + # Using deleted to delete all destination network entries under a single AFI + + # Before state + # ------------- + # RP/0/RP0/CPU0:ios#sh running-config router static + # Sat Feb 22 07:59:08.669 UTC + # router static + # address-family ipv4 unicast + # 192.0.2.16/28 FastEthernet0/0/0/1 192.0.2.10 tag 10 description LAB metric 120 + # 192.0.2.16/28 FastEthernet0/0/0/5 track ip_sla_1 + # 192.0.2.32/28 192.0.2.11 100 + # ! + # address-family ipv6 unicast + # 2001:db8:1000::/36 FastEthernet0/0/0/7 description DC + # 2001:db8:1000::/36 FastEthernet0/0/0/8 2001:db8:2000:2::1 + # ! + # vrf DEV_SITE + # address-family ipv4 unicast + # 192.0.2.48/28 vrf test_1 192.0.2.12 description DEV + # 192.0.2.48/28 GigabitEthernet0/0/0/1 192.0.3.24 vrflabel 2302 + # 192.0.2.80/28 vrf test_1 FastEthernet0/0/0/2 192.0.2.14 vrflabel 124 track ip_sla_2 + # ! + # ! + # ! + + - name: Delete all destination network entries under a single AFI + cisco.iosxr.iosxr_static_routes: + config: + - vrf: DEV_SITE + address_families: + - afi: ipv4 + safi: unicast + state: deleted + + # After state + # ------------ + + # RP/0/RP0/CPU0:ios#sh running-config router static + # Sat Feb 22 08:16:41.464 UTC + # router static + # address-family ipv4 unicast + # 192.0.2.16/28 FastEthernet0/0/0/1 192.0.2.10 tag 10 description LAB metric 120 + # 192.0.2.16/28 FastEthernet0/0/0/5 track ip_sla_1 + # 192.0.2.32/28 192.0.2.11 100 + # ! + # address-family ipv6 unicast + # 2001:db8:1000::/36 FastEthernet0/0/0/7 description DC + # 2001:db8:1000::/36 FastEthernet0/0/0/8 2001:db8:2000:2::1 + # ! + # vrf DEV_SITE + # ! + # ! + + # Using deleted to remove all static route entries from the device + + # Before state + # ------------- + # RP/0/RP0/CPU0:ios#sh running-config router static + # Sat Feb 22 07:59:08.669 UTC + # router static + # address-family ipv4 unicast + # 192.0.2.16/28 FastEthernet0/0/0/1 192.0.2.10 tag 10 description LAB metric 120 + # 192.0.2.16/28 FastEthernet0/0/0/5 track ip_sla_1 + # 192.0.2.32/28 192.0.2.11 100 + # ! + # address-family ipv6 unicast + # 2001:db8:1000::/36 FastEthernet0/0/0/7 description DC + # 2001:db8:1000::/36 FastEthernet0/0/0/8 2001:db8:2000:2::1 + # ! + # vrf DEV_SITE + # address-family ipv4 unicast + # 192.0.2.48/28 vrf test_1 192.0.2.12 description DEV + # 192.0.2.48/28 GigabitEthernet0/0/0/1 192.0.3.24 vrflabel 2302 + # 192.0.2.80/28 vrf test_1 FastEthernet0/0/0/2 192.0.2.14 vrflabel 124 track ip_sla_2 + # ! + # ! + # ! + + - name: Delete static routes configuration + cisco.iosxr.iosxr_static_routes: + state: deleted + + # After state + # ------------ + # RP/0/RP0/CPU0:ios#sh running-config router static + # Sat Feb 22 08:50:43.038 UTC + # % No such configuration item(s) + + # Using gathered to gather static route facts from the device + + - name: Gather static routes facts from the device using iosxr_static_routes module + cisco.iosxr.iosxr_static_routes: + state: gathered + + # Task output (redacted) + # ----------------------- + # "gathered": [ + # { + # "address_families": [ + # { + # "afi": "ipv4", + # "routes": [ + # { + # "dest": "192.0.2.16/28", + # "next_hops": [ + # { + # "description": "LAB", + # "forward_router_address": "192.0.2.10", + # "interface": "FastEthernet0/0/0/1", + # "metric": 120, + # "tag": 10 + # }, + # { + # "interface": "FastEthernet0/0/0/5", + # "track": "ip_sla_1" + # } + # ] + # }, + # { + # "dest": "192.0.2.32/28", + # "next_hops": [ + # { + # "admin_distance": 100, + # "forward_router_address": "192.0.2.11" + # } + # ] + # } + # ], + # "safi": "unicast" + # }, + # { + # "afi": "ipv6", + # "routes": [ + # { + # "dest": "2001:db8:1000::/36", + # "next_hops": [ + # { + # "description": "DC", + # "interface": "FastEthernet0/0/0/7" + # }, + # { + # "forward_router_address": "2001:db8:2000:2::1", + # "interface": "FastEthernet0/0/0/8" + # } + # ] + # } + # ], + # "safi": "unicast" + # } + # ] + # }, + # { + # "address_families": [ + # { + # "afi": "ipv4", + # "routes": [ + # { + # "dest": "192.0.2.48/28", + # "next_hops": [ + # { + # "description": "DEV", + # "dest_vrf": "test_1", + # "forward_router_address": "192.0.2.12" + # }, + # { + # "forward_router_address": "192.0.3.24", + # "interface": "GigabitEthernet0/0/0/1", + # "vrflabel": 2302 + # } + # ] + # }, + # { + # "dest": "192.0.2.80/28", + # "next_hops": [ + # { + # "dest_vrf": "test_1", + # "forward_router_address": "192.0.2.14", + # "interface": "FastEthernet0/0/0/2", + # "track": "ip_sla_2", + # "vrflabel": 124 + # } + # ] + # } + # ], + # "safi": "unicast" + # } + # ], + # "vrf": "DEV_SITE" + # } + # ] + + # Using rendered + + - name: Render platform specific commands (without connecting to the device) + cisco.iosxr.iosxr_static_routes: + config: + - vrf: DEV_SITE + address_families: + - afi: ipv4 + safi: unicast + routes: + - dest: 192.0.2.48/28 + next_hops: + - forward_router_address: 192.0.2.12 + description: DEV + dest_vrf: test_1 + + - dest: 192.0.2.80/28 + next_hops: + - interface: FastEthernet0/0/0/2 + forward_router_address: 192.0.2.14 + dest_vrf: test_1 + track: ip_sla_2 + vrflabel: 124 + + # Task Output (redacted) + # ----------------------- + # "rendered": [ + # "router static"s, + # "vrf DEV_SITE", + # "address-family ipv4 unicast", + # "192.0.2.48/28 vrf test_1 192.0.2.12 description DEV", + # "192.0.2.80/28 vrf test_1 192.0.2.14 FastEthernet0/0/0/2 track ip_sla_2 vrflabel 124" + + # Using parsed + + # parsed.cfg + # ------------ + # Fri Nov 29 21:10:41.896 UTC + # router static + # address-family ipv4 unicast + # 192.0.2.16/28 FastEthernet0/0/0/1 192.0.2.10 tag 10 description LAB metric 120 + # 192.0.2.16/28 FastEthernet0/0/0/5 track ip_sla_1 + # 192.0.2.32/28 192.0.2.11 100 + # ! + # address-family ipv6 unicast + # 2001:db8:1000::/36 FastEthernet0/0/0/7 description DC + # 2001:db8:1000::/36 FastEthernet0/0/0/8 2001:db8:2000:2::1 + # ! + # vrf DEV_SITE + # address-family ipv4 unicast + # 192.0.2.48/28 vrf test_1 192.0.2.12 description DEV + # 192.0.2.80/28 vrf test_1 FastEthernet0/0/0/2 192.0.2.14 vrflabel 124 track ip_sla_2 + # ! + # ! + # ! + + - name: Use parsed state to convert externally supplied device specific static routes + commands to structured format + cisco.iosxr.iosxr_static_routes: + running_config: "{{ lookup('file', '../../fixtures/parsed.cfg') }}" + state: parsed + + # Task output (redacted) + # ----------------------- + # "parsed": [ + # { + # "address_families": [ + # { + # "afi": "ipv4", + # "routes": [ + # { + # "dest": "192.0.2.16/28", + # "next_hops": [ + # { + # "description": "LAB", + # "forward_router_address": "192.0.2.10", + # "interface": "FastEthernet0/0/0/1", + # "metric": 120, + # "tag": 10 + # }, + # { + # "interface": "FastEthernet0/0/0/5", + # "track": "ip_sla_1" + # } + # ] + # }, + # { + # "dest": "192.0.2.32/28", + # "next_hops": [ + # { + # "admin_distance": 100, + # "forward_router_address": "192.0.2.11" + # } + # ] + # } + # ], + # "safi": "unicast" + # }, + # { + # "afi": "ipv6", + # "routes": [ + # { + # "dest": "2001:db8:1000::/36", + # "next_hops": [ + # { + # "description": "DC", + # "interface": "FastEthernet0/0/0/7" + # }, + # { + # "forward_router_address": "2001:db8:2000:2::1", + # "interface": "FastEthernet0/0/0/8" + # } + # ] + # } + # ], + # "safi": "unicast" + # } + # ] + # }, + # { + # "address_families": [ + # { + # "afi": "ipv4", + # "routes": [ + # { + # "dest": "192.0.2.48/28", + # "next_hops": [ + # { + # "description": "DEV", + # "dest_vrf": "test_1", + # "forward_router_address": "192.0.2.12" + # } + # ] + # }, + # { + # "dest": "192.0.2.80/28", + # "next_hops": [ + # { + # "dest_vrf": "test_1", + # "forward_router_address": "192.0.2.14", + # "interface": "FastEthernet0/0/0/2", + # "track": "ip_sla_2", + # "vrflabel": 124 + # } + # ] + # } + # ], + # "safi": "unicast" + # } + # ], + # "vrf": "DEV_SITE" + # } + # ] + # } + + + +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:
+
['router static', 'vrf dev_site', 'address-family ipv4 unicast', '192.0.2.48/28 192.0.2.12 FastEthernet0/0/0/1 track ip_sla_10 description dev1', 'address-family ipv6 unicast', 'no 2001:db8:1000::/36', '2001:db8:3000::/36 2001:db8:2000:2::2 FastEthernet0/0/0/4 track ip_sla_11 description prod1']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_system_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_system_module.rst new file mode 100644 index 00000000..c2c25a78 --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_system_module.rst @@ -0,0 +1,427 @@ +.. _cisco.iosxr.iosxr_system_module: + + +************************ +cisco.iosxr.iosxr_system +************************ + +**Manage the system attributes on Cisco IOS XR devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module provides declarative management of node system attributes on Cisco IOS XR devices. It provides an option to configure host system parameters or remove those parameters from the device active configuration. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- ncclient >= 0.5.3 when using netconf +- lxml >= 4.1.1 when using netconf + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ domain_name + +
+ string +
+ 		+ +
Configure the IP domain name on the remote device to the provided value. Value should be in the dotted name form and will be appended to the hostname to create a fully-qualified domain name.
+
+
+ domain_search + +
+ list + / elements=string +
+ 		+ +
Provides the list of domain suffixes to append to the hostname for the purpose of doing name resolution. This argument accepts a list of names and will be reconciled with the current active configuration on the running node.
+
+
+ hostname + +
+ string +
+ 		+ +
Configure the device hostname parameter. This option takes an ASCII string value.
+
+
+ lookup_enabled + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
Provides administrative control for enabling or disabling DNS lookups. When this argument is set to True, lookups are performed and when it is set to False, lookups are not performed.
+
+
+ lookup_source + +
+ string +
+ 		+ +
The lookup_source argument provides one or more source interfaces to use for performing DNS lookups. The interface provided in lookup_source must be a valid interface configured on the device.
+
+
+ name_servers + +
+ list + / elements=string +
+ 		+ +
The name_serves argument accepts a list of DNS name servers by way of either FQDN or IP address to use to perform name resolution lookups. This argument accepts wither a list of DNS servers See examples.
+
+
+ provider + +
+ dictionary +
+ 		+ +
Deprecated
+
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
For more information please see the Network Guide.
+
+
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ port + +
+ integer +
+ 		+ +
Specifies the port to use when building the connection to the remote device.
+
+
+ ssh_keyfile + +
+ path +
+ 		+ +
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
+
+
+ timeout + +
+ integer +
+ 		+ +
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
+
+
+ transport + +
+ string +
+ 		+
    Choices: +
  • cli ←
    • +
  • netconf
    • +
+ 		+
Specifies the type of connection based transport.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
State of the configuration values in the device's current active configuration. When set to present, the values should be configured in the device active configuration and when set to absent the values should not be in the device active configuration
+
+
+ vrf + +
+ string +
+ 		+ Default:
"default"
+ 		+
VRF name for domain services
+
+
+ + +Notes +----- + +.. note:: + - This module works with connection ``network_cli`` and ``netconf``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_. + - Tested against IOS XRv 6.1.3 + - name-servers *state=absent* operation with ``netconf`` transport is a success, but with rpc-error. This is due to XR platform issue. Recommended to use *ignore_errors* option with the task as a workaround. + - For more information on using Ansible to manage network devices see 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 hostname and domain-name (default vrf=default) + cisco.iosxr.iosxr_system: + hostname: iosxr01 + domain_name: test.example.com + domain_search: + - ansible.com + - redhat.com + - cisco.com + - name: remove configuration + cisco.iosxr.iosxr_system: + hostname: iosxr01 + domain_name: test.example.com + domain_search: + - ansible.com + - redhat.com + - cisco.com + state: absent + - name: configure hostname and domain-name with vrf + cisco.iosxr.iosxr_system: + hostname: iosxr01 + vrf: nondefault + domain_name: test.example.com + domain_search: + - ansible.com + - redhat.com + - cisco.com + - name: configure DNS lookup sources + cisco.iosxr.iosxr_system: + lookup_source: MgmtEth0/0/CPU0/0 + lookup_enabled: true + - name: configure name servers + cisco.iosxr.iosxr_system: + name_servers: + - 8.8.8.8 + - 8.8.4.4 + + + +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:
+
['hostname iosxr01', 'ip domain-name test.example.com']
+
+
+ xml + +
+ list +
+ 		always (empty list when no xml rpc to send) +
NetConf rpc xml sent to device with transport netconf
+
+
Sample:
+
['<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0"> <ip-domain xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-ip-domain-cfg"> <vrfs> <vrf> <vrf-name>default</vrf-name> <lists> <list xc:operation="merge"> <order>0</order> <list-name>redhat.com</list-name> </list> </lists> </vrf> </vrfs> </ip-domain> </config>']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Peter Sprygada (@privateip) +- Kedar Kekan (@kedarX) diff --git a/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_user_module.rst b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_user_module.rst new file mode 100644 index 00000000..fc8cefb3 --- /dev/null +++ b/collections-debian-merged/ansible_collections/cisco/iosxr/docs/cisco.iosxr.iosxr_user_module.rst @@ -0,0 +1,651 @@ +.. _cisco.iosxr.iosxr_user_module: + + +********************** +cisco.iosxr.iosxr_user +********************** + +**Manage the aggregate of local users on Cisco IOS XR device** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module provides declarative management of the local usernames configured on network devices. It allows playbooks to manage either individual usernames or the aggregate of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- ncclient >= 0.5.3 when using netconf +- lxml >= 4.1.1 when using netconf +- base64 when using *public_key_contents* or *public_key* +- paramiko when using *public_key_contents* or *public_key* + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ admin + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Enters into administration configuration mode for making config changes to the device.
+
Applicable only when using network_cli transport
+
+
+ aggregate + +
+ list + / elements=dictionary +
+ 		+ +
The set of username objects to be configured on the remote Cisco IOS XR 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
+
+
+ admin + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enters into administration configuration mode for making config changes to the device.
+
Applicable only when using network_cli transport
+
+
+ configured_password + +
+ string +
+ 		+ +
The password to be configured on the Cisco IOS XR device. The password needs to be provided in clear text. Password is encrypted on the device when used with cli and by Ansible when used with netconf using the same MD5 hash technique with salt size of 3. Please note that this option is not same as provider password.
+
+
+ group + +
+ string +
+ 		+ +
Configures the group for the username in the device running configuration. The argument accepts a string value defining the group name. This argument does not check if the group has been configured on the device.
+

aliases: role
+
+
+ groups + +
+ list + / elements=string +
+ 		+ +
Configures the groups for the username in the device running configuration. The argument accepts a list of group names. This argument does not check if the group has been configured on the device. It is similar to the aggregate command for usernames, but lets you configure multiple groups for the user(s).
+
+
+ name + +
+ string + / required +
+ 		+ +
The username to be configured on the Cisco IOS XR device. This argument accepts a string value and is mutually exclusive with the aggregate argument. Please note that this option is not same as provider username.
+
+
+ public_key + +
+ string +
+ 		+ +
Configures the contents of the public keyfile to upload to the IOS-XR node. This enables users to login using the accompanying private key. IOS-XR only accepts base64 decoded files, so this will be decoded and uploaded to the node. Do note that this requires an OpenSSL public key file, PuTTy generated files will not work! Mutually exclusive with public_key_contents. If used with multiple users in aggregates, then the same key file is used for all users.
+
+
+ public_key_contents + +
+ string +
+ 		+ +
Configures the contents of the public keyfile to upload to the IOS-XR node. This enables users to login using the accompanying private key. IOS-XR only accepts base64 decoded files, so this will be decoded and uploaded to the node. Do note that this requires an OpenSSL public key file, PuTTy generated files will not work! Mutually exclusive with public_key.If used with multiple users in aggregates, then the same key file is used for all users.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
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 Cisco IOS XR device. The password needs to be provided in clear text. Password is encrypted on the device when used with cli and by Ansible when used with netconf using the same MD5 hash technique with salt size of 3. Please note that this option is not same as provider password.
+
+
+ group + +
+ string +
+ 		+ +
Configures the group for the username in the device running configuration. The argument accepts a string value defining the group name. This argument does not check if the group has been configured on the device.
+

aliases: role
+
+
+ groups + +
+ list + / elements=string +
+ 		+ +
Configures the groups for the username in the device running configuration. The argument accepts a list of group names. This argument does not check if the group has been configured on the device. It is similar to the aggregate command for usernames, but lets you configure multiple groups for the user(s).
+
+
+ name + +
+ string +
+ 		+ +
The username to be configured on the Cisco IOS XR device. This argument accepts a string value and is mutually exclusive with the aggregate argument. Please note that this option is not same as provider username.
+
+
+ provider + +
+ dictionary +
+ 		+ +
Deprecated
+
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
For more information please see the Network Guide.
+
+
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ port + +
+ integer +
+ 		+ +
Specifies the port to use when building the connection to the remote device.
+
+
+ ssh_keyfile + +
+ path +
+ 		+ +
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
+
+
+ timeout + +
+ integer +
+ 		+ +
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
+
+
+ transport + +
+ string +
+ 		+
    Choices: +
  • cli ←
    • +
  • netconf
    • +
+ 		+
Specifies the type of connection based transport.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ public_key + +
+ string +
+ 		+ +
Configures the contents of the public keyfile to upload to the IOS-XR node. This enables users to login using the accompanying private key. IOS-XR only accepts base64 decoded files, so this will be decoded and uploaded to the node. Do note that this requires an OpenSSL public key file, PuTTy generated files will not work! Mutually exclusive with public_key_contents. If used with multiple users in aggregates, then the same key file is used for all users.
+
+
+ public_key_contents + +
+ string +
+ 		+ +
Configures the contents of the public keyfile to upload to the IOS-XR node. This enables users to login using the accompanying private key. IOS-XR only accepts base64 decoded files, so this will be decoded and uploaded to the node. Do note that this requires an OpenSSL public key file, PuTTy generated files will not work! Mutually exclusive with public_key.If used with multiple users in aggregates, then the same key file is used for all users.
+
+
+ purge + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
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 and the current defined set of users.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
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:: + - This module works with connection ``network_cli`` and ``netconf``. See `the IOS-XR Platform Options <../network/user_guide/platform_iosxr.html>`_. + - Tested against IOS XRv 6.1.3 + - For more information on using Ansible to manage network devices see 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.iosxr.iosxr_user: + name: ansible + configured_password: mypassword + state: present + - name: create a new user in admin configuration mode + cisco.iosxr.iosxr_user: + name: ansible + configured_password: mypassword + admin: true + state: present + - name: remove all users except admin + cisco.iosxr.iosxr_user: + purge: true + - name: set multiple users to group sys-admin + cisco.iosxr.iosxr_user: + aggregate: + - name: netop + - name: netend + group: sysadmin + state: present + - name: set multiple users to multiple groups + cisco.iosxr.iosxr_user: + aggregate: + - name: netop + - name: netend + groups: + - sysadmin + - root-system + state: present + - name: Change Password for User netop + cisco.iosxr.iosxr_user: + name: netop + configured_password: '{{ new_password }}' + update_password: always + state: present + - name: Add private key authentication for user netop + cisco.iosxr.iosxr_user: + name: netop + state: present + public_key_contents: "{{ lookup('file', '/home/netop/.ssh/id_rsa.pub' }}" + + + +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:
+
['username ansible secret password group sysadmin', 'username admin secret admin']
+
+
+ xml + +
+ list +
+ 		always (empty list when no xml rpc to send) +
NetConf rpc xml sent to device with transport netconf
+
+
Sample:
+
['<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0"> <aaa xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-aaa-lib-cfg"> <usernames xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-aaa-locald-cfg"> <username xc:operation="merge"> <name>test7</name> <usergroup-under-usernames> <usergroup-under-username> <name>sysadmin</name> </usergroup-under-username> </usergroup-under-usernames> <secret>$1$ZsXC$zZ50wqhDC543ZWQkkAHLW0</secret> </username> </usernames> </aaa> </config>']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) +- Sebastiaan van Doesselaar (@sebasdoes) +- Kedar Kekan (@kedarX) -- cgit v1.2.3