Get-PASServer
Get-PASServer
SYNOPSIS
Returns details of the Web Service Server
SYNTAX
Gen2 (Default)
Get-PASServer [<CommonParameters>]
Gen1
Get-PASServer [-UseGen1API] [<CommonParameters>]
DESCRIPTION
Returns information on Server.
Returns the name of the Vault configured in the ServerDisplayName configuration parameter
Appears to need Vault administrator rights
By default, uses the Gen2 api/server endpoint, which works against both self-hosted and
Privilege Cloud/ISPSS shared-services implementations.
Specify -UseGen1API to use the legacy WebServices/PIMServices.svc/Server endpoint instead. This
is only applicable to self-hosted implementations.
EXAMPLES
EXAMPLE 1
Get-PASServer
Displays CyberArk Server information
EXAMPLE 2
Get-PASServer | Format-List -Property *
Displays all available properties returned for the connected Vault server.
EXAMPLE 3
if (Get-PASServer) { "Connection to CyberArk Server is active" }
Uses a call to Get-PASServer to confirm the current session can successfully reach the Vault server.
PARAMETERS
-UseGen1API
Use the legacy Gen1 WebServices/PIMServices.svc/Server endpoint instead of the Gen2 api/server endpoint.
Only applicable to self-hosted implementations.
Type: SwitchParameter
Parameter Sets: Gen1
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
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.