14.3 CancelError (Cancels the Error Status of a Backup or Restoration Task)

Name

[Windows Manager]
Installation_folder\RCXCFMG\bin\CancelError - Cancels the Error Status of a Backup or Restoration Task

[Linux Manager]
/opt/FJSVcfmg/bin/CancelError.sh - Cancels the Error Status of a Backup or Restoration Task

Synopsis

[Windows Manager]

CancelError -version version ID -locale the language for communicating -userId user ID -password password -orgId tenant name -lplatformId L-Platform ID -taskId task ID

[Linux Manager]

CancelError.sh -version version ID -locale the language for communicating -userId user ID -password password -orgId tenant name -lplatformId L-Platform ID -taskId task ID

Function description

This command releases the error status of any backup or restoration task that has been specified.

Options

-version: Specify the version ID of the L-Platform API.

-locale: Specify the language used to communicate with the L-Platform API.

-userId: Specify the user ID for executing the L-Platform API.

-password: Specify the password for the user ID for executing the L-Platform API.

-orgId: Specify the tenant name of the user for executing the L-Platform API.

-lplatformId: Specify the L-Platform ID.

-taskId: Specify the backup or restore task ID that will cancel the error.

Requirements

Permissions: User with OS administrator privilege

Location: Admin server

Example

[Windows Manager]

> CancelError -version 2.0 -locale en -userId user3 -password password -orgId tenantA -lplatformId tenantA-M3PGGWCFX -taskId task001 
<?xml version="1.0" encoding="UTF-8"?>
<CancelErrorResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</CancelErrorResponse>

[Linux Manager]

# CancelError.sh -version 2.0 -locale en -userId user3 -password password -orgId tenantA -lplatformId tenantA-M3PGGWCFX -lserverId tenantA-M3PGGWCFX-S-0001 -taskId task001
<?xml version="1.0" encoding="UTF-8"?>
<CancelErrorResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</CancelErrorResponse>

Exit Status

This command returns the following values:

0: The command executed successfully.

non-zero: An error has occurred.