Dhcpv6BlockConfig Object

Description:

DHCPv6 client block configuration settings.

Writable Attributes
Read-Only Attributes

Parents: EmulatedDevice

Children: Dhcpv6DelayedAuthKey, Dhcpv6MsgOption

Result children (automatically created): Dhcpv6BlockResults, Dhcpv6SessionExtResults, Dhcpv6SessionResults

Relations:

Side name (Type)	Relative	Description
ViewControlPlaneMplsBindingResult (ControlPlaneBindingResult)	ViewControlPlaneMplsBindingResult	Mpls control plane binding result.
ConvergenceConfig (PrimaryPathProtocolConfig)	ConvergenceConfig, ConvergenceConfig	Primary path.
ResultChild (ResultChild)	Dhcpv6BlockResults	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).

Dhcpv6BlockConfig Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

AuthProtocol

Protocol used to generate the authentication information carried in the option.

Type: enum

Default: DELAYED_AUTH

Possible Values:

Value	Description
DELAYED_AUTH	Use the delayed authentication protocol.
RECONFIG_KEY	Use the reconfigure key authentication protocol.

ClientMacAddrMask

DHCPv6 client MAC address mask.

Type: mac

Default: 00-00-00-ff-ff-ff

ClientMacAddrStart

DHCPv6 client starting MAC address.

Type: mac

Default: 00-10-01-00-00-01

ClientMacAddrStep

DHCPv6 client MAC address step.

Type: mac

Default: 00-00-00-00-00-01

ControlPlanePrefix

Control plane source for the IPv6 address prefix.

Type: enum

Default: LINKLOCAL

Possible Values:

Value	Description
LINKLOCAL	Use the Link-Local address.
ROUTERADVERTISEMENT	Use the router advertisement.

DadTimeout

Length of time in seconds that must elapse before the Neighbor Solicit times out.

Type: u32

Default: 1

Range: 1 - 4294967295

DadTransmits

Number of Neighbor Solicit messages to send out per session during duplicate address detection.

Type: u32

Default: 1

Range: 1 - 4294967295

DhcpRealm

DHCP realm that identifies the key used to generate the HMAC-MD5 value when using delayed authentication.

Type: string

Default: spirent.com

Dhcpv6ClientMode

The type of client to emulate.

Type: enum

Default: DHCPV6

Possible Values:

Value	Description
DHCPV6	The client emulates DHCPv6.
DHCPPD	The client emulates DHCP PD.
DHCPV6ANDPD	The client emulates DHCPv6 and DHCP PD.

DstAddrType

Determines the DHCP control plane multicast address used as destination ip address.

Type: enum

Default: ALL_DHCP_RELAY_AGENTS_AND_SERVERS

Possible Values:

Value	Description
ALL_DHCP_RELAY_AGENTS_AND_SERVERS	(FF02::1:2) A link-scoped multicast address used by a client to communicate with neighboring relay agents and servers.
ALL_DHCP_SERVERS	(FF05::1:3) A site-scoped multicast address used by a relay agent to communicate with servers.

DuidEnterprise

Enterprise number to be used in the DUID. This is only applicable when DuidType is set to EN.

Type: u32

Default: 3456

DuidStart

Starting DUID value.

Type: string

Default: 0001

DuidStep

DUID step value.

Type: string

Default: 1

DuidType

DHCPv6 unique identifier type.

Type: enum

Default: LLT

Possible Values:

Value	Description
LLT	Link-layer address plus time.
EN	Vendor-assigned unique ID based on enterprise number.
LL	Link-layer address.
CUSTOM	Custom type.

DuidValue

Custom DUID value.

Type: u16

Default: 1

Range: 0 - 65535

EnableAuth

Specifies whether to use the DHCP message authentication option used to reliably identify the source of a DHCP message and to confirm that the contents of the DHCP message have not been tampered with.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enables authentication option on DHCP clients.
FALSE	Disables authentication option on DHCP clients.

EnableDad

Enable duplicate address detection. Note that the session will not go bound until the duplicate address detection is complete. If duplicate address detection fails, the address will be declined and the session will go idle.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Enables duplicate address detection for this session block.
FALSE	Disables duplicate address detection for this session block.

EnableInterfaceId

Enable or disable Relay Agent Interface ID Option.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable Relay Agent Interface ID Option.
FALSE	Disable Relay Agent Interface ID Option.

EnableLdra

Enable or disable a Lightweight DHCPv6 Relay Agent(LDRA).

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable a Lightweight DHCPv6 Relay Agent(LDRA).
FALSE	Disable a Lightweight DHCPv6 Relay Agent(LDRA).

EnableRebind

Specifies whether the host sends a REBIND message to the delegating router when the DHCPv6/PD session's T2 time has expired. The lifetime of the prefixes (DHCPv6-PD) or addresses (DHCPv6 client) continues until the Valid Lifetime value is reached.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Specifies that the host will send a REBIND message when T2 expires.
FALSE	Specifies that the host will not send a REBIND message when T2 expires.

EnableReconfigAccept

Specifies whether the client is willing to accept Reconfigure messages from the server. The default behavior, in the absence of this option, means unwillingness to accept Reconfigure messages.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Specifies that the client is willing to accept Reconfigure messages from the server.
FALSE	Specifies that the client is unwilling to accept Reconfigure messages from the server.

EnableRelayAgent

Flag to enable relay agent emulation.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable relay agent emulation.
FALSE	Disable relay agent emulation.

EnableRemoteId

Enable or disable Relay Agent Remote ID Option.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable Relay Agent Remote ID Option.
FALSE	Disable Relay Agent Remote ID Option.

EnableRenew

Specifies whether the host sends a RENEW message to the delegating router when the DHCPv6/PD session's T1 time has expired. The host enters the Renewing state when the elapsed lease lifetime is between T1 and T2, but the State field does not change accordingly.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Specifies that host will send a RENEW message when T1 expires.
FALSE	Specifies that host will not send a RENEW message when T1 expires.

HgMacStart

Home Gateway starting MAC address.

Type: mac

Default: 00-10-01-00-00-01

HgMacStep

Home Gateway MAC address step.

Type: mac

Default: 00-00-00-00-00-01

IaidStart

Start value of IAID of each device.

Type: u32

Default: 0

IaidStep

Stept value of IAID of each device.

Type: u32

Default: 0

InterfaceId

Enabled for DHCPv6 LDRA or DHCPv6 Relay Agent to identify the interface on which the client message was received.Use wildcard characters to make each interface ID unique.

Type: string

Default: interfaceId_@p

Range: 1 - 128 characters

Ipv6TrafficClass

Traffic Class Value (Hex) in IP Header.

Type: u8

Default: 0xC0

PreferredLifetime

Preferred lifetime in seconds for the addresses.

Type: u32

Default: 604800

PrefixLength

DHCPv6 client requested prefix length.

Type: u8

Default: 0

Range: 0 - 64

PrefixStart

DHCPv6 client requested prefix starting address.

Type: ipv6

Default: ::

RapidCommitMode

Select the rapid commit operation mode (Disable, Enable, Server).

Type: enum

Default: DISABLE

Possible Values:

Value	Description
DISABLE	Disable rapid commit mode.
ENABLE	Enable rapid commit mode and only honor replies with the Rapid Commit option.
SERVER	Enable rapid commit mode and continue binding process whether or not the server responds with a Rapid Commit option.

RelayServerIpv6Addr

Relay server IPv6 address.

Type: ipv6

Default: null

RelayServerIpv6AddrStep

Relay server IPv6 address step.

Type: ipv6

Default: ::

ReleaseRate

Release Rate.

Type: u32

Default: 100

Range: 1 - 1000

RemoteId

This option may be added by DHCPv6 relay agents that terminate switched or permanent circuits and have mechanisms to identify the remote host end of the circuit. Use wildcard characters to make each remote ID unique.

Type: string

Default: remoteId_@p-@b-@s

Range: 1 - 128 characters

RemoteIdEnterprise

Enabled for DHCPv6 LDRA or DHCPv6 Relay Agent to identify the vendor’s registered Enterprise Number as registered with IANA.

Type: u32

Default: 3456

RemoveIaprefixFromIapd

Remove IA Prefix from IA_PD option

Type: enum

Default: 0

Possible Values:

Value	Description
SOLICIT	Remove IA Prefix from IA_PD option in Solicit
REQUEST	Remove IA Prefix from IA_PD option in Request
RELEASE	Remove IA Prefix from IA_PD option in RELEASE

RenewRate

Renew Rate.

Type: u32

Default: 100

Range: 1 - 1000

RequestedAddrStart

DHCPv6 client requested starting address.

Type: ipv6

Default: ::

RequestRate

Request Rate.

Type: u32

Default: 100

Range: 1 - 1000

T1Timer

Time in seconds at which the client contacts the server from which the addresses were obtained to extend the lifetimes of the assigned addresses.

Type: u32

Default: 302400

Range: 0 - 2147483647

T2Timer

Time in seconds at which the client contacts any available server to extend the lifetimes of the assigned addresses.

Type: u32

Default: 483840

Range: 0 - 2147483647

UsePartialBlockState

Flag indicating partial block state as used.

Type: bool

Default: FALSE

Possible Values:

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

UseRelayAgentMacAddrForDataplane

Whether relay agent's MAC address should be used for the data plane.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Use the relay agent's MAC address for the data plane.
FALSE	Use the linked session block MAC address for the data plane.

ValidLifetime

Valid lifetime in seconds for the addresses.

Type: u32

Default: 2592000

Dhcpv6BlockConfig Read-Only Attributes

Read-Only Attribute

Description

BlockState

Aggregate status of all hosts (home gateways) in the block. If all hosts in the block 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 in a transitional state take precedence over those that are already bound.

Type: enum

Default: IDLE

Possible Values:

Value	Description
IDLE	No hosts are currently active (no commands have been issued). No DHCPv6/PD sessions are active. This state is entered if the hosts were manually released.
REQUEST	At least one session in the block is in the process of being established. At least one host is sending a SOLICIT message to obtain a DHCPv6/PD lease or 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 in the block no longer needs to use the IPv6 prefix leased to it and either 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.
RENEW	At least one host in the block is in the process of renewing the lease by sending a RENEW message. Other hosts can be in the Bound or Idle state. NOTE: The Renewing state refers only to leases that were manually renewed (using the Renew DHCPv6/PD Host command). It does not refer to the automatic renewal that occurs when the T1 timer has expired.
REBIND	At least one host in the block is in the process of being rebound. When the prefix's elapsed lease lifetime is between T2 and the end of the lease (valid lifetime), the emulated home gateways are in the process of sending a REBIND message.
AUTORENEW	At least one session is in the process of being auto-renewed.
GROUPREQ	Intermediate state within the binding state.
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 in the block. No other hosts are requesting or releasing prefixes, but they may be automatically renewing expired leases.
PENDING	All sessions are waiting for lower layer interface to be ready.
IDLINFOREQ	At least one session is sending Info-Request packet.

Dhcpv6BlockState

Type: enum

Default: IDLE

Possible Values:

Value	Description
IDLE	No hosts are currently active (no commands have been issued). No DHCPv6/PD sessions are active. This state is entered if the hosts were manually released.
REQUEST	At least one session in the block is in the process of being established. At least one host is sending a SOLICIT message to obtain a DHCPv6/PD lease or 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 in the block no longer needs to use the IPv6 prefix leased to it and either 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.
RENEW	At least one host in the block is in the process of renewing the lease by sending a RENEW message. Other hosts can be in the Bound or Idle state. NOTE: The Renewing state refers only to leases that were manually renewed (using the Renew DHCPv6/PD Host command). It does not refer to the automatic renewal that occurs when the T1 timer has expired.
REBIND	At least one host in the block is in the process of being rebound. When the prefix's elapsed lease lifetime is between T2 and the end of the lease (valid lifetime), the emulated home gateways are in the process of sending a REBIND message.
AUTORENEW	At least one session is in the process of being auto-renewed.
GROUPREQ	Intermediate state within the binding state.
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 in the block. No other hosts are requesting or releasing prefixes, but they may be automatically renewing expired leases.
PENDING	All sessions are waiting for lower layer interface to be ready.
IDLINFOREQ	At least one session is sending Info-Request packet.

PdBlockState

Type: enum

Default: IDLE

Possible Values:

Value	Description
IDLE	No hosts are currently active (no commands have been issued). No DHCPv6/PD sessions are active. This state is entered if the hosts were manually released.
REQUEST	At least one session in the block is in the process of being established. At least one host is sending a SOLICIT message to obtain a DHCPv6/PD lease or 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 in the block no longer needs to use the IPv6 prefix leased to it and either 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.
RENEW	At least one host in the block is in the process of renewing the lease by sending a RENEW message. Other hosts can be in the Bound or Idle state. NOTE: The Renewing state refers only to leases that were manually renewed (using the Renew DHCPv6/PD Host command). It does not refer to the automatic renewal that occurs when the T1 timer has expired.
REBIND	At least one host in the block is in the process of being rebound. When the prefix's elapsed lease lifetime is between T2 and the end of the lease (valid lifetime), the emulated home gateways are in the process of sending a REBIND message.
AUTORENEW	At least one session is in the process of being auto-renewed.
GROUPREQ	Intermediate state within the binding state.
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 in the block. No other hosts are requesting or releasing prefixes, but they may be automatically renewing expired leases.
PENDING	All sessions are waiting for lower layer interface to be ready.
IDLINFOREQ	At least one session is sending Info-Request packet.