New-CMDeviceCollectionVariable

Creates a device collection variable.

Syntax

New-CMDeviceCollectionVariable
   -CollectionId <String>
   [-Confirm]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-IsMask <Boolean>]
   [-Value <String>]
   -VariableName <String>
   [-WhatIf]
   [<CommonParameters>]
New-CMDeviceCollectionVariable -CollectionName  [-Confirm] [-DisableWildcardHandling]
 [-ForceWildcardHandling] [-IsMask ] [-Value ] -VariableName  [-WhatIf]
 []
New-CMDeviceCollectionVariable [-Confirm] [-DisableWildcardHandling] [-ForceWildcardHandling]
 -InputObject  [-IsMask ] [-Value ] -VariableName  [-WhatIf]
 []

Description

The New-CMDeviceCollectionVariable cmdlet creates a device collection variable. You can use a device collection variable to define custom task sequence variables and their associated values to be used by the resources in a collection. Task sequence variables are a set of name and value pairs that provide a mechanism to configure and customize the steps of a task sequence when the task sequence is deployed to a specific collection.

Examples

Example 1: Create a device collection variable

PS C:\> $Collection = Get-CMCollection -Name "Device"
PS C:\> New-CMDeviceCollectionVariable -Collection $Collection -VariableName "testTS" -Value "test001"

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

The second command creates a collection variable named testTS with the value test001 for the collection object stored in $Collection.

Required Parameters

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

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

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

Specifies a name for the 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
-ForceWildcardHandling

Indicates that wildcard handling is enabled.

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

Indicates whether the collection variable value displays in the Configuration Manager console.

Type:Boolean
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Value

Specifies a value for the collection variable.

Type:String
Aliases:VariableValue
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