Overview Package Class Deprecated Help

mediation
MPRSoftwareFolderDescriptor

This class holds information about each MPR software image set.

public class MPRSoftwareFolderDescriptor

Properties
mprDescriptorName Specifies the MPR Descriptor Name supported by this image.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=Descriptor Name (/Images)
mprSoftwareVersion Specifies the MPR OS software version supported by this image.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=Software Version (/Images)
mprSwLabel Specifies the MPR Label supported by this image.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=Label (/Images)
mprSwUnitType Specifies the MPR Unit Type supported by this image.

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

abortUpgrade

This method involves the abort operation of SW upgrade on sites.
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.MPRSoftwareFolderDescriptor.abortUpgradeException

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.MPRSoftwareFolderDescriptor.scheduleUpgradeException

upgrade

This operation results in transfer of the image set, to the selected sites, as per assigned software upgrade policy.
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.MPRSoftwareFolderDescriptor.upgradeException