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

Creates a new bandwidth policy service configuration.

Syntax


New-CsBandwidthPolicyServiceConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-EnableLogging <$true \| $false>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-LogCleanUpInterval <TimeSpan>] [-MaxLogFileSizeMb <UInt32>] [-MaxTokenLifetime <TimeSpan>] [-WhatIf [<SwitchParameter>]]

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

Parameters

Parameter	Required	Type	Description
Identity	Required	XdsIdentity	A unique identifier that contains the scope and name of the configuration. This configuration can be created only at the site scope, so the Identity will be in the format site:<site name>, where <site name> is the name of the site to which the configuration applies.
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. Default: False
InMemory	Optional	SwitchParameter	Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- 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. Default: 10 days (10.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. Default: 3 (MB)
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. Default: 8 hours (08: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 creates a new bandwidth policy service at the site level.

Return Types

Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration.

Examples

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

	Copy Code
New-CsBandwidthPolicyServiceConfiguration -Identity site:Redmond

This example creates a new bandwidth policy service configuration at the site Redmond (-Identity site:Redmond). No other parameters are specified, so the defaults are used for all configuration values.

-------------------------- Example 2 --------------------------

	Copy Code
New-CsBandwidthPolicyServiceConfiguration -Identity site:Dublin -EnableLogging $True -LogCleanupInterval 30.00:00:00

In this example we again create a new bandwidth policy service configuration, this time for the Dublin site (-Identity site:Dublin). For this site, rather than accepting the default values we want to enable logging and set the number of days that pass before logs are cleaned up to 30 days. We do this by passing a value of True ($True) the EnableLogging parameter, then passing a value of 30.00:00:00 to the parameter LogCleanupInterval. The LogCleanupInterval value is a TimeSpan object, which is in the format dd.hh:mm:ss, where d is days, h is hours, m is minutes, and s is seconds.