14.17 DestroySnapshot (Deletes Snapshots)

Name

[Windows Manager]
Installation_folder\RCXCFMG\bin\DestroySnapshot - Deletes Snapshots

[Linux Manager]
/opt/FJSVcfmg/bin/DestroySnapshot.sh - Deletes Snapshots

Synopsis

[Windows Manager]

DestroySnapshot -version version ID -locale the language for communicating -userId user ID -password password -orgId tenant name -lplatformId L-Platform ID -snapshotId snapshot ID

[Linux Manager]

DestroySnapshot.sh -version version ID -locale the language for communicating -userId user ID -password password -orgId tenant name -lplatformId L-Platform ID -snapshotId snapshot ID

Function description

This command deletes snapshots.

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.

-snapshotId: Specify the snapshot ID to delete.

Requirements

Permissions: User with OS administrator privilege

Location: Admin server

Example

[Windows Manager]

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

[Linux Manager]

# DestroySnapshot.sh -version 2.0 -locale en -userId user3 -password password -orgId tenantA -lplatformId tenantA-M3PGGWCFX -snapshotId snap01
<?xml version="1.0" encoding="UTF-8"?>
<DestroySnapshotResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</DestroySnapshotResponse>

Exit Status

This command returns the following values:

0: The command executed successfully.

non-zero: An error has occurred.