Overview Package Class Deprecated Help

mediation
SoftwareFolderManager

This class represents a container for software folders (SoftwareFolderDescriptor).

public class SoftwareFolderManager

Properties
mediation.FirmwareFolderDescriptor-Set type=Children-Set
mediation.GNESoftwareFolderDescriptor-Set type=Children-Set
mediation.MPRSoftwareFolderDescriptor-Set type=Children-Set
mediation.OmniSoftwareFolderDescriptor-Set type=Children-Set
mediation.SoftwareFolderDescriptor-Set type=Children-Set
mediation.VwmOsuSoftwareFolderDescriptor-Set type=Children-Set
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

containsDeprecatedCards

Returns true if node that is being upgraded to given target version contains deprecated cards.
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.
siteId : string -
targetVersion : string -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
returnValue : boolean -

getInfo

Input Parameters:
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:
configInfo : summary(mediation.SoftwareFolderManager) -
Exceptions:
mediation.SoftwareFolderManager.getInfoException

importFwImage

This operation reads the firmware image files, from a selected location, relative to the local directory server_install_dir/nms/nodeSoftware/ and saves them in the NFM-P database. The local directory server_install_dir/nms/nodeSoftware/ shall be cleaned up periodically, based on config parameter - "nodeSoftware timeToKeepFile" (default = 1440 minutes), specified in nms-server.xml config file.
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.
imageFileNames : List (string) - List of file names to be imported. If empty, all the files in the directory referred to by "imageLocation" parameter shall be picked up.
imageLocation : string - Relative name of the directory containing all the image files (relative to the local directory server_install_dir/nms/nodeSoftware/).
shelfType : int - shelfType - for SAR-Hm it is 413 and SAR-Hmc it is 515
firmwareVersion : string - firmware version
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : boolean -
Exceptions:
mediation.SoftwareFolderManager.importFwImageException

importImage

This operation reads the software image files, from a selected location, relative to the local directory server_install_dir/nms/nodeSoftware/ and saves them in the NFM-P database. The local directory server_install_dir/nms/nodeSoftware/ shall be cleaned up periodically, based on config parameter - "nodeSoftware timeToKeepFile" (default = 1440 minutes), specified in nms-server.xml config file.

Example (eNodeB): 
<mediation.SoftwareFolderManager.importImage xmlns="xmlapi_1.0">
     <deployer>immediate</deployer>
     <synchronousDeploy >true</synchronousDeploy >
     <imageFileNames>
          <string>#BI_0622#FT_OMsw#FI_RH2XANB07#FV_0000002A</string>
          <string>#BI_0623#FT_OMsw#FI_RH2XANB13#FV_0000006A</string>
          <string>#BI_0626#FT_OMsw#FI_RH1XANB64#FV_00000014</string>
          <string>#BI_0627#FT_OMsw#FI_SA2XCOB02#FV_00000018</string>
          <string>#BI_0630#FT_OMsw#FI_TR2XANB13#FV_0000006E</string>
          <string>#BI_0690#FT_OMsw#FI_eccm#FV_00000806</string>
          <string>#BI_06D0#FT_OMsw#FI_MT2XALB03#FV_0000002D</string>
          <string>#BI_06E2#FT_OMsw#FI_TR2XALB07#FV_00000067</string>
          <string>#BI_0702#FT_OMsw#FI_RH2XASB05#FV_0000002F</string>
          <string>#BI_0703#FT_OMsw#FI_RH2XALB01#FV_00000003</string>
          <string>#BI_0704#FT_OMsw#FI_MR2XASB03#FV_00000056</string>
          <string>#BI_0705#FT_OMsw#FI_RH2XASB02#FV_0000002A</string>
          <string>#BI_0708#FT_OMsw#FI_AR2XALB17#FV_00000043</string>
          <string>#BI_070B#FT_OMsw#FI_RH2XALA01#FV_00000011</string>
          <string>#BI_070D#FT_OMsw#FI_AR2XASB07#FV_00000005</string>
          <string>#BI_070F#FT_OMsw#FI_AR2XASB02#FV_00000018</string>
          <string>#BI_0721#FT_OMsw#FI_MX1XASB03#FV_00000003</string>
          <string>#BI_0730#FT_OMsw#FI_RH2XALB04#FV_000000A8</string>
          <string>#BI_0731#FT_OMsw#FI_RH2XALB12#FV_000000A8</string>
          <string>#BI_0734#FT_OMsw#FI_RH2XALL20#FV_000000A0</string>
          <string>#BI_0735#FT_OMsw#FI_RH2XALU20#FV_000000A0</string>
          <string>#BI_0737#FT_OMsw#FI_RH2XALB07#FV_00000099</string>
          <string>#BI_0739#FT_OMsw#FI_RH4XALB02#FV_0000006A</string>
          <string>#BI_073B#FT_OMsw#FI_RH2XALB03#FV_000000A5</string>
          <string>#BI_073C#FT_OMsw#FI_RH2XALB28#FV_00000003</string>
          <string>#BI_07B4#FT_OMsw#FI_bcem#FV_000006C9</string>
          <string>#BI_07D0#FT_OMsw#FI_TR2XPAL20#FV_0000003C</string>
          <string>#BI_07D1#FT_OMsw#FI_TR2XPAU20#FV_00000041</string>
          <string>#BI_07D2#FT_OMsw#FI_TR2XPAB04#FV_0000002A</string>
          <string>#BI_07E0#FT_OMsw#FI_TR2XGPB13#FV_00000074</string>
          <string>#BI_07E1#FT_OMsw#FI_TR2XGPB14#FV_0000003C</string>
          <string>#BI_07E2#FT_OMsw#FI_TR2XGPB12#FV_00000020</string>
          <string>#BI_0820#FT_OMsw#FI_RH4XPAB02#FV_0000003E</string>
          <string>#BI_08C0#FT_OMsw#FI_RM2XALB13#FV_0000001E</string>
          <string>#BI_08D0#FT_OMsw#FI_eccm2#FV_00000287</string>
          <string>#BI_08F0#FT_OMsw#FI_RH2XKMB26#FV_0000002A</string>
          <string>#BI_08F1#FT_OMsw#FI_RH2XKMB04#FV_00000003</string>
          <string>#BI_0920#FT_OMsw#FI_RH2XASB04#FV_00000006</string>
          <string>#BI_cb#FT_OMcpf#FI_cbCpf#FV_00000235</string>
          <string>#BI_enb#FT_OMsdf#FI_sdf#FV_ENB_LR1401_D1000_E00026</string>
          <string>ENODEB-ENB_LR1401_D1000_E00026.xml</string>
     </imageFileNames>
     <imageLocation>ENB_LR1401_D1000_E00026</imageLocation>
     <imageType>lt;/imageType>
     <md5Map></md5Map>
     <versionString>LR1401_D1000_E00026</versionString>
</mediation.SoftwareFolderManager.importImage>
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.
imageFileNames : List (string) - List of file names to be imported. If empty, all the files in the directory referred to by "imageLocation" parameter shall be picked up. 
Example 1:
<imageFileNames>
     <string>myfile.ext</string>
</imageFileNames>


Example 2:
<imageFileNames>
     <string>myfile1.ext</string>
     <string>myfile2.ext</string>
     <string>myfile3.ext</string>
</imageFileNames>

imageLocation : string - Relative name of the directory containing all the image files (relative to the local directory server_install_dir/nms/nodeSoftware/). Descriptor file must be included for RAN based images.
imageType : mediation.PolicyType - Type of image - srBased, aosBased, mprBased, mmeBased, etc.
md5Map : Map (string to string) - Map of file names and their md5 checksums. Used for validation, if not empty. 
Example:
<md5Map>
     <item>
          <key>myfile.ext</key>
          <value>123456789</value>
     </item>
</md5Map>

versionString : string - Image version.
gneType : string - (Optional) Used for generic nodes, this parameter contains the Generic Ne Profile fullname, used to determine GNE types that can be upgraded, using this image.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : boolean -
Exceptions:
mediation.SoftwareFolderManager.importImageException

removeKnownHostKey

Returns true if SSH2 known host key deleted for a given node.
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.
siteId : string -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
returnValue : boolean -

wavenceImportImage

This operation reads the Wavence software image files from the given location on the file system and saves them into the NFM-P database.
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.
imageLocation : string - Absolute name of the directory containing all the files (exe, DSC, toml) of the image.
dscFileName : string - Name of the DSC file.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
mediation.SoftwareFolderManager.wavenceImportImageException