Download Job API Tandem 1.5 - 取扱説明書

取扱説明書 - 日本語
FUJITSU Software ServerView Suite
Server Management
Job API Tandem 1.5
2010 年 2 月版
製品名称の表記
本書では、本文中の製品名称を、次のように略して表記します。
製品名称
Microsoft®
Windows
Server®
本文中の表記
2008 Standard
Microsoft® Windows Server® 2008 Enterprise
Microsoft® Windows Server® 2008 Datacenter
Microsoft® Windows Server® 2008 Foundation
Windows Server 2008
Microsoft® Windows® Small Business Server 2008 Standard
Microsoft® Windows® Small Business Server 2008 Premium
Microsoft® Windows Server® 2008 R2 Standard
Microsoft® Windows Server® 2008 R2 Enterprise
Microsoft® Windows Server® 2008 R2 Datacenter
Microsoft® Windows Server® 2008 R2 Foundation
Windows Server 2008
R2
Microsoft® Windows® Web Server 2008 R2
Microsoft® Windows Server® 2003, Standard Edition
Microsoft® Windows Server® 2003, Enterprise Edition
Microsoft® Windows Server® 2003, Enterprise Edition for
Itanium-based Systems
Windows Server 2003
Microsoft® Windows® Small Business Server 2003
Microsoft® Windows Server® 2003, Standard x64 Edition
Microsoft® Windows Server® 2003, Enterprise x64 Edition
Windows Server 2003
x64
Microsoft® Windows Server® 2003 R2 Standard Edition
Microsoft® Windows Server® 2003 R2 Enterprise Edition
Microsoft® Windows® Small Business Server 2003 R2
Microsoft® Windows® Storage Server 2003 R2, Standard
Edition
Microsoft® Windows Server® 2003 R2 Standard x64 Edition
Microsoft® Windows Server® 2003 R2 Enterprise x64
Edition
Windows Server 2003
R2
Windows Server 2003
R2 x64 または
Windows Server 2003
R2
Windows
製品名称
Red Hat Enterprise Linux 5
Red Hat Enterprise Linux AS（v.4）
Red Hat Enterprise Linux ES（v.4）
本文中の表記
Red Hat Linux
RHEL5
RHEL4
SuSE Linux
SUSE Linux Enterprise Server 11
Linux
SuSE Linux SLES11
または SLES11
SUSE Linux Enterprise Server 10
SuSE Linux SLES10
または SLES10
VMware ESX 4
ESX4
VMware ESX 3.5
ESX3.5
VMware
著作権および商標
Copyright © 2010 Fujitsu Technology Solutions GmbH.
All rights reserved
Microsoft、Windows、Windows Server、Hyper-V は、米国 Microsoft Corporation の米国お
よびその他の国における登録商標または商標です。
Linux は、Linus Torvalds 氏の米国およびその他の国における登録商標あるいは商標です。
Red Hat および Red Hat をベースとしたすべての商標とロゴは、米国およびその他の国にお
ける Red Hat, Inc. の商標または登録商標です。
BrightStor, ARCserve は、CA, Inc の登録商標です。
VMware、VMware ロゴ、VMware ESXi、VMware SMP および VMotion は VMware,Inc の米
国およびその他の国における登録商標または商標です。
その他の各製品名は、各社の商標、または登録商標です。
その他の各製品は、各社の著作物です。
目次
1
はじめに . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.1
本書の適用範囲 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.2
本書の表記について . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2
アーキテクチャ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3
セキュリティ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
4
API クライアント／サーバ関数フロー . . . . . . . . . . . . . . . . . . . . 15
4.1
インストール、イメージ作成の使用例 . . . . . . . . . . . . . . . . . . . . 15
5
API 関数クラス . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
5.1
関数の概要 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
5.2
データの種類 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
5.3
5.3.1
5.3.2
5.3.3
API 管理 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetAPIVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetAPIinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateUserKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
28
28
29
32
5.4
5.4.1
5.4.2
5.4.3
5.4.4
5.4.5
5.4.6
5.4.7
5.4.8
5.4.9
サーバ／ノードリスト管理 . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AddServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ChangeServerConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . .
StartSystemInfoRetrieval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetSystemInfoResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RdDeplServerList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ImportDeploymentConfiguration . . . . . . . . . . . . . . . . . . . . . . . . .
ExportDeploymentConfiguration . . . . . . . . . . . . . . . . . . . . . . . . .
SetUserKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RemoveUserKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
33
33
40
45
48
49
55
57
59
60
Job API Tandem
目次
5.5
5.5.1
5.5.2
5.5.3
5.5.4
電源管理 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetPower . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetPXEBootImage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetPower . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetBootMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
61
61
65
68
70
5.6
5.6.1
5.6.2
5.6.3
5.6.4
5.6.5
5.6.6
5.6.7
5.6.8
5.6.9
リポジトリ管理 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AddRepository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RemoveRepository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetRepositoryList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateImage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteImage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetRepositoryContents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ReadImagefilenameList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ReadImageInfoText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetImageProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
72
74
76
77
79
87
88
90
91
92
5.7
5.7.1
5.7.2
5.7.3
ディレクトリ管理 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetDirectoryContents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
93
93
95
97
5.8
5.8.1
5.8.2
5.8.3
5.8.4
5.8.5
5.8.6
5.8.7
5.8.8
5.8.9
5.8.10
グループ管理 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
CreateGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
DeleteGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
GetGroupList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
SetGroupProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
GetGroupProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
AddGroupMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
RemoveGroupMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
GetGroupMemberList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
SetGroupMemberProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
GetGroupMemberProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
5.9
5.9.1
デプロイメント管理 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Deploy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
5.10
5.10.1
5.10.2
5.10.3
5.10.4
5.10.5
5.10.6
ジョブ管理 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetJobStatusDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetServerJobStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CancelJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetScheduledJobProperties . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetScheduledJobLogList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteScheduledJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
130
131
134
137
139
141
143
Job API Tandem
目次
6
ジョブスケジューリング . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
7
API エラーコード . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
8
インストール . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
8.1
システム要件 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
8.2
インストール . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
8.3
8.3.1
JobAPI と Internet Information Server (IIS) . . . . . . . . . . . . . . 158
Windows Server 2003 での JobAPI と Internet Information
Server (IIS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Windows Server 2008 での JobAPI と Internet Information
Server (IIS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
8.3.2
8.4
インストールテスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
9
その他の情報 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
9.1
URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
9.2
HTTP 認証 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
9.3
HTTPS / SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
9.4
SOAP タイムアウト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
9.5
9.5.1
9.5.2
CGI タイムアウト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Apache 構成 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
IIS 構成 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
9.6
SOAP エラーの対処方法 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
9.7
9.7.1
9.7.2
SOAP デバック . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Job API クライアント . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Job API サーバ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Job API Tandem
目次
10
Job API クライアントの開発 . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
10.1
C/C++ スタブの生成 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
10.2
生成された C/C++ スタブの使用 . . . . . . . . . . . . . . . . . . . . . . . . 177
索引 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Job API Tandem
1
は じ めに
Tandem は、 ServerView Suite の強力な リ モー ト イ ン タ フ ェ ース です。
Tandem に含まれている主要な API パ ッ ケージは次の 2 つです。
– central NodeList API （まだ リ リ ース さ れていません）
– central Job API
Job API および NodeList API は、 SOAP に基づいた Web サービ ス と し て実行
さ れます。 Simple Object Access Protocol （SOAP） は XML ベースの メ ッ
セージ プ ロ ト コ ルです。 RPC 式の要求応答ダ イ ア ログ を実行する ために使用
する構成 メ ッ セージに対 し 、 一連の規則を定義 し ます。 SOAP メ ッ セージは
OS、 プ ログ ラ ム言語、 または ト ラ ン スポー ト プ ロ ト コ ルに依存 し ません。 し
たが っ て、 要求応答ダ イ ア ログ内の ク ラ イ ア ン ト と サーバは、 SOAP メ ッ
セージの準備 と 処理がで き る限 り 、 どんな プ ラ ッ ト フ ォ ーム上で も 動作 し 、
どんな言語で も 書き込む こ と がで き ます。
Job API Tandem は、 Deployment Manager フ ロ ン ト エ ン ド が提供する関数の
ほ と んど を提供する よ う に設計 さ れています。 Job API を使 っ て単一の、 ま
たはグループ化 さ れたサーバの準備、 イ ン ス ト ール、 および ク ローニ ン グが
で き ます。 Job API は ServerView Deployment Manager サービ スに対 し て
ジ ョ ブ を提示 し ます。
Job API 関数 ク ラ スのサーバ／ ノ ー ド リ ス ト の管理には関数が含まれていま
す。 その関数を使 っ て、 ServerView Suite ソ フ ト ウ ェ ア で管理 さ れている管
理サーバすべての物理ビ ュ ーを含んだ集中 ServerView サーバ リ ス ト を操作 し
ます。 そのため、 こ れま で ServerView によ り 管理 さ れていなかっ たベアサー
バを追加で き ます。 Nodelist API が リ リ ース さ れる ま では、 サーバ／ ノ ー ド
リ ス ト の管理が代用の関数を提供 し ます。
Job API は Deployment Manager CD に収録 さ れている独立 し た イ ン ス ト ール
パ ッ ケージ です。
1.1
本書の適用範囲
本書は Job API Tandem のパ ラ メ ー タ と 様々な関数で予測 さ れる動作につい
て説明 し ます。 本書は、 LAN 上か ら リ モー ト で、 または第三者の ソ フ ト ウ ェ
ア を使っ て富士通サーバ管理関数を使用 し たいプ ログ ラ マーを対象 と し てい
ます。
Job API Tandem
9
1 は じ めに
1.2
本書の表記について
本書の表記方法は次の と お り です。
IP ア ド レ スは、 標準的な形式 「XXX.XXX.XXX.XXX」 を使 っ て表記 し ます。
すなわち、 32 ビ ッ ト 整数は、 点で区切 ら れた 0 から 255 ま での 10 進数を 4
つ使用 し て指定 し ます （RFC791）。
有効な GUID 形式は 「XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX」
です。 X には 16 進法の数字 （0,1,2,3,4,5,6,7,8,9,A,B,C,D,E,F） が入 り ます。
関数内の MAC ア ド レ スは形式 「AA-BB-CC-DD-EE-FF」 を使 っ て返 さ れま
す。 入力パラ メ ー タ と し て MAC ア ド レ スが必要な場合はいつで も こ の 「AABB-CC-DD-EE-FF」 形式を使 っ て追加で き ます。 大文字、 小文字を区別する
必要はあ り ません。
10
Job API Tandem
2
アーキテ ク チ ャ
次の図は、 Tandem の Job API および NodeList API パ ッ ケージ と 組み合わせ
た ServerView Suite のサーバ管理に関する概要を示 し ます。
図 1: アーキテ ク チ ャ
Job API Tandem
11
2 アーキテ ク チ ャ
12
Job API Tandem
3
セキ ュ リ テ ィ
現行の Job API サービ スは CGI ベースの Web ア プ リ ケーシ ョ ン と し て実現
さ れます。 原則 と し て、 Web サーバの視点か らみた CGI の動作 と は、 特定の
Web サービ スが定義 さ れ、 CGI ア プ リ ケーシ ョ ン によ り 提供 さ れる も ので
す。 Web サーバへの要求を受け取る と 、 ク ラ イ ア ン ト が入力値 と し て送信 し
たデー タ と と も に、 CGI ア プ リ ケーシ ョ ンが呼び出 さ れます。 最終的には、
CGI ア プ リ ケーシ ョ ンか ら の出力は Web サーバによ っ て収集 さ れ、 ク ラ イ ア
ン ト へ返信 さ れます。
こ の機能に よ り 、 SOAP メ ッ セージに含まれている情報はク ラ イ ア ン ト と
Web サーバ間のみで傍受 さ れます。 最下層では、 SOAP メ ッ セージが
HTTPS へ渡 さ れます。 HTTPS は通信に SSL を使用する ため、 ス ヌ ーピ ング
を防ぐ目的で メ ッ セージ内容は暗号化 さ れ、 ク ラ イ ア ン ト と サーバはお互い
の身元を確認 し ます。 し たが っ て、 Web サーバ と Job API ク ラ イ ア ン ト
（CGI ベースの Web ア プ リ ケーシ ョ ン その も のではあ り ません） に対 し て
HTTPS/SSL サポー ト を設定する必要があ り ます。
Job API Tandem
13
3 セキ ュ リ テ ィ
14
Job API Tandem
4
API ク ラ イ アン ト ／サーバ関数フ ロー
一般的に コ ン ピ ュ ー タ サイ エ ン ス では、 プ ロ ト コ ル と は、 フ ォ ーマ ッ ト 、 内
容、 目的、 および 2 つのエ ン ド ポ イ ン ト 間の通信シーケ ン ス を特定する一連
の規則であ る と 説明 さ れています。 し たが っ て、 Job API ク ラ イ ア ン ト と Job
API サーバ間の情報交換を プ ロ ト コ ル と し て解釈で き ますが、 ク ラ イ ア ン ト
／サーバ間の通信は Job API 仕様内で関数 フ ロー と し て定義 さ れ、 関数を呼
び出す順序は設定 さ れません。 ただ し 、 最初に Job API ク ラ イ ア ン ト に対 し
て有効なユーザキーを作成する必要があ り ます。 ユーザキーは何度で も 作成
で き ますが、 毎回新 し い も のを作成する必要はな く 、 Job API ク ラ イ ア ン ト
に対 し ては 1 回のみでかまいません。
次の節で、 Job API 関数の用途 と 正 し いシーケ ン スについて説明 し ます。
4.1
イ ン ス ト ール、 イ メ ージ作成の使用例
最初の使用例は、 対象シ ス テムのイ ン ス ト ールおよび他のサーバへのデプ ロ
イ メ ン ト に使用する イ メ ージの作成に関 し て説明 し ます。
前述の と お り 、 Job API 関数すべて を使用するには、 有効なユーザキーを作
成する必要があ り ます。 すべての関数を使用する ためには、 UserKey が必要
で、 こ のパ ラ メ ー タ で有効なユーザキーを指定する必要 も あ り ます。 通常、
サーバ リ ス ト にあ るすべてのサーバは、 種類にかかわ ら ず Job API 上で管理
で き ます。 し か し 、 ServerView に よ り 検出 さ れたサーバ、 および AddServer
によ り 新 し く 追加 さ れたベアサーバの一覧を取得するには、 関数
RdDeplServerList を使用 し ます。
Job API Tandem
15
4 API ク ラ イ ア ン ト ／サーバ関数 フ ロー
16
Job API Tandem
4.1 イ ン ス ト ール、 イ メ ージ作成の使用例
例えば、 対象シ ス テム と し て新 し いベアサーバを イ ン ス ト ールするには、 コ
ン フ ィ グ レーシ ョ ン フ ァ イルのパス をパラ メ ー タ と し て直接指定する、 また
はイ ン ス ト ールグループ を作成 し ます。 イ ン ス ト ールグループ を作成 し た場
合、 グループ メ ンバ固有のプ ロパテ ィ は、 あ ら か じ め Installation Manager で
定義 さ れた コ ン フ ィ グ レーシ ョ ン フ ァ イルのパスにな り ます。
Installation Manager は deploy の呼び出 し によ っ て指定 し たグループ内、 また
はサーバのサブグループ内のサーバ （パラ メ ー タ ServerIdList を ご覧 く だ さ
い） のど ち ら かを イ ン ス ト ール し ます。 イ ン ス ト ール作業が完了 し た後
（GetJobStatusDetails を使 っ てジ ョ ブの状態をポー リ ング し ます）、 他のサーバ
へデプ ロ イ メ ン ト する ために、 イ ン ス ト ール さ れた対象シ ス テムのイ メ ージ
が作成 さ れます。 Job API と Deployment Manager は リ ポジ ト リ 内にあ る利
用可能なすべてのイ メ ージ を管理 し ます。 つま り 、 新 し い ク ローニ ング イ
メ ージ を可視化するには、 AddRepository を使 っ て
REPOSITORYTYPE_CLONING タ イ プの新 し い リ ポジ ト リ を リ ポジ ト リ 管理へ
追加 し ます。
基本的に、 各サーバは様々な Job API ク ラ イ ア ン ト や Deployment Manager
フ ロ ン ト エ ン ド に よ っ て管理 さ れる ため、 SetUserKey を使用 し てサーバ専用
のユーザキーを設定 し てお く こ と を推奨 し ます。 イ ン ス ト ール と イ メ ージ作
成作業が正常に完了 し た後、 こ の対象シ ス テムの専用設定を必ず削除 し て く
だ さ い。 削除は関数 RemoveUserKey を使っ て実行 し ます。
Job API Tandem
17
4 API ク ラ イ ア ン ト ／サーバ関数 フ ロー
18
Job API Tandem
4.1 イ ン ス ト ール、 イ メ ージ作成の使用例
Job API Tandem
19
4 API ク ラ イ ア ン ト ／サーバ関数 フ ロー
20
Job API Tandem
5
API 関数 ク ラ ス
次の章では、 Job API の様々な関数のパラ メ ー タ と 予測 さ れる動作に関する
非公式な説明を記載 し ます。 すべてのパラ メ ー タ は SOAP/XML で暗号化 さ れ
ます。
5.1
関数の概要
次の表では、 実装 さ れている関数の概要を示 し ます。
API 管理
GetAPIVersion
Job API のバージ ョ ンに関する情報を返 し ます。 28
ページ を ご覧 く だ さ い。
GetAPIInfo
Job API と 使用可能なデプ ロ イ メ ン ト エ ン ジ ン に関
する詳細情報を返 し ます。 29 ページ を ご覧 く だ さ
い。
CreateUserKey
特有のユーザキーを作成 し ます。 32 ページ を ご覧 く
だ さ い。
サーバ／ ノ ー ド リ ス ト 管理
AddServer
指定 し たデプ ロ イ メ ン ト 構成を使 っ て新 し いサーバ
を追加 し ます。 33 ページ を ご覧 く だ さ い。
ChangeServerConfigura 指定 し たサーバのデプ ロ イ メ ン ト 構成設定を変更 し
tion
ます。 40 ページ を ご覧 く だ さ い。
StartSystemInfoRetrieval 指定 し たサーバから シ ス テム情報の詳細を取得する
ジ ョ ブ を起動 し ます。 45 ページ を ご覧 く だ さ い。
GetSystemInfoResult
指定 し たサーバから シ ス テム情報の詳細を返 し ま
す。 48 ページ を ご覧 く だ さ い。
RdDeplServerList
デプ ロ イ メ ン ト テーブルにあ る使用可能なサーバす
べての一覧を返 し ます。 49 ページ を ご覧 く だ さ い。
ImportDeploymentConfi デプ ロ イ メ ン ト テーブルを XML 文書形式で イ ン
guration
ポー ト し ます。 55 ページ を ご覧 く だ さ い。
ExportDeploymentConfi デプ ロ イ メ ン ト テーブルを XML 文書形式で エ ク ス
guration
ポー ト し ます。 57 ページ を ご覧 く だ さ い。
Job API Tandem
21
5 API 関数 ク ラ ス
SetUserKey
所定のユーザキーに対 し て 1 つ以上のサーバを予約
し ます。 59 ページ を ご覧 く だ さ い。
RemoveUserKey
指定 し たサーバのユーザ予約を削除 し ます。 60 ペー
ジ を ご覧 く だ さ い。
電源管理
SetPower
サーバの電源を投入、 または切断 し ます。 61 ページ
を ご覧 く だ さ い。
SetPXEBootImage
TFTP サーバ上の所定ブー ト イ メ ージ を設定 し 、 そ
のサーバで PXE ブー ト が行え る よ う に し ます。 65
ページ を ご覧 く だ さ い。
GetPower
サーバの電源ス イ ッ チに対する現在の設定を判断 し
ます。 68 ページ を ご覧 く だ さ い。
GetBootMode
サーバの現在のブー ト モー ド を取得 し ます。 70 ペー
ジ を ご覧 く だ さ い。
22
Job API Tandem
5.1 関数の概要
リ ポジ ト リ 管理
AddRepository
新 し い リ ポジ ト リ を追加 し ます。 74 ページ を ご覧 く
だ さ い。
RemoveRepository
指定 し た リ ポジ ト リ を削除 し ます。 76 ページ を ご覧
く だ さ い。
GetRepositoryList
すべての リ ポジ ト リ または、 任意 タ イ プの リ ポジ ト
リ に関する詳細情報を一覧で返 し ます。 77 ページ を
ご覧 く だ さ い。
CreateImage
複数の対象シ ス テムのデプ ロ イ メ ン ト に対 し て使用
可能な イ メ ージ を作成 し ます。 79 ページ を ご覧 く だ
さ い。
DeleteImage
既存のイ メ ージ フ ァ イルを削除 し ます。 87 ページ を
ご覧 く だ さ い。
GetRepositoryContents
指定 し た リ ポジ ト リ 、 または指定 し た種類のすべて
の リ ポジ ト リ 内で検出 さ れた イ メ ージ フ ァ イル名の
一覧を返 し ます。 88 ページ を ご覧 く だ さ い。
ReadImagefilenameList 既知 リ ポジ ト リ すべて で検出 さ れた イ メ ージ フ ァ イ
ル名の一覧を返 し ます。 90 ページ を ご覧 く だ さ い。
ReadImageInfoText
指定 し た イ メ ージの info テキス ト を返 し ます。 91
ページ を ご覧 く だ さ い。
GetImageProperties
所定イ メ ージのプ ロパテ ィ を XML 文書形式で返 し
ます。 92 ページ を ご覧 く だ さ い。
デ ィ レ ク ト リ 管理
CreateDirectory
新 し いデ ィ レ ク ト リ を作成 し ます。 93 ページ を ご覧
く だ さ い。
DeleteDirectory
デ ィ レ ク ト リ を削除 し ます。 95 ページ を ご覧 く だ さ
い。
GetDirectoryContents
指定 し たデ ィ レ ク ト リ に含まれている既知フ ァ イル
すべて を一覧で返 し ます。 97 ページ を ご覧 く だ さ
い。
Job API Tandem
23
5 API 関数 ク ラ ス
グループ管理
CreateGroup
指定 し た種類の新 し いグループ を作成 し ます。
100 ページ を ご覧 く だ さ い。
DeleteGroup
指定 し たグループ を削除 し ます。 102 ページ を
ご覧 く だ さ い。
GetGroupList
既知グループすべて を一覧で返 し ます。 103
ページ を ご覧 く だ さ い。
SetGroupProperties
所定のグループに対 し て、 指定 し たグループの
プ ロパテ ィ 値を設定 し ます。 105 ページ を ご覧
く だ さ い。
GetGroupProperties
使用可能なグループのプ ロパテ ィ と その値に関
する情報を返 し ます。 107 ページ を ご覧 く だ さ
い。
AddGroupMember
所定グループに新 し いサーバを追加 し ます。 108
ページ を ご覧 く だ さ い。
RemoveGroupMember
所定グループから 、 指定 し たサーバを削除 し ま
す。 110 ページ を ご覧 く だ さ い。
GetGroupMemberList
指定 し たグループに所属する既知 メ ンバを一覧
で返 し ます。 111 ページ を ご覧 く だ さ い。
SetGroupMemberProperties 指定 し たグループ メ ンバのプ ロパテ ィ を指定値
へ設定 し ます。 113 ページ を ご覧 く だ さ い。
GetGroupMemberProperties 使用可能なサーバプ ロパテ ィ と その値に関する
情報を返 し ます。 115 ページ を ご覧 く だ さ い。
デプ ロ イ メ ン ト 管理
Deploy
24
指定 し た対象サーバをデプ ロ イ メ ン ト し 、 また
こ れ ら サーバのブー ト を開始 し ます。 118 ページ
を ご覧 く だ さ い。
Job API Tandem
5.1 関数の概要
ジ ョ ブ管理
GetJobStatusDetails
所定の JobID を使 っ て現在のジ ョ ブ状態 と 詳細を返
し ます。 131 ページ を ご覧 く だ さ い。
GetServerJobStatus
所定のサーバ識別子 リ ス ト を使 っ て現在のジ ョ ブ状
態を返 し ます。 134 ページ を ご覧 く だ さ い。
CancelJob
実行中のジ ョ ブ をキ ャ ン セル し ます。 137 ページ を
ご覧 く だ さ い。
DeleteScheduledJob
所定の ScheduledJobID を使 っ て既存のスケジ ュ ー
ルジ ョ ブ を削除 し ます。 143 ページ を ご覧 く だ さ い。
GetScheduledJobProper 所定のスケジ ュ ールジ ョ ブのプ ロパテ ィ すべて を返
ties
し ます。 139 ページ を ご覧 く だ さ い。
GetScheduledJobIDList 所定のスケジ ュ ールジ ョ ブの中で実行中または実行
済みであ る ジ ョ ブの一覧を返 し ます。 141 ページ を
ご覧 く だ さ い。
Job API Tandem
25
5 API 関数 ク ラ ス
5.2
デー タ の種類
本書で使用 し ている一般的なデー タ の種類は次の と お り です。
種類
説明
string
アル フ ァ ベ ッ ト や数値を含む文字列です。
int
整数です。
long
長整数です。
表 1: デー タ の種類
ArrayOf_PropertyData 構造体のレ イ アウ ト
プ ロパテ ィ の構造体のレ イ アウ ト は次の と お り です。
Name
プ ロ パテ ィ の既知名を指定 し ます。
Value
指定 し たプ ロ パテ ィ の値を設定 し ます。
ServerIdentifier 構造体のレ イ アウ ト
サーバを判別するには、 サーバの MAC ア ド レ ス、 IP ア ド レ ス または、 ホス
ト 名を指定 し ます。 次の構造体を使っ てサーバの種類から 、 サーバを判別 し
ます。
Identifier=<string> Type=<int>
Identifier
既知サーバ特有の識別子を含む文字列です。
Type
識別子の種類です。
0 (IDENTIFIERTYPE_MAC): ネ ッ ト ワ ー ク イ ン タ フ ェ ース の物理ア ド レ
ス です。
1 (IDENTIFIERTYPE_IP): サーバの IP ア ド レ ス です。 こ れは、
RdDeplServerList に よ り 返 さ れた SV_IPAddress であ る 必要があ り ます。
2 (IDENTIFIERTYPE_NAME): サーバのホ ス ト 名です。 こ れは、
RdDeplServerList に よ り 返 さ れた ServerName であ る 必要があ り ます。
26
Job API Tandem
5.2 デー タ の種類
ArrayOf_ParameterData 構造体のレ イ アウ ト
次の構造体はパラ メ ー タ を指定 し ます。
Name=<string> Value=<string>
Name
パ ラ メ ー タ の名前です。
Value
該当す る パ ラ メ ー タ 名の値です。
Job API Tandem
27
5 API 関数 ク ラ ス
5.3
API 管理
Job API 関数 ク ラ スの 「API 管理」 は、 Job API の使用を管理する ため、 つま
り Job API Web サービ スや使用 さ れているデプ ロ イ メ ン ト エ ン ジ ンに関する
情報を取得する ために使用 し ます。
5.3.1
GetAPIVersion
関数 GetAPIVersion を使っ て、 Job API サービ スが提供する最新の API バー
ジ ョ ン を API の呼び出 し 元へ通知 し ます。
構文
GetAPIVersion UserKey=<string>
パラ メ ー タ
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
APIVersion
Job API の現在のバージ ョ ンです （例 ： 1.5）。
28
Job API Tandem
5.3 API 管理
5.3.2
GetAPIinfo
GetAPIVersion が返すバージ ョ ン情報 と は別に、 GetAPIInfo は Job API やデプ
ロ イ メ ン ト 環境についての詳細 （例 ： ビル ド 番号、 使用可能なデプ ロ イ メ ン
ト エ ン ジ ン な ど） を取得 し ます。
I こ の関数を使用するには、 Deployment Manager が必要です。
構文
GetAPIInfo
DeploymentEngines= <ArrayOf_DeploymentEngineIdentifier>
RDServer=<string>
UserKey=<string>
APIProperties=<ArrayOf_PropertyData>
DeploymentEngineProperties=<ArrayOf_DeploymentEngineData>
パラ メ ー タ
Deployment Engines
現在のエ ン ジ ンプ ロ パテ ィ を返すために確認す る デプ ロ イ メ ン ト エン
ジ ン を指定 し ます。 構造体に関す る 詳細は、 30 ページの " デプ ロ イ メ
ン ト エン ジ ン識別子の構造体レ イ ア ウ ト " を ご覧 く だ さ い。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
APIProperties
Job API プ ロ パテ ィ すべての配列 （例 ： BuildNumber） を返 し ます。 構
造体に関す る詳細は、 26 ページの "ArrayOf_PropertyData 構造体の レ イ
ア ウ ト " を ご覧 く だ さ い。
DeploymentEngineProperties
指定 さ れたデプ ロ イ メ ン ト エ ン ジ ン （例 ： Installation Manager） の状態
を返 し ます。 構造体に関す る 詳細は、 31 ページの " デプ ロ イ メ ン ト エ
ン ジ ンデー タ の構造体レ イ ア ウ ト " を ご覧 く だ さ い。
Job API Tandem
29
5 API 関数 ク ラ ス
デプ ロ イ メ ン ト エ ン ジ ン識別子の構造体レ イ アウ ト
デプ ロ イ メ ン ト エ ン ジ ン識別子の構造体には、 デプ ロ イ メ ン ト エ ン ジ ンに関
する詳 し い接続情報が含まれています。 こ の構造体のレ イ アウ ト は次の と お
り です。
ServerId=<ServerIdentifier> Type=<int> Username=<string>
Password=<string>
ServerId
エン ジ ンが イ ン ス ト ール さ れてい る サーバの名前です。 構造体に関す
る 詳細は、 26 ページの "ServerIdentifier 構造体の レ イ ア ウ ト " を ご覧 く
だ さ い。
Type
デプ ロ イ メ ン ト エ ン ジ ンの種類です。
1: (DEPLOYMENTENGINE_SCW)
2: (DEPLOYMENTENGINE_INSTALLATIONMANAGER)
3: (DEPLOYMENTENGINE_DEPLOYMENTMANAGER)
Username
指定 し たエ ン ジ ンのユーザア カ ウ ン ト 名です。 こ のパ ラ メ ー タ は必須
です。
Password
指定 し たユーザア カ ウ ン ト に対す る パ ス ワー ド です。 こ のパ ラ メ ー タ
は必須です。
30
Job API Tandem
5.3 API 管理
デプ ロ イ メ ン ト エ ン ジ ンデー タ の構造体レ イ アウ ト
デプ ロ イ メ ン ト エ ン ジ ンデー タ の構造体には、 指定 し た複数のエ ン ジ ン に関
する リ タ ーン情報が含まれています。 こ の構造体のレ イ アウ ト は次の と お り
です。
ServerId=<ServerIdentifier> Type=<int> Properties=
<ArrayOfPropertyData>
ServerId
エ ン ジ ンが イ ン ス ト ール さ れてい る サーバを表示 し ます。 構造体に関
す る 詳細は 26 ページの "ServerIdentifier 構造体の レ イ ア ウ ト " を ご覧
く だ さ い。
Type
デプ ロ イ メ ン ト エ ン ジ ンの種類を表示 し ます。
1: (DEPLOYMENTENGINE_SCW)
2: (DEPLOYMENTENGINE_INSTALLATIONMANAGER)
3: (DEPLOYMENTENGINE_DEPLOYMENTMANAGER)
Properties
指定 し たデプ ロ イ メ ン ト エン ジ ンのプ ロ パテ ィ を表示 し ます。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
Job API Tandem
31
5 API 関数 ク ラ ス
5.3.3
CreateUserKey
関数 CreateUserKey 指定 し たユーザア カ ウ ン ト 専用のユーザキーを作成 し ま
す。 Job API を使 っ て作業するには、 こ の有効なユーザキーが必要です。
構文
CreateUserKey Username=<string> Password=<string>
パラ メ ー タ
Username
Deployment Admins グループに含まれ る ユーザア カ ウ ン ト 名を指定 し ま
す。
Password
指定 し たユーザア カ ウ ン ト に対す る パ ス ワー ド を指定 し ます。
I パラ メ ー タ username および password の長 さ と 形式は OS によ っ て異な
り ます。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
UserKey
指定 し たユーザア カ ウ ン ト 専用のユーザキーです。
32
Job API Tandem
5.4 サーバ／ ノ ー ド リ ス ト 管理
5.4
サーバ／ ノ ー ド リ ス ト 管理
サーバ／ ノ ー ド リ ス ト 管理は ServerView に よ り 検出 さ れたサーバや、
Deployment Manager または Job API によ り 追加 さ れたサーバに関する構成、
状態、 またその他の情報を提供 し ます。 こ れ ら サーバは、 サーバの種類にか
かわ ら ず Job API に よ っ て管理 さ れます。
5.4.1
AddServer
Job API の関数 AddServer を使 っ て、 新 し いベアサーバに対する構成設定 （指
定 し たデプ ロ イ メ ン ト 構成を使 っ て） を手動で入力 し ます。
構文
AddServer Hostname=<string> GUID=<string>
NetworkInterface=<ArrayOf_NetworkInterfaceData>
PXEBootInterface=<int>
Params=<ArrayOf_ParameterData>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
Hostname
指定 し たサーバの新 し い名前を指定 し ます。 こ のサーバを イ ン ス ト ー
ルす る、 ま たは イ メ ージでデプ ロ イ メ ン ト す る 場合、 こ の新 し い名前
は新規サーバのホ ス ト 名 と し て使用 さ れます。
こ のパ ラ メ ー タ は必須です。
GUID
グ ロ ーバル一意識別子を指定 し ます。
デフ ォ ル ト 値 ： 00000000-0000-0000-000000000000
NetworkInterface
新 し いサーバのネ ッ ト ワ ー ク イ ン タ フ ェース に関す る 詳細が含まれて
い る NetworkInterfaceData タ イ プの構造体の配列を指定 し ます。 ネ ッ ト
ワー ク 構成に関す る詳細は、 35 ページの "NetworkInterfaceData 構造体
の レ イ ア ウ ト " を ご覧 く だ さ い。
Job API Tandem
33
5 API 関数 ク ラ ス
PXEBootInterface
PXE ブー ト （ ク ロ ーニ ン グお よ び イ ン ス ト ール用） に使用す る ネ ッ ト
ワ ー ク イ ン タ フ ェ ース の イ ン タ フ ェース イ ンデ ッ ク ス （1 で始ま る）
を指定 し ます。 PXE ブー ト を使用す る ネ ッ ト ワ ー ク イ ン タ フ ェ ース を
1 つ指定す る ためには、 こ のパ ラ メ ー タ を必ず指定 し て く だ さ い。
Params
ParameterData タ イ プの構造体の配列を指定 し ます。 使用可能なパ ラ
メ ー タ に関す る 詳細は、 37 ページの " 使用可能なパ ラ メ ー タ の表 " を
ご覧 く だ さ い。 ま た、 パ ラ メ ー タ の構造体に関 し ては、 27 ページの
"ArrayOf_ParameterData 構造体の レ イ ア ウ ト " を ご覧 く だ さ い。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
I パラ メ ー タ Hostname、 DNSSuffix、 AdminUsername および
AdminPassword の長 さ および許可 さ れている文字は OS によ っ て異な
り ます。
34
Job API Tandem
5.4 サーバ／ ノ ー ド リ ス ト 管理
NetworkInterfaceData 構造体のレ イ アウ ト
ネ ッ ト ワー ク イ ン タ フ ェ ースデー タ の構造体には、 新 し いサーバのネ ッ ト
ワー ク イ ン タ フ ェ ース構成に関する詳細が含まれています。 こ の構造体のレ
イ アウ ト は次の と お り です。
Type=<int> Properties=<ArrayOf_PropertyData>
Type
ネ ッ ト ワ ー ク イ ン タ フ ェ ース の種類を指定 し ます。
1: (NETWORKINTERFACETYPE_PHYSICAL)
Properties
新 し いサーバのネ ッ ト ワ ー ク イ ン タ フ ェース に対す る プ ロ パテ ィ を指
定 し ます。 26 ページの "ArrayOf_PropertyData 構造体の レ イ ア ウ ト " を
ご覧 く だ さ い。
使用可能な物理ネ ッ ト ワー ク イ ン タ フ ェ ース プ ロパテ ィ の表
こ の表はネ ッ ト ワー ク イ ン タ フ ェ ースデー タ の配列で指定で き る プ ロパテ ィ
をすべて表示 し ます。
MACAddress
新 し いサーバのネ ッ ト ワ ー ク イ ン タ フ ェース の物理ア ド レ ス を指定 し
ます。 こ のパ ラ メ ー タ は必須です。
IPAddress
ネ ッ ト ワ ー ク イ ン タ フ ェ ース の IP ア ド レ ス を指定 し ます。
DHCP を使用す る 場合、 IP ア ド レ ス は 0.0.0.0. にな り ます。
デフ ォ ル ト 値 ： 0.0.0.0.
NetMask
ネ ッ ト ワ ー ク イ ン タ フ ェ ース のネ ッ ト マ ス ク を指定 し ます。
DHCP を使用す る 場合、 ネ ッ ト マ ス ク は 255.255.255.255 にな り ます。
デフ ォ ル ト 値 ： 255.255.255.255
Gateway
LAN のデフ ォ ル ト ゲー ト ウ ェ イ を指定 し ます。
DHCP を使用す る 場合、 デフ ォ ル ト ゲー ト ウ ェ イ の IP ア ド レ ス は
0.0.0.0. にな り ます。
デフ ォ ル ト 値 ： 0.0.0.0.
DNSServerList
コ ン マで区切 ら れた DNS サーバ名ま たは ド メ イ ンサーバの IP ア ド レ
ス一覧を指定 し ます。
デフ ォ ル ト 値 ： ""
Job API Tandem
35
5 API 関数 ク ラ ス
RegisterInDNS
DNS で IP ア ド レ ス の動的登録を有効、 ま たは無効に し ます。 こ のパ
ラ メ ー タ は Windows シ ス テ ムに対 し てのみ評価 さ れます。
0: (OFF)
1: (ON)
デフ ォ ル ト 値 ： 1 (ON)
UseSuffixInDNS
こ の接続の IP ア ド レ ス と 接続固有の ド メ イ ン名を登録す る ための
DNS 動的更新を有効、 ま たは無効に し ます。 RegisterInDNS が有効の場
合、 こ こ で有効に し た登録は コ ン ピ ュ ー タ の フルネームに対す る DNS
登録の追加項目 と な り ます。 こ のパ ラ メ ー タ は Windows シ ス テ ムに対
し てのみ評価 さ れます。
0: (OFF)
1: (ON)
デフ ォ ル ト 値 ： 0 (OFF)
ConnectionDNSSuffix
こ の イ ン タ フ ェ ース の ド メ イ ンサ フ ィ ッ ク ス文字列を指定 し ます。 こ
のパ ラ メ ー タ は Windows シ ス テ ムに対 し てのみ評価 さ れます。
デフ ォ ル ト 値 ： ""
36
Job API Tandem
5.4 サーバ／ ノ ー ド リ ス ト 管理
使用可能なパラ メ ー タ の表
こ の表は、 パラ メ ー タ の配列で指定で き るパ ラ メ ー タ を表示 し ます。
SystemType
サーバシ ス テ ムの種類を指定 し ます。 例 ： PRIMERGY TX300
デフ ォ ル ト 値 ： "Any Server"
ServerModel
富士通サーバモデルに関す る 標準名称を指定 し ます。 例えば D1710 と
は詳細名称の S26361-D171-A1 か ら 取っ た も のです。
デフ ォ ル ト 値 ： ""
DNSSuffix
ド メ イ ンサフ ィ ッ ク ス文字列を指定 し ます。 例 ： <hostname>、
<dnssuffix>
デフ ォ ル ト 値 ： ""
DNSAppendList
プ ラ イ マ リ お よ び接続固有な DNS サ フ ィ ッ ク ス の代わ り にサ フ ィ ッ ク
ス を追記す る こ と で不適切な名前を解決す る ために設定 し た DNS サ
フ ィ ッ ク ス の リ ス ト を指定 し ます。
デフ ォ ル ト 値 ： ""
Community
SNMP サービ ス用に定義 さ れた SNMP コ ミ ュ ニテ ィ を指定 し ます。 こ
れは、 サーバ リ ス ト で SNMP コ ミ ュ ニテ ィ 文字列を指定す る ためだけ
に使用 し 、 こ のサーバの SNMP ア ク セ ス のために ServerView Suite ア
プ リ ケーシ ョ ンに よ り 使用 さ れます。 ク ロ ーニ ン グ ま たは イ ン ス ト ー
ル し た SNMP サービ ス の SNMP コ ミ ュ ニテ ィ は定義 し ません。
デフ ォ ル ト 値 ： ""
AdminUsername
管理者のユーザア カ ウ ン ト を指定 し ます。
デフ ォ ル ト 値 ： "" （Windows では administrator、 Linux では root を使用
し ます。）
AdminPassword
指定 し た管理者のユーザア カ ウ ン ト に対す る パ ス ワ ー ド を指定 し ます。
デフ ォ ル ト 値 ： "" （デプ ロ イ メ ン ト 中はパス ワ ー ド を変更 し ないで く
だ さ い。）
Job API Tandem
37
5 API 関数 ク ラ ス
RemoteAccess
リ モー ト ア ク セ ス を指定 し ます。
0 (REMOTEACCESSTYPE-NONE)
1 (REMOTEACCESSTYPE-BMC): BMC サポー ト
2 (REMOTEACCESSTYPE-WOL): Wake on LAN
デフ ォ ル ト 値 ： 0
IpmiMgmtIPAddress
BIOS セ ッ ト ア ッ プで設定 さ れてい る と お り にベース ボー ド 管理 コ ン ト
ロ ー ラ （BMC） の IP ア ド レ ス を指定 し ます。
デフ ォ ル ト 値 ： "".
RemoteAccess が 1 (BMC) の場合、 こ のパ ラ メ ー タ は必須です。
IpmiUsername
BMC 認証用のユーザ名 （Ipmi 1.5） を指定 し ます。
デフ ォ ル ト 値 ： "".
RemoteAccess が 1 (BMC) の場合、 こ のパ ラ メ ー タ は必須です。
IpmiPassword
BMC 認証用 （Ipmi 1.5） ユーザア カ ウ ン ト に対す る パ ス ワ ー ド を指定
し ます。
デフ ォ ル ト 値 ： "".
RemoteAccess が 1 (BMC) の場合、 こ のパ ラ メ ー タ は必須です。
IpmiTimeout
BMC ア ク セ ス ご と の タ イ ム ア ウ ト 値を秒単位で指定 し ます。
デフ ォ ル ト 値 ： 3
IpmiRetries
BMC ア ク セ ス ご と の再試行回数を指定 し ます。
デフ ォ ル ト 値 ： 1
WOLBroadcastIPAddress
マジ ッ ク パケ ッ ト の送信先 と な る 対象の IP ア ド レ ス を指定 し ます。
パ ラ メ ー タ が空白で、 RemoteAccess が WOL の場合、 対象は同 じ LAN
セグ メ ン ト 内でなければな り ません。 リ ミ テ ッ ド ブ ロ ー ド キ ャ ス ト IP
ア ド レ ス 255.255.255.255 を使用 し 、 マジ ッ ク パケ ッ ト は イ ーサネ ッ ト
ブ ロ ー ド キ ャ ス ト と し て UDP ポー ト 9 へ直接送信 さ れます。
デフ ォ ル ト 値 ： ""
38
Job API Tandem
5.4 サーバ／ ノ ー ド リ ス ト 管理
WOLBootstrapProtocolIPAddress
ブー ト ス ト ラ ッ ププ ロ ト コ ルサーバの IP ア ド レ ス を指定 し ます。
ブ ロ ー ド キ ャ ス ト が UDP ポー ト 67 へ送信 さ れ、 WOL
BroadcastIPAddress にユニ キ ャ ス ト IP ア ド レ ス が含まれてい る 場合、
こ のパ ラ メ ー タ は必須です。
デフ ォ ル ト 値 ： ""
I 指定 し たサーバの種類が IPMI over LAN をサポー ト し ない場合、 Wake
on LAN をデ フ ォル ト と し て使用 し ます。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
Job API Tandem
39
5 API 関数 ク ラ ス
5.4.2
ChangeServerConfiguration
こ の関数を使 っ て、 指定 し たサーバの現在の設定値 （デプ ロ イ メ ン ト 構成を
含む） を変更 し ます。 定義 し たパ ラ メ ー タ のみがサーバの構成を変更 し ます。
構文
ChangeServerConfiguration ServerId=<ServerIdentifier>
NetworkInterface=<ArrayOf_NetworkinterfaceData>
Params=<ArrayOf_ParameterData>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
ServerId
デプ ロ イ メ ン ト 構成を変更す る サーバのサーバ ID を指定 し ます。 構造
体に関す る 詳細は、 26 ページの "ServerIdentifier 構造体の レ イ ア ウ ト "
を ご覧 く だ さ い。
こ のパ ラ メ ー タ は必須です。
NetworkInterface
サーバのネ ッ ト ワ ー ク イ ン タ フ ェ ース に関す る 詳細を含む
NetworkInterfaceData タ イ プの構造体の配列を指定 し ます。 ネ ッ ト ワ ー
ク イ ン タ フ ェ ース の構造体に関す る 詳細は、 35 ページの
"NetworkInterfaceData 構造体の レ イ ア ウ ト " を ご覧 く だ さ い。 物理ネ ッ
ト ワ ー ク イ ン タ フ ェ ース については、 41 ページの " 使用可能な物理
ネ ッ ト ワ ー ク イ ン タ フ ェ ース プ ロ パテ ィ の表 " を ご覧 く だ さ い。
I
NetworkInterfaceData を指定 し ない場合、 サーバの現在のネ ッ ト
ワー ク イ ン タ フ ェ ース構成は変更 さ れません。 し か し 、
NetworkInterfaceData を指定する場合は、 すべてのネ ッ ト ワー ク
構成 （すべてのイ ン タ フ ェ ース） を含めて指定 し て く だ さ い。
Params
ParameterData タ イ プの構造体の配列を指定 し ます。 使用可能なパ ラ
メ ー タ に関す る 詳細は、 43 ページの " 使用可能なパ ラ メ ー タ の表 " を
ご覧 く だ さ い。 ま たパ ラ メ ー タ 構造に関 し ては、 27 ページの
"ArrayOf_ParameterData 構造体の レ イ ア ウ ト " を ご覧 く だ さ い。
40
Job API Tandem
5.4 サーバ／ ノ ー ド リ ス ト 管理
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
I 現在のバージ ョ ン では、 指定 し た ブ レー ド に対 し てのみホス ト 名を変
更で き ます。 今後のバージ ョ ン では、 サーバ全種類に対 し てホス ト 名
を変更で き る よ う にな り ます。
使用可能な物理ネ ッ ト ワー ク イ ン タ フ ェ ース プ ロパテ ィ の表
こ の表では、 ネ ッ ト ワー ク イ ン タ フ ェ ースデー タ の配列内で指定で き る プ ロ
パテ ィ を表示 し ます。
MACAddress
変更す る サーバのネ ッ ト ワー ク イ ン タ フ ェ ース の物理ア ド レ ス を指定
し ます。
IPAddress
ネ ッ ト ワ ー ク イ ン タ フ ェ ース の IP ア ド レ ス を指定 し ます。
DHCP を使用す る 場合、 IP ア ド レ ス は 0.0.0.0 にな り ます。
デフ ォ ル ト 値 ： 0.0.0.0
NetMask
ネ ッ ト ワ ー ク イ ン タ フ ェ ース のネ ッ ト マ ス ク を指定 し ます。
DHCP を使用す る 場合、 ネ ッ ト マ ス ク は 255.255.255.255 にな り ます。
デフ ォ ル ト 値 ： 255.255.255.255
Gateway
LAN のデフ ォ ル ト ゲー ト ウ ェ イ を指定 し ます。
DHCP を使用す る 場合、 デフ ォ ル ト ゲー ト ウ ェ イ の IP ア ド レ ス は
0.0.0.0 にな り ます。
デフ ォ ル ト 値 ： 0.0.0.0
DNSServerList
コ ン マで区切 ら れた DNS サーバ名ま たは ド メ イ ンサーバの IP ア ド レ
ス の リ ス ト を指定 し ます。
デフ ォ ル ト 値 ： ""
Job API Tandem
41
5 API 関数 ク ラ ス
RegisterInDNS
DNS で IP ア ド レ ス の動的登録を有効、 ま たは無効に し ます。 こ のパ
ラ メ ー タ は Windows シ ス テ ムでのみ評価 さ れます。
0: (OFF)
1: (ON)
デフ ォ ル ト 値 ： 1 (ON)
UseSuffixInDNS
こ の接続の IP ア ド レ ス と 接続固有の ド メ イ ン名を登録す る ために
DNS 動的更新を有効ま たは無効に し ます。 RegisterInDNS が有効の場
合、 こ こ で有効に し た登録は コ ン ピ ュ ー タ の フルネームに対す る DNS
登録の追加項目 と な り ます。
こ のパ ラ メ ー タ は Windows シ ス テ ムに対 し てのみ評価 さ れます。
0: (OFF)
1: (ON)
デフ ォ ル ト 値 ： 0 (OFF)
ConnectionDNSSuffix
こ の イ ン タ フ ェ ース に対す る ド メ イ ンサ フ ィ ッ ク ス文字列を指定 し ま
す。
こ のパ ラ メ ー タ は Windows シ ス テ ムに対 し てのみ評価 さ れます。
デフ ォ ル ト 値 ： ""
42
Job API Tandem
5.4 サーバ／ ノ ー ド リ ス ト 管理
使用可能なパラ メ ー タ の表
こ の表には、 パラ メ ー タ の配列で指定で き るパラ メ ー タ を表示 し ます。
I パ ラ メ ー タ の指定は任意です。 し たが っ て、 定義 し たパラ メ ー タ のみ
がサーバの構成を変更 し ます。
Hostname
指定 し たサーバの新 し い名前を指定 し ます。 こ のサーバを イ ン ス ト ー
ルす る、 ま たは イ メ ージでデプ ロ イ メ ン ト す る 場合、 こ の新 し い名前
は新規サーバのホ ス ト 名 と し て使用 さ れます。
GUID
グ ロ ーバル一意識別子を指定 し ます。
SystemType
サーバシ ス テ ムの種類を指定 し ます。 例 ： PRIMERGY TX300
ServerModel
富士通サーバモデルに関す る 標準名称を指定 し ます。 例えば D1710 と
は詳細名称の S26361-D171-A1 か ら 取っ た も のです。
DNSSuffix
ド メ イ ンサフ ィ ッ ク ス文字列を指定 し ます。 例 ： <hostname>、
<dnssuffix>
Community
SNMP サービ ス用に定義 さ れた SNMP コ ミ ュ ニテ ィ を指定 し ます。 こ
れは、 サーバ リ ス ト の SNMP コ ミ ュ ニテ ィ 文字列を指定す る ためだけ
に使用 し 、 こ のサーバの SNMP ア ク セ ス のために ServerView Suite ア
プ リ ケーシ ョ ンに よ り 使用 さ れます。 ク ロ ーニ ン グ ま たは イ ン ス ト ー
ル後、 こ れは SNMP サービ ス の SNMP コ ミ ュ ニテ ィ を定義 し ません。
AdminUsername
管理者のユーザア カ ウ ン ト を指定 し ます。
AdminPassword
指定 し た管理者のユーザア カ ウ ン ト に対す る パ ス ワ ー ド を指定 し ます。
PXEBootInterface
PXE ブー ト （ ク ロ ーニ ン グお よ び イ ン ス ト ール用） に使用す る ネ ッ ト
ワ ー ク イ ン タ フ ェ ース の イ ン タ フ ェ ース イ ンデ ッ ク ス （1 で始ま る ）
を指定 し ます。 PXE ブー ト に使用す る ネ ッ ト ワ ー ク イ ン タ フ ェ ース を
必ず指定 し て く だ さ い。
Job API Tandem
43
5 API 関数 ク ラ ス
RemoteAccess
リ モー ト ア ク セ ス を指定 し ます。
0 (REMOTEACCESSTYPE-NONE)
1 (REMOTEACCESSTYPE-BMC): BMC サポー ト
2 (REMOTEACCESSTYPE-WOL): Wake on LAN
IpmiMgmtIPAddress
ベース ボー ド 管理 コ ン ト ロ ー ラ （BMC） の IP ア ド レ ス を指定 し ます。
IpmiUsername
BMC 認証 （Ipmi 1.5） 用のユーザ名を指定 し ます。
IpmiPassword
BMC 認証 （Ipmi 1.5） 用のユーザア カ ウ ン ト に対す る パ ス ワー ド を指
定 し ます。
IpmiTimeout
BMC ア ク セ ス ご と の タ イ ム ア ウ ト 値を秒単位で指定 し ます。
IpmiRetries
BMC ア ク セ ス ご と の再試行回数を指定 し ます。
WOLBroadcastIPAddress
マジ ッ ク パケ ッ ト の送信先 と な る 対象の IP ア ド レ ス を指定 し ます。 こ
のパ ラ メ ー タ が空白の場合、 対象は同 じ LAN セグ メ ン ト 内でなければ
な り ません。 リ ミ テ ッ ド ブ ロ ー ド キ ャ ス ト IP ア ド レ ス の
255.255.255.255 を使っ て、 マジ ッ ク パケ ッ ト を イ ーサネ ッ ト ブ ロ ー ド
キ ャ ス ト と し て UDP ポー ト 9 へ送信 し ます。
WOLBootstrapProtocolIPAddress
ブー ト ス ト ラ ッ ププ ロ ト コ ルサーバの IP ア ド レ ス を指定 し ます。
ブ ロ ー ド キ ャ ス ト が UDP ポー ト 67 へ送信 さ れ、 ま た
WOLBroadcastIPAddress にユニ キ ャ ス ト IP ア ド レ ス が含まれてい る 場
合、 こ のパ ラ メ ー タ は必須です。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
44
Job API Tandem
5.4 サーバ／ ノ ー ド リ ス ト 管理
5.4.3
StartSystemInfoRetrieval
関数 StartSystemInfoRetrieval を使 っ て、 指定 し たサーバに関する現在のシ ス テ
ム情報を取得で き ます。 様々な要因に よ り 、 こ のジ ョ ブが現在のシ ス テム情
報を取得する ま でに数分かかる場合があ り ます。 返 さ れた Job ID を介 し て、
関数 GetJobStatusDetails を使用 し 現在のジ ョ ブ状態を取得で き ます。
構文
StartSystemInfoRetrieval ServerId=<ServerIdentifier>
DeploymentServer=<string>
DeploymentUsername=<string>
DeploymentPassword=<string>
ShutdownType=<int>
ShutdownCommunity=<string>
ShutdownUsername=<string>
ShutdownPassword=<string>
FinalSeStAgentStatus=<int>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
ServerId
サーバ ID を指定 し ます。 構造体に関す る 詳細は、 26 ページの
"ServerIdentifier 構造体の レ イ ア ウ ト " を ご覧 く だ さ い。
DeploymentServer
デプ ロ イ メ ン ト サーバのホ ス ト 名、 ま たは、 1 つ目の LAN ポー ト の IP
ア ド レ ス を指定 し ます。
DeploymentUsername
指定 し たデプ ロ イ メ ン ト サーバのユーザア カ ウ ン ト 名を指定 し ます。
こ のパ ラ メ ー タ は必須です。
DeploymentPassword
デプ ロ イ メ ン ト サーバの指定ユーザア カ ウ ン ト に対 し てパ ス ワ ー ド を
指定 し ます。 こ のパ ラ メ ー タ は必須です。
Job API Tandem
45
5 API 関数 ク ラ ス
ShutdownType
サーバが動作中の場合の応答を指定 し ます。
0 (SHUTDOWNTYPE_NO): シ ャ ッ ト ダ ウ ン し ません。 ただ し サーバの
電源が切断 さ れていない場合はエ ラ ーを返 し ます。
1 (SHUTDOWNTYPE_ACPI)
2 (SHUTDOWNTYPE_GRACEFUL): ServerView エージ ェ ン ト を使っ て
シ ャ ッ ト ダ ウ ン し ます。
3 (SHUTDOWNTYPE_FORCE): ブ レー ド タ イ プのサーバに対 し ては、
マネージ メ ン ト ブ レー ド に よ っ て強制的に電源を切断 し ます。 その他
の タ イ プのサーバに対 し ては、 ACPI で電源を切断 し ます。
デフ ォ ル ト 値 ： 0 (SHUTDOWNTYPE_NO)
ShutdownCommunity
対象サーバで稼動 し てい る ServerView SNMP エージ ェ ン ト に対 し て送
信す る シ ャ ッ ト ダ ウ ン要求用の SNMP コ ミ ュ ニテ ィ を指定 し ます。
ShutdownUsername
ServerView SNMP エージ ェ ン ト シ ャ ッ ト ダ ウ ンに対す る ユーザ名を指
定 し ます。
デフ ォ ル ト 値 ： ""
ShutdownPassword
前述のユーザに対す る パ ス ワ ー ド を指定 し ます。
デフ ォ ル ト 値 ： " "
FinalSeStAgentStatus
ServerStart エージ ェ ン ト であ る Installation Manager エージ ェ ン ト の状
態、 お よ び イ ン ス ト ール後のサーバの電源状態を指定 し ます。
1 (AGENTSTOP_OFF): ServerStart Installation Manager エージ ェ ン ト は動
作 し ません。 サーバの電源を切断 し ます。
2 (AGENTSTOP_REBOOT): ServerStart Installation Manager エージ ェ ン ト
は動作 し ません。 サーバを再起動 し ます。
3 (AGENTSTOP_KEEPRUNNING): ServerStart Installation Manager エー
ジ ェ ン ト は動作 し 続け ます。
デフ ォ ル ト 値 ： 1 (AGENTSTOP_OFF)
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
46
Job API Tandem
5.4 サーバ／ ノ ー ド リ ス ト 管理
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
I ShutdownType が 2 の場合、 パラ メ ー タ ShutdownType、
ShutdownUsername、 ShutdownPassword を指定 し て く だ さ い。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
JobID
詳細を取得す る ために GetJobStatusDetails に対 し て使用す る 、 ユニー
ク な ID です。
Job API Tandem
47
5 API 関数 ク ラ ス
5.4.4
GetSystemInfoResult
GetSystemInfoResult 関数は、 StartSystemInfoRetrieval に よ り 取得 し たシ ス テム
情報を XML 文書形式で提供 し ます。 現在のシ ス テム情報を取得するには、 事
前に StartSystemInfoRetrieval を実行する必要があ り ます。
構文
GetSystemInfoResult ServerId=<ServerIdentifier>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
ServerId
サーバ ID を指定 し ます。 構造体に関す る 詳細は、 26 ページの
"ServerIdentifier 構造体の レ イ ア ウ ト " を ご覧 く だ さ い。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
ModificationDate
指定 し たサーバに関す る シ ス テ ム情報の最終更新日付です （1970 年か
ら の秒数）。
SystemInfo
指定 し たサーバに関す る XML 形式のシ ス テ ム詳細情報です。
48
Job API Tandem
5.4 サーバ／ ノ ー ド リ ス ト 管理
5.4.5
RdDeplServerList
デプ ロ イ メ ン ト テーブルにある使用可能なサーバすべての一覧を取得する た
め、 Job API は関数 RdDeplServerList をサポー ト し ています。 NodeList API が
リ リ ース さ れない限 り 、 こ の関数はサポー ト さ れます。
構文
RdDeplServerList RDServer=<string>
UserKey=<string>
パラ メ ー タ
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
DeplServerList
DeplServer タ イ プの構造体の配列です。
I ServerView デー タ ベースは、 RdDeplServerList を呼び出すたびにア ク
セスするわけではあ り ません。 ServerView デー タ ベースの変更が
Deployment Manager で更新 さ れ RdDeplServerList に よ っ て返 さ れる ま
でに最大 2 分の遅延が発生する場合があ り ます。
Job API Tandem
49
5 API 関数 ク ラ ス
戻 り リ ス ト のレ イ アウ ト
デプ ロ イ メ ン ト サーバの戻 り リ ス ト のその詳細のレ イ アウ ト は次の と お り で
す。 意味を持つ フ ィ ール ド はサーバの種類によ っ て異な り ます。
ServerName=<string>
ServerType=<int>
SV_SystemName=<string>
SV_IPAddress=<string>
SV_IPAddress=<string>
SV_Status=<string>
SystemType=<string>
Administrator=<string>
Location=<string>
MgmtServerName=<string>
MgmtIPAddress=<string>
MgmtSlot=<int>
ServerModel=<string>
CurrentImage=<string>
NewImage=<string>
DeploymentStatus=<string>
MacAddress1=<string>
IPAddress1=<string>
NetMask1=<string>
Gateway1=<string>
MacAddress2=<string>
IPAddress2=<string>
NetMask2=<string>
Gateway2=<string>
MacAddress3=<string>
IPAddress3=<string>
NetMask3=<string>
Gateway3=<string>
MacAddress4=<string>
IPAddress4=<string>
NetMask4=<string>
Gateway4=<string>
UserKeyInfo=<string>
ServerName
デプ ロ イ メ ン ト 構成で指定 し た と お り のサーバ名を表示 し ます。 後述
の SV_SystemName （OS ホ ス ト 名 ) と 同 じ 名前であ る 必要はあ り ませ
ん。
50
Job API Tandem
5.4 サーバ／ ノ ー ド リ ス ト 管理
ServerType
サーバの種類を表示 し ます。
Server (ServerView)
BladeServer (ServerView)
Blade (ServerView)
BareServer (Deployment Manager)
サーバブ レー ド を サーバ と し て ServerView デー タ ベース に入力 し た場
合、 同 じ ホ ス ト 名の項目が 2 回表示 さ れます。
SV_SystemName
ServerView デー タ ベース か ら のシ ス テ ム名を表示 し ます。 すでにサー
バ上に稼動 し てい る OS が イ ン ス ト ール さ れてい る 場合は、 こ れは OS
ホ ス ト 名にな り ます。
SV_IPAddress
ServerView デー タ ベース の関連項目で指定 し たサーバの IP ア ド レ ス を
表示 し ます。
SV_Status
ServerView デー タ ベース内でのサーバの状態を表示 し ます。
OK
Degraded
Fault
snmpOK
RSB_Mode
Not Manageable
Unknown
Ping
SystemType
サーバの種類に関す る 詳細を表示 し ます。
Administrator
サーバの管理者を表示 し ます。
Location
サーバの ロ ケーシ ョ ンに関す る 詳細説明を表示 し ます。
MgmtServerName
指定 し たサーバが属す る ブ レー ド サーバのマネージ メ ン ト ブ レー ド の
ホ ス ト 名を表示 し ます。
Job API Tandem
51
5 API 関数 ク ラ ス
MgmtIPAddress
指定 し たサーバが属す る （ServerType が Blade の場合） ブ レー ド サーバ
か ら マネージ メ ン ト ブ レー ド の SV_IPAddress を表示 し ます。 ServerType
が Server ま たは BareServer で、 さ ら に Ipmi でサーバを管理で き る 場合
は、 BMC の IP ア ド レ ス を表示 し ます。
MgmtSlot
ブ レー ド サーバ内にあ る こ のブ レー ド の ス ロ ッ ト ID を表示 し ます （1
か ら 20）。
ServerModel
富士通サーバモデルの標準名称を表示 し ます （例 ： D1710 は、 詳細名
称の S26361-D1710-A1 か ら 取 ら れま し た）。
CurrentImage
現在 ロ ー ド さ れてい る イ メ ージ名を表示 し ます。 デプ ロ イ メ ン ト 状態
が cloned の場合、 デプ ロ イ メ ン ト テーブルの MasterImageReference は
CurrentImage （NewImage は ""） にな り ます。 デプ ロ イ メ ン ト 状態が
cloned 以外の場合、 MasterImageReference は NewImage （CurrentImage
には最後に ク ロ ーニ ン グ さ れた イ メ ージの名前が含まれます） です。
NewImage
サーバが所属す る （ ク ロ ーニ ン グ ジ ョ ブが開始 さ れ る と す ぐ にサーバ
はグループの メ ンバにな り ます） グループの イ メ ージ名を表示 し ます。
DeploymentStatus
デプ ロ イ メ ン ト 状態を表示 し ます。
"" ( 空白 )
unknown
not cloned
cloning
cloned
installing
installed
MacAddress1
LAN ポー ト （ イ ン タ フ ェ ース） 1 の物理ア ド レ ス を表示 し ます。
IPAddress1
LAN ポー ト （ イ ン タ フ ェ ース） の現在の IP ア ド レ ス を表示 し ます。
DHCP を使用す る 場合、 IPAddress1 は空白です。
NetMask1
LAN ポー ト （ イ ン タ フ ェ ース） 1 の現在のネ ッ ト マ ス ク を表示 し ます。
DHCP を使用す る 場合、 NetMask1 は空白です。
52
Job API Tandem
5.4 サーバ／ ノ ー ド リ ス ト 管理
Gateway1
LAN ポー ト （ イ ン タ フ ェ ース） 1 の現在のゲー ト ウ ェ イ を表示 し ます。
DHCP を使用す る 場合、 Gateway1 は空白です。
MacAddress2
LAN ポー ト （ イ ン タ フ ェ ース） 2 の物理ア ド レ ス を表示 し ます。
IPAddress2
LAN ポー ト （ イ ン タ フ ェ ース） 2 の現在の IP ア ド レ ス を表示 し ます。
DHCP を使用す る 場合、 IPAddress2 は空白です。
NetMask2
LAN ポー ト （ イ ン タ フ ェース） 2 の現在のネ ッ ト マ ス ク を表示 し ます。
DHCP を使用す る 場合、 NetMask2 は空白です。
Gateway2
LAN ポー ト （ イ ン タ フ ェ ース） 2 の現在のゲー ト ウ ェ イ を表示 し ます。
DHCP を使用す る 場合、 Gateway2 は空白です。
MacAddress3
LAN ポー ト （ イ ン タ フ ェ ース） 3 の物理ア ド レ ス を表示 し ます。
IPAddress3
LAN ポー ト （ イ ン タ フ ェ ース） 3 の現在の IP ア ド レ ス を表示 し ます。
DHCP を使用す る 場合 （将来）、 IPAddress3 は空白です。
NetMask3
LAN ポー ト （ イ ン タ フ ェース） 3 の現在のネ ッ ト マ ス ク を表示 し ます。
DHCP を使用す る 場合 （将来）、 NetMask3 は空白です。
Gateway3
LAN ポー ト （ イ ン タ フ ェ ース） 3 の現在のゲー ト ウ ェ イ を表示 し ます。
DHCP を使用す る 場合、 Gateway3 は空白です。
MacAddress4
LAN ポー ト （ イ ン タ フ ェ ース） 4 の物理ア ド レ ス を表示 し ます。
IPAddress4
LAN ポー ト （ イ ン タ フ ェ ース） の現在の IP ア ド レ ス を表示 し ます。
DHCP を使用す る 場合、 IPAddress4 は空白です。
NetMask4
LAN ポー ト （ イ ン タ フ ェース） 4 の現在のネ ッ ト マ ス ク を表示 し ます。
DHCP を使用す る 場合、 NetMask4 は空白です。
Gateway4
LAN ポー ト （ イ ン タ フ ェース） 4 の現在のゲー ト ウ ェ イ を表示 し ます。
DHCP を使用す る 場合、 Gateway4 は空白です。
Job API Tandem
53
5 API 関数 ク ラ ス
UserKeyInfo
サーバが未予約、 自身に よ り 予約済み、 外部ユーザに よ り 予約済みの
いずれかであ る かを表示 し ます。 使用可能な値は次の と お り です。
"" ( 空白 )
userkey_none
userkey_own
userkey_foreign
I NodeList API が リ リ ース さ れない限 り 、 こ の Job API 関数はサポー ト
さ れます。 NodeList API が リ リ ース さ れる と こ の Job API 関数は廃止
さ れ、 Job API の今後のバージ ョ ン ではサポー ト さ れな く な り ます。
イ ン タ フ ェ ースの数は現在 4 つに制限 さ れています。 代わ り に
ExportDeploymentConfiguration （57 ページの
「ExportDeploymentConfiguration」 の項を ご覧 く だ さ い） を使 っ て利
用可能な イ ン タ フ ェ ースすべての情報を エ ク スポー ト で き ます。
54
Job API Tandem
5.4 サーバ／ ノ ー ド リ ス ト 管理
5.4.6
ImportDeploymentConfiguration
Job API では関数 ImportDeploymentConfiguration を使い、 1 つ以上のデプ ロ イ
メ ン ト 構成を XML 文書形式で イ ンポー ト し ます。 こ のデプ ロ イ メ ン ト 構成は
ExportDeploymentConfiguration を実行 し た際に作成 さ れた ものです。
構文
ImportDeploymentConfiguration DeploymentConfiguration=<XML>
Params=<ArrayOf_ParameterData>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
DeploymentConfiguration
XML 文書形式のデプ ロ イ メ ン ト テーブルを指定 し ます。
Params
ParameterData タ イ プの構造体の配列を指定 し ます。 使用可能なパ ラ
メ ー タ に関す る 詳細は 55 ページの " 使用可能なパ ラ メ ー タ の表 " を ご
覧 く だ さ い。 ま た、 パ ラ メ ー タ の構造体については、 27 ページの
"ArrayOf_ParameterData 構造体の レ イ ア ウ ト " を ご覧 く だ さ い。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
使用可能なパラ メ ー タ の表
こ の表では、 パラ メ ー タ の配列で指定で き るパラ メ ー タ を表示 し ます。
AddNonExistingBareServers
サーバ リ ス ト に存在 し ないベアサーバのデプ ロ イ メ ン ト 構成の イ ン
ポー ト を有効ま たは無効に し ます。
0 (OFF): サーバ リ ス ト に存在 し ないベアサーバを イ ン ポー ト し ません。
1 (ON): サーバ リ ス ト に存在 し ないベアサーバを イ ン ポー ト し ます。
デフ ォ ル ト 値 ： 0 (OFF)
Job API Tandem
55
5 API 関数 ク ラ ス
MatchServerId
所定のデプ ロ イ メ ン ト 構成に格納 さ れてい る サーバ ID と サーバ リ ス ト
にあ る サーバ ID が一致す る サーバのデプ ロ イ メ ン ト 構成の イ ン ポー ト
を有効、 ま たは無効に し ます。
0 (OFF): サーバ リ ス ト にあ る サーバ ID と 一致す る サーバ ID を持つ
サーバのデプ ロ イ メ ン ト 構成を イ ン ポー ト し ません。
1 (ON): サーバ リ ス ト にあ る サーバ ID と 一致す る サーバ ID を持つサー
バのデプ ロ イ メ ン ト 構成を イ ン ポー ト し ます。
デフ ォ ル ト 値 ： 0 (OFF)
MatchSlotId
デプ ロ イ メ ン ト 構成に格納 さ れてい る ス ロ ッ ト 番号 と サーバ リ ス ト に
あ る ス ロ ッ ト 番号が一致す る サーバブ レー ド のデプ ロ イ メ ン ト 構成の
イ ン ポー ト を有効、 ま たは無効に し ます。
0 (OFF): サーバ リ ス ト にあ る ス ロ ッ ト 番号 と 一致す る ス ロ ッ ト 番号を
持つサーバブ レー ド のデプ ロ イ メ ン ト 構成を イ ン ポー ト し ません。
1 (ON): サーバ リ ス ト にあ る ス ロ ッ ト 番号 と 一致す る ス ロ ッ ト 番号を持
つサーバブ レー ド のデプ ロ イ メ ン ト 構成を イ ン ポー ト し ます。
デフ ォ ル ト 値 ： 0 (OFF)
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
56
Job API Tandem
5.4 サーバ／ ノ ー ド リ ス ト 管理
5.4.7
ExportDeploymentConfiguration
関数 ExportDeploymentConfiguration は所定のサーバのデプ ロ イ メ ン ト 構成を
XML 文書形式で エ ク スポー ト し ます。 指定 し たサーバがマネージ メ ン ト ブ
レー ド の場合、 既存ブ レー ド のデプ ロ イ メ ン ト 構成 も すべて返 さ れます。
構文
ExportDeploymentConfiguration
ServerIdList=<Array of ServerIdentifier>
Params=<ArrayOf_ParameterData>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
ServerIdList
サーバ リ ス ト にあ る サーバの MAC ア ド レ ス、 IP ア ド レ ス ま たはホ ス
ト 名を含む ServerIdentifier タ イ プの構造体の配列を指定 し ます。 こ の
ServerIdentifier 構造体の定義については、 26 ページの "ServerIdentifier
構造体の レ イ ア ウ ト " を ご覧 く だ さ い。
Params
ParameterData タ イ プの構造体の配列を指定 し ます。 使用可能なパ ラ
メ ー タ に関す る 詳細は、 58 ページの " 使用可能なパ ラ メ ー タ の表 " を
ご覧 く だ さ い。 ま たパ ラ メ ー タ の構造体については、 27 ページの
"ArrayOf_ParameterData 構造体の レ イ ア ウ ト " を ご覧 く だ さ い。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
Job API Tandem
57
5 API 関数 ク ラ ス
使用可能なパ ラ メ ー タ の表
PasswordDecoded
エ ク ス ポー ト さ れたデプ ロ イ メ ン ト 構成に含まれ る パス ワ ー ド の復号
を有効ま たは無効に し ます。
0 (OFF): 暗号化 さ れたパ ス ワ ー ド
1 (ON): 復号化 さ れたパ ス ワ ー ド
デフ ォ ル ト 値 ： 0 (OFF)
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。 最後に実行 し た際の診断番号です。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
DeploymentConfiguration
XML 形式でエ ク ス ポー ト さ れたデプ ロ イ メ ン ト 構成です。
58
Job API Tandem
5.4 サーバ／ ノ ー ド リ ス ト 管理
5.4.8
SetUserKey
ユーザがサーバを予約する場合、 Job API 関数 SetUserKey を使っ て、 指定 し
たサーバまたはサーバの リ ス ト を予約済み と マー ク し ます。
サーバの予約は、 指定 し た UserKey のみに適用 さ れますので ご注意 く だ さ い。
UserKey を な く し て し ま う と 、 その UserKey を使 っ て行 っ たサーバの予約を
取 り 消す こ と がで き な く な り ます。
構文
SetUserKey ServerList=<string>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
ServerList
予約す る 様々なサーバの MAC ア ド レ ス の リ ス ト を指定 し ます。 例 ：
00-C0-12-34-5F-67、 00-C0-A4-12-34-23
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
Job API Tandem
59
5 API 関数 ク ラ ス
5.4.9
RemoveUserKey
こ の関数は、 指定 し たサーバの呼び出 し 元ユーザか ら 利用可能なユーザ予約
を削除 し ます。
構文
SetUserKey ServerList=<string>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
ServerList
サーバの MAC ア ド レ ス の リ ス ト を指定 し ます。 例 ： 00-C0-12-343-5F67、 00-C0-A4-12-34-23.
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
60
Job API Tandem
5.5 電源管理
5.5
電源管理
Job API では、 サーバの電源状態を制御で き ます。 次に示す電源管理の関数
を使 っ て、 対応する マネージ メ ン ト ブ レー ド 経由でサーバブ レー ド を、 そ し
て IPMI 経由で ス タ ン ド ア ロ ンサーバの電源切断や電源投入を直接行 う こ と が
で き ます。
5.5.1
SetPower
SetPower には、 BMC IP address や BMC user name のよ う な特定のパラ メ ー
タ は必要あ り ません。 電源の投入または切断方法に関する具体的な情報を構
成 し 、 ServerView Deployment Manager サービ スに対 し てその情報を設定す
る必要があ り ます。
構文
SetPower ServerId=<ServerIdentifer>
PowerStatus=<int>
Params=<ArrayOf_ParameterData>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
ServerId
サーバのサーバ ID を指定 し ます。 構造体に関す る 詳細は、 26 ページ
の "ServerIdentifier 構造体の レ イ ア ウ ト " を ご覧 く だ さ い。
PowerStatus
電源ス イ ッ チの状態を指定 し ます。
0 (POWERSTATUS_OFF)
1 (POWERSTATUS_ON)
Params
ParameterData タ イ プの構造体の配列を指定 し ます。 使用可能なパ ラ
メ ー タ に関す る 詳細は、 62 ページの " サーバの電源を切断す る ために
使用で き る パ ラ メ ー タ の表 " と 63 ページの " サーバの電源を投入す る
ために使用で き る パ ラ メ ー タ の表 " を ご覧 く だ さ い。 ま たパ ラ メ ー タ
の構造体については 27 ページの "ArrayOf_ParameterData 構造体の レ イ
ア ウ ト " を ご覧 く だ さ い。
Job API Tandem
61
5 API 関数 ク ラ ス
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
サーバの電源を切断する ために使用で き るパラ メ ー タ の表
表は指定 し たサーバの電源状態を電源切断に設定するパラ メ ー タ を表示 し ま
す。 こ のパラ メ ー タ はパラ メ ー タ の配列で指定で き ます。
ShutdownType
シ ャ ッ ト ダ ウ ンの種類を指定 し ます。
0 (SHUTDOWNTYPE_NO): シ ャ ッ ト ダ ウ ン し ません。 サーバの電源が
切断 さ れていない場合はエ ラ ーを返 し ます。
1 (SHUTDOWNTYPE_ACPI)
2 (SHUTDOWNTYPE_GRACEFUL): ServerView エージ ェ ン ト を使っ て
シ ャ ッ ト ダ ウ ン し ます。
3 (SHUTDOWNTYPE_FORCE): ブ レー ド タ イ プのサーバに対 し ては、
マネージ メ ン ト ブ レー ド に よ っ て強制的に電源を切断 し ます。 その他
の タ イ プのサーバに対 し ては、 ACPI で電源を切断 し ます。
デフ ォ ル ト 値 ： 0 (SHUTDOWNTYPE_NO)
ShutdownIp
ServerView エージ ェ ン ト シ ャ ッ ト ダ ウ ン用のホ ス ト 名ま たは IP ア ド レ
ス を指定 し ます。
ShutdownType が 2 の場合、 こ のパ ラ メ ー タ は必須です。
ShutdownCommunity
シ ャ ッ ト ダ ウ ン対象のシ ス テ ムで実行 さ れ る ServerView エージ ェ ン ト
シ ャ ッ ト ダ ウ ンに対 し て SNMP ア ク セ ス用 コ ミ ュ ニテ ィ を指定 し ま
す。
ShutdownType が 2 の場合、 こ のパ ラ メ ー タ は必須です。
ShutdownUsername
ServerView エージ ェ ン ト シ ャ ッ ト ダ ウ ンのユーザア カ ウ ン ト 名を指定
し ます。
ShutdownType が 2 の場合、 こ のパ ラ メ ー タ は必須です。
62
Job API Tandem
5.5 電源管理
ShutdownPassword
ServerView エージ ェ ン ト シ ャ ッ ト ダ ウ ン用ユーザに対す る パ ス ワ ー ド
を指定 し ます。
ShutdownType が 2 の場合、 こ のパ ラ メ ー タ は必須です。
Timeout
ServerView エージ ェ ン ト 、 マネージ メ ン ト ブ レー ド 、 ま たは BMC に
対 し て発行 さ れ る 要求の タ イ ム ア ウ ト 値を秒単位で指定 し ます。
ブ レー ド 用推奨値 ： 6
BMC 用推奨値 ： 3
Retries
シ ャ ッ ト ダ ウ ンの再試行回数を指定 し ます。
ブ レー ド 用推奨値 ： 2
BMC 用推奨値 ： 1
サーバの電源を投入する ために使用で き るパ ラ メ ー タ の表
表は指定 し たサーバの電源投入を設定するパ ラ メ ー タ を表示 し ます。 こ のパ
ラ メ ー タ はパラ メ ー タ の配列で指定で き ます。
BootMode
ブー ト モー ド を指定 し ます。
0 (BOOTMODE_NORMAL)
1 (BOOTMODE_PXE)
デフ ォ ル ト 値 ： 0 (BOOTMODE_NORMAL)
ShutdownType
シ ャ ッ ト ダ ウ ンの種類を指定 し ます。
0 (SHUTDOWNTYPE_NO): シ ャ ッ ト ダ ウ ン し ません。 ただ し サーバの
電源が切断 さ れていない場合はエ ラ ーを返 し ます。
1 (SHUTDOWNTYPE_ACPI)
2 (SHUTDOWNTYPE_GRACEFUL): ServerView エージ ェ ン ト を使っ て
シ ャ ッ ト ダ ウ ン し ます。
3 (SHUTDOWNTYPE_FORCE): ブ レー ド タ イ プのサーバに対 し ては、
マネージ メ ン ト ブ レー ド に よ っ て強制的に電源を切断 し ます。 その他
の タ イ プのサーバに対 し ては、 ACPI で電源を切断 し ます。
デフ ォ ル ト 値 ： 0 (SHUTDOWNTYPE_NO)
ShutdownIp
ServerView エージ ェ ン ト シ ャ ッ ト ダ ウ ン用のホ ス ト 名ま たは IP ア ド レ
ス を指定 し ます。
ShutdownType が 2 の場合、 こ のパ ラ メ ー タ は必須です。
Job API Tandem
63
5 API 関数 ク ラ ス
ShutdownCommunity
シ ャ ッ ト ダ ウ ン対象のシ ス テ ムで実行 さ れ る ServerView エージ ェ ン ト
シ ャ ッ ト ダ ウ ンに対 し て SNMP ア ク セ ス用 コ ミ ュ ニテ ィ を指定 し ま
す。
ShutdownType が 2 の場合、 こ のパ ラ メ ー タ は必須です。
ShutdownPassword
ServerView エージ ェ ン ト シ ャ ッ ト ダ ウ ン用ユーザに対す る パス ワ ー ド
を指定 し ます。
ShutdownType が 2 の場合、 こ のパ ラ メ ー タ は必須です。
Timeout
ServerView エージ ェ ン ト 、 マネージ メ ン ト ブ レー ド 、 ま たは BMC に
対 し て発行 さ れ る 要求の タ イ ム ア ウ ト 値を秒単位で指定 し ます。
ブ レー ド 用推奨値 ： 6
BMC 用推奨値 ： 3
Retries
シ ャ ッ ト ダ ウ ンの再試行回数を指定 し ます。
ブ レー ド 用推奨値 ： 2
BMC 用推奨値 ： 1
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
64
Job API Tandem
5.5 電源管理
5.5.2
SetPXEBootImage
関数 SetPXEBootImage を使 っ て PXE ク ラ イ ア ン ト 用のブー ト イ メ ージ を
PXE サービ スへ登録する、 または登録を解除する こ と がで き ます。
構文
SetPXEBootImage ServerId=<ServerIdentifer>
BootImagePath=<string>
BootImageType=<int>
Params=<ArrayOf_ParameterData>
DeploymentServer
DeploymentUsername
DeploymentPassword
RDServer=<string>
UserKey=<string>
パラ メ ー タ
ServerId
ServerIdentifier タ イ プの構造体でサーバを指定 し ます。 MAC ア ド レ ス
でサーバを指定す る場合、 PXE ク ラ イ ア ン ト は所定の MAC ア ド レ ス
に よ り その ま ま登録 さ れます。 サーバを IP ア ド レ ス、 ま たはホ ス ト 名
で指定す る 場合、 PXE ク ラ イ ア ン ト は PXEBootInterface と し てデプ ロ
イ メ ン ト 構成に登録 さ れた MAC ア ド レ ス に よ り 登録 さ れます。
ServerIdentifier の構造体に関す る 詳細は、 26 ページの "ServerIdentifier
構造体の レ イ ア ウ ト " を ご覧 く だ さ い。
BootImagePath
ブー ト イ メ ージ名を含む、 tftp サーバのルー ト デ ィ レ ク ト リ への相対
パ ス を指定 し ます。 DOS イ メ ージでは、 サーバのルー ト デ ィ レ ク ト リ
への相対パス か、 ま たは フ ァ イ ルシ ス テ ム内の絶対パ ス のいずれかに
な り ます。 絶対パス の場合、 フ ァ イ ルは自動的に tftp サーバの一時
デ ィ レ ク ト リ へ コ ピー さ れます。
BootImageType
ブー ト イ メ ージの種類を指定 し ます。
0 (BOOTIMAGETYPE_BOOTSTRAPIMAGE)
1 (BOOTIMAGETYPE_DOSIMAGE)
デフ ォ ル ト 値 ： 0 (BOOTIMAGETYPE_BOOTSTRAPIMAGE)
Job API Tandem
65
5 API 関数 ク ラ ス
Params
ParameterData タ イ プの構造体の配列を指定 し ます。 使用可能なパ ラ
メ ー タ に関す る 詳細は、 67 ページの "PXE ク ラ イ ア ン ト 用のブー ト イ
メ ージ を登録す る ために使用可能なパ ラ メ ー タ の表 " と 67 ページの
"PXE ク ラ イ ア ン ト 用ブー ト イ メ ージの登録を解除す る ために使用可能
なパ ラ メ ー タ の表 " を ご覧 く だ さ い。 ま たパ ラ メ ー タ の構造体につい
ては、 27 ページの "ArrayOf_ParameterData 構造体の レ イ ア ウ ト " を ご
覧 く だ さ い。
DeploymentServer
PXE サービ ス が稼動 し てい る デプ ロ イ メ ン ト サーバのホ ス ト 名、 ま た
は、 1 つ目の LAN ポー ト の IP ア ド レ ス を指定 し ます。 （ こ の リ リ ース
では、 RDServer と 同 じ でなければな り ません）。
DeploymentUsername
指定 し たデプ ロ イ メ ン ト サーバのユーザア カ ウ ン ト を指定 し ます。 こ
のパ ラ メ ー タ は必須です。
DeploymentPassword
デプ ロ イ メ ン ト サーバ上で指定 し たユーザア カ ウ ン ト に対す る パ ス
ワ ー ド を指定 し ます。 こ のパ ラ メ ー タ は必須です。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
I Params 構造体でパラ メ ー タ を指定 し ない場合、 デ フ ォ ル ト で非持続
的登録が行われます。
66
Job API Tandem
5.5 電源管理
PXE ク ラ イ ア ン ト 用のブー ト イ メ ージ を登録する ために使用可能なパラ メ ー
タ の表
表は、 パラ メ ー タ の配列で指定で き るパラ メ ー タ を表示 し ます。
RegisterMode
指定 し た PXE ブー ト イ メ ージの持続的ま たは非持続的登録を指定 し ま
す。
0 (REGISTER_NONPERSISTENT): 次回の PXE ブー ト 用にサーバを PXE
サービ ス に登録 し ます。 1 回 PXE ブー ト を実行 し た後、 サーバは自動
的に PXE サービ ス の登録か ら 解除 さ れます （ブー ト イ メ ージは登録 さ
れた ま ま です）。
1 (REGISTER_PERSISTENT): サーバを持続的に PXE サービ ス に登録 し
ます。
デフ ォ ル ト 値 ： 0 (REGISTER_NONPERSISTENT)
PXE ク ラ イ ア ン ト 用ブー ト イ メ ージの登録を解除する ために使用可能なパ ラ
メ ー タ の表
表は、 パラ メ ー タ の配列で指定で き るパラ メ ー タ を表示 し ます。
UnregisterMode
登録解除モー ド を指定 し ます。
1 (UNREGISTER_BOOTIMAGE_AND_CLIENT): 所定のブー ト イ メ ージ
か ら サーバの登録を解除 し 、 ブー ト イ メ ージ自身の登録 も 解除 し ます
（ こ のブー ト イ メ ージに他の PXE ク ラ イ ア ン ト が登録 さ れていない場
合）。 サーバが登録 さ れていない場合 （サーバが
REGISTER_NONPERSISTENT モー ド で登録 さ れていて、 PXE ブー ト
がすでに実行 さ れてい る と き に発生す る場合があ り ます）、 エ ラ ーを返
さ ずにブー ト イ メ ージの登録が解除 さ れます （ こ のブー ト イ メ ージに
他の ク ラ イ ア ン ト が登録 さ れていない場合）。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
Job API Tandem
67
5 API 関数 ク ラ ス
5.5.3
GetPower
関数 GetPower を使 っ てサーバの現在の電源状態を確認 し ます。
構文
GetPower ServerId=<ServerIdentifer>
Params=<ArrayOf_ParameterData>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
ServerId
ServerIdentifier タ イ プの構造体でサーバの MAC ア ド レ ス を指定 し ま
す。 詳細は 26 ページの "ServerIdentifier 構造体の レ イ ア ウ ト " を ご覧
く だ さ い。
Params
ParameterData タ イ プの構造体の配列を指定 し ます。 使用可能なパ ラ
メ ー タ に関す る 詳細は、 69 ページの " 使用可能なパ ラ メ ー タ の表 " を
ご覧 く だ さ い。 ま たパ ラ メ ー タ の構造体については、 27 ページの
"ArrayOf_ParameterData 構造体の レ イ ア ウ ト " を ご覧 く だ さ い。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
68
Job API Tandem
5.5 電源管理
使用可能なパラ メ ー タ の表
表は、 パラ メ ー タ の配列で指定で き るパラ メ ー タ を表示 し ます。
Timeout
マネージ メ ン ト ブ レー ド に対 し て発行 さ れ る 要求の タ イ ム ア ウ ト 値を
秒単位で指定 し ます。
推奨値 ： 6
Retries
SNMP 再試行回数を指定 し ます。
推奨値 ： 2
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
PowerStatus
現在の電源状態を返 し ます。
0 (POWERSTATUS_OFF)
1 (POWERSTATUS_ON)
Job API Tandem
69
5 API 関数 ク ラ ス
5.5.4
GetBootMode
関数 GetBootMode を使 っ て、 MAC ア ド レ ス を介 し て指定 し たサーバの現在の
ブー ト モー ド を取得で き ます。 Job API はシ ス テム タ イ プ情報に基づいて、
関数がマネージ メ ン ト ブ レー ド または IPMI を利用 し た BMC によ り 管理 さ れ
ているかど う かを直接確認 し ます。
構文
GetBootMode ServerId=<ServerIdentifer>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
ServerId
ServerIdentifier タ イ プの構造体でサーバの MAC ア ド レ ス を指定 し ま
す。 詳細は、 26 ページの "ServerIdentifier 構造体の レ イ ア ウ ト " を ご覧
く だ さ い。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
70
Job API Tandem
5.5 電源管理
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
BootMode
ブー ト モー ド を返 し ます。
0 (BOOTMODE_NORMAL)
1 (BOOTMODE_PXE)
Job API Tandem
71
5 API 関数 ク ラ ス
5.6
リ ポジ ト リ 管理
リ ポジ ト リ と は、 Deployment Service や ServerView Deployment Manager に
よ り ア ク セスで き る コ ン テナ （Windows サーバでは共有デ ィ レ ク ト リ ） のよ
う な ものです。 リ ポジ ト リ は複数のデ ィ レ ク ト リ やサブデ ィ レ ク ト リ に分割
で き ます。 し か し 原則 と し て、 Deployment Manager では、 リ ポジ ト リ と そ
のデ ィ レ ク ト リ はイ メ ージ を格納する ために使用 さ れます。
イ メ ージは Deployment Manager と Job API 内において注目 さ れる も のです。
基本的に IT における イ メ ージ と は、 ハー ド デ ィ ス ク 、 パーテ ィ シ ョ ン、 また
は CD の コ ピーのよ う な ものです。 Job API 内において イ メ ージ作成 と は完
全に イ ン ス ト ール さ れ構成 さ れたシ ス テムか ら イ メ ージ を作成する こ と を意
味 し ます。 すなわち、 イ メ ージには参照シ ス テム （例 ： ハー ド デ ィ ス ク 、 付
加記憶領域、 パーテ ィ シ ョ ンの構成、 OS のデー タ すべて な ど） の構成情報
が含まれます。 し たがっ て、 イ メ ージは参照イ メ ージ と し て使用 さ れ、 複数
の対象シ ス テムをデプ ロ イ メ ン ト し ます。
新 し い Job API では、 CreateImage と い う 新 し い汎用関数を使用で き ます。 こ
の関数を使 っ て、 サポー ト さ れている種類すべてのイ メ ージ を作成する こ と
がで き ます。 すなわち、 CreateImage では、 snapshot イ メ ージ も 作成で き ま
す。
原則 と し て、 様々な イ メ ージの種類が格納 さ れる ため、 格納先の リ ポジ ト リ
も それぞれ異な り ます。 次では、 現在の Job API がサポー ト する リ ポジ ト リ
の種類をすべて記載 し ます。
–
ク ローニ ング イ メ ージ
リ ポジ ト リ は、 Job API または Deployment Manager を介 し て作成 さ れた
デ ィ ス ク イ メ ージ フ ァ イルすべて を収容 し ます。 また こ れ ら リ ポジ ト リ は
ク ローニ ング を実行する ために使用 さ れます。
– Boot Images
ブー ト イ メ ージの リ ポジ ト リ は、 汎用シ ス テムを準備する ために作成 さ れ
た PXE ブー ト イ メ ージ を収容するデ ィ レ ク ト リ です。
–
イ ン ス ト ール構成
イ ン ス ト ール構成 フ ァ イルの リ ポジ ト リ は、 イ ン ス ト ール構成 フ ァ イルが
格納 さ れているサブデ ィ レ ク ト リ を持つデ ィ レ ク ト リ です。 こ のイ ン ス
ト ール構成 フ ァ イルは Installation Manager を使 っ て作成する必要があ り
ます。
– デプ ロ イ メ ン ト テーブル
デプ ロ イ メ ン ト テーブルの リ ポジ ト リ は、 Deployment Manager フ ロ ン ト
エ ン ド の関数 Export Deployment Configuration を使 っ て エ ク スポー ト さ れた
XML フ ァ イルを収容 し ます。
72
Job API Tandem
5.6 リ ポジ ト リ 管理
例
リ ポジ ト リ 内の各イ メ ージオブ ジ ェ ク ト は同一 フ ァ イルセ ッ ト を表 し ます
が、 それぞれの拡張子は異な り ます。
– バイ ナ リ ク ローニ ング イ メ ージ フ ァ イル (.img)
こ の フ ァ イルは、 ハー ド デ ィ ス ク （ネ ッ ト のど こ かにあ る格納場所の
URL） の コ ピーを収容 し ます。
–
イ メ ージ文書 (.txt)
こ の フ ァ イルは、 イ メ ージ を説明する ために使用で き ます。 例 ： イ
メ ージ作成中に作成 さ れる テキス ト 文書の参照
– ハー ド ウ ェ ア /OS パ ラ メ ー タ フ ァ イル (.cfg)
こ の情報は、 既存イ メ ージの変更 と 割 り 当て ら れた対象 HW に対する
互換性の確認のために使用 し ます。
–
リ モー ト Mass Installation フ ァ イル (.xml)
こ の構成 フ ァ イルは Installation Manager ウ ィ ザー ド （例 ： 準備モー
ド ） によ り 作成 さ れます。
次の項では、 新 し い リ ポジ ト リ の追加、 不要な リ ポジ ト リ の削除、 既知 リ
ポジ ト リ の取得に使用 さ れる リ ポジ ト リ 関数を記載 し ています。 さ ら に、
Job API では リ ポジ ト リ に収容 さ れた イ メ ージ を扱 っ た り 、 新 し い イ メ ー
ジ を作成 し た り する ための関数を使用で き ます。
Job API Tandem
73
5 API 関数 ク ラ ス
5.6.1
AddRepository
リ ポジ ト リ を追加する ためには、 Job API で リ ポジ ト リ を識別する ために使
用する シ ンボ リ ッ ク 名 と パス名を指定 し て く だ さ い。 一般的に、 パス名 と は、
共有デ ィ レ ク ト リ へのネ ッ ト ワー ク パス （UNC 表記法） の こ と です。 パス名
は、 ネ ッ ト ワー ク パス ではな く ロー カルデ ィ レ ク ト リ への絶対パスで も 可能
です。 し か し 、 その場合、 ServerView Deployment Manager サービ ス と
Deployment Service が同 じ マ シ ンに イ ン ス ト ール さ れている必要があ り ま
す。 こ れ ら サービ スがイ ン ス ト ール さ れていない場合、 UNC 表記法によ る共
有へのネ ッ ト ワー ク パス \\server_name\share_name でなければな り ません。
構文
AddRepository RepositoryName=<string>
RepositoryType=<int>
NetworkPath=<string>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
RepositoryName
新 し い リ ポジ ト リ の名前を指定 し ます。
RepositoryType
新 し い リ ポジ ト リ の種類を指定 し ます。
1 (REPOSITORYTYPE_CLONING_IMAGE)
2 (REPOSITORYTYPE_BOOT_IMAGE)
3 (REPOSITORYTYPE_CONFIG_FILE)
4 (REPOSITORYTYPE_DEPLOYMENT_TABLE)
デフ ォ ル ト 値 ： 1 (REPOSITORYTYPE_CLONING_IMAGE)
NetworkPath
後で該当す る イ メ ージ フ ァ イ ルを収容す る 場所の完全修飾ネ ッ ト ワ ー
ク パ ス を UNC 形式で指定 し ます。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
74
Job API Tandem
5.6 リ ポジ ト リ 管理
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
Job API Tandem
75
5 API 関数 ク ラ ス
5.6.2
RemoveRepository
関数 RemoveRepository を使っ て、 不要な リ ポジ ト リ を削除 し ます。 し た
が っ て、 既存の リ ポジ ト リ 、 デプ ロ イ メ ン ト サーバ、 およびユーザア カ ウ ン
ト を識別するユーザキーのシ ンボ リ ッ ク 名を指定 し て く だ さ い。
構文
RemoveRepository RepositoryName=<string>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
RepositoryName
削除す る リ ポジ ト リ 名を指定 し ます。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
I こ の関数を使 う と 、 イ メ ージオブ ジ ェ ク ト ではな く リ ポジ ト リ 一覧の
エ ン ト リ が削除 さ れます。
76
Job API Tandem
5.6 リ ポジ ト リ 管理
5.6.3
GetRepositoryList
関数 GetRepositoryList は既知 リ ポジ ト リ すべての情報を返 し ます。 既存 リ ポ
ジ ト リ の種類を それぞれ表示する ためには、 該当する リ ポジ ト リ の種類、 ま
たは全種類に対 し ては 0 （ALL) を選びます。
構文
GetRepositoryList RepositoryType=<ServerIdentifer>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
RepositoryType
情報を取得す る リ ポジ ト リ の種類を指定 し ます。
0 (ALL)
1 (REPOSITORYTYPE_CLONING_IMAGE)
2 (REPOSITORYTYPE_BOOT_IMAGE)
3 (REPOSITORYTYPE_CONFIG_FILE)
4 (REPOSITORYTYPE_DEPLOYMENT_TABLE)
デフ ォ ル ト 値 ： 0 (ALL)
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
Job API Tandem
77
5 API 関数 ク ラ ス
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
RepositoryList
RepositoryData タ イ プの構造体の配列を返 し ます。
戻 り リ ス ト のレ イ アウ ト
リ ポジ ト リ の戻 り リ ス ト と その詳細のレ イ アウ ト は次の と お り です。
RepositoryName=<string> RepositoryType=<int>
NetworkPath=<string>
RepositoryName
リ ポジ ト リ の名前を表示 し ます。
RepositoryType
リ ポジ ト リ の種類を表示 し ます。
1 (REPOSITORYTYPE_CLONING_IMAGE)
2 (REPOSITORYTYPE_BOOT_IMAGE)
3 (REPOSITORYTYPE_CONFIG_FILE)
4 (REPOSITORYTYPE_DEPLOYMENT_TABLE)
NetworkPath
ネ ッ ト ワ ー ク パ ス を UNC 形式で表示 し ます。
78
Job API Tandem
5.6 リ ポジ ト リ 管理
5.6.4
CreateImage
関数 CreateImage を使 っ て ク ローニ ン グ イ メ ージ と スナ ッ プ シ ョ ッ ト イ メ ー
ジ を作成 し ます。 こ れ ら のイ メ ージ を使 っ て複数のサーバ （デプ ロ イ メ ン ト
テーブルに基づいて個別化 さ れた もの） をデプ ロ イ メ ン ト し ます。 パ ラ メ ー
タ ImageType は生成 さ れた イ メ ージの種類を選択 し ます。 パ ラ メ ー タ Params
にはイ メ ージ作成パラ メ ー タ の リ ス ト が含まれ、 ImageType に応 じ て解釈 さ
れます。 CreateImage は、 イ メ ージの作成を開始 し 、 Job ID を返 し ます。 こ の
Job ID を以降の GetJobStatusDetails の呼び出 し 入力項目 と し て使用で き ます。
構文
CreateImage ServerId=<int>
ImagePath=<string>
ImageType=<int>
InfoText=<string>
Params=<ArrayOf_ParameterData>
DeploymentServer=<string>
DeploymentUsername=<string>
DeploymentPassword=<string>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
ServerId
ServerIdentifier タ イ プの構造体で対象サーバブ レー ド の MAC ア ド レ ス
を指定 し ます。 詳細は 26 ページの "ServerIdentifier 構造体の レ イ ア ウ
ト " を ご覧 く だ さ い。
ImagePath
イ メ ージの名前を含む完全修飾パ ス を指定 し ます。
ImageType
イ メ ージの種類を指定 し ます。
1 (IMAGETYPE_CLONING)
2 (IMAGETYPE_SNAPSHOT)
InfoText
イ メ ージ と 共に保存す る 情報を指定 し ます。 情報は .txt フ ァ イ ルで保
存 さ れます。
Job API Tandem
79
5 API 関数 ク ラ ス
Params
ParameterData タ イ プの構造体の配列を指定 し ます。 パ ラ メ ー タ の構造
体に関 し て詳 し く は、 27 ページの "ArrayOf_ParameterData 構造体の レ
イ ア ウ ト " を ご覧 く だ さ い。 使用可能なパ ラ メ ー タ については 81 ペー
ジの " ク ロ ーニ ン グ イ メ ージ を作成す る ために使用可能なパ ラ メ ー タ
の表 " お よ び 84 ページの " ス ナ ッ プシ ョ ッ ト イ メ ージ を作成す る ため
に使用可能なパ ラ メ ー タ の表 " を ご覧 く だ さ い。
DeploymentServer
デプ ロ イ メ ン ト サーバのホ ス ト 名、 ま たは、 1 つ目の LAN ポー ト の IP
ア ド レ ス を指定 し ます。
DeploymentUsername
指定 し たデプ ロ イ メ ン ト サーバのユーザア カ ウ ン ト 名を指定 し ます。
DeploymentPassword
デプ ロ イ メ ン ト サーバで指定 し たユーザア カ ウ ン ト に対す る パ ス ワ ー
ド を指定 し ます。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
I ShutdownType が 3 で、 IPMI を搭載 し ていないサーバを指定 し た場合、
シ ャ ッ ト ダウ ン を手動で行 う 必要があ る ため、 こ の関数は正常に実行
し た と 返 し ます。
80
Job API Tandem
5.6 リ ポジ ト リ 管理
ク ローニ ング イ メ ージ を作成する ために使用可能なパラ メ ー タ の表
次のパラ メ ー タ 表では、 IMAGETYPE_CLONING タ イ プのイ メ ージ を作成する
ために Params の配列で指定する固有の名前 と 値を説明 し ます。
SaveMode
ハー ド デ ィ ス ク の イ メ ージ作成中に使用す る 保存モー ド を指定 し ます。
0 (SAVEMODE_FILESYSTEM_DEPENDENT): パーテ ィ シ ョ ン内で使用
さ れてい る セ ク タ のみを保存 し ます。
1 (SAVEMODE_FILESYSTEM_INDEPENDENT): パーテ ィ シ ョ ン内のす
べてのセ ク タ を保存 し ます。
2 (SAVEMODE_RAW): デ ィ ス ク すべて を保存 し ます。
デフ ォ ル ト 値 ： 0 (SAVEMODE_FILESYSTEM_DEPENDENT)
ShutdownType
サーバが動作 し てい る 場合の応答を指定 し ます。
0 (SHUTDOWNTYPE_NO): シ ャ ッ ト ダ ウ ン し ません。 ただ し 、 サーバ
の電源が切断 さ れていない場合はエ ラ ーを返 し ます。
1 (SHUTDOWNTYPE_ACPI):
2 (SHUTDOWNTYPE_GRACEFUL): ServerView エージ ェ ン ト を使っ て
シ ャ ッ ト ダ ウ ン し ます。
デフ ォ ル ト 値 ： 0 (SHUTDOWNTYPE_NO)
ShutdownUsername
ServerView エージ ェ ン ト シ ャ ッ ト ダ ウ ンに対す る ユーザア カ ウ ン ト 名
を指定 し ます。 ShutdownType が 2 の場合、 こ のパ ラ メ ー タ は必須です。
デフ ォ ル ト 値 ： ""
ShutdownPassword
前述のユーザに対す る パス ワ ー ド を指定 し ます。
ShutdownType が 2 の場合、 こ のパ ラ メ ー タ は必須です。
デフ ォ ル ト 値 ： ""
FinalPowerStatus
イ メ ージ生成後のサーバの電源状態を指定 し ます。
0 (FINALPOWERSTATUS_OFF): サーバの電源は切断 さ れてい ます。
1 (FINALPOWERSTATUS_ON): イ ン ス ト ール さ れてい る OS が起動 し て
い ます。
こ のパ ラ メ ー タ を使っ て、 イ メ ージ生成後、 サーバの OS を起動す る
か、 ま たはサーバの電源を切断す る か を選択で き ます。
デフ ォ ル ト 値 ： 0 (FINALPOWERSTATUS_OFF)
Job API Tandem
81
5 API 関数 ク ラ ス
OS
サポー ト す る OS を指定 し ます。
Windows:Windows2000 ま たは Windows2003 シ ス テ ムか ら ク ロ ーニ ン グ
イ メ ージ を作成 し ます。
Windows2008: Windows2008 シ ス テ ムか ら ク ロ ーニ ン グ イ メ ージ を作成
し ます。
Linux: Linux シ ス テ ムか ら ク ロ ーニ ン グ イ メ ージ を作成 し ます。
こ のパ ラ メ ー タ は必須です。
LinuxConfigLocation
イ メ ージ作成を行 う シ ス テ ムの /etc デ ィ レ ク ト リ の場所を指定 し ます。
こ のパ ラ メ ー タ は、 Linux を OS と し て選択 し た場合のみ適用 さ れ、 必
須です。
WindowsAdminName
OS WINDOWS （Windows 依存） に対 し て管理者権限を持つ ロ グ イ ン名
を指定 し ます。 こ のパ ラ メ ー タ は、 Windows ま たは Windows2008 を
OS と し て選択 し た場合のみ適用 さ れます。
デフ ォ ル ト 値 ： ""
こ れは参照シ ス テ ムの ロ ーカル管理者ア カ ウ ン ト であ る必要があ り ま
す。
デプ ロ イ メ ン ト サーバま たは参照シ ス テ ムが ド メ イ ンに所属 し てい る
場合、 <hostname>\administrator ま たは <IP address>\administrator の形
式で こ のパ ラ メ ー タ を指定 し て く だ さ い。
WindowsAdminPassword
前述の管理者ユーザに対す る パ ス ワー ド を指定 し ます。
こ のパ ラ メ ー タ は Windows ま たは Windows2008 を OS と し て選択 し て
い る 場合のみ適用 さ れます。
デフ ォ ル ト 値 ： ""
WindowsProductID
参照シ ス テ ムの ProductID を指定 し ます。
こ のパ ラ メ ー タ は、 Windows （必須） ま たは Windows2008 （オプシ ョ
ン） を OS と し て選択 し た場合のみ適用 さ れます。
デフ ォ ル ト 値 ： ""
LogicalDisk
論理デ ィ ス ク を指定 し ます。
デフ ォ ル ト 値 ： 0
82
Job API Tandem
5.6 リ ポジ ト リ 管理
Verify
バ ッ ク ア ッ プを行 う 前に フ ァ イ ルシ ス テ ム を確認 し ます。
0: (OFF)
1: (ON)
デフ ォ ル ト 値 ： 1 (ON)
Compress
圧縮を実行 し ます。
0: (OFF)
1: (ON)
デフ ォ ル ト 値 ： 1 (ON)
UnknownFail
未知の フ ァ イ ルシ ス テ ムが検出 さ れた場合、 SaveMode=
SAVEMODE_FILESYSTEM_DEPENDENT と 合わせて応答を指定 し ま
す。
0 (OFF): 関数処理を続行 し ます。
1 (ON): 関数処理はエ ラ ーにな り 失敗 し ま し た。
デフ ォ ル ト 値 ： 0 (OFF)
FastMode
Linux の ク ロ ーニ ン グ イ メ ージ を作成す る ために使用 し ます。 ext2/ext3
フ ァ イ ルシ ス テ ムの イ メ ージ生成の最適化を指定 し ます。
0 (OFF): イ メ ージ高速生成を無効に し ます。
1 (ON): イ メ ージ高速生成を有効に し ます。
最適化 さ れて作成 さ れた イ メ ージは ExpandLastPartition を使っ て ク
ロ ーニ ン グで き ません （Deploy を ご覧 く だ さ い）。
デフ ォ ル ト 値 ： 0 (OFF)
ServerAccessData
こ のパ ラ メ ー タ は、 Windows ま たは Windows2008 を OS と し て選択 し
た場合のみ適用 さ れます。 こ のパ ラ メ ー タ には、 シ ス テ ムの準備中に
Windows シ ス テ ムへア ク セ スす る ために使用す る IP ア ド レ ス ま たはホ
ス ト 名 （完全修飾名が許可 さ れてい ます） を含んでい る 場合があ り ま
す。 こ のパ ラ メ ー タ が空白の場合、 デプ ロ イ メ ン ト 構成のサーバ名が
使用 さ れます。
デフ ォ ル ト 値 ： ""
Job API Tandem
83
5 API 関数 ク ラ ス
InstallationLocale
Windows2008 のみで使用で き ます。 こ のパ ラ メ ー タ は、 "Fujitsu OEM"
DVD ("Multi Language" DVD) か ら 参照シ ス テ ム を イ ン ス ト ール し た場
合に使用 し ます。 "Microsoft" DVD に対 し て こ のパ ラ メ ー タ を使用 し な
いで く だ さ い。
デフ ォ ル ト 値 ： ""
使用可能な値 ：
English (United States)
German (Germany)
Japanese (Japan)
French (France)
Spanish (Spain)
Italian (Italy)
Dutch (Netherlands)
Portuguese (Portugal)
Portuguese (Brazil)
Czech (Czech Republic)
Polish (Poland)
Russian (Russia)
Swedish (Sweden)
Hungarian (Hungary)
Turkish (Turkey)
Korean (Korea)
Chinese (PRC)
スナ ッ プ シ ョ ッ ト イ メ ージ を作成する ために使用可能なパラ メ ー タ の表
次のパ ラ メ ー タ 一覧表では、 IMAGETYPE_SNAPSHOT タ イ プのイ メ ージ を
作成する ために Params の配列で指定する固有の名前 と 値を説明 し ます。
SaveMode
ハー ド デ ィ ス ク の イ メ ージ作成中に使用す る 保存モー ド を指定 し ます。
0 (SAVEMODE_FILESYSTEM_DEPENDENT): パーテ ィ シ ョ ン内で使用
さ れてい る セ ク タ のみを保存 し ます。
1 (SAVEMODE_FILESYSTEM_INDEPENDENT): パーテ ィ シ ョ ン内のす
べてのセ ク タ を保存 し ます。
2 (SAVEMODE_RAW): デ ィ ス ク すべて を保存 し ます。
デフ ォ ル ト 値 ： 0 (SAVEMODE_FILESYSTEM_DEPENDENT)
84
Job API Tandem
5.6 リ ポジ ト リ 管理
ShutdownType
サーバが動作 し てい る 場合の応答を指定 し ます。
0 (SHUTDOWNTYPE_NO): シ ャ ッ ト ダ ウ ン し ません。 ただ し 、 サーバ
の電源が切断 さ れていない場合はエ ラ ーを返 し ます。
1 (SHUTDOWNTYPE_ACPI):
2 (SHUTDOWNTYPE_GRACEFUL): ServerView エージ ェ ン ト を使っ て
シ ャ ッ ト ダ ウ ン し ます。
デフ ォ ル ト 値 ： 0 (SHUTDOWNTYPE_NO)
ShutdownUsername
ServerView エージ ェ ン ト シ ャ ッ ト ダ ウ ンに対す る ユーザア カ ウ ン ト 名
を指定 し ます。
ShutdownType が 2(SHUTDOWNTYPE_GRACEFUL) の場合、 こ のパ ラ
メ ー タ は必須です。
デフ ォ ル ト 値 ： ""
ShutdownPassword
前述のユーザに対す る パス ワ ー ド を指定 し ます。
ShutdownType が 2 の場合、 こ のパ ラ メ ー タ は必須です。
デフ ォ ル ト 値 ： ""
FinalPowerStatus
イ メ ージ生成後のサーバの電源状態を指定 し ます。
0 (FINALPOWERSTATUS_OFF): サーバの電源が切断 さ れてい ます。
1 (FINALPOWERSTATUS_ON): イ ン ス ト ール さ れてい る OS が起動 さ れ
ます。
こ のパ ラ メ ー タ を使っ て、 イ メ ージ生成後、 サーバ OS シ ス テ ム を起
動す る か、 ま たはサーバの電源を切断す る か を選択 し ます。
デフ ォ ル ト 値 ： 0 (FINALPOWERSTATUS_OFF)
LogicalDisk
論理 ド ラ イ ブを指定 し ます。
デフ ォ ル ト 値 ： 0
Verify
バ ッ ク ア ッ プを行 う 前に フ ァ イ ルシ ス テ ム を確認 し ます。
0: (OFF)
1: (ON)
デフ ォ ル ト 値 ： 1 (ON)
Compress
圧縮を実行 し ます。
0: (OFF)
1: (ON)
デフ ォ ル ト 値 ： 1 (ON)
Job API Tandem
85
5 API 関数 ク ラ ス
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合は、
ErrorCode は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合は、 ErrorString
は空白です。
JobID
詳細を取得す る ために GetJobStatusDetails に対 し て使用す る、 ユニー
ク な ID です。
86
Job API Tandem
5.6 リ ポジ ト リ 管理
5.6.5
DeleteImage
DeleteImage 関数は指定 し た イ メ ージ フ ァ イルを削除 し ます。
構文
DeleteImage Imagefilename=<string>
RepositoryName=<string>
SubPath=<string>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
Imagefilename
削除す る イ メ ージの名前を指定 し ます。
RepositoryName
イ メ ージが含まれてい る リ ポジ ト リ 名を指定 し ます。
SubPath
削除す る イ メ ージが含まれてい る リ ポジ ト リ への完全修飾サブパ ス を
指定 し ます。
デフ ォ ル ト 値 ： ""
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合は、 ErrorString
は空白です。
Job API Tandem
87
5 API 関数 ク ラ ス
5.6.6
GetRepositoryContents
関数 GetRepositoryContents を使 っ て、 指定 し た リ ポジ ト リ または指定 し た
タ イ プのすべての リ ポジ ト リ で検出 さ れた イ メ ージ フ ァ イル名を一覧表示 し
ます。
構文
GetRepositoryContents RepositoryName=<string>
RepositoryType=<int>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
RepositoryName
リ ポジ ト リ 名を指定 し ます。 RepositoryName を指定 し ない場合、 指定
し た種類の リ ポジ ト リ にあ る 内容がすべて表示 さ れます。
デフ ォ ル ト 値 ： ""
RepositoryType
リ ポジ ト リ の種類を指定 し ます。
0 (ALL)
1 (REPOSITORYTYPE_CLONING_IMAGE)
2 (REPOSITORYTYPE_BOOT_IMAGE)
3 (REPOSITORYTYPE_CONFIG_FILE)
4 (REPOSITORYTYPE_DEPLOYMENT_TABLE)
デフ ォ ル ト 値 ： 0 (ALL)
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
88
Job API Tandem
5.6 リ ポジ ト リ 管理
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合は、 ErrorString
は空白です。
FilenameList
イ メ ージ フ ァ イ ル名の配列を返 し ます。
Job API Tandem
89
5 API 関数 ク ラ ス
5.6.7
ReadImagefilenameList
ReadImagefilenameList 関数は、 既知の Deployment Manager リ ポジ ト リ で検
出 さ れた イ メ ージ フ ァ イル名の配列を返 し ます。
構文
ReadImagefilenameList RDServer=<string>
UserKey=<string>
パラ メ ー タ
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合は、 ErrorString
は空白です。
FilenameList
イ メ ージ フ ァ イ ル名の配列を返 し ます。
90
Job API Tandem
5.6 リ ポジ ト リ 管理
5.6.8
ReadImageInfoText
ReadImageInfoText 関数は、 CreateImage 関数の呼び出 し 中に検出 さ れた イ メ ー
ジ文書を取 り 出 し ます。
構文
ReadImageInfoText ImagePath=<string>
RDServer=<string>
UserKey=<string>
Parameter
ImagePath
イ メ ージの名前を含む完全修飾パ ス を指定 し ます。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合は、 ErrorString
は空白です。
InfoText
イ メ ージ文書に戻 り ます。
Job API Tandem
91
5 API 関数 ク ラ ス
5.6.9
GetImageProperties
GetImageProperties 関数は CreateImage 関数の呼び出 し 中に生成 さ れた、 また
は SetImageProperties 関数に よ っ て定義 さ れた イ メ ージのプ ロパテ ィ を返 し
ます。
構文
GetImageProperties ImagePath=<string>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
ImagePath
イ メ ージの名前を含む完全修飾パス を指定 し ます。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
ImageProperties
イ メ ージの構成を XML 文書の形式で返 し ます。
92
Job API Tandem
5.7 デ ィ レ ク ト リ 管理
5.7
デ ィ レ ク ト リ 管理
前述の と お り 、 既存の リ ポジ ト リ には複数のデ ィ レ ク ト リ と サブデ ィ レ ク ト
リ が存在 し ます。 こ の項では、 リ ポジ ト リ にあ るデ ィ レ ク ト リ を管理する た
めの Job API 関数すべて を説明 し ます。
5.7.1
CreateDirectory
CreateDirectory 関数は指定 し た リ ポジ ト リ に新 し いデ ィ レ ク ト リ を作成 し ま
す。
構文
CreateDirectory DirectoryName=<string>
RepositoryName=<string>
SubPath=<string>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
DirectoryName
新 し いデ ィ レ ク ト リ の名前を指定 し ます。
RepositoryName
新 し いデ ィ レ ク ト リ を収容す る リ ポジ ト リ の名前を指定 し ます。
SubPath
指定 し た リ ポジ ト リ に相対す る 、 新 し いデ ィ レ ク ト リ への部分修飾パ
ス を指定 し ます。
デフ ォ ル ト 値 ： ""
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
Job API Tandem
93
5 API 関数 ク ラ ス
戻り値
ErrorCode
最後に実行 し た際の診断番号を返 し ます。 正常に実行 さ れた場合、
ErrorCode は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
94
Job API Tandem
5.7 デ ィ レ ク ト リ 管理
5.7.2
DeleteDirectory
DeleteDirectory 関数は、 所定の リ ポジ ト リ 内の指定デ ィ レ ク ト リ を完全に削
除 し ます。 指定 し たデ ィ レ ク ト リ が空でない場合、 すべての フ ァ イル （イ
メ ージ フ ァ イル） と サブデ ィ レ ク ト リ が最初に削除 さ れます。
構文
DeleteDirectory DirectoryName=<string>
RepositoryName=<string>
SubPath=<string>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
DirectoryName
削除す る デ ィ レ ク ト リ の名前を指定 し ます。
RepositoryName
指定 し たデ ィ レ ク ト リ を含む リ ポジ ト リ の名前を指定 し ます。
SubPath
指定の リ ポジ ト リ に相対す る 、 新 し いデ ィ レ ク ト リ への部分修飾パ ス
を指定 し ます。
デフ ォ ル ト 値 ： ""
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
Job API Tandem
95
5 API 関数 ク ラ ス
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
96
Job API Tandem
5.7 デ ィ レ ク ト リ 管理
5.7.3
GetDirectoryContents
GetDirectoryContents 関数は、 指定 し たデ ィ レ ク ト リ にあ る既知の フ ァ イル と
サブデ ィ レ ク ト リ の一覧を取得 し ます。
構文
GetDirectoryContents DirectoryName=<string>
RepositoryName=<string>
SubPath=<string>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
DirectoryName
デ ィ レ ク ト リ の名前を指定 し ます。
RepositoryName
リ ポジ ト リ の名前を指定 し ます。
SubPath
指定 し た リ ポジ ト リ に相対す る デ ィ レ ク ト リ への部分修飾パ ス を指定
し ます。
デフ ォ ル ト 値 ： ""
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
Job API Tandem
97
5 API 関数 ク ラ ス
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
FileList
FileData 名の配列を返 し ます。
戻 り リ ス ト のレ イ アウ ト
Name=<string> Type=<int> Size=<int> ModificationDate=<long>
Name
フ ァ イ ル名を表示 し ます。
Type
フ ァ イ ルの種類を表示 し ます。
0 (FILETYPE_DIRECTORY)
1 (FILETYPE_INSTALLATION_CONFIG)
2 (FILETYPE_CLONING_IMAGE)
3 (FILETYPE_OTHER)
Size
フ ァ イ ルのサ イ ズ を表示 し ます。
ModificationDate
最終修正日を表示 し ます。
98
Job API Tandem
5.8 グループ管理
5.8
グループ管理
大規模なデプ ロ イ メ ン ト において、 多数のサーバはほぼ同一の構成で同時並
行にデプ ロ イ メ ン ト さ れます。 同 じ 、 または類似 し た構成のサーバを 1 つの
グループにま と める と 作業を最小限に抑え る こ と がで き ます。 一般的にグ
ループ と は、 共通で なおかつ個々のプ ロパテ ィ を持つグループ メ ンバの集合
体に名前をつけた も のです。
Job API は 2 種類のグループの割 り 当て をサポー ト し ます。 その 2 種類 と は、
1:N と N:N のグループ プ ロパテ ィ 割 り 当てです。 1:N プ ロパテ ィ 割 り 当ての
場合、 グループ内の各サーバに対 し て、 指定 し たグループ プ ロパテ ィ を割 り
当て ます。 一方、 N:N 割 り 当ての場合、 プ ロパテ ィ は
SetGroupMemberProperties 関数を介 し てグループ内の各サーバに割 り 当て ら れ
ます。 また、 指定 し たグループ プ ロパテ ィ は考慮 さ れません。
さ ら に、 グループ内に も グループ を作成する こ と がで き ます。 こ う し て作成
さ れたサブグループによ り 、 よ り 詳細なグループ化が可能にな り ます。
Job API Tandem
99
5 API 関数 ク ラ ス
5.8.1
CreateGroup
CreateGroup は指定 し たグループの種類 （GroupType) に応 じ てグループ を作成
し ます。 新 し く 作成 さ れたグループは、 グループの種類にかかわ ら ず空であ
り 、 かつ、 グループ プ ロパテ ィ も 存在 し ません。 正常にグループの作成が完
了する と 、 特有のグループ識別子 （GroupID） が返 さ れます。 他のグループ
関数で こ の GroupID を使 っ て、 既存のグループ を識別 し ます。
構文
CreateGroup GroupName=<string>
GroupType=<int>
ParentGroupID=<int>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
GroupName
新 し いグループの名前を指定 し ます。
GroupType
グループの種類を指定 し ます。
2 (GROUPTYPE_CLONING)
3 (GROUPTYPE_INSTALLATION)
こ のパ ラ メ ー タ は必須です。
ParentGroupID
新 し いサブグループ を作成す る ため既存のグループ識別子を指定 し ま
す。
デフ ォ ル ト 値 ： 0
I 現行バージ ョ ンの Job API では、 ParentGroupID は指定で き ませ
ん。 そのため、 こ のパ ラ メ ー タ は評価 さ れません。 し たが っ て、
現行バージ ョ ン ではサブグループ を作成する こ と はで き ません。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
100
Job API Tandem
5.8 グループ管理
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
GroupID
新 し いグループエ ン ト リ 特有のグループ識別子を返 し ます。
Job API Tandem
101
5 API 関数 ク ラ ス
5.8.2
DeleteGroup
既存のグループ を削除する ためには、 DeleteGroup 関数を使用 し ます。 指定 し
たグループが空ではない場合、 すべてのグループ メ ンバがまず削除 さ れます。
グループ メ ンバを削除する こ と で、 Job API の RemoveGroupMember 関数が呼
び出 さ れます。
構文
DeleteGroup GroupID=<int>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
GroupID
削除す る グループエ ン ト リ を指定 し ます。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
102
Job API Tandem
5.8 グループ管理
5.8.3
GetGroupList
GetGroupList 関数は、 すべての既知のグループ を一覧表示 し ます。 戻 り リ ス
ト の範囲は、 特定の GroupType を 1 つ選択 し て制限する こ と がで き ます。
構文
GetGroupList GroupType=<int>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
GroupType
情報を取得す る グループの種類を指定 し ます。
0 (ALL)
2 (GROUPTYPE_CLONING)
3 (GROUPTYPE_INSTALLATION)
デフ ォ ル ト 値 ： 0 (ALL)
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
GroupList
GroupData タ イ プの構造体の配列です。
Job API Tandem
103
5 API 関数 ク ラ ス
戻 り リ ス ト のレ イ アウ ト
GroupID=<int> GroupName=<string> GroupType=<int>
GroupID
グループのグループ識別子を表示 し ます。
GroupName
グループの名前を表示 し ます。
GroupType
グループの種類を表示 し ます。
2 (GROUPTYPE_CLONING)
3 (GROUPTYPE_INSTALLATION)
104
Job API Tandem
5.8 グループ管理
5.8.4
SetGroupProperties
SetGroupProperties 関数は、 既存グループのプ ロパテ ィ を設定および修正 し ま
す。 し たが っ て、 GetGroupList 関数が返 し た有効なグループ識別子を識別す
る必要があ り ます。
構文
SetGroupProperties GroupID=<int>
GroupProperties=<ArrayOf_PropertyData>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
GroupID
既存グループのグループ識別子を指定 し ます。
GroupProperties
PropertyData タ イ プの構造体の配列を指定 し ます。 こ の配列には、 使
用可能な グループのプ ロ パテ ィ が含まれてい ます。 詳 し く は、 26 ペー
ジの "ArrayOf_PropertyData 構造体の レ イ ア ウ ト " を ご覧 く だ さ い。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 し た場合、 ErrorCode は
0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合は、 ErrorString
は空白です。
Job API Tandem
105
5 API 関数 ク ラ ス
グループ プ ロパテ ィ のレ イ アウ ト
Name=<string> Value=<string>
Name
グループプ ロ パテ ィ の既知名を指定 し ます。
Value
指定 し たプ ロ パテ ィ の値を指定 し ます。
ク ローニ ンググループ プ ロパテ ィ の表
ImagePath
イ メ ージの名前を含む完全修飾パス を指定 し ます。
106
Job API Tandem
5.8 グループ管理
5.8.5
GetGroupProperties
GetGroupMemberProperties 関数は、 指定 し た メ ンバ と GroupID に対する プ ロ
パテ ィ の一覧を返 し ます。
構文
GetGroupProperties GroupID=<int>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
GroupID
既存グループの識別子を指定 し ます。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
GroupName
グループの名前を返 し ます。
GroupType
グループの種類を返 し ます。
2 (GROUPTYPE_CLONING)
3 (GROUPTYPE_INSTALLATION)
GroupProperties
PropertyData タ イ プの構造体の配列を返 し ます。 詳 し く は、 106 ページ
の " グループプ ロ パテ ィ の レ イ ア ウ ト " と 106 ページの " ク ロ ーニ ン
グ グループプ ロ パテ ィ の表 " を ご覧 く だ さ い。
Job API Tandem
107
5 API 関数 ク ラ ス
5.8.6
AddGroupMember
AddGroupMember 関数は、 指定 し たグループへ新 し いグループ を追加 し ます。
現在の Job API バージ ョ ン では、 グループ メ ンバは MAC ア ド レ ス、 IP ア ド
レ ス、 またはホス ト 名 （MemberId） に よ っ て識別 さ れたサーバにな る こ と が
あ り ます。
構文
AddGroupMember MemberIdList=<ArrayOf_MemberIdentifier>
GroupID=<int>
RDServer=<string>
UserKey=<string>
Parameter
MemberIdList
新 し いグループ メ ンバの リ ス ト の 1 つを指定 し ます。 MemberIdentifier
構造体についての詳細は、 109 ページの "MemberIdentifier 構造体の レ
イ ア ウ ト " を ご覧 く だ さ い。
GroupID
新 し い メ ンバを追加す る グループ を指定 し ます。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
I MemberIdList で指定 し た メ ンバの う ち 1 つで も 指定グループへ追加で
き ない場合、 関数にエ ラ ーが発生 し 、 すべての指定 メ ンバが追加 さ れ
ません。
108
Job API Tandem
5.8 グループ管理
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
MemberIdentifier 構造体のレ イ アウ ト
メ ンバを識別する ために識別子の種類を選択 し ます （例 ： MAC ア ド レ ス、 IP
ア ド レ ス、 ホス ト 名な ど）。 次の構造体を使 っ て、 指定 し た種類で メ ンバを識
別 し ます。
Identifier=<string> Type=<int>
Identifier
メ ンバ特有の識別子を含む文字列を指定 し ます。
Type
指定 し た メ ンバ識別子の種類を指定 し ます。
0 (IDENTIFIERTYPE_MAC): ネ ッ ト ワー ク イ ン タ フ ェ ース の物理ア ド レ
ス
1 (IDENTIFIERTPE_IP): サーバの IP ア ド レ ス。
こ れは、 RdDeplServerList で返 さ れた SV_IPAddress フ ィ ール ド であ る
必要があ り ます。
2 (IDENTIFIERTYPE_NAME): サーバのホ ス ト 名。
こ れは、 RdDeplServerList で返 さ れた ServerName フ ィ ール ド であ る必
要があ り ます。
Job API Tandem
109
5 API 関数 ク ラ ス
5.8.7
RemoveGroupMember
RemoveGroupMember 関数は、 指定 し たグループ メ ンバを所定のグループか ら
削除 し ます。 グループ自身は削除 さ れません。
構文
RemoveGroupMember MemberId=<MemberIdentifier>
GroupID=<int>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
MemberId
削除す る グループ メ ンバを指定 し ます。
MemberIdentifier 構造体についての詳細は、 109 ページの
"MemberIdentifier 構造体の レ イ ア ウ ト " を ご覧 く だ さ い。
GroupID
前回 CreateGroup を呼び出 し た際に取得 し た GroupID を指定 し ます。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
110
Job API Tandem
5.8 グループ管理
5.8.8
GetGroupMemberList
GetGroupMemberProperties 関数は、 GroupID を使 っ て、 指定 メ ンバ と 所定グ
ループのプ ロパテ ィ を一覧表で返 し ます。
構文
GetGroupMemberList GroupID=<int>
MemberIdType=<int>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
GroupID
返 さ れた メ ンバの既知グループ を指定 し ます。
MemberIdType
ど の戻 り メ ンバの メ ンバ識別子 タ イ プ を使用す る か を指定 し ます。
0 (IDENTIFIERTYPE_MAC): 最初のネ ッ ト ワー ク イ ン タ フ ェ ース の物理
ア ド レ ス です。
1 (IDENTIFIERTYPE_IP): サーバの IP ア ド レ ス です。
2 (IDENTIFIERTYPE_NAME): サーバのホ ス ト 名です。 指定 し た識別子
が空の場合、 別の識別子を返 し ます。
デフ ォ ル ト 値 ： 0 (IDENTIFIERTYPE_MAC)
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
Job API Tandem
111
5 API 関数 ク ラ ス
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
MemberList
MemberIdentifier の構造体の配列を返 し ます。
戻 り リ ス ト のレ イ アウ ト
リ ポジ ト リ の戻 り リ ス ト と その詳細は次のレ イ アウ ト を使用 し ます。
Identifier=<string> Type=<int>
Identifier
メ ンバ特有の識別子を含む文字列を表示 し ます。
Type
パ ラ メ ー タ MemberIdType の設定に応 じ て、 メ ンバ識別子の種類を表示
し ます。
0 (IDENTIFIERTYPE_MAC): ネ ッ ト ワ ー ク イ ン タ フ ェ ース の物理ア ド レ
ス。
1 (IDENTIFIERTYPE_IP): サーバの IP ア ド レ ス
2 (IDENTIFIERTYPE_NAME): サーバのホ ス ト 名
3 (IDENTIFIERTYPE_GROUPID): グループ ID
112
Job API Tandem
5.8 グループ管理
5.8.9
SetGroupMemberProperties
SetGroupMemberProperties 関数を使 っ て、 グループ メ ンバの各プ ロパテ ィ を設
定 し ます。 PropertyData タ イ プ （名前 / 値のペア） を指定する こ と に よ っ て、
プ ロパテ ィ の任意 リ ス ト を定義 し ます。 指定 さ れたプ ロパテ ィ は こ のグルー
プ内のグループ メ ンバ （サーバ） 固有の ものです。
構文
SetGroupMemberProperties MemberId=<MemberIdentifier>
GroupID=<int>
GroupMemberProperties=<ArrayOf_PropertyData>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
MemberId
グループ メ ンバの識別子を指定 し ます。 MemberIdentifier についての詳
細は 109 ページの "MemberIdentifier 構造体の レ イ ア ウ ト " を ご覧 く だ
さ い。
GroupID
既存グループの識別子を指定 し ます。
GroupMemberProperties
PropertyData タ イ プの構造体の配列を指定 し ます。 構造体についての
詳細は 114 ページの " イ ン ス ト ールグループ メ ンバプ ロ パテ ィ の レ イ
ア ウ ト " を ご覧 く だ さ い。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
Job API Tandem
113
5 API 関数 ク ラ ス
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
イ ン ス ト ールグループ メ ンバプ ロパテ ィ のレ イ アウ ト
Name=<string> Value=<string>
Name
グループ メ ンバプ ロ パテ ィ の既知名を指定 し ます。
Value
指定 し た グループ メ ンバの値を指定 し ます。
グループ メ ンバプ ロパテ ィ のイ ン ス ト ール表
ConfigPath
Installation Manager で定義 さ れた構成名を含む完全修飾パ ス を指定 し
ます。
114
Job API Tandem
5.8 グループ管理
5.8.10 GetGroupMemberProperties
所定グループ メ ンバのプ ロパテ ィ を取得する ためには、 GetGroupMember 関数
を使 っ てグループ メ ンバのプ ロパテ ィ を一覧表示 し ます。
構文
GetGroupMemberProperties MemberId=<MemberIdentifier>
GroupID=<int>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
MemberId
グループ メ ンバの識別子を指定 し ます。 MemberIdentifier の構造体につ
いての詳細は、 109 ページの "MemberIdentifier 構造体の レ イ ア ウ ト "
を ご覧 く だ さ い。
GroupID
グループの識別子を指定 し ます。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
Job API Tandem
115
5 API 関数 ク ラ ス
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
GroupMemberProperties
PropertyData タ イ プの構造体の配列を返 し ます。 詳 し く は、 114 ページ
の " イ ン ス ト ールグループ メ ンバプ ロ パテ ィ の レ イ ア ウ ト " と 114
ページの " グループ メ ンバプ ロ パテ ィ の イ ン ス ト ール表 " を ご覧 く だ
さ い。
116
Job API Tandem
5.9 デプ ロ イ メ ン ト 管理
5.9
デプ ロ イ メ ン ト 管理
原則 と し て、 Job API にはデプ ロ イ メ ン ト のための手順がい く つかあ り ます。
–
ク ローニ ン グ
ク ローニ ン グ と は、 マス タ シ ス テムに イ ン ス ト ール し てマ ス タ シ ス テムの
イ メ ージ フ ァ イルを作成 し （79 ページの 「CreateImage」 の項を ご覧 く
だ さ い）、 そ し て こ のイ メ ージ フ ァ イルを同 じ 構成パラ メ ー タ で イ ン ス
ト ールするサーバグループへ ク ローニ ングする こ と を意味 し ます。
– 大規模な リ モー ト イ ン ス ト ール
大規模な リ モー ト イ ン ス ト ール と は、 Installation Manager で作成 し た コ
ン フ ィ グ レーシ ョ ン フ ァ イルを使い、 こ の フ ァ イルをサーバやサーバグ
ループへ割 り 当て、 そ し てすべてのサーバに対する イ ン ス ト ールを開始す
る こ と を意味 し ます。
Job API Tandem
117
5 API 関数 ク ラ ス
5.9.1
Deploy
Deploy 関数を使 っ てグループにあ るすべてのサーバ、 指定 し た 1 つのサー
バ、 またはグループ内のサーバの リ ス ト のデプ ロ イ メ ン ト を管理 し ます。 一
般的に認め られているパラ メ ー タ （例 DeplomentServer） は通常の方法で指定
する必要があ り ます。 また、 その他のパ ラ メ ー タ はパ ラ メ ー タ 構造
（ParameterData） の配列によ っ て指定 し ます。 すべての既知パ ラ メ ー タ の リ
ス ト はグループの種類によ っ て異な り ます。 こ れに関 し ては次の節で説明 し
ています。
Deploy 関数は新 し いジ ョ ブ を開始 し 、 Job ID を返 し ます。 以降の
GetJobStatusDetails の呼び出 し 入力 と し て こ の Job ID を使用する こ と がで き
ます。
単一サーバのデプ ロ イ メ ン ト を簡単にする ために、 Job API は次の 2 つのデ
プ ロ イ メ ン ト モー ド を識別 し ます。
– シ ングルサーバモー ド
こ のモー ド は GroupID が 0 で、 ServerIdList でサーバを 1 つだけ指定 し た
場合、 有効にな り ます。 し たが っ て、 所定の単一サーバだけがデプ ロ イ メ
ン ト さ れる ため、 グループ管理は不要です。
– グループ モー ド
グループ モー ド を使 う と 、 1 つの Deploy 関数を実行する だけで複数の
サーバをデプ ロ イ メ ン ト する こ と がで き ます。 し たがっ て、 デプ ロ イ メ ン
ト を実行する前に、 グループ管理を使 っ てサーバが含まれる適切なグルー
プ を設定する必要があ り ます。 また、 ServerIdList 経由で指定 さ れた所定
サーバにある所定グループ を縮小で き ます。
I デプ ロ イ メ ン ト のプ ラ ッ ト フ ォ ーム WinPE MDP で ク ローニ ン グ、 ま
たはイ ン ス ト ールする場合、 こ の関数には Installation Manager が必要
です。
118
Job API Tandem
5.9 デプ ロ イ メ ン ト 管理
構文
Deploy GroupID=<int>
ServerIdList=<ArrayOf_ServerIdentifier>
Params=<ArrayOf_ParameterData>
DeploymentServer=<string>
DeploymentUsername=<string>
DeploymentPassword=<string>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
GroupID
既存グループの識別子を指定す る、 ま たは単一サーバ選択モー ド で 0
を指定 し ます。
ServerIdList
選択 し た グループ外の一時サブグループを定義す る ために、 サーバの
リ ス ト を指定 し ます。 サーバを指定 し ない場合、 こ の関数はグループ
のすべてのサーバに対 し て適用 さ れます。 サーバを指定す る には、
ServerIdentifier タ イ プの構造体の配列を使用 し ます。 こ の構造体に関す
る 定義は、 26 ページの "ServerIdentifier 構造体の レ イ ア ウ ト " を ご覧 く
だ さ い。
Params
ParameterData タ イ プの構造体の配列を指定 し ます。 構造体に関す る 詳
細は 27 ページの "ArrayOf_ParameterData 構造体の レ イ ア ウ ト " を ご覧
く だ さ い。 ま た、 使用可能なパ ラ メ ー タ については 120 ページの " ク
ロ ーニ ン グに使用で き る パ ラ メ ー タ " と 127 ページの " イ ン ス ト ール
に使用で き る パ ラ メ ー タ " を ご覧 く だ さ い。
DeploymentServer
デプ ロ イ メ ン ト サーバのホ ス ト 名、 ま たは、 1 つ目の LAN ポー ト の IP
ア ド レ ス を指定 し ます。
DeploymentUsername
指定 し たデプ ロ イ メ ン ト サーバのユーザア カ ウ ン ト 名を指定 し ます。
DeploymentPassword
デプ ロ イ メ ン ト サーバ上の指定 し たユーザア カ ウ ン ト に対す る パ ス
ワ ー ド を指定 し ます。
Job API Tandem
119
5 API 関数 ク ラ ス
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
I ShutdownType が 3 で IPMI を搭載 し ていないサーバを指定 し た場合、
シ ャ ッ ト ダウ ンは手動で行 う 必要があ る ため、 こ の関数は正常に実行
さ れた と 返 し ます。
ク ローニ ングに使用で き るパラ メ ー タ
デプ ロ イ メ ン ト 方式 「ク ローニ ング」 を実行する ためにパラ メ ー タ の配列で
指定で き るパ ラ メ ー タ を示 し ます。
ImagePath
イ メ ージ名を含む完全修飾パ ス を指定 し ます。
こ のパ ラ メ ー タ は単一サーバ選択モー ド では必須です。
PreparationMode
準備モー ド を指定 し ます。
1 (PREPARATIONMODE_BLADEOPTIMIZED):
2 (PREPARATIONMODE_ALLPRIMERGY):
3 (PREPARATIONMODE_GENERICBOOTIMAGE):
4 (PREPARATIONMODE_MANUAL):
こ のパ ラ メ ー タ は必須です。
1 （PREPARATIONMODE_BLADEOPTIMIZED） は廃止にな り ま し た。
使用で き る のは legacy blade BX300 のみです。 その他のブ レー ド すべて
に対 し ては、 2 （PREPARATIONMODE_ALLPRIMERGY） を使用 し て く
だ さ い。 こ の場合、 デプ ロ イ メ ン ト のプ ラ ッ ト フ ォーム WinPE MDP を
使用 し ます （使用 し ない場合は、 デプ ロ イ メ ン ト 構成で別のモー ド を
指定 し ます）。
BootImage
選択 し たブー ト イ メ ージの格納場所の完全修飾パ ス を指定 し ます。
こ のパ ラ メ ー タ は PreparationMode が 3
（PREPARATIONMODE_GENERICBOOTIMAGE） の場合のみ、 使用で き
ます。 ま た こ のパ ラ メ ー タ は必須です。
120
Job API Tandem
5.9 デプ ロ イ メ ン ト 管理
BootImageType
ブー ト イ メ ージの種類を指定 し ます。
0 （BOOTIMAGETYPE_BOOTSTRAPIMAGE） : 複数の部分か ら 成 る
ブー ト イ メ ージです。 1 番目の部分は PXE ブー ト です。 残 り の部分は
tftp ダ ウ ン ロ ー ド で要求 し ます。
1 （BOOTIMAGETYPE_DOSIMAGE） : ブー ト イ メ ージは 「仮想」 フ
ロ ッ ピー イ メ ージです （1.4MB フ ァ イ ル）。
こ のパ ラ メ ー タ は PreparationMode が 3
（PREPARATIONMODE_GENERICBOOTIMAGE） の場合にのみ使用で き
ます。
デフ ォ ル ト 値 ： BOOTSTRAPIMAGE
ControllerVendor
コ ン ト ロ ー ラ のベン ダ を指定 し ます。
LSI/Mylex Raid Controller
Adaptec Raid Controller
Promise Raid Controller
Any Raid Controller （デプ ロ イ メ ン ト のプ ラ ッ ト フ ォームが WinPE MDP
の場合のみ）
Fujitsu Raid Controller （デプ ロ イ メ ン ト のプ ラ ッ ト フ ォームが WinPE
MDP の場合のみ）
ControllerVendor/ControllerFamily/ControllerName/RaidType に対 し て使用
可能な値は Installation Manager （フ ァ イ ル RaidDef.xml を ご覧 く だ さ い）
に よ り 定義 さ れます。
ControllerVendor だけ を指定 し て、 ControllerFamily と ControllerName を
省略す る こ と は可能です。 同 じ ベン ダで も フ ァ ミ リ や名前が異な る 複
数の コ ン ト ロ ー ラ がご使用の コ ン ピ ュ ー タ にあ り 、 どれを使用す る か
明確に指定 し たい時は、 こ の 2 つのパ ラ メ ー タ の う ち一方ま たは両方
を指定 し ます。
こ のパ ラ メ ー タ は、 PreparationMode が 2
（PREPARATIONMODE_ALLPRIMERGY） の場合のみ使用で き 、 ま た必
須です。
ControllerFamily
コ ン ト ロ ー ラ フ ァ ミ リ を指定 し ます。
こ のパ ラ メ ー タ は、 PreparationMode が 2
（PREPARATIONMODE_ALLPRIMERGY） の場合のみ使用で き 、 ま た必
須です。
デフ ォ ル ト 値 ： ""
Job API Tandem
121
5 API 関数 ク ラ ス
ControllerName
コ ン ト ロ ー ラ の名前を指定 し ます。
こ のパ ラ メ ー タ は、 PreparationMode が 2
（PREPARATIONMODE_ALLPRIMERGY） の場合のみ使用で き 、 ま た必
須です。
デフ ォ ル ト 値 ： ""
ControllerNumber
シ ス テ ムで定義 さ れてい る 通 り に （所定のベン ダ／フ ァ ミ リ ／名前の
選択に応 じ て） 論理 コ ン ト ロ ー ラ を指定 し ます。 こ のパ ラ メ ー タ は
PreparationMode が 2 （REPARATIONMODE_ALLPRIMERGY） の場合の
み使用で き ます。
デフ ォ ル ト 値 ： 0
RaidType
Raid 構成を指定 し ます。 こ のパ ラ メ ー タ はオプシ ョ ン です。
PreparationMode が 1 （PREPARATIONMODE_BLADEOPTIMIZED） の場
合：
-1 (RaidType unchanged): Raid 構成を行い ません。
0 (RaidType_0)
1 (RaidType_1)
2000 (RaidType_2_Raid0_Arrays)
デフ ォ ル ト 値 ： 0 (RaidType_0)
PreparationMode が 2 （PREPARATIONMODE_ALLPRIMERGY） の場合 ：
使用可能な値は Installation Manager （フ ァ イ ル RaidDef.xml を ご覧 く だ
さ い） に よ っ て定義 さ れます。
パ ラ メ ー タ を指定 し ない場合は、 Automatic Mode にな り ます。 こ のパ
ラ メ ー タ を指定 し た場合、 Manual Mode にな り 、 オプシ ョ ンの
DiskNumber と HotSpare が追加で指定で き ます。
RaidInit
指定 し た Raid 構成の初期化を指定 し ます。
0 (RAIDINIT_OFF)
1 (RAIDINIT_ON)
デフ ォ ル ト 値 ： 0 (RAIDINIT_OFF)
こ のパ ラ メ ー タ は、 PreparationMode が 1
（PREPARATIONMODE_BLADEOPTIMIZED） の場合のみ使用で き ます。
122
Job API Tandem
5.9 デプ ロ イ メ ン ト 管理
DiskNumber
デ ィ ス ク の数を指定 し ます （0 はすべてのデ ィ ス ク を意味 し ます）。
デフ ォ ル ト 値 ： 0
こ のパ ラ メ ー タ は、 PreparationMode が 2
（PREPARATIONMODE_ALLPRIMERGY） で、 パ ラ メ ー タ RaidType が設
定 さ れてい る場合のみ使用で き ます。
HotSpare
故障 し たハー ド デ ィ ス ク の交換に使用す る ス タ ンバ イ ハー ド デ ィ ス ク
を指定 し ます。
デフ ォ ル ト 値 ： 0
こ のパ ラ メ ー タ は、 PreparationMode が 2
（PREPARATIONMODE_ALLPRIMERGY） で、 パ ラ メ ー タ RaidType が設
定 さ れてい る場合のみ使用で き ます。
ShutdownType
サーバが動作 し てい る 場合の応答を指定 し ます。
0 (SHUTDOWNTYPE_NO): シ ャ ッ ト ダ ウ ン し ません。 ただ し 、 サーバ
の電源が切断 さ れていない場合はエ ラ ーを返 し ます。
1 (SHUTDOWNTYPE_ACPI):
2 (SHUTDOWNTYPE_GRACEFUL): ServerView エージ ェ ン ト を使っ て
シ ャ ッ ト ダ ウ ン し ます。
3 (SHUTDOWNTYPE_FORCE): ブ レー ド タ イ プのサーバに対 し ては、
マネージ メ ン ト ブ レー ド に よ っ て強制的に電源を切断 し ます。 その他
の タ イ プのサーバに対 し ては、 ACPI で電源を切断 し ます。
デフ ォ ル ト 値 ： 0 (SHUTDOWNTYPE_NO)
ShutdownCommunity
対象サーバ上で動作 し てい る ServerView SNMP エージ ェ ン ト に対 し て
発行す る シ ャ ッ ト ダ ウ ン要求の SNMP コ ミ ュ ニテ ィ を指定 し ます。
デフ ォ ル ト 値 ： ""
ShutdownUsername
ServerView SNMP エージ ェ ン ト シ ャ ッ ト ダ ウ ンに対す る ユーザ名を指
定 し ます。
ShutdownType が 2 （graceful） の場合、 こ のパ ラ メ ー タ は必須です。
デフ ォ ル ト 値 ： ""
ShutdownPassword
前に指定 し たユーザに対す る パス ワ ー ド を指定 し ます。
ShutdownType が 2 （graceful） の場合、 こ のパ ラ メ ー タ は必須です。
デフ ォ ル ト 値 ： ""
Job API Tandem
123
5 API 関数 ク ラ ス
FinalPowerStatus
ク ロ ーニ ン グ後の電源状態を指定 し ます。
0 (FINALPOWERSTATUS_OFF)
1 (FINALPOWERSTATUS_ON)
デフ ォ ル ト 値 ： 0 (FINALPOWERSTATUS_OFF)
CustomScriptCmdline
ク ロ ーニ ン グ後に実行す る 、 カ ス タ マー （お客様） が作成 し た ス ク リ
プ ト を指定 し ます。
対象シ ス テ ムが Windows の場合、 パス名は ス ク リ プ ト のネ ッ ト ワ ー ク
パ ス名を UNC 表記法で指定 し ます。 ス ク リ プ ト が格納 さ れてい る ネ ッ
ト ワ ー ク 共有を使用 し なければな ら ない こ と を意味 し ます。 こ の ス ク
リ プ ト に対 し 、 オプシ ョ ンのパ ラ メ ー タ を指定す る こ と も で き ます。
対象シ ス テ ムが Linux の場合、 次の書式でパ ス名を指定 し ます。
\\<server>\<path>\script_name [parameters] ま たは
//<server>/<path>/script_name [parameters]
デフ ォ ル ト 値 ： ""
CustomScriptUsername
対象シ ス テ ムのカ ス タ マース ク リ プ ト にア ク セ スす る ために使用す る
ア カ ウ ン ト 情報を指定 し ます。 対象シ ス テ ムが Windows の場合、 ユー
ザア カ ウ ン ト には共有 と 指定サブデ ィ レ ク ト リ に対す る読み込みお よ
び実行許可が必要です。 対象シ ス テ ムが Linux の場合、 こ のア カ ウ ン
ト を使っ て FTP サーバへア ク セ ス し ます。 カ ス タ マース ク リ プ ト を指
定 し た場合、 こ のパ ラ メ ー タ は必須です。
デフ ォ ル ト 値 ： ""
CustomScriptPassword
指定 し た カ ス タ ム ス ク リ プ ト のユーザア カ ウ ン ト に対す る パス ワ ー ド
を指定 し ます。 カ ス タ マース ク リ プ ト を指定 し た場合、 こ のパ ラ メ ー
タ は必須です。
デフ ォ ル ト 値 ： ""
WindowsDomain
ク ロ ーニ ン グ後に参加す る Windows ド メ イ ン を指定 し ます。
デフ ォ ル ト 値 ： ""
WindowsDomainJoinUsername
ド メ イ ンに参加す る 際に使用す る ユーザ名を指定 し ます。 こ のユーザ
ア カ ウ ン ト には管理者権限が必要です。
デフ ォ ル ト 値 ： ""
124
Job API Tandem
5.9 デプ ロ イ メ ン ト 管理
WindowsDomainJoinPassword
指定 し た WindowsDomainJoinUsername ア カ ウ ン ト に対す る パ ス ワ ー ド
を指定 し ます。
デフ ォ ル ト 値 ： ""
LogicalDisk
イ メ ージ をデプ ロ イ メ ン ト す る 論理デ ィ ス ク 番号を指定 し ます。
デフ ォ ル ト 値 ： 0
ExpandLastPartition
デ ィ ス ク の空 き 領域を使用す る ために、 イ メ ージの最後のパーテ ィ
シ ョ ンの拡大を有効ま たは無効に し ます。
0 (EXPANDLASTPARTITION_OFF): 最後のパーテ ィ シ ョ ン を拡張 し ま
せん。 未使用の スペース はその他のパーテ ィ シ ョ ン用に使用可能な状
態の ま ま に し ます。
1 (EXPANDLASTPARTITION_ON): ク ロ ーニ ン グ さ れ る シ ス テ ムの使用
可能デ ィ ス ク 容量ま で、 最後のパーテ ィ シ ョ ン を拡大 し ます。
デフ ォ ル ト 値 ： 0 (EXPANDLASTPARTITION_OFF)
Unicast
マルチキ ャ ス ト ま たはユニ キ ャ ス ト ク ロ ーニ ン グの実行を指定 し ます。
0 (MULTICAST)
1 (UNICAST)
デフ ォ ル ト 値 ： 0 (MULTICAST)
GUIDCheck
グ ロ ーバルユーザ ID の確認を有効ま たは無効に し ます。
0 (GUIDCHECK_OFF)
1 (GUIDCHECK_ON)
デフ ォ ル ト 値 ： 0 (GUIDCHECK_OFF)
IgnoreModelCompatibility
ク ロ ーニ ン グ イ メ ージが所定の富士通サーバ と 互換性があ る か ど う か
を確認す る 、 互換性チ ェ ッ ク を有効ま たは無効に し ます。
0 (IGNORE_OFF) 互換性チ ェ ッ ク を実行 し ます。
1 (IGNORE_ON) 互換性チ ェ ッ ク を無視 し ます。
デフ ォ ル ト 値 ： 0 (IGNORE_OFF)
Job API Tandem
125
5 API 関数 ク ラ ス
ForceSnapshotCloning
ス ナ ッ プシ ョ ッ ト 以外の イ メ ージに対 し て通常行われ る ク ロ ーニ ン グ
済みシ ス テ ムの後処理 （ホ ス ト 名、 IP ア ド レ ス な ど の設定） を行わず
に、 ス ナ ッ プシ ョ ッ ト 以外の イ メ ージ をデ ィ ス ク へ ク ロ ーニ ン グす る
と い う オプシ ョ ン を有効ま たは無効に し ます。
0 (FORCESNAPSHOT_OFF)
1 (FORCESNAPSHOT_ON)
デフ ォ ル ト 値 ： 0 (FORCESNAPSHOT_OFF)
SetEtcHostname
Linux RedHat を ク ロ ーニ ン グす る 時のみに使用 し ます。 RedHat のバー
ジ ョ ンに よ っ ては、 /etc/hosts にあ る localhost の行にホ ス ト 名を追加す
る も の も あ り ます。 こ のパ ラ メ ー タ を使っ て、 ク ロ ーニ ン グ後、
localhost の行を強制的に変更で き ます。
0 （ま たはパ ラ メ ー タ を指定 し ない場合） : デフ ォ ル ト の対応です。 ほ
と ん ど の場合適応 さ れます。
1: ク ロ ーニ ン グ さ れたシ ス テ ムのホ ス ト 名を localhost の行へ追加 し ま
す。
2: localhost の行か ら ホ ス ト 名を削除 し ます。
デフ ォ ル ト 値 ： 0
MakKey
Windows2008 でのみ使用可能です。
こ のパ ラ メ ー タ には Multiple Activation Key が含まれてお り 、 ク ロ ーニ
ン グ後、 Windows 2008 対象を自動的に有効化 し ます。
デフ ォ ル ト 値 ： ""
KmsServer
Windows2008 でのみ使用可能です。
こ のパ ラ メ ー タ には 「Key Management Service」 サーバの IP ア ド レ ス
ま たはホ ス ト 名が含まれてお り 、 ク ロ ーニ ン グ後、 Windows2008 対象
を自動的に有効化 し ます。
デフ ォ ル ト 値 ： ""
KmsPort
Windows2008 でのみ使用可能です。
Windows2008 でのみ使用可能です。 「Key Management Service」 のポー
ト 番号です。 パ ラ メ ー タ KmsServer が設定 さ れてい る 場合 こ のパ ラ
メ ー タ を使用 し ます。
デフ ォ ル ト 値 ： ""
126
Job API Tandem
5.9 デプ ロ イ メ ン ト 管理
ProxyServer
Windows2008 でのみ使用可能です。
Windows2008 でのみ使用可能です。 パ ラ メ ー タ MakKey ま たは
KmsServer の ど ち ら かを設定 し た場合、 オプシ ョ ンで こ のパ ラ メ ー タ
を設定で き ます。 プ ロ キ シサーバの IP ア ド レ ス ま たはホ ス ト 名を指定
で き ます。
デフ ォ ル ト 値 ： ""
ProxyPort
Windows2008 でのみ使用可能です。
プ ロ キ シサーバのポー ト 番号です。 パ ラ メ ー タ ProxyServer を設定 し た
場合は、 こ のパ ラ メ ー タ を指定 し て く だ さ い。
デフ ォ ル ト 値 ： ""
イ ン ス ト ールに使用で き るパ ラ メ ー タ
デプ ロ イ メ ン ト 方式 「イ ン ス ト ール」 を実行する ためにパ ラ メ ー タ の配列で
指定で き るパラ メ ー タ を示 し ます。
ConfigPath
コ ン フ ィ グ レーシ ョ ン フ ァ イ ル名を含む完全修飾パ ス を指定 し ます。
シ ン グルサーバ選択モー ド では、 こ のパ ラ メ ー タ は必須です。
ShutdownType
サーバが動作中の場合の応答を指定 し ます。
0 (SHUTDOWNTYPE_NO): シ ャ ッ ト ダ ウ ン し ません。 し か し サーバの
電源が切断 さ れていない場合はエ ラ ーを返 し ます。
1 (SHUTDOWNTYPE_ACPI):
2 (SHUTDOWNTYPE_GRACEFUL): ServerView エージ ェ ン ト を使っ て
シ ャ ッ ト ダ ウ ン し ます。
3 (SHUTDOWNTYPE_FORCE): ブ レー ド タ イ プのサーバに対 し ては、
マネージ メ ン ト ブ レー ド に よ っ て強制的に電源を切断 し ます。 その他
の タ イ プのサーバに対 し ては、 ACPI で電源を切断 し ます。
デフ ォ ル ト 値 ： 0 (SHUTDOWNTYPE_NO)
ShutdownCommunity
対象サーバで稼動 し てい る ServerView SNMP エージ ェ ン ト に対す る
シ ャ ッ ト ダ ウ ン要求の SNMP コ ミ ュ ニテ ィ を指定 し ます。
デフ ォ ル ト 値 ： ""
Job API Tandem
127
5 API 関数 ク ラ ス
ShutdownUsername
ServerView SNMP エージ ェ ン ト シ ャ ッ ト ダ ウ ン用のユーザ名を指定 し
ます。
ShutdownType が 2 （graceful） の場合、 こ のパ ラ メ ー タ は必須です。
デフ ォ ル ト 値 ： ""
ShutdownPassword
前に示 し たユーザに対す る パ ス ワ ー ド を指定 し ます。
ShutdownType が 2 （graceful） の場合、 こ のパ ラ メ ー タ は必須です。
デフ ォ ル ト 値 ： ""
FinalPowerStatus
イ ン ス ト ール後のサーバの電源状態を指定 し ます。
0 (FINALPOWERSTATUS_OFF): サーバの電源は切断 さ れます。
1 (FINALPOWERSTATUS_ON): イ ン ス ト ール さ れてい る OS が起動 さ れ
ます。
こ のパ ラ メ ー タ を使っ て、 イ ン ス ト ール後、 サーバの OS を起動す る 、
ま たは サーバの電源を切断す る かを選択 し ます。
デフ ォ ル ト 値 ： 0 (FINALPOWERSTATUS_OFF)
SeStContentsPath
Installation Manager コ ン テ ン ツ ツ リ ーの完全修飾パ ス を UNC 形式で指
定 し ます。
こ のパ ラ メ ー タ を指定 し ない場合、 Installation Manager コ ン テ ン ツ ツ
リ ーのデフ ォ ル ト 値が使用 さ れます。
SeStContentsUsername
Installation Manager デー タ へア ク セ スす る ためのユーザ名を指定 し ま
す。 こ のパ ラ メ ー タ を指定 し ない場合、 リ モー ト ア ク セ ス用のユーザ
が使用 さ れます。
SeStContentsPassword
指定 し たユーザ （ま たは SeSetContentsUsername が設定 さ れていない場
合はデフ ォ ル ト ユーザ） に対す る パ ス ワ ー ド を指定 し ます。
こ のパ ラ メ ー タ は必須です。
128
Job API Tandem
5.9 デプ ロ イ メ ン ト 管理
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 にな り ます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
JobID
詳細を取得す る ために GetJobStatusDetails に対 し て使用す る 、 ユニー
ク な ID です。
Job API Tandem
129
5 API 関数 ク ラ ス
5.10
ジ ョ ブ管理
Job API は、 ジ ョ ブ を要求 と みな し ます。 こ の要求は、 デプ ロ イ メ ン ト エ ン
ジ ンに送信 さ れ、 バ ッ ク グ ラ ウン ド で実行 さ れます。 ジ ョ ブはそれぞれに対
し て作成 さ れた JobID と 関連付け ら れます。
–
イ メ ージ作成 (CreateImage)
–
イ メ ージ割 り 当て (Deploy)
– シ ス テムイ ン ス ト ール (Deploy)
– シ ス テム情報の取得 (StartSystemInfoRetrieval)
さ ら に、 Job API はジ ョ ブ スケジ ュ ー リ ング も サポー ト し ます。 汎用 Job API
関数 Deploy と CreateImage によ り 定義 さ れる ジ ョ ブは、 即時、 毎日、 毎週、
毎月、 またはスケジ ュ ールジ ョ ブ管理プ ロパテ ィ を使 っ て設定 し た予定での
実行を スケジ ュ ー リ ン グ し ます。 スケジ ュ ー リ ング管理プ ロパテ ィ について
の詳細は、 「6 ジ ョ ブ スケジ ュ ー リ ング」 の章 （145 ページ） を ご覧 く だ さ
い。
Job API はジ ョ ブの種類を 2 つに区別 し ます。
– スケジ ュ ールジ ョ ブ
現在のバージ ョ ンの Job API でのスケジ ュ ールジ ョ ブは、 関数 Deploy と
CreateImage、 およびスケジ ュ ールジ ョ ブ管理プ ロパテ ィ を追加で指示す
る こ と に よ り 定義 さ れます （ こ れ ら のジ ョ ブは、 指定 し たスケジ ュ ー リ ン
グ管理プ ロパテ ィ に応 じ てデプ ロ イ メ ン ト エ ン ジ ンへ送信 さ れます）。
– スケジ ュ ール さ れていないジ ョ ブ
スケジ ュ ール さ れていないジ ョ ブ と は、 デプ ロ イ メ ン ト エ ン ジ ンに対 し て
要求 さ れ、 バ ッ ク グ ラ ウン ド で直接開始 さ れたジ ョ ブの こ と です。
130
Job API Tandem
5.10 ジ ョ ブ管理
5.10.1 GetJobStatusDetails
Job API に よ り 実行 さ れたジ ョ ブの詳細を ジ ョ ブ開始以降に取得するには、
次の関数を使用 し ます。 GetJobStatusDetails は Job ID または Job ID リ ス ト で
識別 さ れた現在のジ ョ ブ状態 と 詳細を返 し ます。 1 つのジ ョ ブの実行が完了
し た時、 または タ イムアウ ト 値が経過 し た時に返 し ます。 API 関数は非同期
性です。 同期 し て進めたい場合は、 Timeout を INFINITE に設定 し
GetJobStatusDetails を発行 し ます （ただ し 、 ほ と んどの SoapClinents と
SoapServers は、 自身で タ イ ムアウ ト を設定する必要があ る こ と にご注意 く だ
さ い）。 GetJobStatusDetails の複数の呼び出 し は並行 し て発行で き ます。
構文
GetJobStatusDetails JobIDList=<string>
DeploymentServer=<string>
DeploymentUsername=<string>
DeploymentPassword=<string>
Timeout=<int>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
JobIDList
Deploy、 CreateImage な ど以前呼び出 し た Job ID に関す る コ ン マ区切 り
の リ ス ト を指定 し ます。
DeploymentServer
デプ ロ イ メ ン ト サーバのホ ス ト 名、 ま たは、 1 つ目の LAN ポー ト の IP
ア ド レ ス を指定 し ます。
DeploymentUsername
指定 し たデプ ロ イ メ ン ト サーバのユーザア カ ウ ン ト 名を指定 し ます。
こ のパ ラ メ ー タ は必須です。
DeploymentPassword
デプ ロ イ メ ン ト サーバで指定 し たユーザア カ ウ ン ト に対す る パ ス ワ ー
ド を指定 し ます。 こ のパ ラ メ ー タ は必須です。
Timeout
ジ ョ ブが完了 し ていない場合の待機時間を秒単位で指定 し ます。
0: す ぐ に返 し ます。
1 （INFINITE） : ジ ョ ブが完了す る ま で待ち ます。
デフ ォ ル ト 値 ： 0
Job API Tandem
131
5 API 関数 ク ラ ス
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
I 複数のサーバで使用する ジ ョ ブ では、 GetJobStatusDetails は関連する
サーバの結果を Success または Error で返 し ます。 Error であ る場合、 1
つ以上のサーバのデプ ロ イ メ ン ト に失敗 し た こ と を示 し ています。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
JobStatusDetailsList
JobStatusDetailsData タ イ プの構造体の配列を返 し ます。
132
Job API Tandem
5.10 ジ ョ ブ管理
戻 り リ ス ト のレ イ アウ ト
戻 り リ ス ト には、 指定 し た Job ID のジ ョ ブ情報がすべて含まれています。 ま
た レ イ アウ ト は次の と お り です。
JobID=<int> JobType=<int>
StatusDetails=<ArrayOf_DetailData>
JobID
Job ID を表示 し ます。
JobType
Job の種類を表示 し ます。
0 (JOBTYPE_STARTSYSTEMINFORETRIEVAL)
8 (JOBTYPE_CREATEIMAGE)
9 (JOBTYPE_DEPLOY)
StatusDetails
DetailData タ イ プの要素を使っ た配列で指定 し た Job ID の状態に関す
る 詳細をすべて表示 し ます。 詳細は、 133 ページの "DetailData 構造体
の レ イ ア ウ ト " を ご覧 く だ さ い。
DetailData 構造体のレ イ アウ ト
Name=<string> Value=<string>
Name
状態詳細の名前を表示 し ます。
Value
状態詳細の値を表示 し ます。
Job API Tandem
133
5 API 関数 ク ラ ス
5.10.2 GetServerJobStatus
関数 GetServerJobStatus はサーバの所定 MAC ア ド レ ス リ ス ト に基づいて、 現
在のジ ョ ブ状態 （サーバ上の最新のジ ョ ブ） を返 し ます。 API 関数は非同期
性です。 同期 し て進めたい場合は、 Timeout を INFINITE に設定 し
GetServerJobStatus を発行 し ます （ただ し 、 ほ と んどの SoapClients と
SoapServers は タ イムアウ ト 値を ご自身で設定する必要があ るので ご注意 く だ
さ い）。 GetServerJobStatus への複数の呼び出 し は並行 し て発行で き ます。
構文
GetServerJobStatus ServerIdList=<ArrayOf_ServerIdentifier>
DeploymentServer=<string>
DeploymentUsername=<string>
DeploymentPassword=<string>
Timeout=<int>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
ServerIdList
Deploy、 CreateImage な ど のジ ョ ブ呼び出 し がすでに開始 さ れた 1 つ以
上のサーバを認識すつための ServerIdentifier 構造体の配列を指定 し ま
す。 構造体に関す る 詳細は、 26 ページの "ServerIdentifier 構造体の レ イ
ア ウ ト " を ご覧 く だ さ い。
DeploymentServer
デプ ロ イ メ ン ト サーバのホ ス ト 名、 ま たは、 1 つ目の LAN ポー ト の IP
ア ド レ ス を指定 し ます。
DeploymentUsername
指定 し たデプ ロ イ メ ン ト サーバのユーザア カ ウ ン ト 名を指定 し ます。
こ のパ ラ メ ー タ は必須です。
DeploymentPassword
デプ ロ イ メ ン ト サーバで指定 し たユーザア カ ウ ン ト に対す る パ ス ワ ー
ド を指定 し ます。 こ のパ ラ メ ー タ は必須です。
Timeout
ジ ョ ブが完了 し ていない場合の待機時間を秒単位で指定 し ます。
0: すぐ 返 し ます。
-1 (INFINITE): ジ ョ ブが完了す る ま で待ち ます。
デフ ォ ル ト 値 ： 0
134
Job API Tandem
5.10 ジ ョ ブ管理
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
ServerJobStatusList
ServerIdentifier タ イ プの要素を使っ た配列を返 し ます。
Job API Tandem
135
5 API 関数 ク ラ ス
Layout of the returned list
戻 り リ ス ト には指定 し たサーバ ID のジ ョ ブ状態情報が含まれています。 レ イ
アウ ト は次の と お り です。
JobID
指定 し たサーバで最後に実行 さ れたジ ョ ブのジ ョ ブ ID を表示 し ます。
Status
現在のジ ョ ブ状態を表示 し ます。
"Initializing"
"Waiting"
"Running"
"'Cancelling"
"Success"
"Error"
"Cancelled"
Type
ジ ョ ブの種類を表示 し ます。
0 (JOBTYPE_STARTSYSTEMINFORETRIEVAL)
8 (JOBTYPE_CREATEIMAGE)
9 (JOBTYPE_DEPLOY)
DetailedStatusCode
よ り 詳 し い状態 コ ー ド 番号 （現在は常に 0） を表示 し ます。
DetailedStatus
よ り 詳 し い状態 （ジ ョ ブがすでに終了 し てい る 場合のエ ラ ー メ ッ セー
ジの詳細やジ ョ ブ進行状況の記述） を表示 し ます。
I 現在ま で、 指定 し たサーバに対 し てジ ョ ブ を実行 し ていない場合、 返
さ れる JobID は 0 です。
136
Job API Tandem
5.10 ジ ョ ブ管理
5.10.3 CancelJob
状況に よ っ ては、 キ ャ ン セルで き る ジ ョ ブ も あ り ます。 そのよ う なジ ョ ブ を
キ ャ ン セルするには、 ユーザが Job API 関数 Cancel Job を使い、 実行中の
ジ ョ ブ をキ ャ ン セル し ます。
構文
CancelJob JobID=<int>
DeploymentServer=<string>
DeploymentUsername=<string>
DeploymentPassword=<string>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
JobID
Deploy、 CreateImage な ど の関数を前回呼び出 し た際に取得 し た JobID
を指定 し ます。
DeploymentServer
デプ ロ イ メ ン ト サーバのホ ス ト 名、 ま たは、 1 つ目の LAN ポー ト の IP
ア ド レ ス を指定 し ます。
DeploymentUsername
指定 し たデプ ロ イ メ ン ト サーバのユーザア カ ウ ン ト 名を指定 し ます。
こ のパ ラ メ ー タ は必須です。
DeploymentPassword
デプ ロ イ メ ン ト サーバで指定 し たユーザア カ ウ ン ト に対す る パ ス ワ ー
ド を指定 し ます。 こ のパ ラ メ ー タ は必須です。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
Job API Tandem
137
5 API 関数 ク ラ ス
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
138
Job API Tandem
5.10 ジ ョ ブ管理
5.10.4 GetScheduledJobProperties
関数 GetScheduledJobProperties は、 ScheduledJobID に よ り 識別 さ れすでに定義
さ れたスケジ ュ ールジ ョ ブのスケジ ュ ールジ ョ ブ管理プ ロパテ ィ を取得 し ま
す。
構文
GetScheduledJobProperties ScheduledJobID=<int>
DeploymentServer=<string>
DeploymentUsername=<string>
DeploymentPassword=<string>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
ScheduledJobID
ス ケ ジ ュ ールジ ョ ブを定義す る Deploy、 CreateImage な ど の関数を前回
呼び出 し た際に取得 し た ScheduledJobID を指定 し ます。
DeploymentServer
デプ ロ イ メ ン ト サーバのホ ス ト 名、 ま たは、 1 つ目の LAN ポー ト の IP
ア ド レ ス を指定 し ます。
DeploymentUsername
指定 し たデプ ロ イ メ ン ト サーバのユーザア カ ウ ン ト 名を指定 し ます。
こ のパ ラ メ ー タ は必須です。
DeploymentPassword
デプ ロ イ メ ン ト サーバで指定 し たユーザア カ ウ ン ト に対す る パ ス ワ ー
ド を指定 し ます。 こ のパ ラ メ ー タ は必須です。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
Job API Tandem
139
5 API 関数 ク ラ ス
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
Properties
ス ケ ジ ュ ールジ ョ ブ管理プ ロ パテ ィ の リ ス ト を返 し ます。
140
Job API Tandem
5.10 ジ ョ ブ管理
5.10.5 GetScheduledJobLogList
関数 GetScheduledJobLogList を使 っ て所定のスケジ ュ ールジ ョ ブによ り 開始 さ
れたジ ョ ブに関する情報の詳細を返 し ます。
構文
GetScheduledJobLogList ScheduledJobID=<int>
DeploymentServer=<string>
DeploymentUsername=<string>
DeploymentPassword=<string>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
ScheduledJobID
ス ケ ジ ュ ールジ ョ ブを定義 し た Deploy、 CreateImage な ど の関数を前回
呼び出 し た際に取得 し た ScheduledJobID を指定 し ます。
DeploymentServer
デプ ロ イ メ ン ト サーバのホ ス ト 名、 ま たは、 1 つ目の LAN ポー ト の IP
ア ド レ ス を指定 し ます。
DeploymentUsername
指定 し たデプ ロ イ メ ン ト サーバのユーザア カ ウ ン ト 名を指定 し ます。
こ のパ ラ メ ー タ は必須です。
DeploymentPassword
デプ ロ イ メ ン ト サーバで指定 し たユーザア カ ウ ン ト に対す る パ ス ワ ー
ド を指定 し ます。 こ のパ ラ メ ー タ は必須です。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
Job API Tandem
141
5 API 関数 ク ラ ス
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
LogList
指定 し た ス ケ ジ ュ ールジ ョ ブの ロ グすべての配列を返 し ます。 ロ グに
は、 こ の定義 さ れた ス ケ ジ ュ ールジ ョ ブに よ り 開始 さ れた ジ ョ ブの詳
細が含まれてい ます。
戻 り ログ リ ス ト のレ イ アウ ト
ロ グの戻 り リ ス ト には開始 さ れたジ ョ ブの詳細が含まれています。
JobID=<int> Details=<ArrayOf_DetailData>
JobID
ス ケ ジ ュ ールジ ョ ブに よ り 開始 さ れた ジ ョ ブの JobID を表示 し ます。
Details
JobID に よ り 指示 さ れた ジ ョ ブの詳細を表示 し ます。 構造体に関す る
詳細は、 133 ページの "DetailData 構造体の レ イ ア ウ ト " を ご覧 く だ さ
い。
142
Job API Tandem
5.10 ジ ョ ブ管理
5.10.6 DeleteScheduledJob
定義 さ れたスケジ ュ ールジ ョ ブ を削除するには、 関数 DeleteScheduledJob を
使用 し ます。
構文
DeleteScheduledJob ScheduledJobID=<int>
RDServer=<string>
UserKey=<string>
パラ メ ー タ
ScheduledJobID
ス ケ ジ ュ ールジ ョ ブを定義 し た Deploy、 CreateImage な ど の関数を前回
呼び出 し た際に取得 し た ScheduledJobID を指定 し ます。
RDServer
ServerView Deployment Manager サービ ス が稼動 し てい る サーバのホ ス
ト 名ま たは IP ア ド レ ス を指定 し ます。 こ のパ ラ メ ー タ を指定 し ない場
合、 ロ ーカルのマシ ンが使用 さ れます。
デフ ォ ル ト 値 ： ""
UserKey
特定のユーザア カ ウ ン ト 専用ユーザキーを指定 し ます。
戻り値
ErrorCode
最後に実行 し た際の診断番号です。 正常に実行 さ れた場合、 ErrorCode
は 0 に設定 さ れます。
ErrorString
ErrorCode のテ キ ス ト 記述です。 正常に実行 さ れた場合、 ErrorString は
空白です。
Job API Tandem
143
5 API 関数 ク ラ ス
144
Job API Tandem
6
ジ ョ ブ スケジ ュ ー リ ン グ
Job API はジ ョ ブ スケジ ュ ー リ ング機能をサポー ト し ます。 一般的な Job API
関数 Deploy と CreateImage は、 即時、 毎日、 毎週、 毎月、 またはスケジ ュ ー
ルジ ョ ブ管理プ ロパテ ィ を使 っ て設定 さ れた タ イ ミ ングで実行する よ う に、
スケジ ュ ー リ ングで き ます。
次の表で、 パラ メ ー タ （名前 / 値のペア） と し て Job API 関数で使用で き る
スケジ ュ ールジ ョ ブ管理プ ロパテ ィ について説明 し ます。 こ れ ら のプ ロパ
テ ィ に よ っ て、 1 回のみの実行、 またはジ ョ ブ を繰 り 返 し 実行する際の日付
や時間を設定 し ます。
定義済みのスケジ ュ ールジ ョ ブのプ ロパテ ィ は、 適切な Job API 関数
（Deploy または CreateImage） を繰 り 返 し 実行する際に、 ScheduledJobID を追
加で指示する、 またはスケジ ュ ールジ ョ ブ管理プ ロパテ ィ を全て選択する こ
と で変更で き ます。 次回 こ のスケジ ュ ールジ ョ ブ を実行する と 、 修正 さ れた
スケジ ュ ールジ ョ ブ で開始 さ れます。 さ ら に、 すでに定義 さ れたスケジ ュ ー
ルジ ョ ブ を DeleteScheduledJob 関数で削除 し 、 適切な関数を実行する、 また
はスケジ ュ ールジ ョ ブ管理プ ロパテ ィ で有効な組み合わせを指定する方法 も
あ り ます。
原則 と し て、 スケジ ュ ールジ ョ ブは定義 さ れた Job API 関数によ り 指定 さ れ
た専用の UserKey に設定 さ れています。 すなわち、 適切な UserKey の指定を
前提に、 既存のスケジ ュ ールジ ョ ブ を修正または削除する点に注意 し て く だ
さ い。
パラ メ ー タ 名
パラ メ ー タ の説明 と 値
Scheduled
スケジ ュ ールジ ョ ブのオプ シ ョ ン を有効または
無効に し ます。 スケジ ュ ー リ ング を定義するに
は、 追加でスケジ ュ ールジ ョ ブ管理プ ロパテ ィ
を指定する、 または管理プ ロパテ ィ のデ フ ォ ル
ト 値を使用 し ます。
"0": す ぐ にジ ョ ブ を実行する。
"1": スケジ ュ ールジ ョ ブ を作成する。
デ フ ォル ト 値 ： "0"
ScheduledJobName
新 し いスケジ ュ ールジ ョ ブの名前を指定 し ます。
ScheduledJobID
すでに定義 さ れたスケジ ュ ールジ ョ ブのジ ョ ブ
ID を指定 し ます。 こ のパラ メ ー タ を使 っ て、 す
でに定義 さ れたスケジ ュ ールジ ョ ブ を修正で き
ます。
Job API Tandem
145
6 ジ ョ ブ スケジ ュ ー リ ン グ
パラ メ ー タ名
パ ラ メ ー タ の説明 と 値
Retries
スケジ ュ ールジ ョ ブが失敗 し た場合の再試行回
数を指定 し ます。
デ フ ォル ト 値 ： 2
RetriesInterval
スケジ ュ ールジ ョ ブの試行に失敗 し た場合、 次
の試行ま での時間 （分単位） を指定 し ます。 再
試行回数は、 指定 し たスケジ ュ ールジ ョ ブの試
行回数を超え る こ と はあ り ません。
数値範囲 ： 1 ～ 360 分
デ フ ォル ト 値 ： 15
ScheduledStartTimeWindow
時間ウ ィ ン ド ウの範囲 （分単位） を指定 し ます。
時間ウ ィ ン ド ウの範囲はスケジ ュ ールジ ョ ブの
開始時か ら 始ま り 、 xx 分後 （xx は
StartTimeWindow に対 し て指定 さ れた値です）
に終了 し ます。 時間ウ ィ ン ド ウ内で スケジ ュ ー
ルジ ョ ブが正常に開始 さ れなか っ た場合、 その
スケジ ュ ールジ ョ ブは中止 さ れます。 また、 ス
ケジ ュ ールジ ョ ブは こ の時間ウ ィ ン ド ウ内での
み再試行 さ れます。 し たが っ て、 ジ ョ ブ開始時
間ウ ィ ン ド ウ を経過する と 、 スケジ ュ ールジ ョ
ブは開始 さ れません。 ジ ョ ブ をデプ ロ イ メ ン ト
サーバへ渡す こ と はで き ますが、 すでに大量の
ジ ョ ブが動作中のため、 渡 さ れたジ ョ ブは待ち
行列に入れ られます。 こ の状態のま ま ジ ョ ブ開
始時間ウ ィ ン ド ウが経過 し た場合、 タ ス ク も 中
止 さ れます。 ジ ョ ブ開始ウ ィ ン ド ウが経過 し て
も 実行中のジ ョ ブは中止 さ れません。
数値範囲 ： 10 ～ 600 分
デ フ ォル ト 値 ： 60
ScheduledInterval
スケジ ュ ールジ ョ ブの間隔を指定 し ます。
"Once": ジ ョ ブは 1 度だけ実行 さ れます。
"Daily": ジ ョ ブは毎日実行 さ れます。
"Weekly": ジ ョ ブは毎週実行 さ れます。
"Monthly": ジ ョ ブは毎月実行 さ れます。
ScheduledTime
スケジ ュ ールジ ョ ブの開始時間 （時間 と 分単位）
を指定 し ます。 ScheduledTime の フ ォ ーマ ッ ト
は hh:mm です。
デ フ ォル ト 値 ：
146
Job API Tandem
パラ メ ー タ 名
パラ メ ー タ の説明 と 値
ScheduledDate
スケジ ュ ールジ ョ ブの開始日を指定 し ます。
ScheduledDate の フ ォ ーマ ッ ト は、 mm/dd/yyyy
です。
デ フ ォル ト 値 ： current date
ScheduledDays
1 週間の う ちの 1 日、 またはコ ン マで区切られ
た曜日の リ ス ト を使っ て、 スケジ ュ ールジ ョ ブ
の実行予定を指定 し ます。 毎週実行する よ う に
予定 さ れている ジ ョ ブ （ScheduledInterval=
Weekly） に対 し ては、 次の と お り に曜日を指定
し ます。
"SUN" | "1": 日曜日
"MON" | "2": 月曜日
"TUE" | "3": 火曜日
"WED" | "4": 水曜日
"THU" | "5": 木曜日
"FRI" | "6": 金曜日
"SAT" | "7": 土曜日
毎日実行する よ う に予定 さ れている ジ ョ ブに対
し ては 「WEEKDAYS」 と 指定 し ます。
「WEEKDAYS」 と は、 月曜日か ら 金曜日ま での
毎日です。
ScheduleDailyInterval > 1 の場合、 ScheduledDays
の指定はで き ません。
デ フ ォル ト 値 ： current date
ScheduledMonths
1 つの月、 または コ ン マ で区切 ら れた月の リ ス
ト を使 っ て、 スケジ ュ ールジ ョ ブの実行予定を
指定 し ます。 次の と お り に月を指定 し ます。
"JAN" | "1": 1 月
"FEB" | "2": 2 月
..
"NOV" | "11": 11 月
"DEC" | "12": 12 月
毎月実行を予定 し ている ジ ョ ブ
（ScheduledInterval=Monthly） に対 し て こ のパラ
メ ー タ を指定 し ます。 ScheduledMonthlyInterval >
1 が選択 さ れている場合、 ScheduledMonths は
追加指定で き ません。
デ フ ォル ト 値 ： ""
Job API Tandem
147
6 ジ ョ ブ スケジ ュ ー リ ン グ
パラ メ ー タ名
パ ラ メ ー タ の説明 と 値
ScheduledDayOfMonth
スケジ ュ ールジ ョ ブ を実行する月内の 1 日を指
定 し ます。 毎月実行を予定 し ている ジ ョ ブに対
し て こ のパラ メ ー タ を指定 し ます。 ただ し 、 指
定で き るのは、 パラ メ ー タ ScheduledDayOfMonth
または ScheduledWeekdayOfMonth のど ち ら かのみ
です。
デ フ ォル ト 値 ： ""
ScheduledWeekdayOfMonth
スケジ ュ ールジ ョ ブ を実行する月内の週または
曜日を指定 し ます （第 1 月曜日、 第 2 水曜日な
ど）。 毎月実行を予定 し ている ジ ョ ブ
（ScheduledInterval=Monthly） に対 し て こ のパラ
メ ー タ を指定で き ます。 ただ し 、 指定で き るパ
ラ メ ー タ は ScheduledDayOfMonth または
ScheduledWeekdayOfMonth のど ち ら かのみです。
デ フ ォル ト 値 ： ""
ScheduledWeeklyInterval
スケジ ュ ールジ ョ ブ を実行する間隔を週単位で
指定 し ます。 間隔が 1 の場合、 スケジ ュ ール
ジ ョ ブは毎週実行 さ れます。 間隔が 2 の場合、
スケジ ュ ールジ ョ ブは隔週に実行 さ れます。
数値範囲 ： 1 ～ 52
デ フ ォル ト 値 ： 0
ScheduledMonthlyInterval
スケジ ュ ールジ ョ ブ を実行する間隔を月単位で
指定 し ます。 間隔が 1 の場合、 スケジ ュ ール
ジ ョ ブは毎月実行 さ れます。 間隔が 2 の場合、
スケジ ュ ールジ ョ ブは隔月に実行 さ れます。
数値範囲 ： 1 ～ 12
デ フ ォル ト 値 ： 0
148
Job API Tandem
7
API エ ラ ー コ ー ド
ErrorCode や ErrorString パ ラ メ ー タ 内で、 Job API の呼び出 し に対する API エ
ラ ー コ ー ド が返 さ れる場合があ り ます。 それぞれの API 関数 コ ールの詳細が
定義 さ れている特定情報は、 故障やその他の原因を特定する際に役立ち ます。
I エ ラ ー コ ー ド や様々な エ ラ ーの原因についての説明範囲は多岐に渡る
ため、 こ こ ではエ ラ ー コ ー ド の説明は記載 し ていません。 エ ラ ーや対
処方法についての詳細を入手するには、 Deployment Manager 開発
チームにご連絡 く だ さ い。
Job API Tandem
149
7 API エ ラ ー コ ー ド
150
Job API Tandem
8
イ ン ス ト ール
Job API は Deployment Manager CD-ROM 上で ア ド オ ンパ ッ ケージ と し て配
布 さ れます。 CD-ROM を挿入する と 、 イ ン ス ト ールは自動的にス タ ー ト し ま
す。
Job API を構成 し ている イ ン ス ト ールパ ッ ケージは次の 2 つです。
– Job API for IIS パ ッ ケージ
– Job API for Apache パ ッ ケージ
こ れ ら のパ ッ ケージは、 同時にまたは別々に イ ン ス ト ールで き ます。 Job API
パ ッ ケージ を使 っ てデプ ロ イ メ ン ト サーバへア ク セスで き る ため、
Deployment Manager と し て別のシ ス テムに イ ン ス ト ールで き ます。 Job API
パ ッ ケージ を別々の場所に イ ン ス ト ールする場合、 両方の コ ン ピ ュ ー タ は同
じ Windows のネ ッ ト ワー ク ド メ イ ン内にあ る必要があ り ます。 さ ら に、 イ ン
ス ト ール中に指定するユーザア カ ウン ト は こ のネ ッ ト ワー ク ド メ イ ンの メ ン
バであ る必要があ り ます。
Job API for Apache パ ッ ケージ を イ ン ス ト ールする場合は、 Apache Web サー
バが ServerView Operations Manager セ ッ ト ア ッ プ と 一緒に イ ン ス ト ール さ
れた場合にのみ、 JOB API の Apache Web サーバ統合を行な う こ と がで き ま
す。 Job API と ServerView Operations Manager は同一のシ ス テムに イ ン ス
ト ールする必要があ り ます。
8.1
シ ス テム要件
Job API を イ ン ス ト ールで き る シ ス テムは次の と お り です。
– Windows 2003
– Windows 2008
追加要件 ：
– Web サーバ (IIS または ServerView Apache)
Job API Tandem
151
8 イ ン ス ト ール
8.2
イ ン ス ト ール
こ の項では、 Job API for IIS パ ッ ケージのイ ン ス ト ール例を説明 し ます。
パ ッ ケージ を イ ン ス ト ールする場合は、 次の手順に従 っ て く だ さ い。
1. パ ッ ケージの コ ン ト ロールボ タ ン を有効に し ます。 次の画面が表示 さ れま
す。
「Next」 ボ タ ン を ク リ ッ ク し 、 イ ン ス ト ールを続行 し ます。 セ ッ ト ア ッ プ
プ ログ ラ ムを終了 し たい場合は、 「Cancel」 ボ タ ン を ク リ ッ ク し ます。
152
Job API Tandem
8.2 イ ン ス ト ール
2. 適切な ラ ジオボ タ ン を選択 し て ラ イ セ ン ス契約を承認 し 、 「Next」 ボ タ ン
を ク リ ッ ク し ます。
Job API Tandem
153
8 イ ン ス ト ール
3. パ ッ ケージのイ ン ス ト ール先 フ ォルダ を確認 し 、 「Next」 ボ タ ン を ク リ ッ
ク し ます。
154
Job API Tandem
8.2 イ ン ス ト ール
4. 氏名 と 所属部署を入力 し ます。 Job API の設定を現在のユーザのみに適用
するか、 対象 コ ン ピ ュ ー タ を使 う ユーザ全員に適用するかを指定 し ます。
ど ち ら かを ラ ジオボ タ ン で選択 し 、 「Next」 ボ タ ン を ク リ ッ ク し ます。
Job API Tandem
155
8 イ ン ス ト ール
5. イ ン ス ト ールを始めるには、 「Ready to install the Application」 ウ ィ ン ド ウ
の 「Next」 ボ タ ン を ク リ ッ ク し ます。
イ ン ス ト ールを中止 し たい場合は、 「Cancel」 ボ タ ン を ク リ ッ ク し ます。
156
Job API Tandem
8.2 イ ン ス ト ール
6. Job API のイ ン ス ト ールが正常に完了 し た ら 、 「Finish」 ボ タ ン を ク リ ッ ク
し イ ン ス ト ールを終了 し ます。
Job API Tandem
157
8 イ ン ス ト ール
8.3
JobAPI と Internet Information Server (IIS)
8.3.1
Windows Server 2003 での JobAPI と Internet
Information Server (IIS)
Job API を Windows Server 2003 に イ ン ス ト ール し 、 Internet Information
Server (IIS) を Web サーバ と し て使用する場合、 CGI ス ク リ プ ト が実行で き
る よ う に IIS のデ フ ォル ト 設定を変更 し ます。 変更は、 次の方法に従っ て行
います。
Ê 管理ツールか ら 、 イ ン タ ーネ ッ ト イ ン フ ォ メ ーシ ョ ン サービ ス （IIS） マ
ネージ ャ を起動 し ます。
Ê ロー カルシ ス テムの 「Web サービ ス拡張」 を選択 し ます。
Ê 「すべての不明な CGI 拡張」 を選択 し ます。
Ê 「許可」 ボ タ ン を ク リ ッ ク し ます。
8.3.2
Windows Server 2008 での JobAPI と Internet
Information Server (IIS)
Job API を Windows Server 2008 に イ ン ス ト ール し 、 Internet Information
Server (IIS) を Web サーバ と し て使用する場合、 実行する CGI ス ク リ プ ト に
JobAPI.exe を追加 し て く だ さ い。 追加は、 次の方法に従 っ て行います。
Ê 「ス タ ー ト 」 → 「管理ツール」 → 「イ ン タ ーネ ッ ト イ ン フ ォ メ ーシ ョ ン
サービ ス （IIS） マネージ ャ ー」 の順に選択 し ます。
Ê 左側のウ ィ ン ド ウで ご使用のサーバを ク リ ッ ク し ます。
Ê 中央のウ ィ ン ド ウで 「ISAPI および CGI の制限」 を ダブル ク リ ッ ク し ま
す。
Ê 右側のウ ィ ン ド ウで 「追加 ...」 ボ タ ン を ク リ ッ ク し ます。
Ê 「ISAPI または CGI の制限の追加」 ウ ィ ン ド ウで次の値を入力 し ます。 I
– ISAPI または CGI パス : C:¥Inetpub¥scripts¥JobAPI¥JobAPI.exe
– フ ィ ル タ 名 : JobAPI
– 「拡張パスの実行を許可する」 を チ ェ ッ ク し 実行 し ます。
Ê 「OK」 ボ タ ン を ク リ ッ ク し ます。
158
Job API Tandem
8.4 イ ン ス ト ールテ ス ト
8.4
イ ン ス ト ールテ ス ト
イ ン ス ト ール後、 Web ブ ラ ウザか ら Job API サービ ス を テ ス ト で き ます。
1. ブ ラ ウザのロ ケーシ ョ ンバーに次のいずれかを入力 し ます。
http://<server>:<port>/scripts/JobAPI/JobAPI.exe?Installation
または
http://<server>:<port>/scripts/JobAPI/JobAPI.exe?Test
<server> は、 Job API サービ ス を イ ン ス ト ール し たサーバの IP ア ド レ ス
またはホス ト 名です。 <port> は、 Web サーバのポー ト です。 Job API の
URL に関する詳細は、 161 ページの 「URL」 の項を ご覧 く だ さ い。
2. Job API サービ スが正常に イ ン ス ト ール さ れる と 、 Job API CGI が起動 し 、
次に示す Web ページ または文字列が生成 さ れます。
こ の Web ページ では、 Job API のバージ ョ ン情報 と 同一サーバへの
Deployment Manager のイ ン ス ト ールに関する追加情報を確認で き ます。
Job API Tandem
159
8 イ ン ス ト ール
表示 さ れた文字列には生成 さ れた Web ページ と 同 じ 情報が含まれますが、
保存 さ れるのは次の変数のみです。
JobAPIVersion
イ ン ス ト ール さ れた Job API サービ スのバー
ジ ョ ン を表示 し ます。
Deployment Manager
Job API のイ ン ス ト ール先 と 同 じ サーバに
Deployment Manager がイ ン ス ト ール さ れてい
るかを表示 し ます。
Deploment Manager
Version
イ ン ス ト ール さ れている Deployment Manager
のバージ ョ ン を表示 し ます。
Deployment Manager
Service Status
ServerView Deployment Manager サービ スの状
態を表示 し ます （unknown ＝ア ク セスが拒否 さ
れたため確認で き ません）。
HTTP エ ラ ーが発生 し た場合は （例 ： 404 ： 見つか り ません、 400 ： 無効
な要求）、 Job API がイ ン ス ト ール さ れていない、 または CGI 呼び出 し が
正 し く ないかのいずれかです。
160
Job API Tandem
9
その他の情報
次の章では、 Job API ク ラ イ ア ン ト ア プ リ ケーシ ョ ン と 使用する Web サーバ
の設定のための重要な情報を説明 し ます。
9.1
URL
Job API サーバは Internet Information Service （IIS） と Apache Web サーバに
イ ン ス ト ールで き ます。 次の表は、 Deployment Manager、 Job API バージ ョ
ン、 構成 と 一緒にどの URL を使用する必要があ るかについて説明 し ていま
す。
Deployment Job
Manager
API
V5.30
開発用
ツール
V1.5 gSOAP
V2.7.13
gSOAP
V2.7.13
Web
サーバ
URL
IIS
http://<server>/scripts/JobAPI/
JobAPI.exe
Apache http://<server>:3169/scripts/JobAPI/JobAPI.exe
(SV)
開発用ツールは、 Job API サーバの生成用ツールに関する情報です。 Job API
ク ラ イ ア ン ト の生成には、 バージ ョ ン V2.6 ～ V.2.7.13 の gSOAP の使用を推
奨 し ます。
Job API Tandem
161
9 その他の情報
9.2
HTTP 認証
文字列 soap.userid と soap.passwd を それぞれユーザ名 と パスワー ド に対 し て
設定する こ と に よ り 、 Job API ク ラ イ ア ン ト 側で HTTP 認証がで き る よ う に
な り ます。 Job API ク ラ イ ア ン ト が HTTP 認証な し で、 または間違 っ た認証
情報で接続 し よ う と する と 、 Web サーバはユーザ認証を求め、 ア ク セス
（HTTP401 エ ラ ー） を拒否する場合があ り ます。
ServerView によ っ て イ ン ス ト ール さ れた Apache サーバのユーザおよびパス
ワー ド を設定する ために使用する、 Job API ク ラ イ ア ン ト の コ ー ド フ ラ グ メ
ン ト 例を次で示 し ています。








struct soap soap;
soap init(&soap);
soap.userid = "svuser";
soap.passwd = "password";
ク ラ イ ア ン ト の SOAP 要求には次の HTTP ヘ ッ ダが付き ます。












POST /scripts/JobAPI/JobAPI.exe HTTP/1.1
Host: YYY:3169
User-Agent: gSOAP/2.7
Content-Type: text/xml; charset=utf-8
Content-Length: nnn
Authorization: Basic Z3Vlc3Q6Z3Vlc3Q=
I 各呼び出 し 後、 成功 ・ 失敗にかかわ ら ず文字列が リ セ ッ ト さ れる ため、
ク ラ イ ア ン ト 認証が必要なそれぞれの呼び出 し に対 し て、 Job API ク
ラ イ ア ン ト は必ず文字列 soap.userid と soap.passwd を設定 し な く ては
な り ません。
デ フ ォル ト イ ン ス ト ールに よ り ServerView が Apache サーバを使用す
る よ う 設定 さ れている場合、 SSL サポー ト が有効にな り ます。 さ ら
に、 Job API サービ スに対する HTTP 認証 も 有効にな り ます。
162
Job API Tandem
9.2 HTTP 認証
HTTP 認証を無効にする ためには、 次に従っ て Apache サーバの コ ン フ ィ グ
レーシ ョ ン フ ァ イル （ssl.config） を変更 し ます。
1. SSL コ ン フ ィ グ レーシ ョ ン フ ァ イル （C:¥Program Files¥Fujitsu¥ServerView
Suite¥ServerView¥ServerView Services¥WebServer¥conf¥ssl.config） を開き ま
す。 そ し て Job API ク ラ イ ア ン ト がイ ン ス ト ール さ れているサーバの IP
ア ド レ ス を ス ク リ プ ト 認証の設定へ追加 し ます。 IP ア ド レ ス、 または IP
ア ド レ スの範囲を入力で き ます。 例えば、 122.138 は 呼び出 さ れたサーバ
122.138.200.151 の IP ア ド レ ス範囲です。
ssl.config file - 例
 # scripts


Directory
"C:/PROGRA~1/FUJITS~1/SERVER~1/SERVER~1/scripts">


Options FollowSymLinks


AllowOverride None




Order deny,allow


Deny from all


Allow from 127.0.0.1


AuthType Basic


AuthUserFile "C:/PROGRA~1/FUJITS~1/SERVER~1/SERVER~1/WebServer/bin/passwd" 

AuthName "C:/PROGRA~1/FUJITS~1/SERVER~1/SERVER~1/WebServer/cgi-bin"


Require valid-user


Satisfy any


</Directory>

I 現在の SSL では、 ロー カルサーバか ら の Job API ク ラ イ ア ン ト の
要求だけ を設定で き ます。 サーバ 122.138.200.151 から のア ク セス
を許可するには、 こ の IP ア ド レ ス を使 っ て Allow ス テー ト メ ン ト
を拡張 し ます。
Allow from 127.0.0.1 122.138.200.151
完全な IP ア ド レ スの変更を許可するには、 次を使 っ て拡張 し ます。
Allow from 127.0.0.1 122.138.200
2. Apache Web サーバを再起動 し ます。
Job API Tandem
163
9 その他の情報
9.3
HTTPS / SSL
「3 セキ ュ リ テ ィ 」 の章 （13 ページ） で説明 さ れている と お り 、 Job API は
CGI ア プ リ ケーシ ョ ン と し て実行 さ れます。 Job API は Job API サービ ス
CGI が稼動 し ている Web サーバに よ り 暗号化 / 複合化 さ れた標準的な I/O を
使用 し ます。 し たが っ て、 Web サーバ と Job API ク ラ イ ア ン ト ア プ リ ケー
シ ョ ンに対 し て HTTP/SSL サポー ト を設定する必要があ り ます。
Job API ク ラ イ ア ン ト が確実に HTTP/SSL を利用で き る よ う にするには、
OpenSSL ラ イ ブ ラ リ （http://www.openssl.org） を ご使用のプ ラ ッ ト フ ォ ーム
に イ ン ス ト ール し て く だ さ い。
イ ン ス ト ール後、 オプ シ ョ ン -DWITH_OPENSSL を使 っ て Job API ク ラ イ ア ン
ト ア プ リ ケーシ ョ ンのソ ース をすべて コ ンパイル し て く だ さ い。 または、
soapdefs.h に次の行を追加 し 、 -DWITH_SOAPDEFS_H を使 っ て コ ンパイル し
て く だ さ い。
#define WITH_OPENSSL;
Job API サービ スへの関数呼び出 し のエ ン ド ポ イ ン ト URL において暗号化 さ
れた転送を行 う ために （Web サーバが HTTPS をサポー ト し ている場合）、
Job API ク ラ イ ア ン ト ア プ リ ケーシ ョ ンは、 単に http: の代わ り と し て接頭辞
https: を使用 し ます。 さ ら に、 Web サーバは HTTPS プ ロ ト コ ル用に HTTP
と は別のポー ト を使用 し ます。 デ フ ォル ト では、 IIS7.0 は HTTPS プ ロ ト コ
ルに対 し てポー ト 443 で待機 し 、 Apache2.0 （ServerView） はポー ト 3170
で待機 し ます。
さ ら に、 ク ラ イ ア ン ト 側のキー フ ァ イル と キー フ ァ イルのパスワー ド を指定
し て く だ さ い。 指定方法については、 OpenSSL のマニ ュ アルを ご覧 く だ さ
い。 http://www.openssl.org.

















if (soap_ssl_client_context(&soap,

SOAP_SSL_DEFAULT,

"client.pem",
// key file: required only when client must authenticate 
to server

// (see SSL docs on how to obtain this file)

"password",
// password to read the key file

NULL,
// optional cacert file to store trusted certificates

NULL,
// optional capath to direcoty with trusted certificates 
NULL
// if randfile!=NULL: use a file with random data to seed 
randomness

))

{

soap_print_fault(&soap, stderr);

exit(1);

}

soap_call_ns_jobapifunction(&soap,

"https://server:3169/scripts/JobAPI/JobAPI.exe", "", ...);

164
Job API Tandem
9.3 HTTPS / SSL
デ フ ォル ト では、 サーバ認証は有効にな っ ています。 テ ス ト 目的で、 サーバ
認証を無効にするには、 次を使用 し ます。
 if (soap_ssl_client_context(&soap,

SOAP_SSL_NO_AUTHENTICATION,

NULL,

NULL,

NULL,

NULL,

NULL,

))

{

soap_print_fault(&soap, stderr);

exit(1);

}












こ れ も サーバが ク ラ イ ア ン ト に認証 （キー フ ァ イルがない） を要求 し ない こ
と を前提に し ています。 ア プ リ ケーシ ョ ン では、 接続の切断 （SIGPIPE） を
検出する よ う にシグナルハン ド ラ を設定 し て く だ さ い。
 signal(SIGPIPE, sigpipe_handle);

例：
 void sigpipe_handle(int x) {…}

I WITH_OPENSSL マ ク ロ を一貫 し て定義 し 、 stdsoap2.cpp、 soapC.cpp、
soapClient.cpp な どの ソ ース と stdsoap2.h または soapH.h を含むすべて
のア プ リ ケーシ ョ ン ソ ース を コ ンパイルする こ と が重要です。 マ ク ロ
の使用が一貫 し ていない と 、 ア プ リ ケーシ ョ ンは、 gSOAP 環境の宣言
と ア ク セスの不一致に よ り ク ラ ッ シ ュ し ます。
Job API Tandem
165
9 その他の情報
9.4
SOAP タ イ ムアウ ト
ソ ケ ッ ト の接続、 承認、 送信、 受信の タ イムアウ ト 値を設定する と 、 通信 タ
イ ムアウ ト を管理で き ます。 soap.connect_timeout、 soap.accept_timeout、
soap.send_timeout、 および soap.recv_timeout 属性は、 ユーザ定義 さ れた適切な
ソ ケ ッ ト 送信、 受信、 承認の タ イムアウ ト 値に設定で き ます。 正数の タ イ ム
アウ ト 値は秒単位で測定 し ます。 負数の タ イムアウ ト 値はマ イ ク ロ秒 （10-6
秒） 単位で測定 し ます。
– soap.connect_timeout は soap call ns method 呼び出 し の タ イ ムアウ ト 値を指
定 し ます。
– soap.accept_timeout は soap accept(&soap) 呼び出 し の タ イ ムアウ ト 値を指
定 し ます。
– soap.send_timeout および soap.recv_timeout はブ ロ ッ ク し ない ソ ケ ッ ト I/O
処理の タ イムアウ ト 値を指定 し ます。
例:








struct soap soap;
soap init(&soap);
soap.send timeout = 10;
soap.recv timeout = 10;
送受信操作を ソ ケ ッ ト 上で開始 し た後、 10 秒以内にデー タ が一切送受信 さ れ
なか っ た場合、 タ イムアウ ト にな り ます。 さ ら に、 ゼロ値は タ イムアウ ト を
無効に し ます。
例：
 soap.send timeout = 0;
 soap.recv timeout = 0;


送受信操作中に タ イムアウ ト が発生 し た場合、 SOAP_EOF 例外が出力 さ れ
ます （「end of file」、 または 「no input」）。
166
Job API Tandem
9.5 CGI タ イムアウ ト
9.5
CGI タ イ ムアウ ト
CGI タ イムアウ ト は、 Job API ク ラ イ ア ン ト の同期要求が Job API サーバか
ら の応答を待つ最大秒数を指定 し ます。 CGI が タ イムアウ ト 時間内に応答 し
ない場合、 要求処理は Web サーバによ り 削除 さ れます。 タ イムアウ ト の特性
は、 CreateImage、 Deploy、 StartSystemInfoRetrieval 関数を使 っ て行われた非同
期要求に影響を与え ません。
さ ら に、 同期要求で示 さ れている タ イ ムアウ ト 値よ り も CGI タ イムアウ ト が
常に大き い こ と を確認 し て く だ さ い。 CGI タ イムアウ ト が小 さ い と 、 関数 タ
イムアウ ト が終了する前に Web サーバに よ り 要求が削除 さ れる可能性があ り
ます。
サーバ固有のデ フ ォル ト タ イムアウ ト 値 と 手順に従い、 タ イムアウ ト 間隔を
増や し て く だ さ い。
9.5.1
Apache 構成
Apache Web サーバ内の時間間隔は、 httpd.conf の タ イムアウ ト 命令を使 っ て
修正 し ます。 こ の命令は次の 3 つに対 し て Apache Web サーバが待機する時
間を定義 し ます。
1. GET 要求を受信する ために要する総時間。
2. POST または PUT 要求での TCP パケ ッ ト 受信間の時間。
3. 応答内で TCP パケ ッ ト を送信する際の ACK 間の時間。
Apache1.2 以前は、 1200 をデ フ ォル ト と し て タ イ マーを使用 し ていま し た
が、 ほ と んどの状況において、 よ り 必要な数値であ る 300 に下げ られま し
た。
Job API Tandem
167
9 その他の情報
次のサーバ固有な手順に従 っ て タ イムアウ ト 間隔を増や し ます。
1. httpd.conf フ ァ イルを開き ます。
2. 次の図で示す と お り タ イムアウ ト 値を修正 し ます。
3. httpd.conf フ ァ イルを保存 し ます。























#
# Timeout: The number of seconds before receives and sends time out.
#
Timeout 300
#
# KeepAlive: Whether or not to allow persistent connections (more than
# one request per connection). Set to "Off" to deactivate.
#
KeepAlive On
#
# MaxKeepAliveRequests: The maximum number of requests to allow
# during a persistent connection. Set to 0 to allow an unlimited amount.
# We recommend you leave this number high, for maximum performance.
#
MaxKeepAliveRequests 100
#
# KeepAliveTimeout: Number of seconds to wait for the next request from the
# same client on the same connection.
#
KeepAliveTimeout 15























I タ イムアウ ト 時間の変更を有効にするには、 Web サーバを再起動する
必要があ り ます。
168
Job API Tandem
9.5 CGI タ イムアウ ト
9.5.2
IIS 構成
Microsoft Internet information service (IIS) の構成では、 タ イ ムアウ ト のデ フ ォ
ル ト 値は 900 秒に設定 さ れています。
次のサーバ固有な手順に従っ て タ イムアウ ト 間隔を増や し ます。
Ê
イ ン タ ーネ ッ ト イ ン フ ォ メ ーシ ョ ンサービ ス (IIS) マネージ ャ を開き ます。
次の図で示すよ う な IIS ウ ィ ン ド ウが表示 さ れます。
Ê 「Web サイ ト 」 フ ォルダ を右 ク リ ッ ク し 、 「プ ロパテ ィ 」 を ク リ ッ ク し ま
す。
Ê 「接続」 ボ ッ ク ス内で 「接続の タ イムアウ ト 」 タ ブへ進み、 タ イ ムアウ ト
値を修正 し ます。
Job API Tandem
169
9 その他の情報
170
Job API Tandem
9.6 SOAP エ ラ ーの対処方法
9.6
SOAP エ ラ ーの対処方法
エ ラ ー報告の 1 行目は、 SOAP の仕様に よ っ て管理 さ れます。 無効な要求や
呼び出 し 元の意図が判定で き ない要求に対 し て、 SOAP のフ ォ ール ト 報告 と
フ ォ ール ト コ ー ド を返 し ます。 SOAP か ら のエ ラ ー メ ッ セージは一般的に
Fault 要素内に含まれています。 Fault 要素が存在する場合、 Body 要素の子要
素 と し て表示 さ れる必要があ り ます。 Fault 要素が SOAP メ ッ セージ内で表
示 さ れるのは一度のみです。 SOAP Fault 要素には次のサブ要素が含まれま
す。
サブ要素
説明
<faultcode>
フ ォ ール ト を識別する コ ー ド を表示 し ます。
<faultstring>
人間が読み取る こ と がで き る フ ォ ール ト 説明を
表示 し ます。
<faultactor>
誰が フ ォ ール ト を発生 さ せたのかに関する情報
を表示 し ます。
<detail>
Body 要素 と 関連する ア プ リ ケーシ ョ ン固有の
エ ラ ー情報を保持 し ます。
faultcode 要素内で フ ォ ール ト を説明する ために使用する定義 さ れた フ ォ ール
ト コ ー ド 値は次の と お り です。
エラー
説明
VersionMismatch
SOAP Envelope の要素に対 し て無効なネームス
ペース を見つけま し た。
MustUnderstand
「1」 に設定 さ れた MustUnderstand 属性を も つ
Header 要素の直近の子要素は理解 さ れません
で し た。
Client
メ ッ セージが間違 っ て形成 さ れた、 または間
違 っ た情報を含んでいま し た。
Server
サーバで問題があ っ たため、 メ ッ セージ を続行
で き ませんで し た。
Job API Tandem
171
9 その他の情報
9.7
SOAP デバ ッ ク
9.7.1
Job API ク ラ イ ア ン ト
Job API ク ラ イ ア ン ト 側のデバ ッ ク 用に メ ッ セージ ロギング を有効にする た
めには、 stdsoap2.h 内にある #define DEBUG 命令の コ メ ン ト を削除 し 、 ク ラ イ
ア ン ト ア プ リ ケーシ ョ ン を コ ンパイル し ます （または単に、 g++ -DDEBUG ...
を使 っ てデバ ッ ク を有効に し た状態で コ ンパイル し ます）。 ク ラ イ ア ン ト ア プ
リ ケーシ ョ ン を実行する と 、 次の 3 つの フ ァ イルにそれぞれの動作を記録 し
ます。
– SENT.log
ア プ リ ケーシ ョ ンに よ っ て送信 さ れた SOAP の内容です。
– RECV.log
ア プ リ ケーシ ョ ンに よ っ て受信 さ れた SOAP の内容です。
– RECV.log
ア プ リ ケーシ ョ ンに よ り 実行 さ れた様々な動作を含むログです。
I ログ記録のため、 Job API ア プ リ ケーシ ョ ンの動作が遅 く な る場合が
あ り ます。
9.7.2
Job API サーバ
追加のデバ ッ ク 情報を入手する ため、 Job API サーバ側で も メ ッ セージ ロ グ
記録を有効にで き ます。 詳 し く は、 ReadMe.txt フ ァ イルを ご覧 く だ さ い。
I ログ記録のため、 Job API ア プ リ ケーシ ョ ンの動作が遅 く な る場合が
あ り ます。
172
Job API Tandem
10
Job API ク ラ イ ア ン ト の開発
こ の章では、 Job API サービ ス と 相互運用で き る gSOAP Web サービ ス開発
環境を使 っ た Job API ク ラ イ ア ン ト ア プ リ ケーシ ョ ンの開発手順について説
明 し ます。
原則 と し て、 所定の WSDL に基づ く ク ラ イ ア ン ト ア プ リ ケーシ ョ ン用イ ン タ
フ ェ ース を生成する様々な SOAP 開発ツールがあ り ます。 SOAP ツールに応
じ た選択は、 使用する プ ラ ッ ト フ ォ ームやプ ログ ラ ム言語 （例 ： C、 C++、
Java な ど） に影響 さ れます。 gSOAP は、 C と C++ を使用 し て、 効率的な
SOAP/XML Web サービ ス と Web サービ ス ク ラ イ ア ン ト ア プ リ ケーシ ョ ン を
デプ ロ イ メ ン ト する ための開発環境で、 プ ラ ッ ト フ ォ ームには依存 し ません。
し たがっ て、 原則 と し て SOAP プ ロ ト コ ルを詳細に理解する必要はあ り ませ
ん。
最初に、 「gSOAP toolkit」 を次か ら ダウン ロー ド し て イ ン ス ト ール し ます。
http://www.cs.fsu.edu/~engelen/soap.html
（Job API Web サービ スの開発には、 リ リ ース V2.7.13 の gSOAP が使用 さ れ
ま し た。）
gSOAP を使 っ た ク ラ イ ア ン ト ア プ リ ケーシ ョ ンの構築を始めるには、 次が必
要です。
– C または C++ コ ンパイ ラ
– gSOAP soapcpp2 （例 ： Windows 用 soapcpp2.exe） ス タ ブおよびスケル ト
ン コ ンパイ ラ
– soapcpp2 ス タ ブ と スケル ト ン コ ンパイ ラ に対 し て WSDL を gSOAP 仕様
ヘ ッ ダ フ ァ イルへ変換する gSOAP wsdl2h （例 ： Windows 用 wsdl2h.exe）
WSDL パーサ （構文解析ツール）
– Web サービ ス ア プ リ ケーシ ョ ン と リ ン ク する ためのラ ン タ イ ム ラ イ ブ ラ
リ を持つ次の フ ァ イル ： stdsoap2.c または stdsoap2.cpp、 stdsoap2.h
– SSL （HTTPS） と 圧縮処理がで き る よ う に、 オプ シ ョ ン と し て Open SSL
と Zlib ラ イ ブ ラ リ を イ ン ス ト ールする必要があ る場合 も あ り ます。
Job API Tandem
173
10 Job API ク ラ イ ア ン ト の開発
10.1
C/C++ ス タ ブの生成
一般的に、 SOAP ク ラ イ ア ン ト ア プ リ ケーシ ョ ンの実行には、 ク ラ イ ア ン ト
ア プ リ ケーシ ョ ン を起動する ために必要な各 リ モー ト 方式用のス タ ブルーチ
ンが必要です。 ス タ ブの主な役割 と は、 パラ メ ー タ デー タ を marshal し 、 パ
ラ メ ー タ を使 っ て指定 さ れた SOAP サービ スへ要求を送信 し て応答を待ち、
応答が来た ら応答のパラ メ ー タ デー タ を unmarshal する こ と です。 ク ラ イ ア
ン ト ア プ リ ケーシ ョ ンは、 ロー カル方式を起動するかのよ う に、 リ モー ト 方
式に対する ス タ ブルーチ ン を起動 し ます。 gSOAP wsdl2h WSDL パーサ、
soapcpp2 ス タ ブ、 およびスケル ト ン コ ンパイ ラは、 Web サービ ス ク ラ イ ア ン
ト の開発を自動化 し ます。 gSOAP ス タ ブ と スケル ト ン コ ンパイ ラは、 SOAP
ク ラ イ ア ン ト を構築する ために必要な ソ ース を生成する プ リ プ ロ セ ッ サです。
soapcpp2 への入力は、 標準 C/C++ ヘ ッ ダ フ ァ イルによ り 構成 さ れています。
こ のヘ ッ ダ フ ァ イルは、 あ ら か じ め gSOAP WSDL を使 っ てサービ スの
WSDL 文書か ら作成する必要があ り ます。
Job API ク ラ イ ア ン ト を開発する ためには、 最初に Job API の WSDL を
gSOAP WSDL を使 っ て イ ンポー ト し ます。 SOAP リ モー ト 方式の Job API
関数プ ロ ト タ イ プの C/C++ 宣言を使 っ てヘ ッ ダ フ ァ イルを作成 し ます。
wsdl2h -o JobAPI.h JobAPI.wsdl
こ れで Job API WSDL から C++ 形式で フ ァ イル JobAPI.h が生成 さ れます。
ヘ ッ ダ フ ァ イルを生成 し 純粋な C ク ラ イ ア ン ト ア プ リ ケーシ ョ ン を開発する
には、 次の コ マ ン ド を実行 し ます。
wsdl2h -c -o JobAPI.h JobAPI.wsdl
次の開発手順では、 gSOAP コ ンパイ ラは、 ク ラ イ ア ン ト ア プ リ ケーシ ョ ン に
対する ス タ ブルーチ ンへ こ の生成 さ れた JobAPI.h ヘ ッ ダ フ ァ イルを変換 し ま
す。 結果 と し て生 じ る ス タ ブルーチ ンは、 C および C++ ク ラ イ ア ン ト ア プ リ
ケーシ ョ ンが既存の Job API Web サービ ス と スムーズにや り 取 り で き る よ う
に し ます。 gSOAP コ ンパイ ラは次の コ マ ン ド ラ イ ンか ら 起動 し ます。
soapcpp2 JobAPI.h
こ の Job API SOAP サービ ス方式の入出力パ ラ メ ー タ は、 単純なデー タ タ イ
プ または複合的なデー タ タ イ プの場合があ り ます。 こ れら は、 WSDL に含ま
れているデー タ タ イ プの定義に応 じ て WSDL パーサに よ っ て生成 さ れます。
さ ら に、 gSOAP ス タ ブ と スケル ト ン コ ンパイ ラは自動的にデー タ タ イ プのシ
リ ア ラ イザ と デシ リ ア ラ イザを生成 し ます。 そ し て生成 さ れたス タ ブルーチ
ンが XML で リ モー ト 方式のパ ラ メ ー タ 内容を暗号化および複合化で き る よ う
に し ます。
174
Job API Tandem
10.1 C/C++ ス タ ブの生成
WSDL パーサまたはス タ ブ / スケル ト ン コ ンパイ ラ によ り 生成 さ れた フ ァ イ
ルの詳細は次の と お り です。
soapStub.h
入力ヘ ッ ダ フ ァ イルか ら 作成 さ れた修
正または注釈付き フ ァ イルです。
soapH.h
すべての ク ラ イ ア ン ト と サービ ス ソ ー
スに含まれる メ イ ンヘ ッ ダ フ ァ イルで
す。
soapC.cpp
指定 し たデー タ 構造のシ リ ア ラ イザ と
デシ リ ア ラ イザです。
soapClient.cpp
リ モー ト 操作用 ク ラ イ ア ン ト ス タ ブ
ルーチ ン です。
soapServer.cpp
サービ ススケル ト ンルーチ ン です。
soapClientLib.cpp
ロー カルの静的 （デ） シ リ ア ラ イザ と
結合 し た ク ラ イ ア ン ト ス タ ブ です。
soapServerLib.cpp
ロー カルの静的 （デ） シ リ ア ラ イザ と
結合 し たサービ ス スケル ト ン です。
JobAPI.h
SOAP リ モー ト 方式の Job API 関数プ
ロ ト タ イ プの C/C++ 宣言を含むヘ ッ ダ
フ ァ イルです。
JobAPISoapBinding.nsmp
サーバ と ク ラ イ ア ン ト が収容する ネー
ムスペース マ ッ ピ ングテーブルです。
soapJobAPISoapBindingProxy.h
C++ プ ロキシオブ ジ ェ ク ト です
（soapClient.cpp の代わ り と し て使用で
き ます）。
soapJobAPISoapBindingProxy.cpp
C++ プ ロキシオブ ジ ェ ク ト の実行です。
soapJobAPISoapBindingObject.h
C++ サーバオブ ジ ェ ク ト です
（soapServer.cpp の代わ り と し て使用で
き ます）。
soapJobAPISoapBindingObject.cpp
C++ サーバオブ ジ ェ ク ト の実行です。
.xsd
コ ンパイ ラ に対するヘ ッ ダ フ ァ イル入
力のデー タ 構造に よ り 使用 さ れる各
ネームスペースの接頭辞 ns 用の XML
スキーマ を使 っ て、 ns.xsd フ ァ イルは
生成 さ れます。
表 2:
Job API Tandem
175
10 Job API ク ラ イ ア ン ト の開発
Job API ク ラ イ ア ン ト ア プ リ ケーシ ョ ンの開発プ ロ セスに関する全手順は次
の図の と お り です。
176
Job API Tandem
10.2 生成 さ れた C/C++ ス タ ブの使用
10.2
生成 さ れた C/C++ ス タ ブの使用
生成 さ れた C/C++ ス タ ブルーチ ン を使用するには、 次のよ う な C/C++ ク ラ
イ ア ン ト ア プ リ ケーシ ョ ン コ ー ド を実行 し ます。
C++ コ ンパイ ラ を使っ た コ ンパイル後、 例えば g++ の場合 ：
g++ soapC.cpp soapClient.cpp stdsoap2.cpp client.cc -o client
ア プ リ ケーシ ョ ン を実行する と 、 Job API メ ソ ッ ド GetAPIVersion を呼び出
し 、 ア ク セス し たホス ト （ロー カルホス ト 以外） に イ ン ス ト ール さ れている
Job API サービ スのバージ ョ ン を返 し ます。
I こ の ク ラ イ ア ン ト 開発に関する説明では、 詳細が省略 さ れています。
詳 し く は gSOAP ユーザーズガ イ ド を ご覧 く だ さ い。
Job API Tandem
177
10 Job API ク ラ イ ア ン ト の開発
178
Job API Tandem
索引
GetScheduledJobLogList 141
GetScheduledJobProperties 139
GetServerJobStatus 134
GetSystemInfoResult 48
Group Management 99
A
AddGroupMember 108
AddRepository 74
AddServer 33
API エラーコード 149
API 管理 28
I
ImportDeploymentConfiguration 55
Installation process 152
C
CancelJob 137
ChangeServerConfiguration 40
CreateDirectory 93
CreateGroup 100
CreateImage 79
CreateUserKey 32
R
RdDeplServerList 49
ReadImagefilenameList 90
ReadImageInfoText 91
RemoveGroupMember 110
RemoveRepository 76
RemoveUserKey 60
Repository Management 72
D
DeleteDirectory 95
DeleteGroup 102
DeleteImage 87
DeleteScheduledJob 143
Deploy 118
E
ErrorCode 149
ErrorString 149
ExportDeploymentConfiguration
G
GetAPIinfo 29
GetAPIVersion 28
GetBootMode 70
GetDirectoryContents 97
GetGroupList 103
GetGroupMemberList 111
GetGroupMemberProperties
GetGroupProperties 107
GetImageProperties 92
GetJobStatusDetails 131
GetPower 68
GetRepositoryContents 88
GetRepositoryList 77
Job API Tandem
57
S
SetGroupMemberProperties 113
SetGroupProperties 105
SetPower 61
SetPXEBootImage 65
SetUserKey 59
StartSystemInfoRetrieval 45
い
インストール
115
151
か
関数
AddGroupMember 108
AddRepository 74
AddServer 33
CancelJob 137
ChangeServerConfiguration 40
CreateDirectory 93
CreateGroup 100
CreateImage 79
CreateUserKey 32
179
索引
DeleteDirectory 95
DeleteImage 87
DeleteGroup 102
DeleteScheduledJob 143
Deploy 118
ExportDeploymentConfiguration
57
GetAPIinfo 29
GetAPIVersion 28
GetBootMode 70
GetDirectoryContents 97
GetGroupList 103
GetGroupMemberList 111
GetGroupMemberProperties 11
5
GetGroupProperties 107
GetImageProperties 92
GetJobStatusDetails 131
GetPower 68
GetRepositoryContents 88
GetScheduledJobProperties 139
GetRepositoryList 77
GetScheduledJobLogList 141
GetServerJobStatus 134
GetSystemInfoResult 48
ImportDeploymentConfiguration
55
RdDeplServerList 49
ReadImagefilenameList 90
ReadImageInfoText 91
RemoveGroupMember 110
RemoveRepository 76
RemoveUserKey 60
SetGroupMemberProperties 113
SetGroupProperties 105
SetPower 61
SetPXEBootImage 65
SetUserKey 59
StartSystemInfoRetrieval 45
関数の概要 21
さ
サーバ / ノードリスト管理
180
し
システム要件 151
ジョブ管理 130
ジョブスケジューリング
145
て
ディレクトリ管理 93
データの種類 26
デプロイメント管理 117
電源管理 61
33
Job API Tandem