Skip to content

Commit 8e487a6

Browse files
Merge pull request #25 from AnirbanPaul/patch-17
Update get-networkcontrollernetworkinterface.md
2 parents 514f4f1 + 85dc5d4 commit 8e487a6

File tree

1 file changed

+44
-1
lines changed

1 file changed

+44
-1
lines changed

docset/windows/network-controller/get-networkcontrollernetworkinterface.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ ms.assetid: F9FA653D-84BB-47D8-B876-F6C3E03852ED
2020
# Get-NetworkControllerNetworkInterface
2121

2222
## SYNOPSIS
23+
Retrieves the settings of a network interface from the Network Controller
2324

2425
## SYNTAX
2526

@@ -29,13 +30,19 @@ Get-NetworkControllerNetworkInterface [[-ResourceId] <String[]>] -ConnectionUri
2930
```
3031

3132
## DESCRIPTION
33+
Retrieves the settings of a network interface from the Network Controller
3234

3335
## EXAMPLES
34-
36+
This example retrieves the configuration of a network interface called nw1, from the Network Controller.
37+
```
38+
Get-NetworkControllerNetworkInterface -ConnectionUri https://networkcontroller -ResourceId nw1
39+
```
3540

3641
## PARAMETERS
3742

3843
### -CertificateThumbprint
44+
Specifies the digital public key X.509 certificate of a user account that has permission to perform this action.This is the certificate thumbprint of the certificate.This thumbprint must also be provided in the *ClientCertificateThumbprint* parameter in the **Install-NetworkController** or **Set-NetworkController** cmdlet so that Network Controller can authorize this user.
45+
3946
```yaml
4047
Type: String
4148
Parameter Sets: (All)
@@ -49,6 +56,8 @@ Accept wildcard characters: False
4956
```
5057
5158
### -ConnectionUri
59+
Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller.
60+
5261
```yaml
5362
Type: Uri
5463
Parameter Sets: (All)
@@ -62,6 +71,8 @@ Accept wildcard characters: False
6271
```
6372
6473
### -Credential
74+
Specifies a user credential that has permission to perform this action.The default value is the current user.This user must be present in the security group provided in the *ClientSecurityGroup* parameter in the **Install-NetworkController** cmdlet.
75+
6576
```yaml
6677
Type: PSCredential
6778
Parameter Sets: (All)
@@ -88,6 +99,8 @@ Accept wildcard characters: False
8899
```
89100
90101
### -ResourceId
102+
Specifies the unique identifier for the networkinterface resource.
103+
91104
```yaml
92105
Type: String[]
93106
Parameter Sets: (All)
@@ -106,6 +119,36 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
106119
## INPUTS
107120
108121
## OUTPUTS
122+
Following settings of a network interface can be retrieved:
123+
1. MAC address
124+
2. IP address
125+
3. Whether this is a host virtual NIC
126+
4. Whether the NIC is primary
127+
5. Internal DNS name label of the NIC
128+
6. Port settings of the NIC  
129+
- Whether MAC spoofing is enabled  
130+
- Whether ARP guard is enabled.  ARP guard will allow only addresses specified in ArpFilter to pass through the port  
131+
- ArpFilter: IP list for allowed addresses when arpGuard is enabled  
132+
- Whether DHCP guard is enabled. Specifies whether to drop DHCP messages from a virtual machine claiming to be a DHCP server.  
133+
- Storm limit: the number of broadcast, multicast, and unknown unicast packets per second a virtual machine is allowed to send through the specified virtual network adapter. A value of zero (0) means there is no limit.  
134+
- Port Flow Limit: Specifies the maximum number of flows that can be executed for the port. A value of blank or zero (0) means there is no limit  
135+
- IovWeight: Specifies whether single-root I/O virtualization (SR-IOV) is to be enabled on this virtual network adapter. The range of the value is typically from 0 through 100. Value of 0 disables SR-IOV on the virtual network adapter.  
136+
- IovInterruptModeration: Specifies the interrupt moderation value for a single-root I/O virtualization (SR-IOV) virtual function assigned to a virtual network adapter. Allowed values are “default”, “adaptive”, “off”, low”, “medium”, and “high”.   
137+
- IovQueuePairsRequested: Specifies the number of hardware queue pairs to be allocated to an SR-IOV virtual function. If receive-side scaling (RSS) is required, and if the physical network adapter that binds to the virtual switch supports RSS on SR-IOV virtual functions, then more than one queue pair is required. Allowed values range from 1 to 4294967295  
138+
- VmqWeight: Specifies whether virtual machine queue (VMQ) is to be enabled on the virtual network adapter. The relative weight describes the affinity of the virtual network adapter to use VMQ. The range of value is typically from 0 through 100. Value of 0 disables VMQ on the virtual network adapter.  
139+
- QosSettings: Reference to QoS Settings applied on the interface
140+
7. DNS servers assigned to the interface
141+
8. IP configuration of the interface   
142+
- Private IP address   
143+
- Private IP address allocation method   
144+
- Load balancer backend address pools associated with the IP configuration   
145+
- Load balancer inbound NAT Rules associated with the IP configuration   
146+
- Subnet associated with the IP configuration   
147+
- Public IP address associated with the IP configuration   
148+
- Access control list associated with the IP Configuration   
149+
- Service insertion rules associated with the IP configuration
150+
9. Server where the network interface is hosted
151+
10. Virtual port association of the interface
109152
110153
## NOTES
111154

0 commit comments

Comments
 (0)