パラメーター	目的
アクション	ワークフロー名を指定します。例：discover、backup、fileOrVolRestore、cloneVolAndLun
リソース	保護対象のリソースをリストにします。リソースはUIDとタイプで識別されます。リストは次の形式でプラグインに表示されます。「<UID>,<TYPE>;<UID>,<TYPE>」。次に例を示します。「Instance1,Instance;Instance2\\DB1,Database」
APP_NAME	使用しているプラグインを指定します。例：DB2、MYSQL。SnapCenter Serverには、リストされているアプリケーションのサポートが組み込まれています。このパラメーターでは大文字と小文字が区別されます。
APP_IGNORE_ERROR	（YまたはN）アプリケーションエラーが発生したときにSnapCenterが終了するか、終了しないかを指定します。複数のデータベースをバックアップしている途中で単一の障害が発生したときに、バックアップ処理を停止したくない場合に役立ちます。
<RESOURCE_NAME>__APP_INSTANCE_USERNAME	そのリソースに対してSnapCenterクレデンシャルが設定されます。
<RESOURCE_NAME>_APP_INSTANCE_PASSWORD	そのリソースに対してSnapCenterクレデンシャルが設定されます。
<RESOURCE_NAME>_<CUSTOM_PARAM>	各リソースレベルのカスタムキー値は、プラグインで、「<RESOURCE_NAME>_」というプレフィックスが付いた形式で使用できます。たとえば、「MASTER_SLAVE」というカスタムキーを「MySQLDB」という名前のリソースに設定した場合、MySQLDB_MASTER_SLAVEとして使用できます

パラメーター

目的

アクション

ワークフロー名を指定します。例：discover、backup、fileOrVolRestore、cloneVolAndLun

リソース

保護対象のリソースをリストにします。リソースはUIDとタイプで識別されます。リストは次の形式でプラグインに表示されます。

「<UID>,<TYPE>;<UID>,<TYPE>」。次に例を示します。「Instance1,Instance;Instance2\\DB1,Database」

APP_NAME

使用しているプラグインを指定します。例：DB2、MYSQL。SnapCenter Serverには、リストされているアプリケーションのサポートが組み込まれています。このパラメーターでは大文字と小文字が区別されます。

APP_IGNORE_ERROR

（YまたはN）アプリケーションエラーが発生したときにSnapCenterが終了するか、終了しないかを指定します。複数のデータベースをバックアップしている途中で単一の障害が発生したときに、バックアップ処理を停止したくない場合に役立ちます。

<RESOURCE_NAME>__APP_INSTANCE_USERNAME

そのリソースに対してSnapCenterクレデンシャルが設定されます。

<RESOURCE_NAME>_APP_INSTANCE_PASSWORD

そのリソースに対してSnapCenterクレデンシャルが設定されます。

<RESOURCE_NAME>_<CUSTOM_PARAM>

各リソースレベルのカスタムキー値は、プラグインで、「<RESOURCE_NAME>_」というプレフィックスが付いた形式で使用できます。たとえば、「MASTER_SLAVE」というカスタムキーを「MySQLDB」という名前のリソースに設定した場合、MySQLDB_MASTER_SLAVEとして使用できます

終了コードの使用

プラグインは、終了コードを使用して処理のステータスをホストに返します。各コードには特定の意味があり、プラグインは適切な終了コードを使用してその意味を示します。

次の表に、エラーコードとその意味を示します。

終了コード	目的
0	処理に成功しました。
99	要求された処理はサポートされていないか、実装されていません。
100	処理に失敗しました。休止解除をスキップして終了します。デフォルトは休止解除です。
101	処理に失敗しました。バックアップ処理を続行します。
その他	処理に失敗しました。休止解除を実行して終了します。

ログエラーメッセージ

エラーメッセージは、プラグインからSnapCenter Serverに渡されます。このメッセージには、メッセージ、ログレベル、およびタイムスタンプが含まれます。

次の表に、レベルとその目的を示します。

パラメーター	目的
情報	情報メッセージ
警告	警告メッセージ
エラー	エラーメッセージ
デバッグ	デバッグメッセージ
トレース	トレースメッセージ

パラメーター

目的

情報

情報メッセージ

警告

警告メッセージ

エラー

エラーメッセージ

デバッグ

デバッグメッセージ

トレース

トレースメッセージ

データの整合性の維持

カスタムプラグインでは、同じワークフロー実行の処理間でデータが保持されます。たとえば、プラグインでは、休止の終了時にデータを保存し、休止解除処理中にこのデータを使用できます。

保持するデータは、プラグインによって結果オブジェクトの一部として設定されます。結果オブジェクトは特定のフォーマットに従います。詳しくは、各プラグイン開発スタイルで説明しています。

SnapCenter Software 5 マニュアル ( CA08871-403 )

概要

すべてのAPI呼び出しでの一般的なプラグイン処理

プラグイン パラメーターの使用

終了コードの使用

ログ エラー メッセージ

データの整合性の維持

プラグインパラメーターの使用

ログエラーメッセージ