System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Test-SCDomainCredential コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Test-SCDomainCredential」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Test-SCDomainCredential コマンドレット
名前
Test-SCDomainCredential
概要
ドメインで認証されているかどうかを確認するために、資格情報もしくはユーザー名をテストします。
構文
| Test-SCDomainCredential [-Credential] <VMMCredential> [-VMMServer <ServerConnection>] [<CommonParameters>] Test-SCDomainCredential |
説明
Test-SCDomainCredential コマンドレットは、ドメインで認証されているかどうかを確認するために、資格情報オブジェクトもしくはユーザー名をテストします。
パラメーター
-Credential <VMMCredential>
資格情報オブジェクトもしくは一部のコマンドレットで、この操作を実行するアクセス許可を持つアカウントのユーザー名とパスワードを含む Run As アカウント オブジェクトを指定します。もしくは、Restart-SCJob の場合、再起動したタスクを完了するためのアクセス許可が必要となります。
PSCredential オブジェクトに関する詳細な情報は、Get-Help Get-Credential を実行します。
Run As アカウントに関する詳細な情報は、Get-Help New-SCRunAsAccount を実行します。
| 必須 | true |
|---|---|
| 位置 | 0 |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-UserName <String>
ユーザー名を指定します。フォーマット “ドメイン\ユーザー” のようにユーザー名を入力します。
| 必須 | true |
|---|---|
| 位置 | 0 |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-VMMServer <ServerConnection>
VMM サーバー オブジェクトを取得します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。
入力
出力
- Boolean
- このコマンドレットは、Boolean の結果を返します。
メモ
例
例 1 : 資格情報オブジェクトの有効性をテストする
コマンド
Creds = Get-Credential est-SCDomainCredential -Credential $Creds
コマンドの説明
最初のコマンドは、ユーザー名およびパスワードの入力を求め、PSCredential オブジェクトを作成、そのオブジェクトを $Creds 変数に格納します。
2 番目のコマンドは、$Creds の資格情報オブジェクトを検証し、True もしくは False を返します。
例 2 : ユーザー名の妥当性をテストする
コマンド
Test-SCDomainCredential -UserName "PattiFuller"
コマンドの説明
このコマンドは、ユーザー名 “PattiFuller” の有効性をテストし、True もしくは False を返します。
関連するリンク
参考
- System Center 2016 – データセンターの管理 | Microsoft
https://www.microsoft.com/ja-jp/cloud-platform/system-center - VirtualMachineManager | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/?view=systemcenter-ps-2016 - Test-SCDomainCredential (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/test-scdomaincredential?view=systemcenter-ps-2016