Set-CsNetworkConfiguration
Modifies the settings for a network configuration. This cmdlet will most often be used to enable or disable call admission control (CAC). This cmdlet was introduced in Lync Server 2010.
Syntax
Set-CsNetworkConfiguration
[-Tenant <Guid>]
[-MediaBypassSettings <MediaBypassSettingsType>]
[-BWPolicyProfiles <PSListModifier>]
[-NetworkRegions <PSListModifier>]
[-NetworkRegionLinks <PSListModifier>]
[-InterNetworkRegionRoutes <PSListModifier>]
[-NetworkSites <PSListModifier>]
[-InterNetworkSitePolicies <PSListModifier>]
[-Subnets <PSListModifier>]
[-EnableBandwidthPolicyCheck <Boolean>]
[[-Identity] <XdsIdentity>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CsNetworkConfiguration
[-Tenant <Guid>]
[-MediaBypassSettings <MediaBypassSettingsType>]
[-BWPolicyProfiles <PSListModifier>]
[-NetworkRegions <PSListModifier>]
[-NetworkRegionLinks <PSListModifier>]
[-InterNetworkRegionRoutes <PSListModifier>]
[-NetworkSites <PSListModifier>]
[-InterNetworkSitePolicies <PSListModifier>]
[-Subnets <PSListModifier>]
[-EnableBandwidthPolicyCheck <Boolean>]
[-Instance <PSObject>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The network configuration object contains all the settings for an entire CAC configuration within a Skype for Business Server deployment, plus media bypass settings. You can use this cmdlet to modify any part of the CAC configuration and you must use it if you need to change media bypass settings. However, it's recommended that you use cmdlets specific to the object type when modifying most of the CAC configuration settings. For example, to work with network regions, use the cmdlets ending with the noun CsNetworkRegion rather than manipulating the NetworkRegions parameter of this cmdlet.
The primary use of this cmdlet is to enable (and disable) CAC and apply media bypass settings. After you've set up the various components required for your configuration (such as regions, sites, and subnets), you must enable the configuration before it will work. To do this, simply set the EnableBandwidthPolicyCheck parameter to True. Note that running this cmdlet with EnableBandwidthPolicyCheck set to True doesn't immediately enable CAC. Before it can be enabled, a series of validation checks are made to ensure the setup is configured properly. Any errors or discrepancies in the setup will prompt with warnings that ask if you want to continue to enable CAC even though there is a problem. If you choose to continue (by pressing Enter or Y), the validation will continue and will prompt you again if another issue is discovered.
If you run through the entire validation, choosing to continue at each warning, EnableBandwidthPolicyCheck will be set to True and CAC will be enabled, but until the issues are resolved it probably won't work as expected. If at any point in the validation you choose to stop validation (by typing N at a warning prompt), validation will end and EnableBandwidthPolicyCheck will remain set to False (the default).
If EnableBandwidthPolicyCheck is already set to True, you can call the Set-CsNetworkConfiguration cmdlet and pass a value of True to the parameter EnableBandwidthPolicyCheck to run the validation without modifying any settings.
In addition, when EnableBandwidthPolicyCheck is True, any changes you attempt to make by calling the Set-CsNetworkConfiguration cmdlet will again cause the validation check to run.
The following parameters are not applicable to Skype for Business Online: BWPolicyProfiles, EnableBandwidthPolicyCheck, Force, Identity, Instance, InterNetworkRegionRoutes, InterNetworkSitePolicies, NetworkRegionLinks, NetworkRegions, NetworkSites, PipelineVariable, Subnets, and Tenant
Examples
-------------------------- Example 1 --------------------------
Set-CsNetworkConfiguration -EnableBandwidthPolicyCheck $TrueThe command in this example will run a validation check against the entire CAC configuration and then (depending on your responses to any warning prompts that are returned) will enable CAC. If CAC is already enabled (in other words, if the EnableBandwidthPolicyCheck property is True) and you run this command, it will simply run the validation check.
Parameters
-BWPolicyProfiles
A collection of all the bandwidth policy profiles that can be assigned to sites, inter-site policies and network region links.
Each bandwidth policy profile contains bandwidth limitations (overall limitations and session limitations) for audio and/or video connections.
A full list of bandwidth policy profiles can be retrieved by calling the Get-CsNetworkBandwidthPolicyProfile cmdlet.
| Type: | PSListModifier |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-Confirm
Prompts you for confirmation before executing the command.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-EnableBandwidthPolicyCheck
Setting this parameter to True will run a validation check against the entire CAC configuration. If all validation checks pass, or if you choose to ignore all warnings, CAC will be enabled. If a validation check does not pass, you can choose to stop the validation and the value of EnableBandwidthPolicyCheck will not change. You must have region routes defined between each pair of network regions before you running the validation check.
Setting this value to False will disable CAC.
Default: False
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-Force
This parameter does not take a value. If you include this parameter, any changes made to the configuration, including enabling the configuration, will take place with no warnings or validation checks.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-Identity
This value will always be Global.
| Type: | XdsIdentity |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-Instance
A reference to a network configuration object.
This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings, which can be retrieved by calling the Get-CsNetworkConfiguration cmdlet.
| Type: | PSObject |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-InterNetworkRegionRoutes
A collection of all the network region routes defined within the CAC configuration.
You can retrieve all the members of this collection by calling the Get-CsNetworkInterRegionRoute cmdlet.
| Type: | PSListModifier |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-InterNetworkSitePolicies
A collection of network inter-site policies defined within the CAC configuration.
You can retrieve all the members of this collection by calling the Get-CsNetworkInterSitePolicy cmdlet.
| Type: | PSListModifier |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-MediaBypassSettings
A reference to an object that defines the global media bypass settings for the CAC configuration.
Setting this value will overwrite all existing media bypass settings.
You obtain this object reference by calling the New-CsNetworkMediaBypassConfiguration cmdlet and assigning the new configuration settings to a variable.
Pass this variable to the MediaBypassSettings parameter to change the global media bypass settings.
| Type: | MediaBypassSettingsType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-NetworkRegionLinks
A collection of network region links defined within the CAC configuration.
Each network region link defines a connection that exists between two regions and any bandwidth limitations that should be applied to connections between those regions.
You can retrieve all the members of this collection by calling the Get-CsNetworkRegionLink cmdlet.
| Type: | PSListModifier |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-NetworkRegions
A collection of network regions (each of which represents a hub or backbone within the network) defined within the CAC configuration.
You can retrieve all the members of this collection by calling the Get-CsNetworkRegion cmdlet.
| Type: | PSListModifier |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-NetworkSites
A collection of network sites (each of which represents an office or location within a region) defined within the CAC configuration.
You can retrieve all the members of this collection by calling the Get-CsNetworkSite cmdlet.
| Type: | PSListModifier |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-Subnets
A collection of network subnets (each of which associates an endpoint with a site) defined within the CAC configuration.
You can retrieve all the members of this collection by calling the Get-CsNetworkSubnet cmdlet.
| Type: | PSListModifier |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-Tenant
{{Fill Tenant Description}}
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Skype for Business Online |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
Inputs
Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings object. Accepts pipelined input of a network configuration object.
Outputs
The Set-CsNetworkConfiguration cmdlet does not return a value or object.
Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings object.