Remove-CMDeviceCollectionVariable

Removes a device collection variable.

Syntax

Remove-CMDeviceCollectionVariable
      -Collection <IResultObject>
      [-Confirm]
      [-DisableWildcardHandling]
      [-Force]
      [-ForceWildcardHandling]
      -VariableName <String>
      [-WhatIf]
      [<CommonParameters>]
Remove-CMDeviceCollectionVariable -CollectionId  [-Confirm] [-DisableWildcardHandling] [-Force]
 [-ForceWildcardHandling] -VariableName  [-WhatIf] []
Remove-CMDeviceCollectionVariable -CollectionName  [-Confirm] [-DisableWildcardHandling] [-Force]
 [-ForceWildcardHandling] -VariableName  [-WhatIf] []

Description

The Remove-CMDeviceCollectionVariable cmdlet removes a device collection variable.

Examples

Example 1: Remove a device collection variable

PS C:\> $Collection = Get-CMCollection -Name "Device" 
PS C:\> Remove-CMDeviceCollectionVariable -Collection $Collection -VariableName "testTS" -Force

The first command gets the device collection object named Device and stores the object in the $Collection variable.

The second command removes the device collection variable named testTS from the device collection stored in $Collection. Specifying the Force parameter indicates that the user is not prompted before the variable is removed.

Example 2: Remove a device collection variable by using the pipeline

PS C:\> Get-CMCollection -Name "Device" | Remove-CMDeviceCollectionVariable -VariableName "testTS" -Force

This command gets the device collection object named Device and uses the pipeline operator to pass the object to Remove-CMDeviceCollectionVariable, which removes the device collection variable named testTS from the device collection object. Specifying the Force parameter indicates that the user is not prompted before the variable is removed.

Required Parameters

-Collection

Specifies a device collection object. To obtain a collection object, use the Get-CMCollection cmdlet.

Type:IResultObject
Required:True
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-CollectionId

Specifies the ID of a device collection.

Type:String
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CollectionName

Specifies the name of a device collection.

Type:String
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VariableName

Specifies the name of a collection variable.

Type:String
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Required:False
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-DisableWildcardHandling

Indicates that wildcard handling is disabled.

Type:SwitchParameter
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ForceWildcardHandling

Indicates that wildcard handling is enabled.

Type:SwitchParameter
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Required:False
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False