Clear-RemoteAccessInboxAccountingStore

Clear-RemoteAccessInboxAccountingStore

Clears the inbox accounting store for the specified time period.

Syntax

Parameter Set: Clear0
Clear-RemoteAccessInboxAccountingStore [[-StartDateTime] <DateTime> ] [[-EndDateTime] <DateTime> ] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-Force] [-PassThru] [-ThrottleLimit <Int32> ] [-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

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

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

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

-Force

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.

-PassThru

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

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

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

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

• None

  None

Outputs

The output type is the type of the objects that the cmdlet emits.

• Microsoft.Management.Infrastructure.CimInstance#RemoteAccessInboxAccounting

  The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
  The RemoteAccessInboxAccounting object consists of the following properties:
  -- Status of inbox accounting (Enabled or Disabled).
  -- Time span of the store.
  -- Number of used bytes.
  -- Percentage of used bytes.
  -- Number of free bytes.
  -- Percentage of free bytes.
  -- Time stamp of the first record in the database.
  -- Time stamp of the last record in the database.

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

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

PS C:\> $enddate

PS C:\> Clear-RemoteAccessInboxAccountingStore –StartDateTime $startdate –EndDateTime $enddate –PassThru

EXAMPLE 2

This example clears the accounting store and removes all data.

PS C:\> Clear-RemoteAccessInboxAccountingStore

Related topics

Set-RemoteAccessInboxAccountingStore

Get-Date