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

dir-cli nodes list

指定された Platform Services Controller インスタンスのすべての vCenter Server システムをリストします。

オプション

説明

--login <admin_user_id>

デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は administrator@vsphere.local です。

--password <admin_password>

管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

--server <psc_ip_or_fqdn>

アフィニティ化された Platform Services Controller を対象にしない場合は、このオプションを使用します。Platform Services Controller の IP アドレスまたは完全修飾ドメイン名 (FQDN) を指定します。

dir-cli domain-functional-level get

指定された Platform Services Controller のドメイン機能レベルを検索します。

オプション

説明

--login <admin_user_id>

デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は administrator@vsphere.local です。

--password <admin_password>

管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

--server <psc_ip_or_fqdn>

アフィニティ化された Platform Services Controller を対象にしない場合は、このオプションを使用します。Platform Services Controller の IP アドレスまたは完全修飾ドメイン名 (FQDN) を指定します。

--domain-name <domain_name>

Platform Services Controller が実行されているドメインのオプション名。

dir-cli domain-functional-level set

指定された Platform Services Controller のドメイン機能レベルを明示的に設定します。ドメイン機能レベルは、インストールの一部として自動的に設定されます。環境をアップグレードしている場合は、このコマンドを実行してレベルを 2 に設定します。すべてのノードが vSphere 6.5 にアップグレードされた後、Platform Services Controller インスタンスの 1 つに対してコマンドを実行します。

注:

Platform Services Controller 6.0 以前のインスタンスのドメイン機能レベルを 2 に変更することはできません。

オプション

説明

--level <level>

Platform Services Controller のレベル。

たとえば Platform Services Controller の高可用性を使用する場合は、アップグレード後に 2 を使用してレベルを明示的に設定します。

--login <admin_user_id>

デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は administrator@vsphere.local です。

--password <admin_password>

管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

--server <psc_ip_or_fqdn>

アフィニティ化された Platform Services Controller を対象にしない場合は、このオプションを使用します。Platform Services Controller の IP アドレスまたは完全修飾ドメイン名 (FQDN) を指定します。

--domain-name <domain_name>

Platform Services Controller が実行されているドメインのオプション名。

dir-cli list-domain-versions

現在のドメイン、または --domain-name <domain_name> によって指定されたドメインの各 Platform Services Controller のドメイン機能レベルをリストします。また、そのドメインで可能な最も高いドメイン機能レベルをリストします。

dir-cli domain-functional-level set を実行する前にこのコマンドを実行し、DFL を変更可能であることを確認します。

オプション

説明

--level <level>

Platform Services Controller のレベル。アップグレード後に 2 を使用してレベルを明示的に設定します。たとえば外部の Platform Services Controller を使用する場合は、1 を使用して環境を明示的にダウングレードします。

--login <admin_user_id>

デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は administrator@vsphere.local です。

--password <admin_password>

管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

--server <psc_ip_or_fqdn>

アフィニティ化された Platform Services Controller を対象にしない場合は、このオプションを使用します。Platform Services Controller の IP アドレスまたは完全修飾ドメイン名 (FQDN) を指定します。

--domain-name <domain_name>

Platform Services Controller が実行されているドメインのオプション名。

dir-cli computer password-reset

ドメインのマシン アカウントのパスワードをリセットすることができます。このオプションは、Platform Services Controller インスタンスをリストアする場合に役に立ちます。

オプション

説明

--login <admin_user_id>

デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は administrator@vsphere.local です。

--password <admin_password>

管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

--live-dc-hostname <server name>

Platform Services Controller インスタンスの現在の名前。

dir-cli service create

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

オプション

説明

--name <name>

作成するソリューション ユーザーの名前。

--cert <cert file>

証明書ファイルへのパス。これは、VMCA で署名された証明書またはサードパーティ証明書を指定できます。

--ssogroups <comma-separated-groupnames>

--wstrustrole <ActAsUser>

--ssoadminrole <Administrator/User>

--login <admin_user_id>

デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は administrator@vsphere.local です。

--password <admin_password>

管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli service list

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

オプション

説明

--login <admin_user_id>

デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は administrator@vsphere.local です。

--password <admin_password>

管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli service delete

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

オプション

説明

--name

削除するソリューション ユーザーの名前。

--login <admin_user_id>

デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は administrator@vsphere.local です。

--password <admin_password>

管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli service update

指定したソリューション ユーザー(つまり、サービスのコレクション)の証明書を更新します。このコマンドを実行すると、5 分後に VECS によって変更が取得されます。または、vecs-cli force-refresh を使用して強制的に更新することもできます。

オプション

説明

--name <name>

更新するソリューション ユーザーの名前。

--cert <cert_file>

サービスに割り当てる証明書の名前。

--login <admin_user_id>

デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は administrator@vsphere.local です。

--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 ドメインの管理者は administrator@vsphere.local です。

--password <admin_password>

管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli user modify

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

オプション

説明

--account <name>

削除する vCenter Single Sign-On ユーザーの名前。

--password-never-expires

Platform Services Controller の認証を受ける必要のある自動化タスクにユーザー アカウントを作成し、パスワードの有効期限切れによってタスクの実行を停止しないようにするには、このオプションを True に設定します。

このオプションは慎重に使用してくだい。

--password-expires

--password-never-expires オプションを元に戻すには、このオプションを True に設定します。

--login <admin_user_id>

デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は administrator@vsphere.local です。

--password <admin_password>

管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli user delete

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

オプション

説明

--account <name>

削除する vCenter Single Sign-On ユーザーの名前。

--login <admin_user_id>

デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は administrator@vsphere.local です。

--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 ドメインの管理者は administrator@vsphere.local です。

--password <admin_password>

管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli group modify

すでに存在するグループにユーザーまたはグループを追加します。

オプション

説明

--name <name>

vmdir のグループの名前。

--add <user_or_group_name>

追加するユーザーまたはグループの名前。

--login <admin_user_id>

デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は administrator@vsphere.local です。

--password <admin_password>

管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli group list

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

オプション

説明

--name <name>

vmdir のグループのオプション名。このオプションによって、特定のグループが存在するかどうかを確認することができます。

--login <admin_user_id>

デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は administrator@vsphere.local です。

--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 ドメインの管理者は administrator@vsphere.local です。

--password <admin_password>

管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli trustedcert publish

信頼済みルート証明書を vmdir に発行します。

オプション

説明

--cert <file>

証明書ファイルへのパス。

--crl <file>

このオプションは VMware 認証局 (VMCA) ではサポートされません。

--login <admin_user_id>

デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は administrator@vsphere.local です。

--password <admin_password>

管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

--chain

チェーン証明書を公開している場合は、このオプションを指定します。オプションの値は必要ありません。

dir-cli trustedcert publish

信頼済みルート証明書を vmdir に発行します。

オプション

説明

--cert <file>

証明書ファイルへのパス。

--crl <file>

このオプションは VMware 認証局 (VMCA) ではサポートされません。

--login <admin_user_id>

デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は administrator@vsphere.local です。

--password <admin_password>

管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

--chain

チェーン証明書を公開している場合は、このオプションを指定します。オプションの値は必要ありません。

dir-cli trustedcert unpublish

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

オプション

説明

--cert-file <file>

発行解除する証明書ファイルへのパス。

--login <admin_user_id>

デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は administrator@vsphere.local です。

--password <admin_password>

管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli trustedcert list

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

オプション

説明

--login <admin_user_id>

デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は administrator@vsphere.local です。

--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 ドメインの管理者は administrator@vsphere.local です。

--password <admin_password>

管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli password create

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

オプション

説明

--login <admin_user_id>

デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は administrator@vsphere.local です。

--password <admin_password>

管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli password reset

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

オプション

説明

--account

新しいパスワードを割り当てるアカウントの名前。

--new

指定されたユーザーの新しいパスワード。

--login <admin_user_id>

デフォルトでは、ローカル vCenter Single Sign-On ドメインの管理者は administrator@vsphere.local です。

--password <admin_password>

管理者ユーザーのパスワード。パスワードを指定していない場合、入力を求められます。

dir-cli password change

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

オプション

説明

--account

アカウント名。

--current

アカウントを所有するユーザーの現在のパスワード。

--new

アカウントを所有するユーザーの新しいパスワード。