Overview Package Class Deprecated Help

mediation
SoftwareFolderDescriptor

This class holds information about each software image set.

public class SoftwareFolderDescriptor

Properties
bootLoaderVersion Indicates whether the boot loader file is present or not present in this image set.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=Boot Loader (/Images)
combinedCodeVersion Specifies the combined software version supported by this image set. This is extracted from the header of both.tim file.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=Combined Card Software Version (/Images)
cpmCodeVersion Specifies the CPM software version supported by this image. This is extracted from the header of cpm.tim file.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=CPM Card Software Version (/Images)
hmacSha1Version Indicates whether the hmac-sha1 file is present or not present in this image set.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=HMAC-SHA1 (/Images)
hmacSha256Version Indicates whether the hmac-sha256 file is present or not present in this image set.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=HMAC-SHA256 (/Images)
iomCodeVersion Specifies the IOM software version supported by this image. This is extracted from the header of iom.tim file.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=IOM Card Software Version (/Images)
isaaaCodeVersion Specifies the isa-aa software version supported by this image set. This is extracted from the header of isa-aa.tim file.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=ISA-AA Card Software Version (/Images)
isatmsCodeVersion Specifies the isa-tms software version supported by this image set. This is extracted from the header of isa-tms.tim file.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=ISA-TMS Card Software Version (/Images)
mptSoftwareVersion Specifies the MPT software version supported by this image set. This is extracted from the header of DSC file.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=MPT Image Software Version (/Images)
onieVersion Indicates whether the Onie file is present or not present in this image set.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=ONIE Software Version (/Images)
peakflowtmsCodeVersion Specifies the peakflow-tms software version supported by this image set. This is extracted from the header of peakflow-tms.tim file.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=Peakflow TMS Card Software Version (/Images)
supportCodeVersion Specifies the support software version supported by this image set. This is extracted from the header of support.tim file.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=Support Software Version (/Images)
vxRomVersion Indicates whether the vxRom file is present or not present in this image set.

type=string
access=read-only
default=N/A
maximum=40
  
Properties inherited from mediation.AbstractSoftwareFolderDescriptor
imageShelfClass, isImageValid, productId, productName
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

activateImage

This operation results in the activation of the selected image, on the selected sites. It involves updating the bof file to point to the 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.
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.
networkElements : Set (Pointer) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
mediation.SoftwareFolderDescriptor.activateImageException

extShelfScheduleUpgrade

This operation results in transfer of the image set, as per the selected schedule, to the selected sites, as per assigned software upgrade policy, followed by activation of the image set (if auto-activate is turned on) and reboot (if auto-reboot is turned on).
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.
schedule : string -
extShelves : List (summary(sw.ExtensionShelfUpgradeManager)) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
mediation.SoftwareFolderDescriptor.extShelfScheduleUpgradeException

findApplicableNes

Used to find list network elements that could be upgraded using this image.
Input Parameters:
instanceFullName : string - the full name of the object.
isScheduled : boolean -
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : List (generic.CommonManagedEntityInformation) -

scheduleUpgrade

This operation results in transfer of the image set, as per the selected schedule, to the selected sites, as per assigned software upgrade policy, followed by activation of the image set (if auto-activate is turned on) and reboot or issu (if auto-reboot or issu is turned on).
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.
schedule : string -
networkElements : Set (Pointer) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
mediation.SoftwareFolderDescriptor.scheduleUpgradeException

upgrade

This operation results in transfer of the image set, to the selected sites, as per assigned software upgrade policy, followed by activation of the image set (if auto-activate is turned on) and reboot or issu (if auto-reboot or issu is turned on).
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.
networkElements : Set (Pointer) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
mediation.SoftwareFolderDescriptor.upgradeException

upgradeExtShelves

This operation results in transfer of the image set, to the selected Extended Shelves on SR Chassis, as per assigned software upgrade policy, followed by activation of the image (reboot or reboot with firmware upgrade).
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.
extShelves : List (summary(sw.ExtensionShelfUpgradeManager)) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
mediation.SoftwareFolderDescriptor.upgradeExtShelvesException

validateDiskSpace

validate disk space before upgrade to check for sufficient memory availability
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.
networkElements : Set (Pointer) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false