nvidia / nvidia.nvue / 1.1.7 / module / vrf This is the Cumulus Linux vrf module | "added in version" 1.0.0 of nvidia.nvue" Authors: Nvidia NBU Team (@nvidia-nbu), Krishna Vasudevan (@krisvasudevan)nvidia.nvue.vrf (1.1.7) — module
Install with ansible-galaxy collection install nvidia.nvue:==1.1.7
collections: - name: nvidia.nvue version: 1.1.7
This is a Cumulus Linux module to interact with the vrf object.
# Pass in a message - name: List all the VRFs and their configuration nvidia.nvue.vrf: state: gathered
data: description: Provided configuration elements: dict suboptions: evpn: description: EVPN control plane config and info for VRF. required: false suboptions: enable: choices: - 'on' - 'off' default: 'off' description: Turn the feature 'on' or 'off'. required: false type: str vlan: description: VLAN ID required: false type: int vni: description: L3 VNI elements: dict suboptions: id: description: VNI. required: false type: str type: list type: dict id: description: VRF ID. required: true type: str router: description: Router configuration on the VRF. required: false suboptions: bgp: description: BGP VRF configuration. required: false suboptions: address_family: description: Address family specific configuration. required: false suboptions: ipv4_unicast: description: IPv4 unicast address family. required: false suboptions: enable: choices: - 'on' - 'off' default: 'on' description: Turn the feature 'on' or 'off'. required: false type: str network: description: IPv4 static networks. elements: dict required: false suboptions: id: description: An IPv4 static network. required: false type: str type: list redistribute: description: Route redistribute. required: false suboptions: connected: description: Route redistribution of IPv4 connected routes. required: false suboptions: enable: choices: - 'on' - 'off' default: 'off' description: Turn the feature 'on' or 'off'. required: false type: str type: dict static: description: Route redistribution of IPv4 static routes. required: false suboptions: enable: choices: - 'on' - 'off' default: 'off' description: Turn the feature 'on' or 'off'. required: false type: str type: dict type: dict route_export: description: Route export. required: false suboptions: to_evpn: description: Controls for exporting routes from this VRF for this address-family into EVPN (as type-5 routes). required: false suboptions: enable: choices: - 'on' - 'off' default: 'off' description: Turn the feature 'on' or 'off'. required: false type: str type: dict type: dict type: dict ipv6_unicast: description: IPv6 unicast address family. required: false suboptions: enable: choices: - 'on' - 'off' default: 'off' description: Turn the feature 'on' or 'off'. This feature is disabled by default. required: false type: str network: description: IPv6 static networks. elements: dict required: false suboptions: id: description: An IPv6 static network. required: false type: str type: list redistribute: description: Route redistribute. required: false suboptions: connected: description: Route redistribution of IPv6 connected routes. required: false suboptions: enable: choices: - 'on' - 'off' default: 'off' description: Turn the feature 'on' or 'off'. required: false type: str type: dict static: description: Route redistribution of IPv6 static routes. required: false suboptions: enable: choices: - 'on' - 'off' default: 'off' description: Turn the feature 'on' or 'off'. required: false type: str type: dict type: dict route_export: description: Route export. required: false suboptions: to_evpn: description: Controls for exporting routes from this VRF for this address-family into EVPN (as type-5 routes). required: false suboptions: enable: choices: - 'on' - 'off' default: 'off' description: Turn the feature 'on' or 'off'. required: false type: str type: dict type: dict type: dict l2vpn_evpn: description: L2VPN EVPN address family. required: false suboptions: enable: choices: - 'on' - 'off' default: 'off' description: Turn the feature 'on' or 'off'. required: false type: str type: dict type: dict autonomous_system: description: ASN for this VRF. required: false type: int enable: choices: - 'on' - 'off' default: 'off' description: Turn the feature 'on' or 'off'. required: false type: str neighbor: description: Peers. elements: dict required: false suboptions: address_family: description: Address family specific configuration. required: false suboptions: l2vpn_evpn: description: Peer L2VPN EVPN address family. required: false suboptions: enable: choices: - 'on' - 'off' default: 'off' description: Turn the feature 'on' or 'off'. required: false type: str type: dict type: dict enable: choices: - 'on' - 'off' default: 'on' description: Turn the feature 'on' or 'off'. required: false type: str id: description: Interface. required: false type: str peer_group: description: Optional peer-group to which the peer is attached to inherit the group's configuration. required: false type: str remote_as: description: ASN for the BGP neighbor(s) using this configuration. If specified as 'external', it means an EBGP configuration but the actual ASN is immaterial. If specified as 'internal', it means an IBGP configuration. required: false type: str type: choices: - numbered - unnumbered description: Type of peer. required: false type: str update_source: description: Source of routing updates. required: false type: str type: list peer_group: description: Peer groups. elements: dict required: false suboptions: address_family: description: Address family specific configuration. required: false suboptions: ipv4_unicast: description: Peer IPv4 unicast address family. Always on, unless disabled globaly. required: false suboptions: enable: choices: - 'on' - 'off' default: 'on' description: Turn the feature 'on' or 'off'. required: false type: str type: dict ipv6_unicast: description: Peer IPv6 unicast address family. Always on, unless disabled globaly. required: false suboptions: enable: choices: - 'on' - 'off' default: 'on' description: Turn the feature 'on' or 'off'. required: false type: str type: dict l2vpn_evpn: description: Peer L2VPN EVPN address family. required: false suboptions: enable: choices: - 'on' - 'off' default: 'off' description: Turn the feature 'on' or 'off'. required: false type: str type: dict type: dict capabilities: description: Capabilities required: false suboptions: extended_nexthop: choices: - 'on' - 'off' - auto default: auto description: If on, the extended-nexthop capability defined in RFC 5549 is advertised to peer(s) with this config. If 'auto', it will be 'on' for unnumbered peers and 'off' otherwise. This is the default. required: false type: str source_address: description: source IP address of the TCP connection, which is often used as the BGP next hop for Updates. required: false type: str type: dict id: description: Peer group. required: false type: str remote_as: description: ASN for the BGP neighbor(s) using this configuration. If specified as 'external', it means an EBGP configuration but the actual ASN is immaterial. If specified as 'internal', it means an IBGP configuration. required: false type: str type: list route_import: description: Controls for importing of IPv4 and IPv6 routes from this VRF. required: false suboptions: from_evpn: description: Controls for importing EVPN type-2 and type-5 routes into this VRF. required: false suboptions: route_target: description: List of the RTs to attach to host or prefix routes when importing them into VRF or "auto". If "auto", the RT will be derived. This is the default.. elements: dict required: false suboptions: id: description: A route target identifier. required: false type: str type: list type: dict type: dict router_id: description: BGP router-id for this VRF. If "auto", inherit from the global config. This is the default. required: false type: str type: dict ospf: description: OSPF VRF configuration. required: false suboptions: enable: choices: - 'on' - 'off' default: 'off' description: Turn the feature 'on' or 'off'. required: false type: str router_id: description: BGP router-id for this VRF. If "auto", inherit from the global config. This is the default. required: false type: str type: dict pim: description: PIM VRF configuration. required: false suboptions: address_family: description: Address family specific configuration. required: false suboptions: ipv4_unicast: description: IPv4 unicast address family. required: false suboptions: rp: description: RP address and associated group range. elements: dict required: false suboptions: group_range: description: Set of group range assocaited to RP. elements: dict required: false suboptions: id: description: A group range. required: false type: str type: list id: description: RP. required: false type: str prefix_list: description: Prefix-list to specify multicast group range. required: false type: str type: list type: dict type: dict ecmp: description: Choose all available ECMP paths for a particular RPF. If 'off', the first nexthop found will be used. This is the default. required: false suboptions: enable: choices: - 'on' - 'off' default: 'off' description: Turn the feature 'on' or 'off'. required: false type: str rebalance: choices: - 'on' - 'off' default: 'off' description: Recalculate all multicast streams in the event of path going down. If 'off', only the impacted streams by path going down recalculated. This is the default. required: false type: str type: dict enable: choices: - 'on' - 'off' default: 'off' description: Turn the feature 'on' or 'off'. required: false type: str msdp_mesh_group: description: To connect multiple PIM-SM multicast domains using RPs. elements: dict required: false suboptions: id: description: MSDP mesh-group. required: false type: str member_address: description: Set of member-address. elements: dict required: false suboptions: id: description: A MSDP mesh member. required: false type: str type: list source_address: description: MSDP mesh-group source IP address. required: false type: str type: list type: dict static: description: Statis route info on the VRF. elements: dict required: false suboptions: address_family: default: ipv4-unicast description: Route address family. required: false type: str id: description: Route. required: false type: str via: description: Nexthops. elements: dict required: false suboptions: id: description: A via. required: false type: str type: choices: - interface - ipv4-address - ipv6-address - blackhole - reject description: Type of via. required: false type: str type: list type: list type: dict type: list wait: default: 0 description: How long to poll for "merged/deleted" operation results. required: false type: int force: default: false description: When true, replies "yes" to NVUE prompts. required: false type: bool revid: description: Revision ID to query/to apply config to. required: false type: str state: choices: - gathered - deleted - merged description: Defines the action to be taken. required: true type: str vrfid: description: Specific VRF to query/modify. required: false type: str filters: description: Filters used while fetching information about the system suboptions: include: description: Only include JSON properties matched by an include pattern in the response. elements: str required: false type: list omit: description: Drop any JSON properties matched by an omit pattern from the response. elements: str required: false type: list rev: default: operational description: The default is to query the operational state. However, this parameter can be used to query desired state on configuration branches, such as startup and applied. This could be a branch name, tag name or specific commit. required: false type: str type: dict