Remove-HpcDriver
Remove-HpcDriver
Removes one or more specified device drivers.
Syntax
Parameter Set: Name
Remove-HpcDriver [-Name] <String[]> [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: Driver
Remove-HpcDriver -Driver <HpcDriver[]> [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
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
-Driver<HpcDriver[]>
Specifies a list of one or more 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 |
no default |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies a list of one or more files 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 |
no default |
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 |
%CCP_SCHEDULER% |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before executing the command.
Required? |
false |
Position? |
named |
Default Value |
|
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
Required? |
false |
Position? |
named |
Default Value |
|
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.
- One or more HpcDriver objects.
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
Removes the device driver that has a setup information (.inf) file named MyDriver.inf.
PS C:\>Remove-HpcDriver -Name MyDriver.inf
EXAMPLE 2
Removes the device drivers that have setup information (.inf) files named Driver1.inf and Driver2.inf on the HPC cluster with a head node named Headnode.
PS C:\>Remove-HpcDriver -Name Driver1.inf,Driver2.inf -Scheduler Headnode
EXAMPLE 3
Gets the HpcDriver object for the device driver that has a setup information file named MyDriver.inf, then removes that device driver by redirecting that HpcDriver object to the Remove-HpcDriver cmdlet.
PS C:\>Get-HpcDriver -Name MyDriver.inf | Remove-HpcDriver