New-CMTSPartitionSetting

Create a task sequence partition object to use with the Format and Partition Disk step.

Syntax

New-CMTSPartitionSetting
   [-EnableDriveLetterAssignment <Boolean>]
   [-EnableQuickFormat <Boolean>]
   [-IsBootPartition <Boolean>]
   [-Name <String>]
   [-PartitionFileSystem <FileSystemType>]
   [-PartitionPrimary]
   [-Size <Int32>]
   [-SizeUnit <SizeUnitType>]
   [-Variable <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMTSPartitionSetting
   [-Name <String>]
   [-PartitionEfi]
   [-Size <Int32>]
   [-SizeUnit <SizeUnitType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMTSPartitionSetting
   [-Name <String>]
   [-PartitionExtended]
   [-Size <Int32>]
   [-SizeUnit <SizeUnitType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMTSPartitionSetting
   [-Name <String>]
   [-PartitionHidden]
   [-Size <Int32>]
   [-SizeUnit <SizeUnitType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMTSPartitionSetting
   [-Name <String>]
   [-PartitionLogical]
   [-Size <Int32>]
   [-SizeUnit <SizeUnitType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMTSPartitionSetting
   [-Name <String>]
   [-PartitionMsr]
   [-Size <Int32>]
   [-SizeUnit <SizeUnitType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMTSPartitionSetting
   [-Name <String>]
   [-PartitionRecovery]
   [-Size <Int32>]
   [-SizeUnit <SizeUnitType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

This cmdlet creates a task sequence partition object to use with the Format and Partition Disk step. Use this cmdlet to define the partition settings, and then use that object with the -PartitionSetting parameter of the New-CMTSStepPartitionDisk or Set-CMTSStepPartitionDisk cmdlets.

This cmdlet corresponds to the new Partition Properties window from the Format and Partition Disk step in the task sequence editor.

Examples

Example 1

{{ Add example description here }}

{{ Add example code here }}

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

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

Set this parameter to true to let Configuration Manager assign a drive letter to the partition.

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

Set this parameter to true to let Configuration Manager do a quick format of the partition.

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

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

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

Set this parameter to true to make this partition the boot partition.

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

Specify a name for the partition.

Type:String
Aliases:PartitionName, VolumeName
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PartitionEfi

Add this parameter to make the partition type EFI.

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

Add this parameter to make the partition type Extended.

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

Specify the file system to format the partition.

Type:FileSystemType
Accepted values:Ntfs, Fat32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PartitionHidden

Add this parameter to make the partition type Hidden.

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

Add this parameter to make the partition type Logical.

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

Add this parameter to make the partition type MSR.

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

Add this parameter to make the partition type Primary.

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

Add this parameter to make the partition type Recovery.

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

Specify an integer value for the size of the partition. Use this parameter with the -SizeUnit parameter. If -SizeUnit is Percent, then specify a number between 1-100 for this parameter. If -SizeUnit is MB or GB, specify a number for the specific partition size.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SizeUnit

Specify the unit type for the size. Use this parameter with the -Size parameter.

  • Percent: Use -Size to set the partition to a percentage of remaining free space on the disk.

  • MB or GB: Use -Size to set a specific size for the partition.

Type:SizeUnitType
Accepted values:MB, GB, Percent
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Variable

By default, Configuration Manager assigns the next available drive letter to this partition. To save this drive letter for future use, set a custom task sequence variable with this parameter.

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

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

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

Inputs

None

Outputs

IResultObject