Returns information about the network interfaces in use on computers running Microsoft Communications Server “14” services or server roles.
Syntax
Get-CsNetworkInterface [-Identity <NetworkInterfaceIdentity>] [-ComputerFqdn <Fqdn>] |
Get-CsNetworkInterface [-ComputerFqdn <Fqdn>] [-Filter <String>] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
Network Interface Identity |
Unique identifier for the network interface to be returned. A network interface Identity consists of three parts: The fully qualified domain name of the computer itself (for example, atl-cs-001.litwareinc.com). The network interface "side" (Primary; Internal; External; PSTN.). The side indicates the type of traffic the port is used for. The network interface number for that particular side. For example: -Identity "atl-cs-001.litwareinc.com/Primary/1". The –Identity, -ComputerFqdn, and –Filter parameters must be used separately; for example, you cannot run a command that uses both –ComputerFqdn and –Identity. In addition, you cannot use wildcard characters when specifying the Identity. To employ wildcards, use the –Filter parameter. If neither the –Identity, -ComputerFqdn, or –Filter parameters are used then Get-CsNetworkInterface returns information about all the network interfaces currently in use onyou’re your computers running a Communications Server service or server role. |
|
ComputerFqdn |
Optional |
String |
Fully qualified domain name of the computer for which network interface information is to be returned. For example, to return network interface information for the computer atl-cs-001.litwareinc.com (and only for that computer) use this syntax: -ComputerFqdn atl-cs-001.litwareinc.com. |
|
Filter |
Optional |
String |
Enables you to use wildcards when specifying the network interface (or interfaces) to be returned. For example, this syntax returns information about the Primary network interface used on all of your computers running a Communications Server service or server role: -Filter "*/Primary/*". |
Detailed Description
In order for information to be transmitted from one computer to another, these computers need network interfaces: connections between the computer and the network. Computers running Microsoft Communications Server “14” services or server roles must have at least one network interface; otherwise they would not be able to communicate with other computers. However, these computers can also have multiple network interfaces; for example, an Access Edge server might have one interface for connecting to the internal network and a second interface for connecting to the Internet. The Get-CsNetworkInterface cmdlet provides a way for administrators to return information about the network interfaces currently in use on computers running Microsoft Communications Server 2010 services or server roles.
Return Types
Get-CsNetworkInterface returns instance of the Microsoft.Rtc.Management.Xds.DisplayNetworkInterface object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Get-CsNetworkInterface |
|
The preceding command returns information for all the Communications Server network interfaces configured for use in the organization.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsNetworkInterface -Identity atl-cs-001.litwareinc.com.com/Primary/1 |
|
The command shown in Example 2 returns information about a single Communications Server network interface: the interface that has the Identity atl-cs-001.litwareinc.com.com/Primary/1.
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Get-CsNetworkInterface -Filter "*.litwareinc.com*" |
|
In Example 3, information is returned for all the Communications Server network interfaces in the domain litwareinc.com. To carry out this task, the -Filter parameter is included, along with the filter value "*.litwareinc.com*". This filter value limits the returned data to interfaces that have an Identity that includes the string value "litwareinc.com".
-------------------------- Example 4 ------------------------
| Copy Code |
|
|---|---|
Get-CsNetworkInterface | Where-Object {$_.IPAddress -eq "192.168.0.240"}
|
|
Example 4 returns information about all the Communications Server network interfaces configured for the IP address 192.168.0.240. To do this, the command first calls Get-CsNetworkInterface without any parameters; this returns a collection of all the network interfaces configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those interfaces where the IPAddress property is equal to (-eq) 192.168.0.240.
-------------------------- Example 5 ------------------------
| Copy Code |
|
|---|---|
Get-CsNetworkInterface | Where-Object {$_.IPAddress -like "192.168.0.*"}
|
|
The command shown in Example 5 is a variation of the command shown in Example 4; in this case, however, information is returned for all the network interfaces configured for the subnet 192.168.0.*. This is done by retrieving a collection of all the network interfaces, piping that collection to Where-Object, then picking out only those interfaces where the IPAddress starts with (-like) the string value "192.168.0.".
-------------------------- Example 5 ------------------------
| Copy Code |
|
|---|---|
Get-CsNetworkInterface | Where-Object {$_.Interface -eq "External"}
|
|
The preceding command returns all the Communications Server network interfaces that have been configured for external access. To achieve this, Get-CsNetworkInterface is first called without any parameters; this returns a collection of all the network interfaces currently in use. This collection is then piped to the Where-Object cmdlet, which selects only those items where the Interface property is equal to External.