Skip to content

Commit d4e358d

Browse files
Merge pull request #11702 from vivekiiit/patch-2
Create Get-CsTenantNetworkConfiguration.md
2 parents aa77795 + 00d108c commit d4e358d

File tree

1 file changed

+128
-0
lines changed

1 file changed

+128
-0
lines changed
Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
3+
online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkconfiguration
4+
applicable: Microsoft Teams
5+
title: Get-CsTenantNetworkConfiguration
6+
schema: 2.0.0
7+
ms.reviewer:
8+
---
9+
10+
# Get-CsTenantNetworkConfiguration
11+
12+
## SYNOPSIS
13+
Returns information about the network regions, sites and subnets in the tenant network configuration. Tenant network configuration is used for Location Based Routing.
14+
15+
## SYNTAX
16+
17+
### Identity (Default)
18+
```
19+
Get-CsTenantNetworkConfiguration [[-Identity] <string>] [<CommonParameters>]
20+
```
21+
22+
### Filter
23+
```
24+
Get-CsTenantNetworkConfiguration [-Filter <string>] [<CommonParameters>]
25+
```
26+
27+
## DESCRIPTION
28+
Tenant Network Configuration contains the list of network sites, subnets and regions configured.
29+
30+
A network site represents a ___location where your organization has a physical venue, such as offices, a set of buildings, or a campus. Network sites are defined as a collection of IP subnets.
31+
32+
A best practice for Location Based Routing (LBR) is to create a separate site for each ___location which has unique PSTN connectivity. Each network site must be associated with a network region. Sites may be created as LBR or non-LBR enabled. A non-LBR enabled site may be created to allow LBR enabled users to make PSTN calls when they roam to that site. Note that network sites may also be used for emergency calling enablement and configuration.
33+
34+
IP subnets at the ___location where Teams endpoints can connect to the network must be defined and associated to a defined network in order to enforce toll bypass.
35+
36+
Multiple subnets may be associated with the same network site, but multiple sites may not be associated with a same subnet. This association of subnets enables Location-Based routing to locate the endpoints geographically to determine if a given PSTN call should be allowed. Both IPv4 and IPv6 subnets are supported. When determining if a Teams endpoint is located at a site an IPv6 address will be checked for a match first.
37+
38+
A network region interconnects various parts of a network across multiple geographic areas.
39+
40+
A network region contains a collection of network sites. For example, if your organization has many sites located in India, then you may choose to designate "India" as a network region.
41+
42+
Location-Based Routing is a feature that allows PSTN toll bypass to be restricted for users based on policy and the user's geographic ___location at the time of an incoming or outgoing PSTN call.
43+
44+
Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. It is now available in Microsoft 365 for Teams clients. For toll bypass restricted locations, each IP subnet and PSTN gateway for that ___location are associated to a network site by the administrator. A user's ___location is determined by the IP subnet which the user's Teams endpoint(s) is connected to at the time of a PSTN call. A user may have multiple Teams clients located at different sites, in which case Location-Based Routing will enforce each client's routing separately depending on the ___location of its endpoint.
45+
46+
## EXAMPLES
47+
48+
### Example 1
49+
```powershell
50+
PS C:\> Get-CsTenantNetworkConfiguration
51+
```
52+
The command shown in Example 1 returns the list of network configuration for the current tenant.
53+
54+
### Example 2
55+
```powershell
56+
PS C:\> Get-CsTenantNetworkConfiguration -Identity Global
57+
```
58+
The command shown in Example 2 returns the network configuration within the scope of Global.
59+
60+
### Example 3
61+
```powershell
62+
PS C:\> Get-CsTenantNetworkConfiguration -Filter "global"
63+
```
64+
The command shown in Example 3 returns the network site that matches the specified filter.
65+
66+
## PARAMETERS
67+
68+
### -Filter
69+
Enables you to use wildcard characters when indicating the network configuration (or network configurations) to be returned.
70+
71+
```yaml
72+
Type: String
73+
Parameter Sets: Filter
74+
Aliases:
75+
76+
Required: False
77+
Position: Named
78+
Default value: None
79+
Accept pipeline input: False
80+
Accept wildcard characters: False
81+
```
82+
83+
### -Identity
84+
The Identity parameter is a unique identifier for the network configuration.
85+
86+
```yaml
87+
Type: String
88+
Parameter Sets: Identity
89+
Aliases:
90+
91+
Required: False
92+
Position: Named
93+
Default value: None
94+
Accept pipeline input: False
95+
Accept wildcard characters: False
96+
```
97+
### CommonParameters
98+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
99+
For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).
100+
101+
## INPUTS
102+
103+
### None
104+
105+
## OUTPUTS
106+
107+
### Identity
108+
The Identity of the network configuration.
109+
110+
### NetworkRegions
111+
The list of network regions of the network configuration.
112+
113+
### NetworkSites
114+
The list of network sites of the network configuration.
115+
116+
### Subnets
117+
The list of network subnets of the network configuration.
118+
119+
### PostalCodes
120+
This parameter is reserved for internal Microsoft use.
121+
122+
## NOTES
123+
124+
## RELATED LINKS
125+
[Get-CsTenantNetworkSite](Get-CsTenantNetworkSite.md)
126+
[Get-CsTenantNetworkSubnet](Get-CsTenantNetworkSubnet.md)
127+
[Get-CsTenantNetworkRegion](Get-CsTenantNetworkRegion.md)
128+

0 commit comments

Comments
 (0)