Stop-PASVRMService
Stop-PASVRMService
SYNOPSIS
Stops a Vault or DR service
SYNTAX
Stop-PASVRMService [[-BaseURI] <String>] [-serviceName] <String> [-serverAddress] <String>
[[-serviceUserName] <String>] [-servicePassword] <SecureString> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Stops a specified VRM service (Vault or DR) on the target server. Use this command for maintenance, troubleshooting, or controlled shutdowns. Requires authentication with the PARAgent service credentials and supports WhatIf for testing.
EXAMPLES
Example 1
$password = ConvertTo-SecureString -String 'P@ssw0rd' -AsPlainText -Force
Stop-PASVRMService -serviceName Vault -serverAddress vault.company.com -servicePassword $password
Stops the Vault service on the specified server
Example 2
$password = ConvertTo-SecureString -String 'P@ssw0rd' -AsPlainText -Force
Stop-PASVRMService -serviceName DR -serverAddress dr-vault.company.com -servicePassword $password -Confirm:$false
Stops the DR service on the specified server without prompting for confirmation
Example 3
$password = ConvertTo-SecureString -String 'P@ssw0rd' -AsPlainText -Force
Stop-PASVRMService -serviceName ENE -serverAddress vault.company.com -servicePassword $password -WhatIf
Shows what would happen if the ENE service was stopped, without actually stopping it. This service requires CyberArk version 15.2 or higher
PARAMETERS
-BaseURI
The URL of the PVWA server. If not specified, uses the BaseURI from New-PASSession
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-serviceName
The name of the service to stop. Supported services: Vault, DR, ENE
The ENE service requires CyberArk version 15.2 or higher.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-serverAddress
The IP address or hostname of the Primary Vault or DR Vault server
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-serviceUserName
The PARAgent user name. Defaults to Administrator
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: Administrator
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-servicePassword
The PARAgent password as a SecureString
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: True
Position: 5
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
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.