Overview Package Class Deprecated Help

dhcp
AbstractAddressPool

Base class for an IP address pool instance on the local DHCP server (v4 or v6).

public abstract class AbstractAddressPool

Properties
description A user provided description for this IP address pool.

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Description
displayedName The name of this IP address pool instance.

type=string
access=read-create
default=
minimum=1
maximum=32
Mandatory on create
Displayed(tab/group)=Pool Name
localDhcpServerName The local DHCP server name.

type=string
access=read-only
default=
localDhcpServerPointer A pointer points to a local DHCP server.

type=Pointer
access=read-only
Displayed(tab/group)=Local DHCP Server
nodeId The system address of a network equipment.

type=string
access=read-only
default=0.0.0.0
maximum=64
routerId The routerId matches the vRtrId in the MIB. The routerId can either be virtual router ID in the network or virtual router ID in the service.

type=long
default=1
minimum=1
maximum=10240
stickyLseActActionTime The value of stickyLseActActionTime indicates the value of sysUpTime at the last time that the object stickyLseActResultCode was written by the system

type=long
access=read-only
stickyLseActErrorMsg The value of stickyLseActErrorMsg indicates the reason of failure, in case the value of the object stickyLseActResultCode is not 'success(0)'.

type=string
access=read-only
stickyLseActResultCode The value of stickyLseActResultCode indicates the result of the last performed action.

type=dhcp.StickyLseActResultCode
access=read-only
templateVersionPointer Pointer to the template if this object was created from a template.

type=Pointer
default=
Displayed(tab/group)=Associated Template (Template/Associated Template)
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

dhcpStickyLeaseAction

dhcpStickyLeaseAction allows to request an action to be performed upon a Sticky Lease instance. To create a Sticky Lease instance, write the name of the entry to be created in aInHostName, and set the required action in the object aInStickyLseActActionType. NOTE: This method is only supported on Local DHCP v4 Server and Address Pool.
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.
aInSiteId : string - Specifies the NE system address on which the Sticky Lease action is to be performed.
aInRoutingInstance : string - Specifies the routing instance ID used for the creation of Sticky Lease query. For example, 'Base' for base router and 'vprn-x' for VPRN service ID, where 'x' is a VPRN service ID. This is a mandatory input parameter.
aInLocalDhcpServerName : string - Specifies the name of the local DHCP server instance.
aInAddressPoolName : string - Specifies the name of IP address pool within the local DHCP server instance.
aInHostName : string - Specifies the name of the host
aInMacAddress : string - (Optional) Specifies the MAC address for this host.
aInCircuitId : string - (Optional) Specifies the circuit ID for this host.
aInClientId : string - (Optional) Specifies the client ID for this host.
aInStickyLseAddressType : rtr.InetAddressType - Specifies the address type of DHCP Sticky Lease Address.
aInStickyLseAddress : string - (Optional) Specifies the request IP address for this Sticky Lease. If aInStickyLeaseAddress is not specified in the SNMP SET PDU, the system selects an IP address. The value of this object will be that selected IP address on the SNMP read operation.
aInTimeout : long - (Optional) The number of milliseconds to wait before receiving the results. If no results are received in the given time, the method returns. This is an optional input parameter. The default value is 5 minutes (300000).
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
Response : string -
Exceptions:
dhcp.AbstractAddressPool.dhcpStickyLeaseActionException