Get-MceRetentionInterval
SYNOPSIS
Gets a MCE retention policy interval.
SYNTAX
Get-MceRetentionInterval [-Unit] <MceRetentionIntervalUnit> [[-IntervalInDays] <Int32>] [<CommonParameters>]
DESCRIPTION
This cmdlet gets the MCE retention interval based on the specified retention interval unit and the number of days.
The cmdlet is designed to pipeline returned retention interval to other cmdlets.
EXAMPLES
EXAMPLE 1
Get-MceRetentionInterval -Unit Days -IntervalInDays 25
Gets a retention interval of 25 days.
EXAMPLE 2
Get-MceRetentionInterval -Unit Never
Gets a retention interval that will set the interval unit to never.
PARAMETERS
-Unit
The retention interval unit. Can be 'Days' and 'Never'
Possible values: Days, Never
Type: MceRetentionIntervalUnit
Parameter Sets: (All)
Aliases:
Accepted values: Days, Never
Required: True
Position: 0
Default value: Days
Accept pipeline input: False
Accept wildcard characters: False
-IntervalInDays
The number of days.
This value is optional, the retention interval unit can be specified as 'Never' in which case we don't need to specify the number of days.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
MindLink.Core.Mce.PowerShell.Model.MceRetentionInterval
An MCE retention interval.