Overview Package Class Deprecated Help

mediation
OmniSoftwareFolderDescriptor

This class holds information about each AOS Omni software image set.

public class OmniSoftwareFolderDescriptor

Properties
issuStackedSignature

type=string
access=read-only
default=N/A
maximum=40
omniAdRoutingVersion Specifies the AOS Advance Routing Image software version supported by this image set.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=AOS Advance Routing (Optional) (/Images)
omniBaseCodeVersion Specifies the AOS base software version supported by this image.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=AOS Base Software (/Images)
omniDiagVersion Specifies the AOS Diagnostics Image software version supported by this image set.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=AOS Diagnostic (/Images)
omniEncryptVersion Specifies the AOS Encrypt Image software version supported by this image set.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=AOS Encrypt (/Images)
omniEthernetVersion Specifies the AOS Ethernet Image software version supported by this image set.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=AOS Ethernet Software (/Images)
omniFpgaVersion Specifies the AOS FPGA version supported by this file.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=AOS FPGA file (/FPGA file)
omniIssuImageShaFile Specifies the AOS software image file for issu upgrade.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=AOS Image Sha File (/Images)
omniIssuVersion Specifies the AOS ISSU text file supported by this image set.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=AOS ISSU File (/Images)
omniMinibootVersion Specifies the AOS Mini Boot software version supported by this image set.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=AOS Mini Boot (/Boot files)
omniOSCodeVersion Specifies the AOS OS software version supported by this image.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=AOS OS Software (/Images)
omniRelVersion Specifies the AOS Release image version supported by this image.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=AOS Release Software (/Images)
omniRescueVersion Specifies the AOS Rescue Image software version supported by this image set.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=AOS Rescue (/Images)
omniSecurityVersion Specifies the AOS Security Image software version supported by this image set.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=AOS Security (/Images)
omniSoftwareIssuVersion Specifies the AOS software ISSU text file supported by this image set.

type=string
access=read-only
default=N/A
maximum=40
Displayed(tab/group)=AOS Software ISSU File (/Images)
omniUbootVersion Specifies the AOS Uboot software version supported by this image set.

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

certifyImage

This operation results in the certify of the selected image on the selected sites. It involves certify the image files.
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.OmniSoftwareFolderDescriptor.certifyImageException

deleteUbootMiniBoot

This operation results in deleting U-Boot and Miniboot files in /flash directory.
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.OmniSoftwareFolderDescriptor.deleteUbootMiniBootException

installImage

This operation results in the install of the selected image on the selected sites. It involves installing the image files.
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.OmniSoftwareFolderDescriptor.installImageException

reload

This operation results in the reload image from working directory.
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) -
isIssu : boolean -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
mediation.OmniSoftwareFolderDescriptor.reloadException

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) -
isIssu : boolean -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
mediation.OmniSoftwareFolderDescriptor.upgradeException

upgradeFPGA

This operation results in upgrading FPGA files in /flash directory.
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.OmniSoftwareFolderDescriptor.upgradeFPGAException

upgradeUbootMiniBoot

This operation results in the upgrade U-Boot and Miniboot files in /flash directory.
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.OmniSoftwareFolderDescriptor.upgradeUbootMiniBootException