See Also
Topic Last Modified: 2010-10-01
Retrieves one or more network inter-site policies, which define bandwidth limitations between sites that are directly linked within a call admission control (CAC) configuration.
Syntax
Get-CsNetworkInterSitePolicy [-Identity
<XdsGlobalRelativeIdentity>] [-LocalStore
<SwitchParameter>]
|
Get-CsNetworkInterSitePolicy [-Filter <String>]
[-LocalStore <SwitchParameter>]
|
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
XdsGlobalRelativeIdentity |
The unique identifier of the network site policy you want to retrieve. Network site policies are created only at the global scope, so this identifier does not need to specify a scope. Instead, it contains a string that is a unique name that identifies that policy. |
|
Filter |
Optional |
String |
A string containing wildcard characters that will search for policies with Identity values matching the wildcard string. |
|
LocalStore |
Optional |
SwitchParameter |
Retrieves the network inter-site policy information from the local replica of the Central Management store, rather than the Central Management store itself. |
Detailed Description
When network sites share a direct link, bandwidth limitations for audio and video connections can be defined between those two sites. This cmdlet retrieves one or more network site policies that associate bandwidth limitation settings with directly connected sites.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsNetworkInterSitePolicy 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-CsNetworkInterSitePolicy"}
Input Types
None.
Return Types
Retrieves an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType.
Example
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
Get-CsNetworkInterSitePolicy |
|
Calling Get-CsNetworkInterSitePolicy with no parameters retrieves all network site policies defined between two directly linked network sites.
-------------------------- Example 2 --------------------------
| Copy Code |
|
|---|---|
Get-CsNetworkInterSitePolicy -Identity Reno_Portland |
|
This example retrieves the network site policy with the Identity Reno_Portland.
-------------------------- Example 3 --------------------------
| Copy Code |
|
|---|---|
Get-CsNetworkInterSitePolicy -Filter *Reno* |
|
Example 3 retrieves all network site policies that have the string Reno anywhere within the Identity value. The wildcard characters (*) within the value passed to the Filter parameter signify “any character or set of characters.” In other words, the string *Reno* will match Identity values that begin with any character or characters, followed by the string Reno, followed by any character or characters.
-------------------------- Example 4 --------------------------
| Copy Code |
|
|---|---|
Get-CsNetworkInterSitePolicy | Where-Object {$_.BWPolicyProfileID -eq $null}
|
|
This example retrieves all network site policies that do not have a bandwidth policy profile assigned. The command begins by calling Get-CsNetworkInterSitePolicy, which, as we saw in Example 1, retrieves a collection of all network site policies. This collection is then piped to the Where-Object cmdlet. Where-Object narrows the collection down to only those site policies that don’t have a bandwidth policy profile assigned. It does this by comparing to see if the BWPolicyProfileID property of each site policy is equal to (-eq) Null ($null).