本ページの製品は2024年4月1日より、エフサステクノロジーズ株式会社に統合となり、順次、切り替えを実施してまいります。一部、富士通表記が混在することがありますので、ご了承ください。
SnapCenter Software 5 マニュアル ( CA08871-403 )
SnapCenterのカスタム プラグイン
SnapCenterのカスタム プラグイン
Java、Perl、またはネイティブ形式で作成したカスタム プラグインをSnapCenter Serverを使用してホストにインストールし、アプリケーションのデータ保護を有効にできます。このチュートリアルで提供されている手順を使用してプラグインをSnapCenterホストにインストールするには、プラグインをエクスポートしておく必要があります。
プラグイン定義ファイルの作成
作成するプラグインすべてに、定義ファイルが必要です。定義ファイルには、プラグインの詳細が定義されています。ファイル名はPlugin_descriptor.xmlである必要があります。
プラグインdescriptorファイルの属性とその意味
| 属性 | 説明 |
|---|---|
名前 |
プラグインの名前。英数字を使用できます。例：DB2、MYSQL、MongoDB ネイティブ形式で作成されたプラグインの場合は、ファイルの拡張子を指定しないでください。たとえば、プラグイン名がMongoDB.shの場合は、名前をMongoDBと指定します。 |
バージョン |
プラグインのバージョン。メジャー バージョンとマイナー バージョンの両方を含めることができます。例：1.0、1.1、2.0、2.1 |
表示名 |
SnapCenter Serverに表示されるプラグイン名。同じプラグインを複数バージョン作成する場合は、表示名がすべてのバージョンで同じであることを確認してください。 |
プラグインタイプ |
プラグインの作成に使用した言語。サポートされている値は、Perl、Java、およびNativeです。 ネイティブ プラグイン タイプには、UNIX / Linuxシェル スクリプト、Windowsスクリプト、Python、またはその他のスクリプト言語が含まれます。 |
OS名 |
プラグインのインストール先ホストOSの名前。有効な値は、WindowsとLinuxです。1つのプラグインを複数のOSタイプに導入することができます（Perlタイプのプラグインなど）。 |
OSバージョン |
プラグインのインストール先ホストOSのバージョン。 |
リソース名 |
プラグインがサポートできるリソース タイプの名前。例：database、instance、collections。 |
Parent |
ResourceNameが別のリソース タイプに階層的に依存している場合は、Parentで親のResourceTypeを指定します。 たとえば、DB2プラグインはResourceNameが「Database」でParentが「Instance」です。 |
RequireFileSystemPlugin |
YesまたはNo。リカバリータブをリストア ウィザードに表示するかを指定します。 |
ResourceRequiresAuthentication |
YesまたはNo。リソースが自動検出されたかにかかわらず、ストレージの検出後にデータ保護処理を実行するためにクレデンシャルが必要かを指定します。 |
RequireFileSystemClone |
YesまたはNo。クローン ワークフローのために、プラグインでファイルシステム プラグインの統合が必要かを指定します。 |
カスタム プラグインDB2のPlugin_descriptor.xmlファイルの例を次に示します。
<Plugin> <SMSServer></SMSServer> <Name>DB2</Name> <Version>1.0</Version> <PluginType>Perl</PluginType> <DisplayName>Custom DB2 Plugin</DisplayName> <SupportedOS> <OS> <OSName>windows</OSName> <OSVersion>2012</OSVersion> </OS> <OS> <OSName>Linux</OSName> <OSVersion>7</OSVersion> </OS> </SupportedOS> <ResourceTypes> <ResourceType> <ResourceName>データベース</ResourceName> <Parent>インスタンス</Parent> </ResourceType> <ResourceType> <ResourceName>インスタンス</ResourceName> </ResourceType> </ResourceTypes> <RequireFileSystemPlugin>×</RequireFileSystemPlugin> <ResourceRequiresAuthentication>〇</ResourceRequiresAuthentication> <SupportsApplicationRecovery>〇</SupportsApplicationRecovery> </Plugin>
ZIPファイルの作成
プラグインを開発し、descriptorファイルを作成したら、プラグイン ファイルとPlugin_descriptor.xmlファイルをフォルダーに追加してzip圧縮します。
ZIPファイルを作成する前に、次の点を考慮する必要があります。
-
スクリプト名はプラグイン名と同じにする必要があります。
-
Perlプラグインの場合、ZIPフォルダーにスクリプト ファイル入りのフォルダーを含める必要があります。descriptorファイルはこのフォルダーの外に配置する必要があります。フォルダー名はプラグイン名と同じである必要があります。
-
Perlプラグイン以外のプラグインの場合は、ZIPフォルダーにdescriptorファイルとスクリプト ファイルを含める必要があります。
-
OSバージョンには数値を指定してください。
例：
-
DB2プラグイン：DB2.pmファイルとPlugin_descriptor.xmlファイルを「DB2.zip」に追加します。
-
Javaを使用して開発したプラグイン：jarファイル、依存するjarファイル、およびPlugin_descriptor.xmlファイルを1つフォルダーに追加してzip圧縮します。
プラグインZIPファイルのアップロード
プラグインを目的のホストに導入できるようにするには、プラグインZIPファイルをSnapCenter Serverにアップロードする必要があります。
UIまたはコマンドレットを使用してプラグインをアップロードできます。
UI：
-
[追加]または[Modify Host]ワークフロー ウィザードを通じてプラグインZIPファイルをアップロードします
-
[Select to upload custom plug-in]をクリックします
PowerShell：
-
Upload-SmPluginPackageコマンドレット
例：PS> Upload-SmPluginPackage -AbsolutePath c:\DB2_1.zip
PowerShellコマンドレットの詳細については、SnapCenterコマンドレットのヘルプを使用するか、コマンドレットのリファレンス情報を参照してください。
カスタム プラグインの導入
アップロードしたカスタム プラグインが、[追加]および[Modify Host]ワークフローを通じて目的のホストに導入できるようになりました。複数バージョンのプラグインをSnapCenter Serverにアップロードし、目的のバージョンを選んで特定のホストに導入できます。
プラグインをアップロードする方法の詳細については、「ホストの追加とリモート ホストへのプラグイン パッケージのインストール」を参照してください。
