Dot1xSupplicantBlockConfig Object

Description:

Supplicant block settings.

Writable Attributes
Read-Only Attributes

Parents: EmulatedDevice

Children: Dot1xEapFastConfig, Dot1xEapMd5Config, Dot1xEapPeapConfig, Dot1xEapTls12Config, Dot1xEapTlsConfig, Dot1xEapTtlsConfig

Result children (automatically created): Dot1xEapAuthMethodResults, Dot1xEapMethodResults, Dot1xEapolResults, Dot1xEapPktResults, Dot1xSupplicantAuthResults

Relations:

Side name (Type)	Relative	Description
ViewControlPlaneMplsBindingResult (ControlPlaneBindingResult)	ViewControlPlaneMplsBindingResult	View control plane MPLS binding result.
ConvergenceConfig (PrimaryPathProtocolConfig)	ConvergenceConfig, ConvergenceConfig	Primary convergence config.
ResultChild (ResultChild)	Dot1xEapAuthMethodResults, Dot1xEapMethodResults, Dot1xEapolResults, Dot1xEapPktResults, Dot1xSupplicantAuthResults	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).

Dot1xSupplicantBlockConfig Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

AuthenticatorMac

MAC address of the authenticator DUT.

Type: mac

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

AuthRetryCount

Number of retries attempted when authentication fails.

Type: u32

Default: 10

AuthRetryIntervalInMsec

Authentication retry interval in ms.

Type: u32

Default: 1000

EapAuthMethod

EAP authentication method for supplicant(s).

Type: enum

Default: MD5

Possible Values:

Value	Description
MD5	EAP-MD5 authentication method.
FAST	EAP-FAST authentication method.
PEAP	EAP-PEAP authentication method.
TLS	EAP-TLS authentication method.
TLS12	TLS auth and TLS version is 1.2
TTLS	EAP-TTLS authentication method.

PeapTlsVersion

TLS auth and TLS version

Type: enum

Default: TLS10

Possible Values:

Value	Description
TLS10	TLS auth and TLS version is 1.0
TLS12	TLS auth and TLS version is 1.2

RetransmitCount

Number of retransmission attempts for EAPOL/EAP packets.

Type: u32

Default: 10

RetransmitIntervaInMsec

Retransmission interval (in ms) for EAPOL/EAP packets.

Type: u32

Default: 1000

UseAuthenticatorMacForAll

Use authenticator MAC for all Tx.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use authenticator MAC.
FALSE	Do not use authenticator MAC.

UsePaeGroupMac

Indicates whether to use the PAE multicast MAC (that is, 01:80:C2:00:00:03) in transmitted EAPOL packets. Note that 'AuthenticatorMac' will be ignored when this option is enabled.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Use PAE multicast MAC address.
FALSE	Use 'AuthenticatorMac' address.

UsePartialBlockState

Flag indicating partial block state to be used.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use partial block state.
FALSE	Do not use partial block state.

Dot1xSupplicantBlockConfig Read-Only Attributes

Read-Only Attribute

Description

AuthState

Current authentication state for the supplicant block.

Type: enum

Default: UNAUTHORIZED

Possible Values:

Value	Description
UNAUTHORIZED	Supplicant is not authorized.
AUTHENTICATING	Supplicant is being authenticated.
REAUTHENTICATING	Supplicant is being reauthenticated.
AUTH_SUCCESS	Supplicant was authenticated.
AUTH_FAILED	Supplicant was not authenticated.
LOGGING_OFF	Supplicant is logging off.