Dhcpv6PortConfig Object


Description:

DHCPv6 port-level configuration settings.

Parents: AccessTestGenPortParams

Automatically created from: Port

Result children (automatically created): Dhcpv6PortResults

Relations:

Side name
(Type)
Relative Description
ResultChild
(ResultChild)

Dhcpv6PortResults

Use this to connect a results object to an object.

Dhcpv6PortConfig Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
ConfirmTimeout

Initial retransmission time of confirm messages.

Type: u32

Default: 1

Range: 1 - 99999

DeclineRetryCount

Number of decline retries.

Type: u8

Default: 5

Range: 0 - 32

DeclineTimeout

Decline message initial timeout in seconds.

Type: u32

Default: 1

Range: 1 - 99999

DisableDeclineRetry

Flag indicating declines will be not be retried.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Disable retry of declines.

FALSE

Enable retry of declines.

DisableInfoRequestRetry

Flag indicating info-request messages will be not be retried.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Disable retry of info-request messages.

FALSE

Enable retry of info-request messages.

DisableRebindRetry

Flag indicating rebinds will be not be retried.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Disable retry of rebinds.

FALSE

Enable retry of rebinds.

DisableReleaseRetry

Flag indicating releases will be not be retried.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Disable retry of releases.

FALSE

Enable retry of releases.

DisableRenewRetry

Flag indicating renews will be not be retried.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Disable retry of renews.

FALSE

Enable retry of renews.

DisableRequestRetry

Flag indicating requests will be not be retried.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Disable retry of requests.

FALSE

Enable retry of requests.

DisableSolicitRetry

Flag indicating solicits will be not be retried.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Disable retry of solicits.

FALSE

Enable retry of solicits.

EnableBlockRate

Enable To Control Block Rate Based On Devices.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Control Block Rate Based On Devices.

FALSE

Control Block Rate Based On Port Config.

IndefDeclineRetry

Flag indicating decline be retried indefinitely.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable indefinite retry of decline.

FALSE

Disable indefinite retry of decline.

IndefInfoRequestRetry

Flag indicating info-request message be retried indefinitely.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable indefinite retry of info-request message.

FALSE

Disable indefinite retry of info-request message.

IndefRebindRetry

Flag indicating rebind will retried indefinitely.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable indefinite retry of rebind.

FALSE

Disable indefinite retry of rebind.

IndefReleaseRetry

Flag indicating release be retried indefinitely.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable indefinite retry of release.

FALSE

Disable indefinite retry of release.

IndefRenewRetry

Flag indicating renew will retried indefinitely.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable indefinite retry of renew.

FALSE

Disable indefinite retry of renew.

IndefRequestRetry

Flag indicating requests will retried indefinitely.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable indefinite retry of requests.

FALSE

Disable indefinite retry of requests.

IndefSolicitRetry

Flag indicating solicits will be retried indefinitely.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable indefinite retry of solicits.

FALSE

Disable indefinite retry of solicits.

InfoRequestRetryCount

Number of info-request message retries.

Type: u32

Default: 0

Range: 0 - 4294967295

InfoRequestTimeout

Initial retransmission time of info-request messages.

Type: u32

Default: 1

Range: 1 - 99999

LeaseTime

Suggested lease time in seconds at the DHCPv6 port level.

Type: u32

Default: 86400

Range: 10 - 4294967295

MaxConfirmDuration

Specifies an upper bound on the length of time a client may retransmit the confirm message. The message exchange fails once the duration is exceeded.

Type: u32

Default: 10

Range: 1 - 99999

MaxConfirmTimeout

Specifies an upper bound on the value of retransmission time of confirm messages.

Type: u32

Default: 4

Range: 1 - 99999

MaxInfoRequestTimeout

Specifies an upper bound on the value of retransmission time of info-request messages.

Type: u32

Default: 120

Range: 1 - 99999

MaxRebindRetryTimeout

Maximum rebind message retry timeout in seconds.

Type: u32

Default: 600

Range: 1 - 99999

MaxRenewRetryTimeout

Maximum renew message retry timeout in seconds.

Type: u32

Default: 600

Range: 1 - 99999

MaxRequestRetryTimeout

Maximum request message retry timeout in seconds.

Type: u32

Default: 30

Range: 1 - 99999

MaxSolicitRetryTimeout

Maximum solicit message retry timeout in seconds.

Type: u32

Default: 120

Range: 1 - 99999

NoWaitMultiAdv

Disable DHCPv6 Client Collecting Advertise.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

DHCPv6 Client Use The First Advertise.

FALSE

DHCPv6 Client Will Collect Advertise.

OutstandingSessionCount

Number of DHCPv6 sessions to resolve at a time.

Type: u32

Default: 1000

Range: 1 - 65535

RebindRetryCount

Number of rebind retries.

Type: u32

Default: 0

Range: 0 - 4294967295

RebindTimeout

Rebind message initial timeout in seconds.

Type: u32

Default: 10

Range: 1 - 99999

ReleaseRate

Number of DHCPv6 sessions that are released per second. This value applies to all sessions on the port. Use the Release operation to release DHCPv6 sessions.

Type: double

Default: 100.0

Range: 1.0 - 1000.0

ReleaseRetryCount

Number of release retries.

Type: u8

Default: 5

Range: 0 - 32

ReleaseTimeout

Release message initial timeout in seconds.

Type: u32

Default: 1

Range: 1 - 99999

RenewRate

Renewals per second for DHCPv6 client renewals. This value applies to all sessions on the port.

Type: double

Default: 100.0

Range: 1.0 - 1000.0

RenewRetryCount

Number of renew retries.

Type: u32

Default: 0

Range: 0 - 4294967295

RenewTimeout

Renew message initial timeout in seconds.

Type: u32

Default: 10

Range: 1 - 99999

RequestRate

Requests per second for DHCPv6 client leases. This value applies to all sessions on the port.

Type: double

Default: 100.0

Range: 1.0 - 1000.0

RequestRateBehavior

How DHCPv6 client control the solicit message based on Request Rate.

Type: enum

Default: NEWSESSIONONLY

Possible Values:

Value Description
NEWSESSIONONLY

The DHCPv6 client send Solicit Message for new sessions at Request rate.

NEWSESSIONANDRETRY

The DHCPv6 client send Solicit Message for new sessions and retry messages at Request rate.

NEWSESSIONANDRETRYSTRICTLY

The DHCPv6 client send Solicit Message for new sessions and retry messages at Request rate strictly.

RequestRetryCount

Number of request retries.

Type: u8

Default: 10

Range: 0 - 32

RequestTimeout

Request message initial timeout in seconds.

Type: u32

Default: 1

Range: 1 - 99999

RetryAttempts

Maximum Session Level Auto Retry Count.

Type: u32

Default: 0

Range: 0 - 4294967295

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.

SessionAutoRetry

Enable Session Level Auto Retry.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable Session Level Auto Retry.

FALSE

Disable Session Level Auto Retry.

SolicitRetryCount

Number of solicit retries.

Type: u8

Default: 10

Range: 0 - 32

SolicitTimeout

Solicit message initial timeout in seconds.

Type: u32

Default: 1

Range: 1 - 99999

Dhcpv6PortConfig Read-Only Attributes

Read-Only Attribute Description
PortState

Aggregate status of all hosts (home gateways) on the DHCPv6/PD port. If all hosts on the port are not in the same state, the aggregate state is determined based on rules of precedence. There are three stable states: Idle, Bound, or None. All other states are considered transitional. In determining the aggregate state, any hosts on a port that are 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 DHCPv6/PD sessions are active. This state is entered if all hosts were manually released.

ESTABLISH

At least one session on the port is in the process of being established. At least one host is sending a REQUEST message requesting an IPv6 prefix. The remaining hosts may be in either the Bound or Idle state, but not the Releasing state.

RELEASE

At least one host on the port no longer needs to use the IPv6 prefix leased to it and is in the process of sending a RELEASE message to the delegating router or is awaiting a REPLY message from the delegating router in response to a RELEASE message.

ESTABLISH_RELEASE

If there is more than one host on the port, at least one host is requesting a prefix and at least one is releasing a prefix.

BOUND

The SOLICIT, ADVERTISE, REQUEST, and REPLY messages between the host and delegating router have resulted in retrieving an IPv6 prefix for at least one host on the port. No other hosts are requesting or releasing prefixes, but they may be automatically renewing expired leases.