Overview Package Class Deprecated Help

sw
BackupRestoreManager

This class manages the backup and restore related operations, performed by NFM-P server, for each network element.

public class BackupRestoreManager

Properties
backupFileMigrationState Status of the NE backup file migration from the DB to the filesystem for backups associated with this manager.

type=sw.BackupFileMigrationState
access=read-only
default=notStarted
backupLicenseFile Specifies license file backup is required as part of NE backup process

type=boolean
access=read-only
default=true
backupPolicyId Specifies the ID of the Backup Policy assigned to this network element.

type=int
default=1
minimum=1
maximum=65535
Displayed(tab/group)=Policy ID
backupPolicyName Specifies the name of the Backup Policy assigned to this network element.

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Backup Policy Name
displayedName Specifies the displayed name of the network element.

type=string
access=read-only
default=
maximum=252
Displayed(tab/group)=Name
lastBootOptionBackupVersion Specifies the last backed up BOF file version.

type=string
access=read-only
default=
maximum=252
Displayed(tab/group)=Last Backed Up BOF Version (/Backup Status)
lastConfigBackupVersion Specifies the last backed up config file version.

type=Date
access=read-only
default=0
lastDeviceSaveConfigState Specifies the state of the last save config operation, performed on the node.

type=sw.BackupRestoreProcessState
access=read-only
default=notAttempted
Displayed(tab/group)=Config Save State (Configuration Saves)
lastDeviceSaveConfigTimestamp Specifies the time of last save config operation, performed on the node.

type=Date
access=read-only
default=0
Displayed(tab/group)=Config Save Time (Node) (Configuration Saves/Details)
lastFailureDetails Specifies the text of the last error message generated by a failed backup or restore related operation.

type=string
access=read-only
default=
maximum=4096
Displayed(tab/group)=Last Operation Details
lastNmsBootBackupState Specifies the state of the last backup operation, performed by NFM-P.

type=sw.BackupRestoreProcessState
access=read-only
default=notAttempted
Displayed(tab/group)=Backup State (/Backup Status)
lastNmsBootBackupTimestamp Specifies the time of the last backup operation, performed by NFM-P.

type=Date
access=read-only
default=0
Displayed(tab/group)=Backup Time (/Backup Status)
lastNmsBootRestoreState Specifies the state of the last restore operation, performed by NFM-P.

type=sw.BackupRestoreProcessState
access=read-only
default=notAttempted
Displayed(tab/group)=Restore State (/Restore Status)
lastNmsBootRestoreTimestamp Specifies the time of last restore operation, performed by NFM-P.

type=Date
access=read-only
default=0
Displayed(tab/group)=Restore Time (/Restore Status)
lastNmsSaveConfigState Specifies the state of the last save config operation, performed by NFM-P.

type=sw.BackupRestoreProcessState
access=read-only
default=notAttempted
Displayed(tab/group)=Config Save State (NFM-P Server) (Configuration Saves/Details)
lastNmsSaveConfigTimestamp Specifies the time of last save config operation, performed by NFM-P.

type=Date
access=read-only
default=0
Displayed(tab/group)=Config Save Time (Configuration Saves/Details)
lastNmsVersionRestoreState

type=sw.BackupRestoreProcessState
access=read-only
default=notAttempted
lastSuccessfulBootBackupTimestamp Specifies the time of the last successful backup operation, performed by NFM-P.

type=Date
access=read-only
default=0
Displayed(tab/group)=Last Successful Backup Time (/Backup Status)
lastSuccessfulBootRestoreTimestamp Specifies the time of last successful restore operation, performed by NFM-P.

type=Date
access=read-only
default=0
Displayed(tab/group)=Last Successful Restore Time (/Restore Status)
lastSuccessfulSaveConfigTimestamp Specifies the time of the last successful save config operation, performed by NFM-P.

type=Date
access=read-only
default=0
Displayed(tab/group)=Last Successful Config Save Time (Configuration Saves)
nodeVersion Specifies the version of this network element.

type=string
access=read-only
default=
minimum=0
maximum=252
Displayed(tab/group)=Node Version
numSavesSinceLastBackup Specifies the number of save config operations, since last backup, performed by NFM-P.

type=int
access=read-only
default=0
Displayed(tab/group)=Number Of Config Saves Since Last Backup Started (Configuration Saves/Details)
routerId Specifies the system address of the network element.

type=string
access=read-only
default=
maximum=64
Displayed(tab/group)=Router ID
sw.AimBackupFolderDescriptor-Set type=Children-Set
sw.BackupFolderDescriptor-Set type=Children-Set
sw.DWBackupFolderDescriptor-Set type=Children-Set
sw.GneBackupFolderDescriptor-Set type=Children-Set
sw.MPRBackupFolderDescriptor-Set type=Children-Set
sw.OmniBackupFolderDescriptor-Set type=Children-Set
sw.VwmOSUBackupFolderDescriptor-Set type=Children-Set
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

backup

This operation retrieves the backup files (node bof file (bof.cfg), primary-config specified in the bof, index file (primary-config) with a .ndx extension, license file, Certificates) from the node and saves them on the NFM-P server. OSS instanceFullName must have the format of: network:38.120.200.156:backupRestoreManager where 38.120.200.156 should be the node's systemAddress.
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.
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
sw.BackupRestoreManager.backupException

backupStatusRefresh

This operation does polling on the Node to check whether backup is complete if so updates the states.
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.
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
sw.BackupRestoreManager.backupStatusRefreshException

restore

This operation restores the backup files (node bof file (bof.cfg), primary-config specified in the bof, index file (primary-config) with a .ndx extension, license file, Certificates) back to the node.
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.
instanceFullName : string - the full name of the object.
backupFolderDescriptorPointer : Pointer -
restoreBof : boolean -
restoreConfig : boolean -
force : boolean - (Optional)
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
sw.BackupRestoreManager.restoreException

saveConfig

This operation sends a request to the network element to save its current configurations.
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.
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
sw.BackupRestoreManager.saveConfigException