Overview Package Class Deprecated Help

rollback
RollbackNEInfo

public class RollbackNEInfo

Properties
displayedName Specifies the displayed name of the network element.

type=string
access=read-only
default=
maximum=252
Displayed(tab/group)=Site Name
redundantRollbackSyncForce

type=int
default=none
enums=
    1: none - None
    2: rollbackSingle - Rollback Single
    3: rollbackAll - Rollback All
redundantSyncMode

type=boolean
default=false
Displayed(tab/group)=Redundant Rollback Synchronization (/Redundant Rollback Synchronization)
redundantSyncStatus

type=int
access=read-only
default=unknown
Displayed(tab/group)=Last Rollback File Sync Status (Rollback Status/Redundancy Sync)
enums=
    0: unknown - No Rollback Sync
    1: rollbackFail - Rollback Sync Failed
    2: rollbackInProgress - Rollback Sync In Progress
    3: rollbackSuccess - Rollback Sync Successful
rescueCompactFlashType

type=rollback.CompactFlashType
default=cf1
Displayed(tab/group)=Compact Flash (/Rescue File/CFLASH)
revertSchedulePtr The schedule, if any, that specifies when the upgrade task executes.

type=Pointer
access=read-only
default=
revertScheduledTaskPtr The schedule task, if any, that specifies the binding between the upgrade task and the schedule.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Scheduled Task - Checkpoint File Revert (Scheduled Task Status/Checkpoint File Revert)
rollback.RollbackFileInfo-Set type=Children-Set
rollback.SaveScheduledTaskResults-Set type=Children-Set
rollbackCflashRoot Specifies the location on the node file system, where the software image files shall be transferred.

type=string
default=
minimum=0
maximum=174
Displayed(tab/group)=File Path (/Checkpoint File Storage/CFLASH)
rollbackCompactFlashType

type=rollback.CompactFlashType
default=cf1
Displayed(tab/group)=Compact Flash (/Checkpoint File Storage/CFLASH)
rollbackFileDeleteResult

type=rollback.ResultEnum
access=read-only
Displayed(tab/group)=Last Checkpoint File Delete Result (Rollback Status/Checkpoint File Delete)
rollbackFtpPassword

type=string
minimum=0
maximum=30
Displayed(tab/group)=FTP User Password (/Checkpoint File Storage/Remote Location)
rollbackFtpPath

type=string
default=
minimum=0
maximum=120
Displayed(tab/group)=File Path (/Checkpoint File Storage/Remote Location)
rollbackFtpServerIP

type=InetAddress
Displayed(tab/group)=FTP Server IP (/Checkpoint File Storage/Remote Location)
rollbackFtpServerIPAddrType

type=rtr.InetAddressType
default=ipv4
rollbackFtpUser

type=string
minimum=0
maximum=30
Displayed(tab/group)=FTP User ID (/Checkpoint File Storage/Remote Location)
rollbackLoc

type=string
access=read-only
Displayed(tab/group)=Rollback Checkpoint Location
rollbackLocationtype

type=rollback.RollBackFileLocationType
default=cflash
Displayed(tab/group)=Rollback Location Type (/Checkpoint File Storage)
rollbackMaxLocalFiles

type=int
default=10
minimum=1
maximum=50
Displayed(tab/group)=Maximum # of Local Checkpoint Files (/Checkpoint File Storage)
rollbackMaxRemoteFiles

type=int
default=10
minimum=1
maximum=200
Displayed(tab/group)=Maximum # of Remote Checkpoint Files (/Checkpoint File Storage)
rollbackPolicyId Specifies the id of the rollback Policy assigned to this network element.

type=int
default=1
minimum=1
maximum=65535
Displayed(tab/group)=Policy Id
rollbackPolicyName Specifies the name of the Software Upgrade Policy assigned to this network element.

type=string
default=Default
minimum=0
maximum=80
Displayed(tab/group)=Policy Name
rollbackRescueCflashRoot Specifies the location on the node file system, where the software image files shall be transferred.

type=string
default=
minimum=0
maximum=174
Displayed(tab/group)=File Path (/Rescue File/CFLASH)
rollbackRescueDeleteResult

type=rollback.ResultEnum
access=read-only
Displayed(tab/group)=Last Rescue File Delete Result (Rollback Status/Rescue File Delete)
rollbackRescueFileExists

type=boolean
access=read-only
Displayed(tab/group)=Rescue File Exists (/Rescue File)
rollbackRescueFtpPassword

type=string
minimum=0
maximum=30
Displayed(tab/group)=FTP User Password (/Rescue File/Remote Location)
rollbackRescueFtpPath

type=string
default=
minimum=0
maximum=100
Displayed(tab/group)=File Path (/Rescue File/Remote Location)
rollbackRescueFtpServerIP

type=InetAddress
Displayed(tab/group)=FTP Server IP (/Rescue File/Remote Location)
rollbackRescueFtpServerIPAddrType

type=rtr.InetAddressType
default=ipv4
rollbackRescueFtpUser

type=string
minimum=0
maximum=30
Displayed(tab/group)=FTP User ID (/Rescue File/Remote Location)
rollbackRescueLoc

type=string
access=read-only
rollbackRescueLocationtype

type=rollback.RollBackFileLocationType
default=cflash
Displayed(tab/group)=Rescue File Location Type (/Rescue File)
rollbackRescueRevertEndTime

type=string
access=read-only
Displayed(tab/group)=Last Rescue File Revert End Time (Rollback Status/Rescue File Revert)
rollbackRescueRevertResult

type=rollback.ResultEnum
access=read-only
Displayed(tab/group)=Last Rescue File Revert Result (Rollback Status/Rescue File Revert)
rollbackRescueRevertStartTime

type=string
access=read-only
Displayed(tab/group)=Last Rescue File Revert Start Time (Rollback Status/Rescue File Revert)
rollbackRescueRevertUserName

type=string
access=read-only
Displayed(tab/group)=Last Rescue File User Name (Rollback Status/Rescue File Revert)
rollbackRescueSaveResult

type=rollback.ResultEnum
access=read-only
Displayed(tab/group)=Last Rescue File Create Result (Rollback Status/Rescue File Create)
rollbackRescueSavedTime

type=string
access=read-only
Displayed(tab/group)=Last Rescue File Create Time (Rollback Status/Rescue File Create)
rollbackResult

type=rollback.ResultEnum
access=read-only
Displayed(tab/group)=Last Checkpoint File Revert Result (Rollback Status/Checkpoint File Revert)
rollbackRevertEndTime

type=string
access=read-only
Displayed(tab/group)=Last Checkpoint File Revert End Time (Rollback Status/Checkpoint File Revert)
rollbackRevertFileName

type=string
access=read-only
maximum=180
Displayed(tab/group)=Last Checkpoint File Revert File Name (Rollback Status/Checkpoint File Revert)
rollbackRevertIndex

type=int
access=read-only
minimum=0
maximum=199
Displayed(tab/group)=Last Checkpoint File Revert Index (Rollback Status/Checkpoint File Revert)
rollbackRevertStartTime

type=string
access=read-only
Displayed(tab/group)=Last Checkpoint File Revert Start Time (Rollback Status/Checkpoint File Revert)
rollbackRevertUserName

type=string
access=read-only
Displayed(tab/group)=Last Checkpoint File Revert User Name (Rollback Status/Checkpoint File Revert)
rollbackSaveResult

type=rollback.ResultEnum
access=read-only
Displayed(tab/group)=Last Checkpoint File Create Result (Rollback Status/Checkpoint File Create)
rollbackSavedTime

type=string
access=read-only
Displayed(tab/group)=Last Checkpoint File Create Time (Rollback Status/Checkpoint File Create)
rollbackSyncLastTime

type=Date
access=read-only
Displayed(tab/group)=Last Rollback File Sync Time (Rollback Status/Redundancy Sync)
routerId Specifies the system address of the network element.

type=string
access=read-only
default=
maximum=64
Displayed(tab/group)=Site Id
saveScheduledTaskResultPtr The schedule task, if any, that specifies the binding between the upgrade task and the schedule.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Scheduled Task - Checkpoint File Create (Scheduled Task Status/Checkpoint File Create - Policy based)
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

configRedundancyRlbkSync

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.
neId : string -
configSyncType : boolean -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
rollback.RollbackNEInfo.configRedundancyRlbkSyncException

createRollbckCheckPt

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.
neId : string -
checkPtComment : string -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
rollback.RollbackNEInfo.createRollbckCheckPtException

createRollbckRescue

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.
neId : string -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
rollback.RollbackNEInfo.createRollbckRescueException

deleteRollbckCheckPt

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.
neId : string -
rollbackIndex : int -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
rollback.RollbackNEInfo.deleteRollbckCheckPtException

deleteRollbckRescue

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.
neId : string -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
rollback.RollbackNEInfo.deleteRollbckRescueException

executeCompareCheckpoint

Input Parameters:
isSynchronized : boolean -
clientId : string -
neId : string -
cliCommand : string -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : string -
Exceptions:
rollback.RollbackNEInfo.executeCompareCheckpointException

executeViewCheckPoint

Input Parameters:
isSynchronized : boolean - Wait until executed command finished. True to wait, false otherwise.
clientId : string - Identifies the client Id that is requesting the execution (used for sending an event to the specific client when execution is complete).
neId : string -
rollbackIndex : int -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : string - The result of the executed command (returned as a string).
Exceptions:
rollback.RollbackNEInfo.executeViewCheckPointException

redundancyRollbackSync

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.
neId : string -
syncType : int -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
rollback.RollbackNEInfo.redundancyRollbackSyncException

revertRollbckCheckPt

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.
neId : string -
rollbackIndex : int -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
rollback.RollbackNEInfo.revertRollbckCheckPtException

revertRollbckRescue

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.
neId : string -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
rollback.RollbackNEInfo.revertRollbckRescueException
Supported Network Elements
7750 SR Supported from 9.0.R4
7705 SAR Gen 2
7450 ESS Supported from 9.0.R4
7705 SAR Supported from 8.0.R4
7705 SAR H Supported from 8.0.R4
7705 SAR Hm
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
7210 SAS Mxp Supported from 10.0.R2
7250 IXR
7210 SAS R Supported from 7.0.R1