+
+ | Parameter |
+ Choices/Defaults |
+ Comments |
+
+
+ |
+
+ config
+
+
+ list
+ / elements=dictionary
+
+ |
+
+ |
+
+ A list of dictionaries containing Links information.
+ |
+
+
+ |
+
+
+ dst_device
+
+
+ string
+ / required
+
+ |
+
+ |
+
+ IP address or DNS name of the destination switch which is part of the link being configured.
+ |
+
+
+ |
+
+
+ dst_fabric
+
+
+ string
+ / required
+
+ |
+
+ |
+
+ Name of the destination fabric. If this is same as 'src_fabric' then the link is considered intra-fabric link. If this parameter is different from 'src_fabric', then the link is considered inter-fabric link.
+ |
+
+
+ |
+
+
+ dst_interface
+
+
+ string
+ / required
+
+ |
+
+ |
+
+ Interface on the destination device which is part of the link being configured.
+ |
+
+
+ |
+
+
+ profile
+
+
+ -
+
+ |
+
+ |
+
+ Additional link related parameters that must be included while creating links.
+ |
+
+
+ |
+ |
+
+
+ admin_state
+
+
+ boolean
+ / required
+
+ |
+
+
+ |
+
+ Admin state of the link.
+ This parameter is not required if template is 'ext_evpn_multisite_overlay_setup', 'ext_multisite_underlay_setup', and 'ext_fabric_setup'.
+ |
+
+
+ |
+ |
+
+
+ auto_deploy
+
+
+ string
+ / required
+
+ |
+
+ |
+
+ Flag that controls auto generation of neighbor VRF Lite configuration for managed neighbor devices.
+ This parameter is required only if template is 'ext_fabric_setup'.
+ |
+
+
+ |
+ |
+
+
+ bgp_multihop
+
+
+ integer
+
+ |
+
+ Default:
5
+ |
+
+ eBGP Time-To-Live Value for Remote Peer.
+ This parameter is required only if template is 'ext_evpn_multisite_overlay_setup'.
+ |
+
+
+ |
+ |
+
+
+ deploy_dci_tracking
+
+
+ boolean
+
+ |
+
+
+ |
+
+ Flag to enable deploy DCI tracking.
+ This parameter is required only if template is 'ext_multisite_underlay_setup'.
+ This parameter MUST be included only if the fabrics are part of multisite.
+ |
+
+
+ |
+ |
+
+
+ dst_asn
+
+
+ string
+ / required
+
+ |
+
+ |
+
+ BGP ASN number on the destination fabric.
+ This parameter is required only if template is 'ext_fabric_setup' or 'ext_multisite_underlay_setup'. or "ext_evpn_multisite_overlay_setup"
+ |
+
+
+ |
+ |
+
+
+ ebgp_auth_key_type
+
+
+ integer
+ / required
+
+ |
+
+ Choices:
+ - 3 (3DES)
+ - 7 (Cisco)
+
+ |
+
+ BGP Key Encryption Type.
+ This parameter is required only if template is 'ext_multisite_underlay_setup' or 'ext_evpn_multisite_overlay_setup'.
+ This parameter is required only if inherit_from_msd is false.
+ |
+
+
+ |
+ |
+
+
+ ebgp_password
+
+
+ string
+ / required
+
+ |
+
+ |
+
+ Encrypted eBGP Password Hex String.
+ This parameter is required only if template is 'ext_multisite_underlay_setup' or 'ext_evpn_multisite_overlay_setup'.
+ This parameter is required only if inherit_from_msd is false.
+ |
+
+
+ |
+ |
+
+
+ ebgp_password_enable
+
+
+ boolean
+
+ |
+
+
+ |
+
+ Flag to enable eBGP password.
+ This parameter is required only if template is 'ext_multisite_underlay_setup' or 'ext_evpn_multisite_overlay_setup'.
+ |
+
+
+ |
+ |
+
+
+ enable_macsec
+
+
+ boolean
+
+ |
+
+
+ |
+
+ Enable MACsec on the link.
+ This parameter is applicable only if MACsec feature is enabled on the fabric.
+ This parameter is applicable only if template is 'int_intra_fabric_ipv6_link_local' or 'int_intra_fabric_num_link' or 'int_intra_fabric_unnum_link'.
+ |
+
+
+ |
+ |
+
+
+ inherit_from_msd
+
+
+ boolean
+
+ |
+
+
+ |
+
+ Flag indicating whether to inherit BGP password from MSD information.
+ Applicable only when source and destination fabric are in the same MSD fabric.
+ This parameter is required only if template is 'ext_multisite_underlay_setup' or 'ext_evpn_multisite_overlay_setup'
+ |
+
+
+ |
+ |
+
+
+ intf_vrf
+
+
+ string
+
+ |
+
+ Default:
""
+ |
+
+ Name of the non-default VRF for the link.
+ Make sure to configure the VRF before using it here.
+ This parameter is applicable only if template is 'int_intra_vpc_peer_keep_alive_link'.
+ |
+
+
+ |
+ |
+
+
+ ipv4_address
+
+
+ string
+ / required
+
+ |
+
+ |
+
+ IPV4 address of the source interface without mask.
+ This parameter is required only if template is 'ext_evpn_multisite_overlay_setup'.
+ |
+
+
+ |
+ |
+
+
+ ipv4_subnet
+
+
+ string
+ / required
+
+ |
+
+ |
+
+ IPV4 address of the source interface with mask.
+ This parameter is required only if template is 'ext_fabric_setup' or 'ext_multisite_underlay_setup'.
+ |
+
+
+ |
+ |
+
+
+ max_paths
+
+
+ integer
+
+ |
+
+ Default:
1
+ |
+
+ Maximum number of iBGP/eBGP paths.
+ This parameter is required only if template is 'ext_multisite_underlay_setup'.
+ |
+
+
+ |
+ |
+
+
+ mtu
+
+
+ integer
+ / required
+
+ |
+
+ |
+
+ MTU of the link.
+ This parameter is optional if template is 'ios_xe_int_intra_fabric_num_link'. The default value in this case will be 1500.
+ This parameter is not required if template is 'ext_evpn_multisite_overlay_setup'.
+ |
+
+
+ |
+ |
+
+
+ neighbor_ip
+
+
+ string
+ / required
+
+ |
+
+ |
+
+ IPV4 address of the neighbor switch on the destination fabric.
+ This parameter is required only if template is 'ext_fabric_setup' or 'ext_multisite_underlay_setup' or "ext_evpn_multisite_overlay_setup"
+ |
+
+
+ |
+ |
+
+
+ peer1_bfd_echo_disable
+
+
+ boolean
+
+ |
+
+
+ |
+
+ Enable BFD echo on the source interface. Only applicable if BFD is enabled on the fabric.
+ This parameter is applicable only if template is 'int_intra_fabric_num_link'.
+ |
+
+
+ |
+ |
+
+
+ peer1_cmds
+
+
+ list
+
+ |
+
+ Default:
[]
+ |
+
+ Commands to be included in the configuration under the source interface.
+ This parameter is not required if template is 'ext_evpn_multisite_overlay_setup'.
+ |
+
+
+ |
+ |
+
+
+ peer1_description
+
+
+ string
+
+ |
+
+ Default:
""
+ |
+
+ Description of the source interface.
+ This parameter is not required if template is 'ext_evpn_multisite_overlay_setup'.
+ |
+
+
+ |
+ |
+
+
+ peer1_ipv4_address
+
+
+ string
+ / required
+
+ |
+
+ |
+
+ IPV4 address of the source interface.
+ This parameter is optional if the underlying fabric is ipv6 enabled.
+ This parameter is required only if template is 'int_intra_fabric_num_link' or 'ios_xe_int_intra_fabric_num_link' or 'int_intra_vpc_peer_keep_alive_link'.
+ |
+
+
+ |
+ |
+
+
+ peer1_ipv6_address
+
+
+ string
+
+ |
+
+ Default:
""
+ |
+
+ IPV6 address of the source interface.
+ This parameter is required only if the underlying fabric is ipv6 enabled.
+ This parameter is required only if template is 'int_intra_fabric_num_link' or 'ios_xe_int_intra_fabric_num_link' or 'int_intra_vpc_peer_keep_alive_link'.
+ |
+
+
+ |
+ |
+
+
+ peer2_bfd_echo_disable
+
+
+ boolean
+
+ |
+
+
+ |
+
+ Enable BFD echo on the destination interface. Only applicable if BFD is enabled on the fabric.
+ This parameter is applicable only if template is 'int_intra_fabric_num_link'.
+ |
+
+
+ |
+ |
+
+
+ peer2_cmds
+
+
+ list
+
+ |
+
+ Default:
[]
+ |
+
+ Commands to be included in the configuration under the destination interface.
+ This parameter is not required if template is 'ext_evpn_multisite_overlay_setup'.
+ |
+
+
+ |
+ |
+
+
+ peer2_description
+
+
+ string
+
+ |
+
+ Default:
""
+ |
+
+ Description of the destination interface.
+ This parameter is not required if template is 'ext_evpn_multisite_overlay_setup'.
+ |
+
+
+ |
+ |
+
+
+ peer2_ipv4_address
+
+
+ string
+ / required
+
+ |
+
+ |
+
+ IPV4 address of the destination interface.
+ This parameter is optional if the underlying fabric is ipv6 enabled.
+ This parameter is required only if template is 'int_intra_fabric_num_link' or 'ios_xe_int_intra_fabric_num_link' or 'int_intra_vpc_peer_keep_alive_link'.
+ |
+
+
+ |
+ |
+
+
+ peer2_ipv6_address
+
+
+ string
+
+ |
+
+ Default:
""
+ |
+
+ IPV6 address of the destination interface.
+ This parameter is required only if the underlying fabric is ipv6 enabled.
+ This parameter is required only if template is 'int_intra_fabric_num_link' or 'ios_xe_int_intra_fabric_num_link' or 'int_intra_vpc_peer_keep_alive_link'.
+ |
+
+
+ |
+ |
+
+
+ route_tag
+
+
+ string
+
+ |
+
+ Default:
""
+ |
+
+ Routing tag associated with interface IP.
+ This parameter is required only if template is 'ext_multisite_underlay_setup'
+ |
+
+
+ |
+ |
+
+
+ src_asn
+
+
+ string
+ / required
+
+ |
+
+ |
+
+ BGP ASN number on the source fabric.
+ This parameter is required only if template is 'ext_fabric_setup' or 'ext_multisite_underlay_setup' or "ext_evpn_multisite_overlay_setup"
+ |
+
+
+ |
+ |
+
+
+ trm_enabled
+
+
+ boolean
+
+ |
+
+
+ |
+
+ Flag to enable Tenant Routed Multicast.
+ This parameter is required only if template is 'ext_evpn_multisite_overlay_setup'.
+ |
+
+
+
+ |
+
+
+ src_device
+
+
+ list
+ / required
+
+ |
+
+ |
+
+ IP address or DNS name of the source switch which is part of the link being configured.
+ |
+
+
+ |
+
+
+ src_interface
+
+
+ string
+ / required
+
+ |
+
+ |
+
+ Interface on the source device which is part of the link being configured.
+ |
+
+
+ |
+
+
+ template
+
+
+ string
+ / required
+
+ |
+
+ Choices:
+ - int_intra_fabric_ipv6_link_local(intra-fabric)
+ - int_intra_fabric_num_link (intra-fabric)
+ - int_intra_fabric_unnum_link (intra-fabric)
+ - int_intra_vpc_peer_keep_alive_link (intra-fabric)
+ - int_pre_provision_intra_fabric_link (intra-fabric)
+ - ios_xe_int_intra_fabric_num_link (intra-fabric)
+ - ext_fabric_setup (inter-fabric)
+ - ext_multisite_underlay_setup (inter-fabric)
+ - ext_evpn_multisite_overlay_setup (inter-fabric)
+
+ |
+
+ Name of the template that is applied on the link being configured.
+ The last 3 template choices are applicable for inter-fabric links and the others are applicable for intra-fabric links.
+ This parameter is required only for 'merged' and 'replaced' states. It is
+ optional for other states.
+ |
+
+
+
+ |
+
+ deploy
+
+
+ boolean
+
+ |
+
+
+ |
+
+ Flag to control deployment of links. If set to 'true' then the links included will be deployed to specified switches. If set to 'false', the links will be created but not deployed.
+ Setting this flag to 'true' will result in all pending configurations on the source and destination devices to be deployed.
+ |
+
+
+ |
+
+ src_fabric
+
+
+ string
+ / required
+
+ |
+
+ |
+
+ Name of the source fabric for links operations.
+ |
+
+
+ |
+
+ state
+
+
+ string
+
+ |
+
+ Choices:
+ merged ← - replaced
+ - deleted
+ - query
+
+ |
+
+ The required state of the configuration after module completion.
+ |
+
+
+