Export (0) Print
Expand All
Expand Minimize

New-CsBandwidthPolicyServiceConfiguration

 

Topic Last Modified: 2012-08-11

Creates a new bandwidth policy service configuration. This cmdlet was introduced in Lync Server 2010.

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

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.

New-CsBandwidthPolicyServiceConfiguration -Identity site:Redmond

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) to the EnableLogging parameter, and 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.

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

Call admission control (CAC) is a way of determining whether to allow real-time communications sessions, such as voice or video calls, to be established based on bandwidth constraints. Within the Lync 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. Bandwidth Policy service is the component that performs CAC functionality in the Lync Server deployment, enabling the decision as to whether sufficient bandwidth exists for a call to be established. This cmdlet configures a new bandwidth policy service at the site level.

Who can run this cmdlet: By default, members of the following groups are authorized to run the New-CsBandwidthPolicyServiceConfiguration cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsBandwidthPolicyServiceConfiguration"}

 

Parameter Required Type Description

Identity

Required

Microsoft.Rtc.Management.Xds.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 following format: site:<site name>, where <site name> is the name of the site to which the configuration applies.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command.

EnableLogging

Optional

System.Boolean

Set this parameter to True to generate CAC failure and link status logs related to the bandwidth policy service.

Default: False

Force

Optional

System.Management.Automation.SwitchParameter

Suppresses any confirmation prompts that would otherwise be displayed before making changes.

InMemory

Optional

System.Management.Automation.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

System.TimeSpan

The period of time after which CAC failure and link status 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

System.UInt32

The maximum size the log file is allowed to reach. The value for this parameter must be a positive number; it specifies the file size in megabytes.

Default: 3 (MB)

MaxTokenLifetime

Optional

System.TimeSpan

The maximum amount of time the token issued by the Bandwidth Policy 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

System.Management.Automation.SwitchParameter

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

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

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft