SCVMM 2016 UR5 で利用可能なコマンドレット (Get-SCSSHKey) について

スポンサーリンク

System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。

ここでは Get-SCSSHKey コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Get-SCSSHKey」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。

Get-SCSSHKey コマンドレット

名前

Get-SCSSHKey

概要

VMM ライブラリから Linux Administrator SSHKey オブジェクトを取得します。

構文

Get-SCSSHKey
 [-All]
 [-VMMServer <ServerConnection>]
 [<CommonParameters>]

Get-SCSSHKey
 -FamilyName <String>
 [-Release <String>]
 [-VMMServer <ServerConnection>]
 [<CommonParameters>]

Get-SCSSHKey
 [-ID <Guid>]
 [-VMMServer <ServerConnection>]
 [<CommonParameters>]

Get-SCSSHKey
 -Name <String>
 [-VMMServer <ServerConnection>]
 [<CommonParameters>]

説明

Get-SCSSHKey コマンドレットは、Virtual Machine Manager (VMM) ライブラリから Linux Administrator SSHKey オブジェクト情報を取得します。

パラメーター

-All [<SwitchParameter>]

このコマンドレットが親オブジェクトから独立したすべての従属オブジェクトを取得する場合に指定します。例えば、コマンド Get-SCVirtualDiskDrive -All は、各仮想ディスク ドライブ オブジェクトが関連付けられている仮想マシン オブジェクト、もしくはテンプレート オブジェクトに関係なく、すべての仮想ディスク ドライブ オブジェクトを取得します。

必須false
位置named
既定値False
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-FamilyName <String>

VMM ライブラリ内の物理リソースに対するファミリ名を指定します。

必須true
位置named
既定値None
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-ID <Guid>

このコマンドレットが取得する SSHKey の一意の ID を指定します。

必須false
位置named
既定値None
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-Name <String>

このコマンドレットが取得する SSHKey オブジェクト名を指定します。

必須true
位置named
既定値None
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-Release <String>

ライブラリ リソースのリリースを表す文字列を指定します。VMM は、ライブラリにインポートされたすべてのリソースのリリース値を自動的に作成します。リソースをインポートした後、文字列をカスタマイズすることが可能です。

必須false
位置named
既定値None
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-VMMServer <ServerConnection>

VMM サーバー オブジェクトを取得します。

必須false
位置named
既定値None
パイプライン入力を許可するTrue (ByValue)
ワイルドカード文字を許可するfalse

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。

入力

出力

  • LinuxAdministratorSshKey
    • このコマンドレットは、LinuxAdministratorSshKey オブジェクトを返します。

メモ

例 1 : VMM ライブラリ内のすべての SSHKey オブジェクト情報を取得する

コマンド
$SSHKey = Get-SCSSHKey -All
コマンドの説明

このコマンドは、VMM ライブラリ内のすべての SSHKey オブジェクトを取得し、それぞれに関する情報を表示します。

例 2 : Name による SSHKey 情報を取得する

コマンド
$SSHKey = Get-SCSSHKey -Name "My.sshkey"
$SSHKey
コマンドの説明

最初のコマンドは、”My.sshkey” SSHKey オブジェクトを取得し、そのオブジェクトを $SSHKey 変数に格納します。

2 番目のコマンドは、$SSHKey に格納された SSHKey オブジェクトに関する情報を表示します。

例 3 : プロパティを共有するすべての SSHKey オブジェクト情報を取得する

コマンド
Get-SCSSHKey -FamilyName "Family01"
コマンドの説明

このコマンドは、FamilyName 値 “Family01” を持つ VMM ライブラリからすべての SSHKey オブジェクトを取得し、各 SSHKey に関する情報を表示します。

関連するリンク

  • Remove-SCSSHKey
  • Set-SCSSHKey

参考