Share via

Get-SCSSHKey

  • Reference
Module:
VirtualMachineManager

Gets Linux Administrator SSHKey objects from the VMM library.

Syntax

Get-SCSSHKey
   [-VMMServer <ServerConnection>]
   [-All]
   [<CommonParameters>]
Get-SCSSHKey
   [-VMMServer <ServerConnection>]
   -Name <String>
   [<CommonParameters>]
Get-SCSSHKey
   [-VMMServer <ServerConnection>]
   [-Release <String>]
   -FamilyName <String>
   [<CommonParameters>]
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.

Type:SwitchParameter
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

-ID

Specifies the unique ID of an SSHKey that this cmdlet gets.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of an SSHKey object that this cmdlet gets.

Type:String
Position:Named
Default value:None
Required:True
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: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.