| Actions |
boolean |
-
cancel
(
);
-
Cancel can be invoked during any long-lasting operation.
It stops the operation and restores the consistent state that existed before the long-lasting operation started. The action returns immediately after invocation. The consequences of the action can be tracked by attribute progressReport. The action returns false if the action is refused by the ME. In all other cases, it returns true.
|
uint16 |
-
createUpgradePackage
(
string uri
,
EcimPasswordString password
);
-
Creates a new UpgradePackage MO that represents a UP specified by a URI.
This action includes all activities to initialize the UP MO. After the UP MO is created, all descriptive information is available, for example, administrativeData, number or names of activation step 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 by attribute progressReport . The action returns 0 if the action cannot start for any reason, for example, another parallel action is in progress. The action also returns 0 if the ME cannot handle the URI, for example, it does not support the protocol specified in the URI. In all other cases, it returns the id of the action. The action id is different and unique for every invocation of the action.
-
Parameters
Name: uri
Description: Contains a URI that points to a directory that contains the UP content.
The generic URI syntax is defined by RFC 2396. The URI must not contain any password. The password must be provided in the second parameter of this action. The URI can be local absolute, for example, file:///data/dir/subdir. It can also be remote, for example, sftp://hostname/dir/subdir.
Name: password
Description: A password to the server that provides the UP.
If authentication is not password-based, this parameter is ignored.
|
boolean |
-
removeSoftwareVersion
(
SwVersion swVersion
);
-
Removes a SW version as much as possible.
It does not disturb 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.
-
Parameters
Name: swVersion
Description: The value component of the RDN of the SwVersion MO in ECIM_SWIM to be removed.
|
boolean |
-
removeSwVersion
(
SwVersionMain swVersion
);
-
Action removeSwVersion is deprecated, it is recommended to use action removeSoftwareVersion.
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.
Deprecated: Action has been removed from ECIM SWM 4.2, deprecated in CmwSwM 5.1
-
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. It also removes 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 by attribute progressReport. 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, for example, another parallel action is in progress. In all other cases, it returns true.
-
Parameters
Name: upgradePackage
Description: An UpgradePackage MO to be removed.
|
| Attributes |
ActionCapabilityState
readOnly |
-
actionCapable
=
CAPABLE
-
Shows whether the Software Management function is in a state of readiness to execute actions.
The Managed Element sets it to WAIT during any operations and maintenance activity that causes one or more of the Software Management function related actions to become unavailable. The Management System should wait until the state returns to CAPABLE before invoking any Software Management action.
|
string[0..1]
readOnly |
-
actionCapableInfo
-
Additional information relating to actionCapable.
Provides free-text information if available about the managed element operation or maintenance activity causing actionCapable to be at state WAIT.
|
SwVersionMain[1..]
readOnly |
-
activeSwVersion
-
Reference to the active software version(s) actively controlling the behavior of the managed element.
Deprecated: Attribute has been removed from ECIM SWM 4.2, deprecated in CmwSwM 5.1
|
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.
|
ExecMethod[0..1]
noNotification |
-
execMethod
-
The default execution method.
|
int16 |
-
fallbackTimer
=
1200
-
Maximum interval in seconds within which the next action must be invoked to avoid fallback.
The maximum number of seconds allowed to elapse between the finish of an activation step and the start of the next new activate() action or new confirm() action. This attribute holds the value to which attribute timeRemainingBeforeFallback is set after the action activate() is successfully completed. -1 means infinity. In this case, the start value of timeRemainingBeforeFallback must also be set to -1 when the timer starts, even though no countdown ever starts (it remains always -1).
|
string[0..1]
readOnly |
-
localFileStorePath
-
URI of the directory where the UPs are stored on the ME.
|
AsyncActionProgress[0..1]
readOnly |
-
reportProgress
-
Represents the progress report, including the result, of the ongoing action.
This MO supports only one action execution 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
-
Holds the name used when identifying the MO.
|
SwMTimeoutFallbackCapability[0..1]
noNotification
readOnly |
-
timeoutFallbackCapability
=
SUPPORTED
-
Shows whether fallback capability is supported or not.
If fallback capability is not supported, setting SwM fallbackTimer has no effect and automatic fallback does not occur.
|
int16
noNotification
readOnly |
-
timeRemainingBeforeFallback
=
-1
-
Remaining number of seconds before performing fallback.
Value -1 indicates an infinite number of seconds. Fallback means that the system returns to state PREPARE_COMPLETED .
|
string[0..1] |
-
userLabel
-
Used for free-text description.
|