LdpWithdrawMacAddrCommand Object

Description:

Withdraw MAC addresses associated with LDP signaled VPLSs.

Writable Attributes
Read-Only Attributes

Can be used with Command Sequencer: Yes

GUI Command Name: LDP: Withdraw MAC Address

Parents: Sequencer, StcSystem

LdpWithdrawMacAddrCommand Writable Attributes

Attribute

Description

Common Writable Attributes

ProgressCancelled

AttachmentGroupId

Start value for attachment group identifier (AGI) for custom generalized PWid LSPs.

Type: string

Default: 100:1

AttachmentGroupIdIncrement

Attachment group identifier (AGI) increment for custom generalized PWid LSPs.

Type: string

Default: 0:1

CustomEncap

Custom encapsulation value.

Type: u16

Default: 4

Range: 0 - 32767

Encap

Encapsulation type.

Type: enum

Default: LDP_LSP_ENCAP_ETHERNET_VLAN

Possible Values:

Value	Description
LDP_LSP_ENCAP_FRAME_RELAY_DLCI	Frame relay DLCI.
LDP_LSP_ENCAP_ATM_AAL5_VCC	ATM AAL5 SDU VCC 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 n-to-one VCC cell transport.
LDP_LSP_ENCAP_ATM_VPC	ATM n-to-one VPC cell transport.
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 (DS1) 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 (DS3) 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 packet.
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.

GroupId

Group ID for custom VC LSPs.

Type: u32

Default: 0

LspCount

Number of custom LSPs on which MAC addresses are to be withdrawn.

Type: u32

Default: 1

Range: 1 - 4294967295

LspType

Mode for specifying LSPs for which MAC addresses are withdrawn.

Type: enum

Default: LDP_LSP_TYPE_CONFIGURED_LSPS

Possible Values:

Value	Description
LDP_LSP_TYPE_CONFIGURED_LSPS	Send a MAC withdraw message for selected LSPs.
LDP_LSP_TYPE_CUSTOM_VC	Send a user-configured FEC 128 MAC withdraw message for selected devices.
LDP_LSP_TYPE_CUSTOM_GENERALIZED_PWID	Send a user-configured FEC 129 MAC withdraw message for selected devices.

MacAddrCount

Number of addresses to withdraw using the MAC address range values.

Type: u32

Default: 1

Range: 1 - 5000

MacAddrInputFormat

Input format for MAC addresses to be withdrawn.

Type: enum

Default: MAC_ADDR_ALL

Possible Values:

Value	Description
MAC_ADDR_ALL	Withdraw all MAC addresses associated with the LSPs. This option would use an empty MAC TLV.
MAC_ADDR_CUSTOM_RANGE	Custom range of MAC addresses.
MAC_ADDR_CUSTOM_TABLE	List of MAC addresses.

MacAddrStep

Step value for the MAC addresses in the custom MAC range.

Type: mac

Default: 00:00:00:00:00:01

MacList

List of MAC addresses to withdraw.

Type: mac

Default: 00-00-00-00-00-01

ObjectList

List of LSPs for LspType of configured LSPs. The list of routers for LspType of custom VC or custom generalized PWid LSPs.

Type: handle

Default: 0

SrcAttachmentIndividualId

Start value for source attachment individual identifier (SAII) for custom generalized PWid LSPs.

Type: string

Default: 192.0.0.1

SrcAttachmentIndividualIdIncrement

Source attachment individual identifier (SAII) increment for custom generalized PWid LSPs.

Type: string

Default: 0.0.0.1

StartMacAddr

Start value for the MAC addresses in the custom MAC range.

Type: mac

Default: 00:10:94:00:00:02

StartVcId

Start VC ID for custom VC LSPs.

Type: u32

Default: 1

TargetAttachmentIndividualId

Start value for target attachment individual identifier (TAII) for custom generalized PWid LSPs.

Type: string

Default: 192.0.0.1

TargetAttachmentIndividualIdIncrement

Target attachment individual identifier (TAII) increment for custom generalized PWid LSPs.

Type: string

Default: 0.0.0.1

UseCustomEncap

Use or do not use custom encapsulation for the custom LSPs.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use custom encapsulation for the custom LSPs.
FALSE	Do not use custom encapsulation for the custom LSPs.

VcIdIncrement

VC ID increment for custom VC LSPs.

Type: u32

Default: 1

LdpWithdrawMacAddrCommand Read-Only Attributes

Read-Only Attribute	Description
Common Read-Only Attributes	ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status