付録

印刷する

付録

印刷する

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

設定ファイル仕様（Windows版）

設定ファイル
appsettings.json

設定項目

カテゴリ	項目	型	説明	デフォルト値	必須
api	url	string	iDoperation ServerのIPアドレス/ホスト名を設定します。	-	〇
	authType	int	『事前準備』で準備した認証方式（0：OAuth認証、1：Basic認証、2：APIトークン）を設定します。	0
	clientId	string	認証方式が OAuth認証の場合、iDoperation WebAPIクライアントIDを設定します。	-	△ (*1)
	clientSecret	string	認証方式が OAuth認証の場合、iDoperation WebAPIクライアントシークレットを設定します。	-	△ (*1)
	token	string	認証方式が OAuth認証の場合、 iDoperation WebAPIのアクセストークンを設定します。	-	△ (*1)
	basicClientId	string	認証方式が Basic認証の場合、『事前準備』で準備したクライアントIDを設定します。	-	△ (*2)
	basicPassword	string	認証方式が Basic認証の場合、『事前準備』で準備したBasic認証パスワードを設定します。	-	△ (*2)
	apiToken	string	認証方式がAPIトークンの場合、『事前準備』で準備したAPIトークンを設定します。	-	△ (*3)
proxy	useProxy	bool	プロキシの使用/不使用を設定します。	false
	server	string	プロキシサーバー（ポート番号付き）を設定します。	-
	user	string	プロキシ認証ユーザを設定します。	-
	password	string	プロキシ認証ユーザのパスワードを設定します。	-
cache	useCache	bool	認証データのキャッシュ保持/非保持を設定します。	true
cache	term	int	キャッシュ保持期間を設定します。（単位：分）(*4)	60
log	level	int	ログ出力レベルを設定します。 1：FATAL 2：ERROR 3：WARN 4：INFO 5：DEBUG	4

(*1) 認証方式がOAuth認証の場合、clientIdとclientSecret、もしくはtokenのどちらかが必須です。
(*2) 認証方式がBasic認証の場合、必須です。
(*3) 認証方式がAPIトークンの場合、必須です。
(*4) 0を設定すると無期限で保持します。

設定ファイル例

{
　　"api": {
　　　　"url": "192.168.0.1",
　　 "authType": 0,
　　　　"clientId": "82218383-9D78-4812-8CE5-BB2AB79xxxxx",
　　　　"clientSecret": "Jw5CpnMaD435uodkbcvBfIWE5Nr3ODk8GZJxxxxx",
　　　　"token": ""
　　},
　　"proxy": {
　　　　"useProxy": true,
　　　　"server": "http://proxy.example.com:8080",
　　　　"user": "",
　　　　"password": ""
　　},
　　"cache": {
　　　　"useCache": true,
　　　　"term": 60
　　},
　　"log": {
　　　　"level": 4
　　}
}

設定ファイル仕様（UNIX/Linux版）

設定ファイル
appsettings.ini

設定項目

セクション	項目	説明	デフォルト値	必須
api	url	iDoperation ServerのIPアドレス/ホスト名を設定します。	-	〇
	authType	『事前準備』で準備した認証方式（0：OAuth認証、1：Basic認証、2：APIトークン）を設定します。	0
	clientId	認証方式が OAuth認証の場合、iDoperation WebAPIクライアントIDを設定します。	-	△ (*1)
	clientSecret	認証方式が OAuth認証の場合、iDoperation WebAPIクライアントシークレットを設定します。	-	△ (*1)
	token	iDoperation WebAPIのアクセストークンを設定します。	-	△ (*1)
	basicClientId	認証方式が Basic認証の場合、『事前準備』で準備したクライアントIDを設定します。	-	△ (*2)
	basicPassword	認証方式が Basic認証の場合、『事前準備』で準備したBasic認証パスワードを設定します。	-	△ (*2)
	apiToken	認証方式がAPIトークンの場合、『事前準備』で準備したAPIトークンを設定します。	-	△ (*3)
proxy	useProxy	プロキシの使用/不使用を設定します。 1：使用 0：不使用	0
	server	プロキシサーバー（ポート番号付き）を設定します。	-
	user	プロキシ認証ユーザを設定します。	-
	password	プロキシ認証ユーザのパスワードを設定します。	-
cache	useCache	認証データのキャッシュ保持/非保持を設定します。 1：保持 0：非保持	1
cache	term	キャッシュ保持期間を設定します。（単位：分）(*4)	60
log	level	ログ出力レベルを設定します。 1：FATAL 2：ERROR 3：WARN 4：INFO 5：DEBUG	4
log	out	ログを出力するパスを設定します。	-

設定ファイル例

[api]
url = "192.168.0.1"
authType = 0
clientId = "82218383-9D78-4812-8CE5-BB2AB79xxxxx "
clientSecret = " gQF+DGMiOyIDPwYRKIIFynfWYAfGKWMYW7J0lil1uKEuPxJfyYjzqTC9SreLttVVKAaWjGEwHpJqubj56oLD3bLEjusDUf9pG0mO/r3OI1lSeGl4i5ulJ4XuOvg1yLtUSBjY58r/IfE+3JOv3hXzeuE0LFAC1E079adf3x/V3o0= "
token = ""
basicClientId =””
basicPassword =””
apiToken =””

[proxy]
useProxy = 0
server = "http://proxy.example.com:8080"
user = ""
password = ""

[cache]
useCache = 1
term = 60

[log]
level = 4
out = ./log

コマンド仕様（Windows版）

■認証情報取得コマンド

iDoperation WebAPIからパスワード/秘密鍵ファイル/パスフレーズ等を取得し、JSON形式で返却します。

構文

AppClient get [options]

Options:
--account <account> (REQUIRED) 　　　　 Account name (string)
--id <id> 　　　　　　　　　　　　　　　　 Target ID (int) []
--name <name> 　　　　　　　　　　　　　Target name (string) []
--type <type> 　　　　　　　　　　　　　　Target type (int) []
--memo <memo> 　　　　　　　　　　　　 Memo (string) []
--ip-address <ip-address> 　　　　　　　　Target IPaddress / hostname (string) []
--port <port> 　　　　　　　　　　　　　 Port (int) []
--sub-type <sub-type> 　　　　　　　　　Sub type (int) []
--db-name <db-name> 　　　　　　　　　 Database name (string) []
--db-sid <db-sid> 　　　　　　　　　　　　Database SID (string) []
--db-id <db-id> 　　　　　　　　　　　　　Database ID (string) []
--domain-name <domain-name> 　　　　　Domain name (string) []
-?, -h, --help 　　　　　　　　　　　　　　 Show help and usage information

使用例

>.¥AppClient get --account Administrator --name WindowsServer01 --ip-address 192.168.0.1

オプションパラメータ
ターゲットを一意に特定できるようパラメータを指定します。

項目名	型	説明	必須
--account	string	アカウント名を設定します。	〇
--id	int	ターゲットID（ターゲットを一意に特定可能）を設定します。
--name	string	ターゲット名を設定します。
--type	int	ターゲット種別を設定します。
--memo	string	メモを設定します。
--ip-address	string	IPアドレス/ホスト名を設定します。
--port	int	ターゲットのポート番号を設定します。
--sub-type	int	ターゲットのサブ種別を設定します。
--db-name	string	データベース名/サービス名を設定します。
--db-sid	string	データベースシステム識別子(SID) を設定します。
--db-id	string	インスタンス名/DBIDを設定します。
--domain-name	string	ドメイン名を設定します。

■設定ファイル変更（暗号化）コマンド

オプションで指定されたWebAPI認証情報項目とパスワード（プロキシ認証用）の平文を設定ファイル（appsettings.json）に暗号化して保存します。

構文

AppClient setting [options]

Options:

--client-secret 　　 Encrypt Client Secret (string) []
--basic-password 　 Encrypt password for Basic Authentication (string) []
--api-token 　　　　 Encrypt API Token (string) []
--proxy-password Encrypt password for Proxy (string) []
-?, -h, --help 　　 Show help and usage information

使用例

> .\AppClient setting --client-secret QYQYVKccs6SgM39pfBYfpNNtCK2nUaEBciTpiL4ibmGcf23A5RcLuZUFFRHYAA/vcaZA8MBdvVYkae/2fUaDow==

オプション

項目名	説明
--client-secret	設定ファイルのapi.clientSecret項目に暗号化した値を設定します
--basic-password	設定ファイルのapi.basicPassword項目に暗号化した値を設定します
--api-token	設定ファイルのapi.apiToken項目に暗号化した値を設定します
--proxy-password	設定ファイルのproxy.password項目に暗号化した値を設定します

■キャッシュ削除コマンド

キャッシュデータ（パスワード/秘密鍵ファイル/パスフレーズ等）を削除します。

※通常は次回のApp Clientのアクセスで保持期限の切れたキャッシュデータは自動的に削除されます。手動で削除したい場合は、キャシュ削除コマンドで削除してください。

構文

AppClient delete [options]

Options:
　--all 　　　　　Database deletion flag [default: False]
　-?, -h, --help 　Show help and usage information

使用例

>.¥AppClient delete

オプション

項目名	説明
（指定なし）	キャッシュ保持期間を過ぎたキャッシュデータを削除します。
--all	キャッシュ保持期間を過ぎたキャッシュデータだけでなくデータベース自体を削除する場合、設定します。

コマンド仕様（UNIX/Linux版）

■認証情報取得コマンド

iDoperation WebAPIからパスワード/秘密鍵ファイル/パスフレーズ等を取得し、JSON形式で返却します。

構文

appclient [options]

Options:
--account <account> (REQUIRED) 　　　 Account name (string)
--id <string> 　　　　　　　　　　　　　　Target ID (string) []
--name <name> 　　　　　　　　　　　　Target name (string) []
--type <type> 　　　　　　　　　　　　　Target type (int) []
--memo <memo> 　　　　　　　　　　　 Memo (string) []
--ip-address <ip-address> 　　　　　　　Target IPaddress / hostname (string) []
--port <port> Database port (int) []
--sub-type <sub-type> Database type (int) []
--db-name <db-name> 　　　　　　　　 Database name (string) []
--db-sid <db-sid> 　　　　　　　　　　　Database SID (string) []
--db-id <db-id> 　　　　　　　　　　　　Database ID (string) []
--domain-name <domain-name> 　　　　Domain name (string) []
-?, -h, --help 　　　　　　　　　　　　　 Show help and usage information

使用例

> ./appclient get --account root --name Linux01 --ip-address 192.168.0.1

オプションパラメータ
ターゲットを一意に特定できるようパラメータを指定します。

項目名	型	説明	必須
--account	string	アカウント名を設定します。	〇
--id	int	ターゲットID（ターゲットを一意に特定可能）を設定します。
--name	string	ターゲット名を設定します。
--type	int	ターゲット種別を設定します。
--memo	string	メモを設定します。
--ip-address	string	IPアドレス/ホスト名を設定します。
--port	int	ターゲットのポート番号を設定します。
--sub-type	int	ターゲットのサブ種別を設定します。
--db-name	string	データベース名/サービス名を設定します。
--db-sid	string	データベースシステム識別子(SID) を設定します。
--db-id	string	インスタンス名/DBIDを設定します。
--domain-name	string	ドメイン名を設定します。

■設定ファイル変更（暗号化）コマンド

オプションで指定されたWebAPI認証情報項目とパスワード（プロキシ認証用）の平文を設定ファイル（appsettings.ini）に暗号化して保存します。

構文

appclient setting [options]

Options:

--client-secret <clientSecret> 　 Encrypt clientSecret item
--basic-password <basicPassword> Encrypt basicPassword item
--api-token <apiToken> Encrypt apiToken item
--password <password> Encrypt password item
-?, -h, --help Show help and usage information

使用例

> ./appclient setting --client-secret GZPNJnyQk81EZ7AFis3W4AHwPhtmGqucCtqB51w4

オプション

項目名	説明
--client-secret	設定ファイルのapi.clientSecret項目に暗号化した値を設定します
--basic-password	設定ファイルのapi.basicPassword項目に暗号化した値を設定します
--api-token	設定ファイルのapi.apiToken項目に暗号化した値を設定します
--password	設定ファイルのproxy.password項目に暗号化した値を設定します

■キャッシュ削除コマンド

キャッシュデータ（パスワード/秘密鍵ファイル/パスフレーズ等）を削除します。

構文

appclient delete [options]

Options:
　--all <flag>　　Delete cashe file?
　-?, -h, --help 　Show help and usage information

使用例

> ./appclient delete
> ./appclient delete –all true

オプション

項目名	型	説明
（指定なし）	-	キャッシュ保持期間を過ぎたキャッシュデータを削除します。
--all	string	キャッシュ保持期間を過ぎたキャッシュデータだけでなくデータベース自体を削除する場合、設定します。 true(全削除) false(指定なしと同様)

What's Next

リファレンス（Web API）

INDEX

設定ファイル仕様（Windows版）
設定ファイル仕様（UNIX/Linux版）
コマンド仕様（Windows版）
コマンド仕様（UNIX/Linux版）