Remove-QLRSqlRegServer
From PowerGUI Wiki
Removes registration of a SQL Server instance.
Contents |
Syntax
Remove-QLRSqlRegServer [-Name] <String[]> [-Group [<String[]>]] [-ConfigFile [<String>]] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-QLRSqlRegServer [-ConfigFile [<String>]] -InputObject <ServerWrapper[]> [-WhatIf] [-Confirm] [<CommonParameters>]
Detailed Description
The Remove-QLRSqlRegServer cmdlet removes a registered SQL Server from a configuration file.
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| Name | The name of a registered SQL Server instance. The name may contain wildcard characters. | true | false | |
| Group | The group where the SQL Server instance is registered. The group name may contain wildcard characters. | false | false | |
| ConfigFile | The configuration file name. The default configuration file is located at <%LocalAppData%>\Quest Software\Log Reader for SQL Server\QuestLogReader.config. You can read settings from another configuration file. | false | false | |
| WhatIf | Set this parameter to display a message describing what would happen if you executed the command. The registrations are not removed. | false | false | |
| Confirm | Set this parameter to prompt for confirmation before executing the command. | false | false | |
| InputObject | The SQL server instances that will be unregistered. | true | true (ByValue) |
Input Type
None
Return Values
None
Examples
EXAMPLE 1
Remove-QLRSqlRegServer * -Group MyGroup
This command removes all registered SQL server instances that are in the MyGroup group.
