[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Modifies an existing bandwidth policy service configuration.

Syntax

Set-CsBandwidthPolicyServiceConfiguration [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-EnableLogging <$true | $false>] [-Force <SwitchParameter>] [-LogCleanUpInterval <TimeSpan>] [-MaxLogFileSizeMb <UInt32>] [-MaxTokenLifetime <TimeSpan>] [-WhatIf [<SwitchParameter>]]
Set-CsBandwidthPolicyServiceConfiguration [-Confirm [<SwitchParameter>]] [-EnableLogging <$true | $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-LogCleanUpInterval <TimeSpan>] [-MaxLogFileSizeMb <UInt32>] [-MaxTokenLifetime <TimeSpan>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Identity

Optional

XdsIdentity

The unique identifier of the configuration you want to change. This identifier will consist of the scope (for the global configuration) or the scope and name (for a site-level configuration, such as site:Redmond).

Confirm

Optional

SwitchParameter

Prompts you for confirmation before executing the command.

EnableLogging

Optional

Boolean

Set this parameter to True to generate audit logs related to the bandwidth policy service.

Instance

Optional

PSObject

A reference to a bandwidth policy service configuration object. This object must be of type BandwidthPolicyServiceConfiguration, which can be retrieved by calling the Get-CsBandwidthPolicyServiceConfiguration cmdlet.

LogCleanUpInterval

Optional

TimeSpan

The period of time after which audit logs will be removed.

This value must be within the range 1 day through 60 days. The value must be entered in the format dd.hh:mm:ss, where d is days, h is hours, m is minutes, and s is seconds. For example, 20 days would be 20.00:00:00.

MaxLogFileSizeMb

Optional

UInt32

The maximum size the log file is allowed to reach. The value for this parameter must be a positive number and specifies the file size in megabytes. For example, to allow the log file to reach a maximum size of 10 megabytes, enter the value 10.

MaxTokenLifetime

Optional

TimeSpan

The maximum amount of time the token issued by the authentication service will exist.

This value must be in the range 1 hour through 24 hours. The value must be entered in the format dd.hh:mm:ss, where d is days, h is hours, m is minutes, and s is seconds. For example, the value for 12 hours would be 12:00:00.

WhatIf

Optional

SwitchParameter

Describes what would happen if you executed the command without actually executing the command.

Detailed Description

Call admission control (CAC) is a way of managing bandwidth for non-data transmissions. In Microsoft Communications Server 2010, this means managing the bandwidth available for audio and video transmissions. Within the Communications Server implementation of CAC, regions, sites, and subnets are defined within a network along with the relationships and links between those entities in order to place bandwidth constraints between them. The bandwidth policy service enables the decision as to whether sufficient bandwidth exists for a call to be completed. This cmdlet modifies an existing bandwidth policy service.

Return Types

This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration.

Examples

-------------------------- Example 1 --------------------------

Copy Code
Set-CsBandwidthPolicyServiceConfiguration -Identity site:Redmond -EnableLogging $true -MaxTokenLifetime 3:00:00 -LogCleanUpInterval 5.00:00:00

This example modifies the bandwidth policy service configuration for the site Redmond (-Identity site:Redmond). The configuration is modified to enable logging, change the maximum lifetime of a token to 3 hours, and the number of days before log cleanup to 5 days. This is all accomplished in this one command. To enable logging, the EnableLogging parameter is set to True ($true). Next the MaxTokenLifetime parameter receives a value of 3:00:00, which represents 3 hours. Finally, the LogCleanUpInterval parameter receives a value of 5.00:00:00, which signifies 5 days.