Dhcpv4BlockConfig Object

Description:

DHCPv4 block configuration settings.

Writable Attributes
Read-Only Attributes

Parents: EmulatedDevice

Children: Dhcpv4MsgOption

Result children (automatically created): Dhcpv4BlockResults, Dhcpv4SessionResults

Relations:

Side name (Type)	Relative	Description
ArpProxyIf (ArpProxyIf)	Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, PppIf, PppoeIf, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf	Relation to an extra layer 3 interface to be used to response ARP when the DHCPv4 block operates in relay agent mode.
ViewControlPlaneMplsBindingResult (ControlPlaneBindingResult)	ViewControlPlaneMplsBindingResult	Mpls control plane binding result.
ConvergenceConfig (PrimaryPathProtocolConfig)	ConvergenceConfig, ConvergenceConfig	Primary Path Protocol Config Relation.
RelayAgentIf (RelayIf)	Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, PppIf, PppoeIf, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf	Relation to an extra layer 3 interface to be used when the DHCPv4 block operates in relay agent mode.
ResultChild (ResultChild)	Dhcpv4BlockResults	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).

Dhcpv4BlockConfig Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

CircuitId

Specify the Circuit ID field in the message sent by the relay agent. Use wildcard characters to make each circuit 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 EnableCircuitId attribute must be set to TRUE for this attribute to take effect.

Type: string

Default: circuitId_@p

Range: 1 - 128 characters

ClientHwType

Client hardware type in option 61 (Client identifier).

Type: enum

Default: ETHERNET

Possible Values:

Value	Description
STRING	The client hardware address is a string.
ETHERNET	The client hardware address is an Ethernet MAC address.
FIBRECHANNEL	The client hardware address is a 64 bits Fibre Channel address.
CUSTOM	User can customize the hardware address type and value.

ClientRelayAgent

Not exposed in the GUI.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable Client Relay agent.
FALSE	Disable Client Relay agent.

CustomHwAddr

The hardware address in option 61 (Client identifier).

Type: string

Default: "" (empty string)

CustomHwType

The customized hardware type in option 61 (Client identifier).

Type: u8

Default: 255

DefaultHostAddrPrefixLength

Default prefix length for the host address.

Type: u8

Default: 24

Range: 0 - 32

DNAv4DestIp

DNAv4 destination IP address.

Type: ip

Default: 192.85.1.1

DNAv4DestMac

DNAv4 destination MAC address.

Type: mac

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

EnableArpServerId

Enable or disable ARP on the Server ID.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable ARP on the Server ID.
FALSE	Disable ARP on the Server ID.

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 the circuit ID sub-option in the DHCP messages that are sent from the emulated relay agent. The circuit ID sub-option is described in RFC 3046.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Include the circuit ID sub-option.
FALSE	Do not include the circuit ID sub-option.

EnableForcedRediscover

Enable Forced Rediscover

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable Forced Rediscover
FALSE	Disable Forced Rediscover

EnableGarp

Enable/Disable Garp function.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable Garp function.
FALSE	Disable Garp function.

EnableRelayAgent

Enables or disables the relay agent option specified in RFC 3046.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Send all client bind requests as if they were passing through a relay agent.
FALSE	Do not use 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 the remote ID sub-option in the DHCP messages that are sent from the emulated relay agent. The remote ID sub-option is described in RFC 3046.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Include the remote ID sub-option.
FALSE	Do not include the remote ID sub-option.

EnableRequestedIpAddressOption

Enable Requested IP Address Option

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable Requested IP Address Option
FALSE	Disable Requested IP Address Option

EnableRouterOption

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

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable router option.
FALSE	Disable router option.

EnableSessionAutoRetry

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.

EnableVendorClassIdentifierOption

Enable Option 60 (Vendor Class Identifier) in both Discover and Request message.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Include Option 60 (Vendor Class Identifier) in both Discover and Request message.
FALSE	Exclude Option 60 (Vendor Class Identifier) in both Discover and Request message.

FibreChannelAddr

Fibre channel address in option 61 (Client identifier).

Type: wwn

Default: 20:00:10:94:00:00:00:01

FibreChannelAddrStep

Fibre channel address step in option 61 (Client identifier).

Type: wwn

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

GarpTimeout

Garp timeout value default is 1 second.

Type: u32

Default: 1

Range: 1 - 4294967295

GarpTransmits

Garp transmit times default is 1.

Type: u32

Default: 1

Range: 1 - 4294967295

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

Ipv4Tos

Provides an indication of the quality of service wanted.

Type: u8

Default: 192

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"

NOTE: The correct default for this attribute is 1 6 15 33 44.

Type: u8

Default: 1

RelayAgentIpv4Addr

Source IP address of the relay agent message, and the giaddr field in the DHCP message.

Type: ip

Default: 0.0.0.0

RelayAgentIpv4AddrMask

IP Mask to apply to the Relay Local IP address.

Type: ip

Default: 255.255.0.0

RelayAgentIpv4AddrStep

IP Step to be applied to the Relay Local IP address.

Type: ip

Default: 0.0.0.1

RelayClientMacAddrMask

MAC mask that will be applied to the Relay Client MAC address.

Type: mac

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

RelayClientMacAddrStart

Starting value for the MAC address.

Type: mac

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

RelayClientMacAddrStep

MAC step that will be applied to the Relay Client MAC address.

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

Number of Relay Agent networks.

Type: ip

Default: 0.0.0.0

RelayPoolIpv4AddrStep

Relay 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

Destination IP address for the relay agent message.

Type: ip

Default: 0.0.0.0

RelayServerIpv4AddrStep

IP Step to be applied to the Relay Server IP address.

Type: ip

Default: 0.0.0.1

RemoteId

Use wildcard characters to make each remote 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 EnableRemoteId attribute must be set to TRUE for this to take effect.

Type: string

Default: remoteId_@p-@b-@s

Range: 1 - 128 characters

RequestIp

Requested IP Address

Type: ip

Default: 192.85.1.1

RequestIpStep

Requested IP Address Step

Type: ip

Default: 0.0.0.1

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

SecretKey1

Authentication Secret Key 1

Type: string

Default: spirent001

Range: 1 - 256 characters

SecretKey2

Authentication Secret Key 2

Type: string

Default: spirent002

Range: 1 - 256 characters

StringAddr

A string as the client indentifier in option 61 (Client identifier).

Type: string

Default: client_@s

UseBroadcastFlag

Enable/disable broadcast bit in DHCP control plane packets.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Enable broadcast bit.
FALSE	Disable broadcast bit.

UseClientMacAddrForDataplane

Use client MAC address for the data plane.

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

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.

VendorClassIdentifier

Vendor Class Identifier in option 60.

Type: string

Default: "" (empty string)

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

Dhcpv4BlockConfig Read-Only Attributes

Read-Only Attribute

Description

BlockState

Aggregate status of the DHCP host block. If all hosts in the block are not in the same state, their aggregate state is determined based on rules of precedence. Idle and Bound are the only stable states. 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	Host block is not currently active (no commands have been issued). No DHCP sessions are active. This state is entered if the hosts were manually released.
REQUEST	At least one session associated with the host block is in the process of being established. The hosts are either sending an initial DHCPDISCOVER broadcast message to obtain a DHCP lease, or sending a DHCPREQUEST message requesting an IP address. The messages use 255.255.255.255 as the destination address and 0.0.0.0 as the source address. The remaining hosts may be in either the Bound state or the Idle state, but not the Releasing state.
RELEASE	At least one host in the host block no longer needs to use the IP address leased to it and is in the process of sending a DHCPRELEASE message to the DHCP server.
RENEW	At least one host in the block is in the process of renewing the lease by sending another DHCPREQUEST message. Other hosts can be in the Bound or Idle state. NOTE: The Renewing state only refers to leases that were manually renewed (using the Renew DHCP Host command). It does not refer to the automatic renewal that occurs when the T1 timer has expired.
REBIND	At least one session is rebinding as the lease has expired.
AUTORENEW	At least one session is in the process of being auto-renewed.
GROUPREQ	Intermediate state within the binding state.
REBOOT	At least one session is rebooting.
ROAM	At least one session is roaming.
DNAREQUEST	At least one session is DNAv4 requesting.
BOUND	The DHCPDISCOVER, DHCPOFFER, DHCPREQUEST, and DHCPACK messages between the DHCP host and server have resulted in retrieving an IP address for at least one host in the block. No other hosts are requesting or releasing IP addresses, but they may be automatically renewing expired leases.