SnapCenter Software 4.9

to English version

概要

SnapCenter Serverを使用すると、アプリケーションをプラグインとしてSnapCenterに導入し、管理できます。 任意のアプリケーションをSnapCenter Serverに接続して、データの保護と 管理ができます。

SnapCenterでは、さまざまなプログラミング言語を使用してカスタム プラグインを開発できます。Perl、Java、バッチ、またはその他のスクリプト言語を使用してカスタム プラグインを開発できます。

SnapCenterでカスタム プラグインを使用するには、次のタスクを実行する必要があります。

  • このガイドの手順に従って、アプリケーション用のプラグインを作成する

  • 定義ファイルを作成する

  • SnapCenterホストにインストールするために、カスタム プラグインをエクスポートする

  • プラグインのzipファイルをSnapCenter Serverにアップロードする

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

API呼び出しでは必ず、次の情報を使用します。

  • プラグイン パラメーター

  • 終了コード

  • ログ エラー メッセージ

  • データの整合性

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

APIを呼び出すごとに、一連のパラメーターがプラグインに渡されます。次の表に、各パラメーターの具体的な情報を示します。

パラメーター 目的

アクション

ワークフロー名を指定します。例: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に渡されます。このメッセージには、メッセージ、ログ レベル、およびタイム スタンプが含まれます。

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

パラメーター 目的

情報

情報メッセージ

警告

警告メッセージ

エラー

エラー メッセージ

デバッグ

デバッグ メッセージ

トレース

トレース メッセージ

データの整合性の維持

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

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

Top of Page