Overview Package Class Deprecated Help

nge
RekeyProgress

This class holds the rekey progress info during a rekey process

public class RekeyProgress

Properties
hasCellDomainSite Indicates rekey sites has cellular domain site.

type=boolean
access=read-only
default=false
keyGroupId

type=int
access=read-create
Mandatory on create
Displayed(tab/group)=Key Group ID
nge.RekeyPendingSite-Set type=Children-Set
ngeRekeySubState Indicates rekey state of this key group.

type=nge.NgeRekeySubState
access=read-only
Displayed(tab/group)=Rekey State
numRemainingOfflineSites The number of offline sites that were encountered during the rekey process.

type=int
access=read-only
default=0
Displayed(tab/group)=Number of Sites Pending Rekey
numRemainingRekeySites The Remaining ReKey Sites for the current executed scheduled task.

type=int
access=read-only
default=0
Displayed(tab/group)=Number of Remaining Sites for New Key Deployment
numTotalRekeySites The Total ReKey Sites for the current executed scheduled task.

type=int
access=read-only
default=0
Displayed(tab/group)=Total Number of Rekey Sites
refreshTime The time when the rekey progress info was refreshed.

type=Date
access=read-only
default=0
Displayed(tab/group)=Last Updated at
rekeyType

type=int
access=read-only
default=nomal
Displayed(tab/group)=Rekey Type
enums=
    1: nomal - Normal Rekey
    2: force - Force Rekey
    3: progressive - Progressive Rekey
remainingWaitTime

type=long
access=read-only
default=0
Displayed(tab/group)=Remaining Inter-Nodal Wait Time for New Key Deployment
startTime The time when the rekey progress started.

type=Date
access=read-create
default=0
Displayed(tab/group)=Rekey Start Time
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

forceRekey

This method stop waiting for the offline sites during the progressive rekey and continue the rekey process with force rekey instead
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.
keyGroupId : int -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

refreshInfo

This method updates the rekey progress info
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.
keyGroupId : int -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

stopRekey

This method stop and fail the rekey during the progressive rekey
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.
keyGroupId : int -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false