VpnMartiniGenParams Object

Description:

Parameters for generating a Martini 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: MultiSegmentLeftSitePortParams, MultiSegmentRightSitePortParams, VpnLspPingGenIpv4CoreParams, VpnLspPingGenIpv4VpnParams, VpnMartiniGenCorePortParams, VpnMartiniGenCustPortParams

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

VpnMartiniGenParams Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

AttachmentGroupId

Attachment Group identifier.

Type: string

Default: 100:1

AttachmentGroupIdAssignment

Attachment Group Identification Assignment

Type: enum

Default: USE_RT

Possible Values:

Value	Description
USE_RT	USE_RT
MANUAL	MANUAL

AttachmentGroupIdIncrement

Attachment Group identifier increment.

Type: string

Default: 0:1

AttachmentGroupIdIncrementSimulatedSegment

Attachment Group identifier increment for simulated segment.

Type: string

Default: 0:1

AttachmentGroupIdSimulatedSegment

Attachment Group identifier for simulated segment.

Type: string

Default: 100:1

Cbit

Determines whether or not a control word is used for the virtual circuits. Note: This option is currently not supported.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Control word is used for virtual circuits.
FALSE	Control word is not used for virtual circuits.

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	OSFP
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

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.

CreatePeWithDirectTargetLdpSessions

Create PE Router with Direct and Target LDP sessions

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Create PE Router with Direct and Target LDP sessions is true
FALSE	Create PE Router with Direct and Target LDP sessions is false

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.

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

CustomEncap

Specifies a custom encapsulation type.

Type: u16

Default: 4

Range: 0 - 32767

DutAs

DUT AS number.

Type: u16

Default: 1

Range: 1 - 65535

DutLoopbackIpAddr

DUT loopback IP address.

Type: ip

Default: 10.0.0.1

EnableBgpAutoDiscovery

Whether to enable BGP auto discovery.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable BGP auto discovery.
FALSE	Disable BGP auto discovery.

EnableCoreTunnelLspPing

Enable Core Tunnel LspPing

Type: bool

Default: FALSE

Possible Values:

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

EnableSPeTlvs

Whether to enable S-PE TLVs.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable S-PE TLVs.
FALSE	Disable S-PE TLVs.

EnableVpnToDutTunnelLspPing

Enable PE-To-DUT VPN Tunnel LspPing

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enabled PE-To-DUT VPN Tunnel LspPing
FALSE	Disabled 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

Encap

LDP VC encapsulation.

Type: enum

Default: LDP_LSP_ENCAP_ETHERNET_VLAN

Possible Values:

Value	Description
LDP_LSP_ENCAP_FRAME_RELAY_DLCI	Frame Relay DLCI (Martini mode).
LDP_LSP_ENCAP_ATM_AAL5_VCC	ATM AAL5 SDU cell transport.
LDP_LSP_ENCAP_ATM_TRANSPARENT_CELL	ATM transparent cell transport.
LDP_LSP_ENCAP_ETHERNET_VLAN	Ethernet VLAN.
LDP_LSP_ENCAP_ETHERNET	Ethernet
LDP_LSP_ENCAP_HDLC	HDLC
LDP_LSP_ENCAP_PPP	PPP
LDP_LSP_ENCAP_CEM	SONET-SDH circuit emulation service over MPLS.
LDP_LSP_ENCAP_ATM_VCC	ATM VCC.
LDP_LSP_ENCAP_ATM_VPC	ATM VPC.
LDP_LSP_ENCAP_ETHERNET_VPLS	Ethernet VPLS.
LDP_LSP_ENCAP_ATM_VCC_ONE_TO_ONE	ATM one-to-one VCC cell mode.
LDP_LSP_ENCAP_ATM_VPC_ONE_TO_ONE	ATM one-to-one VPC cell mode.
LDP_LSP_ENCAP_ATM_AAL5_PDU_VCC	ATM AAL5 PDU VCC transport.
LDP_LSP_ENCAP_FRAME_RELAY_PORT	Frame Relay port mode.
LDP_LSP_ENCAP_SONET_SDH_OVER_PKT	SONET-SDH circuit emulation over packet.
LDP_LSP_ENCAP_STRUCT_AGNOSTIC_E1_OVER_PKT	Structure-agnostic E1 over packet.
LDP_LSP_ENCAP_STRUCT_AGNOSTIC_T1_OVER_PKT	Structure-agnostic T1 over packet.
LDP_LSP_ENCAP_STRUCT_AGNOSTIC_E3_OVER_PKT	Structure-agnostic E3 over packet.
LDP_LSP_ENCAP_STRUCT_AGNOSTIC_T3_OVER_PKT	Structure-agnostic T3 over packet.
LDP_LSP_ENCAP_CES_OVER_PSN_BASIC	CESoPSN basic mode.
LDP_LSP_ENCAP_TDM_OVER_IP_AAL1	TDMoIP AAL1 mode.
LDP_LSP_ENCAP_CES_OVER_PSN_TDM_CAS	CESoPSN TDM with CAS.
LDP_LSP_ENCAP_TDM_OVER_IP_AAL2	TDMoIP AAL2 mode.
LDP_LSP_ENCAP_FRAME_RELAY_DLCI_NEW_BIT_ORDERING	Frame Relay DLCI.
LDP_LSP_ENCAP_ROHC_HEADER_COMPRESSED_PKT	ROHC transport header-compressed packets.
LDP_LSP_ENCAP_ECRTP_HEADER_COMPRESSED_PKT	ECRTP transport header-compressed packets.
LDP_LSP_ENCAP_IPHC_HEADER_COMPRESSED_PKT	IPHC transport header-compressed packets.
LDP_LSP_ENCAP_CRTP_HEADER_COMPRESSED_PKT	cRTP transport header-compressed packets.
LDP_LSP_ENCAP_ATM_VP_VIRTUAL_TRUNK	ATM VP virtual trunk.
LDP_LSP_ENCAP_RESERVED	Reserved.
LDP_LSP_ENCAP_WILDCARD	Wildcard.

EncapOverride

Override the default LDP VC encapsulation.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Override the default LDP VC encapsulation.
FALSE	Use the default LDP VC encapsulation.

GroupId

Group ID assigned to all virtual circuits.

Type: u32

Default: 1

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

HostNumLeftSiteVlans

Number of host VLANs for left site hosts.

Type: u8

Default: 1

Range: 0 - 9

HostNumRightSiteVlans

Number of host VLANs for right site 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

IncludeStatusTlv

Whether to include status TLV.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Include status TLV.
FALSE	Do not include status TLV.

LdpFecType

LDP FEC type.

Type: enum

Default: FEC_128

Possible Values:

Value	Description
FEC_128	FEC 128.
FEC_129	FEC 129.

LdpFecTypeSimulatedSegment

LDP FEC type for simulated segment.

Type: enum

Default: FEC_128

Possible Values:

Value	Description
FEC_128	FEC 128.
FEC_129	FEC 129.

LeftSiteHostPercent

Left VPN site host percent.

Type: double

Default: 50

Range: 0 - 100.0

LeftSiteHostsPerCe

Left VPN site hosts per CE.

Type: u32

Default: 1

Range: 1 - 2147483647

Mtu

MTU for the virtual circuit.

Type: u16

Default: 1500

Range: 512 - 65535

MultiSegmentTopologyType

MultiSegment topology type.

Type: enum

Default: DUT_SPE

Possible Values:

Value	Description
DUT_INGRESS_EGRESS	DUT as ingress or egress.
DUT_SPE	DUT as S-PE.

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.

PseudowireType

Pseudowire type.

Type: enum

Default: SINGLE_SEGMENT

Possible Values:

Value	Description
SINGLE_SEGMENT	Single segment.
MULTI_SEGMENT	Multi segment.

PwCount

Number of pseudowires.

Type: u32

Default: 1

Range: 1 - 4294967295

RightSiteHostPercent

Right VPN site host percent.

Type: double

Default: 50

Range: 0 - 100.0

RightSiteHostsPerCe

Right VPN site hosts per CE.

Type: u32

Default: 1

Range: 1 - 2147483647

RouteDistinguisher

Route distinguisher.

Type: string

Default: 1:0

RouteDistinguisherAssignment

Route distinguisher assignment.

Type: enum

Default: USE_RT

Possible Values:

Value	Description
USE_RT	Use router target.
MANUAL	Manual

RouteDistinguisherIncrement

Route distinguisher increment.

Type: string

Default: 0:1

RouteTarget

Route target.

Type: string

Default: 1:0

RouteTargetIncrement

Route target increment.

Type: string

Default: 0:1

SimulatedPeLoopbackIpAddr

Simulated PE loopback IP address.

Type: ip

Default: 100.0.0.2

SimulatedPeLoopbackIpAddrStep

Simulated PE loopback IP address step.

Type: ip

Default: 0.0.0.1

SimulatedPePerCorePe

Number of simulated PE routers behind each emulated PE router in a row topology.

Type: u32

Default: 1

Range: 0 - 1000

SimulatedTPePerCorePe

Number of simulated T-PE routers behind last simulated PE router.

Type: u32

Default: 1

Range: 1 - 1000

SPeEnable

Whether to configure the emulated router as an S-PE router.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Configure emulated router as S-PE router.
FALSE	Configure emulated router as T-PE router.

SrcAttachmentIndividualId

Source Attachment individual identifier.

Type: string

Default: "" (empty string)

SrcAttachmentIndividualIdIncrement

Source Attachment individual identifier increment.

Type: string

Default: "" (empty string)

SrcAttachmentIndividualIdIncrementSimulatedSegment

Source Attachment individual identifier increment for simulated segment.

Type: string

Default: 0.0.0.1

SrcAttachmentIndividualIdSimulatedSegment

Source Attachment individual identifier for simulated segment.

Type: string

Default: 10.0.0.1

StatusCode

Status code.

Type: enum

Default: 0

Possible Values:

Value	Description
NOT_FORWARDING	Pseudowire not forwarding (bit 0).
ATTACHMENT_CIRCUIT_RX_FAULT	Local attachment circuit receive fault (bit 1).
ATTACHMENT_CIRCUIT_TX_FAULT	Local attachment circuit transmit fault (bit 2).
PSEUDOWIRE_RX_FAULT	Local PSN-facing PW (ingress) receive fault (bit 3).
PSEUDOWIRE_TX_FAULT	Local PSN-facing PW (egress) transmit fault (bit 4).

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.

TargetAttachmentIndividualId

Target Attachment individual identifier.

Type: string

Default: "" (empty string)

TargetAttachmentIndividualIdIncrement

Target Attachment individual identifier increment.

Type: string

Default: 0.0.0.0

TargetAttachmentIndividualIdIncrementSimulatedSegment

Target Attachment individual identifier increment for simulated segment.

Type: string

Default: 0.0.0.1

TargetAttachmentIndividualIdSimulatedSegment

Target Attachment individual identifier.

Type: string

Default: 192.0.0.1

TotalHosts

Total number of hosts.

Type: u32

Default: 100

Range: 1 - 2147483647

TPePerSubIf

Number of T-PE routers per sub-interface.

Type: u32

Default: 1

Range: 0 - 1000

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.
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

TrafficLoadPercentFromLeftSitePorts

Traffic load percent from left VPN site ports.

Type: double

Default: 10.0

Range: 0 - 100

TrafficLoadPercentFromRightSitePorts

Traffic load percent from right VPN site ports.

Type: double

Default: 10.0

Range: 0 - 100

UseCorePortsEnable

Whether core side ports will be used.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Use core side ports.
FALSE	Do not use any core side ports.

UseCustomEncap

Use custom encapsulation.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use a custom encapsulation number in CustomEncap.
FALSE	Use the predefined encapsulation Encap.

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.

VcCount

Number of virtual circuits that will be configured.

Type: u16

Default: 10

Range: 1 - 65535

VcIdPeOverlapEnable

Overlap VC IDs on PEs.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Overlap VC IDs on PEs.
FALSE	Do not overlap VC IDs on PEs.

VcIdStart

Starting virtual circuit ID.

Type: u32

Default: 1

Range: 1 - 4294967295

VcIdStartSimulatedSegment

VC ID start for simulated segment.

Type: u32

Default: 1

Range: 1 - 4294967295

VcIdStep

Step applied to the starting VC ID for each subsequent VPN.

Type: u32

Default: 1

Range: 1 - 4294967295

VcIdStepSimulatedSegment

VC ID step for simulated segment.

Type: u32

Default: 1

Range: 1 - 4294967295

VlanEnable

Enable stacked VLANs.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use stacked VLANs.
FALSE	Do not use stacked VLANs.

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

Determines if VPN host 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.

VpnMartiniGenParams Read-Only Attributes

There are no read-only attributes.