| Actions |
boolean |
-
cancelCurrentAction
(
);
-
Cancel an ongoing asynchronous createBackup, deleteBackup, or importBackup operation.
|
boolean |
-
createBackup
(
string name
);
-
Creates a new backup of the backupType and backupDomain managed by the BackupManager.
This is an asynchronous action - progress and result will be reported in the ReportProgress attribute.
-
Parameters
Name: name
Description: The name of the backup to create.
If specified, input name validation is done by the implementation to forbid illegal names. Backup name validation rules are defined by the implementation and include duplicate backup names, names exceeding maximum allowed length, etc.
If not specified, the implementation will generate a backup name automatically with format defined by the implementation, example: <managedElementId>_<YYYY-MM-DDThh-mm-ss>.
|
boolean |
-
deleteBackup
(
string name
);
-
Delete a backup specified by its name and of the type and domain managed by this BackupManager.
This is an asynchronous action - progress and result will be reported in the progressReport attribute.
-
Parameters
Name: name
Description: The name of the backup to delete.
|
boolean |
-
importBackup
(
string uri
,
EcimPasswordString password
);
-
Import a backup using the specified uri.
This is an asynchronous action; progress and result will be reported in the progressReport attribute. Note that the type and domain of the backup to be imported must match the backup type and domain indicated by the instance of the backup manager on which this action is invoked.
-
Parameters
Name: uri
Description: Specifies the location (url) of the backup to import.
Orthe resource name (urn) that encapsulates the backup import procedure.
Name: password
Description: The password required to access the location specified by the uri.
If no password is required, this parameter may be omitted.
|
| Attributes |
BrmAsyncActionProgress[0..1]
noNotification
readOnly |
-
asyncActionProgress
-
The structure used to report the progress and final result of asynchronous actions.
[Deprecated - Replaced by progressReport]
Deprecated: Replaced by progressReport
|
BrmAutoExport[0..1] |
-
autoExport
=
DISABLED
-
Determines whether a manual backup is to be automatically exported at successful creation.
If set to ENABLED, the manual backup most recently created is exported to the location specified by attribute autoExportUri after it is successfully created. Note that the automatic export is only triggered if creation of the manual backup was successful. Otherwise, no export operation is triggered, even if this attribute is set to ENABLED. Also, note that setting this attribute to ENABLED has no impact on the manual backups that were already created and stored prior to the new configuration.
|
EcimPassword[0..1] |
-
autoExportPassword
-
Password used by the manual backup when automatically exporting a manually created backup.
If autoExport attribute is set to ENABLED, this password will be used for authentication when automatically exporting the manually created backup.
|
string[0..1] |
-
autoExportUri
-
Uri used by the manual backup when automatically exporting a manual created backup.
If attribute autoExport is set to ENABLED, this uri specifies the location to which the manual created backup is automatically exported.
|
string
readOnly |
-
backupDomain
-
Backup domain, for example System.
|
string
readOnly |
-
backupType
-
Type of backup; System Data or User Data.
|
string
key
mandatory
noNotification
restricted |
-
brmBackupManagerId
-
The value component of the RDN.
|
string[0..1] |
-
manualBackupName
-
The configurable portion of the manual backup name.
The format of generared backups are named <manualBackupName>-<creation date and time>, where creation date and time is of type DateTime defined in the common library.
Note: <creation date and time> will based on local time when operatior issues action request
|
BrmAsyncActionProgress[0..1]
readOnly |
-
progressReport
-
Represents the progress report and final result of the ongoing (asynchronous) action.
This MO supports only one action to be executed at a time.
|