Topic Last Modified: 2013-03-06
Retrieves global settings for call admission control (CAC), Enhanced 9-1-1 (E9-1-1), and media bypass. This cmdlet was introduced in Lync Server 2010.
Syntax
Get-CsNetworkConfiguration [-Identity
<XdsIdentity>] <COMMON PARAMETERS>
|
Get-CsNetworkConfiguration [-Filter <String>]
<COMMON PARAMETERS>
|
COMMON PARAMETERS: [-LocalStore
<SwitchParameter>]
|
Examples
EXAMPLE 1
This example retrieves the network configuration settings. These settings are defined only at the global scope, so only one item will be returned.
Copy Code | |
---|---|
Get-CsNetworkConfiguration |
EXAMPLE 2
Only one set of media bypass settings exists, which is applied globally. These settings are stored as part of the overall network configuration. This command first retrieves that configuration by calling the Get-CsNetworkConfiguration cmdlet, and then retrieves the MediaBypassSettings property of the configuration.
Copy Code | |
---|---|
(Get-CsNetworkConfiguration).MediaBypassSettings |
Detailed Description
The network configuration object contains all the global settings for media bypass and for an entire CAC configuration within a Lync Server deployment, including whether or not that configuration has been enabled. You can use this cmdlet to retrieve these configurations and settings. However, other than EnableBandwidthPolicyCheck and MediaBypassSettings, it’s recommended that you use cmdlets specific to the object type for retrieving the CAC configuration settings. For example, to retrieve the network regions, it will usually be easier to call the Get-CsNetworkRegion cmdlet than to call the Get-CsNetworkConfiguration cmdlet and then retrieve the NetworkRegions property of that configuration.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsNetworkConfiguration cmdlet locally: RTCUniversalUserAdmins, 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 "Get-CsNetworkConfiguration"}
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Filter |
Optional |
System.String |
Because there will only ever be one network configuration, you do not need this parameter for this cmdlet. |
Identity |
Optional |
Microsoft.Rtc.Management.Xds.XdsIdentity |
This will always be Global. |
LocalStore |
Optional |
System.Management.Automation.SwitchParameter |
Retrieves the network configuration from the local replica of the Central Management store, rather than the Central Management store itself. |
Input Types
None.
Return Types
The Get-CsNetworkConfiguration cmdlet returns an instance of the Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings object.