Dhcpv4DeviceGenProtocolParams Object


Description:

DHCP specific Host generator parameters.

Parents: AncpAccessLoopGenParams, EmulatedDeviceGenParams, HostGenParams, RouterGenParams

Children: DeviceGenLinkedStep

Dhcpv4DeviceGenProtocolParams Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
CircuitId

Circuit ID.

Type: string

Default: circuitId_@p

Range: 1 - 128 characters

ClientsPerRelayAgent

Clients per relay agent.

Type: u32

Default: 1

Range: 1 - 65535

EnableAutoRetry

Enable auto retry. Auto retry will retry sessions that fail to initially come up.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable auto retry. Failed sessions will be retried automatically.

FALSE

Disable auto retry.

EnableCircuitId

Enable circuit ID.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Include the circuit ID sub-option.

FALSE

Do not include the circuit ID sub-option.

EnableRelayAgent

Enable relay agent emulation.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Emulate a client behind a relay agent.

FALSE

Client is not behind a relay agent.

EnableRelayLinkSelection

Enable relay agent link selection sub-option in DHCP messages sent from emulated relay agent. The link selection sub-option is described in RFC 3527.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Include the link selection sub-option.

FALSE

Do not include the link selection sub-option.

EnableRelayServerIdOverride

Enable relay agent server identifier override sub-option in DHCP messages sent from emulated relay agent. The server identifier override sub-option is described in RFC 5107.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Include the server identifier override sub-option.

FALSE

Do not include the server identifier override sub-option.

EnableRelayVPNID

Enable relay agent virtual subnet selection sub-option in DHCP messages sent from emulated relay agent. The virtual subnet selection sub-option is described in RFC 6607.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Include the virtual subnet selection sub-option.

FALSE

Do not include the virtual subnet selection sub-option.

EnableRemoteId

Enable remote ID sub-option in DHCP messages sent from emulated relay agent.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Include the remote ID sub-option.

FALSE

Do not include the remote ID sub-option.

EnableRouterOption

Enable the router option (option 3) specified in RFC 2132.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable the router option.

FALSE

Disable the router option.

HostName

Unique hostname of emulated client. Use wildcard characters to make each hostname unique:

@s - Session index associated with the DHCP client.

@b - Block (host/router) index.

@p - Port name.

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

Type: string

Default: client_@p-@b-@s

Range: 1 - 32 characters

OptionList

A space-separated list of Option 55 numbers for the DHCP request messages on each session block. This attribute can have one or more of the following values:

1 - Subnet Mask Option.

3 - Router Option.

6 - Domain Name Servers Option.

15 - Domain Name Option.

33 - Static Routes Option.

44 - NetBIOS Name Servers Option.

46 - NetBIOS Node Type Option.

47 - NetBIOS Scope Option.

51 - IP Address Lease Time Option.

54 - Server Identifier Option.

58 - Renewal Time (T1) Option.

59 - Rebinding Time (T2) Option.

Tcl example:

-optionList "1 6 15 33 44 51"

Type: u8

Default: 1

RelayClientMacAddrMask

Relay agent client MAC address mask.

Type: mac

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

RelayClientMacAddrStart

Relay agent client starting MAC address.

Type: mac

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

RelayClientMacAddrStep

Relay agent client MAC address step.

Type: mac

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

RelayLinkSelection

Link selection field for the message sent by the relay agent.

The EnableRelayLinkSelection attribute must be set to TRUE for this to take effect.

Type: ip

Default: 192.85.1.1

RelayPoolIpv4Addr

Relay agent pool IPv4 address.

Type: ip

Default: 0.0.0.0

RelayPoolIpv4AddrStep

Relay agent pool IPv4 address step.

Type: ip

Default: 0.0.1.0

RelayServerIdOverride

Server identifier override field for the message sent by the relay agent.

The EnableRelayServerIdOverride attribute must be set to TRUE for this to take effect.

Type: ip

Default: 192.85.1.1

RelayServerIpv4Addr

Relay agent server IPv4 address if UseGatewayAsRelayServerIpv4Addr is true.

Type: ip

Default: 0.0.0.0

RelayServerIpv4AddrStep

Relay agent server IPv4 address step if UseGatewayAsRelayServerIpv4Addr is true.

Type: ip

Default: 0.0.0.1

RemoteId

Remote ID.

Type: string

Default: remoteId_@p-@b-@s

Range: 1 - 128 characters

RetryAttempts

Number of times to retry the session after the initial failure (each retry will use a new transaction ID).

Type: u32

Default: 4

Range: 1 - 4294967295

UseClientMacAddrForDataplane

Use the client's MAC address for traffic.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable use of the client's MAC address for traffic.

FALSE

Disable use of the client's MAC address for traffic (uses the Relay Agent's MAC instead).

UseGatewayAsRelayServerIpv4Addr

Use the gateway address as the relay agent server IPv4 address.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Use the gateway address as the relay agent server IPv4 address.

FALSE

Use the RelayServerIpv4Addr address field for the server IPv4 address.

VPNId

Use wildcard characters to make each VPN ID unique:

@s - Session index associated with the DHCP client.

@b - Block (host/router) index.

@p - Port name.

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

The EnableRelayVPNID attribute must be set to TRUE for this to take effect.

Type: string

Default: spirent_@p

Range: 1 - 128 characters

VPNType

Type of VPN-ID.

The EnableRelayVPNID attribute must be set to TRUE for this to take effect.

Type: enum

Default: NVT_ASCII

Possible Values:

Value Description
NVT_ASCII

Network Virtual Terminal (NVT) ASCII VPN identifier.

RFC_2685

RFC 2685 VPN-ID.

Dhcpv4DeviceGenProtocolParams Read-Only Attributes

There are no read-only attributes.