N1 Service Provisioning System 4.1 リファレンスガイド

第 15 章 udb: ユーザーとグループを管理する CLI コマンド

この章は、ユーザーとグループの管理に必要なコマンドについて説明します。

`udb` コマンドの概要

CLI には、ユーザーとグループを管理する以下のコマンドセットが含まれています。

表 15–1 ユーザーアカウント、グループ、ログインのコマンドセット


CLI 接頭辞	コマンドセットの説明
udb.g	ユーザーグループを管理するコマンド
udb.login udb.logout udb.whoami	ログインセッションを管理するコマンド
udb.p	アクセス権を管理するコマンド
udb.u	ユーザーアカウントを管理するコマンド
udb.sv	セッション変数を管理するコマンド

この章では、これらの各セット内のすべてのコマンドについて説明します。

udb.g: ユーザーグループの管理

udb.g コマンドを使用すると、ユーザーグループを定義、変更、削除、一覧表示することができます。

表 15–2 udb.g コマンドの概要


コマンド名	説明
udb.g.add	新しいユーザーグループを追加する
udb.g.del	ユーザーグループを削除する
udb.g.la	すべてのユーザーグループを一覧表示する
udb.g.lo	指定されたユーザーグループについての情報を検出する
udb.g.lp	指定されたグループに与えられたアクセス権を一覧表示する
udb.g.lu	指定されたグループのメンバーであるユーザーを一覧表示する
udb.g.mod	既存のユーザーグループを変更する

udb.g.add

このコマンドは、新しいグループを追加します。

表 15–3 udb.g.add の引数と結果


引数/結果		構文	説明
n	[R]	文字列	新しいグループ名
d	[O]	文字列	新しいグループの説明
ua	[O]	UserArray	新しいグループのユーザー
pa	[O]	PermissionArray	新しいグループのアクセス権
pga	[O]	GroupArray	新しいグループの親グループ
cga	[O]	GroupArray	新しいグループの子グループ
result		Group	新しいグループ

udb.g.del

このコマンドは、指定されたグループを削除します。

注 –

グループを削除しても、グループ内のユーザーアカウントは削除されません。ユーザーアカウントが分類されていたグループが削除されるだけです。

表 15–4 udb.g.del コマンドの引数


引数		構文	説明
ID	[R]	GroupID	グループ ID

udb.g.la

このコマンドは、N1 Service Provisioning System software で定義されたすべてのグループを一覧表示します。

表 15–5 udb.g.la コマンドの結果


結果	構文	説明
result	GroupArray	グループ

udb.g.lo

このコマンドは、指定されたグループを検出します。

表 15–6 udb.g.lo コマンドの引数と結果


引数/結果		構文	説明
ID	[R]	GroupID	グループ ID
result		Group	グループ

udb.g.lp

このコマンドは、グループに与えられたアクセス権を一覧表示します。

表 15–7 udb.g.lp の引数と結果


引数/結果		構文	説明
ID	[R]	GroupID	グループ ID
result		PermissionArray	アクセス権

udb.g.lu

このコマンドは、指定されたグループのメンバーを一覧表示します。

表 15–8 udb.g.lu コマンドの引数と結果


引数/結果		構文	説明
ID	[R]	GroupID	グループ ID
result		UserArray	ユーザー

udb.g.mod

このコマンドは、既存のグループを変更します。省略された引数は、現在の値を保持します。

表 15–9 udb.g.mod コマンドの引数と結果


引数/結果		構文	説明
ID	[R]	GroupID	グループ ID
n	[O]	文字列	新しいグループ名
d	[O]	文字列	新しいグループの説明
ua	[O]	UserArray	新しいグループのユーザー
pa	[O]	PermissionArray	新しいグループのアクセス権
pga	[O]	GroupArray	新しいグループの親グループ
cga	[O]	GroupArray	新しいグループの子グループ
result		Group	変更されたグループ

udb.u: ユーザーアカウントの管理

udb.u コマンドを使用すると、個々のユーザーアカウントを管理できます。

表 15–10 udb.g コマンドの概要


コマンド名	説明
udb.u.add	新しいユーザーアカウントを追加する
udb.u.cp	指定されたユーザーのパスワードを変更する
udb.u.la	すべてのユーザーアカウントを一覧表示する
udb.u.lo	指定されたユーザーについての情報を検出する
udb.u.lp	指定されたユーザーに与えられたアクセス権を一覧表示する
udb.u.mod	指定されたユーザーアカウントを変更する

udb.u.add

このコマンドは、新しいユーザーを追加します。

表 15–11 udb.u.add コマンドの引数と結果


引数		構文	説明
nu	[R]	文字列	新しいユーザー名
np	[R]	文字列	新しいユーザーパスワード
ng	[O]	GroupArray	新しいユーザーグループ
hide	[O]	ブール型	ユーザーを非表示にするかどうか。デフォルトは false
result		User	新しいユーザー

udb.u.cp

このコマンドは、指定されたユーザーのパスワードを変更します。

表 15–12 udb.u.cp コマンドの引数


引数		構文	説明
un	[R]	文字列	パスワードを変更する必要があるユーザーのユーザー名
op	[R]	文字列	古いパスワード
np	[R]	文字列	新しいパスワード

udb.u.la

このコマンドは、すべてのユーザーアカウントを一覧表示します。

表 15–13 udb.u.la コマンドの引数と結果


引数/結果		構文	説明
sh	[O]	ブール型	非表示ユーザーを表示するかどうか。デフォルトは false
result		UserArray	ユーザー

udb.u.lo

udb.u.lo コマンドは、指定されたユーザーを検出します。

表 15–14 udb.u.lo コマンドの引数と結果


引数/結果		構文	説明
ID	[R]	UserID	ユーザー ID
result		User	ユーザー

udb.u.lp

このコマンドは、ユーザーに与えられたアクセス権を一覧表示します。

表 15–15 udb.u.lp コマンドの引数と結果


引数/結果		構文	説明
ID	[R]	UserID	ユーザー ID
result		PermissionArray	アクセス権

udb.u.mod

このコマンドは、既存のユーザーを変更します。省略された引数は、現在の値を保持します。

表 15–16 udb.u.mod コマンドの引数と結果


引数/結果		構文	説明
ID	[R]	UserID	ユーザー ID
np	[O]	文字列	新しいユーザーパスワード
ng	[O]	GroupArray	新しいユーザーグループ
hide	[O]	ブール型	ユーザーを非表示に設定するかどうか
active	[O]	ブール型	ユーザーをアクティブに設定するかどうか
result		User	変更されたユーザー

udb.sv: セッション変数の管理

udb.sv コマンドを使用すると、セッション変数を管理できます。

表 15–17 udb.sv コマンドの概要


コマンド名	説明
udb.sv.add	新しいセッション変数を追加する
udb.sv.del	セッション変数を削除する
udb.sv.la	すべてのセッション変数を一覧表示する
udb.sv.lo	セッション変数についての情報を検出する
udb.sv.mod	指定されたセッションの値を変更する

udb.sv.add

このコマンドは、新しいセッション変数を追加します。

注 –

HTML ユーザーインタフェースにログインし、CLI を使用してセッション変数を追加する場合、変数の一覧を再表示すると、セッション変数名が値なしで表示されます。新しいセッション変数の値を表示するには、HTML ユーザーインタフェースからいったんログアウトして、ログインし直してください。

表 15–18 udb.sv.add コマンドの引数と結果


引数		構文	説明
name	[R]	文字列	新しいセッション変数名
secure	[O]	ブール型	値を表示するかどうか。true の場合表示されない。デフォルトは false
desc	[O]	String	新しいセッション変数値の説明
value	[R]	文字列	該当ユーザーの新しいセッション変数値変数の値が空の文字列の場合、 `- value ""` と入力する
result		SessionVariable	新しいセッション変数

udb.sv.del

このコマンドは、セッション変数を削除します。

表 15–19 udb.sv.del コマンドの引数


引数		構文	説明
name	[R]	文字列	削除するセッション変数の名前

udb.sv.la

このコマンドは、すべてのセッション変数を一覧表示します。

表 15–20 udb.sv.la コマンドの引数と結果


引数/結果		構文	説明
result		SessionVariable	セッション変数

udb.sv.lo

このコマンドは、指定されたセッション変数を検出します。

表 15–21 udb.sv.lo コマンドの引数と結果


引数/結果		構文	説明
name	[R]	文字列	表示するセッション変数の名前
result		SessionVariable	セッション変数

udb.sv.mod

このコマンドは、セッション変数を変更します。変数を保持する場合は、-p パラメタを使用してパスワードを設定します。

表 15–22 udb.sv.mod コマンドの引数と結果


引数/結果		構文	説明
name	[R]	文字列	変更するセッション変数の名前
secure	[O]	文字列	値を表示するかどうか。true の場合表示されない。デフォルトは false
desc	[O]	文字列	新しいセッション変数の説明
value	[O]	文字列	該当ユーザーの新しいセッション変数値
result		SessionVariable	新しいセッション変数

認証コマンド

udb.login

このコマンドは、ユーザーにログインし、認証に使用する SessionID を返します。

表 15–23 udb.login コマンドの結果


結果	構文	説明
result	SessionID	セッション ID

udb.logout

このコマンドは、実行ユーザーをログアウトします。

udb.whoami

このコマンドは、現在のセッションの所有者を返します。

表 15–24 udb.whoami コマンドの結果


結果	構文	説明
result	UserID	現在のユーザー ID

udb.p: アクセス権を管理するコマンド

udb.p コマンドを使用すると、N1 Service Provisioning System software で設定されたアクセス権についての情報を表示できます。

表 15–25 udb.p コマンドの概要


コマンド	説明
udb.p.la	すべてのアクセス権を一覧表示する
udb.p.lo	指定されたアクセス権を検出する

udb.p.la

このコマンドは、すべてのアクセス権を一覧表示します。

表 15–26 udb.p.la コマンドの結果


結果	構文	説明
result	PermissionArray	アクセス権

udb.p.lo

このコマンドは、指定されたアクセス権を検出します。

表 15–27 udb.p.lo コマンドの引数と結果


引数/結果		構文	説明
ID	[R]	PermissionID	アクセス権の ID
result		Permission	アクセス権