Edit

Get-CsNetworkSubnet

  • Reference
Module:
SkypeForBusiness
Applies to:
Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Retrieves information about one or more network subnets. This cmdlet was introduced in Lync Server 2010.

Syntax

Get-CsNetworkSubnet
   [[-Identity] <XdsGlobalRelativeIdentity>]
   [-LocalStore]
   [<CommonParameters>]
Get-CsNetworkSubnet
   [-Filter <String>]
   [-LocalStore]
   [<CommonParameters>]

Description

Each subnet must be associated with a network site for the purposes of determining the geographic location of the host belonging to this subnet. Use this cmdlet to retrieve information about the subnet, including the Identity (the subnet ID), the number of mask bits, the associated network site, and the description of the subnet.

Examples

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

Get-CsNetworkSubnet

This example retrieves all subnets within the Skype for Business Server deployment.

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

Get-CsNetworkSubnet -Identity 172.11.15.0

This example retrieves all information about the subnet with the Identity (the Subnet ID) 172.11.15.0.

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

Get-CsNetworkSubnet -Filter 172.11.*

This example retrieves all subnets with identities that begin with 172.11.

-------------------------- Example 4 --------------------------

Get-CsNetworkSubnet | Where-Object {$_.NetworkSiteID -eq "Vancouver"}

Example 4 retrieves all subnets associated with the Vancouver site. We first call the Get-CsNetworkSubnet cmdlet with no parameters, which, as we saw in Example 2, retrieves all defined subnets. We then pipe this collection of subnets to the Where-Object cmdlet. The Where-Object cmdlet takes that collection and narrows it down to only those subnets with a NetworkSiteID equal to (-eq) Vancouver.

Parameters

-Filter

Use this parameter to perform a wildcard search of all subnets based on Identity. For example, the Filter value 172.11.* will retrieve all subnets with an Identity beginning with 172.11. (such as 172.11.10.0, 172.11.25.0, etc.).

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-Identity

The unique subnet ID of the subnet you want to retrieve. This value will be an IP address (such as 174.11.12.0).

Type:XdsGlobalRelativeIdentity
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-LocalStore

Retrieves the network subnet information from the local replica of the Central Management store, rather than the Central Management store itself.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Inputs

None

Outputs

Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType