Export (0) Print
Expand All

Set-OdbcDriver

Windows Server 2012 R2 and Windows 8.1

Updated: June 5, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Set-OdbcDriver

Configures the properties for installed ODBC drivers.

Syntax

Parameter Set: InputObject
Set-OdbcDriver [-InputObject] <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-RemovePropertyValue <String[]> ] [-SetPropertyValue <String[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Name
Set-OdbcDriver [-Name] <String> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-Platform <String> ] [-RemovePropertyValue <String[]> ] [-SetPropertyValue <String[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-OdbcDriver cmdlet configures the properties for installed Open Database Connectivity (ODBC) drivers. Specify properties to add or modify by using the SetPropertyValue parameter. Specify properties to remove by using the RemovePropertyValue parameter.

Use the driver installation program to install and uninstall a driver. You cannot install or uninstall a driver by using Windows PowerShell® cmdlets.

For more information about ODBC and drivers, see Microsoft Open Database Connectivity (ODBC) (http://msdn.microsoft.com/en-us/library/ms710252.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 modifies the ODBC drivers that the specified ODBC driver objects represent. Specify a variable that contains the objects, or type a command or expression that gets the objects.


Aliases

Driver

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of a driver. You can use wildcard characters to specify more than one driver. This cmdlet modifies one or more ODBC drivers that this parameter specifies.


Aliases

DriverName

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Platform<String>

Specifies the platform architecture. This cmdlet modifies an ODBC driver that belongs 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

-SetPropertyValue<String[]>

Specifies an array of property values. This cmdlet modifies or adds the values that this parameter specifies on an ODBC driver. Specify an array of strings in the form <key>=<value>.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RemovePropertyValue<String[]>

Specifies an array of property values to remove. This cmdlet removes the property values that this parameter specifies from the ODBC driver. Specify an array of keys to be removed.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PassThru

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

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

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.

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_OdbcDriver[]

Examples

Example 1: Assign a value for a 32-bit driver by using a name

This command assigns the key CPTimeout a value of 60 for the 32-bit driver named SQL Server Native Client 10.0.


PS C:\> Set-OdbcDriver -Name "SQL Server Native Client 10.0" -Platform "32-bit" -SetPropertyValue "CPTimeout=60"

Example 2: Remove a property for any driver that starts with a string for the native platform

This command removes the property named aaa for all drivers with a name that starts with SQL Server under the native platform.


PS C:\> Set-OdbcDriver -Name "SQL Server*" -RemovePropertyValue "aaa"

Example 3: Change and remove properties for a driver

This command operates on any driver named SQL Server Native Client 10.0 under both 32-bit and 64-bit architectures. The command removes the properties aaa1 and aaa2. It also sets the property aaa3 to bbb3 and the property aaa4 to bbb4.


PS C:\> Set-OdbcDriver -Name "SQL Server Native Client 10.0" -Platform "All" -RemovePropertyValue @("aaa1", "aaa2") -SetPropertyValue @("aaa3=bbb3", "aaa4=bbb4")

Example 4: Assign a value for a 32-bit driver by using a name and store the result

This command assigns the key aaa a value of bbb for the 32-bit driver named SQL Server Native Client 10.0, and then stores the driver object in the $driver variable.


PS C:\> $driver = Set-OdbcDriver -Name "SQL Server Native Client 10.0" -Platform "32-bit" -SetPropertyValue "aaa=bbb" -PassThru

Example 5: Change and remove properties for a driver by using the pipeline operator

This command operates on any driver named SQL Server Native Client 10.0 under both 32-bit and 64-bit architectures. This command removes the properties aaa1 and aaa2. It also sets the property aaa3 to bbb3 and the property aaa4 to bbb4.


PS C:\> Get-OdbcDriver "SQL Server Native Client 10.0" -Platform "All" | Set-OdbcDriver -RemovePropertyValue @("aaa1", "aaa2") -SetPropertyValue @("aaa3=bbb3", "aaa4=bbb4")

Example 6: Change and remove properties for a driver by using a variable

This command uses the Get-OdbcDriver cmdlet to get any driver named SQL Server Native Client 10.0 under both 32-bit and 64-bit architectures, and then stores them in the $driverArray variable. The second command removes the properties aaa1 and aaa2. It also sets the property aaa3 to bbb3 and the property aaa4 to bbb4.


PS C:\> $driverArray = Get-OdbcDriver "SQL Server Native Client 10.0" -Platform "All"
PS C:\> Set-OdbcDriver -InputObject $driverArray -RemovePropertyValue @("aaa1", "aaa2") -SetPropertyValue @("aaa3=bbb3", "aaa4=bbb4")

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft