Dhcpv4MsgOption Object


Description:

Allows you to specify custom DHCP options.

Parents: Dhcpv4BlockConfig

Relations:

Side name
(Type)
Relative Description
Dhcpv4RelayAgentLink
(CustomOptionLink)

Dhcpv4RelayAgentLink

Link from Dhcpv4RelayAgentLink to Dhcpv4MsgOption.

Dhcpv4MsgOption Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
EnableWildcards

Expand wildcards in the message option.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Wildcards in the message option will be substituted for values.

FALSE

Wildcards in the message option will not be substituted for values.

HexValue

Indicate the string should/should not be treated as hexadecimal.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

String is in hexadecimal format.

FALSE

String is not in hexadecimal format.

MsgType

Includes the message option in DISCOVER, REQUEST, or BOTH.

Type: enum

Default: BOTH

Possible Values:

Value Description
DISCOVER

Include the message option in the DISCOVER message.

REQUEST

Include the message option in the REQUEST message.

BOTH

Include the message option in both DISCOVER and REQUEST messages.

OptionType

Option value.

Type: u8

Default: 0

Range: 0 - 255

Payload

@s - Session index associated with the DHCP client.

@b - Block (host/router) index.

@p - Port name.

@m - MAC address of the DHCP client.

@x - Custom step setup in (start,count,step,zeropadding,stutter) format.

start - starting value.

count - number of values to generate.

step - amount to increment the start value when the start value must be stepped.

zeropadding - length the value should be padded to by prepending 0's.

stutter - number of times a value should be repeated before applying the step.

@@ - This must be used to include the "@" symbol in the string.

Type: string

Default: "" (empty string)

Remove

Remove the options in the payload.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Remove the specified option(s).

FALSE

Do not remove the specified option(s).

Dhcpv4MsgOption Read-Only Attributes

There are no read-only attributes.