LacpPortConfig Object


Description:

LACP port configuration.

Parents: Port

Result children (automatically created): LacpPortResults

Relations:

Side name
(Type)
Relative Description
ViewControlPlaneMplsBindingResult
(ControlPlaneBindingResult)

ViewControlPlaneMplsBindingResult

LinkAggregationGroup
(MemberOfLag)

LacpGroupConfig

Identifies the LACP group that contains this port

ConvergenceConfig
(PrimaryPathProtocolConfig)

ConvergenceConfig, ConvergenceConfig

ResultChild
(ResultChild)

LacpPortResults

Use this to connect a results object to an object.

TimeComparisonPair
(TimeComparisonPairSrcProtocol)

TsnProtocolsTimeComparisonPair, TsnProtocolsTimeComparisonPair

UsesIf
(UsesIf)

Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, PppIf, PppoeIf, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf

Specifies the interfaces used by the configuration object (configuration object examples: BgpRouterConfig, LdpRouterConfig, and so on).

LacpPortConfig Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
ActorKey

Operational key value assigned to the port by the actor.

Type: u16

Default: 1

ActorPort

Port number assigned to the port by the actor.

Type: u16

Default: 1

ActorPortPriority

Priority assigned to this port by the actor.

Type: u16

Default: 1

LacpActivity

Activity control value with regard to this link.

Type: enum

Default: ACTIVE

Possible Values:

Value Description
PASSIVE

Passive activity - sends LACP PDUs only after receipt of LACP PDUs from partner.

ACTIVE

Active activity - initiates LACP PDUs.

LacpTimeout

Timeout value for this link.

Type: enum

Default: LONG

Possible Values:

Value Description
LONG

Long timeout (90 seconds).

SHORT

Short timeout (3 seconds).

UsePartialBlockState

Use partial block state.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Use partial block state.

FALSE

Do not use partial block state.

LacpPortConfig Read-Only Attributes

Read-Only Attribute Description
ActorState

Actor state variables for the port, encoded as individual bits.

The state bits are encoded as follows:

Bit 0: LACP Activity - this flag indicates the activity control value with regard to this link.

Bit 1: LACP Timeout - this flag indicates the timeout control value with regard to this link.

Bit 2: Aggregation - If true, this flag indicates that the system considers this link to be "aggregatable" (i.e., a potential candidate for aggregation). If false, this link is considered to be "individual" (i.e., this link can be operated only as an individual link).

Bit 3: Synchronization - If true, the system considers this link to be "in sync" [i.e., it has been allocated to the correct Link Aggregation Group (LAG), the group has been associated with a compatible aggregator, and the identity of the LAG is consistent with the system ID and operation key information transmitted]. If false, then this link is currently "out of sync" (i.e., it is not in the right aggregation).

Bit 4: Collecting - If true, it means collection of incoming frames on this link is enabled (i.e., collection is currently enabled and is not expected to be disabled in the absence of administrative changes or changes in received protocol information). If false, collection of frames is not enabled.

Bit 5: Distributing - If false, it means the distribution of outgoing frames on this link is disabled (i.e., distribution is currently disabled and is not expected to be enabled in the absence of administrative changes or changes in received protocol information). If true, distribution of frames is enabled.

Bit 6: Defaulted - If true, this flag indicates that the actor receive machine is using defaulted operational partner information, administratively configured for the partner. If false, the operational partner information in use has been received in a LACPDU.

Bit 7: Expired - If true, this flag indicates that the actor receive machine is in the expired state. If false, this flag indicates that the actor receive machine is not in the expired state.

Type: u8

Default: 0x00

LacpState

Summary information about the LACP peering state.

Type: enum

Default: NO_STATE

Possible Values:

Value Description
NO_STATE

State when the user configuration has not been applied.

DOWN

State when the actor or partner states are defaulted or do not have the collecting and distributing state bits set.

EXCHG

State when LACP sessions are either coming up or negotiating.

UP

State when the actor and partner states indicate a true value for the collecting and distributing state bits.

PartnerState

Partner state variables for the port, encoded as individual bits.

The state bits are encoded as follows:

Bit 0: LACP Activity - this flag indicates the activity control value with regard to this link.

Bit 1: LACP Timeout - this flag indicates the timeout control value with regard to this link.

Bit 2: Aggregation - If true, this flag indicates that the system considers this link to be "aggregatable" (i.e., a potential candidate for aggregation). If false, this link is considered to be "individual" (i.e., this link can be operated only as an individual link).

Bit 3: Synchronization - If true, the system considers this link to be "in sync" [i.e., it has been allocated to the correct Link Aggregation Group (LAG), the group has been associated with a compatible aggregator, and the identity of the LAG is consistent with the system ID and operation key information transmitted]. If false, then this link is currently "out of sync" (i.e., it is not in the right aggregation).

Bit 4: Collecting - If true, it means collection of incoming frames on this link is enabled (i.e., collection is currently enabled and is not expected to be disabled in the absence of administrative changes or changes in received protocol information). If false, collection of frames is not enabled.

Bit 5: Distributing - If false, it means the distribution of outgoing frames on this link is disabled (i.e., distribution is currently disabled and is not expected to be enabled in the absence of administrative changes or changes in received protocol information). If true, distribution of frames is enabled.

Bit 6: Defaulted - If true, this flag indicates that the actor receive machine is using defaulted operational partner information, administratively configured for the partner. If false, the operational partner information in use has been received in a LACPDU.

Bit 7: Expired - If true, this flag indicates that the actor receive machine is in the expired state; if false, this flag indicates that the actor receive machine is not in the expired state.

Type: u8

Default: 0x00