Share via

Remove-SCSSHKey

  • Reference
Module:
VirtualMachineManager

Removes a Linux Administrator SSHkey object from VMM.

Syntax

Remove-SCSSHKey
      [-SSHKey] <SSHKey>
      [-Force]
      [-RunAsynchronously]
      [-PROTipID <Guid>]
      [-JobVariable <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-SCSSHKey cmdlet removes a Linux Administrator SSHKey object from Virtual Machine Manager (VMM).

Examples

Example 1: Remove an SSHKey

PS C:\> $SSHKey = Get-SCSSHKey -Name "My.sshkey"
PS C:\> Remove-SCSSHKey -SSHKey $SSHKey -Confirm

The first command gets the SSHKey object named My.sshkey from the VMM library, and then stores that object in the $SSHKey variable.

The second command removes the SSHKey object stored in $SSHKey from VMM, prompting you for confirmation before performing the action.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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

-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

-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

-SSHKey

Specifies a Linux Administrator SSHKey object.

Type:SSHKey
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False