GET PRIVATE SSH KEY VALUE

USE THIS FUNCTION TO GET PRIVATE SSH KEY VALUE OF AN ACCOUNT IN CYBERARK

Get-VPASAccountPrivateSSHKey [-safe <String>] [-platform <String>] [-username <String>] [-address <String>] -reason <String> [-SaveToFile] [-HideOutput] [-token <Hashtable>] [<CommonParameters>]

Get-VPASAccountPrivateSSHKey -reason <String> -AcctID <String> [-SaveToFile] [-HideOutput] [-token <Hashtable>] [<CommonParameters>]

Get-VPASAccountPrivateSSHKey -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]

-safe <String>
Safe name that will be used to query for the target account if no AcctID is passed

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-platform <String>
PlatformID that will be used to query for the target account if no AcctID is passed

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-username <String>
Username that will be used to query for the target account if no AcctID is passed

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-address <String>
Address that will be used to query for the target account if no AcctID is passed

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-reason <String>
Define a reason for connecting for audit purposes

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-AcctID <String>
Unique ID that maps to a single account, passing this variable will skip any query functions

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-SaveToFile [<SwitchParameter>]
The key will be saved to a PEM file

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-HideOutput [<SwitchParameter>]
Suppress any output to the console

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-InputParameters <Hashtable>
HashTable of values containing the parameters required to make the API call

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-token <Hashtable>
HashTable of data containing various pieces of login information (PVWA, LoginToken, HeaderType, etc).
If -token is not passed, function will use last known hashtable generated by New-VPASToken

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug
ErrorAction, ErrorVariable, WarningAction, WarningVariable
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216)

$SSHKey = Get-VPASAccountPrivateSSHKey -reason {REASON VALUE} -safe {SAFE VALUE} -address {ADDRESS VALUE}

$InputParameters = @{
        safe = "TargetSafe"
        platform = "TargetPlatformID"
        username = "TargetUsername"
         address = "TargetAddress"
         reason = "Enter reason here"
         SaveToFile = $true|$false
         HideOutput = $true|$false
}
$SSHKey = Get-VPASAccountPrivateSSHKey -InputParameters $InputParameters

$InputParameters = @{
        AcctID = "22_123"
         reason = "Enter reason here"
         SaveToFile = $true|$false
         HideOutput = $true|$false
}
$SSHKey = Get-VPASAccountPrivateSSHKey -InputParameters $InputParameters

If successful:
"ASuperSecretKeyValue=="

$false if failed