PppMsgOption Object


Description:

Set up custom options.

Parents: PppoaClientBlockConfig, PppoaServerBlockConfig, PppoeClientBlockConfig, PppoeServerBlockConfig, PppoL2tpv2ClientBlockConfig, PppoL2tpv2ServerBlockConfig, PppoL2tpv3ClientBlockConfig, PppoL2tpv3ServerBlockConfig, PppProtocolConfig

PppMsgOption Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
Data

Data portion of the option field.

Type: string

Default: "" (empty string)

EnableWildcards

Enables use of wildcards in the data portion of the custom option.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable wildcards (wildcard expressions will be expanded).

FALSE

Disable wildcards (wildcard expressions will be ignored).

HexValue

Treat the data string as ASCII or hexadecimal.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

String is hexadecimal.

FALSE

String is ASCII.

MsgCodeProto

Protocol(s) that will include the custom option. If you want to include the same option in multiple protocols, create multiple (nearly-identical) options, and set the MsgCodeProto for each of them.

Type: enum

Default: LCP

Possible Values:

Value Description
LCP

LCP.

IPCP

IPCP.

IPV6CP

IPv6CP.

PADI_PADR

PADI_PADR.

OptionType

16-bit option type.

Type: u16

Default: 0

PppMsgOption Read-Only Attributes

There are no read-only attributes.