Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Remove-OdbcDsn

Remove-OdbcDsn

msft_odbcdsntask_v1.0.cdxml

Synopsis

Removes ODBC DSNs.

Syntax

Remove-OdbcDsn [-InputObject] [-AsJob] [-CimSession] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Remove-OdbcDsn [-Name] [-AsJob] [-CimSession] [-DriverName] [-PassThru] [-Platform] [-ThrottleLimit] [-DsnType] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Remove-OdbcDsn cmdlet removes Open Database Connectivity (ODBC) data source names (DSNs) from the computer.

For more information about ODBC, data source names, and drivers, see Microsoft Open Database Connectivity (ODBC) (http://msdn.microsoft.com/en-us/library/ms710252.aspx), Data Sources (http://msdn.microsoft.com/en-us/library/ms711688.aspx), and Drivers (http://msdn.microsoft.com/en-us/library/ms715383.aspx) on the Microsoft Developer Network.

Parameters

-InputObject <CimInstance[]>

Specifies an array of input objects. This cmdlet removes the ODBC DSNs that the specified ODBC DSN objects represent. Specify a variable that contains the objects, or type a command or expression that gets the objects.

Aliases

Dsn

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-Name <String>

Specifies the name of an ODBC DSNs. You can use wildcard characters to specify more than one name. This cmdlet removes the DSNs that the names specify.

Aliases

DsnName

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DsnType <String>

Specifies the type of an ODBC DSN. This cmdlet removes DSNs of the type that this parameter specifies. The acceptable values for this parameter are:  -- User -- System -- All

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Platform <String>

Specifies the platform architecture. This cmdlet removes the ODBC DSNs that belong to the architecture that this parameter specifies. The acceptable values for this parameter are:  -- 32-bit -- 64-bit -- All

The default value is 32-bit on a 32-bit process. The default value is 64-bit on a 64-bit process. If you run this cmdlet in a remote CIM session, this parameter refers to the platform architecture on the remote computer.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DriverName <String>

Specifies the name of a driver. This cmdlet removes the ODBC DSN that uses the driver that this parameter specifies. You can use wildcard characters. If you do not specify this parameter, this cmdlet removes DSNs for all drivers.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the item with which you are working. 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 <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

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

Session

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 <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

Microsoft.Management.Infrastructure.CimInstance#MSFT_OdbcDsn[]

Notes

None

Examples

Example 1: Remove 32-bit User DSNs that have names that contain a string

This command removes the 32-bit ODBC User DSNs that have names that contain Payroll.

PS C:\> Remove-OdbcDsn -Name "*Payroll*" -DsnType "User" -Platform "32-bit"

Example 2: Remove the System DSN named MyPayroll from the native platform

This command removes the ODBC System DSN named MyPayroll from the native platform.

PS C:\> Remove-OdbcDsn -Name "MyPayroll" -DsnType "System"

Example 3: Remove all 32-bit ODBC System DSNs by using wildcard characters

This command removes all 32-bit ODBC System DSNs that have names that contain the string *Payroll*, and use the driver with a name that starts with SQL Server.

PS C:\> Remove-OdbcDsn -Name "*Payroll*" -DsnType "System" -Platform "32-bit" -DriverName "SQL Server*"

Example 4: Remove a 32-bit ODBC User DSN by using a name

This command removes the 32-bit ODBC User DSNs named MyPayroll, and then stores the deleted DSN object in the $sysDsn variable.

PS C:\> $sysDsn = Remove-OdbcDsn -Name "MyPayroll" -DsnType "User" -Platform "32-bit" -PassThru

Example 5: Remove a System DSN on the native platform by using the pipeline operator

This command uses the Get-OdbcDsn to get the ODBC System DSN on the native platform named MyPayroll, and then passes it to the current cmdlet by using the pipeline operator. The example removes that DSN.

PS C:\> Get-OdbcDsn -Name "MyPayroll" -DsnType "System" | Remove-OdbcDsn

Example 6: Remove a ODBC System DSN on the native platform by using a variable

The first command uses Get-OdbcDsn to get the ODBC System DSN on the native platform named MyPayroll, and then stores it in the $dsnArray variable.

The second command removes the DSN stored in $dsnArray.

PS C:\> $dsnArray = Get-OdbcDsn -Name "MyPayroll" -DsnType "System"
PS C:\> Remove-OdbcDsn -InputObject $dsnArray 

Online Version
Add-OdbcDsn
Get-OdbcDsn
Set-OdbcDsn
N:Wdac