Overview Package Class Deprecated Help

mediation
BackupPolicy

This class defines the criteria, used by the NFM-P server, to determine when and how to perform node backup and restore related operations.

public class BackupPolicy

Properties
autoBackupScheme Used to determine whether NFM-P server shall perform a node backup, after initiating a number of config saves as specified by the "autoBackupSchemeTreshold".

type=mediation.AutoBackupScheme
default=none
Displayed(tab/group)=Auto Backup Scheme (/Backup Triggering)
autoBackupSchemeTreshold Works in conjunction with the Auto Backup Scheme parameter, to specify the number of configuration saves that occur, before the NFM-P server performs a node backup.

type=int
default=0
minimum=0
maximum=1000
units=operations
Displayed(tab/group)=Auto Backup Threshold (/Backup Triggering)
backupCertificates Specifies whether to backup certificates as part of backup operation.

type=boolean
default=false
Displayed(tab/group)=Backup Certificates (/Backup Settings)
backupMode This parameted is deprecated since it was only used for LTE-A.

DEPRECATED: 21.3
type=mediation.BackupMode
default=mib
Displayed(tab/group)=Backup Mode
backupRollbackFiles Specifies whether to backup rollback files as part of backup operation.

type=boolean
default=true
Displayed(tab/group)=Backup roll back files (/Backup Settings)
backupTSFiles Specifies whether to backup tech-support files as part of backup operation.

type=boolean
default=true
Displayed(tab/group)=Backup tech-support files (/Backup Settings)
bootOptionFileBackupMode Specifies whether and when to backup the config files as a part of the backup operation. Possible values are always, never (disabled) or whenever a new version is detected.

type=mediation.FileBackupMode
default=always
Displayed(tab/group)=Boot Option File Mode (/Backup Settings)
cliAdminSave Specifies whether to issue admin Save before node backup.

type=boolean
default=true
Displayed(tab/group)=Admin Save Before Backup (/Backup Settings)
cliConfigFileBackupMode Specifies whether and when to backup the config files as a part of the backup operation. Possible values are always, never (disabled) or whenever a new version is detected.

type=mediation.FileBackupMode
default=always
Displayed(tab/group)=CLI Config File Mode (/Backup Settings)
cliConfigSaveDetails Specifies whether to backup a basic configuration file or a detailed one.

type=boolean
default=false
Displayed(tab/group)=CLI Config Save Details (/Backup Settings)
commandToApply Specifies the software control module command to apply after successful backup.

type=sw.AosVersionMngt
default=notSignificant
Displayed(tab/group)=Command to Apply After Backup (/AOS Backup Settings)
compressionMode Specifies the compression format to be used for the backup files. Possible values - GZIP, ZIP, no compression.

type=mediation.BackupCompressionMode
default=none
Displayed(tab/group)=File Compression (/Backup Settings), File Compression (/AOS Backup Settings), File Compression (/Wavence Backup Settings), File Compression (/1830 Backup/Restore Settings), File Compression (/Generic NE Backup Settings)
debugConfigFileBackupMode Specifies whether to backup the debug config files as a part of the backup operation.

type=boolean
default=false
Displayed(tab/group)=CLI Debug Save Config File Mode (/Backup Settings)
displayedName Specifies the name assigned to this backup policy.

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Name
enableBackup Indicates whether backups are enabled for this Backup Policy.

type=boolean
default=true
Displayed(tab/group)=Enable Backup
ftpPassword

type=string
minimum=0
maximum=255
Displayed(tab/group)=FTP/SFTP Password (/Backup Transfer Settings/FTP/SFTP Settings), SFTP/FTP Password (/1830 Backup/Restore Settings), SFTP/FTP Password (/Generic NE Backup Settings), SFTP Password (/AIM Backup Settings/SFTP Settings)
ftpRootDir

type=string
default=/
minimum=0
maximum=255
Displayed(tab/group)=Root Directory (/Backup Transfer Settings), Root Directory (/CMM Backup Settings), File Transfer Server Directory (/1830 Backup/Restore Settings), Root Directory (/Generic NE Backup Settings), Backup Directory (/Flexi MR BTS Backup Settings), Backup Directory (/Generic NE3S Backup Settings)
ftpServerIP

type=InetAddress
default=127.0.0.1
Displayed(tab/group)=SFTP/FTP Server IP (/Backup Transfer Settings), SFTP/FTP Server IP (/CMM Backup Settings), Server IP (/1830 Backup/Restore Settings)
ftpServerIPAddrType

type=rtr.InetAddressType
default=ipv4
ftpServerPort

type=int
default=21
Displayed(tab/group)=FTP/SFTP Server Port (/Backup Transfer Settings/FTP/SFTP Settings), File Transfer Server Port (/1830 Backup/Restore Settings), SFTP/FTP Server Port (/Generic NE Backup Settings), SFTP Server Port (/AIM Backup Settings/SFTP Settings)
ftpType

type=mediation.FtpType
default=ftp
Displayed(tab/group)=Transfer Protocol (/Backup Transfer Settings), Transfer Protocol (/1830 Backup/Restore Settings), Transfer Protocol (/Generic NE Backup Settings), Transfer Protocol (/AIM Backup Settings)
ftpUser

type=string
minimum=0
maximum=255
Displayed(tab/group)=FTP/SFTP User ID (/Backup Transfer Settings/FTP/SFTP Settings), SFTP User ID (/CMM Backup Settings/SFTP Settings), SFTP/FTP User ID (/1830 Backup/Restore Settings), SFTP/FTP User ID (/Generic NE Backup Settings), SFTP User ID (/AIM Backup Settings/SFTP Settings)
isAutoReboot Specifies whether to reboot the node, after a successful transfer of config/BOF files, to the node, on a restore operation.

type=boolean
default=false
Displayed(tab/group)=Auto Reboot After Successful Restore (/Auto Reboot)
isDefaultPolicy

type=boolean
access=read-only
default=false
Displayed(tab/group)=Is Default Policy
maxBackupAge Specifies the number of days a backup is kept before deleting it. Works in conjunction with purgeMode attribute.

type=int
default=100
minimum=0
maximum=365
units=days
Displayed(tab/group)=Maximum Backup Age (/Backup Purging)
numBackupsToKeep Specifies how many backups to keep at a time. Works in conjunction with purgeMode attribute.

type=int
default=30
minimum=1
maximum=365
Displayed(tab/group)=Number Of Backups (/Backup Purging)
policyId Specifies the ID assigned to this backup policy.

type=int
access=read-create
default=1
minimum=1
maximum=65535
Displayed(tab/group)=Policy ID
policyType

type=mediation.PolicyType
access=read-create
default=srBased
Displayed(tab/group)=Policy Type
purgeMode Specifies the criteria, used by the NFM-P server during a cleanup of backups, to determine when and which backup files to delete from the NFM-P server.

type=mediation.BackupPurgeMode
default=atMostNBackups
Displayed(tab/group)=Auto Purge Scheme (/Backup Purging)
restoreDirectory Specifies the directory on the node where the backup files are restored to. By default, backup files are restored in the working directory. This parameter can be configured with the name of a user-defined directory.

type=string
default=working
minimum=0
maximum=255
Displayed(tab/group)=Restore Directory (/AOS Backup Settings), Restore Directory (/CMM Backup Settings)
sarRadioDbFileBackupMode Specifies whether and when to backup the 7705 radio database files as a part of the backup operation. Possible values are true/false.The radio databases are saved on each admin save.

type=boolean
default=false
Displayed(tab/group)=Backup 7705 Radio Database (/Backup Settings)
saveCertifyDir

type=boolean
default=true
Displayed(tab/group)=Save Certified Directory (/AOS Backup Settings), Save Certified Directory (/Wavence Backup Settings)
saveNetworkDir

type=boolean
default=false
Displayed(tab/group)=Save Network Directory (/AOS Backup Settings)
saveSystemDir

type=boolean
default=false
Displayed(tab/group)=Save System Directory (/AOS Backup Settings)
scheduledBackupFrequency Used in conjunction with scheduleBackupScheme, to specify how often to perform the backups.

type=mediation.ScheduledBackupFrequency
default=24hours
Displayed(tab/group)=Scheduled Backup Interval (/Backup Triggering)
scheduledBackupScheme Specifies that the node backups occur at regular intervals, as specified by the scheduledBackupFrequency attribute.

type=mediation.ScheduledBackupScheme
default=always
Displayed(tab/group)=Scheduled Backup Scheme (/Backup Triggering)
scheduledBackupSyncTime Specifies the scheduled backup start time.

type=Date
default=0
Displayed(tab/group)=Scheduled Backup Sync Time (/Backup Triggering)
scheduledBackupTreshold Specifies the number of times that a backup retry occurs, if a backup fails.

type=int
default=0
minimum=0
maximum=1000
units=operations
Displayed(tab/group)=Scheduled Backup Threshold (/Backup Triggering)
sshHostKeyFingerPrint

type=string
maximum=32
Displayed(tab/group)=Host Key Fingerprint (/Backup Transfer Settings/SFTP Settings)
useActiveServer

type=boolean
default=true
Displayed(tab/group)=Use Active Server (/1830 Backup/Restore Settings)
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

configure

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.
configInfo : config(mediation.BackupPolicy) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
mediation.BackupPolicy.configureException
Supported Network Elements
7450 ESS
7210 SAS M
7210 SAS X
7210 SAS E
7210 SAS D
7210 SAS K
7210 SAS T
7210 SAS Mxp
7210 SAS Dxp
7210 SAS S/Sx
7210 SAS R
7250 IXR
7750 SR
7705 SAR Gen 2
7705 SAR Hm
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
7705 SAR
7705 SAR H
7701 CPAA
OS6850/6850E
OS6855
OS6400
Wavence SM
Wavence SA
OS6250
OS6450
OS6350
OS9700E/9800E
OS6900
OS6860E/OS6860N
OS6870
OS6865
OS6560/OS6560E
OS6570M
OS6465
OS6360
1830 VWM OSU
Product Specifics
1830 VWM OSU 8.2
1830 VWM OSU 8.3
1830 VWM OSU 8.4
1830 VWM OSU 8.5
1830 VWM OSU 9.0