Get-PASSafe
Get-PASSafe
SYNOPSIS
Returns safe details from the vault.
SYNTAX
Gen2 (Default)
Get-PASSafe [-search <String>] [-sort <String>] [-includeAccounts <Boolean>] [-extendedDetails <Boolean>]
[-TimeoutSec <Int32>] [<CommonParameters>]
Gen2-byName
Get-PASSafe [-includeAccounts <Boolean>] -SafeName <String> [-useCache <Boolean>] [-TimeoutSec <Int32>]
[<CommonParameters>]
Gen1-byName
Get-PASSafe -SafeName <String> [-UseGen1API] [-TimeoutSec <Int32>] [<CommonParameters>]
Gen1-byQuery
Get-PASSafe [-query <String>] [-TimeoutSec <Int32>] [<CommonParameters>]
Gen1-byAll
Get-PASSafe [-FindAll] [-UseGen1API] [-TimeoutSec <Int32>] [<CommonParameters>]
DESCRIPTION
Gets safe by SafeName, by search query string, or, by default will return all safes.
- Minimum required version for default operation using Gen2 API is 12.0.
- Minimum required version for operation using Gen2-byName ParameterSet is 12.2.
- For PAS versions earlier than 12.0, the Gen1 API parameters must be used.
- Gen1 API parameters are deprecated for versions higher than 12.3.
EXAMPLES
EXAMPLE 1
Get-PASSafe
Returns details of all safes.
Minimum required version 12.0.
EXAMPLE 2
Get-PASSafe -search SAFE1 -extendedDetails $false
Returns names of safes matching pattern “Safe1”
Minimum required version 12.1
EXAMPLE 3
Get-PASSafe -SafeName SAFE1
Returns details of “Safe1” using Gen2 API.
Minimum required version 12.2
EXAMPLE 4
Get-PASSafe -query SAFE1
Returns details of safes matching query “Safe1” using Gen1 API.
Deprecated from version 12.2
EXAMPLE 5
Get-PASSafe -FindAll -UseGen1API
Returns details of all safes using Gen1 API.
Deprecated from version 12.3
EXAMPLE 6
Get-PASSafe -SafeName SAFE1 -UseGen1API
Returns details of “Safe1” using Gen1 API.
Deprecated from version 12.3
PARAMETERS
-includeAccounts
Whether or not to return accounts for each Safe as part of the response.
Minimum required version 12.0 (Default Gen2 Operation)
Minimum required version 12.2 (Gen2-byName Operation)
Type: Boolean
Parameter Sets: Gen2, Gen2-byName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-search
Searches according to the Safe name.
Minimum required version 12.0
Type: String
Parameter Sets: Gen2
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-sort
Sorts according to the safeName property in ascending order (default) or descending order.
Minimum required version 12.0
Type: String
Parameter Sets: Gen2
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-extendedDetails
Whether or not to return all Safe details or only safeName as part of the response.
Minimum required version 12.1
Type: Boolean
Parameter Sets: Gen2
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-SafeName
The name of a specific safe to get details of.
Gen2 API operation requires minimum version 12.2
When using Gen1 API in versions earlier than 12.0, must be specified with the -UseGen1API parameter.
Gen1 operation deprecated from version 12.3
Type: String
Parameter Sets: Gen2-byName, Gen1-byName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-query
Query String for safe search in the vault using Gen1 API.
Should be specified for versions earlier than 12.0
Deprecated from version 12.3
Type: String
Parameter Sets: Gen1-byQuery
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FindAll
Specify to find all safes using Gen1 API.
Should be specified for versions earlier than 12.0
Deprecated from version 12.3
Type: SwitchParameter
Parameter Sets: Gen1-byAll
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-TimeoutSec
See Invoke-WebRequest
Specify a timeout value in seconds
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-useCache
Whether to retrieve from session or not.
Type: Boolean
Parameter Sets: Gen2-byName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-UseGen1API
Specify to force use of the Gen1 API
Type: SwitchParameter
Parameter Sets: Gen1-byName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Type: SwitchParameter
Parameter Sets: Gen1-byAll
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.