Set-SCSSHKey
Linux SSHKey のプロパティを更新します。
構文
Set-SCSSHKey
[-UserRole <UserRole>]
[-Enabled <Boolean>]
[-VMMServer <ServerConnection>]
[-SSHKey] <SSHKey>
[-Name <String>]
[-SharePath <String>]
[-Description <String>]
[-Owner <String>]
[-FamilyName <String>]
[-Release <String>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>]
Set-SCSSHKey
[-VMMServer <ServerConnection>]
[-SSHKeys] <System.Collections.Generic.List`1[Microsoft.SystemCenter.VirtualMachineManager.SSHKey]>
-FamilyName <String>
-Release <String>
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>]
説明
Set-SCSSHKey コマンドレットは、仮想マシン マネージャー (VMM) ライブラリに格納されている Linux SSHKey オブジェクトのプロパティを更新します。
例
例 1: SSHKey の説明を変更する
PS C:\> $SSHKey = Get-SCSSHKey -VMMServer "VMMServer01.Contoso.com" | where { $_.LibraryServer.Name -eq "LibraryServer01.Contoso.com" -and $_.Name -eq "My.sshkey" }
PS C:\> Set-SCSSSHKey -SSHKey $sshkey -Description "My standard SSHKey"
最初のコマンドは、VMMServer01 上のライブラリから My.sshkey という名前の SSHKey オブジェクトを取得し、そのオブジェクトを $SSHKey 変数に格納します。
2 番目のコマンドは、$SSHKeyに格納されている SSHKey の説明を "My standard SSHKey" に変更します。
例 2: SSHKey のプロパティを変更する
PS C:\> $SSHKey = Get-SCSSHKey -Name "My.sshkey"
PS C:\> Set-SCSSHKey -SSHKey $SSHKey -FamilyName "Family01"
最初のコマンドは、My.sshkey という名前の SSHKey オブジェクトを取得し、そのオブジェクトを $SSHKey 変数に格納します。
2 番目のコマンドは、$SSHKeyに格納されている SSHKey オブジェクトの Family01 に FamilyName プロパティを設定します。
パラメーター
-Description
SSHKey オブジェクトの説明を指定します。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Enabled
SSHKey オブジェクトを有効または無効にするかどうかを示します。 SSHKey を有効にする$Trueを指定するか、無効にする$Falseを指定します。
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-FamilyName
VMM ライブラリ内の物理リソースのファミリ名を指定します。
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-JobVariable
ジョブの進行状況を追跡して格納する変数を指定します。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
VMM SSHKey オブジェクトの名前を指定します。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Owner
有効なドメイン ユーザー アカウントの形式で VMM SSHKey オブジェクトの所有者を指定します。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PROTipID
このアクションをトリガーしたパフォーマンスとリソースの最適化のヒント (PRO ヒント) の ID を指定します。 このパラメーターを使用すると、PRO のヒントを監査できます。
Type: | Guid |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Release
ライブラリ リソースのリリースを記述する文字列を指定します。 VMM は、ライブラリにインポートされたすべてのリソースのリリース値を自動的に作成します。 リソースがインポートされたら、文字列をカスタマイズできます。
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RunAsynchronously
コントロールがコマンド シェルにすぐに戻るように、ジョブが非同期的に実行されることを示します。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SharePath
汎用名前付け規則 (UNC) パスを使用する既存のライブラリ サーバー上にある有効なライブラリ共有へのパスを指定します。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SSHKey
Linux Administrator SSHKey オブジェクトを指定します。
Type: | SSHKey |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SSHKeys
Linux Administrator SSHKey オブジェクトの一覧を指定します。
Type: | System.Collections.Generic.List`1[Microsoft.SystemCenter.VirtualMachineManager.SSHKey] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-UserRole
ユーザー ロール オブジェクトを指定します。
Type: | UserRole |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VMMServer
VMM サーバー オブジェクトを指定します。
Type: | ServerConnection |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
出力
LinuxAdministratorSshKey
このコマンドレットは、 LinuxAdministratorSshKey オブジェクトを 返します。