dir-cli コマンド リファレンス

dir-cli ユーティリティは、VMware Directory Service (vmdir) におけるソリューション ユーザーの作成と更新、アカウント管理、および証明書とパスワードの管理をサポートします。vCenter Server インスタンスのドメイン機能レベルの管理およびクエリに、dir-cli を使用できます。

dir-cli nodes list

拡張リンク モードで接続されているすべての vCenter Server システムを一覧表示します。

オプション	説明
--login <admin_user_id>	デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は [email protected] です。
--password <admin_password>	管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。
--server <psc_ip_or_fqdn>	このオプションを使用すると、別の vCenter Server に接続して、そのレプリケーション パートナーを表示できます。

dir-cli computer password-reset

ドメインのマシン アカウントのパスワードをリセットすることができます。

オプション	説明
--login <admin_user_id>	デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は [email protected] です。
--password <admin_password>	管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。
--live-dc-hostname <server name>	vCenter Server インスタンスの現在の名前。

dir-cli service create

ソリューション ユーザーを作成します。主にサードパーティ製ソリューションで使用されます。

オプション	説明
--name <name>	作成するソリューション ユーザーの名前。
--cert <cert file>	証明書ファイルへのパス。VMCA で署名された証明書またはサードパーティ証明書を指定できます。
--ssogroups <comma-separated-groupnames>	ソリューション ユーザーを指定されたグループのメンバーにします。
--wstrustrole <ActAsUser>	ソリューション ユーザーを組み込みの管理者またはユーザー グループのメンバーにします。つまり、ソリューション ユーザーに管理者権限を付与するかどうかを決定します。
--ssoadminrole <Administrator/User>	ソリューション ユーザーを ActAsUser グループのメンバーにします。ActAsUser ロールを持つユーザーは、他のユーザーに代わって作業できるようになります。
--login <admin_user_id>	デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は [email protected] です。
--password <admin_password>	管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli service list

dir-cli で認識されるソリューション ユーザーをリストします。

オプション	説明
--login <admin_user_id>	デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は [email protected] です。
--password <admin_password>	管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli service delete

vmdir のソリューション ユーザーを削除します。ソリューション ユーザーを削除すると、vmdir のこのインスタンスを使用するすべての管理ノードで、関連するサービスがすべて使用できなくなります。

オプション	説明
--name	削除するソリューション ユーザーの名前。
--login <admin_user_id>	デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は [email protected] です。
--password <admin_password>	管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli service update

指定したソリューション ユーザー（つまり、サービスのコレクション）の証明書を更新します。このコマンドを実行した後で、vecs-cli entry create コマンドを実行して、VECS のソリューション ユーザー証明書エントリを更新します。vecs-cli コマンド リファレンスを参照してください。

オプション	説明
--name <name>	更新するソリューション ユーザーの名前。
--cert <cert_file>	サービスに割り当てる証明書の名前。
--login <admin_user_id>	デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は [email protected] です。
--password <admin_password>	管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli user create

vmdir 内に一般ユーザーを作成します。このコマンドは、ユーザー名とパスワードを使用して vCenter Single Sign-On の認証を受けるユーザー（人）に使用できます。このコマンドは、プロトタイピング時にのみ使用します。

オプション	説明
--account <name>	作成する vCenter Single Sign-On ユーザーの名前。
--user-password <password>	ユーザーの初期パスワード。
--first-name <name>	ユーザーの名。
--last-name <name>	ユーザーの姓。
--login <admin_user_id>	デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は [email protected] です。
--password <admin_password>	管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli user modify

vmdir 内の指定したユーザーを変更します。

オプション	説明
--account <name>	変更する vCenter Single Sign-On ユーザーの名前。
--password-never-expires	vCenter Server の認証を受ける必要のある自動化タスクにユーザー アカウントを変更し、パスワードの有効期限切れによってタスクの実行を停止しないようにするには、このオプションを True に設定します。 このオプションは慎重に使用してくだい。
--password-expires	--password-never-expiresオプションを元に戻すには、このオプションを True に設定します。
--login <admin_user_id>	デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は [email protected] です。
--password <admin_password>	管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli user delete

vmdir 内の指定したユーザーを削除します。

オプション	説明
--account <name>	削除する vCenter Single Sign-On ユーザーの名前。
--login <admin_user_id>	デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は [email protected] です。
--password <admin_password>	管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli user find-by-name

vmdir 内のユーザーを名前で検索します。このコマンドが返す情報は、--levelオプションでの指定によって異なります。

オプション	説明
--account <name>	検索する vCenter Single Sign-On ユーザーの名前。
--level <info level 0|1|2>	次の情報を返します。 レベル 0 - アカウントと UPN レベル 1 - レベル 0 の情報と姓名 レベル 2 - レベル 0 とアカウント無効のフラグ、アカウント ロックのフラグ、パスワード無期限のフラグ、パスワード期限切れのフラグ、およびパスワード有効期限のフラグ。 デフォルト レベルは 0 です。
--login <admin_user_id>	デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は [email protected] です。
--password <admin_password>	管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli group modify

既存のグループにユーザーまたはグループを追加します。

オプション	説明
--name <name>	vmdir のグループの名前。
--add <user_or_group_name>	追加するユーザーまたはグループの名前。
--login <admin_user_id>	デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は [email protected] です。
--password <admin_password>	管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli group list

指定した vmdir グループをリストします。

オプション	説明
--name <name>	vmdir のグループのオプション名。このオプションによって、特定のグループが存在するかどうかを確認することができます。
--login <admin_user_id>	デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は [email protected] です。
--password <admin_password>	管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli ssogroup create

ローカル ドメイン（デフォルトでは vsphere.local）内にグループを作成します。

グループを作成して vCenter Single Sign-On ドメインのユーザー権限を管理するには、このコマンドを使用します。たとえば、グループを作成し、そのグループを vCenter Single Sign-On ドメインの管理者グループに追加する場合、そのグループに追加されるすべてのユーザーはドメインに対する管理者権限を与えられます。

また、vCenter Single Sign-On ドメインのグループに対して、vCenter Server のインベントリ オブジェクトへのアクセス権限を付与することもできます。『vSphere のセキュリティ』ドキュメントを参照してください。

オプション	説明
--name <name>	vmdir のグループの名前。最大文字数は 487 文字です。
--description <description>	グループの説明（オプション）。
--login <admin_user_id>	デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は [email protected] です。
--password <admin_password>	管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli trustedcert publish

信頼済みルート証明書を vmdir に発行します。このコマンドを実行すると、1 分後に VECS によって証明書の変更が取得されます。または、vecs-cli force-refresh コマンドを実行して証明書をすぐに同期することもできます。

注： vSphere 8.0 Update 3 以降では、 vSphere Client または API のいずれかを使用して信頼できるルート証明書を公開し、サービスの再起動を不要にします。

オプション	説明
--cert <file>	証明書ファイルへのパス。
--crl <file>	このオプションは VMware 認証局 (VMCA) ではサポートされません。
--login <admin_user_id>	デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は [email protected] です。
--password <admin_password>	管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。
--chain	チェーン証明書を公開している場合は、このオプションを指定します。オプションの値は必要ありません。

dir-cli trustedcert unpublish

現在 vmdir にある信頼済みルート証明書を発行解除します。たとえば、現在の使用環境の他のすべての証明書のルート証明書となっている別のルート証明書を vmdir に追加した場合、このコマンドを使用します。使用されなくなった証明書の発行解除は、使用環境の堅牢化に寄与します。

注： vSphere 8.0 Update 3 以降では、 vSphere Client または API のいずれかを使用して信頼できるルート証明書を非公開にし、サービスの再起動を不要にします。

オプション	説明
--cert-file <file>	発行解除する証明書ファイルへのパス。
--login <admin_user_id>	デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は [email protected] です。
--password <admin_password>	管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli trustedcert list

すべての信頼済みルート証明書と対応する ID をリストします。dir-cli trustedcert get を使用して証明書を取得するには、証明書 ID が必要です。

オプション	説明
--login <admin_user_id>	デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は [email protected] です。
--password <admin_password>	管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli trustedcert get

vmdir から信頼済みルート証明書を取得し、指定したファイルに書き込みます。

オプション	説明
--id <cert_ID>	取得する証明書の ID。 dir-cli trustedcert list コマンドは ID を示します。
--outcert <path>	証明書ファイルの書き込み先のパス。
--outcrl <path>	CRL ファイルの書き込み先のパス。現在使用されていません。
--login <admin_user_id>	デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は [email protected] です。
--password <admin_password>	管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli password create

パスワード要件を満たす、ランダムなパスワードを作成します。このコマンドは、サードパーティ製ソリューション ユーザーが使用できます。

オプション	説明
--login <admin_user_id>	デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は [email protected] です。
--password <admin_password>	管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli password reset

管理者がユーザーのパスワードをリセットできるようにします。管理者以外のユーザーがパスワードをリセットするには、代わりに dir-cli password change を使用します。

オプション	説明
--account	新しいパスワードを割り当てるアカウントの名前。
--new	指定されたユーザーの新しいパスワード。
--login <admin_user_id>	デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は [email protected] です。
--password <admin_password>	管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli password change

ユーザーがパスワードを変更できるようにします。この変更を行うアカウントを所有するユーザーである必要があります。管理者は dir-cli password reset を使用して、パスワードをリセットできます。

オプション	説明
--account	アカウント名。
--current	アカウントを所有するユーザーの現在のパスワード。
--new	アカウントを所有するユーザーの新しいパスワード。