Set-SCSSHKey
Updates the properties of a Linux SSHKey.
Syntax
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>]Description
The Set-SCSSHKey cmdlet updates the properties of a Linux SSHKey object stored in the Virtual Machine Manager (VMM) Library.
Examples
Example 1: Change the description of an 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"The first command gets the SSHKey object named My.sshkey from the library on VMMServer01, and then stores that object in the $SSHKey variable.
The second command changes the description of the SSHKey stored in $SSHKey to "My standard SSHKey."
Example 2: Change a property for an SSHKey
PS C:\> $SSHKey = Get-SCSSHKey -Name "My.sshkey"
PS C:\> Set-SCSSHKey -SSHKey $SSHKey -FamilyName "Family01"The first command gets the SSHKey object named My.sshkey, and then stores that object in the $SSHKey variable.
The second command sets the FamilyName property to Family01 on the SSHKey object stored in $SSHKey.
Parameters
-Description
Specifies a description for the SSHKey object.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Enabled
Indicates whether to enable or disable the SSHKey object. Specify $True to enable the SSHKey or $False to disable it.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FamilyName
Specifies a family name for a physical resource in the VMM library.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobVariable
Specifies a variable in which job progress is tracked and stored.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name of a VMM SSHKey object.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Owner
Specifies the owner of the VMM SSHKey object in the form of a valid domain user account.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PROTipID
Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Release
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SharePath
Specifies a path to a valid library share on an existing library server that uses a Universal Naming Convention (UNC) path.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SSHKey
Specifies a Linux Administrator SSHKey object.
| Type: | SSHKey |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SSHKeys
Specifies a list of Linux Administrator SSHKey objects.
| 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
Specifies a user role object.
| Type: | UserRole |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VMMServer
Specifies a VMM server object.
| Type: | ServerConnection |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Outputs
LinuxAdministratorSshKey
This cmdlet returns a LinuxAdministratorSshKey object.