Set-SCSSHKey

Set-SCSSHKey

Updates the properties of a Linux SSHKey object stored in the VMM library.

構文

Parameter Set: Default
Set-SCSSHKey [-SSHKey] <SSHKey> [-Description <String> ] [-Enabled <Boolean> ] [-FamilyName <String> ] [-JobVariable <String> ] [-Name <String> ] [-Owner <String> ] [-PROTipID <Guid]> ] [-Release <String> ] [-RunAsynchronously] [-SharePath <String> ] [-UserRole <UserRole> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Parameter Set: EquivalencySet
Set-SCSSHKey [-SSHKeys] <0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]> -FamilyName <String> -Release <String> [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

詳細説明

The Set-SCSSHKey cmdlet updates the properties of a Linux SSHKey object stored in the Virtual Machine Manager (VMM) Library.

パラメーター

-Description<String>

States a description for the specified object.

-Enabled<Boolean>

Indicates whether to enable an object when set to $True, or disables an object when set to $False. For example, if you want to upgrade software on a virtual machine template, you can disable the template object in the VMM library to temporarily prevent users from using that object.

-FamilyName<String>

Specifies a family name for a physical resource in the VMM library. This value is used in conjunction with Release, Namespace, and Type to establish equivalency among library resources.

-JobVariable<String>

Specifies that job progress is tracked and stored in the variable named by this parameter.

-Name<String>

Specifies the name of a VMM object.

-Owner<String>

Specifies the owner of a VMM object in the form of a valid domain user account.

Example format: -Owner "Contoso\ReneeLo"

Example format: -Owner "ReneeLo@Contoso"

-PROTipID<Guid]>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

-Release<String>

Specifies a string that describes the release of a library resource. VMM automatically creates a release value for every resource imported into the library. After the resource has been imported, the string can be customized.

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

-SharePath<String>

Specifies a path to a valid library share on an existing library server that uses a Universal Naming Convention (UNC) path.

Example format: -SharePath "\\LibServer01\LibShare"

-SSHKey<SSHKey>

Specifies a Linux Administrator SSHKey object.

-SSHKeys<0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]>

Specifies a list of Linux Administrator SSHKey objects.

-UserRole<UserRole>

Specifies a user role object.

-VMMServer<ServerConnection>

Specifies a VMM server object.

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

• LinuxAdministratorSshKey

例

Example Example 1: Change the description of an SSHKey object.

The first command gets the SSHKey object named My.sshkey from the library on VMMServer01, and then stores the object in the $sshkey variable.

The second command changes the description of the SSHKey stored in $sshkey to My standard 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"

Example Example 2: Change the FamilyName property for an SSHKey object.

The first command gets the SSHKey object named My.sshkey, and then stores the object in the $SSHKey variable.

The second command sets the FamilyName property to Family01 on the SSHKey object stored in $SSHKey.

PS C:\> $SSHKey = Get-SCSSHKey -Name "My.sshkey"
PS C:\> Set-SCSSHKey -SSHKey $SSHKey -FamilyName "Family01"

関連トピック

Get-SCSSHKey

Remove-SCSSHKey