Get-SCSSHKey
Get-SCSSHKey
Gets Linux Administrator Ssh Key objects from the VMM library.
Syntax
Parameter Set: All
Get-SCSSHKey [-All] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: EquivalentResourceParamSet
Get-SCSSHKey -FamilyName <String> [-Release <String> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: ID
Get-SCSSHKey [-ID <Guid> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: NameParamSet
Get-SCSSHKey -Name <String> [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Get-SCSSHKey cmdlet gets Linix Administrator SSH Key ojects from the VMM library.
Parameters
-All
Retrieves a full list of all subordinate objects independent of the parent object. For example, the command Get-SCVirtualDiskDrive -All retrieves all virtual disk drive objects regardless of the virtual machine object or template object that each virtual disk drive object is associated with.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-FamilyName<String>
Specifies a family name for a physical resource in the VMM library.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ID<Guid>
Specifies the numerical identifier (as a globally unique identifier, or GUID) for a specific object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of a VMM object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMMServer<ServerConnection>
Specifies a VMM server object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- LinuxAdministratorSshKey
Examples
1: Get all SSHKey objects in the VMM library.
This command gets all SSHKey objects in the VMM library and displays information about each to the user.
PS C:\> $SSHKey = Get-SCSSHKey -All
2: Get an SSHKey by its name.
The first command gets the SSHKey object named My.sshkey and stores the object in the $SSHKey variable.
The second command displays information about the SSHKey object stored in $SSHKey to the user
PS C:\> $SSHKey = Get-SCSSHKey -Name "My.sshkey"
PS C:\> $SSHKey
3: Get all SSHKey objects with the same FamilyName value.
This command gets all SSHKey objects from the VMM library with the FamilyName value of Family01, and displays information about each SSH key to the user.
PS C:\> Get-SCSSHKey -FamilyName "Family01"