Remove-OdbcDsn
Remove-OdbcDsn
Removes one or more existing DSNs from the system.
Syntax
Parameter Set: InputObject
Remove-OdbcDsn [-InputObject] <CimInstance> [-AsJob] [-CimSession <CimSession> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: Name
Remove-OdbcDsn [-Name] <String> -DsnType <String> [-AsJob] [-CimSession <CimSession> ] [-DriverName <String> ] [-PassThru] [-Platform <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
For more information about ODBC, data source names, and drivers, see Microsoft Open Database Connectivity (ODBC), Data Sources, and Drivers.
Parameters
-InputObject<CimInstance>
Removes the ODBC DSNs represented by the specified ODBC DSN objects. Enter a variable that contains the objects, or type a command or expression that gets the objects.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies one or more ODBC DSNs to remove. You can use wildcard characters.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
-DsnType<String>
The type of the ODBC DSN to remove. Possible values are 'User', 'System' or 'All'.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Platform<String>
The platform architecture of the ODBC DSN to remove. Possible values are '32-bit', '64-bit' or 'All'. The default is '32-bit' on a 32-bit process and '64-bit' on a 64-bit process. This is the platform architecture on the remote machine if this command is executed in a remote CIM session.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DriverName<String>
This cmdlet will remove the ODBC DSN using this driver only. You can use wildcard characters. The default is to remove all ODBC DSNs.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
-PassThru
Passes the object removed by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
Returns an object representing the removed ODBC DSN(s). By default, this cmdlet does not generate any output.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<CimSession>
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ThrottleLimit<Int32>
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Management.Infrastructure.CimInstance#MSFT_OdbcDsn[]
Examples
This command removes the 32-bit ODBC User DSN(s) with a name matches the wildcard "*Payroll*":
PS C:\> Remove-OdbcDsn -Name "*Payroll*" -DsnType User -Platform 32-bit
This command removes the ODBC System DSN with a name equal to "MyPayroll" from the native platform:
PS C:\> Remove-OdbcDsn "MyPayroll" -DsnType System
This command removes all 32-bit ODBC System DSN(s) that match the wildcard pattern "*Payroll*" and are using the driver with a name started with "SQL Server":
PS C:\> Remove-OdbcDsn -Name "*Payroll*" -DsnType System -Platform 32-bit -DriverName "SQL Server*"
This command removes the 32-bit ODBC User DSN(s) with a name that matches the wildcard "*Payroll*" and stores the deleted DSN object into a PowerShell variable:
PS C:\> $sysDsn = Remove-OdbcDsn "MyPayroll" -DsnType User -Platform 32-bit -PassThru
This command removes the ODBC System DSN on the native platform with name equal to "MyPayroll" and pipelines the object returned from the command Get-OdbcDsn:
PS C:\> Get-OdbcDsn -Name "MyPayroll" -DsnType System | Remove-OdbcDsn
This command removes the ODBC System DSN on the native platform with name equal to "MyPayroll" and uses the PowerShell variable $dsnArray:
PS C:\> $dsnArray = Get-OdbcDsn -Name "MyPayroll" -DsnType System
Remove-OdbcDsn $dsnArray
Related topics
N:Wdac