Get-SCSSHKey
Gets Linux Administrator SSHKey objects from the VMM library.
Syntax
All (Default)
Get-SCSSHKey
[-VMMServer <ServerConnection>]
[-All]
[<CommonParameters>]
NameParamSet
Get-SCSSHKey
-Name <String>
[-VMMServer <ServerConnection>]
[<CommonParameters>]
EquivalentResourceParamSet
Get-SCSSHKey
-FamilyName <String>
[-VMMServer <ServerConnection>]
[-Release <String>]
[<CommonParameters>]
ID
Get-SCSSHKey
[-VMMServer <ServerConnection>]
[-ID <Guid>]
[<CommonParameters>]
Description
The Get-SCSSHKey cmdlet gets Linux Administrator SSHKey objects from the Virtual Machine Manager (VMM) library.
Examples
Example 1: Get all SSHKey objects in the VMM library
PS C:\> $SSHKey = Get-SCSSHKey -All
This command gets all SSHKey objects in the VMM library and displays information about each to the user.
Example 2: Get an SSHKey by its name
PS C:\> $SSHKey = Get-SCSSHKey -Name "My.sshkey"
PS C:\> $SSHKey
The first command gets the SSHKey object named My.sshkey, and then stores that object in the $SSHKey variable.
The second command displays information about the SSHKey object stored in $SSHKey.
Example 3: Get all SSHKey objects that share a property
PS C:\> Get-SCSSHKey -FamilyName "Family01"
This command gets all SSHKey objects from the VMM library with the FamilyName value of Family01, and displays information about each SSHKey.
Parameters
-All
Indicates that this cmdlet gets all subordinate objects independent of the parent object.
For example, the command Get-SCVirtualDiskDrive -All gets all virtual disk drive objects regardless of the virtual machine object or template object that each virtual disk drive object is associated with.
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 |
-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
EquivalentResourceParamSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ID
Specifies the unique ID of an SSHKey that this cmdlet gets.
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ID
| 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 an SSHKey object that this cmdlet gets.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
NameParamSet
| Position: | Named |
| Mandatory: | True |
| 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
EquivalentResourceParamSet
| 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.