| Actions |
boolean |
-
cancel
(
);
-
Stops the operation and restores the (consistent) state present before the long lasting operation was started.
Cancel can be invoked during any long lasting operation.
The action returns immediately after invocation. The consequences of the action can be tracked via the progressReport attribute. The action returns false if the action is refused by the ME, returns true otherwise.
|
uint16 |
-
createUpgradePackage
(
string uri
,
EcimPasswordString password
);
-
Creates a new UpgradePackage MO representing an UP specified by a URI.
This action includes all activities to initialize the UP MO. After the UP MO is created, all descriptive information will be available: e.g. administrativeData, number/names of activation step(s) data.
This action can be invoked when there is no other action in progress on this MO.
The action returns immediately after invocation. The progress of the action can be tracked via the progressReport attribute.
The action returns 0 if the action could not start for any reason (e.g., another parallel action is in progress), otherwise returns the id of the action. The action id is different and unique for every invocation of the action.
The action also returns 0 if the ME cannot handle the URI (e.g., does not support the protocol specified in the URI).
-
Parameters
Name: uri
Description: Contains a URI pointing to a directory containing the UP content.
The generic URI syntax is defined by RFC 2396
The URI must not contain any password. (The password shall be provided in the second parameter of this action.)
The URI may be local absolute (e.g., file:///data/dir/subdir), or remote (e.g., sftp://hostname/dir/subdir).
Name: password
Default value: NULL
Description: A password to the server which provides UP.
If authentication is not password based, this parameter will be ignored.
|
boolean |
-
createUpgradePackageFromUri
(
string uri
,
EcimPassword password
);
-
Creates a new UpgradePackage MO representing an UP specified by a URI.
Deprecated, replaced by the createUpgradePackage action.
This action includes all activities to initialize the UP MO. After the UP MO is created, all descriptive information will be available: e.g. administrativeData, number/names of activation step(s) data.
This action can be invoked when there is no other action in progress on this MO.
The action returns immediately after invocation. The progress of the action can be tracked via the progressReport attribute.
The action returns false if the action could not start for any reason (e.g., another parallel action is in progress), otherwise returns true.
The action also returns false if the ME cannot handle the URI (e.g., does not support the protocol specified in the URI).
Deprecated:
-
Parameters
Name: uri
Description: Contains a URI pointing to a directory containing the UP content.
The generic URI syntax is defined by RFC 2396
The URI must not contain any password. (The password shall be provided in the second parameter of this action.)
The URI may be local absolute (e.g., file:///data/dir/subdir), or remote (e.g., sftp://hostname/dir/subdir).
Name: password
Description: A password to the server which provides UP.
If there is no password, this parameter shall not be specified (i.e., NULL).
|
boolean |
-
createUpgradePackageLocal
(
string directoryPathExtension
);
-
Creates a new UpgradePackage MO representing an UP stored locally in the file system of the ME.
Deprecated, replaced by the createUpgradePackage action.
This action includes all activities to initialize the UP MO. After the UP MO is created, all descriptive information will be available: e.g. administrativeData, number/names of activation step(s) data.
The action returns immediately after invocation. The progress of the action can be tracked via the progressReport attribute.
This action can be invoked when there is no other action in progress on this MO. The action returns false if the action could not start for any reason (e.g., another parallel action is in progress), otherwise returns true.
Deprecated:
-
Parameters
Name: directoryPathExtension
Description: Parameter is a relative file system path pointing to the directory where the UP content is located. The path is relative to the localFileStore attribute.
|
boolean |
-
createUpgradePackageRemote
(
string directoryPathExtension
,
ManagedObject remoteFileStore
);
-
Creates a new UpgradePackage MO representing an UP stored remotely that is not stored on the ME.
Deprecated, replaced by the createUpgradePackage action.
This action includes all activities to initialize the UP MO. After the UP MO is created, all descriptive information will be available: e.g. administrativeData, number/names of activation step(s) data.
The location of the UP file is specified (by this action) input parameters: directoryPathExtension and remoteLocation.
The action returns immediately after invocation. The progress of the action can be tracked via the progressReport attribute.
This action can be invoked when there is no other action in progress on this MO. The action returns false if the action could not start for any reason (e.g., another parallel action is in progress), otherwise returns true.
Deprecated:
-
Parameters
Name: directoryPathExtension
Description: This parameter is a relative file system path pointing to the directory where the UP content is located. The path is relative to the uriPathExtension in the TransferPolicyConsumer.
Name: remoteFileStore
Description: This TransferPolicyConsumer object contains a uriPathExtension attribute, which (together with Target and TargetGroup, all defined in the FileM fragment) define the exact remote location of the Upgrade Package.
|
boolean |
-
removeSwVersion
(
SwVersionMain swVersion
);
-
Removes a SW version as completely as possible without disturbing node functionality.
Files shared with other SW versions are not deleted.
The active SW version cannot be removed.
This action can only be invoked when there is no other action in progress on this MO.
The action returns false if any of these conditions are violated.
The action returns immediately after invocation. The progress of the action can be tracked via the progressReport attribute.
-
Parameters
Name: swVersion
Description: The value component of the RDN of the SwVersionMain MO to remove.
|
boolean |
-
removeUpgradePackage
(
UpgradePackage upgradePackage
);
-
Removes an UpgradePackage.
This action removes the UpgradePackage MO specified as action parameter as well as all files temporarily stored in the ME and associated with the UP.
The action returns immediately after invocation. The progress of the action can be tracked via the progressReport attribute.
This action can be invoked when there is no other action in progress on this MO. The action returns false if the action could not start for any reason (e.g., another parallel action is in progress), otherwise returns true.
-
Parameters
Name: upgradePackage
Description: An UpgradePackage MO to be removed. The DN of the UpgradePackage MO to be removed.
|
| Attributes |
SwVersionMain[1..]
readOnly |
-
activeSwVersion
-
Reference to the active software version(s) actively controlling the behavior of the managed element.
|
uint32
noNotification |
-
alarmBeforeTimeout
=
180
-
alarmBeforeTimeout is the time in seconds an alarm is sent out before a fallback occurs.
|
uint32
noNotification |
-
automaticBackup
=
1
-
automaticBackup is set to true(1) if ECIM SwM shall perform backup at activate() action otherwise set to false(0).
|
uint32
noNotification |
-
automaticRestore
=
1
-
automaticRestore is set to true(1) if ECIM SwM shall automatically perform fallback operation at certain events otherwise set to false(0).
These events are the following:
• The ME meets a critical problem.
(The ME must be able to detect any kind of software problem that prohibits a successful activation (step).)
• The user calls the cancel() action any time during the activation.
o Sub-case: Calling the cancel() action after the last activation step has completed (instead of calling commit()).
• The fallback timer expires during the activation.
The fallback operation shall restore the state that the ME had before starting the activation procedure.
|
int16 |
-
fallbackTimer
=
1200
-
The maximum number of seconds allowed to elapse between the finish of an activation step and the start of the next action - a new activate() action - or commit() action.
I.e., this attribute holds the value to which the attribute timeRemainingBeforeFallback is set after the action activate() is successfully completeted.
-1 symbolizes "infinity". In this case, the starting value of timeRemainingBeforeFallback shall also be set to -1 when the timer stars even though no counting down ever starts (it remains always -1).
|
ManagedObject[0..1]
readOnly |
-
localFileStore
-
Reference to a FileGroup MO (in the File Managment MOM Fragment) representing a directory in the local file system.
Deprecated, superseded by the localFileStorePath attribute.
The locally stored UPs are stored under this directory. If the ME does not support pull download of the UP, the MS has a separate procedure for downloading the files to a directory modeled as a FileGroup MO.
If FileM MOM fragment is not implemented by the Managed Element, the localFileStore attribute is NULL.
If the ME supports pull download only, the localFileStore attribute is NULL.
Deprecated:
|
string[0..1]
readOnly |
-
localFileStorePath
-
URI of the directory where the UPs are stored on the ME.
|
AsyncActionProgress
readOnly |
-
reportProgress
-
Represents the progress report (including result) of the ongoing action.
This MO supports only one action to be executed at a time.
|
string[0..1]
noNotification
readOnly |
-
subType
-
subType is any string value identifying the type of node from a ECIM SwM perspective.
|
string
key
mandatory
noNotification
restricted |
-
swMId
-
The value component of the RDN.
|
SwMTimeoutFallbackCapability[0..1]
noNotification
readOnly |
-
timeoutFallbackCapability
=
SUPPORTED
-
Indicates whether fallback capability is supported or not.
If fallback capability is not supported, then setting SwM fallbackTimer has no effect and automatic fallback never happens.
|
int16
noNotification
readOnly |
-
timeRemainingBeforeFallback
=
-1
-
Remaining number of seconds before performing fallback.
The value -1 indicates infinite number of seconds.
Fallback means that the system returns to the state PREPARE_COMPLETED.
|
string[0..1] |
-
userLabel
-
Used for free-text description.
|