Dhcpv6DeviceGenProtocolParams Object


Description:

DHCP-PD specific Host generator parameters.

Parents: EmulatedDeviceGenParams, HostGenParams, RouterGenParams

Children: DeviceGenLinkedStep

Dhcpv6DeviceGenProtocolParams 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

ClientsPerHomeGateway

Number of clients per home gateway.

Type: u32

Default: 1

Range: 1 - 65536

ClientsPerRelayAgent

Number of clients per relay agent.

Type: u32

Default: 1

Range: 1 - 65535

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.

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.

EnableRebind

Enable or disable rebind messages.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable rebind messages.

FALSE

Disable rebind messages.

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

Enable or disable renew messages.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable renew messages.

FALSE

Disable renew messages.

ExportAddrToLinkedClients

Enables exporting resolved addresses to linked client blocks (through a home gateway Link).

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable exporting resolved addresses to linked client blocks.

FALSE

Disable exporting resolved addresses to linked client blocks.

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.

Type: string

Default: interfaceId_@p

Range: 1 - 128 characters

Mode

Specifies whether the device is emulating a DHCPv6-PD client or full DHCPv6 client.

Type: enum

Default: PD

Possible Values:

Value Description
CLIENT

Specifies that the device is emulating a full DHCPv6 client.

PD

Specifies that the device is emulating a DHCPv6-PD client.

PD_AND_CLIENT

Specifies that the device is emulating a DHCPv6 and DHCPv6-PD client.

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

PrefixStep

DHCPv6 client requested prefix step.

Type: ipv6

Default: ::

RapidCommitMode

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

Type: enum

Default: DISABLE

Possible Values:

Value Description
DISABLE

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

RelayClientMacAddrStart

Client (behind the relay agent) MAC address start.

Type: mac

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

RelayClientMacAddrStep

Client (behind the relay agent) MAC address step.

Type: mac

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

RelayServerIpv6Addr

Relay server IPv6 address.

Type: ipv6

Default: ::

RelayServerIpv6AddrStep

Relay server IPv6 address step.

Type: ipv6

Default: ::1

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

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

UseGatewayAsRelayServerIpv6Addr

Whether the gateway address will be used as the relay server IPv6 address.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Use the gateway as the relay server IPv6 address.

FALSE

Do not use the gateway as the relay server IPv6 address (specify with RelayServerIpv6Addr).

UseRelayAgentMacAddrForDataplane

Whether the 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 client's MAC address for the data plane.

ValidLifetime

Valid lifetime in seconds for the addresses.

Type: u32

Default: 2592000

Dhcpv6DeviceGenProtocolParams Read-Only Attributes

There are no read-only attributes.