Dhcpv6PdBlockConfig Object


Description:

DHCP PD block configuration settings.

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).

Dhcpv6PdBlockConfig Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
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.

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

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

Enable or disable rebind messages.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable rebind messages.

FALSE

Disable rebind messages.

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

Do not enable 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

Enable or disable renew messages.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable renew messages.

FALSE

Disable renew messages.

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

Step 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:

@s - Session index associated with the DHCPv6 client.

@b - Block (host/router) index.

@p - Port name.

@m - MAC address of the DHCPv6 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 textual "@" symbol in the string.

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

DHCPv6 release rate of this device block.

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:

@s - Session index associated with the DHCPv6 client.

@b - Block (host/router) index.

@p - Port name.

@m - MAC address of the DHCPv6 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 textual "@" symbol in the string.

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

DHCPv6 renew/rebind rate of this device block.

Type: u32

Default: 100

Range: 1 - 1000

RequestRate

DHCPv6 request rate of this device block.

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

Dhcpv6PdBlockConfig Read-Only Attributes

Read-Only Attribute Description
BlockState

Current state of the DHCPv6 session block.

Type: enum

Default: IDLE

Possible Values:

Value Description
IDLE

All sessions are idle.

REQUEST

At least one session is binding.

RELEASE

At least one session is releasing.

RENEW

At least one session is renewing.

REBIND

At least one session is rebinding.

AUTORENEW

At least one session is in the process of being auto-renewed.

GROUPREQ

Intermediate state within the binding state.

BOUND

All sessions done binding.

PENDING

All sessions are waiting for lower layer interface to be ready.

IDLINFOREQ

At least one session is sending Info-Request packet.

Dhcpv6BlockState

Current state of the DHCPv6 session block.

Type: enum

Default: IDLE

Possible Values:

Value Description
IDLE

All sessions are idle.

REQUEST

At least one session is binding.

RELEASE

At least one session is releasing.

RENEW

At least one session is renewing.

REBIND

At least one session is rebinding.

AUTORENEW

At least one session is in the process of being auto-renewed.

GROUPREQ

Intermediate state within the binding state.

BOUND

All sessions done binding.

PENDING

All sessions are waiting for lower layer interface to be ready.

IDLINFOREQ

At least one session is sending Info-Request packet.

PdBlockState

Current state of the DHCP PD session block.

Type: enum

Default: IDLE

Possible Values:

Value Description
IDLE

All sessions are idle.

REQUEST

At least one session is binding.

RELEASE

At least one session is releasing.

RENEW

At least one session is renewing.

REBIND

At least one session is rebinding.

AUTORENEW

At least one session is in the process of being auto-renewed.

GROUPREQ

Intermediate state within the binding state.

BOUND

All sessions done binding.

PENDING

All sessions are waiting for lower layer interface to be ready.

IDLINFOREQ

At least one session is sending Info-Request packet.