Dhcpv4PortConfig Object


Description:

Defines characteristics of the communication between emulated DHCP clients and the DHCP server (the DUT).

You can create only one DhcpPort object under an Ethernet object. The values defined by the DhcpPort object are applied to all DHCP sessions defined by all DhcpSessionBlock objects that are children of the same Ethernet object.

Parents: AccessTestGenPortParams

Automatically created from: Port

Result children (automatically created): Dhcpv4PortResults

Relations:

Side name
(Type)
Relative Description
ResultChild
(ResultChild)

Dhcpv4PortResults

Use this to connect a results object to an object.

Dhcpv4PortConfig Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
Dnav4Timeout

DNAv4 timeout.

Type: u32

Default: 1000

Range: 10 - 99999

EnableAssignCustomOptionsForHosts

Enable assign custom option on relay agent mode.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable assign custom option on relay agent mode.

FALSE

Disable assign custom option on relay agent mode.

LeaseTime

Suggested lease time in seconds at the DHCP port level.

Type: u32

Default: 60

Range: 10 - 4294967295

MaxDnav4RetryCount

Max DNAv4 retry count.

Type: u16

Default: 0

Range: 0 - 10

MaxMsgSize

Used to negotiate the maximum DHCP message size, in bytes. This is option 57 for the options field of the DHCP message, as described in RFC 2132.

Type: u16

Default: 576

Range: 264 - 1500

MsgTimeout

Message timeout in seconds.

Type: u32

Default: 60

Range: 1 - 99999

NakBehaviorType

The DHCPv4 client's behavior when Nak is received.

Type: enum

Default: ATONCE

Possible Values:

Value Description
ATONCE

The DHCPv4 client send Discover at once when Nak is received.

ATREQESTRATE

The DHCPv4 client send Discover at Request rate when Nak is received.

STOPSESSION

The DHCPv4 client stop current session when Nak is received.

OutstandingSessionCount

Number of DHCP sessions to resolve at a time.

Type: u32

Default: 1000

Range: 1 - 65535

ReleaseRate

Number of DHCP sessions that are released per second. This value applies to all sessions on the port (all sessions defined by all DhcpSessionBlock objects that ReleaseRate are children of the Ethernet object). Use the Release operation to release DHCP sessions.

Type: double

Default: 100.0

Range: 1 - 10000

RequestRate

Requests per second for DHCP client leases or lease renewals. This value applies to all sessions on the port (all sessions defined by all DhcpSessionBlock objects that are children of the Ethernet object).

Type: double

Default: 100.0

Range: 1.0 - 10000.0

RetryCount

Number of retries allowed.

Type: u16

Default: 4

Range: 0 - 65535

SeqType

Port-level sequence type that determines in what order sessions are attempted.

Type: enum

Default: SEQUENTIAL

Possible Values:

Value Description
SEQUENTIAL

Sessions are attempted sequentially across host blocks under the port.

PARALLEL

Sessions are attempted in parallel across host blocks under the port.

StartingXid

Starting transaction ID for sessions on this port.

Type: u32

Default: 0

Dhcpv4PortConfig Read-Only Attributes

Read-Only Attribute Description
PortState

Aggregate status of all DHCP hosts on the port. If all hosts on the port are not in the same state, their aggregate state is determined based on rules of precedence. Idle and Bound are the only stable states. All other states are considered transitional. In determining the aggregate state, any hosts in a transitional state take precedence over those that are already bound.

Type: enum

Default: IDLE

Possible Values:

Value Description
IDLE

No host blocks are currently active (no commands have been issued). No DHCP sessions are active. This state is entered if all hosts were manually released.

ESTABLISH

At least one of the session blocks is doing a bind.

RELEASE

At least one host on the port no longer needs to use the IP address leased to it and is in the process of sending a DHCPRELEASE message to the DHCP server.

ESTABLISH_RELEASE

At least one session block is binding, and at least one session block is releasing an IP address.

BOUND

The DHCPDISCOVER, DHCPOFFER, DHCPREQUEST, and DHCPACK messages between the DHCP host and server have resulted in retrieving an IP address for at least one host on the port. No other hosts are requesting or releasing IP addresses, but they may be automatically renewing expired leases.