Set-RemoteAccessInboxAccountingStore

Set-RemoteAccessInboxAccountingStore

Modifies the size of the inbox accounting store.

Syntax

Parameter Set: Set1
Set-RemoteAccessInboxAccountingStore [-StoreLimit] <String> [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-RemoteAccessInboxAccountingStore cmdlet modifies the size of the inbox accounting store.

The store for inbox accounting resides locally on every Remote Access (RA) server. When inbox accounting is Enabled for the first time the default size of the store is 12 months on every server. Any subsequent change to the store size can be done using this cmdlet and the change happens at the server level. Therefore this cmdlet is not impacted by a multi-site deployment.

This cmdlet can be used to modify store size even if inbox accounting is Disabled. This is because the store exists even when inbox accounting is later Disabled.

Parameters

-AsJob

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 RA server computer specific tasks should be run. When this parameter is specified the size limit of the store residing on that RA server is modified.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-PassThru

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

-StoreLimit<String>

Specifies the limit on the amount of accounting data that can be stored, specifically the size of the store, in terms of time. Following is the format used: <duration><time unit>. The time unit can be day, week, month or year as specified using the characters d, w, m, or y. Such as 100d means 100 days, 3m means 3 months, or 2y means 2 years.

Aliases	none
Required?	true
Position?	2
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
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

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

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

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<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

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 RemoteAccessAccountingStore object consists of the following properties:
  -- The 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 changes the inbox store limit from the configured default to store 2 years of data.

PS C:\> Set-RemoteAccessInboxAccountingStore -StoreLimit 2y -PassThru

Related topics

Clear-RemoteAccessInboxAccountingStore