Export (0) Print
Expand All
Expand Minimize

Get-CsNetworkSubnet

 

Topic Last Modified: 2012-03-23

Retrieves information about one or more network subnets.

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

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.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsNetworkSubnet 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-CsNetworkSubnet"}

 

Parameter Required Type Description

Identity

Optional

XdsGlobalRelativeIdentity

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

Filter

Optional

String

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.).

LocalStore

Optional

SwitchParameter

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

Returns one or more objects of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType.

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

Get-CsNetworkSubnet

This example retrieves all subnets within the Microsoft Lync Server 2010 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 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. Where-Object takes that collection and narrows it down to only those subnets with a NetworkSiteID equal to (-eq) Vancouver.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft