Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Clear-RemoteAccessInboxAccountingStore

Clear-RemoteAccessInboxAccountingStore

ps_remoteaccessinboxaccountingstore_v1.0.0.cdxml

Synopsis

Clears the inbox accounting store for the specified time period.

Syntax

Clear-RemoteAccessInboxAccountingStore [-StartDateTime] [-EndDateTime] [-AsJob] [-CimSession] [-ComputerName] [-Force] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Clear-RemoteAccessInboxAccountingStore cmdlet clears the inbox accounting store for the specified time period.

The store for inbox accounting resides locally on every Remote Access server and the clearing operation happens at the server level. Therefore this cmdlet is not impacted by a multi-site deployment.

Note: If neither a start date nor an end date is specified, then the entire inbox accounting store is cleared.

When a store is cleared more space becomes available to record accounting data.

This cmdlet can be used to clear portions of the store even if inbox accounting is Disabled. This is because the store exists even when inbox accounting is later disabled.

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CimSession <CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ComputerName <String>

Specifies the IPv4 or IPv6 address, or host name, of the computer on which the remote access server computer specific tasks should be run. When this parameter is specified the store residing on that Remote Access server is cleared.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-EndDateTime <DateTime>

Specifies the time duration for which the store should be emptied and indicates the end date. If no start date is specified, then the time stamp of the last record entry in the accounting store is used by default.

Aliases

None

Required?

false

Position

3

Default value

last day/entry in the accounting store

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-Force <SwitchParameter>

Forces the command to run without asking for user confirmation. When this parameter is specified, the cmdlet assumes user confirmation for the clearing of the store.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-StartDateTime <DateTime>

Specifies the time duration for which the store should be emptied and indicates the start date. If no start date is specified, then the time stamp of the first record entry in the accounting store is used by default.

Aliases

None

Required?

false

Position

2

Default value

first day/entry in the accounting store

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-ThrottleLimit <Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

Microsoft.Management.Infrastructure.CimInstance#RemoteAccessInboxAccounting

Notes

None

Examples

EXAMPLE 1

This example deletes the data between the specific dates provided. The remaining data will be preserved.

PS C:\>$startdate = Get-Date –Date "1/1/2011"



PS C:\>$startdate
Saturday, January 01, 2011 12:00:00AM


PS C:\>$enddate = Get-Date –Date "1/3/2011"



PS C:\>$enddate
Tuesday, March 01, 2011 12:00:00AM


PS C:\>Clear-RemoteAccessInboxAccountingStore –StartDateTime $startdate –EndDateTime $enddate –PassThru
Confirm 
Emptying the store will delete the accounting data in accordance with the specified settings. Do you want to continue? 
 
[Y] Yes  [N] No  [S] Suspend  [?] Help  (default is ꞌYꞌ): Y 
 
InboxAccountingStatus      : Enabled 
StoreLimit                 : 12m 
StoreUsedBytes             : 12648448 
StoreUsedBytesInPercentage : 0.2944946 
StoreFreeBytes             : 4282318848 
StoreFreeBytesInPercentage : 99.70551 
StoreFirstRecordDate       : 12/31/2010 11:17:00 PM 
StoreLastRecordDate        : 8/9/2011 12:17:00 AM 

EXAMPLE 2

This example clears the accounting store and removes all data.

PS C:\>Clear-RemoteAccessInboxAccountingStore
Confirm 
Emptying the store will delete the accounting data in accordance with the specified settings. Do you want to continue? 
 
[Y] Yes  [N] No  [S] Suspend  [?] Help  (default is ꞌYꞌ): Y 
 
InboxAccountingStatus      : Enabled 
StoreLimit                 : 12m 
StoreUsedBytes             : 12648448 
StoreUsedBytesInPercentage : 0.2944946 
StoreFreeBytes             : 4282318848 
StoreFreeBytesInPercentage : 99.70551 
StoreFirstRecordDate       : 12/29/2011 4:39:41 PM 
StoreLastRecordDate        : 12/29/2011 4:39:41 PM 

Online Version
Get-Date
Set-RemoteAccessInboxAccountingStore