Remove-HpcDriver

Remove-HpcDriver

Removes a device driver.

Syntax

Parameter Set: Name
Remove-HpcDriver [-Name] <String[]> [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Driver
Remove-HpcDriver -Driver <HpcDriver[]> [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Remove-HpcDriver cmdlet removes one or more specified device drivers. You specify the device drivers by using either HpcDriver objects or the names of the setup information (.inf) files for the device drivers. Do not include the paths for the .inf files.

Parameters

-ClusterConnectionString<String[]>

Specifies an array of cluster connection strings for the cluster to which you want to add the device drivers. The value format is host1,host2,host3. If you do not specify the ClusterConnectionString parameter, this cmdlet uses the connection string on the head node that the CCP_CONNECTIONSTRING environment variable specifies. To set this environment variable, run the following cmdlet: Set-Content Env: CCP_CONNECTIONSTRING <head_node_name>.

This parameter was introduced in HPC Pack 2016.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Driver<HpcDriver[]>

Specifies an array of HpcDriver objects for the device drivers that you want to remove. Use the Get-HpcDriver cmdlet to get the HpcDriver objects for the device drivers.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of file names for the setup information (.inf) files for the device drivers that you want to remove. You do not need to include paths for the .inf files. Use the Get-HpcDriver cmdlet to view the file names of the .inf files for the device drivers in the HPC cluster.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Scheduler<String[]>

Specifies the host name or IP address of the head node for the cluster that includes the device drivers. The value must be a valid computer name or IP address. If you do not specify the Scheduler parameter, this cmdlet uses the scheduler on the head node that the CCP_SCHEDULER environment variable specifies. To set this environment variable, run the following cmdlet:

Set-Content Env:CCP_SCHEDULER <head_node_name>


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: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • HpcDriver[]

Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

Notes

  • The built-in ConfirmImpact setting for this cmdlet is Medium. If this ConfirmImpact setting is equal to or higher than the value of the $ConfirmPreference variable for your environment, the cmdlet prompts for confirmation unless you specify –Confirm:$False. If this ConfirmImpact setting is lower than the value of the $ConfirmPreference variable for your environment, the cmdlet does not prompt for confirmation unless you specify –Confirm or -Confirm:$True.

  • You must be a cluster administrator to run this cmdlet successfully.

Examples

Example 1: Remove a device driver

This command removes the device driver that has a setup information (.inf) file named MyDriver.inf.


PS C:\> Remove-HpcDriver -Name "MyDriver.inf"

Example 2: Remove drivers in a head node

This command removes the device drivers that have setup information (.inf) files named Driver01.inf and Driver02.inf on the HPC cluster with a head node named Headnode.


PS C:\> Remove-HpcDriver -Name "Driver01.inf,Driver02.inf" -Scheduler "Headnode"

Example 3: Get a driver and remove it

This command gets the HpcDriver object for the device driver that has a setup information file named MyDriver.inf, and then removes that device driver by redirecting that HpcDriver object to the Remove-HpcDriver cmdlet.


PS C:\> Get-HpcDriver -Name "MyDriver.inf" | Remove-HpcDriver

Related topics

Community Additions

ADD
Show: