Set-CsTenantNetworkSite

Reference

Module:: SkypeForBusiness

Applies to:: Microsoft Teams, Skype for Business Online

As an Admin, you can use the Windows PowerShell command, Set-CsTenantNetworkSite to define network sites. Network sites are defined as a collection of IP subnets. Each network site must be associated with a network region. Tenant network site is used for Location Based Routing.

Syntax

Set-CsTenantNetworkSite
   [-Tenant <System.Guid>]
   [-Description <String>]
   [-NetworkRegionID <String>]
   [-LocationPolicy <String>]
   [-EnableLocationBasedRouting <Boolean>]
   [-OnlineVoiceRoutingPolicy <String>]
    [-NetworkRoamingPolicy <String>]
   [[-Identity] <XdsGlobalRelativeIdentity>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CsTenantNetworkSite
   [-Tenant <System.Guid>]
   [-Description <String>]
   [-NetworkRegionID <String>]
   [-LocationPolicy <String>]
   [-EnableLocationBasedRouting <Boolean>]
   [-OnlineVoiceRoutingPolicy <String>]
   [-NetworkRoamingPolicy <String>]
   [-Instance <PSObject>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

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. Each network site must be associated with a network region.

A best practice for Location Based Routing (LBR) is to create a separate site for each location which has unique PSTN connectivity. 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. In addition, network sites can also be used for configuring Network Roaming Policy capabilities.

Examples

-------------------------- Example 1 --------------------------

PS C:\> Set-CsTenantNetworkSite -Identity "MicrosoftSite1" -NetworkRegionID "RegionRedmond" -Description "Microsoft site 1"

The command shown in Example 1 set the network site 'MicrosoftSite1' with description 'Microsoft site 1'.

The network region 'RegionRedmond' is created beforehand and 'MicrosoftSite1' will be associated with 'RegionRedmond'.

-------------------------- Example 2 --------------------------

PS C:\> Set-CsTenantNetworkSite -Identity "site2" -Description "site 2" -NetworkRegionID "RedmondRegion" -EnableLocationBasedRouting $true

The command shown in Example 2 sets the network site 'site2' with description 'site 2'. This site is enabled for LBR. The example associates the site with network region 'RedmondRegion'.

-------------------------- Example 3 --------------------------

PS C:\> Set-CsTenantNetworkSite -Identity "site3" -Description "site 3" -NetworkRegionID "RedmondRegion" -NetworkRoamingPolicy "TestNetworkRoamingPolicy"

The command shown in Example 3 sets the network site 'site3' with description 'site 3'. This site is enabled for network roaming capabilities. The example associates the site with network region 'RedmondRegion' and network roaming policy 'TestNetworkRoamingPolicy'.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

Provide a description of the network site to identify purpose of setting it.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableLocationBasedRouting

This parameter determines whether the current site is enabled for location based routing.

Type:	Boolean
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Identity

Unique identifier for the network site to be set.

Type:	XdsGlobalRelativeIdentity
Position:	1
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Instance

The Instance parameter allows you to pass a reference to an object to the cmdlet, rather than set individual parameter values. You can retrieve this object reference by calling the Get-CsTenantNetworkSite cmdlet.

Type:	PSObject
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-LocationPolicy

This parameter is reserved for internal Microsoft use.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-NetworkRegionID

NetworkRegionID is the identifier for the network region which the current network site is associating to.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-NetworkRoamingPolicy

NetworkRoamingPolicy is the identifier for the network roaming policy to which the network site will associate to.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-OnlineVoiceRoutingPolicy

This parameter is deprecated and should not be used.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Tenant

Globally unique identifier (GUID) of the tenant account whose network sites are being created. For example:

-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"

You can return your tenant ID by running this command:

Get-CsTenant | Select-Object DisplayName, TenantID

Type:	System.Guid
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

System.Management.Automation.PSObject

Outputs

System.Object