| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| adminState |
The local DHCP server's failover administrative state.
type=netw.AdministrativeState default=tmnxOutOfService Displayed(tab/group)=Administrative State |
| forcePrtnrDwnActErrMsg |
Indicates the reason of failure, in case the value of the object actionSuccessful
is equal to 'false'.
type=string access=read-only default= minimum=0 maximum=255 Displayed(tab/group)=Action Error Message (/Force Partner Down Action) |
| forcePrtnrDwnActSuccessful |
Indicates whether the action was successful.
type=dhcp.DhcpSFoActionSuccessState access=read-only default=notApplicable Displayed(tab/group)=Action Status (/Force Partner Down Action) |
| forcePrtnrDwnActTime |
Indicates last time that the actionSuccessful was written by the system.
type=Date access=read-only default=0 Displayed(tab/group)=Last Action Success Time (/Force Partner Down Action) |
| ignoreMaxCLT |
Setting the value of this object to 'true' has the effect
that the DHCP server starts offering IP addresses from the partner's scope
immediately after this transition, without waiting for existing leases allocated by
the partner and not known by this system to time out.
type=boolean default=false Displayed(tab/group)=Ignore MCLT on Takeover (/Client Lead Time) |
| localDhcpServerName |
The local DHCP server name.
type=string access=read-only default= |
| maxCLTHours |
The local DHCP server's configured maximum client lead time hours.
type=int default=0 minimum=0 maximum=23 Displayed(tab/group)=Maximum Time Hours (/Client Lead Time) |
| maxCLTMins |
The local DHCP server's configured maximum client lead time minutes.
type=int default=10 minimum=0 maximum=59 Displayed(tab/group)=Minutes (/Client Lead Time) |
| maxCLTSecs |
The local DHCP server's configured maximum client lead time seconds.
type=int default=0 minimum=0 maximum=59 Displayed(tab/group)=Seconds (/Client Lead Time) |
| nodeId |
The system address of a network equipment.
type=string access=read-only default= maximum=64 |
| operMaxCLT |
The local DHCP server's actual maximum client lead time.
type=int access=read-only |
| operMaxCLTHours |
The local DHCP server's actual maximum client lead time hours.
type=int access=read-only minimum=0 maximum=23 Displayed(tab/group)=Operational Value Hours (/Client Lead Time) |
| operMaxCLTMins |
The local DHCP server's actual maximum client lead time minutes.
type=int access=read-only minimum=0 maximum=59 Displayed(tab/group)=Minutes (/Client Lead Time) |
| operMaxCLTSecs |
The local DHCP server's actual maximum client lead time seconds.
type=int access=read-only minimum=0 maximum=59 Displayed(tab/group)=Seconds (/Client Lead Time) |
| partnerDownDelayHours |
Specifies the minimum (hours) safe-time after the beginning of COMMUNICATIONS-INTERRUPTED
state. After the expiry of this time, the server enters the PARTNER-DOWN state.
type=int default=23 minimum=0 maximum=23 Displayed(tab/group)=Partner Down Delay Hours (/Partner Down Delay) |
| partnerDownDelayMins |
Specifies the minimum (minutes) safe-time after the beginning of COMMUNICATIONS-INTERRUPTED
state. After the expiry of this time, the server enters the PARTNER-DOWN state.
type=int default=59 minimum=0 maximum=59 Displayed(tab/group)=Minutes (/Partner Down Delay) |
| partnerDownDelaySecs |
Specifies the minimum (seconds) safe-time after the beginning of COMMUNICATIONS-INTERRUPTED
state. After the expiry of this time, the server enters the PARTNER-DOWN state.
type=int default=59 minimum=0 maximum=59 Displayed(tab/group)=Seconds (/Partner Down Delay) |
| routerId |
Specifies the virtual router instance ID.
type=int access=read-only default=1 minimum=1 maximum=10240 |
| startupWaitTimeMins |
The startup wait time in minutes. This is the time that one server attempts to contact
the partner server. During this time, the server is unresponsive to DHCP client requests.
type=int default=2 minimum=1 maximum=10 Displayed(tab/group)=Startup Wait Time Minutes (/Startup Wait Time) |
| startupWaitTimeSecs |
The startup wait time in seconds. This is the time that one server attempts to contact
the partner server. During this time, the server is unresponsive to DHCP client requests.
type=int default=0 minimum=0 maximum=59 Displayed(tab/group)=Seconds (/Startup Wait Time) |
| state |
Indicates operational state of failover for the Local DHCP Server.
type=dhcp.FailoverStateType access=read-only default=shutdown Displayed(tab/group)=Operational State |
| templateVersionPointer |
Pointer to the template if this object was created from a template.
type=Pointer default= Displayed(tab/group)=Associated Template (Template/Associated Template) |
| timeLeft |
Indicates the time left until expiry of one of the timers MCLT, startup wait time or
partner-down-delay.
type=int access=read-only |
| timeLeftHours |
Indicates the time left (hours) until expiry of one of the timers MCLT, startup wait time or
partner-down-delay.
type=int access=read-only minimum=0 maximum=23 Displayed(tab/group)=Time Left Until Expiry Hours (/Time Left Until Expiry) |
| timeLeftMins |
Indicates the time left (minutes) until expiry of one of the timers MCLT, startup wait time or
partner-down-delay.
type=int access=read-only minimum=0 maximum=59 Displayed(tab/group)=Minutes (/Time Left Until Expiry) |
| timeLeftSecs |
Indicates the time left (seconds) until expiry of one of the timers MCLT, startup wait time or
partner-down-delay.
type=int access=read-only minimum=0 maximum=59 Displayed(tab/group)=Seconds (/Time Left Until Expiry) |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| Methods |
|---|
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 force-partner-down action is to be performed.
aInRoutingInstanceName
: string - Specifies the routing instance name on which the force-partner-down action is to be performed,
for example, 'Base' for base router and 'vprn3' for VPRN service with id as 3.
aInDHCPServerName
: string - Specifies Local DHCP Server name on which the force-partner-down action is to be performed.
aInDHCPServerPoolName
: string - (Optional) Specifies Local DHCP Server Pool name on which the force-partner-down action is to be performed.
This is an optional input parameter. If pool name is not specified, the action would be on the server.
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
result
: string -
dhcp.AbstractDhcpServerFailover.forcePartnerDownException
- | Supported Network Elements | |
|---|---|
| 7750 SR |
Supported from 9.0.R1
|
| 7705 SAR Gen 2 | |
| 7450 ESS |
Supported from 9.0.R1
|
| 7705 SAR Hm | |
| Product Specifics | |
| 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 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 | |
| 7750 SR 20.0 | |
| 7750 SR 21.0 | |
| 7750 SR 22.0 | |
| 7750 SR 23.0 | |
| 7750 SR 24.0 | |
| 7750 SR 25.0 | |