Get-PASServerWebService
Get-PASServerWebService
SYNOPSIS
Returns details of the Web Service
SYNTAX
Get-PASServerWebService [[-WebSession] <WebRequestSession>] [-BaseURI] <String> [[-PVWAAppName] <String>]
[-UseGen1API] [<CommonParameters>]
DESCRIPTION
Returns information on Server web service.
Returns the name of the Vault configured in the ServerDisplayName configuration parameter
EXAMPLES
EXAMPLE 1
Get-PASServerWebService
Displays CyberArk Web Service Information
EXAMPLE 2
Get-PASServerWebService -BaseURI https://cyberark.local
Returns web service details for the PVWA at “https://cyberark.local”, using the default “PasswordVault” virtual directory.
EXAMPLE 3
Get-PASServerWebService -BaseURI https://cyberark.local -PVWAAppName PVWA -UseGen1API
Returns web service details from the deprecated Gen1 API endpoint, using a virtual directory named “PVWA” instead of the default “PasswordVault”.
EXAMPLE 4
[PSCustomObject]@{BaseURI = 'https://cyberark.local'} | Get-PASServerWebService
Retrieves web service details for the PVWA by piping an object with a BaseURI property.
PARAMETERS
-WebSession
WebRequestSession object returned from New-PASSession
Type: WebRequestSession
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-BaseURI
PVWA Web Address
Do not include “/PasswordVault/”
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-PVWAAppName
The name of the CyberArk PVWA Virtual Directory.
Defaults to PasswordVault
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: PasswordVault
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-UseGen1API
Force use of Gen1 API for request.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: UseClassicAPI
Required: False
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.