dhcp
AddressPool

An IP address pool instance on the local DHCP server.



public class AddressPool

Stats:
dhcp.LocalDhcpServerPoolStats

Properties
creationOrigin

type=svt.L2RouteOriginType
access=read-create
default=manual

dhcp.AddressPoolCustomOption-Set type=Children-Set
dhcp.AddressPoolDeclinedAddressData-Set type=Children-Set
dhcp.AddressPoolFreeAddressData-Set type=Children-Set
dhcp.LocalDhcpPFoPeer-Set type=Children-Set
dhcp.LocalDhcpPoolFailover-Set type=Children-Set
dhcp.Subnet-Set type=Children-Set
maxLeaseDay The day portion of maximum lease time.

type=int
default=10
minimum=0
maximum=3650
Displayed(tab/group)=Days (/Maximum Lease Time)

maxLeaseHour The hour portion of maximum lease time.

type=int
default=0
minimum=0
maximum=23
Displayed(tab/group)=Hours (/Maximum Lease Time)

maxLeaseMinute The minute portion of maximum lease time.

type=int
default=0
minimum=0
maximum=59
Displayed(tab/group)=Minutes (/Maximum Lease Time)

maxLeaseSecond The second portion of maximum lease time.

type=int
default=0
minimum=0
maximum=59
Displayed(tab/group)=Seconds (/Maximum Lease Time)

maxLeaseTime The maximum lease time in seconds. Minimum is 10 seconds, maximum is 10 years. Default to 10 days. It must be larger than or equal to minLeaseTime. If the maxLeaseTime is set and either or all of the maxLeaseSecond, maxLeaseMinute, maxLeaseHour, maxLeaseDay are set as well, the maxLeaseTime takes the precedence.

type=long
default=864000
minimum=10
maximum=315446399

minLeaseDay The day portion of minimum lease time.

type=int
default=0
minimum=0
maximum=3650
Displayed(tab/group)=Days (/Minimum Lease Time)

minLeaseHour The hour portion of minimum lease time.

type=int
default=0
minimum=0
maximum=23
Displayed(tab/group)=Hours (/Minimum Lease Time)

minLeaseMinute The minute portion of minimum lease time.

type=int
default=10
minimum=0
maximum=59
Displayed(tab/group)=Minutes (/Minimum Lease Time)

minLeaseSecond The second portion of minimum lease time.

type=int
default=0
minimum=0
maximum=59
Displayed(tab/group)=Seconds (/Minimum Lease Time)

minLeaseTime The minimum lease time in seconds. Minimum is 10 seconds, maximum is 10 years. Default to 10 minutes. It must be smaller than or equal to maxLeaseTime. If the minLeaseTime is set and either or all of the minLeaseSecond, minLeaseMinute, minLeaseHour, minLeaseDay are set as well, the minLeaseTime takes the precedence.

type=long
default=600
minimum=10
maximum=315446399

nakNonMatch Specifies if this DHCP server sends a DHCPNAK when it receives a DHCPREQUEST message for a subnet that does not match any of the ranges associated with this pool. If the value of nakNonMatch is equal to 'false', this DHCP server drops such a DHCPREQUEST message.

type=boolean
default=false
Displayed(tab/group)=NAK Non Matching Subnet

offerMinute The minute portion of DHCP offer time.

type=int
default=1
minimum=0
maximum=10
Displayed(tab/group)=Minutes (/Offer Time)

offerSecond The second portion of DHCP offer time.

type=int
default=0
minimum=0
maximum=59
Displayed(tab/group)=Seconds (/Offer Time)

offerTime The time interval during which a DHCP offer is valid. The offer time is in seconds. If the offerTime is set and either or all of the offerSecond, offerMinute are set as well, the offerTime takes the precedence.

type=int
default=60
minimum=10
maximum=600

poolDepletedEvent This value specifies whether a notification is generated when this pool is depleted.

type=boolean
default=false
Displayed(tab/group)=Notify When Pool Is Depleted (/Pool Notifications (Minimum Free))

poolMinFree This value specifies the desired minimum number of free addresses in the pool. If the actual number of free addresses in the pool falls below this configured minimum, alarm is generated. The value 0 specifies "No minimum".

type=int
default=1
minimum=0
maximum=255
Displayed(tab/group)=Threshold Value (/Pool Notifications (Minimum Free))

poolMinFreeType This value specifies whether Pool Minimum Free is expressed as an absolute number or as a percentage. When the value is set to percentage, the accepted range for Pool Minimum Free is limited between 0 and 100.

type=dhcp.DhcpSvrMinFreeType
default=absolute
Displayed(tab/group)=Threshold Type (/Pool Notifications (Minimum Free))

subnetBindDelay Specifies the number of seconds before unbinding the subnet from the access node, after the last lease in this subnet has been released.

DEPRECATED: 12.0 R1 - It is only supported in SR nodes from 11.0R4 to 11.0R6. This feature has been disabled for 11.0R7+ SR nodes.
type=long
default=300
minimum=1
maximum=86400

subnetBindKey Specifies the key to be used for subnet binding. The default value 'none' (0) disables the subnet binding.

DEPRECATED: 12.0 R1 - It is only supported in SR nodes from 11.0R4 to 11.0R6. This feature has been disabled for 11.0R7+ SR nodes.
type=dhcp.SubnetBindKeyType
default=none
Displayed(tab/group)=Key (/Subnet Binding)

  
Properties inherited from dhcp.AbstractAddressPool
description, displayedName, localDhcpServerName, localDhcpServerPointer, nodeId, routerId, stickyLseActActionTime, stickyLseActErrorMsg, stickyLseActResultCode, templateVersionPointer
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

resyncDeclinedAddresses

This method gets the declined address entries from the network.
Input Parameters:
aInRtrId : string - The system address of a network equipment.
aInVirtualRtrId : long - The virtual router ID in the network or virtual router ID in the service.
aInLocalDhcpServerName : string - A local DHCP Server name.
aInAddressPoolName : string - The IP address pool name.
aInDhcpSvrSubnetAddress : string - (Optional) The value of aInDhcpSvrSubnetAddress specifies a subnet.
aInDhcpSvrSubnetPrefixLength : long - (Optional) The value of aInDhcpSvrSubnetPrefixLength specifies the length of aInDhcpSvrSubnetAddress
aInDhcpSvrFreeAddress : string - (Optional) The value of aInDhcpSvrFreeAddress specifies the free IP address.
timeout : long - The number of milliseconds to wait before receiving the results. If no results are received in the given time, the method returns.
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : List (generic.CommonManagedEntityInformation) - The number of declined addresses.

resyncFreeAddresses

This method gets the free address entries from the network.
Input Parameters:
aInRtrId : string - The system address of a network equipment.
aInVirtualRtrId : long - The virtual router ID in the network or virtual router ID in the service.
aInLocalDhcpServerName : string - A local DHCP server name.
aInAddressPoolName : string - The IP address pool name.
aInDhcpSvrSubnetAddress : string - (Optional) The value of aInDhcpSvrSubnetAddress specifies a subnet.
aInDhcpSvrSubnetPrefixLength : long - (Optional) The value of aInDhcpSvrSubnetPrefixLength specifies the length of aInDhcpSvrSubnetAddress
aInDhcpSvrFreeAddress : string - (Optional) The value of aInDhcpSvrFreeAddress specifies the free IP address.
timeout : long - The number of milliseconds to wait before receiving the results. If no results are received in the given time, the method returns.
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : List (generic.CommonManagedEntityInformation) - The number of free addresses.
Methods inherited from dhcp.AbstractAddressPool
dhcpStickyLeaseAction
 
Supported Network Elements
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7450 ESS Supported for all versions
  • Excluded chassis types: 7450-ESS1
7705 SAR H
7705 SAR
7210 SAS K Supported from 9.0.R3
  • Required Capabilities: NetworkMode
7250 IXR Supported from 13.1.R8
Product Specifics
7210 SAS K 20.0
7210 SAS K 21.0
7210 SAS K 22.0
7210 SAS K 23.0
7210 SAS K 24.0
7210 SAS K 25.0
7250 IXR 20.0
7250 IXR 21.0
7250 IXR 22.0
7250 IXR 23.0
7250 IXR 24.0
7250 IXR 25.0
7450 ESS 20.0
7450 ESS 21.0
7450 ESS 22.0
7450 ESS 23.0
7450 ESS 24.0
7450 ESS 25.0
7705 SAR Gen 2 25.0
7705 SAR H 20.0
7705 SAR H 21.0
7705 SAR H 22.0
7705 SAR H 23.0
7705 SAR H 24.0
7705 SAR H 25.0
7705 SAR H 9.0
7705 SAR Hm 20.0
7705 SAR Hm 21.0
7705 SAR Hm 22.0
7705 SAR Hm 23.0
7705 SAR Hm 24.0
7705 SAR Hm 25.0
7705 SAR 20.0
7705 SAR 21.0
7705 SAR 22.0
7705 SAR 23.0
7705 SAR 24.0
7705 SAR 25.0
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0