Functions/Safes/Get-PVPasswordObject.ps1
|
Function Get-PVPasswordObject { <# .SYNOPSIS Retrieves a password object from the Vault .DESCRIPTION Exposes the PACLI Function: "RETRIEVEPASSWORDOBJECT" .PARAMETER vault The defined Vault name .PARAMETER user The Username of the authenticated User. .PARAMETER safe The name of the Safe that contains the password object(s) you are looking for. You can use a wildcard to specify a wider range of safenames. .PARAMETER folder The name of the folder that contains the password object(s) to be found. .PARAMETER file The name of the password object. .PARAMETER lockFile Whether or not to lock the password object. .PARAMETER evenIfLocked Whether or not the file will be retrieved if the password object is locked by another user. .PARAMETER requestUsageType The operation that the user will carry out. Possible options are: REQUEST_AND_USE – create and send a request if necessary, or use the confirmation if it has been granted to open the Safe/file/password. CHECK_DON’T_USE – check if a request has been sent or, if not, create one and send an error. If a request is not needed, carry out the action. USE_ONLY – if the request has been confirmed, or if a request is not needed, open the Safe/file/password. Note: In version 4.1, this parameter has no default value and is obsolete. However, it can still be used as long as the ‘userequest’, ‘sendrequest’ and ‘executerequest’ parameters are not specified. .PARAMETER requestAccessType Whether the request is for a single or multiple access. Possible options are: SINGLE – for a single access. MULTIPLE – for multiple accesses .PARAMETER usableFrom The proposed date from when the request will be valid. .PARAMETER usableTo The proposed date until when the request will be valid. .PARAMETER requestReason The reason for the request. .PARAMETER userRequest If a confirmed request exists, it will be used to open the Safe and retrieve the specified password object. .PARAMETER sendRequest If a request is required to retrieve the selected password object, it will be sent. .PARAMETER executeRequest If a confirmed request exists or a request is not needed, the specified password object will be retrieved. .PARAMETER internalName The name of a previous password version. .PARAMETER sessionID The ID number of the session. Use this parameter when working with multiple scripts simultaneously. The default is ‘0’. .EXAMPLE Get-PVPasswordObject -vault Lab -user administrator -safe Oracle -folder root ` -file Application-ORACLE-10.10.10.10-SYS -lockFile Retrieves the specified password from the Oracle safe .NOTES AUTHOR: Pete Maan #> [CmdLetBinding()] param( [Parameter( Mandatory = $True, ValueFromPipelineByPropertyName = $True)] [string]$vault, [Parameter( Mandatory = $True, ValueFromPipelineByPropertyName = $True)] [string]$user, [Parameter( Mandatory = $True, ValueFromPipelineByPropertyName = $True)] [Alias("Safename")] [string]$safe, [Parameter( Mandatory = $True, ValueFromPipelineByPropertyName = $True)] [string]$folder, [Parameter( Mandatory = $True, ValueFromPipelineByPropertyName = $True)] [Alias("Filename")] [string]$file, [Parameter( Mandatory = $False, ValueFromPipelineByPropertyName = $True)] [switch]$lockFile, [Parameter( Mandatory = $False, ValueFromPipelineByPropertyName = $True)] [switch]$evenIfLocked, [Parameter( Mandatory = $False, ValueFromPipelineByPropertyName = $True)] [ValidateSet("REQUEST_AND_USE", "CHECK_DON’T_USE", "USE_ONLY")] [string]$requestUsageType, [Parameter( Mandatory = $False, ValueFromPipelineByPropertyName = $True)] [ValidateSet("SINGLE", "MULTIPLE")] [string]$requestAccessType, [Parameter( Mandatory = $False, ValueFromPipelineByPropertyName = $True)] [string]$usableFrom, [Parameter( Mandatory = $False, ValueFromPipelineByPropertyName = $True)] [string]$usableTo, [Parameter( Mandatory = $False, ValueFromPipelineByPropertyName = $True)] [string]$requestReason, [Parameter( Mandatory = $False, ValueFromPipelineByPropertyName = $True)] [switch]$userRequest, [Parameter( Mandatory = $False, ValueFromPipelineByPropertyName = $True)] [switch]$sendRequest, [Parameter( Mandatory = $False, ValueFromPipelineByPropertyName = $True)] [switch]$executeRequest, [Parameter( Mandatory = $False, ValueFromPipelineByPropertyName = $True)] [string]$internalName, [Parameter( Mandatory = $False, ValueFromPipelineByPropertyName = $True)] [int]$sessionID ) PROCESS { $Return = Invoke-PACLICommand $Script:PV.ClientPath RETRIEVEPASSWORDOBJECT "$($PSBoundParameters.getEnumerator() | ConvertTo-ParameterString -donotQuote requestUsageType,requestAccessType) OUTPUT (ALL,ENCLOSE)" if($Return.ExitCode -eq 0) { #if result(s) returned if($Return.StdOut) { #Convert Output to array $Results = (($Return.StdOut | Select-String -Pattern "\S") | ConvertFrom-PacliOutput) #Output Object [PSCustomObject] @{ "Password" = $Results } | Add-ObjectDetail -TypeName pacli.PoShPACLI.Password -PropertyToAdd @{ "vault" = $vault "user" = $user "sessionID" = $sessionID } } } } } |