Virtual Network#
Virtual Networks → VNVirtual Networks
Documentation coming soon!
Custom Resource Definition#
To browse the Custom Resource Definition go to crd.eda.dev.
VirtualNetwork
SPEC
VirtualNetworkSpec defines the desired state of VirtualNetwork
-
List of Subnets. [emits=BridgeDomain]
-
-
The name of the BridgeDomain.
-
Specification of the BridgeDomain
-
The name of the BridgeDomain to configure on the device.
-
The description of the BridgeDomain.
-
Encapsulation-specific options (such as MPLS tunneling options).
default: {"vxlan": {"tunnelIndexPool": "tunnel-index-pool", "vniPool": "vni-pool"}}-
VXLAN encapsulation options. Only applicable if VXLAN encapsulation is used (Type=EVPNVXLAN).
-
Reference to a tunnel index pool to use for allocations.
default: "tunnel-index-pool" -
VNI to use for this BridgeDomain, can be optionally left blank to have it allocated using the VNI Pool.
range: 1 to 16777215 -
Reference to a VNI pool to use for allocations if VNI is left blank.
default: "vni-pool"
-
-
EVI to use for this BridgeDomain, can be optionally left blank to have it automatically allocated using the EVI Pool.
range: 1 to 65535 -
Reference to an EVI pool to use for allocations if EVI is left blank.
default: "evi-pool" -
Export route target in 'target:N:N' format, if not specified, the default value taken as "target:1:<evi>".
-
Import route target in 'target:N:N' format, if not specified, the default value taken as "target:1:<evi>".
-
Enables / Disabled Proxy ARP / Proxy ND.
-
Configures dynamic learning of ARP/ND entries in the proxy table.
-
Aging timer value for the proxy entries in seconds. If not set, this indicates that the entries are never flushed.
format: int32range: 60 to 86400 -
Enables or disables Dynamic Learning.
default: false -
The interval determines the frequency at which the system generates three ARP Requests or Neighbor Solicitations with the intent to refresh the proxy entry. The refresh is sent within the age-time window.
range: 120 to 86400
-
-
Configures IP duplication detection and resolution mechanisms.
-
Enables or disables IP Duplication.
default: false -
Time to wait in minutes from the moment an IP is declared duplicate to the time the IP is removed from the proxy ARP/ND table.
default: 9range: 2 to 60 -
Monitoring window for detecting duplication on a given IP address in the proxy ARP/ND table.
default: 3range: 1 to 15 -
Number of moves in the proxy ARP/ND table that an IP is allowed within the monitoring-window.
default: 5range: 3 to 10
-
-
Maximum number of entries allowed in the proxy table of the bridge domain.
default: 250range: 1 to 8192 -
Enables proxy ARP.
default: false -
Enables proxy ND.
default: false
-
-
Enable or disable MAC duplication detection and resolution mechanisms.
-
Action to take on the subinterface upon detecting at least one mac addresses as duplicate on the subinterface.
default: "StopLearning"enum: "Blackhole", "OperDown", "StopLearning" -
Enables or disables Mac Duplication Detection.
default: false -
Time to wait in minutes from the moment a mac is declared duplicate to the mac is flushed from the bridge table.
default: 9format: int32range: 2 to 60 -
Monitoring window in minutes for detecting duplication on a given mac address.
default: 3format: int32range: 1 to 15 -
Number of moves a mac is allowed within the monitoring-window, before it is declared duplicate.
default: 5range: >= 3
-
-
Sets the maximum number of MAC entries accepted in the bridge table.
format: int32range: >= 1 -
Select the type of BridgeDomain. Simple doesn't include any overlay control plane or dataplane properties (EVPN/VXLAN). EVPNVXLAN includes the properties needed to provision this BridgeDomain over an IP Fabric.
default: "EVPNVXLAN"enum: "Simple", "EVPNVXLAN", "EVPNMPLS"
-
-
-
-
List of BridgeInterfaces. [emits=BridgeInterface]
-
-
The name of the BridgeInterface.
-
Specification of the BridgeInterface
-
Reference to a BridgeDomain in which to attach the BridgeInterface.
-
The description of the BridgeInterface.
-
Reference to an Interface resource to attach this BridgeInterface.
-
L2 MTU specifies the maximum sized Ethernet frame that can be transmitted on the subinterface. If a frame exceeds this size it is discarded. If the l2-mtu of the subinterface exceeds the port-mtu of the associated interface, the subinterface will remain operationally down.
range: 1450 to 9500 -
Override for Mac Duplication Detection action if enabled in the associated BridgeDomain.
enum: "Blackhole", "OperDown", "StopLearning", "BridgeDomainAction" -
Split Horizon Group to be used for this BridgeInterface. The subinterface within this BridgeInterface will be a member of this Split Horizon Group.
-
The Uplink between your access breakout switch and your leaf switch.
-
Selects TopoLinks which connect a leaf switch to a breakout switch. This is the uplink between your access breakout switch and your leaf switch. There can only be a single TopoLink between the access breakout switch and the leaf switch, if more than one TopoLink is present between two devices the transaction will fail.
-
The VLAN ID to be utilized to isolate traffic from the VLAN on the access breakout switch to the leaf switch on the selected uplink TopoLink.
default: "pool" -
A VLAN from this pool will be utilized to isolate traffic from the VLAN on the access breakout switch to the leaf switch on the selected uplink TopoLink.
-
Single value between 1-4094 support, ranges supported in the format x-y,x-y, or the special keyword null, any, untagged or pool for auto allocation.
-
-
-
-
List of IRBInterfaces. [emits=IRBInterface]
-
-
The name of the IrbInterface.
-
Specification of the IrbInterface
-
The gateway MAC to use on the anycast address, if left empty the node will automatically assign one.
-
Enable BFD on the IRBInterface.
-
The minimum interval in milliseconds between transmission of BFD control packets.
default: 1000range: 10 to 100000 -
The number of packets that must be missed to declare this session as down.
default: 3range: 3 to 20 -
Enables Biforward Detection.
default: false -
The minimum interval between echo packets the local node can receive.
default: 0range: 0 to 100000 -
The minimum interval in milliseconds between received BFD control packets that this system should support.
default: 1000range: 10 to 100000 -
Sets custom IP TTL or Hop Limit for multi-hop BFD sessions packets. Not applicable to single-hop BFD sessions.
range: 2 to 255
-
-
Reference to a BridgeDomain.
-
The description of the IRBInterface.
-
Controls the type of ARP/ND entries to advertise.
-
Advertise dynamic ARP entries.
default: false -
Advertise static ARP entries.
default: false -
Advertise dynamic ND entries.
default: false -
Advertise static ND entries.
default: false -
Use RFC9135-based symmetric mode for ARP/ND host route advertisements.
-
-
Configures host route population based on ARP entries.
-
Configures IP addresses on the IRBInterface.
-
-
Reference to a TopoNode resource, if not specified the IP address will be assigned to all nodes on which the IRB is deployed. If specified the IP address will be assigned to the specified node.
-
-
IP MTU for the IRBInterface [default=1500].
default: 1500range: 1280 to 9486 -
IPv4 parameters that are not applicable to IPv6.
-
Duration of time that dynamic ARP entries remain in the ARP cache before they expire.
default: 14400format: int32range: >= 0 -
Allow receiving and forwarding of directed broadcast packets. Enabled when set to true.
-
Enable or disable learning of unsolicited ARPs.
default: "Disabled"enum: "Enabled", "Disabled"
-
-
IPv6 parameters that are not applicable to IPv4.
-
Enable or disable learning of unsolicited Neighbor Advertisements.
default: "Disabled"enum: "All", "Global", "LinkLocal", "Disabled" -
Manages IPv6 Router Advertisement parameters.
-
The current hop limit to advertise in the router advertisement messages.
default: 64format: int32range: 0 to 255 -
Enable or disable IPv6 router advertisements.
default: false -
The IP MTU to advertise in the router advertisement messages.
format: int32range: 1280 to 9486 -
Enable DHCPv6 for address configuration (M-bit).
default: false -
Maximum time between router advertisements (in seconds).
default: 600format: int32range: 4 to 1800 -
Minimum time between router advertisements (in seconds).
default: 200format: int32range: 3 to 1350 -
Enable DHCPv6 for other configuration (O-bit).
default: false -
IPv6 prefixes to advertise in router advertisements.
-
IPv6Prefix defines the configuration for an IPv6 prefix advertisement.
-
When this is set in the prefix information option hosts can use the prefix for stateless address autoconfiguration (SLAAC).
default: true -
When this is set in the prefix information option hosts can use the prefix for on-link determination.
default: true -
The length of time in seconds (relative to the time the packet is sent) that addresses generated from the prefix via stateless address autoconfiguration remain preferred.
default: 604800format: int32range: 0 to 4294967295 -
An IPv6 global unicast address prefix.
-
The length of time in seconds (relative to the time the packet is sent) that the prefix is valid for the purpose of on-link determination.
default: 2592000format: int32range: 0 to 4294967295
-
-
-
Time in milliseconds for Neighbor Unreachability Detection.
default: 0format: int32range: 0 to 3600000 -
Time in milliseconds between retransmitted NS messages.
default: 0format: int32range: 0 to 1800000 -
Router lifetime in seconds for default gateway.
default: 1800format: int32range: 0 to 9000
-
-
-
Reference to a Router.
-
Configuration for Virtual IP discovery on the interface.
-
-
Virtual IP Address.
-
List of allowed MAC addresses for a discovered virtual IP address.
-
List of BridgeInterfaces on the associated MAC-VRF to which the ARP probes are sent. If left blank, the probes are sent on all BridgeInterfaces associated with the BridgeDomain.
-
ARP probe interval in seconds.
default: 0range: 0 to 86400 -
List of VLANs on the associated BridgeDomain to which the ARP probes are sent. If left blank, the probes are sent on all VLANs associated with the BridgeDomain.
-
-
-
-
-
-
Protocols to configure.
-
BGP Protocol.
-
List of BgpGroups. [emits=BGPGroup]
-
-
The name of the BgpGroup.
-
Specification of the BgpGroup
-
AS Path Options
-
The maximum number of times the global AS number or a local AS number of the BGP instance can appear in any received AS_PATH before it is considered a loop and considered invalid.
default: 0range: 0 to 255 -
Options for removing private AS numbers (2-byte and 4-byte) from the advertised AS path towards all peers.
-
If set to true then do not delete or replace a private AS number that is the same as the peer AS number.
default: false -
If set to true then only delete or replace private AS numbers that appear before the first occurrence of a non-private ASN in the sequence of most recent ASNs in the AS path.
default: false -
The method by which private AS numbers are removed from the advertised AS_PATH attribute.
default: "Disabled"enum: "Disabled", "Replace", "Delete"
-
-
-
Enable or disable Bi-forward Forwarding Detection (BFD) with fast failover.
-
When set to true, all configured and dynamic BGP peers are considered RR clients.
-
Enables route reflect client and sets the cluster ID.
-
Configures the group name on the device.
-
Sets the description on the BGP group.
-
Reference to a Policy CR that will be used to filter routes advertised to peers.
-
Enables Graceful Restart on the peer and sets the stale route time in seconds.
range: 1 to 3600 -
Reference to a Policy CR that will be used to filter routes received from peers.
-
Parameters relating to the IPv4 unicast AFI/SAFI.
-
Enables advertisement of IPv4 Unicast routes with IPv6 next-hops to peers.
-
Enables the IPv4 unicast AFISAFI.
-
Configures the maximum number of IPv4 unicast prefixes that can be received from a BGP peer.
-
Configuration of the maximum number of prefixes that can be accepted from a BGP peer.
-
Defines the action to take when the maximum number of prefixes is exceeded. Session is reset if set to false, otherwise only a warning is logged.
-
Maximum number of prefixes allowed to be received from the neighbor, counting only accepted routes.
format: int32range: 1 to 4294967295 -
A percentage of the maximum number of prefixes that can be accepted before a warning is logged.
range: 1 to 100
-
-
Configuration of the maximum number of prefixes that can be received from a BGP peer.
-
Defines the action to take when the maximum number of prefixes is exceeded. Session is reset if set to false, otherwise only a warning is logged.
-
Maximum number of prefixes allowed to be received from the neighbor, counting all routes (accepted and rejected by import policies).
format: int32range: 1 to 4294967295 -
A percentage of the maximum number of prefixes that can be received before a warning is logged.
range: 1 to 100
-
-
-
Enables the advertisement of the RFC 5549 capability to receive IPv4 routes with IPv6 next-hops.
-
-
Parameters relating to the IPv6 unicast AFI/SAFI.
-
Enables the IPv6 unicast AFISAFI
-
Enables advertisement of IPv6 Unicast routes with IPv4 next-hops to peers.
-
Configuration of the maximum number of prefixes that can be accepted from a BGP peer.
-
Defines the action to take when the maximum number of prefixes is exceeded. Session is reset if set to false, otherwise only a warning is logged.
-
Maximum number of prefixes allowed to be received from the neighbor, counting only accepted routes.
format: int32range: 1 to 4294967295 -
A percentage of the maximum number of prefixes that can be accepted before a warning is logged.
range: 1 to 100
-
-
Configuration of the maximum number of prefixes that can be received from a BGP peer.
-
Defines the action to take when the maximum number of prefixes is exceeded. Session is reset if set to false, otherwise only a warning is logged.
-
Maximum number of prefixes allowed to be received from the neighbor, counting all routes (accepted and rejected by import policies).
format: int32range: 1 to 4294967295 -
A percentage of the maximum number of prefixes that can be received before a warning is logged.
range: 1 to 100
-
-
-
-
Reference to a Keychain resource that will be used for authentication with the BGP peer.
-
The local autonomous system number advertised to peers.
-
Local Autonomous System number.
range: 1 to 4294967295 -
When set to true, the global ASN value is prepended to the AS path in outbound routes towards each BGP peer.
-
When set to true, the local AS value is prepended to the AS path of inbound routes from each EBGP peer.
-
-
Local Preference attribute added to received routes from the BGP peers, also sets local preference for generated routes.
range: 0 to 4294967295 -
Enable multihop for eBGP peers and sets the maximum number of hops allowed.
range: 1 to 255 -
When set to true, the next-hop in all IPv4-unicast, IPv6-unicast and EVPN BGP routes advertised to the peer is set to the local-address.
-
When false, all large (12 byte) BGP communities from all outbound routes advertised to the peer are stripped.
-
When false, all standard (4 byte) communities from all outbound routes advertised to the peer are stripped.
-
Options for controlling the generation of default routes towards BGP peers.
-
Enables the sending of a synthetically generated default IPv4 or IPV6 route to each peer.
-
Reference to a Policy that should be applied to the advertised default routes, in order to set their attributes to non-default values.
-
-
Timer configurations
-
The time interval in seconds between successive attempts to establish a session with a peer.
range: 1 to 65535 -
The hold-time interval in seconds that the router proposes to the peer in its OPEN message.
range: 0 to 65535 -
The interval in seconds between successive keepalive messages sent to the peer.
range: 0 to 21845 -
The value assigned to the MinRouteAdvertisementIntervalTimer of RFC 4271, for both EBGP and IBGP sessions, in seconds.
range: 1 to 255
-
-
-
-
-
List of BgpPeers [emits=BGPPeer]
-
-
The name of the BgpPeer.
-
Specification of the BgpPeer
-
AS Path Options
-
The maximum number of times the global AS number or a local AS number of the BGP instance can appear in any received AS_PATH before it is considered a loop and considered invalid.
default: 0range: 0 to 255 -
Options for removing private AS numbers (2-byte and 4-byte) from the advertised AS path towards all peers.
-
If set to true then do not delete or replace a private AS number that is the same as the peer AS number.
default: false -
If set to true then only delete or replace private AS numbers that appear before the first occurrence of a non-private ASN in the sequence of most recent ASNs in the AS path.
default: false -
The method by which private AS numbers are removed from the advertised AS_PATH attribute.
default: "Disabled"enum: "Disabled", "Replace", "Delete"
-
-
-
Enable or disable Bi-forward Forwarding Detection (BFD) with fast failover.
-
When set to true, all configured and dynamic BGP peers are considered RR clients.
-
Enables route reflect client and sets the cluster ID.
-
Sets the description on the BGP peer
-
When set to true the Interface is added to the dynamic-neighbor list for dynamic peering.
default: false -
The autonomous system numbers allowed from peers if dynamic peering is enabled.
-
Reference to a Policy CR that will be used to filter routes advertised to peers.
-
Enables Graceful Restart on the peer and sets the stale route time in seconds.
range: 1 to 3600 -
Reference to a BGPGroup. When present this BGP peer will be added to the BGP group
-
Reference to a Policy CR that will be used to filter routes received from peers.
-
Reference to a RoutedInterface or IRBInterface resource whose IP will be used as a source IP for the BGP session.
-
InterfaceReference type defines whether the provided Reference is a RoutedInterface or IRBInterface.
enum: "RoutedInterface", "IRBInterface" -
Parameters relating to the IPv4 unicast AFI/SAFI.
-
Enables advertisement of IPv4 Unicast routes with IPv6 next-hops to peers.
-
Enables the IPv4 unicast AFISAFI.
-
Configures the maximum number of IPv4 unicast prefixes that can be received from a BGP peer.
-
Configuration of the maximum number of prefixes that can be accepted from a BGP peer.
-
Defines the action to take when the maximum number of prefixes is exceeded. Session is reset if set to false, otherwise only a warning is logged.
-
Maximum number of prefixes allowed to be received from the neighbor, counting only accepted routes.
format: int32range: 1 to 4294967295 -
A percentage of the maximum number of prefixes that can be accepted before a warning is logged.
range: 1 to 100
-
-
Configuration of the maximum number of prefixes that can be received from a BGP peer.
-
Defines the action to take when the maximum number of prefixes is exceeded. Session is reset if set to false, otherwise only a warning is logged.
-
Maximum number of prefixes allowed to be received from the neighbor, counting all routes (accepted and rejected by import policies).
format: int32range: 1 to 4294967295 -
A percentage of the maximum number of prefixes that can be received before a warning is logged.
range: 1 to 100
-
-
-
Enables the advertisement of the RFC 5549 capability to receive IPv4 routes with IPv6 next-hops.
-
-
Parameters relating to the IPv6 unicast AFI/SAFI.
-
Enables the IPv6 unicast AFISAFI
-
Enables advertisement of IPv6 Unicast routes with IPv4 next-hops to peers.
-
Configuration of the maximum number of prefixes that can be accepted from a BGP peer.
-
Defines the action to take when the maximum number of prefixes is exceeded. Session is reset if set to false, otherwise only a warning is logged.
-
Maximum number of prefixes allowed to be received from the neighbor, counting only accepted routes.
format: int32range: 1 to 4294967295 -
A percentage of the maximum number of prefixes that can be accepted before a warning is logged.
range: 1 to 100
-
-
Configuration of the maximum number of prefixes that can be received from a BGP peer.
-
Defines the action to take when the maximum number of prefixes is exceeded. Session is reset if set to false, otherwise only a warning is logged.
-
Maximum number of prefixes allowed to be received from the neighbor, counting all routes (accepted and rejected by import policies).
format: int32range: 1 to 4294967295 -
A percentage of the maximum number of prefixes that can be received before a warning is logged.
range: 1 to 100
-
-
-
-
Reference to a Keychain resource that will be used for authentication with the BGP peer.
-
The local autonomous system number advertised to peers.
-
Local Autonomous System number.
range: 1 to 4294967295 -
When set to true, the global ASN value is prepended to the AS path in outbound routes towards each BGP peer.
-
When set to true, the local AS value is prepended to the AS path of inbound routes from each EBGP peer.
-
-
Local Preference attribute added to received routes from the BGP peers, also sets local preference for generated routes.
range: 0 to 4294967295 -
Enable multihop for eBGP peers and sets the maximum number of hops allowed.
range: 1 to 255 -
When set to true, the next-hop in all IPv4-unicast, IPv6-unicast and EVPN BGP routes advertised to the peer is set to the local-address.
-
Node on which to configure the BGP peer. This node must be one of the nodes on which the IRBInterface is configured. When left blank or if the node is not part of the IRBInterface, the peer will not be deployed. Ignored for RoutedInterfaces.
-
Peer IP to which the peering session will be established.
-
When false, all large (12 byte) BGP communities from all outbound routes advertised to the peer are stripped.
-
When false, all standard (4 byte) communities from all outbound routes advertised to the peer are stripped.
-
Options for controlling the generation of default routes towards BGP peers.
-
Enables the sending of a synthetically generated default IPv4 or IPV6 route to each peer.
-
Reference to a Policy that should be applied to the advertised default routes, in order to set their attributes to non-default values.
-
-
Timer configurations
-
The time interval in seconds between successive attempts to establish a session with a peer.
range: 1 to 65535 -
The hold-time interval in seconds that the router proposes to the peer in its OPEN message.
range: 0 to 65535 -
The interval in seconds between successive keepalive messages sent to the peer.
range: 0 to 21845 -
The value assigned to the MinRouteAdvertisementIntervalTimer of RFC 4271, for both EBGP and IBGP sessions, in seconds.
range: 1 to 255
-
-
-
-
-
-
OSPF Protocol Instanes.
-
-
The name of the OSPFInstance.
-
List of OSPFInterfaces. [emits=OSPFInterface]
-
-
The name of the OSPFInterface.
-
Specification of the OSPFInterface.
-
Dead Interval in seconds.
range: 3 to 65535 -
Hello Interval in seconds.
range: 1 to 65535 -
Reference to a RoutedInterface.
-
Reference to the Kind of interface to enable OSPF on.
default: "RoutedInterface"enum: "RoutedInterface" -
Interface metric.
range: >= 0 -
OSPF interface MTU
range: 512 to 10240 -
Reference to a OSPFArea.
-
Reference to a OSPF Instance on which the OSPF area is configured.
-
Configure the OSPF interface as passive.
-
OSPF interface type.
default: "PointToPoint"enum: "PointToPoint", "Broadcast"
-
-
-
Specification of the OSPFInstance.
-
Selects an address family for OSPFv3. It is mandatory to specify at least one address family when OSPFv3 is selected.
enum: "IPv4Unicast", "IPv6Unicast" -
Enables OSPF instance.
default: false -
The maximum number of ECMP paths (next-hops).
range: 1 to 256 -
Reference bandwidth (in Gbps) for automatic metric calculation.
range: 1 to 3200 -
Configures OSPF timers.
-
LSA Timers configuration.
-
Delay (in milliseconds) to gather LSAs before advertising to neighbors
range: >= 0 -
Minimum interval (in milliseconds) to accept an identical LSA.
range: >= 0 -
Hold interval (in milliseconds) for subsequent LSA regeneration.
range: >= 0 -
Initial delay (in milliseconds) to generate the first instance of LSAs.
range: >= 0 -
Maximum interval (in milliseconds) between two consecutive regenerations (of the same LSA).
range: >= 0
-
-
SPF Timers configuration.
-
Hold interval for subsequent SPF calculations.
range: >= 1 -
Delay (in milliseconds) before an incremental SPF calculation starts.
range: >= 0 -
Initial SPF calculation delay (in milliseconds).
range: >= 0 -
Maximum interval (in milliseconds) between two consecutive SPF calculations.
range: >= 1
-
-
-
OSPF version to use. OSPFv2 is supported over IPv4-enabled interfaces, OSPFv3 over IPv6-enabled interfaces.
enum: "OSPFv2", "OSPFv3"
-
-
-
-
Routing Policies.
-
List of Policies. [emits=Policy]
-
-
Name of the Policy.
-
A policy
-
The name of the policy to configure on the device.
-
The default action to apply if no other actions are defined.
-
Actions related to the BGP protocol.
-
Clear the AS path to make it empty.
-
Replace the existing AS path with a new AS_SEQUENCE containing the listed AS numbers.
-
Set a new LOCAL_PREF value for matching BGP routes.
format: int32range: 0 to 4294967295 -
Set a new ORIGIN attribute for matching BGP routes.
enum: "egp", "igp", "incomplete"
-
Final disposition for the route.
enum: "Accept", "Reject", "NextPolicy", "NextStatement"
-
-
List of policy statements.
-
-
Actions for routes that match the policy statement.
-
Actions related to the BGP protocol.
-
Clear the AS path to make it empty.
-
Replace the existing AS path with a new AS_SEQUENCE containing the listed AS numbers.
-
Set a new LOCAL_PREF value for matching BGP routes.
format: int32range: 0 to 4294967295 -
Set a new ORIGIN attribute for matching BGP routes.
enum: "egp", "igp", "incomplete"
-
Final disposition for the route.
enum: "Accept", "Reject", "NextPolicy", "NextStatement"
-
-
Match conditions of the policy statement.
-
Configuration for BGP-specific policy match criteria.
-
AS Path match criteria.
-
A singular regular expression string to match against AS_PATH objects. Mutually exclusive with the ASPathSet reference.
-
Reference to an ASPathSet resource. Mutually exclusive with the ASPathExpression.
-
The matching criteria that applies to the members in the referenced set.
enum: "Any", "All", "Invert"
-
-
Match conditions for BGP communities.
-
Match conditions for EVPN route types.
-
-
Address families that the route belongs to.
-
Reference to a PrefixSet resource.
-
The route protocol type to match.
enum: "Aggregate", "ARP_ND", "BGP", +12 more
-
-
Name of the policy statement.
-
-
-
-
-
-
List of PrefixSet [emits=PrefixSet]
-
-
Name of the PrefixSet.
-
A PrefixSets
-
The name of the prefixset to configure on the device.
-
List of IPv4 or IPv6 prefixes in CIDR notation.
-
-
-
-
-
List of Static Routes within this VirtualNetwork. [emits=StaticRoute]
-
-
Name of the StaticRoute.
-
A StaticRoutes
-
The name of the static route to configure on the device.
-
Group of nexthops for the list of prefixes.
-
Enables BFD to the next-hops in the group. Local and Remote discriminator parameters have been deprecated at this level. Use Nexthop to set these parameters.
-
Defines whether BFD should be enabled towards the nexthops.
default: false -
Defines the local address to use when establishing the BFD session with the nexthop.
-
-
If set to true all traffic destined to the prefixes will be blackholed. If enabled, next-hops are ignored and this takes precedence.
default: false -
When enabled, the router will generate ICMP Unreachable messages for packets destined to the blackhole route.
-
Follow the resolution of another route. This setting is mutually exclusive with all other settings in the group.
-
Follow mode. Only "NextLongest" is supported, which means that the route will follow the next-hop-group of the next most specific matching route in the routing table.
enum: "NextLongest"
-
-
Ordered list of nexthops.
-
-
Enables BFD to the next-hops in the group. This overrides the configuration at the group.
-
Defines whether BFD should be enabled towards the nexthops.
default: false -
Defines the local address to use when establishing the BFD session with the nexthop.
-
Defines the local discriminator.
-
Defines the remote discriminator.
-
-
Address to use.
-
If set to true the next-hops can be destinations which are resolved in the route table. This overrides the configuration at the group.
default: false
-
-
-
If set to true the next-hops can be destinations which are resolved in the route table.
default: false
-
-
List of nodes on which to configure the static routes. An AND operation is executed against the nodes in this list and the nodes on which the Router is configured to determine the Nodes on which to configure the static routes.
-
Defines the route preference.
-
List of destination prefixes and mask to use for the static routes.
-
Reference to a Router on which to configure the static routes. If no Nodes are provided then the static routes will be provisioned on all Nodes on which the Router is provisioned.
-
-
-
-
-
List of RoutedInterface. [emits=RoutedInterface]
-
-
The name of the RoutedInterface.
-
Specification of the RoutedInterface
-
Enables BFD on the RoutedInterface.
-
The minimum interval in milliseconds between transmission of BFD control packets.
default: 1000range: 10 to 100000 -
The number of packets that must be missed to declare this session as down.
default: 3range: 3 to 20 -
Enables Biforward Detection.
default: false -
The minimum interval between echo packets the local node can receive.
default: 0range: 0 to 100000 -
The minimum interval in milliseconds between received BFD control packets that this system should support.
default: 1000range: 10 to 100000 -
Sets custom IP TTL or Hop Limit for multi-hop BFD sessions packets. Not applicable to single-hop BFD sessions.
range: 2 to 255
-
-
The description of the RoutedInterface.
-
Configures host route population based on ARP/ND entries.
-
Reference to an Interface to use for attachment.
-
IP MTU for the RoutedInterface.
default: 1500range: 1280 to 9486 -
IPv4 parameters that are not applicable to IPv6.
-
Duration of time that dynamic ARP entries remain in the ARP cache before they expire.
default: 14400format: int32range: >= 0 -
Allow receiving and forwarding of directed broadcast packets. Enabled when set to true.
-
Enable or disable learning of unsolicited ARPs.
default: "Disabled"enum: "Enabled", "Disabled"
-
-
IPv6 parameters that are not applicable to IPv4.
-
Enable or disable learning of unsolicited Neighbor Advertisements.
default: "Disabled"enum: "All", "Global", "LinkLocal", "Disabled" -
Manages IPv6 Router Advertisement parameters.
-
The current hop limit to advertise in the router advertisement messages.
default: 64format: int32range: 0 to 255 -
Enable or disable IPv6 router advertisements.
default: false -
The IP MTU to advertise in the router advertisement messages.
format: int32range: 1280 to 9486 -
Enable DHCPv6 for address configuration (M-bit).
default: false -
Maximum time between router advertisements (in seconds).
default: 600format: int32range: 4 to 1800 -
Minimum time between router advertisements (in seconds).
default: 200format: int32range: 3 to 1350 -
Enable DHCPv6 for other configuration (O-bit).
default: false -
IPv6 prefixes to advertise in router advertisements.
-
IPv6Prefix defines the configuration for an IPv6 prefix advertisement.
-
When this is set in the prefix information option hosts can use the prefix for stateless address autoconfiguration (SLAAC).
default: true -
When this is set in the prefix information option hosts can use the prefix for on-link determination.
default: true -
The length of time in seconds (relative to the time the packet is sent) that addresses generated from the prefix via stateless address autoconfiguration remain preferred.
default: 604800format: int32range: 0 to 4294967295 -
An IPv6 global unicast address prefix.
-
The length of time in seconds (relative to the time the packet is sent) that the prefix is valid for the purpose of on-link determination.
default: 2592000format: int32range: 0 to 4294967295
-
-
-
Time in milliseconds for Neighbor Unreachability Detection.
default: 0format: int32range: 0 to 3600000 -
Time in milliseconds between retransmitted NS messages.
default: 0format: int32range: 0 to 1800000 -
Router lifetime in seconds for default gateway.
default: 1800format: int32range: 0 to 9000
-
-
-
Reference to a Router.
-
Single value between 1-4094 support, ranges supported in the format x-y,x-y, or the special keyword null, any, untagged or pool for auto allocation.
default: "pool" -
Reference to a VLAN pool to use for allocations.
default: "vlan-pool"
-
-
-
-
List of Routers.[emits=Router]
-
-
The name of the Router.
-
Specification of the Router
-
BGP configuration.
-
Autonomous System number for BGP.
range: 1 to 4294967295 -
Preference to be set for eBGP [default=170].
default: 170range: 1 to 255 -
Enable or disable BGP.
default: false -
Reference to a Policy CR that will be used to filter routes advertised to peers.
-
Preference to be set for iBGP [default=170].
default: 170range: 1 to 255 -
Reference to a Policy CR that will be used to filter routes received from peers.
-
IP aliasing configuration.
-
-
10 byte Ethernet Segment Identifier, if not set a type 0 ESI is generated.
default: "auto" -
The nexthop IP address to track for the IP alias.
-
When not set the ES is used in an all active mode. This references the TopoNode object and when set, the DF algorithm is configured to type preference and the selected Node is set with a higher preference value. All other Nodes have a lower value configured.
-
-
-
Parameters relating to the IPv4 unicast AFI/SAFI.
-
Enables advertisement of IPv4 Unicast routes with IPv6 next-hops to peers.
-
Enables the IPv4 unicast AFISAFI.
default: false -
Enable multipath.
-
When set to true, BGP is allowed to build a multipath set using BGP routes with different neighbor AS (most recent AS in the AS_PATH), When set to false, BGP is only allowed to use non-best paths for ECMP if they meet the multipath criteria and they have the same neighbor AS as the best path.
default: true -
The maximum number of BGP ECMP next-hops for BGP routes with an NLRI belonging to the address family of this configuration context.
range: 1 to 256
-
-
Enables the advertisement of the RFC 5549 capability to receive IPv4 routes with IPv6 next-hops.
-
-
Parameters relating to the IPv6 unicast AFI/SAFI.
-
Enables the IPv6 unicast AFISAFI
default: false -
Enable multipath
-
When set to true, BGP is allowed to build a multipath set using BGP routes with different neighbor AS (most recent AS in the AS_PATH), When set to false, BGP is only allowed to use non-best paths for ECMP if they meet the multipath criteria and they have the same neighbor AS as the best path.
default: true -
The maximum number of BGP ECMP next-hops for BGP routes with an NLRI belonging to the address family of this configuration context.
range: 1 to 256
-
-
-
Keychain to be used for authentication
-
Minimum wait time before advertising routes post BGP restart.
default: 0range: 0 to 3600 -
Enable rapid withdrawal in BGP.
default: true -
Wait for FIB installation before advertising routes.
default: false
-
-
The name of the Router to configure on the device.
-
The description of the Router.
-
Set the maximum number of ECMP paths for the Router. This is supported only by some platforms, and will be ignored for others.
range: 1 to 256 -
Encapsulation-specific options (such as MPLS tunneling options).
default: {"vxlan": {"tunnelIndexPool": "tunnel-index-pool", "vniPool": "vni-pool"}}-
VXLAN encapsulation options. Only applicable if VXLAN encapsulation is used (Type=EVPNVXLAN).
-
Reference to tunnel index allocation pool.
default: "tunnel-index-pool" -
VNI for the Router; leave blank for auto-allocation from VNI pool. Only applicable to VXLAN encapsulation.
range: 1 to 16777215 -
Reference to VNI pool for auto-allocation. Only applicable to VXLAN encapsulation.
default: "vni-pool"
-
-
EVI for the Router; leave blank for auto-allocation from EVI pool. Optional for IPVPN (can be used to auto-derive RTs), required for EVPN.
range: 1 to 65535 -
Reference to EVI pool for auto-allocation.
default: "evi-pool" -
Export route target in 'target:N:N' format, if not specified, the default value taken as "target:1:<evi>".
-
Import route target in 'target:N:N' format, if not specified, the default value taken as "target:1:<evi>".
-
Node selectors for deployment constraints. If Nodes are selected, the Router will only be deployed on the Nodes selected, if left blank it will be deployed on all Nodes for which there are IRB or RoutedInterfaces referencing this Router.
-
Resilient Hashing configuration.
-
IPv4 or IPv6 prefix. Active routes in the FIB that exactly match this prefix or that are longer matches of this prefix are provided with resilient-hash programming.
-
-
The number of times each next-hop is repeated in the fill pattern if there are max-paths ECMP next-hops.
default: 1range: 1 to 32 -
The maximum number of ECMP next-hops per route associated with the resilient-hash prefix.
default: 1range: 1 to 64 -
IPv4 or IPv6 prefix. Active routes in the FIB that exactly match this prefix or that are longer matches of this prefix are provided with resilient-hash programming.
-
-
-
-
Router ID.
-
Select the type of Router. Simple doesn't include any overlay control plane or dataplane properties (such as EVPN/VXLAN). EVPNVXLAN includes the properties needed to provision this Router over an IP Fabric.
default: "EVPNVXLAN"enum: "Simple", "EVPNVXLAN", "EVPNMPLS", "IPVPN"
-
-
-
-
List of VLANs. [emits=VLAN]
-
-
The name of the VLAN.
-
Specification of the Vlan
-
Reference to a BridgeDomain or SimpleBridgeDomain.
-
The description of the VLAN.
-
Interfaces to use for attachment to this VLAN based on the label selector. Selects Interfaces based on their associated labels.
-
L2 MTU specifies the maximum sized Ethernet frame that can be transmitted on the subinterface. If a frame exceeds this size it is discarded. If the l2-mtu of the subinterface exceeds the port-mtu of the associated interface, the subinterface will remain operationally down.
range: 1450 to 9500 -
If Mac Duplication Detection is enabled on the associated Bridge Domain, this property will override the MDD action set in the BridgeDomain.
enum: "Blackhole", "OperDown", "StopLearning", "BridgeDomainAction" -
Name of the Split Horizon Group to be used for this VLAN. All subinterfaces within this VLAN will be members of this Split Horizon Group.
-
The Uplink between your access breakout switch and your leaf switch.
-
Selects TopoLinks which connect a leaf switch to a breakout switch. This is the uplink between your access breakout switch and your leaf switch. There can only be a single TopoLink between the access breakout switch and the leaf switch, if more than one TopoLink is present between two devices the transaction will fail.
-
The VLAN ID to be utilized to isolate traffic from the VLAN on the access breakout switch to the leaf switch on the selected uplink TopoLink.
default: "pool" -
A VLAN from this pool will be utilized to isolate traffic from the VLAN on the access breakout switch to the leaf switch on the selected uplink TopoLink.
-
Single value between 1-4094 support, ranges supported in the format x-y,x-y, or the special keyword null, any, untagged or pool for auto allocation.
default: "pool" -
Reference to a VLAN pool to use for allocations. [default="vlan-pool"]
-
-
-
STATUS
-
Indicates the health score of the VNET.
-
Indicates the reason for the health score.
-
The time when the state of the resource last changed.
-
List of Nodes on which the VNET is configured.
-
Total number of configured BGP Peers.
-
Total Number of BGP Peer operationally down.
-
Total number of irb-interfaces configured by the VNET.
format: int32 -
Total number of irb-interfaces configured by the VNET which are oper-down.
format: int32 -
Total number of Nodes on which the VNET is configured.
-
Total number of configured OSPF Interfaces.
-
Total Number of OSPF Interface operationally down.
-
Total number of routed-interfaces configured by the VNET.
format: int32 -
Total number of routed-interfaces configured by the VNET which are oper-down.
format: int32 -
Total number of sub-interfaces configured by the VNET.
format: int32 -
Total number of sub-interfaces configured by the VNET which are oper-down.
format: int32 -
Operational state of the VNET.
enum: "Up", "Down", "Degraded", "Unknown"