mediation
SoftwareUpgradePolicy

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



public class SoftwareUpgradePolicy

Properties
activateOnly Indicates whether the NFM-P server shall activate the software image. Image activation involves updating the bof file on the node to point to this image, backing up the currently active boot loader and replacing it by the boot loader from the selected image and then forcing a boot env resync for nodes with redundant CPMs.

type=boolean
default=false
Displayed(tab/group)=Activate Image (/SR Based Setting)

autoRebootType Indicates whether NFM-P server shall activate the selected software on the node, followed by a system-wide reboot or system-wide reboot with firmware upgrade, (supported only on 7210 SAS and 7705 SAR family) or perform ISSU (In Service Software Upgrade), after a successful activation. Note: This attribute must be set to "none", if mediation.SoftwareUpgradePolicy.isAutoReboot is set to false.

type=mediation.AutoRebootTypes
default=none
Displayed(tab/group)=Software Upgrade Options (/SR Based Setting)

backup This attribute, enforces node for DB backup as part of audit action.

type=boolean
default=true

backupDir This attribute has to be configured only in case 'Use Active Server' is false and 'Node Backup' is true. Used in audit action. Indicates the backup path location. If backupDir is not configured by user, audit action will use the default backup path location on the main server as the backup path on the remote server as well.

type=string
default=/

cflashBackupRoot Specifies the location on the node file system, where the currently active boot loader shall be backed up, before replacing it with the new boot loader.

type=string
default=cf3:/backup
minimum=0
maximum=255
Displayed(tab/group)=CFlash Backup Root Path (/SR Based Setting)

cflashFirmwareImagePath Specifies the location on the node file system, where the firmware image files shall be transferred.

type=string
access=read-only
default=cf3:/
minimum=0
maximum=255
Displayed(tab/group)=CFlash Firmware Image Path (/SAR-Hm/Hmc Firmware Settings)

cflashImageRoot Specifies the location on the node file system, where the software image files shall be transferred.

type=string
default=cf3:/images
minimum=0
maximum=255
Displayed(tab/group)=CFlash Image Root Path (/SR Based Setting), Image Root Path (/AOS Based Setting), Image Root Path (/WMM Based Setting)

displayedName Specifies the name of this software upgrade policy.

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Name

extShelfFileTxOnly

type=boolean
default=true
Displayed(tab/group)=Extension Shelf Software Download (/Extension Shelf Settings)

extShelfRebootType

type=mediation.ExtShelfRebootTypes
default=none
Displayed(tab/group)=Software Upgrade Options (/Extension Shelf Settings)

fileTxOnly Indicates whether the NFM-P server shall download image to the NEs, as a part of the mediation.SoftwareFolderDescriptor.upgrade() or mediation.SoftwareFolderDescriptor.scheduleUpgrade() or mediation.SoftwareFolderDescriptor.activateImage() actions.

type=boolean
default=true
Displayed(tab/group)=Software Download (/SR Based Setting)

firmwareActivateOnly Indicates whether the NFM-P server shall activate the firmware image. Image activation involves executing the tools perform port cellular-port cellular update-firmware command.

type=boolean
default=false
Displayed(tab/group)=Firmware Activate (/SAR-Hm/Hmc Firmware Settings)

firmwareRebootType Indicates whether NFM-P server shall activate the selected firmware on the node, followed by a system-wide reboot.

type=mediation.FirmwareRebootTypes
default=none
Displayed(tab/group)=Firmware Upgrade Options (/SAR-Hm/Hmc Firmware Settings)

firmwareTxOnly Indicates whether the NFM-P server shall download firmware image to the NEs, as a part of the mediation.firmwareFolderDescriptor.upgrade() or mediation.firmwareFolderDescriptor.scheduleUpgrade() or mediation.firmwareFolderDescriptor.activateImage() actions.

type=boolean
default=true
Displayed(tab/group)=Firmware Download (/SAR-Hm/Hmc Firmware Settings)

forceUpgrade This attribute on enable, MAY result in the DB being purged (only if there is no upgrade path available).

type=boolean
default=false

forcedActivation

type=boolean
default=false
Displayed(tab/group)=Forced Download (/MPR Based Setting)

freeSpaceAfterUpgrade Indicates free percentage of space that should be available after image download is complete on to flash Memory

type=int
default=25
minimum=1
maximum=100
units=%
Displayed(tab/group)=Expected free disk space after upgrade (/DiskSpace Validation Settings)

ftpPassword

type=string
default=
minimum=0
maximum=255
Displayed(tab/group)=FTP Password (/MPR Based Setting/FTP Settings), FTP Password (/GNE Based Setting/FTP Settings), SFTP/FTP Password (/1830 Based Setting)

ftpRootDir

type=string
default=/
minimum=0
maximum=255
Displayed(tab/group)=Root Directory (/MPR Based Setting), Root Directory (/GNE Based Setting), Root Directory (/1830 Based Setting)

ftpServerIP

type=InetAddress
default=127.0.0.1
Displayed(tab/group)=SFTP/FTP Server IP (/MPR Based Setting), Server IP (/1830 Based Setting)

ftpServerIPAddrType

type=rtr.InetAddressType
default=ipv4

valid enums=ipv4 (Where parent is one of (netw.Network))

ftpServerPort

type=int
default=21
Displayed(tab/group)=FTP Server Port (/MPR Based Setting/FTP Settings), FTP Server Port (/GNE Based Setting/FTP Settings), SFTP/FTP Server Port (/1830 Based Setting)

ftpType

type=mediation.FtpType
default=ftp
Displayed(tab/group)=Transfer Protocol (/MPR Based Setting), Transfer Protocol (/GNE Based Setting), Transfer Protocol (/1830 Based Setting)

ftpUser

type=string
minimum=0
maximum=255
Displayed(tab/group)=FTP User ID (/MPR Based Setting/FTP Settings), FTP User ID (/GNE Based Setting/FTP Settings), SFTP/FTP User ID (/1830 Based Setting)

isAutoAccept Indicates whether the NFM-P shall automatically send the 'Accept Software Image' request to the eNodeB following a successful 'Activation' of that same Software Image.

type=boolean
default=false
Displayed(tab/group)=Auto-Commit After Successful Software Activation (/1830 Based Setting)

isAutoActivate Indicates whether the NFM-P server shall activate the software image, after transferring it successfully to the node. Image activation involves updating the bof file on the node to point to this image, backing up the currently active boot loader and replacing it by the boot loader from the selected image and then forcing a boot env resync for nodes with redundant CPMs. Note : Deprecated for SR family in 12.0, use mediation.SoftwareFolderDescriptor.activateImage() instead.

type=boolean
default=true
Displayed(tab/group)=Auto-Activate After Successful File Transfer (/1830 Based Setting)

isAutoReboot Indicates whether NFM-P server shall reboot the node, after a successful activation.

DEPRECATED: 12.0 - Replaced with autoRebootType
type=boolean
default=false

isDefaultPolicy

type=boolean
access=read-only
default=false

isIssu Indicates whether this software upgrade shall be an "In-service Software Upgrade". For SR family. use mediation.SoftwareUpgradePolicy.isAutoReboot = true and mediation.SoftwareUpgradePolicy.autoRebootType = ISSU, instead.

DEPRECATED: 12.0 - Replaced with autoRebootType - ISSU
type=boolean
default=false

policyId Specifies the ID assigned to this software upgrade 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

runningDirectory

type=string
default=working
minimum=0
maximum=255
Displayed(tab/group)=Running Directory (/AOS Based Setting)

sFtpServerPort

type=int
default=22
Displayed(tab/group)=SFTP Server Port (/MPR Based Setting/SFTP Settings), SFTP Server Port (/GNE Based Setting/SFTP Settings)

sftpPassword

type=string
default=
minimum=0
maximum=255
Displayed(tab/group)=SFTP Password (/MPR Based Setting/SFTP Settings), SFTP Password (/GNE Based Setting/SFTP Settings)

sftpUser

type=string
minimum=0
maximum=255
Displayed(tab/group)=SFTP User ID (/MPR Based Setting/SFTP Settings), SFTP User ID (/GNE Based Setting/SFTP Settings)

sshHostKeyFingerPrint

type=string
maximum=32
Displayed(tab/group)=Host Key Fingerprint (/MPR Based Setting/SFTP Settings)

timeToWaitForSoftwareResync Indicates the time (in minutes) NFM-P server has to wait before launching a software resync on MRBTS after a successful activation.

type=int
default=15
minimum=0
maximum=30
Displayed(tab/group)=Timer For Automatic Software Resynchronization After Activation (minutes) (/Flexi MR BTS Based Setting)

timerToWaitForFallbackToPreviousSWversion This parameter is used to specify the timer (minutes) to wait for eNodeB performing a full fallback to the previous SW version when eNodeB failed to use new (updated) version. OMC can also use this parameter to detect network problems and re-configure eNodeB. The value 0 is used to turn off the SW fallback functionality. The supported timer range is 30 .. 120 min. The default value is 30 min. This parameter is supported used by MPT-GS, but the defualt value is 20 min, and the range is 5 .. 500 min.

type=int
default=30
minimum=0
maximum=120
units=min
Displayed(tab/group)=Accept Timeout (/GNE Based Setting)

upgradeBootFiles Indicates whether this software upgrade shall download types of files to AOS switch.

type=mediation.AOSFilesType
default=aosAllFile
Displayed(tab/group)=Upgrade File Type (/AOS Based Setting)

upgradeOptions Indicates the WMM Software Upgrade Options

type=mediation.WMMUpgradeOptions
default=upgradeNoCommit
Displayed(tab/group)=Upgrade Options (/WMM Based Setting)

useActiveServer Indicates whether the NE Software Image is in remote server Or NFM-P server.

type=boolean
default=true
Displayed(tab/group)=Use Active Server (/1830 Based Setting)

useUSBPort Indicates whether the NE Software Image is in remote server Or NFM-P server.

type=boolean
default=false
Displayed(tab/group)=Use USB Port (/1830 Based Setting)

validateDiskSpace Indicates whether the NFM-P server shall validate the disk space on the network element.

type=boolean
default=false
Displayed(tab/group)=Validate Disk Space (/DiskSpace Validation Settings)

  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Supported Network Elements
Generic NE
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
7750 SR
7705 SAR Gen 2
7250 IXR
7705 SAR Hm
1830 VWM OSU
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
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
Generic NE
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