Overview Package Class Deprecated Help

mediation
GNESoftwareFolderDescriptor

This class holds information about each GNE software image set.

public class GNESoftwareFolderDescriptor

Properties
gneDriver Specifies the GNE Driver used by the GNEs that can be upgraded using this image.

type=Pointer
access=read-only
default=
Displayed(tab/group)=GNE Driver (/Software Image)
gneProfile Specifies the GNE profile of the GNEs that can be upgraded using this image.

type=Pointer
access=read-only
default=
Displayed(tab/group)=GNE Profile (/Software Image)
gneSwVersion Specifies the GNE OS software version supported by this image.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=GNE Software Image Version (/Software Image)
gneType Specifies the GNE Type supported by this image.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=GNE Type (/Software Image)
swImageFileNames List of relative software image file names.

type=List (string)
access=read-only
Displayed(tab/group)=GNE Software Image File Names (/Software Image)
  
Properties inherited from mediation.AbstractSoftwareFolderDescriptor
imageShelfClass, isImageValid, productId, productName
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

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) -

findApplicableOperations

Used to find list upgrade operations that could be performed using this image.
Input Parameters:
instanceFullName : string - the full name of the object.
isScheduled : boolean -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : List (string) -

scheduleUpgrade

This operation results in upgrade operation, as per the selected schedule, on 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.
schedule : string -
networkElements : Set (Pointer) -
operation : string -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
mediation.GNESoftwareFolderDescriptor.scheduleUpgradeException

upgrade

This operation results in upgrade operation, 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) -
operation : string -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
mediation.GNESoftwareFolderDescriptor.upgradeException