Udostępnij za pośrednictwem

Set-SCSSHKey

Module:
VirtualMachineManager Module

Updates the properties of a Linux SSHKey.

Syntax

Default 

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

EquivalencySet 

Set-SCSSHKey
    [-SSHKeys] <System.Collections.Generic.List`1[Microsoft.SystemCenter.VirtualMachineManager.SSHKey]>
    -FamilyName <String>
    -Release <String>
    [-VMMServer <ServerConnection>]
    [-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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Default
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Enabled

Indicates whether to enable or disable the SSHKey object. Specify $True to enable the SSHKey or $False to disable it.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Default
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FamilyName

Specifies a family name for a physical resource in the VMM library.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Default
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-JobVariable

Specifies a variable in which job progress is tracked and stored.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of a VMM SSHKey object.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Default
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Owner

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Default
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Default
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RunAsynchronously

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SharePath

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Default
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SSHKey

Specifies a Linux Administrator SSHKey object.

Parameter properties

Type:SSHKey
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Default
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-SSHKeys

Specifies a list of Linux Administrator SSHKey objects.

Parameter properties

Type:

System.Collections.Generic.List`1[Microsoft.SystemCenter.VirtualMachineManager.SSHKey]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EquivalencySet
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-UserRole

Specifies a user role object.

Parameter properties

Type:UserRole
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Default
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VMMServer

Specifies a VMM server object.

Parameter properties

Type:ServerConnection
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

LinuxAdministratorSshKey

This cmdlet returns a LinuxAdministratorSshKey object.