VpnBgpVplsGenParams Object

Description:

Parameters for generating a BGP VPLS VPN configuration. These parameters can be expanded into a test configuration using the VpnGenConfigExpandCommand. This can simplify the process of setting up large complicated VPN tests, but is not as flexible as directly creating the configuration.

Writable Attributes
Read-Only Attributes

Parents: Project

Children: AccessVplsGenParams, VpnBgpVplsGenCorePortParams, VpnBgpVplsGenCustPortParams, VpnLspPingGenIpv4CoreParams, VpnLspPingGenIpv4VpnParams

Automatically-created children: VpnIgpIsisSessionParams, VpnIgpOspfv2SessionParams, VpnMplsLdpSessionParams, VpnMplsRsvpSessionParams

VpnBgpVplsGenParams Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

CoreEnableBfdForBgp

Enable BFD for core side BGP.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable BFD for core side BGP.
FALSE	Do not enable BFD for core side BGP.

CoreHostPercent

Percentage of core side hosts.

Type: double

Default: 50

Range: 0 - 100.0

CoreHostsPerCe

Number of hosts that will be added to each core side CE.

Type: u32

Default: 1

Range: 1 - 2147483647

CoreIgpProtocol

IGP protocol to use on the core side.

Type: enum

Default: OSPF

Possible Values:

Value	Description
OSPF	Use OSPF as the core side IGP.
ISIS	Use IS-IS as the core side IGP.
RIP	Use RIP as the core side IGP.
NONE	None

CoreLdpHelloType

Type of LDP hello packet used by the emulated core routers.

Type: enum

Default: DIRECTED

Possible Values:

Value	Description
DIRECTED	Use directed hellos for the LDP session.
TARGETED	Use targeted hellos for the LDP session.

CoreMplsProtocol

MPLS protocol used to determine the outer transport MPLS label.

Type: enum

Default: LDP

Possible Values:

Value	Description
NONE	Don't use an outer transport MPLS label (single label stack).
LDP	Use LDP to determine the outer transport MPLS label.
RSVP	Use RSVP to determine the outer transport MPLS label.
OSPF	OSPF
ISIS	ISIS

CorePeLoopbackIpAddr

Starting core side PE loopback IP address.

Type: ip

Default: 10.0.0.2

CorePeLoopbackIpAddrStep

Step to apply to the starting core side PE loopback IP address for each subsequent PE.

Type: ip

Default: 0.0.0.1

CorePEnable

Enables the creation of core P routers between the PE routers and the DUT.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Enables the creation of core P routers.
FALSE	Disables the creation of core P routers.

CorePePerSubIf

Number of PE routers created per core side sub-interface.

Type: u16

Default: 1

Range: 1 - 10000

CorePeVpnAll

Determines if each PE uses all VPNs. Disable this attribute to manually set the number of VPNs each PE will advertise routes for.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Indicates that each PE should advertise routes for all VPNs.
FALSE	Allows user to enter in the number of VPNs each PE will advertise routes for.

CorePeVpnAssignment

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Determines how VPNs are assigned to PEs.

Type: enum

Default: VPNS_PER_PE

Possible Values:

Value	Description
VPNS_PER_PE	VPNs are assigned to PEs. The CorePeVpnCount determines the number of VPNs assigned to a PE. For example if there are 6 VPNs and 2 PEs with CorePeVpnCount equal to 3, PE1 will be assigned VPN1-VPN3 and PE2 will be assigned VPN4-VPN6.
PES_PER_VPN	PEs are assigned to VPNs. The CorePeVpnCount determines the number of PEs assigned to a VPN. For example if there are 2 VPNs and 6 PEs with CorePeVpnCount equal to 3, VPN1 will be assigned PE1-PE3 and VPN2 will be assigned PE4-PE6.

CorePeVpnCount

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Number of VPNs each core PE will advertise routes for. This attribute is only applicable when the CorePeVpnAll attribute is FALSE.

Type: u16

Default: 1

Range: 1 - 65535

CorePIfIpAddr

Starting simulated P router IPv4 interface address.

Type: ip

Default: 1.0.0.1

CorePIfPrefixLength

Prefix length to use for simulated P router IPv4 interfaces.

Type: u8

Default: 24

Range: 1 - 30

CorePLoopbackIpAddr

Starting loopback address for emulated/simulated P routers.

Type: ip

Default: 192.0.1.1

CorePLoopbackIpAddrStep

Step applied to the loopback address for emulated/simulated P routers.

Type: ip

Default: 0.0.1.0

CorePPerSubIf

Number of core P routers per core side sub-interface. Only 1 emulated P router is created per sub-interface. If this number is greater than 1, then additional P routers are simulated through the IGP protocol routes. The topology for the additional P routers is determined by the CorePTopologyType attribute.

Type: u16

Default: 1

Range: 1 - 65535

CorePRsvpBandwidthPerLink

RSVP link bandwidth advertised by ISIS or OSPF.

Type: u32

Default: 100000

Range: 1 - 2147483647

CorePRsvpBandwidthPerTunnel

RSVP tunnel bandwidth.

Type: u32

Default: 0

Range: 0 - 2147483647

CorePSrv6VpnCount

Core P Router Number for Srv6Vpn

Type: u8

Default: 1

Range: 1 - 16

CorePTopologyType

Type of core P router topology.

Type: enum

Default: TREE

Possible Values:

Value	Description
TREE	Creates a simulated tree topology of P routers.
GRID	Creates a simulated grid topology of P routers.

CoreRouteDistinguisher

Starting route distinguisher for core side sites.

To use this attribute, VpnRouteDistinguisherAssignment must be set to MANUAL.

Type: string

Default: 1:0

CoreRouteDistinguisherStepPerCe

Core side route distinguisher step per CE.

Type: string

Default: 0:0

CoreRouteDistinguisherStepPerCeEnable

Enable core side route distinguisher step per CE.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use route distinguisher stepping.
FALSE	Don't use route distinguisher stepping.

CoreRouteDistinguisherStepPerVpn

Core side route distinguisher step per VPN.

Type: string

Default: 1:0

CoreRouteDistinguisherStepPerVpnEnable

Enable the core side route distinguisher step per VPN.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Use route distinguisher stepping.
FALSE	Don't use route distinguisher stepping.

CoreRouteReflectorClusterId

Starting cluster ID.

Type: ip

Default: 0.0.0.0

CoreRouteReflectorClusterIdStep

Step to apply to the starting cluster ID for each subsequent route reflector.

Type: ip

Default: 0.0.0.1

CoreRouteReflectorEnable

Enables the usage of core side route reflectors. When this attribute is enabled, Spirent TestCenter emulates a BGP route reflector on one (or more) of the generated P routers. The DUT should be set up to peer with the route reflector instead of the PE routers (which Spirent TestCenter simulates through advertised routes).

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use core side route reflectors.
FALSE	Don't use core side route reflectors.

CoreRouteReflectorIds

Core Route Reflector ID(s)

Type: ip

Default: 0.0.0.0

CoreRouteReflectorLoopbackIpAddr

Starting core side route reflector loopback IP address.

Type: ip

Default: 7.7.7.7

CoreRouteReflectorLoopbackIpAddrStep

Step to apply to the starting core side route reflector loopback IP address for each subsequent route reflector.

Type: ip

Default: 0.0.0.1

CoreRouteReflectorMode

Core Route Reflector Mode

Type: enum

Default: STC_AS_RR

Possible Values:

Value	Description
STC_AS_RR	STC_AS_RR
DUT_AS_RR	DUT_AS_RR

CoreRouteReflectorPerPe

Number of route reflectors that will reflect routes for each PE.

Type: u16

Default: 1

Range: 1 - 65535

CoreRouteReflectorPerSubIf

Number of route reflectors per core side sub-interface.

Type: u16

Default: 1

Range: 1 - 65535

CoreVeIdOverlapEnable

Whether the core VE IDs will be overlapping.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Core VE IDs are the same on all VPNs.
FALSE	Core VE IDs are all unique on all VPNs.

CoreVeIdStart

Starting core VE ID.

Type: u16

Default: 1

Range: 0 - 65535

CoreVeIdStep

Step applied to the starting VE ID for each subsequent VE on the same VPN.

Type: u16

Default: 1

Range: 0 - 65535

CreateUnusedVpnHostsCorePorts

Whether to create hosts for unused core VPN sites.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Create hosts for unused core VPN sites.
FALSE	Do not create hosts for unused core VPN sites.

CustCeVpnAssignment

Mode used when assigning CEs to VPNs.

Type: enum

Default: ROUND_ROBIN

Possible Values:

Value	Description
ROUND_ROBIN	CEs are assigned to VPNs in round robin. For example if there are 2 VPNs and 4 CEs, the 1st CE will be assigned to VPN1, the 2nd CE will be assigned to VPN2, the 3rd CE will be assigned to VPN1 and the 4th CE will be assigned to VPN2.
SEQUENTIAL	All CEs are assigned to one VPN before assigning CEs to the next VPN. For example if there are 2 VPNs and 4 CEs, the 1st CE would be assigned to VPN1, the 2nd CE will be assigned to VPN1, the 3rd CE will be assigned to VPN2 and the 4th CE will be assigned to VPN2.

CustHostPercent

Percentage of customer side hosts.

Type: double

Default: 50

Range: 0 - 100.0

CustHostsPerCe

Number of hosts that will be added to each customer side CE.

Type: u32

Default: 1

Range: 1 - 2147483647

CustRouteDistinguisher

Starting customer side route distinguisher.

To use this attribute, VpnRouteDistinguisherAssignment must be set to MANUAL.

Type: string

Default: 1:0

CustRouteDistinguisherStepPerCe

Customer side route distinguisher step per CE.

Type: string

Default: 0:0

CustRouteDistinguisherStepPerCeEnable

Enable customer side route distinguisher step per CE.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use route distinguisher stepping.
FALSE	Don't use route distinguisher stepping.

CustRouteDistinguisherStepPerVpn

Customer side route distinguisher step per VPN.

Type: string

Default: 1:0

CustRouteDistinguisherStepPerVpnEnable

Enable the customer side route distinguisher step per VPN.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Use route distinguisher stepping.
FALSE	Don't use route distinguisher stepping.

CustVeIdOverlapEnable

Whether the customer VE IDs will be overlapping.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Customer VE IDs are the same on all VPNs.
FALSE	Customer VE IDs are unique on all VPNs.

CustVeIdStart

Starting customer VE ID.

Type: u16

Default: 0

Range: 0 - 65535

CustVeIdStep

Starting customer VE ID.

Type: u16

Default: 1

Range: 0 - 65535

DutAs

AS number of the DUT.

Type: u16

Default: 1

Range: 1 - 65535

DutAs4Byte

DUT 4-byte AS number.

Type: string

Default: 1:1

DutLoopbackIpAddr

DUT loopback IP address.

Type: ip

Default: 10.0.0.1

Enable4ByteDutAs

Enable 4-byte DUT AS number.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use 4-byte DUT AS number.
FALSE	Use 2-byte DUT AS number.

EnableCoreTunnelLspPing

Enable Core Tunnel LspPing

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enabled Core Tunnel LspPing
FALSE	Disabled Core Tunnel LspPing

EnableVpnToDutTunnelLspPing

Enable PE-To-DUT VPN Tunnel LspPing

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable PE-To-DUT VPN Tunnel LspPing
FALSE	Disable PE-To-DUT VPN Tunnel LspPing

EnableVpnTunnelLspPing

Enable PE-To-PE VPN Tunnel LspPing

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enabled PE-To-PE VPN Tunnel LspPing
FALSE	Disabled PE-To-PE VPN Tunnel LspPing

HostNumCoreVlans

Number of host VLANs for core side hosts.

Type: u8

Default: 1

Range: 0 - 9

HostNumCustVlans

Number of host VLANs for customer side hosts.

Type: u8

Default: 1

Range: 0 - 9

HostsPerVpn

Number of hosts per VPN.

Type: u32

Default: 100

Range: 1 - 2147483647

HostVlanId

Host VLAN ID start.

Type: u16

Default: 100

Range: 0 - 4095

HostVlanIdStepPerHost

Host VLAN ID step per host.

Type: u16

Default: 0

Range: 0 - 4095

HostVlanIdStepPerVpn

Host VLAN ID step per VPN.

Type: u16

Default: 1

Range: 0 - 4095

Mtu

MTU for the VPN.

Type: u16

Default: 1500

Range: 512 - 65535

ProviderPeLspAssignment

Determines how LSPs are assigned to PEs.

Type: enum

Default: LSPS_PER_PE

Possible Values:

Value	Description
LSPS_PER_PE	LSPs are assigned to PEs. The ProviderPeLspCount determines the number of LSPs assigned to a PE. For example if there are 6 LSPs and 2 PEs with ProviderPeLspCount equal to 3, PE1 will be assigned LSP1-LSP3 and PE2 will be assigned LSP4-LSP6.
PES_PER_LSP	PEs are assigned to LSPs. The ProviderPeLspCount determines the number of PEs assigned to a LSP. For example if there are 2 LSPs and 6 PEs with ProviderPeLspCount equal to 3, LSP1 will be assigned PE1-PE3 and LSP2 will be assigned PE4-PE6.

ProviderPeLspCount

Provider PEs per LSP or LSPs per PE count.

Type: u16

Default: 1

Range: 1 - 65535

ProviderPeVpnAssignment

Determines how VPNs are assigned to PEs.

Type: enum

Default: VPNS_PER_PE

Possible Values:

Value	Description
VPNS_PER_PE	VPNs are assigned to PEs. The CorePeVpnCount determines the number of VPNs assigned to a PE. For example if there are 6 VPNs and 2 PEs with CorePeVpnCount equal to 3, PE1 will be assigned VPN1-VPN3 and PE2 will be assigned VPN4-VPN6.
PES_PER_VPN	PEs are assigned to VPNs. The CorePeVpnCount determines the number of PEs assigned to a VPN. For example if there are 2 VPNs and 6 PEs with CorePeVpnCount equal to 3, VPN1 will be assigned PE1-PE3 and VPN2 will be assigned PE4-PE6.

PseudowireFlood

This option is currently not supported.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	This option is currently not supported.
FALSE	This option is currently not supported.

StreamBlockGroupMethod

Stream block group method.

Type: enum

Default: AGGREGATE

Possible Values:

Value	Description
AGGREGATE	Use one stream block per port.
VPN	Use one stream block per VPN per port.

StreamBlockUseSingleStreamNumberPerEndpointPair

Enables using a single stream number for each endpoint pair.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use a single stream number for each endpoint pair.
FALSE	Use multiple stream numbers for each endpoint pair.

TotalHosts

Total number of hosts.

Type: u32

Default: 100

Range: 1 - 2147483647

TrafficFlow

Type of traffic flows to create.

Type: enum

Default: BIDIRECTIONAL

Possible Values:

Value	Description
CUSTOMER_TO_CORE	Traffic is created from the customer side to the core side.
CORE_TO_CUSTOMER	Traffic is created from the core side to the customer side.
BIDIRECTIONAL	Traffic is created from the customer side to the core side and the core side to the customer side.
FULLY_MESHED	Traffic is created from the customer side to the core side and the core side to the customer side like BIDIRECTIONAL mode. Additionally traffic is created between customer side sites that are on different ports and core side sites that are on different ports.
NONE	None

TrafficLoadPercentFromCorePorts

Load percentage for test traffic from each core side port.

Type: double

Default: 10.0

Range: 0 - 100

TrafficLoadPercentFromCustomerPorts

Load percentage for test traffic from each customer side port.

Type: double

Default: 10.0

Range: 0 - 100

TrafficPattern

Traffic Pattern

Type: enum

Default: ONE_TO_MANY

Possible Values:

Value	Description
ONE_TO_ONE	Traffic Pattern is one to one
ONE_TO_MANY	Traffic Pattern is one to many

UseCorePortsEnable

Whether core side ports will be used.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Use core side ports.
FALSE	Don't use any core side ports.

UseCustPortsEnable

Whether customer side ports will be used.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Use customer side ports.
FALSE	Don't use any customer side ports.

VlanEnable

Whether the traffic uses Q-in-Q VLAN tags.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Traffic is Q-in-Q VLAN tagged.
FALSE	Traffic is not Q-in-Q VLAN tagged.

VplsDraftVersion

VPLS version.

Type: enum

Default: VERSION_VPLS_4761

Possible Values:

Value	Description
VERSION_00	Ver 00.
VERSION_02	Ver 02.
VERSION_VPLS_4761	Ver VPLS 4761.

VpnCount

Number of VPNs that will be configured.

Type: u16

Default: 10

Range: 1 - 65535

VpnHostAssignment

Determines how the number of VPN hosts are specified.

Type: enum

Default: HOSTS_PER_CE

Possible Values:

Value	Description
HOSTS_PER_CE	Number of hosts is specified in hosts per CE. The parameters CoreHostsPerCe and CustHostsPerCe are used.
HOSTS_PER_VPN	Number of hosts is specified in hosts per VPN. The parameters HostsPerVpn, CoreHostPercent and CustHostPercent are used.
TOTAL_HOSTS	Number of hosts is specified as a total number of hosts. The parameters TotalHosts, CoreHostPercent and CustHostPercent are used.

VpnHostIdFormatEnable

Enables VPN host MAC formatting.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use VPN host MAC formatting.
FALSE	Don't use VPN host MAC formatting.

VpnHostIdFormatOffsetBytes

Number of offset bytes in the host MAC format.

Type: u8

Default: 1

Range: 0 - 5

VpnHostIdFormatPortBytes

Number of port bytes in the host MAC format.

Type: u8

Default: 1

Range: 0 - 4

VpnHostIdFormatRouterBytes

Number of router bytes in the host MAC format.

Type: u8

Default: 2

Range: 0 - 4

VpnHostMacStart

Starting MAC address for VPN hosts.

Type: mac

Default: 0.0.1.0.0.1

VpnHostMacStep

Step applied to the MAC address for VPN hosts.

Type: mac

Default: 0.0.0.0.0.1

VpnHostOverlap

Whether the VPN host MAC addresses should overlap.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use the same host MAC addresses on all VPNs.
FALSE	Use different host MAC addresses on each VPN.

VpnRouteDistinguisher

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Instead of this attribute, use the CoreRouteDistinguisherXX or CustRouteDistinguisherXX attributes.

Starting VPN route distinguisher.

Type: string

Default: 1:0

VpnRouteDistinguisherAssignment

Route distinguisher assignment mode.

Type: enum

Default: USE_RT

Possible Values:

Value	Description
USE_RT	Use the route target as the route distinguisher.
MANUAL	Manually assign the route distinguisher.

VpnRouteDistinguisherStep

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Instead of this attribute, use the CoreRouteDistinguisherXX or CustRouteDistinguisherXX attributes.

Step to apply to the starting VPN route distinguisher for each subsequent VPN.

Type: string

Default: 1:0

VpnRouteMplsLabelStart

Starting MPLS label to assign to core side VPN routes.

Type: u32

Default: 16

Range: 0 - 1048575

VpnRouteTarget

Starting route target for the VPN.

Route distinguisher will be the same as this unless you set VpnRouteDistinguisherAssignment to MANUAL and use some of the CoreRouteDistinguisherXX or CustRouteDistinguisherXX attributes.

Type: string

Default: 1:0

VpnRouteTargetOverride

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Use VpnRouteDistinguisherAssignment instead of this attribute.

Determines if the route target should be overridden. By default, the route target and the route distinguisher are the same. Enable this attribute to use a route target that is different from the route distinguisher.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Override the route target with a different value than the route distinguisher.
FALSE	Use the route distinguisher as the route target.

VpnRouteTargetStep

Step to apply to the starting VPN route target for each subsequent VPN. Specify the starting route target with VpnRouteTarget.

Type: string

Default: 1:0

VpnTestConfig

VPN Test Config.

Type: enum

Default: STANDARD

Possible Values:

Value	Description
STANDARD	STANDARD
PE_VPN_SCALABILITY	PE_VPN_SCALABILITY

VpnBgpVplsGenParams Read-Only Attributes

There are no read-only attributes.