Overview Package Class Deprecated Help

dhcp
LocalDhcpServer

A Local DHCP server instance running within a routing instance or VPRN site.

public class LocalDhcpServer

Stats:
dhcp.LocalDhcpServerStats

Properties
allowSendForceRenews The value specifies whether the server is allowed to send a DHCP FORCERENEW message to DHCP clients. If it is set to true, then the server will send a DHCP FORCERENEW message to the client when its configuration changes in such a way that the clients need to renew their lease in order to obtain the new parameters. This will be the case when, for example, an option is added to a subnet.

type=boolean
default=false
Displayed(tab/group)=Allow Send Force Renews
clear.ClearRequest-Set type=Children-Set
creationOrigin

type=svt.L2RouteOriginType
access=read-create
default=manual
dhcp.AddressPool-Set type=Children-Set
dhcp.HostConflictLog-Set type=Children-Set
dhcp.LeaseNotOwnerLog-Set type=Children-Set
dhcp.LocalDhcpSFoPeer-Set type=Children-Set
dhcp.LocalDhcpServerFailover-Set type=Children-Set
dhcp.LocalDhcpServerLeaseData-Set type=Children-Set
dhcp.PoolUnknownLog-Set type=Children-Set
dhcp.StickyLease-Set type=Children-Set
dhcp.StickyLeaseData-Set type=Children-Set
useGiAddress Specifies whether GI address matching is enabled. If it is set to true, then an IP address will be provided based on the Gateway IP address from the DHCP message, even when authentication fails or when there is no local user database configured in userDatabasePointer.

type=boolean
default=false
Displayed(tab/group)=Use Gateway Interface (GI) Address
useGiScope Specifies whether the GI address selects a single subnet or a pool. The value of this attribute is only meaningful when the value of UseGiAddress is set to true

type=dhcp.GiAddressScopeType
default=subnet
Displayed(tab/group)=Gateway Interface (GI) Address Scope
userDatabaseName The local user database to use for authentication.

type=string
default=
Displayed(tab/group)=Database Name (/Local User Database)
userDatabasePointer A pointer to a local user database for authentication.

DEPRECATED: 11.0.R1 - Use userDatabaseName instead
type=Pointer
default=
userIdent Specifies which method is used by the local DHCP server to uniquely identify a user.

type=dhcp.DhcpUserIdentMethod
default=macCircuitId
Displayed(tab/group)=User Identification Method
  
Properties inherited from dhcp.AbstractDhcpServer
administrativeState, createOrigin, description, displayedName, leaseHoldTimeDay, leaseHoldTimeFor, leaseHoldTimeHour, leaseHoldTimeMinute, leaseHoldTimeSecond, nodeId, operationalState, poolNameDelimiter, routerId, serviceId, templateVersionPointer, usePoolFromClient
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

clearDhcpServerLeases

Request clearing one or all leases of a given Local DHCP Server on Service ID . The siteId dhcpSvrName is mandatory. If serviceId is not given, the method will use the base routing instance. ipAddress and prefix are optional. If not specified, all leases will be cleared, otherwise lease on given ipAddress and prefix will be cleared. Clear result will be displayed on Clear Status tab on given Local DHCP Server.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
clearLeaseInfo : dhcp.ClearDhcpLeaseStruct - clearLeasesInfo contains all input parameters required for clearing Local DHCP Server lease
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:
aOutResult : clear.RequestHandleStruct - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.
Exceptions:
dhcp.LocalDhcpServer.clearDhcpServerLeasesException

clearDhcpServerStickyLeases

Request clearing sticky leases of a given Local DHCP Server on Service ID. The siteId dhcpSvrName is mandatory. If serviceId is not specified, it will be Base routing instance as default. If hostName is specified, lease for the given hostName will be cleared. If hostName-Prefix is specified, leases for the given hosts starting with the specified prefix will be cleared. hostName and hostName-Prefix are mutually exclusive. If both parameters are specified only hostName will be used to clear the sticky lease.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
clearStickyLeaseInfo : dhcp.ClearDhcpStickyLeasesStruct - clearStickyLeaseInfo contains all input parameters required for clearing Local DHCP Server Sticky lease
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:
aOutResult : clear.RequestHandleStruct - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.
Exceptions:
dhcp.LocalDhcpServer.clearDhcpServerStickyLeasesException

resyncLeases

This method gets the free address entries from the network.
Input Parameters:
aInRtrId : string - The system address of a network equipment.
aInVirtualRtrId : long -
aInLocalDhcpServerName : string -
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 leases.
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 Supported from 6.1.R1
7210 SAS K Supported from 9.0.R3
  • Required Capabilities: NetworkMode
7250 IXR Supported from 13.1.R8
Product Specifics
7705 SAR H (all versions)
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 (all versions)
7705 SAR 20.0
7705 SAR 21.0
7705 SAR 22.0
7705 SAR 23.0
7705 SAR 24.0
7705 SAR 25.0