Modifies an existing call admission control (CAC) or E911 network site.
Syntax
Set-CsNetworkSite [-Identity <XdsGlobalRelativeIdentity>] [-BWPolicyProfileID <String>] [-BypassID <String>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Force <SwitchParameter>] [-LocationPolicy <String>] [-NetworkRegionID <String>] [-WhatIf [<SwitchParameter>]] |
Set-CsNetworkSite [-BWPolicyProfileID <String>] [-BypassID <String>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-LocationPolicy <String>] [-NetworkRegionID <String>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
XdsGlobalRelativeIdentity |
The unique identifier of the network site you want to modify. Sites are created only at the global scope, so you do not need to specify a scope. Instead, you need to specify only the site ID. |
|
BWPolicyProfileID |
Optional |
String |
The Identity of the bandwidth policy profile that will define the limitations for this site. You can retrieve a list of available profiles by calling the Get-CsNetworkBandwidthPolicyProfile cmdlet. |
|
BypassID |
Optional |
String |
A globally unique identifier (GUID). This GUID is used to map network sites to media bypass settings within a CAC or E911 network configuration. (Use this BypassID value in the call to New-CsNetworkMediaBypassConfiguration.) If you specify a value for this parameter you must also specify a value for the NetworkRegionID parameter. If you do not specify a value for this parameter but you do specify a NetworkRegionID, a BypassID will be automatically generated. If you explicitly specify a value, it must be in the format of a GUID (for example, 3b24a047-dce6-48b2-9f20-9fbff17ed62a). It is recommended that you supply a value for NetworkRegionID and allow the BypassID value to be auto-generated. |
|
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
|
Description |
Optional |
String |
A string that describes the site. This parameter can be used to provide a more descriptive explanation of what the site is for or where it is than can be expressed by the Identity alone. |
|
Force |
Optional |
SwitchParameter |
|
|
Instance |
Optional |
PSObject |
A reference to a network site object (an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType). This object can be retrieved by calling the Get-CsNetworkSite cmdlet. |
|
LocationPolicy |
Optional |
String |
The name of the location policy associated with this site. The location policy assigns specific E911 settings to the site. |
|
NetworkRegionID |
Optional |
String |
The Identity of the network region that this site is associated with. This parameter must contain a value if you want to provide a BypassID (either through auto-generation or manually). If a BypassID exists on this site already and you don’t specify a value for the BypassID parameter, the existing BypassID will be overwritten by an auto-generated BypassID. |
|
WhatIf |
Optional |
SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Detailed Description
Network sites are the offices or locations configured within each region of a CAC or E911 deployment. This cmdlet modifies the settings on an existing site. This can include such things as the region with which the site is associated, the description of the site, and the associated bandwidth policy profile.
Return Types
This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType.
Examples
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
Set-CsNetworkSite -Identity Vancouver -NetworkRegionID Canada |
|
In this example the network site named Vancouver is modified. The name of the site being modified is specified as the value for the Identity parameter. The Vancouver site is being moved to a new region, which requires that the NetworkRegionID parameter be changed, in this case to the region named Canada. Because a NetworkRegionID has been supplied but no value has been specified for BypassID, a BypassID value will be automatically generated. Any previously-existing bypass ID will be overwritten.
-------------------------- Example 2 --------------------------
| Copy Code |
|
|---|---|
Set-CsNetworkSite -Identity Vancouver - BWPolicyProfileID LowBWLimits |
|
Example 2 simply modifies the bandwidth policy profile associated with the Vancouver site. The site name is specified as the value for the Identity parameter. Then we specify a value for the BWPolicyProfileID parameter: LowBWLimits. The policies associated with that profile will be used for this site.