Dhcpv4ServerConfig Object

HOME | TECHNOLOGIES | TEST CONFIGURATION | SEQUENCER COMMANDS | GUI COMMAND NAMES | ALL COMMANDS | RESULT | PDU | ALL | OBJECT TREE

Description:

DHCPv4 server configuration settings.

Parents: Dhcpv4ServerPoolConfig, EmulatedDevice

Children: Dhcpv4ServerMsgOption

Automatically created from: Dhcpv4ServerDefaultPoolConfig

Result children (automatically created): Dhcpv4ServerResults, Dhcpv4ServerSessionResults

Relations:

Side name
(Type)		 Relative Description
ViewControlPlaneMplsBindingResult
(ControlPlaneBindingResult)

ViewControlPlaneMplsBindingResult

Mpls control plane binding result.
ConvergenceConfig
(PrimaryPathProtocolConfig)

ConvergenceConfig, ConvergenceConfig

Primary Path Protocol Config Relation.
ResultChild
(ResultChild)

Dhcpv4ServerResults

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

Dhcpv4ServerConfig Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
AssignStrategy

The strategy that server choose address pools which are used for assign address.

Type: enum

Default: GATEWAY

Possible Values:

Value Description
GATEWAY

If Client IP address is not 0 in DHCP message, assign address from those pools who has the same network as Client IP address.

Else if Relay Agent IP address is not 0 in DHCP message, assign address from those pools who has the same network as Relay Agent IP address.

Else if EnablePoolAddrPrefix is true, assign address from the default address pool.

Else assign address from those pools who has the same network as DHCP server IP.
CIRCUIT_ID

Assign address from those pools who match the relay agent circuit ID option received.
REMOTE_ID

Assign address from those pools who match the relay agent remote ID option received.
LINK_SELECTION

Assign address from those pools who match the relay agent link selection option received.
VPN_ID

Assign address from those pools who match the relay agent virtual subnet selection option received.
POOL_BY_POOL

Assign address from default pool, and then from the first relay agent pool if any when the default pool is exhausted and so on.
AuthToken

Token configured for authentication.

Type: string

Default: spirent123

Range: 1 - 128 characters
AuthType

DHCP authentication type.

Type: enum

Default: NONE

Possible Values:

Value Description
NONE

No authentication.

FORCE_RENEW_TOKEN

Token authentication for forcerenew message.

DELAYED_AUTHENTICATION

Delayed Authentication
DeclineReserveTime

Time in seconds an address will be reserved after it is declined by the client.

Type: u32

Default: 10
EnableOverlapAddress

Reuse addresses based on circuit ID. For example: say we configured 1 pool with 100 addresses and 5 different circuit ID, server can assign 100 addresses for each circuit ID. It is like we have 500 addresses.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Reuse addresses based on circuit ID.
FALSE

Do not reuse addresses based on circuit ID.
ForceRenewXidMode

Transaction-ID for Force-Renew

Type: enum

Default: RESET

Possible Values:

Value Description
RESET

Reset to zero.
REUSE

Use the existing Transaction-ID.
HostName

Server host name.

Type: string

Default: server_@p-@b-@s

Range: 1 - 32 characters
Ipv4Tos

Provides an indication of the quality of service wanted.

Type: u8

Default: 192
LeaseTime

Default lease time in seconds.

Type: u32

Default: 3600
MinAllowedLeaseTime

Minimum allowed lease time in seconds.

Type: u32

Default: 600
OfferReserveTime

Time in seconds an address will be reserved while the server is waiting for a response for an offer.

Type: u32

Default: 10
RebindingTimePercent

(T2) Percent of the lease time at which the client should begin the rebinding process.

Type: double

Default: 87.5

Range: 0.0 - 200.0
RenewalTimePercent

(T1) Percent of the lease time at which the client should begin the renewal process.

Type: double

Default: 50.0

Range: 0.0 - 200.0
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
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.

Dhcpv4ServerConfig Read-Only Attributes

Read-Only Attribute Description
ServerState

Current state of the DHCPv4 server.

Type: enum

Default: NONE

Possible Values:

Value Description
NONE

Servers not started.
UP

Servers are up.