Edit

New-CMRequirementRuleFreeDiskSpaceValue

  • Reference
Module:
ConfigurationManager

Create a disk space requirement rule for an application deployment type.

Syntax

New-CMRequirementRuleFreeDiskSpaceValue
   [-DriverLetter <String>]
   -PartitionOption <PartitionType>
   -RuleOperator <RuleExpressionOperator>
   -Value1 <Int64[]>
   [-Value2 <Int64>]
   [-InputObject] <IResultObject>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Description

Use this cmdlet to create a disk space requirement rule for an application deployment type.

After you use this cmdlet, then use one of the Add- or Set- cmdlets for deployment types. Pass this requirement rule object to either the AddRequirement or RemoveRequirement parameters.

For more information, see Deployment type Requirements and Create global conditions.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Add a requirement rule for disk space

This example first uses the Get-CMGlobalCondition cmdlet to get the default Disk space global condition. It then creates the requirement rule object to check free space on the E: drive is between 5 MB and 10 MB. Finally it passes that rule object to the Set-CMScriptDeploymentType cmdlet to add the requirement.

$value1 = 5

$value2 = 10

$myGC = Get-CMGlobalCondition -Name "Disk space"

$myRule = $myGC | New-CMRequirementRuleFreeDiskSpaceValue -PartitionOption Special -RuleOperator Between -Value1 $value1 -Value2 $value2 -DriverLetter "E:"

Set-CMScriptDeploymentType -ApplicationName "Central App" -DeploymentTypeName "Install" -AddRequirement $myRule

Parameters

-DisableWildcardHandling

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

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

-DriverLetter

When you set the PartitionOption parameter to Special, use this parameter to specify the drive letter. For example, "C:".

Type:String
Position:Named
Default value:None
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specify a global condition object to use as the basis for this requirement rule. To get this object, use the Get-CMGlobalCondition cmdlet.

In most instances, you'll use the default Disk space global condition, for example: Get-CMGlobalCondition -Name "Disk space".

Type:IResultObject
Aliases:GlobalCondition
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PartitionOption

Specify the type of partition to evaluate with this requirement rule:

  • Any: Any drive on the device
  • System: The Windows system drive
  • Special: A specific drive. Use the DriverLetter parameter to specify the drive letter.
Type:PartitionType
Accepted values:Any, System, Special
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-RuleOperator

Specify the operator to compare the device's setting with the expected value.

Type:RuleExpressionOperator
Accepted values:IsEquals, NotEquals, GreaterThan, GreaterEquals, LessThan, LessEquals, Between
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Value1

Specify an integer or array of expected values to compare. This value is the amount of free space in megabytes (MB).

Type:Int64[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Value2

If you use a RuleOperator like Between, use this parameter to specify the upper value.

For example:

$myRule = New-CMRequirementRuleFreeDiskSpaceValue -InputObject $GC -PartitionOption System -RuleOperator Between -Value1 1024 -Value2 2048

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object