Get-PASVRMServiceConfigParameter
Get-PASVRMServiceConfigParameter
SYNOPSIS
Gets a specific DR configuration parameter value
SYNTAX
Get-PASVRMServiceConfigParameter [[-BaseURI] <String>] [-parameterName] <String> [-serviceName] <String>
[-serverAddress] <String> [[-serviceUserName] <String>] [-servicePassword] <SecureString> [<CommonParameters>]
DESCRIPTION
Retrieves the current value of a specific Disaster Recovery configuration parameter. Use this command to query individual DR configuration settings from the VRM service. Requires authentication with the PARAgent service credentials.
EXAMPLES
Example 1
$password = ConvertTo-SecureString -String 'P@ssw0rd' -AsPlainText -Force
Get-PASVRMServiceConfigParameter -parameterName 'ReplicationInterval' -serviceName DR -serverAddress dr-vault.company.com -servicePassword $password
Retrieves the value of the ReplicationInterval configuration parameter from the DR service
Example 2
$password = ConvertTo-SecureString -String 'P@ssw0rd' -AsPlainText -Force
Get-PASVRMServiceConfigParameter -parameterName EnableFailover -serviceName Vault -serverAddress vault.company.com -servicePassword $password
Retrieves the value of the EnableFailover configuration parameter from the Vault service
Example 3
$password = ConvertTo-SecureString -String 'P@ssw0rd' -AsPlainText -Force
[PSCustomObject]@{parameterName = 'FailoverMode'; serviceName = 'DR'; serverAddress = 'dr-vault.company.com'; servicePassword = $password} | Get-PASVRMServiceConfigParameter
Retrieves the FailoverMode configuration parameter value using pipeline input
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
-parameterName
The name of the configuration parameter to retrieve
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-serviceName
The name of the service to query. Supported services: Vault, DR
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
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: 4
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: 5
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: 6
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.
INPUTS
OUTPUTS
NOTES
RELATED LINKS
https://pspas.pspete.dev/commands/Get-PASVRMServiceConfigParameter