Set-CsBandwidthPolicyServiceConfiguration
Topic Last Modified: 2012-03-27
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>]]
Detailed Description
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 Microsoft Lync Server 2010 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 2010 deployment, enabling the decision as to whether sufficient bandwidth exists for a call to be established. This cmdlet modifies an existing bandwidth policy service configuration.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-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 "Set-CsBandwidthPolicyServiceConfiguration"}
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). |
Instance |
Optional |
BandwidthPolicyServiceConfiguration |
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. |
EnableLogging |
Optional |
Boolean |
Set this parameter to True to generate CAC failure and link status logs related to the bandwidth policy service. |
LogCleanUpInterval |
Optional |
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. 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 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. For example, the value for 12 hours would be 12:00:00. |
Force |
Optional |
SwitchParameter |
Suppresses any confirmation prompts that would otherwise be displayed before making changes. |
WhatIf |
Optional |
SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
Input Types
Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration object. Accepts pipelined input of bandwidth policy service configuration objects.
Return Types
This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration.
Example
-------------------------- Example 1 --------------------------
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 three hours, and the number of days before log cleanup to five 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 three hours. Finally, the LogCleanUpInterval parameter receives a value of 5.00:00:00, which signifies five days.