Dhcpv4ServerPoolConfig Object

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

Description:

DHCP server pool config for relay agent pools.

Parents: Dhcpv4ServerConfig, EmulatedDevice, ExternalDevice, ExternalDevicePort, Host, IptvChannelBlock, Port, Router, SUT

Children: Dhcpv4ServerMsgOption, GroupIf, SrEvpnSiteInfo, SrL3VpnSiteInfo

Relations:

Side name
(Type)		 Relative Description
DstBoundTo
(DstBinding)

PathDescriptor, StreamBlock

Specifies destination endpoints bound to StreamBlock.
EncapsulationSource
(Encapsulation)

PathDescriptor

Specifies the encapsulation.
MemberOfVpn
(MemberOfVpn)

EthernetVpnSiteInfo, VpnIdGroup, VpnSiteInfo6Pe, VpnSiteInfoMplsTpStatic, VpnSiteInfoRfc2547, VpnSiteInfoRfc4659, VpnSiteInfoVplsBgp, VpnSiteInfoVplsLdp

Do not use, to be removed
MulticastExpectedRxPorts
(MulticastExpectedRxPorts)

Port

Traffic sent to this end point is expected to be received as multicast traffic by any of the ports connected through this relation.
OptionallyStackedUnder
(OptionallyStackedOnEndpoint)

Aal5If, Dhcpv4ServerDefaultPoolConfig, Dhcpv4ServerPoolConfig, Dhcpv6ServerAddrPoolConfig, Dhcpv6ServerDefaultAddrPoolConfig, Dhcpv6ServerDefaultPrefixPoolConfig, Dhcpv6ServerPrefixPoolConfig, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv4NetworkBlock, Ipv4VpnMcastNetworkBlock, Ipv6If, Ipv6NetworkBlock, Ipv6SrhIf, Ipv6VpnMcastNetworkBlock, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacBlock, MacsecIf, MplsIf, Pimv4JoinSrc, Pimv4PruneSrc, Pimv6JoinSrc, Pimv6PruneSrc, PppIf, PppoeIf, PppoeServerIpv4PeerPool, PppoxServerIpv4PeerPool, PppoxServerIpv6PeerPool, TrillIf, VbrasIf, VlanBlock, VlanIf, VxlanGpeIf, VxlanIf

Specifies an optionally-selected lower interface in the stack. Selection is controlled by protocol implementations which decide based on other criteria whether they should include the target interface in their stack.
SrcBoundTo
(SrcBinding)

PathDescriptor, StreamBlock

Specifies the source endpoint bound to StreamBlock.
StackedOn
(StackedOnEndpoint)

Aal5If, Dhcpv4ServerDefaultPoolConfig, Dhcpv4ServerPoolConfig, Dhcpv6ServerAddrPoolConfig, Dhcpv6ServerDefaultAddrPoolConfig, Dhcpv6ServerDefaultPrefixPoolConfig, Dhcpv6ServerPrefixPoolConfig, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv4NetworkBlock, Ipv4VpnMcastNetworkBlock, Ipv6If, Ipv6NetworkBlock, Ipv6SrhIf, Ipv6VpnMcastNetworkBlock, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacBlock, MacsecIf, MplsIf, Pimv4JoinSrc, Pimv4PruneSrc, Pimv6JoinSrc, Pimv6PruneSrc, PppIf, PppoeIf, PppoeServerIpv4PeerPool, PppoxServerIpv4PeerPool, PppoxServerIpv6PeerPool, TrillIf, VbrasIf, VlanBlock, VlanIf, VxlanGpeIf, VxlanIf

Specifies network endpoint stacking.
UnicastExpectedRxPorts
(UnicastExpectedRxPorts)

Port

Traffic sent to this end point is expected to be received as unicast traffic by any of the ports connected through this relation.
VpnTag
(VpnTag)

VpnTag

Dhcpv4ServerPoolConfig Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
AddrIncrement

Pool address network increment.

Type: u32

Default: 1
AddrIncrementPerRouter

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Per router increment.

Type: u32

Default: 0
AddrModifierTypePerDevice

Address Modifier Type per Device in Device Block.

Type: enum

Default: CONTINUOUS

Possible Values:

Value Description
CONTINUOUS

Continuous.
REPEAT

Repeat.
CircuitId

Generate a list of circuit ID so that this pool can assign addresses for those DHCP clients who match any of the circuit ID in the list.

The CIRCUIT_ID flag of AssignStrategy attribute must be set for this attribute to take effect.

Type: string

Default: circuitId_@p

Range: 1 - 128 characters
CircuitIdCount

Maximum circuit ID count that can be generated. Say CircuitId attribute is a wildcard value, and that wildcard can be expanded to X unique value, then Min(X, CircuitIdCount) circuit ID can be generated.

The CIRCUIT_ID flag of AssignStrategy attribute must be set for this attribute to take effect.

Type: u32

Default: 1
DomainName

Domain name (option 15).

Type: string

Default: "" (empty string)

DomainNameServerList

Domain name servers (option 6).

Type: ip

Default: 0
HostAddrCount

Number of addresses in a pool.

Type: u32

Default: 254
HostAddrStep

Pool host address step.

Type: ip

Default: 0.0.0.1
LimitHostAddrCount

Limit host address count.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Use the host address count to limit pool size.
FALSE

Host address count will automatically be calculated.
NetworkCount

Pool prefix length.

Type: u32

Default: 1
NetworkInterfaceWithIpList

Create Network Interface for Network Block IP List.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Create Network Interface for Network Block IP List.
FALSE

Don't create Network Interface for Network Block IP List.
PrefixLength

Pool prefix length.

Type: u8

Default: 24

Range: 0 - 32
RemoteId

Generate a list of remote ID so that this pool can assign addresses for those DHCP clients who match any of the remote ID in the list.

The REMOTE_ID flag of AssignStrategy attribute must be set for this attribute to take effect.

Type: string

Default: remoteId_@p-@b-@s

Range: 1 - 128 characters
RemoteIdCount

Maximum remote ID count that can be generated. Say RemoteId attribute is a wildcard value, and that wildcard can be expanded to X unique value, then Min(X, RemoteIdCount) remote ID can be generated.

The REMOTE_ID flag of AssignStrategy attribute must be set for this attribute to take effect.

Type: u32

Default: 1

Range: 1 - 20
RouterList

Router addresses (option 3).

Type: ip

Default: 0
ServerID

Server ID

Type: ip

Default: 192.85.1.1
ServerIDStep

Server ID Step

Type: ip

Default: 0.0.1.0
ServerIDType

Server ID Type

Type: enum

Default: DEVICE_ADDRESS

Possible Values:

Value Description
DEVICE_ADDRESS

Server ID Type is device address
ROUTER_ID

Server ID Type is router id
USER_DEFINE

Server ID Type is user define
StartIpList

Pool starting IP address.

Type: ip

Default: 192.0.1.0
UseUniqueIpForOverlappingPrefixes

Use Unique IP for Overlapping Prefixes

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable Use Unique IP for Overlapping Prefixes option

FALSE

Disable Use Unique IP for Overlapping Prefixes option

VPNId

Generate a list of VPN ID so that this pool can assign addresses for those DHCP clients who match any of the VPN ID in the list.

The VPN_ID flag of AssignStrategy attribute must be set for this attribute to take effect.

Type: string

Default: spirent_@p

Range: 1 - 128 characters
VPNIdCount

Maximum VPN ID count that can be generated. Say VPNId attribute is a wildcard value, and that wildcard can be expanded to X unique value, then Min(X, RemoteIdCount) VPN ID can be generated.

The VPN_ID flag of AssignStrategy attribute must be set for this attribute to take effect.

Type: u32

Default: 1
VPNType

Type of VPN-ID.

The VPN_ID flag of AssignStrategy attribute must be set for this attribute 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.

Dhcpv4ServerPoolConfig Read-Only Attributes

There are no read-only attributes.