| Server IP : 134.29.175.74 / Your IP : 216.73.216.160 Web Server : nginx/1.10.2 System : Windows NT CST-WEBSERVER 10.0 build 19045 (Windows 10) i586 User : Administrator ( 0) PHP Version : 7.1.0 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : OFF | Perl : OFF | Python : OFF | Sudo : OFF | Pkexec : OFF Directory : /Windows/System32/WindowsPowerShell/v1.0/Modules/NetTCPIP/en-US/ |
Upload File : |
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml">
<!-- Updatable Help Version 5.0.4.0 -->
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Find-NetRoute</command:name>
<maml:description>
<maml:para>Finds the best local IP address and the best route to reach a remote address. </maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Find</command:verb>
<command:noun>NetRoute</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Find-NetRoute cmdlet finds the best local IP address and the best route to reach a remote address. Specify the remote address to reach. You can also specify an interface and a local address to use to reach the remote address.</maml:para>
<maml:para>For more information about routing, see <maml:navigationLink><maml:linkText>Chapter 5 - IP Routing</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://technet.microsoft.com/library/bb727001.aspx) in the TechNet library.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Find-NetRoute</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an index of a network interface. The cmdlet finds a route for this interface.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LocalIPAddress</maml:name>
<maml:description>
<maml:para>Specifies a local IP address from which to find a route. You can specify a host address or a subnet address. You can also use a wildcard address, such as 0.0.0.0/0 for all IPv4 addresses, ::/0 for all IPv6 addresses, or ANY for all addresses. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RemoteIPAddress</maml:name>
<maml:description>
<maml:para>Specifies a remote IP address to which to find a route. You can specify a host address or a subnet address. You can also use a wildcard address, such as 0.0.0.0/0 for all IPv4 addresses, ::/0 for all IPv6 addresses, or ANY for all addresses </maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an index of a network interface. The cmdlet finds a route for this interface.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LocalIPAddress</maml:name>
<maml:description>
<maml:para>Specifies a local IP address from which to find a route. You can specify a host address or a subnet address. You can also use a wildcard address, such as 0.0.0.0/0 for all IPv4 addresses, ::/0 for all IPv6 addresses, or ANY for all addresses. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RemoteIPAddress</maml:name>
<maml:description>
<maml:para>Specifies a remote IP address to which to find a route. You can specify a host address or a subnet address. You can also use a wildcard address, such as 0.0.0.0/0 for all IPv4 addresses, ::/0 for all IPv6 addresses, or ANY for all addresses </maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>NetIPAddress, NetRoute</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Find a local address and route</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Find-NetRoute -RemoteIPAddress "10.79.197.200"
IPAddress : 172.31.234.140
InterfaceIndex : 3
InterfaceAlias : Ethernet
AddressFamily : IPv4
Type : Unicast
PrefixLength : 21
PrefixOrigin : Dhcp
SuffixOrigin : Dhcp
AddressState : Preferred
ValidLifetime : 6.00:10:40
PreferredLifetime : 6.00:10:40
SkipAsSource : False
PolicyStore : ActiveStore
Caption :
Description :
ElementName :
InstanceID : :8:8:8:9:55=55;A<8=;8<=<8;55;
AdminDistance :
DestinationAddress :
IsStatic :
RouteMetric : 0
TypeOfRoute : 3
AddressFamily : IPv4
DestinationPrefix : 0.0.0.0/0
InterfaceAlias : Ethernet
InterfaceIndex : 3
NextHop : 172.31.232.1
PreferredLifetime : 8.00:00:00
Protocol : NetMgmt
Publish : No
Store : ActiveStore
ValidLifetime : 8.00:00:00
PSComputerName :
ifIndex : 3
</dev:code>
<dev:remarks>
<maml:para>This command finds a NetIPAddress object and NetRoute object to use to access the IP address 10.79.197.200. The command returns two objects. The first object is the local IP address. The second object is the local route that includes the selected connectivity path and next hop.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkID=313144</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>New-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-NetCompartment</command:name>
<maml:description>
<maml:para>Gets all network compartments in the protocol stack.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>NetCompartment</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-NetCompartment cmdlet gets network compartments in the protocol stack. You can specify the ID of a compartment to get. If you do not specify the CompartmentId parameter, the cmdlet gets all compartments in the protocol stack.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-NetCompartment</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CompartmentId</maml:name>
<maml:description>
<maml:para>Specifies an array of identifiers of compartments.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CompartmentId</maml:name>
<maml:description>
<maml:para>Specifies an array of identifiers of compartments.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>
</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>
</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get a network compartment on the local host</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Find-NetCompartment -CompartmentId 1
CompartmentId : 1
CompartmentDescription : Default Compartment
CompartmentGuid : {b1062982-2b18-4b4f-b3d5-a78ddb9cdd49}
</dev:code>
<dev:remarks>
<maml:para>This command gets the network compartment that has the ID 1.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=313145</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetIPInterface</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-NetIPAddress</command:name>
<maml:description>
<maml:para>Gets the IP address configuration.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>NetIPAddress</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-NetIPAddress cmdlet gets the IP address configuration, such as IPv4 addresses, IPv6 addresses and the IP interfaces with which addresses are associated. Without parameters, this cmdlet gets the entire IP address configuration for the computer. </maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-NetIPAddress</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="LocalAddress">
<maml:name>IPAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of IPv4 or IPv6 addresses.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address families. The cmdlet gets the IP address configuration that matches the address families. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressState</maml:name>
<maml:description>
<maml:para>Specifies an array of duplicate address detection (DAD) state values for the IP address. Use this parameter to filter the output based on addresses that are valid and available for use. The acceptable values for this parameter are:
-- Invalid. IP address configuration information for addresses that are not valid and will not be used.
-- Tentative. IP address configuration information for addresses that are not used for communication, as the uniqueness of those IP addresses is being verified.
-- Duplicate. IP address configuration information for addresses for which a duplicate IP address has been detected and the current IP address will not be used.
-- Deprecated. IP address configuration information for addresses that will no longer be used to establish new connections, but will continue to be used with existing connections.
-- Preferred. IP address configuration information for addresses that are valid and available for use. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressState[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedIPInterface</maml:name>
<maml:description>
<maml:para>Specifies an IP interface as a CIM object. To obtain an IP interface, use the Get-NetIPInterface cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes addresses from all configured network compartments. If you do not specify this parameter, the cmdlet gets only addresses in the default network compartment.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet gets IP addresses that match the aliases.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet gets IP addresses that match the indexes.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
The default value is ActiveStore. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values of preferred lifetimes, as TimeSpan objects, for an IP address. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PrefixLength</maml:name>
<maml:description>
<maml:para>Specifies an array of prefix lengths. This parameter defines the local subnet size, and is also known as a subnet mask.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Byte[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PrefixOrigin</maml:name>
<maml:description>
<maml:para>Specifies an array of origins for address prefixes. IP addresses are divided into two parts, the prefix and the suffix. The address prefix identifies the network portion of an IP address, and the address suffix identifies the host portion. The acceptable values for this parameter are:
-- Manual. The IP address prefix was manually specified.
-- WellKnown. The IP address prefix is from a well-known source.
-- DHCP. The IP address prefix was provided by DHCP settings.
-- RouterAdvertisement. The IP address prefix was obtained through a router advertisement (RA). </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">PrefixOrigin[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SkipAsSource</maml:name>
<maml:description>
<maml:para>Indicates whether an address is a primary IP address. This parameter identifies the primary IP address for outgoing traffic in a multiple IP address scenario. If this parameter is set to True, the addresses are not used for outgoing traffic and are not registered in DNS.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Boolean[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SuffixOrigin</maml:name>
<maml:description>
<maml:para>Specifies an array of origins for address suffixes. IP addresses are divided into two parts, the prefix and the suffix. The address prefix identifies the network portion of an IP address, and the address suffix identifies the host portion. The acceptable values for this parameter are:
-- Manual. The IP address suffix was manually specified.
-- WellKnown. The IP address suffix is from a well-known source.
-- DHCP. The IP address suffix was provided by DHCP settings.
-- Link. The IP address suffix was obtained from the link-layer address.
-- Random. The IP address suffix was obtained from a random source. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">SuffixOrigin[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Type</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address types. The acceptable values for this parameter are:
-- Unicast
-- Anycast
The default value is Unicast. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Type[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values for valid lifetimes, as TimeSpan objects, for an IP address. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address families. The cmdlet gets the IP address configuration that matches the address families. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
<dev:type>
<maml:name>AddressFamily[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressState</maml:name>
<maml:description>
<maml:para>Specifies an array of duplicate address detection (DAD) state values for the IP address. Use this parameter to filter the output based on addresses that are valid and available for use. The acceptable values for this parameter are:
-- Invalid. IP address configuration information for addresses that are not valid and will not be used.
-- Tentative. IP address configuration information for addresses that are not used for communication, as the uniqueness of those IP addresses is being verified.
-- Duplicate. IP address configuration information for addresses for which a duplicate IP address has been detected and the current IP address will not be used.
-- Deprecated. IP address configuration information for addresses that will no longer be used to establish new connections, but will continue to be used with existing connections.
-- Preferred. IP address configuration information for addresses that are valid and available for use. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressState[]</command:parameterValue>
<dev:type>
<maml:name>AddressState[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedIPInterface</maml:name>
<maml:description>
<maml:para>Specifies an IP interface as a CIM object. To obtain an IP interface, use the Get-NetIPInterface cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
<dev:type>
<maml:name>CimInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes addresses from all configured network compartments. If you do not specify this parameter, the cmdlet gets only addresses in the default network compartment.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet gets IP addresses that match the aliases.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet gets IP addresses that match the indexes.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="LocalAddress">
<maml:name>IPAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of IPv4 or IPv6 addresses.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
The default value is ActiveStore. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values of preferred lifetimes, as TimeSpan objects, for an IP address. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
<dev:type>
<maml:name>TimeSpan[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PrefixLength</maml:name>
<maml:description>
<maml:para>Specifies an array of prefix lengths. This parameter defines the local subnet size, and is also known as a subnet mask.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Byte[]</command:parameterValue>
<dev:type>
<maml:name>Byte[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PrefixOrigin</maml:name>
<maml:description>
<maml:para>Specifies an array of origins for address prefixes. IP addresses are divided into two parts, the prefix and the suffix. The address prefix identifies the network portion of an IP address, and the address suffix identifies the host portion. The acceptable values for this parameter are:
-- Manual. The IP address prefix was manually specified.
-- WellKnown. The IP address prefix is from a well-known source.
-- DHCP. The IP address prefix was provided by DHCP settings.
-- RouterAdvertisement. The IP address prefix was obtained through a router advertisement (RA). </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">PrefixOrigin[]</command:parameterValue>
<dev:type>
<maml:name>PrefixOrigin[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SkipAsSource</maml:name>
<maml:description>
<maml:para>Indicates whether an address is a primary IP address. This parameter identifies the primary IP address for outgoing traffic in a multiple IP address scenario. If this parameter is set to True, the addresses are not used for outgoing traffic and are not registered in DNS.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Boolean[]</command:parameterValue>
<dev:type>
<maml:name>Boolean[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SuffixOrigin</maml:name>
<maml:description>
<maml:para>Specifies an array of origins for address suffixes. IP addresses are divided into two parts, the prefix and the suffix. The address prefix identifies the network portion of an IP address, and the address suffix identifies the host portion. The acceptable values for this parameter are:
-- Manual. The IP address suffix was manually specified.
-- WellKnown. The IP address suffix is from a well-known source.
-- DHCP. The IP address suffix was provided by DHCP settings.
-- Link. The IP address suffix was obtained from the link-layer address.
-- Random. The IP address suffix was obtained from a random source. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">SuffixOrigin[]</command:parameterValue>
<dev:type>
<maml:name>SuffixOrigin[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Type</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address types. The acceptable values for this parameter are:
-- Unicast
-- Anycast
The default value is Unicast. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Type[]</command:parameterValue>
<dev:type>
<maml:name>Type[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values for valid lifetimes, as TimeSpan objects, for an IP address. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
<dev:type>
<maml:name>TimeSpan[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetIPAddress</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get IPv6 address configuration</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetIPAddress –AddressFamily IPv6
</dev:code>
<dev:remarks>
<maml:para>This command gets information about IP address configuration for all IPv6 addresses on the computer.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Get IP address information and format the output</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetIPAddress | Format-Table
</dev:code>
<dev:remarks>
<maml:para>This command gets information about IP address configuration, and displays that information in a table. The table format provides a convenient overview for computers with many IP addresses.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 3: Get IP address information by the interface index</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetIPAddress –InterfaceIndex 12
</dev:code>
<dev:remarks>
<maml:para>This command gets information about IP address configuration for a specific interface index.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 4: Get IP address information and sort the output</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetIPAddress | Sort-Object -Property InterfaceIndex | Format-Table
</dev:code>
<dev:remarks>
<maml:para>This command gets information about IP address configuration, sorts them numerically by the interface index in the cmdlet name, and then displays them in a table format. This display can help you find IP address information by interface index.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 5: Get IP address information and filter the output</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>
PS C:\>Get-NetIPAddress | Where-Object -FilterScript { $_.ValidLifetime -Lt ([TimeSpan]::FromDays(1)) }
Similarly, this cmdlet can be used to get information about IP address configuration for IP addresses that have an Infinite ValidLifetime.
PS C:\>Get-NetIPAddress | Where-Object -FilterScript { $_.ValidLifetime -Eq ([TimeSpan]::MaxValue) }
</dev:code>
<dev:remarks>
<maml:para>This command gets IP address configuration for IP addresses that have a ValidLifetime of less than one day.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=288380</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>New-NetIPAddress</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-NetIPAddress</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetIPAddress</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-NetIPConfiguration</command:name>
<maml:description>
<maml:para>Gets IP network configuration.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>NetIPConfiguration</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-NetIPConfiguration cmdlet gets network configuration, including usable interfaces, IP addresses, and DNS servers. </maml:para>
<maml:para>If you do not specify any parameters, this cmdlet gets IP configuration properties for all non-virtual connected interfaces on a computer.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-NetIPConfiguration</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an alias of a network interface. The cmdlet gets an IP configuration that matches the alias.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IncludeAllCompartments">
<maml:name>AllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet gets the IP configuration properties for all of the compartments on a computer.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="PSComputerName,ComputerName">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimSession</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>CompartmentId</maml:name>
<maml:description>
<maml:para>Specifies an identifier for network compartment in the protocol stack. By default, the cmdlet gets Net IP configuration in the default compartment. If you specify a value for this parameter, the cmdlet gets any matching Net IP configuration in the compartment specified in this field.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Detailed</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet retrieves additional interface and computer configuration information, including the computer name, link layer address, network profile, MTU length, and DHCP status.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Get-NetIPConfiguration</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IncludeAllCompartments">
<maml:name>AllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet gets the IP configuration properties for all of the compartments on a computer.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="PSComputerName,ComputerName">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimSession</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>CompartmentId</maml:name>
<maml:description>
<maml:para>Specifies an identifier for network compartment in the protocol stack. By default, the cmdlet gets Net IP configuration in the default compartment. If you specify a value for this parameter, the cmdlet gets any matching Net IP configuration in the compartment specified in this field.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Detailed</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet retrieves additional interface and computer configuration information, including the computer name, link layer address, network profile, MTU length, and DHCP status.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IncludeAllInterfaces">
<maml:name>All</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet retrieves the IP configuration properties for all of the interfaces on a computer, including virtual interfaces, loopback interfaces, and disconnected interfaces.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Get-NetIPConfiguration</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IncludeAllCompartments">
<maml:name>AllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet gets the IP configuration properties for all of the compartments on a computer.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="PSComputerName,ComputerName">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimSession</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>CompartmentId</maml:name>
<maml:description>
<maml:para>Specifies an identifier for network compartment in the protocol stack. By default, the cmdlet gets Net IP configuration in the default compartment. If you specify a value for this parameter, the cmdlet gets any matching Net IP configuration in the compartment specified in this field.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Detailed</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet retrieves additional interface and computer configuration information, including the computer name, link layer address, network profile, MTU length, and DHCP status.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an index of a network interface. The cmdlet gets an IP configuration that matches the index.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IncludeAllInterfaces">
<maml:name>All</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet retrieves the IP configuration properties for all of the interfaces on a computer, including virtual interfaces, loopback interfaces, and disconnected interfaces.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="IncludeAllCompartments">
<maml:name>AllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet gets the IP configuration properties for all of the compartments on a computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="PSComputerName,ComputerName">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimSession</command:parameterValue>
<dev:type>
<maml:name>CimSession</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none">
<maml:name>CompartmentId</maml:name>
<maml:description>
<maml:para>Specifies an identifier for network compartment in the protocol stack. By default, the cmdlet gets Net IP configuration in the default compartment. If you specify a value for this parameter, the cmdlet gets any matching Net IP configuration in the compartment specified in this field.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Detailed</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet retrieves additional interface and computer configuration information, including the computer name, link layer address, network profile, MTU length, and DHCP status.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an alias of a network interface. The cmdlet gets an IP configuration that matches the alias.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an index of a network interface. The cmdlet gets an IP configuration that matches the index.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get the IP configuration</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetIPConfiguration
</dev:code>
<dev:remarks>
<maml:para>This command gets IP configuration information. When this cmdlet is run without parameters, it gets the IP configuration information for all of the non-virtual connected interfaces on the computer.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Get all IP configuration details</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetIPConfiguration -All
</dev:code>
<dev:remarks>
<maml:para>This command gets the IP configuration information for all of the interfaces on the computer, including virtual interfaces, loopback interfaces, and disconnected interfaces.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 3: Get the IP configuration information with a common parameter</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetIPConfiguration -Verbose
</dev:code>
<dev:remarks>
<maml:para>This command gets IP configuration information. By using the Verbose parameter, the networking cmdlets are shown to gather and format the information displayed in this cmdlet. </maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 4: Get the IP configuration by interface index</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetIPConfiguration –InterfaceIndex 12
</dev:code>
<dev:remarks>
<maml:para>This command gets the IP configuration information for the interface at the index 12.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 5: Get the IP configuration from pipeline input</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetIPConfiguration | Get-NetIPAddress
</dev:code>
<dev:remarks>
<maml:para>This command gets the IP address information, including the prefix length.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=288381</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-DNSClientServerAddress</maml:linkText>
<maml:uri>
</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetAdapter</maml:linkText>
<maml:uri>
</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetIPAddress</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetIPInterface</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-NetIPInterface</command:name>
<maml:description>
<maml:para>Gets an IP interface.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>NetIPInterface</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-NetIPInterface cmdlet gets an IP interface, including IPv4 and IPv6 addresses, and the associated address configuration for the IP interfaces. Without parameters, this cmdlet gets all of the IP interface properties on the computer, including virtual interfaces and loopback interfaces. </maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-NetIPInterface</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet gets IP interfaces that match the aliases.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address families. The cmdlet gets the IP interface that matches the address families. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AdvertiseDefaultRoute</maml:name>
<maml:description>
<maml:para>Specifies an array of default router advertisement values for an IP interface. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AdvertiseDefaultRoute[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AdvertisedRouterLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of lifetimes, as TimeSpan objects, for default routes. This parameter indicates the lifetime of default routes when advertising routes on the IP interface. The default value is 1800. Valid only for advertising interfaces. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Advertising</maml:name>
<maml:description>
<maml:para>Specifies an array of router advertisement values for the IP interface. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Advertising[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutomaticMetric</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the automatic metric calculation. Automatic metric determines whether TCP/IP automatically calculates a value for an interface metric that is based on the speed of the interface. The fastest interface has the lowest interface metric value. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AutomaticMetric[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="BaseReachableTime">
<maml:name>BaseReachableTimeMs</maml:name>
<maml:description>
<maml:para>Specifies an array of base values of random reachable times, in milliseconds. For more information, see <maml:navigationLink><maml:linkText>RFC 2461</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. The default value is 30.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ClampMss</maml:name>
<maml:description>
<maml:para>Specifies an array of MSS clamping values for IP interface. This value determines if the IP interface clamps MSS on the forwarded TCP packets that are sent out of the interface. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">ClampMss[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CompartmentId</maml:name>
<maml:description>
<maml:para>Specifies an array of identifiers for network compartments in the protocol stack. By default, the cmdlet only gets Net IP interfaces in the default compartment. If you specify a value, the cmdlet gets any matching NetIPInterface in all compartments in this field. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ConnectionState</maml:name>
<maml:description>
<maml:para>Specifies an array of connection states for interfaces that are physically connected to a network.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">ConnectionState[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CurrentHopLimit</maml:name>
<maml:description>
<maml:para>Specifies an array of hop limits. This parameter is the value that the IP interface writes in the hop limit for IPv6, or the Time To Live (TTL) field, for IPv4, in all outbound traffic. When forwarding a packet, routers must decrement the hop limit, or TTL, by 1, and discard the packet when the hop limit reaches 0. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="DadRetransmitTime">
<maml:name>DadRetransmitTimeMs</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the time interval between neighbor solicitation messages.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DadTransmits</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the number of consecutive messages sent while the network driver performs duplicate address detection. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Dhcp</maml:name>
<maml:description>
<maml:para>Specifies the DHCP value for an IP interface. This value is persistent across reboots and only stored in the active policy store.
The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Dhcp[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DirectedMacWolPattern</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the wake-up packet for an IP interface. This parameter determines if an IP interface is configured to wake up a computer with directed MAC packet patterns. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">DirectedMacWolPattern[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EcnMarking</maml:name>
<maml:description>
<maml:para>Specifies an array of values for Explicit Congestion Notification (ECN) marking. This parameter value controls the specific ECN marking in the ECN field of the IP header. The acceptable values for this parameter are:
-- AppDecide. Allow an application or higher layer protocol, such as TCP, to decide how to apply ECN marking. In order for an application to fully control ECN capability value in the Network TCP value must also be set to enabled.
-- Disabled. Disable the ECN marking on the IP interface.
-- UseEct0. Mark all of the egress IP packets on the IP interface with the Ect0 bit set.
-- UseEct1. Mark all of the egress IP packets on the IP interface with the Ect1 bit set.
The default value is AppDecide. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">EcnMarking[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ForceArpNdWolPattern</maml:name>
<maml:description>
<maml:para>Specifies an array of Wake On LAN (WOL) values for the IP interface. This parameter determines if an IP interface is configured to wake up a computer with Address Resolution Protocol (ARP) and Neighbor Discovery (ND) packet patterns. By default, IP interface properties have ForceArpNdWolPattern set to disabled. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">ForceArpNdWolPattern[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Forwarding</maml:name>
<maml:description>
<maml:para>Specifies an array of packet forwarding values for the IP interface. This value determines if this IP interface forwards packets that arrive on this interface to other interfaces. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Forwarding[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IgnoreDefaultRoutes</maml:name>
<maml:description>
<maml:para>Specifies an array of values for default route advertisements. If you enable this value, default routes will not be dynamically added to the routing table. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">IgnoreDefaultRoutes[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes all non-default compartments.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet gets IP interfaces that match the indexes.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>InterfaceMetric</maml:name>
<maml:description>
<maml:para>Specifies an array of metrics of IP interfaces. When routes are chosen, the overall metric used to determine the preference is the sum of the route metric and the interface metric. Typically, the interface metric gives preference to a particular interface, such as using wired if both wired and wireless are available. The default value is automatic.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ManagedAddressConfiguration</maml:name>
<maml:description>
<maml:para>Specifies an array of values of managed address configurations. This parameter determines if an IP interface uses a stateful protocol, such as DHCP, to obtain an address. Setting this parameter will have no effect on an interface that has router discovery enabled and advertising disabled. In that case, the parameter is controlled by router discovery. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">ManagedAddressConfiguration[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NeighborDiscoverySupported</maml:name>
<maml:description>
<maml:para>Specifies an array of neighbor discovery values for the IP interface. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">NeighborDiscoverySupported[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NeighborUnreachabilityDetection</maml:name>
<maml:description>
<maml:para>Specifies an array of values for Neighbor Unreachability Detection (NUD). Use this parameter to determine when a neighbor is no longer reachable. For more information, see <maml:navigationLink><maml:linkText>RFC 2461</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">NeighborUnreachabilityDetection[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NlMtuBytes</maml:name>
<maml:description>
<maml:para>Specifies an array of network layer Maximum Transmission Unit (MTU) values, in bytes, for an IP interface. The IP interface will not transmit packets larger than the maximum value.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>OtherStatefulConfiguration</maml:name>
<maml:description>
<maml:para>Specifies an array of values for configuration other than addresses. This parameter determines if an IP interface uses a stateful protocol, such as DHCP, to obtain configuration information other than addresses. This parameter value has no effect on an interface that has router discovery enabled and advertising disabled. In that case, the parameter is controlled by router discovery. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">OtherStatefulConfiguration[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
The default value is ActiveStore. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="ReachableTime">
<maml:name>ReachableTimeMs</maml:name>
<maml:description>
<maml:para>Specifies an array of reachable time values. This parameter is the time, in milliseconds, that a node assumes that a neighbor is reachable after having received a reachability confirmation. This parameter works with the NeighborUnreachabilityDetection parameter.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="RetransmitTime">
<maml:name>RetransmitTimeMs</maml:name>
<maml:description>
<maml:para>Specifies an array of value for timeout and retransmission, in milliseconds, for Neighbor Solicitation messages. For more information, see RetransTimer in <maml:navigationLink><maml:linkText>RFC 2461</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. By default, the value is 1000.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RouterDiscovery</maml:name>
<maml:description>
<maml:para>Specifies the value for router discovery for an IP interface. The acceptable values for this parameter are:
-- Enabled
-- Disabled
-- ControlledByDHCP. IP Interface properties for interfaces that have RouterDiscovery controlled by Dynamic Host Configuration Protocol (DHCP).
By default, the value of this parameter is ControlledByDHCP for IPv4 and Enabled for IPv6. If the value of this parameter is enabled, an IP host can locate routers that reside on an attached link.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">RouterDiscovery[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>WeakHostReceive</maml:name>
<maml:description>
<maml:para>Specifies the receive value for a weak host model. By default, an IP interface properties set this parameter to disabled. If this parameter is enabled, an IP host can receive IP packets on an interface that is not assigned the destination IP address of the packet being received. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">WeakHostReceive[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>WeakHostSend</maml:name>
<maml:description>
<maml:para>Specifies the send value for a weak host model. By default, an IP interface set this parameter to disabled. If this parameter is enabled, an IP host can send IP packets on an interface that is not assigned the destination IP address of the packet being sent. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">WeakHostSend[]</command:parameterValue>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Get-NetIPInterface</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedAdapter</maml:name>
<maml:description>
<maml:para>Specifies a network adapter as a CIM object.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes all non-default compartments.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Get-NetIPInterface</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedIPAddress</maml:name>
<maml:description>
<maml:para>Specifies a network IP address as a CIM object. To obtain an IP address object, use the Get-NetIPAddress cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes all non-default compartments.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Get-NetIPInterface</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedNeighbor</maml:name>
<maml:description>
<maml:para>Specifies a network neighbor as a CIM object. To obtain a neighbor object, use the Get-NetNeighbor cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes all non-default compartments.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Get-NetIPInterface</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedRoute</maml:name>
<maml:description>
<maml:para>Specifies a network route as a CIM object. To obtain a route object, use the Get-NetRoute cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes all non-default compartments.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address families. The cmdlet gets the IP interface that matches the address families. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
<dev:type>
<maml:name>AddressFamily[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AdvertiseDefaultRoute</maml:name>
<maml:description>
<maml:para>Specifies an array of default router advertisement values for an IP interface. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AdvertiseDefaultRoute[]</command:parameterValue>
<dev:type>
<maml:name>AdvertiseDefaultRoute[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AdvertisedRouterLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of lifetimes, as TimeSpan objects, for default routes. This parameter indicates the lifetime of default routes when advertising routes on the IP interface. The default value is 1800. Valid only for advertising interfaces. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
<dev:type>
<maml:name>TimeSpan[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Advertising</maml:name>
<maml:description>
<maml:para>Specifies an array of router advertisement values for the IP interface. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Advertising[]</command:parameterValue>
<dev:type>
<maml:name>Advertising[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedAdapter</maml:name>
<maml:description>
<maml:para>Specifies a network adapter as a CIM object.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
<dev:type>
<maml:name>CimInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedIPAddress</maml:name>
<maml:description>
<maml:para>Specifies a network IP address as a CIM object. To obtain an IP address object, use the Get-NetIPAddress cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
<dev:type>
<maml:name>CimInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedNeighbor</maml:name>
<maml:description>
<maml:para>Specifies a network neighbor as a CIM object. To obtain a neighbor object, use the Get-NetNeighbor cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
<dev:type>
<maml:name>CimInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedRoute</maml:name>
<maml:description>
<maml:para>Specifies a network route as a CIM object. To obtain a route object, use the Get-NetRoute cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
<dev:type>
<maml:name>CimInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutomaticMetric</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the automatic metric calculation. Automatic metric determines whether TCP/IP automatically calculates a value for an interface metric that is based on the speed of the interface. The fastest interface has the lowest interface metric value. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AutomaticMetric[]</command:parameterValue>
<dev:type>
<maml:name>AutomaticMetric[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="BaseReachableTime">
<maml:name>BaseReachableTimeMs</maml:name>
<maml:description>
<maml:para>Specifies an array of base values of random reachable times, in milliseconds. For more information, see <maml:navigationLink><maml:linkText>RFC 2461</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. The default value is 30.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ClampMss</maml:name>
<maml:description>
<maml:para>Specifies an array of MSS clamping values for IP interface. This value determines if the IP interface clamps MSS on the forwarded TCP packets that are sent out of the interface. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">ClampMss[]</command:parameterValue>
<dev:type>
<maml:name>ClampMss[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CompartmentId</maml:name>
<maml:description>
<maml:para>Specifies an array of identifiers for network compartments in the protocol stack. By default, the cmdlet only gets Net IP interfaces in the default compartment. If you specify a value, the cmdlet gets any matching NetIPInterface in all compartments in this field. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ConnectionState</maml:name>
<maml:description>
<maml:para>Specifies an array of connection states for interfaces that are physically connected to a network.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">ConnectionState[]</command:parameterValue>
<dev:type>
<maml:name>ConnectionState[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CurrentHopLimit</maml:name>
<maml:description>
<maml:para>Specifies an array of hop limits. This parameter is the value that the IP interface writes in the hop limit for IPv6, or the Time To Live (TTL) field, for IPv4, in all outbound traffic. When forwarding a packet, routers must decrement the hop limit, or TTL, by 1, and discard the packet when the hop limit reaches 0. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="DadRetransmitTime">
<maml:name>DadRetransmitTimeMs</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the time interval between neighbor solicitation messages.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DadTransmits</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the number of consecutive messages sent while the network driver performs duplicate address detection. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Dhcp</maml:name>
<maml:description>
<maml:para>Specifies the DHCP value for an IP interface. This value is persistent across reboots and only stored in the active policy store.
The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Dhcp[]</command:parameterValue>
<dev:type>
<maml:name>Dhcp[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DirectedMacWolPattern</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the wake-up packet for an IP interface. This parameter determines if an IP interface is configured to wake up a computer with directed MAC packet patterns. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">DirectedMacWolPattern[]</command:parameterValue>
<dev:type>
<maml:name>DirectedMacWolPattern[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EcnMarking</maml:name>
<maml:description>
<maml:para>Specifies an array of values for Explicit Congestion Notification (ECN) marking. This parameter value controls the specific ECN marking in the ECN field of the IP header. The acceptable values for this parameter are:
-- AppDecide. Allow an application or higher layer protocol, such as TCP, to decide how to apply ECN marking. In order for an application to fully control ECN capability value in the Network TCP value must also be set to enabled.
-- Disabled. Disable the ECN marking on the IP interface.
-- UseEct0. Mark all of the egress IP packets on the IP interface with the Ect0 bit set.
-- UseEct1. Mark all of the egress IP packets on the IP interface with the Ect1 bit set.
The default value is AppDecide. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">EcnMarking[]</command:parameterValue>
<dev:type>
<maml:name>EcnMarking[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ForceArpNdWolPattern</maml:name>
<maml:description>
<maml:para>Specifies an array of Wake On LAN (WOL) values for the IP interface. This parameter determines if an IP interface is configured to wake up a computer with Address Resolution Protocol (ARP) and Neighbor Discovery (ND) packet patterns. By default, IP interface properties have ForceArpNdWolPattern set to disabled. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">ForceArpNdWolPattern[]</command:parameterValue>
<dev:type>
<maml:name>ForceArpNdWolPattern[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Forwarding</maml:name>
<maml:description>
<maml:para>Specifies an array of packet forwarding values for the IP interface. This value determines if this IP interface forwards packets that arrive on this interface to other interfaces. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Forwarding[]</command:parameterValue>
<dev:type>
<maml:name>Forwarding[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IgnoreDefaultRoutes</maml:name>
<maml:description>
<maml:para>Specifies an array of values for default route advertisements. If you enable this value, default routes will not be dynamically added to the routing table. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">IgnoreDefaultRoutes[]</command:parameterValue>
<dev:type>
<maml:name>IgnoreDefaultRoutes[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes all non-default compartments.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet gets IP interfaces that match the aliases.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet gets IP interfaces that match the indexes.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>InterfaceMetric</maml:name>
<maml:description>
<maml:para>Specifies an array of metrics of IP interfaces. When routes are chosen, the overall metric used to determine the preference is the sum of the route metric and the interface metric. Typically, the interface metric gives preference to a particular interface, such as using wired if both wired and wireless are available. The default value is automatic.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ManagedAddressConfiguration</maml:name>
<maml:description>
<maml:para>Specifies an array of values of managed address configurations. This parameter determines if an IP interface uses a stateful protocol, such as DHCP, to obtain an address. Setting this parameter will have no effect on an interface that has router discovery enabled and advertising disabled. In that case, the parameter is controlled by router discovery. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">ManagedAddressConfiguration[]</command:parameterValue>
<dev:type>
<maml:name>ManagedAddressConfiguration[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NeighborDiscoverySupported</maml:name>
<maml:description>
<maml:para>Specifies an array of neighbor discovery values for the IP interface. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">NeighborDiscoverySupported[]</command:parameterValue>
<dev:type>
<maml:name>NeighborDiscoverySupported[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NeighborUnreachabilityDetection</maml:name>
<maml:description>
<maml:para>Specifies an array of values for Neighbor Unreachability Detection (NUD). Use this parameter to determine when a neighbor is no longer reachable. For more information, see <maml:navigationLink><maml:linkText>RFC 2461</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">NeighborUnreachabilityDetection[]</command:parameterValue>
<dev:type>
<maml:name>NeighborUnreachabilityDetection[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NlMtuBytes</maml:name>
<maml:description>
<maml:para>Specifies an array of network layer Maximum Transmission Unit (MTU) values, in bytes, for an IP interface. The IP interface will not transmit packets larger than the maximum value.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>OtherStatefulConfiguration</maml:name>
<maml:description>
<maml:para>Specifies an array of values for configuration other than addresses. This parameter determines if an IP interface uses a stateful protocol, such as DHCP, to obtain configuration information other than addresses. This parameter value has no effect on an interface that has router discovery enabled and advertising disabled. In that case, the parameter is controlled by router discovery. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">OtherStatefulConfiguration[]</command:parameterValue>
<dev:type>
<maml:name>OtherStatefulConfiguration[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
The default value is ActiveStore. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="ReachableTime">
<maml:name>ReachableTimeMs</maml:name>
<maml:description>
<maml:para>Specifies an array of reachable time values. This parameter is the time, in milliseconds, that a node assumes that a neighbor is reachable after having received a reachability confirmation. This parameter works with the NeighborUnreachabilityDetection parameter.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="RetransmitTime">
<maml:name>RetransmitTimeMs</maml:name>
<maml:description>
<maml:para>Specifies an array of value for timeout and retransmission, in milliseconds, for Neighbor Solicitation messages. For more information, see RetransTimer in <maml:navigationLink><maml:linkText>RFC 2461</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. By default, the value is 1000.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RouterDiscovery</maml:name>
<maml:description>
<maml:para>Specifies the value for router discovery for an IP interface. The acceptable values for this parameter are:
-- Enabled
-- Disabled
-- ControlledByDHCP. IP Interface properties for interfaces that have RouterDiscovery controlled by Dynamic Host Configuration Protocol (DHCP).
By default, the value of this parameter is ControlledByDHCP for IPv4 and Enabled for IPv6. If the value of this parameter is enabled, an IP host can locate routers that reside on an attached link.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">RouterDiscovery[]</command:parameterValue>
<dev:type>
<maml:name>RouterDiscovery[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>WeakHostReceive</maml:name>
<maml:description>
<maml:para>Specifies the receive value for a weak host model. By default, an IP interface properties set this parameter to disabled. If this parameter is enabled, an IP host can receive IP packets on an interface that is not assigned the destination IP address of the packet being received. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">WeakHostReceive[]</command:parameterValue>
<dev:type>
<maml:name>WeakHostReceive[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>WeakHostSend</maml:name>
<maml:description>
<maml:para>Specifies the send value for a weak host model. By default, an IP interface set this parameter to disabled. If this parameter is enabled, an IP host can send IP packets on an interface that is not assigned the destination IP address of the packet being sent. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">WeakHostSend[]</command:parameterValue>
<dev:type>
<maml:name>WeakHostSend[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetIPInterface</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get IP interface configuration</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>
PS C:\>Get-NetIPInterface
</dev:code>
<dev:remarks>
<maml:para>This command gets the IP interface configuration on the computer on which you run the cmdlet.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Get IP interface information for IPv6 addresses</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetIPInterface –AddressFamily IPv6
</dev:code>
<dev:remarks>
<maml:para>This command gets information about the IP interface configuration for all IP interfaces for which you have configured IPv6 addresses.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 3: Get IP interface information and format the output</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetIPInterface | Format-Table
</dev:code>
<dev:remarks>
<maml:para>This command gets information about IP interface configuration, and displays that information in a table. </maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 4: Get IP interface information by interface index</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetIPInterface –InterfaceIndex 12
</dev:code>
<dev:remarks>
<maml:para>This command gets information about the IP interface configuration for a specific interface index.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 5: Get and sort IP interface information</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetIPInterface | Sort-Object –Property InterfaceIndex | Format-Table
</dev:code>
<dev:remarks>
<maml:para>This command gets information about IP address configuration, sorts them numerically by the interface index in the cmdlet name, and then displays them in a table format. </maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 6: Get the IP interface by specifying the router lifetime</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetIPInterface | Where-Object -FilterScript { $_.AdvertisedRouterLifetime.TotalSeconds -Eq 1800 }
</dev:code>
<dev:remarks>
<maml:para>This command gets information about IP address configuration for all IP interfaces that have a default AdvertisedRouterLifetime.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=288382</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetIPInterface</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-NetIPv4Protocol</command:name>
<maml:description>
<maml:para>Gets IPv4 protocol configurations.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>NetIPv4Protocol</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-NetIPv4Protocol cmdlet gets the global settings for IPv4 protocol configurations for the computer. If you do not specify any parameters, the cmdlet gets the IPv4 protocol configuration settings for all network connections for the computer. The cmdlet returns IPv4 protocol settings, such as the Internet Control Message Protocol (ICMP) setting, the default hop limit, the neighbor cache limit, and the multicast configuration.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-NetIPv4Protocol</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressMaskReply</maml:name>
<maml:description>
<maml:para>Specifies an array of values for address mask reply. The cmdlet gets the IPv4 protocol configurations that have these values. Address mask reply specifies how the computer responds to ICMP address mask packets. The acceptable values for this parameter are:
-- Enabled. The computer responds to ICMP address mask packets.
-- Disabled. The computer does not respond to ICMP address mask packets. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressMaskReply[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DeadGatewayDetection</maml:name>
<maml:description>
<maml:para>Specifies an array of values for dead gateway detection. The cmdlet gets IPv4 protocol configurations that have these values. </maml:para>
<maml:para>Dead gateway detection is a feature that identifies gateways that are not operating properly and switches the computer to a new default gateway if available.</maml:para>
<maml:para>The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">DeadGatewayDetection[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DefaultHopLimit</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the default hop limit. The cmdlet gets the IPv4 protocol configurations that have these values. The default hop limit is the default value for the CurrentHopLimit property in the IP interface. The current hop limit is the value that the IP interface writes in the time-to-live (TTL) field in all outbound traffic. When routers forward a packet, they decrement the hop limit by 1 and discard the packet when the hop limit is 0.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DhcpMediaSense</maml:name>
<maml:description>
<maml:para>Specifies an array of values for Media Sense. The cmdlet gets IPv4 protocol configurations that have these values.</maml:para>
<maml:para>Media Sense provides a mechanism for the network adapter to notify the protocol stack of media connect and disconnect events. These events trigger the DHCP client to take an action, such as attempting to renew a DHCP lease or removing routes that are related to a disconnected network. When Media Sense is enabled, the network parameters on the laptop of a roaming user are automatically and transparently updated without requiring a restart when the user moves from one location to another. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">DhcpMediaSense[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>GroupForwardedFragments</maml:name>
<maml:description>
<maml:para>Specifies an array of values for group forwarded fragments. The cmdlet gets IPv4 protocol configurations that have these values. Group forwarded fragments specifies whether the IP interface collects fragments into groups before it forwards the fragments. The acceptable values for this parameter are:
-- Enabled. The IP interface collects IPv4 protocol fragments into groups before it forwards the fragments.
-- Disabled. The IP interface does not collect IPv4 protocol fragments into groups before it forwards the fragments.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">GroupForwardedFragments[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IcmpRedirects</maml:name>
<maml:description>
<maml:para>Specifies an array of values for ICMP redirects. The cmdlet gets IPv4 protocol configurations that have these values. ICMP redirects specifies whether to update the path cache in response to ICMP redirect packets. The acceptable values for this parameter are:
-- Enabled. The IP interface updates the path cache in response to ICMP redirect packets.
-- Disabled. The IP interface does not update the path cache in response to ICMP redirect packets.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">IcmpRedirects[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="MldLevel">
<maml:name>IGMPLevel</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the Internet Group Management Protocol (IGMP) level. The cmdlet gets IPv4 protocol configurations that have these values. The IGMP level specifies the level of multicast support. The acceptable values for this parameter are:
-- None
-- SendOnly
-- All</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">MldLevel[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="MldVersion">
<maml:name>IGMPVersion</maml:name>
<maml:description>
<maml:para>Specifies an array of the IGMP version numbers. The cmdlet gets IPv4 protocol configurations that have these IGMP version numbers. The IGMP version is the maximum IGMP version supported by the host of IPv4 protocol configuration.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">MldVersion[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MediaSenseEventLog</maml:name>
<maml:description>
<maml:para>Specifies an array of values for Media Sense event log. The cmdlet gets IPv4 protocol configurations that have these values. Media Sense event log specifies whether the computer logs DHCP Media Sense events. The acceptable values for this parameter are:
-- Enabled. The IP interface logs DHCP Media Sense events in the event log for troubleshooting purposes.
-- Disabled. The IP interface does not log DHCP Media Sense events in the event log. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">MediaSenseEventLog[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MinimumMtu</maml:name>
<maml:description>
<maml:para>Specifies an array of values, in bytes, for network layer Maximum Transmission Unit (MTU). The cmdlet gets settings that have the Mtu values that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MulticastForwarding</maml:name>
<maml:description>
<maml:para>Specifies an array of values for multicast forwarding. The cmdlet gets IPv4 protocol configurations that have these values. The acceptable values for this parameter are:
-- Enabled. The computer can forward multicast packets.
-- Disabled. The computer cannot forward multicast packets.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">MulticastForwarding[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="NeighborCacheLimit">
<maml:name>NeighborCacheLimitEntries</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the maximum number of neighbor cache entries. The cmdlet gets IPv4 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RandomizeIdentifiers</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the randomization of identifiers. The cmdlet gets IPv4 protocol configurations that have these values. The acceptable values for this parameter are:
-- Enabled. The IP interface randomizes identifiers when it creates an IP address.
-- Disabled. The IP interface does not randomize identifiers when it creates an IP address.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">RandomizeIdentifiers[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="ReassemblyLimit">
<maml:name>ReassemblyLimitBytes</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the maximum size of the reassembly buffer. The cmdlet gets IPv4 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="RouteCacheLimit">
<maml:name>RouteCacheLimitEntries</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the maximum number of route cache entries. The cmdlet gets IPv4 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SourceRoutingBehavior</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the behavior for source-routed packets. The cmdlet gets IPv4 protocol configurations that have these values. The acceptable values for this parameter are:
-- DontForward. The computer can receive but not forward source-routed packets.
-- Drop. The computer drops source-routed packets.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">SourceRoutingBehavior[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressMaskReply</maml:name>
<maml:description>
<maml:para>Specifies an array of values for address mask reply. The cmdlet gets the IPv4 protocol configurations that have these values. Address mask reply specifies how the computer responds to ICMP address mask packets. The acceptable values for this parameter are:
-- Enabled. The computer responds to ICMP address mask packets.
-- Disabled. The computer does not respond to ICMP address mask packets. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressMaskReply[]</command:parameterValue>
<dev:type>
<maml:name>AddressMaskReply[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DeadGatewayDetection</maml:name>
<maml:description>
<maml:para>Specifies an array of values for dead gateway detection. The cmdlet gets IPv4 protocol configurations that have these values. </maml:para>
<maml:para>Dead gateway detection is a feature that identifies gateways that are not operating properly and switches the computer to a new default gateway if available.</maml:para>
<maml:para>The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">DeadGatewayDetection[]</command:parameterValue>
<dev:type>
<maml:name>DeadGatewayDetection[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DefaultHopLimit</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the default hop limit. The cmdlet gets the IPv4 protocol configurations that have these values. The default hop limit is the default value for the CurrentHopLimit property in the IP interface. The current hop limit is the value that the IP interface writes in the time-to-live (TTL) field in all outbound traffic. When routers forward a packet, they decrement the hop limit by 1 and discard the packet when the hop limit is 0.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DhcpMediaSense</maml:name>
<maml:description>
<maml:para>Specifies an array of values for Media Sense. The cmdlet gets IPv4 protocol configurations that have these values.</maml:para>
<maml:para>Media Sense provides a mechanism for the network adapter to notify the protocol stack of media connect and disconnect events. These events trigger the DHCP client to take an action, such as attempting to renew a DHCP lease or removing routes that are related to a disconnected network. When Media Sense is enabled, the network parameters on the laptop of a roaming user are automatically and transparently updated without requiring a restart when the user moves from one location to another. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">DhcpMediaSense[]</command:parameterValue>
<dev:type>
<maml:name>DhcpMediaSense[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>GroupForwardedFragments</maml:name>
<maml:description>
<maml:para>Specifies an array of values for group forwarded fragments. The cmdlet gets IPv4 protocol configurations that have these values. Group forwarded fragments specifies whether the IP interface collects fragments into groups before it forwards the fragments. The acceptable values for this parameter are:
-- Enabled. The IP interface collects IPv4 protocol fragments into groups before it forwards the fragments.
-- Disabled. The IP interface does not collect IPv4 protocol fragments into groups before it forwards the fragments.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">GroupForwardedFragments[]</command:parameterValue>
<dev:type>
<maml:name>GroupForwardedFragments[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="MldLevel">
<maml:name>IGMPLevel</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the Internet Group Management Protocol (IGMP) level. The cmdlet gets IPv4 protocol configurations that have these values. The IGMP level specifies the level of multicast support. The acceptable values for this parameter are:
-- None
-- SendOnly
-- All</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">MldLevel[]</command:parameterValue>
<dev:type>
<maml:name>MldLevel[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="MldVersion">
<maml:name>IGMPVersion</maml:name>
<maml:description>
<maml:para>Specifies an array of the IGMP version numbers. The cmdlet gets IPv4 protocol configurations that have these IGMP version numbers. The IGMP version is the maximum IGMP version supported by the host of IPv4 protocol configuration.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">MldVersion[]</command:parameterValue>
<dev:type>
<maml:name>MldVersion[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IcmpRedirects</maml:name>
<maml:description>
<maml:para>Specifies an array of values for ICMP redirects. The cmdlet gets IPv4 protocol configurations that have these values. ICMP redirects specifies whether to update the path cache in response to ICMP redirect packets. The acceptable values for this parameter are:
-- Enabled. The IP interface updates the path cache in response to ICMP redirect packets.
-- Disabled. The IP interface does not update the path cache in response to ICMP redirect packets.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">IcmpRedirects[]</command:parameterValue>
<dev:type>
<maml:name>IcmpRedirects[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MediaSenseEventLog</maml:name>
<maml:description>
<maml:para>Specifies an array of values for Media Sense event log. The cmdlet gets IPv4 protocol configurations that have these values. Media Sense event log specifies whether the computer logs DHCP Media Sense events. The acceptable values for this parameter are:
-- Enabled. The IP interface logs DHCP Media Sense events in the event log for troubleshooting purposes.
-- Disabled. The IP interface does not log DHCP Media Sense events in the event log. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">MediaSenseEventLog[]</command:parameterValue>
<dev:type>
<maml:name>MediaSenseEventLog[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MinimumMtu</maml:name>
<maml:description>
<maml:para>Specifies an array of values, in bytes, for network layer Maximum Transmission Unit (MTU). The cmdlet gets settings that have the Mtu values that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MulticastForwarding</maml:name>
<maml:description>
<maml:para>Specifies an array of values for multicast forwarding. The cmdlet gets IPv4 protocol configurations that have these values. The acceptable values for this parameter are:
-- Enabled. The computer can forward multicast packets.
-- Disabled. The computer cannot forward multicast packets.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">MulticastForwarding[]</command:parameterValue>
<dev:type>
<maml:name>MulticastForwarding[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="NeighborCacheLimit">
<maml:name>NeighborCacheLimitEntries</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the maximum number of neighbor cache entries. The cmdlet gets IPv4 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RandomizeIdentifiers</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the randomization of identifiers. The cmdlet gets IPv4 protocol configurations that have these values. The acceptable values for this parameter are:
-- Enabled. The IP interface randomizes identifiers when it creates an IP address.
-- Disabled. The IP interface does not randomize identifiers when it creates an IP address.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">RandomizeIdentifiers[]</command:parameterValue>
<dev:type>
<maml:name>RandomizeIdentifiers[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="ReassemblyLimit">
<maml:name>ReassemblyLimitBytes</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the maximum size of the reassembly buffer. The cmdlet gets IPv4 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="RouteCacheLimit">
<maml:name>RouteCacheLimitEntries</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the maximum number of route cache entries. The cmdlet gets IPv4 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SourceRoutingBehavior</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the behavior for source-routed packets. The cmdlet gets IPv4 protocol configurations that have these values. The acceptable values for this parameter are:
-- DontForward. The computer can receive but not forward source-routed packets.
-- Drop. The computer drops source-routed packets.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">SourceRoutingBehavior[]</command:parameterValue>
<dev:type>
<maml:name>SourceRoutingBehavior[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetIPv4Protocol</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get all IPv4 protocol configurations</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetIPv4Protocol
</dev:code>
<dev:remarks>
<maml:para>This command gets the global settings for all the IPv4 protocol configurations for the computer. The default output for the cmdlet does not include all properties of the NetIPv4Protocol object.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Output all settings for IPv4 protocol configurations</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetIPv4Protocol | Format-List –Property *
</dev:code>
<dev:remarks>
<maml:para>This command gets the global settings for all IPv4 protocol configurations for the computer. The command uses the Format-List cmdlet to display all the properties in the output in the form of a table. For more information, type Get-Help Format-Table.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=288383</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetIPv4Protocol</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetIPv6Protocol</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-NetIPv6Protocol</command:name>
<maml:description>
<maml:para>Gets IPv6 protocol configurations.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>NetIPv6Protocol</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-NetIPv6Protocol cmdlet gets the global IPv6 protocol configurations for the computer. The cmdlet returns IPv6 Protocol settings, such as the Internet Control Message Protocol (ICMP) setting, the default hop limit, the neighbor cache limit, and the multicast configuration. If you do not specify any parameters, the cmdlet gets all the IPv6 Protocol configuration settings.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-NetIPv6Protocol</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressMaskReply</maml:name>
<maml:description>
<maml:para>Specifies an array of values for address mask reply. The cmdlet gets the IPv6 protocol configurations that have these values. Address mask reply specifies how the computer responds to ICMP address mask packets. The acceptable values for this parameter are:
-- Enabled. The computer responds to ICMP address mask packets.
-- Disabled. The computer does not respond to ICMP address mask packets. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressMaskReply[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DeadGatewayDetection</maml:name>
<maml:description>
<maml:para>Specifies an array of values for dead gateway detection. The cmdlet gets IPv4 protocol configurations that have these values. </maml:para>
<maml:para>Dead gateway detection is a feature that identifies gateways that are not operating properly and switches the computer to a new default gateway if available.</maml:para>
<maml:para>The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">DeadGatewayDetection[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DefaultHopLimit</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the default hop limit. The cmdlet gets the IPv6 protocol configurations that have these values. The default hop limit is the default value for the CurrentHopLimit property in the IP interface. The current hop limit is the value that the IP interface writes in the time-to-live (TTL) field in all outbound traffic. When routers forward a packet, they decrement the hop limit by 1 and discard the packet when the hop limit is 0.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DhcpMediaSense</maml:name>
<maml:description>
<maml:para>Specifies an array of values for Media Sense. The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
<maml:para>Media Sense provides a mechanism for the network adapter to notify the protocol stack of media connect and disconnect events. These events trigger the DHCP client to take an action, such as attempting to renew a DHCP lease or removing routes that are related to a disconnected network. When Media Sense is enabled, the network parameters on the laptop of a roaming user are automatically and transparently updated without requiring a restart when the user moves from one location to another. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">DhcpMediaSense[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>GroupForwardedFragments</maml:name>
<maml:description>
<maml:para>Specifies an array of values for group forwarded fragments. The cmdlet gets IPv6 protocol configurations that have these values. Group forwarded fragments specifies whether the IP interface collects fragments into groups before it forwards the fragments. The acceptable values for this parameter are:
-- Enabled. The IP interface collects IPv4 protocol fragments into groups before it forwards the fragments.
-- Disabled. The IP interface does not collect IPv4 protocol fragments into groups before it forwards the fragments.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">GroupForwardedFragments[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IcmpRedirects</maml:name>
<maml:description>
<maml:para>Specifies an array of values for ICMP redirects. The cmdlet gets IPv4 protocol configurations that have these values. ICMP redirects specifies whether to update the path cache in response to ICMP redirect packets. The acceptable values for this parameter are:
-- Enabled. The IP interface updates the path cache in response to ICMP redirect packets.
-- Disabled. The IP interface does not update the path cache in response to ICMP redirect packets.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">IcmpRedirects[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="MaxDadAttempts">
<maml:name>MaxTemporaryDadAttempts</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the maximum number of duplicate address detection attempts for temporary addresses. The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="MaxRandomTime">
<maml:name>MaxTemporaryDesyncTime</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the maximum time to desynchronize temporary address preferred lifetimes. The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="MaxPreferredLifetime">
<maml:name>MaxTemporaryPreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values, as TimeSpan objects, for the maximum preferred lifetime over which to prefer a temporary address. The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="MaxValidLifetime">
<maml:name>MaxTemporaryValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values, as TimeSpan objects, for the maximum lifetime over which a temporary address is valid. The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MediaSenseEventLog</maml:name>
<maml:description>
<maml:para>Specifies an array of values for Media Sense event log. The cmdlet gets IPv6 protocol configurations that have these values. Media Sense event log specifies whether the computer logs DHCP Media Sense events. The acceptable values for this parameter are:
-- Enabled. The IP interface logs DHCP Media Sense events in the event log for troubleshooting purposes.
-- Disabled. The IP interface does not log DHCP Media Sense events in the event log. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">MediaSenseEventLog[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MldLevel</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the level of Multicast Listener Discovery (MLD) support. The cmdlet gets IPv6 protocol configurations that have these values. The acceptable values for this parameter are:
-- All. The computer can send and receive multicast packets.
-- None. The computer cannot send or receive multicast packets.
-- SendOnly. The computer can send but not receive multicast packets.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">MldLevel[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MldVersion</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the maximum version of Multicast Listener Discovery that the host supports. The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">MldVersion[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MulticastForwarding</maml:name>
<maml:description>
<maml:para>Specifies an array of values for multicast forwarding. The cmdlet gets IPv6 protocol configurations that have these values. The acceptable values for this parameter are:
-- Enabled. The computer can forward multicast packets.
-- Disabled. The computer cannot forward multicast packets.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">MulticastForwarding[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="NeighborCacheLimit">
<maml:name>NeighborCacheLimitEntries</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the maximum number of neighbor cache entries. The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RandomizeIdentifiers</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the randomization of identifiers. The cmdlet gets IPv6 protocol configurations that have these values. The acceptable values for this parameter are:
-- Enabled. The IP interface randomizes identifiers when it creates an IP address.
-- Disabled: The IP interface does not randomize identifiers when it creates an IP address.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">RandomizeIdentifiers[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="ReassemblyLimit">
<maml:name>ReassemblyLimitBytes</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the maximum size of the reassembly buffer. The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="RouteCacheLimit">
<maml:name>RouteCacheLimitEntries</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the maximum number of route cache entries. The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SourceRoutingBehavior</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the behavior for source-routed packets. The cmdlet gets IPv6 protocol configurations that have these values. The acceptable values for this parameter are:
-- DontForward. The computer can receive but not forward source-routed packets.
-- Drop. The computer drops source-routed packets.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">SourceRoutingBehavior[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="RegenerateTime">
<maml:name>TemporaryRegenerateTime</maml:name>
<maml:description>
<maml:para>Specifies an array of values, as TimeSpan objects, for the time before deprecating a temporary address when a new address is generated. </maml:para>
<maml:para>The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>UseTemporaryAddresses</maml:name>
<maml:description>
<maml:para>Specifies an array of values for temporary addresses. The cmdlet gets IPv6 protocol configurations that have these values. The acceptable values for this parameter are:
-- Always. The computer always generates temporary addresses by using random numbers.
-- Counter. The computer generates temporary addresses by using the interface identifier. You typically use this identifier for test purposes.
-- Disabled. The computer does not use temporary addresses.
-- Enabled. The computer uses temporary addresses. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UseTemporaryAddresses[]</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressMaskReply</maml:name>
<maml:description>
<maml:para>Specifies an array of values for address mask reply. The cmdlet gets the IPv6 protocol configurations that have these values. Address mask reply specifies how the computer responds to ICMP address mask packets. The acceptable values for this parameter are:
-- Enabled. The computer responds to ICMP address mask packets.
-- Disabled. The computer does not respond to ICMP address mask packets. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressMaskReply[]</command:parameterValue>
<dev:type>
<maml:name>AddressMaskReply[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DeadGatewayDetection</maml:name>
<maml:description>
<maml:para>Specifies an array of values for dead gateway detection. The cmdlet gets IPv4 protocol configurations that have these values. </maml:para>
<maml:para>Dead gateway detection is a feature that identifies gateways that are not operating properly and switches the computer to a new default gateway if available.</maml:para>
<maml:para>The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">DeadGatewayDetection[]</command:parameterValue>
<dev:type>
<maml:name>DeadGatewayDetection[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DefaultHopLimit</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the default hop limit. The cmdlet gets the IPv6 protocol configurations that have these values. The default hop limit is the default value for the CurrentHopLimit property in the IP interface. The current hop limit is the value that the IP interface writes in the time-to-live (TTL) field in all outbound traffic. When routers forward a packet, they decrement the hop limit by 1 and discard the packet when the hop limit is 0.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DhcpMediaSense</maml:name>
<maml:description>
<maml:para>Specifies an array of values for Media Sense. The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
<maml:para>Media Sense provides a mechanism for the network adapter to notify the protocol stack of media connect and disconnect events. These events trigger the DHCP client to take an action, such as attempting to renew a DHCP lease or removing routes that are related to a disconnected network. When Media Sense is enabled, the network parameters on the laptop of a roaming user are automatically and transparently updated without requiring a restart when the user moves from one location to another. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">DhcpMediaSense[]</command:parameterValue>
<dev:type>
<maml:name>DhcpMediaSense[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>GroupForwardedFragments</maml:name>
<maml:description>
<maml:para>Specifies an array of values for group forwarded fragments. The cmdlet gets IPv6 protocol configurations that have these values. Group forwarded fragments specifies whether the IP interface collects fragments into groups before it forwards the fragments. The acceptable values for this parameter are:
-- Enabled. The IP interface collects IPv4 protocol fragments into groups before it forwards the fragments.
-- Disabled. The IP interface does not collect IPv4 protocol fragments into groups before it forwards the fragments.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">GroupForwardedFragments[]</command:parameterValue>
<dev:type>
<maml:name>GroupForwardedFragments[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IcmpRedirects</maml:name>
<maml:description>
<maml:para>Specifies an array of values for ICMP redirects. The cmdlet gets IPv4 protocol configurations that have these values. ICMP redirects specifies whether to update the path cache in response to ICMP redirect packets. The acceptable values for this parameter are:
-- Enabled. The IP interface updates the path cache in response to ICMP redirect packets.
-- Disabled. The IP interface does not update the path cache in response to ICMP redirect packets.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">IcmpRedirects[]</command:parameterValue>
<dev:type>
<maml:name>IcmpRedirects[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="MaxDadAttempts">
<maml:name>MaxTemporaryDadAttempts</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the maximum number of duplicate address detection attempts for temporary addresses. The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="MaxRandomTime">
<maml:name>MaxTemporaryDesyncTime</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the maximum time to desynchronize temporary address preferred lifetimes. The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
<dev:type>
<maml:name>TimeSpan[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="MaxPreferredLifetime">
<maml:name>MaxTemporaryPreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values, as TimeSpan objects, for the maximum preferred lifetime over which to prefer a temporary address. The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
<dev:type>
<maml:name>TimeSpan[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="MaxValidLifetime">
<maml:name>MaxTemporaryValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values, as TimeSpan objects, for the maximum lifetime over which a temporary address is valid. The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
<dev:type>
<maml:name>TimeSpan[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MediaSenseEventLog</maml:name>
<maml:description>
<maml:para>Specifies an array of values for Media Sense event log. The cmdlet gets IPv6 protocol configurations that have these values. Media Sense event log specifies whether the computer logs DHCP Media Sense events. The acceptable values for this parameter are:
-- Enabled. The IP interface logs DHCP Media Sense events in the event log for troubleshooting purposes.
-- Disabled. The IP interface does not log DHCP Media Sense events in the event log. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">MediaSenseEventLog[]</command:parameterValue>
<dev:type>
<maml:name>MediaSenseEventLog[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MldLevel</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the level of Multicast Listener Discovery (MLD) support. The cmdlet gets IPv6 protocol configurations that have these values. The acceptable values for this parameter are:
-- All. The computer can send and receive multicast packets.
-- None. The computer cannot send or receive multicast packets.
-- SendOnly. The computer can send but not receive multicast packets.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">MldLevel[]</command:parameterValue>
<dev:type>
<maml:name>MldLevel[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MldVersion</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the maximum version of Multicast Listener Discovery that the host supports. The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">MldVersion[]</command:parameterValue>
<dev:type>
<maml:name>MldVersion[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MulticastForwarding</maml:name>
<maml:description>
<maml:para>Specifies an array of values for multicast forwarding. The cmdlet gets IPv6 protocol configurations that have these values. The acceptable values for this parameter are:
-- Enabled. The computer can forward multicast packets.
-- Disabled. The computer cannot forward multicast packets.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">MulticastForwarding[]</command:parameterValue>
<dev:type>
<maml:name>MulticastForwarding[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="NeighborCacheLimit">
<maml:name>NeighborCacheLimitEntries</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the maximum number of neighbor cache entries. The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RandomizeIdentifiers</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the randomization of identifiers. The cmdlet gets IPv6 protocol configurations that have these values. The acceptable values for this parameter are:
-- Enabled. The IP interface randomizes identifiers when it creates an IP address.
-- Disabled: The IP interface does not randomize identifiers when it creates an IP address.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">RandomizeIdentifiers[]</command:parameterValue>
<dev:type>
<maml:name>RandomizeIdentifiers[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="ReassemblyLimit">
<maml:name>ReassemblyLimitBytes</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the maximum size of the reassembly buffer. The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="RouteCacheLimit">
<maml:name>RouteCacheLimitEntries</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the maximum number of route cache entries. The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SourceRoutingBehavior</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the behavior for source-routed packets. The cmdlet gets IPv6 protocol configurations that have these values. The acceptable values for this parameter are:
-- DontForward. The computer can receive but not forward source-routed packets.
-- Drop. The computer drops source-routed packets.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">SourceRoutingBehavior[]</command:parameterValue>
<dev:type>
<maml:name>SourceRoutingBehavior[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="RegenerateTime">
<maml:name>TemporaryRegenerateTime</maml:name>
<maml:description>
<maml:para>Specifies an array of values, as TimeSpan objects, for the time before deprecating a temporary address when a new address is generated. </maml:para>
<maml:para>The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
<dev:type>
<maml:name>TimeSpan[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>UseTemporaryAddresses</maml:name>
<maml:description>
<maml:para>Specifies an array of values for temporary addresses. The cmdlet gets IPv6 protocol configurations that have these values. The acceptable values for this parameter are:
-- Always. The computer always generates temporary addresses by using random numbers.
-- Counter. The computer generates temporary addresses by using the interface identifier. You typically use this identifier for test purposes.
-- Disabled. The computer does not use temporary addresses.
-- Enabled. The computer uses temporary addresses. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UseTemporaryAddresses[]</command:parameterValue>
<dev:type>
<maml:name>UseTemporaryAddresses[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetIPv6Protocol</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get all IPv6 protocol configurations</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetIPv6Protocol
</dev:code>
<dev:remarks>
<maml:para>This command gets all IPv6 protocol configurations for the IP interface. The default output for the cmdlet does not include all properties of the NetIPv6Protocol object.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Output all properties of IPv6 protocol configurations</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetIPv6Protocol | Format-List –Property *
</dev:code>
<dev:remarks>
<maml:para>This command gets all IPv6 protocol configurations for the IP interface. The command uses the Format-List cmdlet to display all the properties in the output in the form of a table. For more information, type Get-Help Format-Table. The command default output omits some properties.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=288384</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetIPv6Protocol</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetIPv4Protocol</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-NetNeighbor</command:name>
<maml:description>
<maml:para>Gets neighbor cache entries.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>NetNeighbor</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-NetNeighbor cmdlet gets neighbor cache entries. The cmdlet returns information about IP addresses and link-layer addresses for the neighbor cache entries.</maml:para>
<maml:para>The neighbor cache maintains information for each on-link neighbor, including the IP address and the associated link-layer address. In IPv4, the neighbor cache is commonly known as the Address Resolution Protocol (ARP) cache.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-NetNeighbor</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>IPAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of IP addresses. The cmdlet gets neighbor cache entries that have the IP addresses you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address families. The cmdlet gets the neighbor cache entries that belong to the IP address families you specify. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedIPInterface</maml:name>
<maml:description>
<maml:para>Specifies an IP interface as a CIM object. The cmdlet gets neighbor cache entries that belong to this interface. To obtain an IP interface, use the Get-NetIPInterface cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes neighbor cache entries from all configured network compartments. If you do not specify this parameter, the cmdlet gets only neighbor cache entries in the default network compartment.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet gets neighbor cache entries for the network interfaces that have the aliases you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet gets neighbor cache entries for the network interfaces located at the indexes you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LinkLayerAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of link-layer addresses of the neighbor cache entry. The cmdlet gets neighbor cache entries that have the link-layer addresses you specify.</maml:para>
<maml:para>The link-layer address is also called the media access control (MAC) address. A link-layer address that uses IPv4 address syntax is a tunnel technology that encapsulates packets over an IPv4 tunnel, such as Intra-Site Automatic Tunnel Addressing Protocol (ISATAP) or Teredo. A link-layer address of all zeroes indicates that the neighbor is unreachable and the neighbor cache entry does not have a link-layer address entry. An empty link-layer address indicates that the link layer does not use link-layer addresses, such as on a loopback interface.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The cmdlet gets neighbor cache entries that have the PolicyStore value you specify. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>State</maml:name>
<maml:description>
<maml:para>Specifies an arrary of states of neighbor cache entries. The cmdlet gets neighbor cache entries that have the state you specify. The neighbor cache contains information maintained by Neighbor Unreachability Detection. Neighbor Unreachability Detection for IPv4 tracks the reachable state of IPv4 nodes in the IPv4 route cache. The acceptable values for this parameter are:
-- Unreachable. The IP address is unreachable.
-- Incomplete. Address resolution is in progress and Neighbor Unreachability Detection has not determined the link-layer address of the neighbor.
-- Probe. The neighbor is no longer known to be reachable, and Neighbor Unreachability Detection is sending unicast Neighbor Solicitation probes to verify reachability.
-- Delay. The neighbor is no longer known to be reachable, and traffic was recently sent to the neighbor. Neighbor Unreachability Detection does not probe the neighbor immediately. Neighbor Unreachability Detection delays sending probes for a short time so that the upper layer protocols can provide reachability confirmation.
-- Stale. The neighbor is no longer known to be reachable. and Until traffic is sent to the neighbor, Neighbor Unreachability Detection makes no attempt to verify its reachability.
-- Reachable. The neighbor is known to have been reachable recently, within the last minute.
-- Permanent. The neighbor is statically provisioned and will not expire unless you remove it through configuration.
-- Maximum. A maximum value for testing purposes. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">State[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address families. The cmdlet gets the neighbor cache entries that belong to the IP address families you specify. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
<dev:type>
<maml:name>AddressFamily[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedIPInterface</maml:name>
<maml:description>
<maml:para>Specifies an IP interface as a CIM object. The cmdlet gets neighbor cache entries that belong to this interface. To obtain an IP interface, use the Get-NetIPInterface cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
<dev:type>
<maml:name>CimInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes neighbor cache entries from all configured network compartments. If you do not specify this parameter, the cmdlet gets only neighbor cache entries in the default network compartment.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>IPAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of IP addresses. The cmdlet gets neighbor cache entries that have the IP addresses you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LinkLayerAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of link-layer addresses of the neighbor cache entry. The cmdlet gets neighbor cache entries that have the link-layer addresses you specify.</maml:para>
<maml:para>The link-layer address is also called the media access control (MAC) address. A link-layer address that uses IPv4 address syntax is a tunnel technology that encapsulates packets over an IPv4 tunnel, such as Intra-Site Automatic Tunnel Addressing Protocol (ISATAP) or Teredo. A link-layer address of all zeroes indicates that the neighbor is unreachable and the neighbor cache entry does not have a link-layer address entry. An empty link-layer address indicates that the link layer does not use link-layer addresses, such as on a loopback interface.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The cmdlet gets neighbor cache entries that have the PolicyStore value you specify. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet gets neighbor cache entries for the network interfaces that have the aliases you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet gets neighbor cache entries for the network interfaces located at the indexes you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>State</maml:name>
<maml:description>
<maml:para>Specifies an arrary of states of neighbor cache entries. The cmdlet gets neighbor cache entries that have the state you specify. The neighbor cache contains information maintained by Neighbor Unreachability Detection. Neighbor Unreachability Detection for IPv4 tracks the reachable state of IPv4 nodes in the IPv4 route cache. The acceptable values for this parameter are:
-- Unreachable. The IP address is unreachable.
-- Incomplete. Address resolution is in progress and Neighbor Unreachability Detection has not determined the link-layer address of the neighbor.
-- Probe. The neighbor is no longer known to be reachable, and Neighbor Unreachability Detection is sending unicast Neighbor Solicitation probes to verify reachability.
-- Delay. The neighbor is no longer known to be reachable, and traffic was recently sent to the neighbor. Neighbor Unreachability Detection does not probe the neighbor immediately. Neighbor Unreachability Detection delays sending probes for a short time so that the upper layer protocols can provide reachability confirmation.
-- Stale. The neighbor is no longer known to be reachable. and Until traffic is sent to the neighbor, Neighbor Unreachability Detection makes no attempt to verify its reachability.
-- Reachable. The neighbor is known to have been reachable recently, within the last minute.
-- Permanent. The neighbor is statically provisioned and will not expire unless you remove it through configuration.
-- Maximum. A maximum value for testing purposes. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">State[]</command:parameterValue>
<dev:type>
<maml:name>State[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetNeighbor</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get all neighbor cache entries</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetNeighbor
</dev:code>
<dev:remarks>
<maml:para>This command gets all the neighbor cache entries. The default output for the cmdlet does not include all properties of the NetNeighbor object.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Output all properties for neighbor cache entries</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetNeighbor | Format-List –Property *
</dev:code>
<dev:remarks>
<maml:para>This command gets all the neighbor cache entries. The command uses the Format-List cmdlet to display all the properties in the output in the form of a table. For more information, type Get-Help Format-Table.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 3: Get neighbor cache entries that have an IPv6 address</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetNeighbor –AddressFamily IPv6
</dev:code>
<dev:remarks>
<maml:para>This command gets information about the neighbor cache for neighbors that have an IPv6 address. </maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 4: Get network adapters that have reachable neighbors</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetNeighbor –State Reachable | Get-NetAdapter
</dev:code>
<dev:remarks>
<maml:para>This command gets a NetNeighbor object that contains neighbor cache entries that are reachable. The command passes the NetNeighbor object to the Get-NetAdapter cmdlet by using the pipeline operator. The Get-NetAdapter cmdlet gets the network adapters that have the interface index number for the network neighbors stored the NetNeighbor object.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=288385</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetAdapter</maml:linkText>
<maml:uri>
</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>New-NetNeighbor</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-NetNeighbor</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetNeighbor</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-NetOffloadGlobalSetting</command:name>
<maml:description>
<maml:para>Gets the global TCP/IP offload settings.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>NetOffloadGlobalSetting</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-NetOffloadGlobalSetting cmdlet gets the global TCP/IP offload settings. These settings include Receive Side Scaling, Receive Segment Coalescing, task offload, and NetworkDirect.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-NetOffloadGlobalSetting</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Chimney</maml:name>
<maml:description>
<maml:para>Specifies an array of values of TCP Chimney global state on the computer. The acceptable values for this parameter are:
-- Enabled
-- Disabled
-- Automatic
The default value is Disabled.</maml:para>
<maml:para>In Automatic mode, TCP Chimney Offload offloads the processing for a connection only if certain following criteria are met. In enabled mode, TCP Chimney Offload offloads the processing for connections on a first-come, first-served basis. For more information, see <maml:navigationLink><maml:linkText>Using TCP Chimney Offload</maml:linkText><maml:uri></maml:uri></maml:navigationLink> in the TechNet library.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">ChimneyEnum[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NetworkDirect</maml:name>
<maml:description>
<maml:para>Specifies an array of NetworkDirect Remote Direct Memory Access (RDMA) values on the computer. Use this parameter only on servers. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">EnabledDisabledEnum[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NetworkDirectAcrossIPSubnets</maml:name>
<maml:description>
<maml:para>Specifies an array of NetworkDirect connectivity values from outside a local IP network. The acceptable values for this parameter are:
-- Allowed
-- Blocked</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AllowedBlockedEnum[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PacketCoalescingFilter</maml:name>
<maml:description>
<maml:para>Specifies the values for a packet-coalescing filter on the computer. To reduce the number of interrupts that a computer processes, the packet-coalescing filter combines random broadcast and multicast packets, such as Address Resolution Protocol (ARP) requests, Neighbor Discovery messages, and Simple Service Discovery Protocol (SSDP) requests, into a single packet. Use this parameter only on client computers. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">EnabledDisabledEnum[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ReceiveSegmentCoalescing</maml:name>
<maml:description>
<maml:para>Specifies the Receive Segment Coalescing settings on the network adapter. Receive Segment Coalescing parses small packets of data and combines the data into a single packet. Coalescing small packets into a single packet reduces the overhead that is required to process packets. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">EnabledDisabledEnum[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ReceiveSideScaling</maml:name>
<maml:description>
<maml:para>Specifies the Receive Side Scaling settings on the computer. Receive Side Scaling distributes the network processing load across multiple processor cores. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">EnabledDisabledEnum[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>TaskOffload</maml:name>
<maml:description>
<maml:para>Specifies the global TCP/IP task offload settings on the computer. Task offload settings include IP checksum offload, Internet Protocol security (IPsec) task offload, and Large Send Offload. These features reduce the overhead of per-packet processing by distributing packet processing tasks, such as checksum calculation, to a network adapter. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">EnabledDisabledEnum[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Chimney</maml:name>
<maml:description>
<maml:para>Specifies an array of values of TCP Chimney global state on the computer. The acceptable values for this parameter are:
-- Enabled
-- Disabled
-- Automatic
The default value is Disabled.</maml:para>
<maml:para>In Automatic mode, TCP Chimney Offload offloads the processing for a connection only if certain following criteria are met. In enabled mode, TCP Chimney Offload offloads the processing for connections on a first-come, first-served basis. For more information, see <maml:navigationLink><maml:linkText>Using TCP Chimney Offload</maml:linkText><maml:uri></maml:uri></maml:navigationLink> in the TechNet library.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">ChimneyEnum[]</command:parameterValue>
<dev:type>
<maml:name>ChimneyEnum[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NetworkDirect</maml:name>
<maml:description>
<maml:para>Specifies an array of NetworkDirect Remote Direct Memory Access (RDMA) values on the computer. Use this parameter only on servers. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">EnabledDisabledEnum[]</command:parameterValue>
<dev:type>
<maml:name>EnabledDisabledEnum[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NetworkDirectAcrossIPSubnets</maml:name>
<maml:description>
<maml:para>Specifies an array of NetworkDirect connectivity values from outside a local IP network. The acceptable values for this parameter are:
-- Allowed
-- Blocked</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AllowedBlockedEnum[]</command:parameterValue>
<dev:type>
<maml:name>AllowedBlockedEnum[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PacketCoalescingFilter</maml:name>
<maml:description>
<maml:para>Specifies the values for a packet-coalescing filter on the computer. To reduce the number of interrupts that a computer processes, the packet-coalescing filter combines random broadcast and multicast packets, such as Address Resolution Protocol (ARP) requests, Neighbor Discovery messages, and Simple Service Discovery Protocol (SSDP) requests, into a single packet. Use this parameter only on client computers. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">EnabledDisabledEnum[]</command:parameterValue>
<dev:type>
<maml:name>EnabledDisabledEnum[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ReceiveSegmentCoalescing</maml:name>
<maml:description>
<maml:para>Specifies the Receive Segment Coalescing settings on the network adapter. Receive Segment Coalescing parses small packets of data and combines the data into a single packet. Coalescing small packets into a single packet reduces the overhead that is required to process packets. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">EnabledDisabledEnum[]</command:parameterValue>
<dev:type>
<maml:name>EnabledDisabledEnum[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ReceiveSideScaling</maml:name>
<maml:description>
<maml:para>Specifies the Receive Side Scaling settings on the computer. Receive Side Scaling distributes the network processing load across multiple processor cores. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">EnabledDisabledEnum[]</command:parameterValue>
<dev:type>
<maml:name>EnabledDisabledEnum[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>TaskOffload</maml:name>
<maml:description>
<maml:para>Specifies the global TCP/IP task offload settings on the computer. Task offload settings include IP checksum offload, Internet Protocol security (IPsec) task offload, and Large Send Offload. These features reduce the overhead of per-packet processing by distributing packet processing tasks, such as checksum calculation, to a network adapter. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">EnabledDisabledEnum[]</command:parameterValue>
<dev:type>
<maml:name>EnabledDisabledEnum[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetOffloadGlobalSetting</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get global TCP/IP offload settings</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetOffloadGlobalSetting
</dev:code>
<dev:remarks>
<maml:para>This command gets the global TCP/IP offload settings on the computer.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=288386</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetOffloadGlobalSetting</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-NetPrefixPolicy</command:name>
<maml:description>
<maml:para>Gets the prefix policy.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>NetPrefixPolicy</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-NetPrefixPolicy cmdlet gets the prefix policy. A computer uses a prefix policy to select source and destination addresses. A prefix policy establishes selection criteria based on the precedence of destination addresses and on labels that are attached to source addresses. For more information, see <maml:navigationLink><maml:linkText>RFC 3484</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-NetPrefixPolicy</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>Prefix</maml:name>
<maml:description>
<maml:para>Specifies an array of prefixes. A prefix identifies the IP address prefix that is used to select source and destination addresses.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Label</maml:name>
<maml:description>
<maml:para>Specifies an array of labels for a prefix policy. A label value identifies a preference for a particular source address prefix in conjunction with a destination address prefix.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Precedence</maml:name>
<maml:description>
<maml:para>Specifies an array of precedence values. A precedence value identifies a value that is used to sort destination addresses.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Label</maml:name>
<maml:description>
<maml:para>Specifies an array of labels for a prefix policy. A label value identifies a preference for a particular source address prefix in conjunction with a destination address prefix.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Precedence</maml:name>
<maml:description>
<maml:para>Specifies an array of precedence values. A precedence value identifies a value that is used to sort destination addresses.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>Prefix</maml:name>
<maml:description>
<maml:para>Specifies an array of prefixes. A prefix identifies the IP address prefix that is used to select source and destination addresses.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetPrefixPolicy</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get a prefix policy</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetPrefixPolicy
</dev:code>
<dev:remarks>
<maml:para>This command gets the prefix policy on the computer on which you run the command.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Get a prefix policy by precedence</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetPrefixPolicy –Precedence 1
</dev:code>
<dev:remarks>
<maml:para>This command gets the prefix policy that has a precedence of 1.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=288387</maml:uri>
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-NetRoute</command:name>
<maml:description>
<maml:para>Gets the IP route information from the IP routing table.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>NetRoute</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-NetRoute cmdlet gets IP route information from the IP routing table, including destination network prefixes, next hop IP addresses, and route metrics. Run this cmdlet without any parameters to get all IP routes from the routing table. Specify parameters to narrow your results. For instance, you can specify a particular interface or an IP address family.</maml:para>
<maml:para>For more information about routing, see <maml:navigationLink><maml:linkText>Chapter 5 - IP Routing</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://technet.microsoft.com/library/bb727001.aspx) in the TechNet library.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-NetRoute</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>DestinationPrefix</maml:name>
<maml:description>
<maml:para>Specifies an array of destination prefixes of IP routes. The cmdlet gets IP routes that use the prefixes that you specify. A destination prefix contains an IP address prefix and a prefix length, separated by a slash (/). A value of 0.0.0.0/0 for IPv4 or ::/0 for IPv6 indicates that the value of the NextHop parameter is a default gateway.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an IP address family. The cmdlet gets IP routes of the families that you specify. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedIPInterface</maml:name>
<maml:description>
<maml:para>Specifies an IP interface as a CIM object. The cmdlet gets IP routes that belong to the interface that you specify. To obtain an IP interface, use the Get-NetIPInterface cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CompartmentId</maml:name>
<maml:description>
<maml:para>Specifies an array of identifiers for network compartments in the protocol stack. By default, the cmdlet only gets Net routes in the default compartment. If you specify a value, the cmdlet gets any matching Net routes in all compartments in this field.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes routes from all configured network compartments. If you do not specify this parameter, the cmdlet gets only routes in the default network compartment. </maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet gets IP routes for the interfaces that have the aliases that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet gets IP routes for the interfaces located at the indexes that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>InterfaceMetric</maml:name>
<maml:description>
<maml:para>Specifies an array of integer interface metrics for network interfaces. The cmdlet gets IP routes for the interfaces that have the metric that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NextHop</maml:name>
<maml:description>
<maml:para>Specifies an array of next hop values. The cmdlet gets IP routes that have the next hop values that you specify. A value of 0.0.0.0 for IPv4 or :: for IPv6 indicates that the route is on the local subnet. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The cmdlet gets IP routes that have the PolicyStore value that you specify. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values for preferred lifetime, as TimeSpan objects, of IP routes. The cmdlet gets entries that have these values. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. For more information, type Get-Help New-TimeSpan. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Protocol</maml:name>
<maml:description>
<maml:para>Specifies an array of types of routing protocols. The cmdlet gets entries that use the protocols that you specify. The acceptable values for this parameter are:
-- Bbn
-- Bgp
-- Dhcp
-- Dvmrp
-- Egp
-- Eigrp
-- EsIs
-- Ggp
-- Hello
-- Icmp
-- Idpr
-- Igrp
-- IsIs
-- Local
-- NetMgmt
-- Ospf
-- Rip
-- Rpl
-- Other</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Protocol[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Publish</maml:name>
<maml:description>
<maml:para>Specifies an array of publish settings of IP routes. The cmdlet gets entries that have the publish values that you specify. The acceptable values for this parameter are:
-- No. Do not publish or advertise IP route information in router advertisements.
-- Yes. Publish and advertise IP route information with an infinite valid lifetime in router advertisements
-- Age. Publish and advertise IP route information with a finite valid lifetime in router advertisements.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Publish[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RouteMetric</maml:name>
<maml:description>
<maml:para>Specifies an array of integer route metrics for IP routes. The cmdlet gets entries that have the metrics that you specify. To choose among multiple routes, the computer adds this value to the interface metric value. The computer selects the route with the lowest combined value. To modify the interface metric, use the Set-NetIPInterface cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>State</maml:name>
<maml:description>
<maml:para>Specifies an array of state values for IP routes. The cmdlet gets entries that have the state values that you specify. </maml:para>
<maml:para>The acceptable values for this parameter are:
-- Alive
-- Dead
-- Probe</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">State[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values for valid lifetimes, as TimeSpan objects, for IP routes. The cmdlet gets entries that have the lifetimes that you specify. To obtain a TimeSpan object, use the New-Timespan cmdlet. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an IP address family. The cmdlet gets IP routes of the families that you specify. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
<dev:type>
<maml:name>AddressFamily[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedIPInterface</maml:name>
<maml:description>
<maml:para>Specifies an IP interface as a CIM object. The cmdlet gets IP routes that belong to the interface that you specify. To obtain an IP interface, use the Get-NetIPInterface cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
<dev:type>
<maml:name>CimInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CompartmentId</maml:name>
<maml:description>
<maml:para>Specifies an array of identifiers for network compartments in the protocol stack. By default, the cmdlet only gets Net routes in the default compartment. If you specify a value, the cmdlet gets any matching Net routes in all compartments in this field.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>DestinationPrefix</maml:name>
<maml:description>
<maml:para>Specifies an array of destination prefixes of IP routes. The cmdlet gets IP routes that use the prefixes that you specify. A destination prefix contains an IP address prefix and a prefix length, separated by a slash (/). A value of 0.0.0.0/0 for IPv4 or ::/0 for IPv6 indicates that the value of the NextHop parameter is a default gateway.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes routes from all configured network compartments. If you do not specify this parameter, the cmdlet gets only routes in the default network compartment. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet gets IP routes for the interfaces that have the aliases that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet gets IP routes for the interfaces located at the indexes that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>InterfaceMetric</maml:name>
<maml:description>
<maml:para>Specifies an array of integer interface metrics for network interfaces. The cmdlet gets IP routes for the interfaces that have the metric that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NextHop</maml:name>
<maml:description>
<maml:para>Specifies an array of next hop values. The cmdlet gets IP routes that have the next hop values that you specify. A value of 0.0.0.0 for IPv4 or :: for IPv6 indicates that the route is on the local subnet. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The cmdlet gets IP routes that have the PolicyStore value that you specify. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values for preferred lifetime, as TimeSpan objects, of IP routes. The cmdlet gets entries that have these values. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. For more information, type Get-Help New-TimeSpan. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
<dev:type>
<maml:name>TimeSpan[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Protocol</maml:name>
<maml:description>
<maml:para>Specifies an array of types of routing protocols. The cmdlet gets entries that use the protocols that you specify. The acceptable values for this parameter are:
-- Bbn
-- Bgp
-- Dhcp
-- Dvmrp
-- Egp
-- Eigrp
-- EsIs
-- Ggp
-- Hello
-- Icmp
-- Idpr
-- Igrp
-- IsIs
-- Local
-- NetMgmt
-- Ospf
-- Rip
-- Rpl
-- Other</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Protocol[]</command:parameterValue>
<dev:type>
<maml:name>Protocol[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Publish</maml:name>
<maml:description>
<maml:para>Specifies an array of publish settings of IP routes. The cmdlet gets entries that have the publish values that you specify. The acceptable values for this parameter are:
-- No. Do not publish or advertise IP route information in router advertisements.
-- Yes. Publish and advertise IP route information with an infinite valid lifetime in router advertisements
-- Age. Publish and advertise IP route information with a finite valid lifetime in router advertisements.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Publish[]</command:parameterValue>
<dev:type>
<maml:name>Publish[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RouteMetric</maml:name>
<maml:description>
<maml:para>Specifies an array of integer route metrics for IP routes. The cmdlet gets entries that have the metrics that you specify. To choose among multiple routes, the computer adds this value to the interface metric value. The computer selects the route with the lowest combined value. To modify the interface metric, use the Set-NetIPInterface cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
<dev:type>
<maml:name>UInt16[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>State</maml:name>
<maml:description>
<maml:para>Specifies an array of state values for IP routes. The cmdlet gets entries that have the state values that you specify. </maml:para>
<maml:para>The acceptable values for this parameter are:
-- Alive
-- Dead
-- Probe</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">State[]</command:parameterValue>
<dev:type>
<maml:name>State[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values for valid lifetimes, as TimeSpan objects, for IP routes. The cmdlet gets entries that have the lifetimes that you specify. To obtain a TimeSpan object, use the New-Timespan cmdlet. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
<dev:type>
<maml:name>TimeSpan[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetRoute</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get all routes</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetRoute | Format-List –Property *
</dev:code>
<dev:remarks>
<maml:para>This command gets all the routes for the computer, and then passes them to the Format-List cmdlet by using the pipeline operator. The Format-List cmdlet displays all the properties of an object. For more information, type Get-Help Format-List.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Get all IPv6 routes</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetRoute –AddressFamily IPv6
</dev:code>
<dev:remarks>
<maml:para>This command gets the routes that belong to the IPv6 address family. </maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 3: Get routes for a specified interface</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetRoute –InterfaceIndex 12
</dev:code>
<dev:remarks>
<maml:para>This command gets the IP routes associated with the interface that has an index of 12. </maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 4: Get the next hop for the default route</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetRoute –DestinationPrefix "0.0.0.0/0" | Select-Object –ExpandProperty "NextHop"
</dev:code>
<dev:remarks>
<maml:para>This command gets the next hop for the default route. The next hop gateway for the default route is also known as the default gateway. The command gets the default IP routes, and passes them to the Select-Object cmdlet. That cmdlet displays the NextHop property for each default route. For more information about displaying selected properties, type Get-Help Select-Object. </maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 5: Get IP routes to non-local destinations</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetRoute | Where-Object –FilterScript { $_.NextHop -Ne "::" } | Where-Object –FilterScript { $_.NextHop -Ne "0.0.0.0" } | Where-Object –FilterScript { ($_.NextHop.SubString(0,6) -Ne "fe80::") }
</dev:code>
<dev:remarks>
<maml:para>This command gets IP routes that have next hops that are not in the local subnet. The command gets all routes, and then passes them to a series of Where-Object commands by using the pipeline operator. The command uses different filter scripts to discard routes that are the default gateway for the two IP address families and the IPv6 addresses that begin with fe80. For more information about filtering by using Where-Object, type Get-Help Where-Object. </maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 6: Get network adapters that have IP routes to non-local destinations</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetRoute | Where-Object –FilterScript {$_.NextHop -Ne "::"} | Where-Object –FilterScript { $_.NextHop -Ne "0.0.0.0" } | Where-Object –FilterScript { ($_.NextHop.SubString(0,6) -Ne "fe80::") } | Get-NetAdapter
</dev:code>
<dev:remarks>
<maml:para>This command gets network adapters that have IP routes that have next hops that are not in the local subnet. As in the previous example, the command gets the routes that have next hop values by using the Get-NetRoute and the Where-Object cmdlets, and then passes those routes to the Get-NetAdapter cmdlet by using the pipeline operator.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 7: Get IP routes that have an infinite valid lifetime</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetRoute | Where-Object –FilterScript { $_.ValidLifetime -Eq ([TimeSpan]::MaxValue) }
</dev:code>
<dev:remarks>
<maml:para>This command gets all IP routes, and then passes them to the Where-Object cmdlet by using the pipeline operator. The command selects those routes that have a valid lifetime of the maximum value. </maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkID=288388</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetAdapter</maml:linkText>
<maml:uri>
</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Find-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetIPInterface</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>New-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-NetTCPConnection</command:name>
<maml:description>
<maml:para>Gets TCP connections. </maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>NetTCPConnection</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-NetTCPConnection cmdlet gets current TCP connections. Use this cmdlet to view TCP connection properties such as local or remote IP address, local or remote port, and connection state. </maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-NetTCPConnection</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="IPAddress">
<maml:name>LocalAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of local IP addresses. The cmdlet gets connections for the addresses that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>LocalPort</maml:name>
<maml:description>
<maml:para>Specifies an array of local ports. The cmdlet gets connections for the ports that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AppliedSetting</maml:name>
<maml:description>
<maml:para>Specifies an array of values of applied settings. The cmdlet gets connections that match the settings that you specify. The acceptable values for this parameter are:
-- Internet
-- Datacenter
-- Compat
-- Custom</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AppliedSetting[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CreationTime</maml:name>
<maml:description>
<maml:para>Specifies an array of DateTime objects. To get a DateTime object, use the Get-Date cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>OffloadState</maml:name>
<maml:description>
<maml:para>Specifies the offload state of a TCP connection.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">OffloadState[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>OwningProcess</maml:name>
<maml:description>
<maml:para>Specifies the PID of the owning process of a TCP connection.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RemoteAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of remote IP addresses. The cmdlet gets connections for the addresses that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RemotePort</maml:name>
<maml:description>
<maml:para>Specifies an array of remote ports. The cmdlet gets connections for the ports that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>State</maml:name>
<maml:description>
<maml:para>Specifies an array of TCP states. The cmdlet gets connections that match the states that you specify. The acceptable values for this parameter are:
-- Closed
-- CloseWait
-- Closing
-- DeleteTCB
-- Established
-- FinWait1
-- FinWait2
-- LastAck
-- Listen
-- SynReceived
-- SynSent
-- TimeWait </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">State[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AppliedSetting</maml:name>
<maml:description>
<maml:para>Specifies an array of values of applied settings. The cmdlet gets connections that match the settings that you specify. The acceptable values for this parameter are:
-- Internet
-- Datacenter
-- Compat
-- Custom</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AppliedSetting[]</command:parameterValue>
<dev:type>
<maml:name>AppliedSetting[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CreationTime</maml:name>
<maml:description>
<maml:para>Specifies an array of DateTime objects. To get a DateTime object, use the Get-Date cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue>
<dev:type>
<maml:name>DateTime[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="IPAddress">
<maml:name>LocalAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of local IP addresses. The cmdlet gets connections for the addresses that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>LocalPort</maml:name>
<maml:description>
<maml:para>Specifies an array of local ports. The cmdlet gets connections for the ports that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
<dev:type>
<maml:name>UInt16[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>OffloadState</maml:name>
<maml:description>
<maml:para>Specifies the offload state of a TCP connection.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">OffloadState[]</command:parameterValue>
<dev:type>
<maml:name>OffloadState[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>OwningProcess</maml:name>
<maml:description>
<maml:para>Specifies the PID of the owning process of a TCP connection.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RemoteAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of remote IP addresses. The cmdlet gets connections for the addresses that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RemotePort</maml:name>
<maml:description>
<maml:para>Specifies an array of remote ports. The cmdlet gets connections for the ports that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
<dev:type>
<maml:name>UInt16[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>State</maml:name>
<maml:description>
<maml:para>Specifies an array of TCP states. The cmdlet gets connections that match the states that you specify. The acceptable values for this parameter are:
-- Closed
-- CloseWait
-- Closing
-- DeleteTCB
-- Established
-- FinWait1
-- FinWait2
-- LastAck
-- Listen
-- SynReceived
-- SynSent
-- TimeWait </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">State[]</command:parameterValue>
<dev:type>
<maml:name>State[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetTCPConnection</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get all connections</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetTCPConnection
</dev:code>
<dev:remarks>
<maml:para>This command gets all current TCP connections. </maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Get established connections</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetTCPConnection –State Established
</dev:code>
<dev:remarks>
<maml:para>This command gets all TCP connections that have an Established state.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 3: Get Internet TCP connections</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetTCPConnection –AppliedSetting Internet
</dev:code>
<dev:remarks>
<maml:para>This command gets all TCP connections that use a TCP applied setting of Internet.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkID=288389</maml:uri>
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-NetTCPSetting</command:name>
<maml:description>
<maml:para>Gets information about TCP settings and configuration.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>NetTCPSetting</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-NetTCPSetting cmdlet gets TCP settings. TCP settings are optimized for different network conditions including latency and congestion. To apply a TCP setting to a port number or destination IP address range, create a transport filter by using the New-NetTransportFilter cmdlet. </maml:para>
<maml:para>Specify a setting to get by using the SettingName parameter, or by specifying a transport filter that is associated with a setting. Specify parameter values to determine which settings to get, or do not include any parameters to get all TCP settings.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-NetTCPSetting</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>SettingName</maml:name>
<maml:description>
<maml:para>Specifies an array of setting names. The acceptable values for this parameter are:
-- Internet. Optimized for networks with higher latency and lower throughput.
-- Datacenter. Optimized for networks with lower latency and higher throughput.
-- Compat. Optimized for compatibility with legacy network equipment.
-- Custom. Custom settings.
-- Automatic. The computer uses latency to select either Internet or Datacenter. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedTransportFilter</maml:name>
<maml:description>
<maml:para>Specifies CIM object for a transport filter associated with a setting. The cmdlet gets the setting for this transport filter. To obtain a transport filter, use the Get-NetTransportFilter cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutomaticUseCustom</maml:name>
<maml:description>
<maml:para>Specifies an array of values for whether the automatic profile assigns a custom template, either Datacenter Custom or Internet Custom, to a connection. The cmdlet gets settings that have the values you specify. The acceptable values for this parameter are:
-- True
-- False</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AutomaticUseCustom[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoReusePortRangeNumberOfPorts</maml:name>
<maml:description>
<maml:para>Specifies the number of ports for the auto-reuse port range, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. </maml:para>
<maml:para>If you specify 0, the auto-reuse feature is disabled and ephemeral ports are drawn instead from the dynamic port range as specified by DynamicPortRangeStartPort and DynamicPortRangeNumberOfPorts, even if SO_REUSE_UNICASTPORT is set on a socket.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoReusePortRangeStartPort</maml:name>
<maml:description>
<maml:para>Specifies the number of ports for the auto-reuse port range, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. </maml:para>
<maml:para>If you specify 0, the auto-reuse feature is disabled and ephemeral ports are drawn instead from the dynamic port range as specified by DynamicPortRangeStartPort and DynamicPortRangeNumberOfPorts, even if SO_REUSE_UNICASTPORT is set on a socket.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoTuningLevelEffective</maml:name>
<maml:description>
<maml:para>Specifies an array of values of the TCP auto-tuning level effective property. The cmdlet gets settings that the values that you specify. This property can improve throughput for high thoughput, high latency networks. The acceptable values for this parameter are:
-- Local
-- GroupPolicy </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AutoTuningLevelEffective[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoTuningLevelGroupPolicy</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the group policy for the auto-tuning level. The cmdlet gets settings that have the values that you specify. This property determines the setting of the TCP auto-tuning level that group policy configures. A group policy applies uniformly across all NetTcpSetting objects. The auto-tuning level can improve throughput for high thoughput, high latency networks. The acceptable values for this parameter are:
-- Disabled
-- HighlyRestricted
-- Restricted
-- Normal
-- Experimental
-- NotConfigured
-- NotChanged</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AutoTuningLevelGroupPolicy[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoTuningLevelLocal</maml:name>
<maml:description>
<maml:para>Specifies an array of TCP auto-tuning levels for the host computer. The cmdlet gets settings that have the values that you specify. TCP auto-tuning can improve throughput on high throughput, high latency networks. The acceptable values for this parameter are:
-- Disabled. Sets the TCP receive window to the default value.
-- HighlyRestricted. Sets the TCP receive window to grow beyond the default value, but very conservatively.
-- Restricted. Sets the TCP receive window to grow beyond the default value, but less conservatively than HighlyRestricted.
-- Normal. Sets the TCP receive window to grow to accommodate almost all scenarios.
-- Experimental. Sets the TCP receive window to grow to accommodate extreme scenarios.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AutoTuningLevelLocal[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CongestionProvider</maml:name>
<maml:description>
<maml:para>Specifies an array of congestion provider properties that TCP uses. The cmdlet gets settings that have the congestion provider values that you specify. The acceptable values for this parameter are:
-- CTCP. Compound TCP increases the receive window and amount of data sent. This value can improve throughput on higher latency connections.
-- DCTCP. Data Center TCP adjusts the TCP window based on network congestion feedback based on Explicit Congestion Notification (ECN) signaling. This value can improve throughput on low latency links.
-- Default. Servers use Data Center TCP by default. Clients use NewReno. For information about NewReno, see <maml:navigationLink><maml:linkText>RFC 3782</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.ietf.org/rfc/rfc3782.txt).</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CongestionProvider[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CwndRestart</maml:name>
<maml:description>
<maml:para>Specifies an array of values that determine whether to enable congestion window restart. The cmdlet gets settings that have the congestion window restart values that you specify. Congestion window restart can avoid slow start to optimize throughput on low latency networks. For more information about congestion window restart, see <maml:navigationLink><maml:linkText>RFC 2581</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.ietf.org/rfc/rfc2581.txt). The acceptable values for this parameter are:
-- True. TCP uses congestion window restart.
-- False. TCP uses the default setting of the connection.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CwndRestart[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DelayedAckFrequency</maml:name>
<maml:description>
<maml:para>Specifies an array of numbers of acknowledgments (ACKs) received before the computer sends a response. The cmdlet gets settings that have the delayed ACK frequency values that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Byte[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="DelayedAckTimeout">
<maml:name>DelayedAckTimeoutMs</maml:name>
<maml:description>
<maml:para>Specifies an array of the time to wait, in milliseconds, before the computer sends an ACK if the computer receives fewer than delayed acknowledgment frequency of packets. The cmdlet gets settings that have the delayed ACK timeout values that you specify. Use the DelayedAckFrequency parameter to specify the delayed ACK frequency value. Reducing the time to wait can increase throughput on low latency networks by accelerating growth in TCP window size. The acceptable values for this parameter are: increments of 10, from 10 through 600. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DynamicPortRangeNumberOfPorts</maml:name>
<maml:description>
<maml:para>Specifies an array of the number of ports for the dynamic port range that starts from the port that you specify for the DynamicPortRangeStartPort parameter. The cmdlet gets settings that have the numbers of ports that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DynamicPortRangeStartPort</maml:name>
<maml:description>
<maml:para>Specifies an array of starting ports for dynamic port ranges. The acceptable values for this parameter are: 1 through 65535. The cmdlet gets settings that have the starting ports that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EcnCapability</maml:name>
<maml:description>
<maml:para>Specifies an array of values that determine whether to enable ECN capability. The cmdlet gets settings that have ECN capability value that you specify. The acceptable values for this parameter are:
-- Enabled. Uses ECN capability.
-- Disabled. Does not use ECN capability. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">EcnCapability[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ForceWS</maml:name>
<maml:description>
<maml:para>Specifies an array of values that determine whether to force window scaling for retransmission. The cmdlet gets settings that have the force window scaling value that you specify. The acceptable values for this parameter are:
-- Enabled. Requires window scaling for retransmission.
-- Disabled. Does not require window scaling for retransmission. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">ForceWS[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="InitialCongestionWindow">
<maml:name>InitialCongestionWindowMss</maml:name>
<maml:description>
<maml:para>Specifies an array of initial sizes of the congestion window. The cmdlet gets settings that have the initial congestion window value that you specify. Provide a value to multiply by the maximum segment size (MMS). The acceptable values for this parameter are: an even number from 2 through 64.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="InitialRto">
<maml:name>InitialRtoMs</maml:name>
<maml:description>
<maml:para>Specifies the period, in milliseconds, before connect, or SYN, retransmit. The cmdlet gets settings that have the initial connect retransmit values that you specify. The acceptable values for this parameter are: increments of 10, from 300 ms through 3000 ms. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MaxSynRetransmissions</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of times the computers sends SYN packets without receiving a response. The cmdlet gets settings that have the maxium values that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Byte[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MemoryPressureProtection</maml:name>
<maml:description>
<maml:para>Specifies an array of values that determines whether to use memory pressure protection. The cmdlet gets settings that have the memory pressure protection values that you specify. TCP memory pressure protection helps ensure that a computer continues normal operation when low on memory due to denial of service attacks. The acceptable values for this parameter are:
-- Enabled. When low on memory, during an attack, close existing TCP connections and drop incoming SYN requests.
-- Disabled. Do not use memory pressure protection.
-- Default. Use the computer default value for memory pressure protection. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">MemoryPressureProtection[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="MinRto">
<maml:name>MinRtoMs</maml:name>
<maml:description>
<maml:para>Specifies an array of values, in milliseconds, for the TCP retransmission to time out. The cmdlet gets settings that have the timeout values that you specify. The acceptable values for this parameter are: increments of 10, from 20 ms through 300 ms.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NonSackRttResiliency</maml:name>
<maml:description>
<maml:para>Specifies an array of values that determine whether to enable round trip time resiliency for clients that do not support selective acknowledgment. The cmdlet gets settings that have the enable round trip time resiliency values that you specify. The acceptable values for this parameter are:
-- Enabled.
-- Disabled. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">NonSackRttResiliency[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ScalingHeuristics</maml:name>
<maml:description>
<maml:para>Specifies an array of values that determine whether to enable scaling heuristics. The cmdlet gets settings that have scaling heuristics values that you specify. The acceptable values for this parameter are:
-- Enabled
-- Disabled </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">ScalingHeuristics[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Timestamps</maml:name>
<maml:description>
<maml:para>Specifies an array of values that determine whether to enable timestamps. The cmdlet gets settings that have the enable timestamps values that you specify. Timestamps facilitate round trip measurement, and can help protect against wrapped sequence numbers on high throughput links. For more information about TCP timestamps, see <maml:navigationLink><maml:linkText>RFC 1323</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.ietf.org/rfc/rfc1323.txt). The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Timestamps[]</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedTransportFilter</maml:name>
<maml:description>
<maml:para>Specifies CIM object for a transport filter associated with a setting. The cmdlet gets the setting for this transport filter. To obtain a transport filter, use the Get-NetTransportFilter cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
<dev:type>
<maml:name>CimInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutomaticUseCustom</maml:name>
<maml:description>
<maml:para>Specifies an array of values for whether the automatic profile assigns a custom template, either Datacenter Custom or Internet Custom, to a connection. The cmdlet gets settings that have the values you specify. The acceptable values for this parameter are:
-- True
-- False</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AutomaticUseCustom[]</command:parameterValue>
<dev:type>
<maml:name>AutomaticUseCustom[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoReusePortRangeNumberOfPorts</maml:name>
<maml:description>
<maml:para>Specifies the number of ports for the auto-reuse port range, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. </maml:para>
<maml:para>If you specify 0, the auto-reuse feature is disabled and ephemeral ports are drawn instead from the dynamic port range as specified by DynamicPortRangeStartPort and DynamicPortRangeNumberOfPorts, even if SO_REUSE_UNICASTPORT is set on a socket.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
<dev:type>
<maml:name>UInt16[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoReusePortRangeStartPort</maml:name>
<maml:description>
<maml:para>Specifies the number of ports for the auto-reuse port range, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. </maml:para>
<maml:para>If you specify 0, the auto-reuse feature is disabled and ephemeral ports are drawn instead from the dynamic port range as specified by DynamicPortRangeStartPort and DynamicPortRangeNumberOfPorts, even if SO_REUSE_UNICASTPORT is set on a socket.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
<dev:type>
<maml:name>UInt16[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoTuningLevelEffective</maml:name>
<maml:description>
<maml:para>Specifies an array of values of the TCP auto-tuning level effective property. The cmdlet gets settings that the values that you specify. This property can improve throughput for high thoughput, high latency networks. The acceptable values for this parameter are:
-- Local
-- GroupPolicy </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AutoTuningLevelEffective[]</command:parameterValue>
<dev:type>
<maml:name>AutoTuningLevelEffective[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoTuningLevelGroupPolicy</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the group policy for the auto-tuning level. The cmdlet gets settings that have the values that you specify. This property determines the setting of the TCP auto-tuning level that group policy configures. A group policy applies uniformly across all NetTcpSetting objects. The auto-tuning level can improve throughput for high thoughput, high latency networks. The acceptable values for this parameter are:
-- Disabled
-- HighlyRestricted
-- Restricted
-- Normal
-- Experimental
-- NotConfigured
-- NotChanged</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AutoTuningLevelGroupPolicy[]</command:parameterValue>
<dev:type>
<maml:name>AutoTuningLevelGroupPolicy[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoTuningLevelLocal</maml:name>
<maml:description>
<maml:para>Specifies an array of TCP auto-tuning levels for the host computer. The cmdlet gets settings that have the values that you specify. TCP auto-tuning can improve throughput on high throughput, high latency networks. The acceptable values for this parameter are:
-- Disabled. Sets the TCP receive window to the default value.
-- HighlyRestricted. Sets the TCP receive window to grow beyond the default value, but very conservatively.
-- Restricted. Sets the TCP receive window to grow beyond the default value, but less conservatively than HighlyRestricted.
-- Normal. Sets the TCP receive window to grow to accommodate almost all scenarios.
-- Experimental. Sets the TCP receive window to grow to accommodate extreme scenarios.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AutoTuningLevelLocal[]</command:parameterValue>
<dev:type>
<maml:name>AutoTuningLevelLocal[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CongestionProvider</maml:name>
<maml:description>
<maml:para>Specifies an array of congestion provider properties that TCP uses. The cmdlet gets settings that have the congestion provider values that you specify. The acceptable values for this parameter are:
-- CTCP. Compound TCP increases the receive window and amount of data sent. This value can improve throughput on higher latency connections.
-- DCTCP. Data Center TCP adjusts the TCP window based on network congestion feedback based on Explicit Congestion Notification (ECN) signaling. This value can improve throughput on low latency links.
-- Default. Servers use Data Center TCP by default. Clients use NewReno. For information about NewReno, see <maml:navigationLink><maml:linkText>RFC 3782</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.ietf.org/rfc/rfc3782.txt).</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CongestionProvider[]</command:parameterValue>
<dev:type>
<maml:name>CongestionProvider[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CwndRestart</maml:name>
<maml:description>
<maml:para>Specifies an array of values that determine whether to enable congestion window restart. The cmdlet gets settings that have the congestion window restart values that you specify. Congestion window restart can avoid slow start to optimize throughput on low latency networks. For more information about congestion window restart, see <maml:navigationLink><maml:linkText>RFC 2581</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.ietf.org/rfc/rfc2581.txt). The acceptable values for this parameter are:
-- True. TCP uses congestion window restart.
-- False. TCP uses the default setting of the connection.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CwndRestart[]</command:parameterValue>
<dev:type>
<maml:name>CwndRestart[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DelayedAckFrequency</maml:name>
<maml:description>
<maml:para>Specifies an array of numbers of acknowledgments (ACKs) received before the computer sends a response. The cmdlet gets settings that have the delayed ACK frequency values that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Byte[]</command:parameterValue>
<dev:type>
<maml:name>Byte[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="DelayedAckTimeout">
<maml:name>DelayedAckTimeoutMs</maml:name>
<maml:description>
<maml:para>Specifies an array of the time to wait, in milliseconds, before the computer sends an ACK if the computer receives fewer than delayed acknowledgment frequency of packets. The cmdlet gets settings that have the delayed ACK timeout values that you specify. Use the DelayedAckFrequency parameter to specify the delayed ACK frequency value. Reducing the time to wait can increase throughput on low latency networks by accelerating growth in TCP window size. The acceptable values for this parameter are: increments of 10, from 10 through 600. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DynamicPortRangeNumberOfPorts</maml:name>
<maml:description>
<maml:para>Specifies an array of the number of ports for the dynamic port range that starts from the port that you specify for the DynamicPortRangeStartPort parameter. The cmdlet gets settings that have the numbers of ports that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
<dev:type>
<maml:name>UInt16[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DynamicPortRangeStartPort</maml:name>
<maml:description>
<maml:para>Specifies an array of starting ports for dynamic port ranges. The acceptable values for this parameter are: 1 through 65535. The cmdlet gets settings that have the starting ports that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
<dev:type>
<maml:name>UInt16[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EcnCapability</maml:name>
<maml:description>
<maml:para>Specifies an array of values that determine whether to enable ECN capability. The cmdlet gets settings that have ECN capability value that you specify. The acceptable values for this parameter are:
-- Enabled. Uses ECN capability.
-- Disabled. Does not use ECN capability. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">EcnCapability[]</command:parameterValue>
<dev:type>
<maml:name>EcnCapability[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ForceWS</maml:name>
<maml:description>
<maml:para>Specifies an array of values that determine whether to force window scaling for retransmission. The cmdlet gets settings that have the force window scaling value that you specify. The acceptable values for this parameter are:
-- Enabled. Requires window scaling for retransmission.
-- Disabled. Does not require window scaling for retransmission. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">ForceWS[]</command:parameterValue>
<dev:type>
<maml:name>ForceWS[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="InitialCongestionWindow">
<maml:name>InitialCongestionWindowMss</maml:name>
<maml:description>
<maml:para>Specifies an array of initial sizes of the congestion window. The cmdlet gets settings that have the initial congestion window value that you specify. Provide a value to multiply by the maximum segment size (MMS). The acceptable values for this parameter are: an even number from 2 through 64.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="InitialRto">
<maml:name>InitialRtoMs</maml:name>
<maml:description>
<maml:para>Specifies the period, in milliseconds, before connect, or SYN, retransmit. The cmdlet gets settings that have the initial connect retransmit values that you specify. The acceptable values for this parameter are: increments of 10, from 300 ms through 3000 ms. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MaxSynRetransmissions</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of times the computers sends SYN packets without receiving a response. The cmdlet gets settings that have the maxium values that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Byte[]</command:parameterValue>
<dev:type>
<maml:name>Byte[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MemoryPressureProtection</maml:name>
<maml:description>
<maml:para>Specifies an array of values that determines whether to use memory pressure protection. The cmdlet gets settings that have the memory pressure protection values that you specify. TCP memory pressure protection helps ensure that a computer continues normal operation when low on memory due to denial of service attacks. The acceptable values for this parameter are:
-- Enabled. When low on memory, during an attack, close existing TCP connections and drop incoming SYN requests.
-- Disabled. Do not use memory pressure protection.
-- Default. Use the computer default value for memory pressure protection. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">MemoryPressureProtection[]</command:parameterValue>
<dev:type>
<maml:name>MemoryPressureProtection[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="MinRto">
<maml:name>MinRtoMs</maml:name>
<maml:description>
<maml:para>Specifies an array of values, in milliseconds, for the TCP retransmission to time out. The cmdlet gets settings that have the timeout values that you specify. The acceptable values for this parameter are: increments of 10, from 20 ms through 300 ms.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NonSackRttResiliency</maml:name>
<maml:description>
<maml:para>Specifies an array of values that determine whether to enable round trip time resiliency for clients that do not support selective acknowledgment. The cmdlet gets settings that have the enable round trip time resiliency values that you specify. The acceptable values for this parameter are:
-- Enabled.
-- Disabled. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">NonSackRttResiliency[]</command:parameterValue>
<dev:type>
<maml:name>NonSackRttResiliency[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ScalingHeuristics</maml:name>
<maml:description>
<maml:para>Specifies an array of values that determine whether to enable scaling heuristics. The cmdlet gets settings that have scaling heuristics values that you specify. The acceptable values for this parameter are:
-- Enabled
-- Disabled </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">ScalingHeuristics[]</command:parameterValue>
<dev:type>
<maml:name>ScalingHeuristics[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>SettingName</maml:name>
<maml:description>
<maml:para>Specifies an array of setting names. The acceptable values for this parameter are:
-- Internet. Optimized for networks with higher latency and lower throughput.
-- Datacenter. Optimized for networks with lower latency and higher throughput.
-- Compat. Optimized for compatibility with legacy network equipment.
-- Custom. Custom settings.
-- Automatic. The computer uses latency to select either Internet or Datacenter. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Timestamps</maml:name>
<maml:description>
<maml:para>Specifies an array of values that determine whether to enable timestamps. The cmdlet gets settings that have the enable timestamps values that you specify. Timestamps facilitate round trip measurement, and can help protect against wrapped sequence numbers on high throughput links. For more information about TCP timestamps, see <maml:navigationLink><maml:linkText>RFC 1323</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.ietf.org/rfc/rfc1323.txt). The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Timestamps[]</command:parameterValue>
<dev:type>
<maml:name>Timestamps[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetTCPSetting</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get all TCP settings</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetTCPSetting
</dev:code>
<dev:remarks>
<maml:para>This command gets TCP settings. The command specifies no parameters, so it gets all TCP settings.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Get Internet TCP settings</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetTCPSetting –Setting Internet
</dev:code>
<dev:remarks>
<maml:para>This command gets TCP settings that are optimized for connectivity across the Internet.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 3: View formatted TCP settings</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetTcpSetting | Format-Table
</dev:code>
<dev:remarks>
<maml:para>This command gets TCP settings, and then passes them to the Format-Table cmdlet by using the pipeline operator. That cmdlet displays the results as a summary in a table view. For more information, type Get-Help Format-Table.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkID=288390</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>New-NetTransportFilter</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetTCPSetting</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-NetTransportFilter</command:name>
<maml:description>
<maml:para>Gets transport filters.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>NetTransportFilter</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-NetTransportFilter cmdlet gets transport filters. A transport filter specifies the TCP settings, as a NetTcpSetting object, to apply to an IP address prefix or a TCP port range. Use the cmdlet without parameters to get all transport filters for the computer. </maml:para>
<maml:para>Use the New-NetTransportFilter cmdlet to create transport filters, and use the Remove-NetTransportFilter cmdlet to remove filters.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-NetTransportFilter</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none">
<maml:name>AssociatedTCPSetting</maml:name>
<maml:description>
<maml:para>Specifies a NetTCPSetting object. The cmdlet gets transport filters associated with the setting that you specify. To obtain a NetTCPSetting object, use the Get-NetTCPSetting cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DestinationPrefix</maml:name>
<maml:description>
<maml:para>Specifies an array of destination prefixes of IP routes. The cmdlet gets transport filters that have the prefixes that you specify. A destination prefix consists of an IP address prefix and a prefix length, separated by a slash (/).</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LocalPortEnd</maml:name>
<maml:description>
<maml:para>Specifies an array of upper bounds of ranges of local TCP ports. The cmdlet removes transport filters that have the upper bounds that you specify. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LocalPortStart</maml:name>
<maml:description>
<maml:para>Specifies an array of lower bounds of ranges of local TCP ports. The cmdlet removes transport filters that have the lower bounds that you specify. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Protocol</maml:name>
<maml:description>
<maml:para>Specifies an array of types of routing protocols. The cmdlet gets transport filters based on the protocols that you specify. The acceptable values for this parameter are:
-- Bbn
-- Bgp
-- Dhcp
-- Dvmrp
-- Egp
-- Eigrp
-- EsIs
-- Ggp
-- Hello
-- Icmp
-- Idpr
-- Igrp
-- IsIs
-- Local
-- NetMgmt
-- Ospf
-- Rip
-- Rpl
-- Other</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Protocol[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RemotePortEnd</maml:name>
<maml:description>
<maml:para>Specifies an array of upper bounds of ranges of remote TCP ports. The cmdlet removes transport filters that have the upper bounds that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RemotePortStart</maml:name>
<maml:description>
<maml:para>Specifies an array of lower bounds of a ranges of remote TCP ports. The cmdlet removes transport filters that have the lower bounds that you specify. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SettingName</maml:name>
<maml:description>
<maml:para>Specifies an array of setting names. The cmdlet gets transport filters that have the settings that you specify. The acceptable values for this parameter are:
-- Internet
-- Datacenter
-- Compat
-- Custom</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none">
<maml:name>AssociatedTCPSetting</maml:name>
<maml:description>
<maml:para>Specifies a NetTCPSetting object. The cmdlet gets transport filters associated with the setting that you specify. To obtain a NetTCPSetting object, use the Get-NetTCPSetting cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
<dev:type>
<maml:name>CimInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DestinationPrefix</maml:name>
<maml:description>
<maml:para>Specifies an array of destination prefixes of IP routes. The cmdlet gets transport filters that have the prefixes that you specify. A destination prefix consists of an IP address prefix and a prefix length, separated by a slash (/).</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LocalPortEnd</maml:name>
<maml:description>
<maml:para>Specifies an array of upper bounds of ranges of local TCP ports. The cmdlet removes transport filters that have the upper bounds that you specify. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
<dev:type>
<maml:name>UInt16[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LocalPortStart</maml:name>
<maml:description>
<maml:para>Specifies an array of lower bounds of ranges of local TCP ports. The cmdlet removes transport filters that have the lower bounds that you specify. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
<dev:type>
<maml:name>UInt16[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Protocol</maml:name>
<maml:description>
<maml:para>Specifies an array of types of routing protocols. The cmdlet gets transport filters based on the protocols that you specify. The acceptable values for this parameter are:
-- Bbn
-- Bgp
-- Dhcp
-- Dvmrp
-- Egp
-- Eigrp
-- EsIs
-- Ggp
-- Hello
-- Icmp
-- Idpr
-- Igrp
-- IsIs
-- Local
-- NetMgmt
-- Ospf
-- Rip
-- Rpl
-- Other</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Protocol[]</command:parameterValue>
<dev:type>
<maml:name>Protocol[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RemotePortEnd</maml:name>
<maml:description>
<maml:para>Specifies an array of upper bounds of ranges of remote TCP ports. The cmdlet removes transport filters that have the upper bounds that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
<dev:type>
<maml:name>UInt16[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RemotePortStart</maml:name>
<maml:description>
<maml:para>Specifies an array of lower bounds of a ranges of remote TCP ports. The cmdlet removes transport filters that have the lower bounds that you specify. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
<dev:type>
<maml:name>UInt16[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SettingName</maml:name>
<maml:description>
<maml:para>Specifies an array of setting names. The cmdlet gets transport filters that have the settings that you specify. The acceptable values for this parameter are:
-- Internet
-- Datacenter
-- Compat
-- Custom</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetTransportFilter</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get all transport filters</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetTransportFilter
</dev:code>
<dev:remarks>
<maml:para>This command gets all the transport filters on the computer. </maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Get transport filters that apply specified settings</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetTransportFilter –SettingName Internet
</dev:code>
<dev:remarks>
<maml:para>This command gets transport filters that apply Internet settings.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkID=288391</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetUDPSetting</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>New-NetTransportFilter</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-NetTransportFilter</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetTCPSetting</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetUDPSetting</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-NetUDPEndpoint</command:name>
<maml:description>
<maml:para>Gets current UDP endpoint statistics.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>NetUDPEndpoint</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-NetUDPEndpoint cmdlet gets current statistics for a UDP endpoint. The cmdlet returns UDP end point properties, such as local and remote UDP ports. If you do not specify any parameters, the cmdlet gets statistics for all UDP end points.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-NetUDPEndpoint</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="IPAddress">
<maml:name>LocalAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of local IP addresses. The cmdlet gets the UDP endpoint statistics that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>LocalPort</maml:name>
<maml:description>
<maml:para>Specifies an array of local ports. The cmdlet gets the UDP endpoint statistics that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CreationTime</maml:name>
<maml:description>
<maml:para>Specifies an array of DateTime objects. To get a DateTime object, use the Get-Date cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>OwningProcess</maml:name>
<maml:description>
<maml:para>Specifies the PID of the owning process of a bound UDP socket.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CreationTime</maml:name>
<maml:description>
<maml:para>Specifies an array of DateTime objects. To get a DateTime object, use the Get-Date cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue>
<dev:type>
<maml:name>DateTime[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="IPAddress">
<maml:name>LocalAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of local IP addresses. The cmdlet gets the UDP endpoint statistics that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>LocalPort</maml:name>
<maml:description>
<maml:para>Specifies an array of local ports. The cmdlet gets the UDP endpoint statistics that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
<dev:type>
<maml:name>UInt16[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>OwningProcess</maml:name>
<maml:description>
<maml:para>Specifies the PID of the owning process of a bound UDP socket.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetUDPEndpoint</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get statistics for all UDP endpoints</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetUDPEndpoint
</dev:code>
<dev:remarks>
<maml:para>This example gets current statistics for all UDP endpoints.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Get statistics for UDP traffic</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetUDPEndpoint –LocalAddress 127.0.0.1
</dev:code>
<dev:remarks>
<maml:para>This command gets statistics for recent UDP traffic that was sent and received on the IPv4 loopback address.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=288392</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetUDPSetting</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetUDPEndpoint</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Get-NetUDPSetting</command:name>
<maml:description>
<maml:para>Gets UDP settings.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>NetUDPSetting</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Get-NetUDPSetting cmdlet gets UDP settings for the IP interface. The cmdlet gets the starting port and the number of ports for a dynamic port range that the IP interface uses to send and receive UDP traffic. Use this cmdlet with the Set-NetUDPSetting to specify a dynamic port range to modify. If you do not specify any parameters, the cmdlet gets all dynamic port ranges for UDP from the IP interface.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-NetUDPSetting</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>DynamicPortRangeStartPort</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the starting port of the dynamic port range. The cmdlet gets the UDP settings that have these values. The acceptable values for this parameter are: 1 through 65535.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>DynamicPortRangeNumberOfPorts</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the number of ports for a dynamic port range that starts from the port that you specify for the DynamicPortRangeStartPort parameter. The cmdlet gets the UDP settings that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>DynamicPortRangeNumberOfPorts</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the number of ports for a dynamic port range that starts from the port that you specify for the DynamicPortRangeStartPort parameter. The cmdlet gets the UDP settings that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
<dev:type>
<maml:name>UInt16[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>DynamicPortRangeStartPort</maml:name>
<maml:description>
<maml:para>Specifies an array of values for the starting port of the dynamic port range. The cmdlet gets the UDP settings that have these values. The acceptable values for this parameter are: 1 through 65535.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
<dev:type>
<maml:name>UInt16[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetUDPSetting</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Get all dynamic port ranges for UDP</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetUDPSetting
</dev:code>
<dev:remarks>
<maml:para>This command gets all UDP settings. The command gets all dynamic port ranges for UDP from the IP interface.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=288393</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetTransportFilter</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetTCPSetting</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetUDPSetting</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>New-NetIPAddress</command:name>
<maml:description>
<maml:para>Creates and configures an IP address.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>New</command:verb>
<command:noun>NetIPAddress</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The New-NetIPAddress cmdlet creates and configures an IP address. To create a specific IP address object, specify either an IPv4 address or an IPv6 address, and an interface index or interface alias. We recommend that you define the prefix length, also known as a subnet mask, and a default gateway.</maml:para>
<maml:para>If you run this cmdlet to add an IP address to an interface on which DHCP is already enabled, then DHCP is automatically disabled. If Duplicate Address Detection (DAD) is enabled on the interface, the new IP address is not usable until DAD successfully finishes, which confirms the uniqueness of the IP address on the link.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>New-NetIPAddress</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="LocalAddress">
<maml:name>IPAddress</maml:name>
<maml:description>
<maml:para>Specifies the IPv4 or IPv6 address to create.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an IP address family. The cmdlet creates an IP address for the family. If you do not specify this parameter, the property is automatically generated. The acceptable values for this parameter are:
-- IPv4
-- IPv6 </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">IPv4</command:parameterValue>
<command:parameterValue required="false" variableLength="false">IPv6</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DefaultGateway</maml:name>
<maml:description>
<maml:para>Specifies the IPv4 address or IPv6 address of the default gateway for the host. Default gateways provide a default route for TCP/IP hosts to use when communicating with other hosts on remote networks.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
The default value is ActiveStore. Specify ActiveStore only.</maml:para>
<maml:para>If you do not specify this parameter, the default entries are created in both the ActiveStore and the PersistentStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies a preferred lifetime, as a TimeSpan object, for an IP address. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PrefixLength</maml:name>
<maml:description>
<maml:para>Specifies a prefix length. This parameter defines the local subnet size, and is also known as a subnet mask.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Byte</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SkipAsSource</maml:name>
<maml:description>
<maml:para>Indicates whether an address is a primary IP address. This parameter identifies the primary IP address for outgoing traffic in a multiple IP address scenario. If this parameter is set to True, the addresses are not used for outgoing traffic and are not registered in DNS.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Type</maml:name>
<maml:description>
<maml:para>Specifies an IP address type. The acceptable values for this parameter are:
-- Unicast
-- Anycast
The default value is Unicast.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Unicast</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Anycast</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies a valid lifetime value, as a TimeSpan object, for an IP address. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an alias of a network interface. The cmdlet creates an IP address for the alias.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>New-NetIPAddress</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="LocalAddress">
<maml:name>IPAddress</maml:name>
<maml:description>
<maml:para>Specifies the IPv4 or IPv6 address to create.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an IP address family. The cmdlet creates an IP address for the family. If you do not specify this parameter, the property is automatically generated. The acceptable values for this parameter are:
-- IPv4
-- IPv6 </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">IPv4</command:parameterValue>
<command:parameterValue required="false" variableLength="false">IPv6</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DefaultGateway</maml:name>
<maml:description>
<maml:para>Specifies the IPv4 address or IPv6 address of the default gateway for the host. Default gateways provide a default route for TCP/IP hosts to use when communicating with other hosts on remote networks.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
The default value is ActiveStore. Specify ActiveStore only.</maml:para>
<maml:para>If you do not specify this parameter, the default entries are created in both the ActiveStore and the PersistentStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies a preferred lifetime, as a TimeSpan object, for an IP address. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PrefixLength</maml:name>
<maml:description>
<maml:para>Specifies a prefix length. This parameter defines the local subnet size, and is also known as a subnet mask.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Byte</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SkipAsSource</maml:name>
<maml:description>
<maml:para>Indicates whether an address is a primary IP address. This parameter identifies the primary IP address for outgoing traffic in a multiple IP address scenario. If this parameter is set to True, the addresses are not used for outgoing traffic and are not registered in DNS.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Type</maml:name>
<maml:description>
<maml:para>Specifies an IP address type. The acceptable values for this parameter are:
-- Unicast
-- Anycast
The default value is Unicast.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Unicast</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Anycast</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies a valid lifetime value, as a TimeSpan object, for an IP address. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an index of a network interface. The cmdlet creates an IP address for the index.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an IP address family. The cmdlet creates an IP address for the family. If you do not specify this parameter, the property is automatically generated. The acceptable values for this parameter are:
-- IPv4
-- IPv6 </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">AddressFamily</command:parameterValue>
<dev:type>
<maml:name>AddressFamily</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DefaultGateway</maml:name>
<maml:description>
<maml:para>Specifies the IPv4 address or IPv6 address of the default gateway for the host. Default gateways provide a default route for TCP/IP hosts to use when communicating with other hosts on remote networks.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an alias of a network interface. The cmdlet creates an IP address for the alias.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an index of a network interface. The cmdlet creates an IP address for the index.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="LocalAddress">
<maml:name>IPAddress</maml:name>
<maml:description>
<maml:para>Specifies the IPv4 or IPv6 address to create.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
The default value is ActiveStore. Specify ActiveStore only.</maml:para>
<maml:para>If you do not specify this parameter, the default entries are created in both the ActiveStore and the PersistentStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies a preferred lifetime, as a TimeSpan object, for an IP address. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
<dev:type>
<maml:name>TimeSpan</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PrefixLength</maml:name>
<maml:description>
<maml:para>Specifies a prefix length. This parameter defines the local subnet size, and is also known as a subnet mask.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Byte</command:parameterValue>
<dev:type>
<maml:name>Byte</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SkipAsSource</maml:name>
<maml:description>
<maml:para>Indicates whether an address is a primary IP address. This parameter identifies the primary IP address for outgoing traffic in a multiple IP address scenario. If this parameter is set to True, the addresses are not used for outgoing traffic and are not registered in DNS.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Type</maml:name>
<maml:description>
<maml:para>Specifies an IP address type. The acceptable values for this parameter are:
-- Unicast
-- Anycast
The default value is Unicast.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Type</command:parameterValue>
<dev:type>
<maml:name>Type</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies a valid lifetime value, as a TimeSpan object, for an IP address. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
<dev:type>
<maml:name>TimeSpan</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetIPAddress</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Add an IPv4 address</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>
PS C:\>New-NetIPAddress –InterfaceIndex 12 –IPAddress 192.168.0.1 -PrefixLength 24 -DefaultGateway 192.168.0.5
The second command removes the IPv4 address. To remove the IPv4 address, use the Remove-NetIPAddress cmdlet.
PS C:\>Remove-NetIPAddress –IPAddress 192.168.0.1 -DefaultGateway 192.168.0.5
</dev:code>
<dev:remarks>
<maml:para>The first command adds a new IPv4 address to the network interface at index 12. The PrefixLength parameter specifies the subnet mask for the IP address. In this example, the PrefixLength of 24 equals a subnet mask of 255.255.255.0. When you add an IPv4 address, the address specified for the Default Gateway must be in the same subnet as the IPv4 address that you add.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=288394</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetIPAddress</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-NetIPAddress</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetIPAddress</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>New-NetNeighbor</command:name>
<maml:description>
<maml:para>Creates a neighbor cache entry.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>New</command:verb>
<command:noun>NetNeighbor</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The New-NetNeighbor cmdlet creates a neighbor cache entry. The neighbor cache maintains information for each on-link neighbor, including the IP address and the associated link-layer address. The address family that you specify for the neighbor cache entry must match the address family of the IP interface.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>New-NetNeighbor</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>IPAddress</maml:name>
<maml:description>
<maml:para>Specifies an IP address. The cmdlet adds a neighbor cache entry that has the IP address you specify.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies the IP address family. The cmdlet adds a neighbor cache entry that belongs to the IP address family you specify. If you do not specify this parameter, the cmdlet automatically generates the address families of the neighbor cache entries. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">IPv4</command:parameterValue>
<command:parameterValue required="false" variableLength="false">IPv6</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LinkLayerAddress</maml:name>
<maml:description>
<maml:para>Specifies the link-layer address of the neighbor cache entry. The cmdlet adds a neighbor cache entry that has the link-layer address you specify.</maml:para>
<maml:para>The link-layer address is also called the media access control (MAC) address. A link-layer address that uses IPv4 address syntax is a tunnel technology that encapsulates packets over an IPv4 tunnel, such as Intra-Site Automatic Tunnel Addressing Protocol (ISATAP) or Teredo. A link-layer address of all zeroes indicates that the neighbor is unreachable and the neighbor cache entry does not have a link-layer address entry. An empty link-layer address indicates that the link layer does not use link-layer addresses, such as on a loopback interface.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The cmdlet adds a neighbor cache entry that has the PolicyStore value you specify. The acceptable values for this parameter are:
-- ActiveStore: The IP address information is valid.
-- PersistentStore: The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
Specify ActiveStore only.</maml:para>
<maml:para>If you do not specify this parameter, the default entries are created in both the ActiveStore and the PersistentStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>State</maml:name>
<maml:description>
<maml:para>Specifies the state of the neighbor cache entry. The cmdlet adds a neighbor cache entry that has the state you specify. You can create only neighbor cache entries that are in a permanent state. The acceptable values for this parameter are:
-- Permanent. The neighbor is statically provisioned and will not expire unless you remove it.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Unreachable</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Incomplete</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Probe</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Delay</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Stale</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Reachable</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Permanent</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies the alias of a network interface. The cmdlet adds a neighbor cache entry for the network interface that has the alias you specify.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>New-NetNeighbor</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>IPAddress</maml:name>
<maml:description>
<maml:para>Specifies an IP address. The cmdlet adds a neighbor cache entry that has the IP address you specify.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies the IP address family. The cmdlet adds a neighbor cache entry that belongs to the IP address family you specify. If you do not specify this parameter, the cmdlet automatically generates the address families of the neighbor cache entries. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">IPv4</command:parameterValue>
<command:parameterValue required="false" variableLength="false">IPv6</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LinkLayerAddress</maml:name>
<maml:description>
<maml:para>Specifies the link-layer address of the neighbor cache entry. The cmdlet adds a neighbor cache entry that has the link-layer address you specify.</maml:para>
<maml:para>The link-layer address is also called the media access control (MAC) address. A link-layer address that uses IPv4 address syntax is a tunnel technology that encapsulates packets over an IPv4 tunnel, such as Intra-Site Automatic Tunnel Addressing Protocol (ISATAP) or Teredo. A link-layer address of all zeroes indicates that the neighbor is unreachable and the neighbor cache entry does not have a link-layer address entry. An empty link-layer address indicates that the link layer does not use link-layer addresses, such as on a loopback interface.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The cmdlet adds a neighbor cache entry that has the PolicyStore value you specify. The acceptable values for this parameter are:
-- ActiveStore: The IP address information is valid.
-- PersistentStore: The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
Specify ActiveStore only.</maml:para>
<maml:para>If you do not specify this parameter, the default entries are created in both the ActiveStore and the PersistentStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>State</maml:name>
<maml:description>
<maml:para>Specifies the state of the neighbor cache entry. The cmdlet adds a neighbor cache entry that has the state you specify. You can create only neighbor cache entries that are in a permanent state. The acceptable values for this parameter are:
-- Permanent. The neighbor is statically provisioned and will not expire unless you remove it.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Unreachable</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Incomplete</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Probe</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Delay</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Stale</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Reachable</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Permanent</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies the alias of a network interface. The cmdlet adds a neighbor cache entry for the network interface located at the index you specify.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies the IP address family. The cmdlet adds a neighbor cache entry that belongs to the IP address family you specify. If you do not specify this parameter, the cmdlet automatically generates the address families of the neighbor cache entries. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">AddressFamily</command:parameterValue>
<dev:type>
<maml:name>AddressFamily</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>IPAddress</maml:name>
<maml:description>
<maml:para>Specifies an IP address. The cmdlet adds a neighbor cache entry that has the IP address you specify.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LinkLayerAddress</maml:name>
<maml:description>
<maml:para>Specifies the link-layer address of the neighbor cache entry. The cmdlet adds a neighbor cache entry that has the link-layer address you specify.</maml:para>
<maml:para>The link-layer address is also called the media access control (MAC) address. A link-layer address that uses IPv4 address syntax is a tunnel technology that encapsulates packets over an IPv4 tunnel, such as Intra-Site Automatic Tunnel Addressing Protocol (ISATAP) or Teredo. A link-layer address of all zeroes indicates that the neighbor is unreachable and the neighbor cache entry does not have a link-layer address entry. An empty link-layer address indicates that the link layer does not use link-layer addresses, such as on a loopback interface.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The cmdlet adds a neighbor cache entry that has the PolicyStore value you specify. The acceptable values for this parameter are:
-- ActiveStore: The IP address information is valid.
-- PersistentStore: The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
Specify ActiveStore only.</maml:para>
<maml:para>If you do not specify this parameter, the default entries are created in both the ActiveStore and the PersistentStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies the alias of a network interface. The cmdlet adds a neighbor cache entry for the network interface that has the alias you specify.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies the alias of a network interface. The cmdlet adds a neighbor cache entry for the network interface located at the index you specify.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>State</maml:name>
<maml:description>
<maml:para>Specifies the state of the neighbor cache entry. The cmdlet adds a neighbor cache entry that has the state you specify. You can create only neighbor cache entries that are in a permanent state. The acceptable values for this parameter are:
-- Permanent. The neighbor is statically provisioned and will not expire unless you remove it.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">State</command:parameterValue>
<dev:type>
<maml:name>State</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetNeighbor</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Create an IPv4 neighbor cache entry</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>New-NetNeighbor –InterfaceIndex 12 –IPAddress "192.168.0.5" –LinkLayerAddress "00-00-12-00-00-ff"
</dev:code>
<dev:remarks>
<maml:para>This command creates a neighbor cache entry that has the IP address 192.168.0.5. The command specifies that the neighbor is connected to the interface that has the index 12. The command specifies that the link-layer address of the neighbor cache entry is 00-00-12-00-00-ff. </maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Create an IPv6 neighbor cache entry</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>New-NetNeighbor –InterfaceIndex 13 –IPAddress "fe80::5efe:192.168.0.5"
</dev:code>
<dev:remarks>
<maml:para>This command creates a neighbor cache entry on a virtual ISATAP interface that has the IP address fe80::5efe:192.168.0.5. The command specifies that the neighbor is connected to the interface that has the index 13.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=288395</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetAdapter</maml:linkText>
<maml:uri>
</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetNeighbor</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-NetNeighbor</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetNeighbor</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>New-NetRoute</command:name>
<maml:description>
<maml:para>Creates a route in the IP routing table.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>New</command:verb>
<command:noun>NetRoute</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The New-NetRoute cmdlet creates an IP route in the IP routing table. Specify the destination prefix, and specify an interface by using the interface alias or the interface index. </maml:para>
<maml:para>IP routing is the process of forwarding a packet based on the destination IP address. Routing occurs at TCP/IP hosts and at IP routers. The sending host or router determines where to forward the packet. To determine where to forward a packet, the host or router consults a routing table that is stored in memory. When TCP/IP starts, it creates entries in the routing table. You can add entries either manually or automatically. </maml:para>
<maml:para>For more information about routing, see <maml:navigationLink><maml:linkText>Chapter 5 - IP Routing</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://technet.microsoft.com/library/bb727001.aspx) in the TechNet library.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>New-NetRoute</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>DestinationPrefix</maml:name>
<maml:description>
<maml:para>Specifies a destination prefix of an IP route. A destination prefix consists of an IP address prefix and a prefix length, separated by a slash (/). A value of 0.0.0.0/0 for IPv4 or ::/0 for IPv6 indicates that the value of the NextHop parameter is a default gateway. The prefix length of the local host must match the prefix specified in this parameter, with all remaining address fields set to zero.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies the IP address family. The cmdlet uses the family that you specify for the IP route. The acceptable values for this parameter are:
-- IPv4
-- IPv6
If you do not specify this parameter, the cmdlet selects a value based on the other input that you provide.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">IPv4</command:parameterValue>
<command:parameterValue required="false" variableLength="false">IPv6</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NextHop</maml:name>
<maml:description>
<maml:para>Specifies the next hop for the IP route. The cmdlet assigns the next hop that you specify to the IP route. A value of 0.0.0.0 for IPv4 or :: for IPv6 indicates that the route is on the local subnet. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies the PolicyStore value. The cmdlet assigns the PolicyStore value that you specify to the IP route. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
The default value is ActiveStore. Specify ActiveStore only.</maml:para>
<maml:para>If you do not specify this parameter, the default entries are created in both the ActiveStore and the PersistentStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies a preferred lifetime, as a TimeSpan object, of an IP route.The cmdlet assigns the lifetime that you specify to the IP route. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. For more information, type Get-Help New-TimeSpan. The default value for a lifetime is infinite.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Protocol</maml:name>
<maml:description>
<maml:para>Specifies the type of routing protocol. The cmdlet assigns the protocol that you specify to the IP route. The acceptable values for this parameter are:
-- Bbn
-- Bgp
-- Dhcp
-- Dvmrp
-- Egp
-- Eigrp
-- EsIs
-- Ggp
-- Hello
-- Icmp
-- Idpr
-- Igrp
-- IsIs
-- Local
-- NetMgmt
-- Ospf
-- Rip
-- Rpl
-- Other
The default value is NetMgmt.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Other</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Local</command:parameterValue>
<command:parameterValue required="false" variableLength="false">NetMgmt</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Icmp</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Egp</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Ggp</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Hello</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Rip</command:parameterValue>
<command:parameterValue required="false" variableLength="false">IsIs</command:parameterValue>
<command:parameterValue required="false" variableLength="false">EsIs</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Igrp</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Bbn</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Ospf</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Bgp</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Idpr</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Eigrp</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Dvmrp</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Rpl</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Dhcp</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Publish</maml:name>
<maml:description>
<maml:para>Specifies the publish setting of an IP route. The cmdlet assigns the publish setting that you specify to the IP route. The acceptable values for this parameter are:
-- No. Do not publish or advertise IP route information in router advertisements.
-- Yes. Publish and advertise IP route information with an infinite valid lifetime in router advertisements.
-- Age. Publish and advertise IP route information with a finite valid lifetime in router advertisements. Specify a valid lifetime by using the ValidLifetime parameter.
The default value is No. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">No</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Age</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Yes</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RouteMetric</maml:name>
<maml:description>
<maml:para>Specifies an integer route metric for an IP route. The cmdlet assigns the metric that you specify to the IP route. The default value is 256. To choose among multiple routes, the computer adds this value. The computer selects the route with the lowest combined value. To modify the interface metric, use the Set-NetIPInterface cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies a valid lifetime, as a TimeSpan object, for an IP route. The cmdlet assigns the lifetime setting that you specify to the IP route. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. The default value is infinite. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies the alias of a network interface. The cmdlet adds a route for the interface that has the alias that you specify. </maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>New-NetRoute</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>DestinationPrefix</maml:name>
<maml:description>
<maml:para>Specifies a destination prefix of an IP route. A destination prefix consists of an IP address prefix and a prefix length, separated by a slash (/). A value of 0.0.0.0/0 for IPv4 or ::/0 for IPv6 indicates that the value of the NextHop parameter is a default gateway. The prefix length of the local host must match the prefix specified in this parameter, with all remaining address fields set to zero.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies the IP address family. The cmdlet uses the family that you specify for the IP route. The acceptable values for this parameter are:
-- IPv4
-- IPv6
If you do not specify this parameter, the cmdlet selects a value based on the other input that you provide.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">IPv4</command:parameterValue>
<command:parameterValue required="false" variableLength="false">IPv6</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NextHop</maml:name>
<maml:description>
<maml:para>Specifies the next hop for the IP route. The cmdlet assigns the next hop that you specify to the IP route. A value of 0.0.0.0 for IPv4 or :: for IPv6 indicates that the route is on the local subnet. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies the PolicyStore value. The cmdlet assigns the PolicyStore value that you specify to the IP route. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
The default value is ActiveStore. Specify ActiveStore only.</maml:para>
<maml:para>If you do not specify this parameter, the default entries are created in both the ActiveStore and the PersistentStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies a preferred lifetime, as a TimeSpan object, of an IP route.The cmdlet assigns the lifetime that you specify to the IP route. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. For more information, type Get-Help New-TimeSpan. The default value for a lifetime is infinite.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Protocol</maml:name>
<maml:description>
<maml:para>Specifies the type of routing protocol. The cmdlet assigns the protocol that you specify to the IP route. The acceptable values for this parameter are:
-- Bbn
-- Bgp
-- Dhcp
-- Dvmrp
-- Egp
-- Eigrp
-- EsIs
-- Ggp
-- Hello
-- Icmp
-- Idpr
-- Igrp
-- IsIs
-- Local
-- NetMgmt
-- Ospf
-- Rip
-- Rpl
-- Other
The default value is NetMgmt.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Other</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Local</command:parameterValue>
<command:parameterValue required="false" variableLength="false">NetMgmt</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Icmp</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Egp</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Ggp</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Hello</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Rip</command:parameterValue>
<command:parameterValue required="false" variableLength="false">IsIs</command:parameterValue>
<command:parameterValue required="false" variableLength="false">EsIs</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Igrp</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Bbn</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Ospf</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Bgp</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Idpr</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Eigrp</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Dvmrp</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Rpl</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Dhcp</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Publish</maml:name>
<maml:description>
<maml:para>Specifies the publish setting of an IP route. The cmdlet assigns the publish setting that you specify to the IP route. The acceptable values for this parameter are:
-- No. Do not publish or advertise IP route information in router advertisements.
-- Yes. Publish and advertise IP route information with an infinite valid lifetime in router advertisements.
-- Age. Publish and advertise IP route information with a finite valid lifetime in router advertisements. Specify a valid lifetime by using the ValidLifetime parameter.
The default value is No. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">No</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Age</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Yes</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RouteMetric</maml:name>
<maml:description>
<maml:para>Specifies an integer route metric for an IP route. The cmdlet assigns the metric that you specify to the IP route. The default value is 256. To choose among multiple routes, the computer adds this value. The computer selects the route with the lowest combined value. To modify the interface metric, use the Set-NetIPInterface cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies a valid lifetime, as a TimeSpan object, for an IP route. The cmdlet assigns the lifetime setting that you specify to the IP route. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. The default value is infinite. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies the index of a network interface. The cmdlet adds a route for the interface located at the index that you specify. </maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies the IP address family. The cmdlet uses the family that you specify for the IP route. The acceptable values for this parameter are:
-- IPv4
-- IPv6
If you do not specify this parameter, the cmdlet selects a value based on the other input that you provide.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">AddressFamily</command:parameterValue>
<dev:type>
<maml:name>AddressFamily</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>DestinationPrefix</maml:name>
<maml:description>
<maml:para>Specifies a destination prefix of an IP route. A destination prefix consists of an IP address prefix and a prefix length, separated by a slash (/). A value of 0.0.0.0/0 for IPv4 or ::/0 for IPv6 indicates that the value of the NextHop parameter is a default gateway. The prefix length of the local host must match the prefix specified in this parameter, with all remaining address fields set to zero.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies the alias of a network interface. The cmdlet adds a route for the interface that has the alias that you specify. </maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies the index of a network interface. The cmdlet adds a route for the interface located at the index that you specify. </maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NextHop</maml:name>
<maml:description>
<maml:para>Specifies the next hop for the IP route. The cmdlet assigns the next hop that you specify to the IP route. A value of 0.0.0.0 for IPv4 or :: for IPv6 indicates that the route is on the local subnet. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies the PolicyStore value. The cmdlet assigns the PolicyStore value that you specify to the IP route. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
The default value is ActiveStore. Specify ActiveStore only.</maml:para>
<maml:para>If you do not specify this parameter, the default entries are created in both the ActiveStore and the PersistentStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies a preferred lifetime, as a TimeSpan object, of an IP route.The cmdlet assigns the lifetime that you specify to the IP route. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. For more information, type Get-Help New-TimeSpan. The default value for a lifetime is infinite.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
<dev:type>
<maml:name>TimeSpan</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Protocol</maml:name>
<maml:description>
<maml:para>Specifies the type of routing protocol. The cmdlet assigns the protocol that you specify to the IP route. The acceptable values for this parameter are:
-- Bbn
-- Bgp
-- Dhcp
-- Dvmrp
-- Egp
-- Eigrp
-- EsIs
-- Ggp
-- Hello
-- Icmp
-- Idpr
-- Igrp
-- IsIs
-- Local
-- NetMgmt
-- Ospf
-- Rip
-- Rpl
-- Other
The default value is NetMgmt.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Protocol</command:parameterValue>
<dev:type>
<maml:name>Protocol</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Publish</maml:name>
<maml:description>
<maml:para>Specifies the publish setting of an IP route. The cmdlet assigns the publish setting that you specify to the IP route. The acceptable values for this parameter are:
-- No. Do not publish or advertise IP route information in router advertisements.
-- Yes. Publish and advertise IP route information with an infinite valid lifetime in router advertisements.
-- Age. Publish and advertise IP route information with a finite valid lifetime in router advertisements. Specify a valid lifetime by using the ValidLifetime parameter.
The default value is No. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Publish</command:parameterValue>
<dev:type>
<maml:name>Publish</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RouteMetric</maml:name>
<maml:description>
<maml:para>Specifies an integer route metric for an IP route. The cmdlet assigns the metric that you specify to the IP route. The default value is 256. To choose among multiple routes, the computer adds this value. The computer selects the route with the lowest combined value. To modify the interface metric, use the Set-NetIPInterface cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
<dev:type>
<maml:name>UInt16</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies a valid lifetime, as a TimeSpan object, for an IP route. The cmdlet assigns the lifetime setting that you specify to the IP route. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. The default value is infinite. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
<dev:type>
<maml:name>TimeSpan</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetRoute</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Add an IP route to the routing table</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>New-NetRoute –DestinationPrefix "10.0.0.0/24" –InterfaceIndex 12 –NextHop 192.168.0.1
PS C:\> Get-NetRoute | Format-List -Property *
</dev:code>
<dev:remarks>
<maml:para>This example adds a routing table entry, and then displays the properties of all the entries in the routing table. </maml:para>
<maml:para>The first command creates a route for the destination prefix 10.0.0.0/24 for the interface that has the index of 12. The command specifies 192.168.0.1 as the next hop. </maml:para>
<maml:para>The second command uses the Get-NetRoute cmdlet to get all the routes for the computer, and then passes them to the Format-List cmdlet by using the pipeline operator. The Format-List cmdlet can display all the properties of an object. For more information, type Get-Help Format-List. </maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkID=288396</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Find-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetIPInterface</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>New-NetTransportFilter</command:name>
<maml:description>
<maml:para>Creates a transport filter.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>New</command:verb>
<command:noun>NetTransportFilter</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The New-NetTransportFilter cmdlet creates a transport filter. A transport filter specifies the TCP settings, as a NetTcpSetting object, to apply to an IP address prefix or a TCP port range. Specify the setting to apply by name. You can use the Set-NetTCPSetting cmdlet to modify a setting.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>New-NetTransportFilter</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DestinationPrefix</maml:name>
<maml:description>
<maml:para>Specifies a destination prefix of an IP route. The cmdlet associates the transport filter that to the prefix that you specify. A destination prefix consists of an IP address prefix and a prefix length, separated by a slash (/).</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LocalPortEnd</maml:name>
<maml:description>
<maml:para>Specifies the upper bound of a range of local TCP ports. The cmdlet assigns the upper bound that you specify to the transport filter. If you do not specify this parameter, the cmdlet uses the lower range value of 1025.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LocalPortStart</maml:name>
<maml:description>
<maml:para>Specifies the lower bound of a range of local TCP ports. The cmdlet assigns the lower bound that you specify to the transport filter. If you do not specify this parameter, the cmdlet uses the lower range value of 65535.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Protocol</maml:name>
<maml:description>
<maml:para>Specifies the type of routing protocol. The cmdlet assigns the protocol that you specify to the routing filter. The acceptable values for this parameter are:
-- Bbn
-- Bgp
-- Dhcp
-- Dvmrp
-- Egp
-- Eigrp
-- EsIs
-- Ggp
-- Hello
-- Icmp
-- Idpr
-- Igrp
-- IsIs
-- Local
-- NetMgmt
-- Ospf
-- Rip
-- Rpl
-- Other</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">TCP</command:parameterValue>
<command:parameterValue required="false" variableLength="false">UDP</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RemotePortEnd</maml:name>
<maml:description>
<maml:para>Specifies the upper bound of a range of remote TCP ports. The cmdlet assigns the upper bound that you specify to the transport filter. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RemotePortStart</maml:name>
<maml:description>
<maml:para>Specifies the lower bound of a range of remote TCP ports. The cmdlet assigns the lower bound that you specify to the transport filter. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SettingName</maml:name>
<maml:description>
<maml:para>Specifies a setting name. The cmdlet associates the setting that you specify to the transport filter. The acceptable values for this parameter are:
-- Internet
-- Datacenter
-- Compat
-- Custom</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DestinationPrefix</maml:name>
<maml:description>
<maml:para>Specifies a destination prefix of an IP route. The cmdlet associates the transport filter that to the prefix that you specify. A destination prefix consists of an IP address prefix and a prefix length, separated by a slash (/).</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LocalPortEnd</maml:name>
<maml:description>
<maml:para>Specifies the upper bound of a range of local TCP ports. The cmdlet assigns the upper bound that you specify to the transport filter. If you do not specify this parameter, the cmdlet uses the lower range value of 1025.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
<dev:type>
<maml:name>UInt16</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LocalPortStart</maml:name>
<maml:description>
<maml:para>Specifies the lower bound of a range of local TCP ports. The cmdlet assigns the lower bound that you specify to the transport filter. If you do not specify this parameter, the cmdlet uses the lower range value of 65535.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
<dev:type>
<maml:name>UInt16</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Protocol</maml:name>
<maml:description>
<maml:para>Specifies the type of routing protocol. The cmdlet assigns the protocol that you specify to the routing filter. The acceptable values for this parameter are:
-- Bbn
-- Bgp
-- Dhcp
-- Dvmrp
-- Egp
-- Eigrp
-- EsIs
-- Ggp
-- Hello
-- Icmp
-- Idpr
-- Igrp
-- IsIs
-- Local
-- NetMgmt
-- Ospf
-- Rip
-- Rpl
-- Other</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Protocol</command:parameterValue>
<dev:type>
<maml:name>Protocol</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RemotePortEnd</maml:name>
<maml:description>
<maml:para>Specifies the upper bound of a range of remote TCP ports. The cmdlet assigns the upper bound that you specify to the transport filter. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
<dev:type>
<maml:name>UInt16</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RemotePortStart</maml:name>
<maml:description>
<maml:para>Specifies the lower bound of a range of remote TCP ports. The cmdlet assigns the lower bound that you specify to the transport filter. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
<dev:type>
<maml:name>UInt16</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SettingName</maml:name>
<maml:description>
<maml:para>Specifies a setting name. The cmdlet associates the setting that you specify to the transport filter. The acceptable values for this parameter are:
-- Internet
-- Datacenter
-- Compat
-- Custom</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetTransportFilter</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Create a transport filter</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>New-NetTransportFilter –SettingName Datacenter –DestinationPrefix 192.168.0.0/16
</dev:code>
<dev:remarks>
<maml:para>This command creates a transport filter for the 192.168.0.0/16 network. The data center TCP settings applies to all TCP connections between the computer and other computers in this network.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Create a transport filter for an app</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetTransportFilter –SettingName Compat –LocalPortStart 5000 –LocalPortEnd 5000 –RemotePortStart 6000 –RemotePortEnd 6000
</dev:code>
<dev:remarks>
<maml:para>This command creates a transport filter for a compatibility setting. The command specifies port ranges for both local and remote computers.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkID=288397</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetTransportFilter</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-NetTransportFilter</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetTCPSetting</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Remove-NetIPAddress</command:name>
<maml:description>
<maml:para>Removes an IP address and its configuration.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Remove</command:verb>
<command:noun>NetIPAddress</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Remove-NetIPAddress cmdlet removes an IP address and its configuration. To remove a specific IP address object, use the IPv4 Address parameter or IPv6 Address parameter. If you do not specify an IPv4 or IPv6 address, the cmdlet will remove all IP addresses that match.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Remove-NetIPAddress</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="LocalAddress">
<maml:name>IPAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of IPv4 or IPv6 addresses.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address families. The cmdlet removes the IP address that matches the families. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressState</maml:name>
<maml:description>
<maml:para>Specifies an array of duplicate address detection (DAD) state values for the IP address. The acceptable values for this parameter are:
-- Invalid. IP address configuration information for addresses that are not valid and will not be used.
-- Tentative. IP address configuration information for addresses that are not used for communication, as the uniqueness of those IP addresses is being verified.
-- Duplicate. IP address configuration information for addresses for which a duplicate IP address has been detected and the current IP address will not be used.
-- Deprecated. IP address configuration information for addresses that will no longer be used to establish new connections, but will continue to be used with existing connections.
-- Preferred. IP address configuration information for addresses that are valid and available for use. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressState[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DefaultGateway</maml:name>
<maml:description>
<maml:para>Specifies the IPv4 address or IPv6 address of the default gateway for the host. Default gateways provide a default route for TCP/IP hosts to use when communicating with other hosts on remote networks.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes addresses from all configured network compartments. If you do not specify this parameter, the cmdlet removes only addresses in the default network compartment.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet removes IP addresses that match the aliases. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet removes IP addresses that match the indexes.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
The default value is ActiveStore. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values of preferred lifetimes, as TimeSpan objects, for an IP address. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PrefixLength</maml:name>
<maml:description>
<maml:para>Specifies an array of prefix lengths. This parameter defines the local subnet size, and is also known as a subnet mask.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Byte[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PrefixOrigin</maml:name>
<maml:description>
<maml:para>Specifies an array of origins of address prefixes. IP addresses are divided into two parts, the prefix and the suffix. The address prefix identifies the network portion of an IP address, and the address suffix identifies the host portion. The acceptable values for this parameter are:
-- Manual. The IP address prefix was manually specified.
-- WellKnown. The IP address prefix is from a well-known source.
-- DHCP. The IP address prefix was provided by DHCP settings.
-- RouterAdvertisement. The IP address prefix was obtained through a router advertisement (RA). </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">PrefixOrigin[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SkipAsSource</maml:name>
<maml:description>
<maml:para>Indicates whether an address is a primary IP address. This parameter identifies the primary IP address for outgoing traffic in a multiple IP address scenario. If this parameter is set to True, the addresses are not used for outgoing traffic and are not registered in DNS.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Boolean[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SuffixOrigin</maml:name>
<maml:description>
<maml:para>Specifies an array of origins of address suffixes. IP addresses are divided into two parts, the prefix and the suffix. The address prefix identifies the network portion of an IP address, and the address suffix identifies the host portion. The acceptable values for this parameter are:
-- Manual. The IP address prefix was manually specified.
-- WellKnown. The IP address suffix is from a well-known source.
-- DHCP. The IP address suffix was provided by DHCP settings.
-- Link. The IP address suffix was obtained from the link-layer address.
-- Random. The IP address suffix was obtained from a random source. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">SuffixOrigin[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Type</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address types. The acceptable values for this parameter are:
-- Unicast
-- Anycast
The default value is Unicast. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Type[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values of valid lifetimes, as TimeSpan objects, for an IP address. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Remove-NetIPAddress</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address families. The cmdlet removes the IP address that matches the families. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
<dev:type>
<maml:name>AddressFamily[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressState</maml:name>
<maml:description>
<maml:para>Specifies an array of duplicate address detection (DAD) state values for the IP address. The acceptable values for this parameter are:
-- Invalid. IP address configuration information for addresses that are not valid and will not be used.
-- Tentative. IP address configuration information for addresses that are not used for communication, as the uniqueness of those IP addresses is being verified.
-- Duplicate. IP address configuration information for addresses for which a duplicate IP address has been detected and the current IP address will not be used.
-- Deprecated. IP address configuration information for addresses that will no longer be used to establish new connections, but will continue to be used with existing connections.
-- Preferred. IP address configuration information for addresses that are valid and available for use. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressState[]</command:parameterValue>
<dev:type>
<maml:name>AddressState[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DefaultGateway</maml:name>
<maml:description>
<maml:para>Specifies the IPv4 address or IPv6 address of the default gateway for the host. Default gateways provide a default route for TCP/IP hosts to use when communicating with other hosts on remote networks.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes addresses from all configured network compartments. If you do not specify this parameter, the cmdlet removes only addresses in the default network compartment.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet removes IP addresses that match the aliases. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet removes IP addresses that match the indexes.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="LocalAddress">
<maml:name>IPAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of IPv4 or IPv6 addresses.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
The default value is ActiveStore. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values of preferred lifetimes, as TimeSpan objects, for an IP address. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
<dev:type>
<maml:name>TimeSpan[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PrefixLength</maml:name>
<maml:description>
<maml:para>Specifies an array of prefix lengths. This parameter defines the local subnet size, and is also known as a subnet mask.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Byte[]</command:parameterValue>
<dev:type>
<maml:name>Byte[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PrefixOrigin</maml:name>
<maml:description>
<maml:para>Specifies an array of origins of address prefixes. IP addresses are divided into two parts, the prefix and the suffix. The address prefix identifies the network portion of an IP address, and the address suffix identifies the host portion. The acceptable values for this parameter are:
-- Manual. The IP address prefix was manually specified.
-- WellKnown. The IP address prefix is from a well-known source.
-- DHCP. The IP address prefix was provided by DHCP settings.
-- RouterAdvertisement. The IP address prefix was obtained through a router advertisement (RA). </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">PrefixOrigin[]</command:parameterValue>
<dev:type>
<maml:name>PrefixOrigin[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SkipAsSource</maml:name>
<maml:description>
<maml:para>Indicates whether an address is a primary IP address. This parameter identifies the primary IP address for outgoing traffic in a multiple IP address scenario. If this parameter is set to True, the addresses are not used for outgoing traffic and are not registered in DNS.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Boolean[]</command:parameterValue>
<dev:type>
<maml:name>Boolean[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SuffixOrigin</maml:name>
<maml:description>
<maml:para>Specifies an array of origins of address suffixes. IP addresses are divided into two parts, the prefix and the suffix. The address prefix identifies the network portion of an IP address, and the address suffix identifies the host portion. The acceptable values for this parameter are:
-- Manual. The IP address prefix was manually specified.
-- WellKnown. The IP address suffix is from a well-known source.
-- DHCP. The IP address suffix was provided by DHCP settings.
-- Link. The IP address suffix was obtained from the link-layer address.
-- Random. The IP address suffix was obtained from a random source. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">SuffixOrigin[]</command:parameterValue>
<dev:type>
<maml:name>SuffixOrigin[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Type</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address types. The acceptable values for this parameter are:
-- Unicast
-- Anycast
The default value is Unicast. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Type[]</command:parameterValue>
<dev:type>
<maml:name>Type[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values of valid lifetimes, as TimeSpan objects, for an IP address. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
<dev:type>
<maml:name>TimeSpan[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetIPAddress</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Remove an IP address</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>
PS C:\>New-NetIPAddress –InterfaceIndex 12 –IPAddress 192.168.0.1
This command removes the IP address created by the previous command.
PS C:\>Remove-NetIPAddress –IPAddress 192.168.0.1
</dev:code>
<dev:remarks>
<maml:para>This command adds a new IP address.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Remove an IP address using a pipeline</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetIPAddress –IPAddress 192.168.0.1 | Remove-NetIPAddress
</dev:code>
<dev:remarks>
<maml:para>This command removes all of the IP addresses with the address 192.168.0.1.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 3: Remove IP addresses by prefix origin</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Remove-NetIPAddress –PrefixOrigin Manual
</dev:code>
<dev:remarks>
<maml:para>This command removes all of the IP addresses that have a manually-configured prefix origin.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=288398</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetIPAddress</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>New-NetIPAddress</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetIPAddress</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Remove-NetNeighbor</command:name>
<maml:description>
<maml:para>Removes neighbor cache entries.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Remove</command:verb>
<command:noun>NetNeighbor</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Remove-NetNeighbor cmdlet removes neighbor cache entries. The neighbor cache maintains information for each on-link neighbor, including the IP address and the associated link-layer address.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Remove-NetNeighbor</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>IPAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of IP addresses. The cmdlet removes neighbor cache entries that have the IP addresses you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address families. The cmdlet removes the neighbor cache entries that belong to the IP address families you specify. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedIPInterface</maml:name>
<maml:description>
<maml:para>Specifies an IP interface as a CIM object. The cmdlet removes neighbor cache entries that belong to this interface. To obtain an IP interface, use the Get-NetIPInterface cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes neighbor cache entries from all configured network compartments. If you do not specify this parameter, the cmdlet removes only neighbor cache entries in the default network compartment.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet removes neighbor cache entries for the network interfaces that have the aliases you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet removes neighbor cache entries for the network interfaces located at the indexes you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LinkLayerAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of link-layer addresses of the neighbor cache entry. The cmdlet removes the neighbor cache entries that have the link-layer addresses you specify.</maml:para>
<maml:para>The link-layer address is also called the media access control (MAC) address. A link-layer address that uses IPv4 address syntax is a tunnel technology that encapsulates packets over an IPv4 tunnel, such as Intra-Site Automatic Tunnel Addressing Protocol (ISATAP) or Teredo. A link-layer address of all zeroes indicates that the neighbor is unreachable and the neighbor cache entry does not have a link-layer address entry. An empty link-layer address indicates that the link layer does not use link-layer addresses, such as on a loopback interface.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The cmdlet removes the neighbor cache entries that have the PolicyStore value you specify. The acceptable values for this parameter are:
-- ActiveStore: The IP address information is valid.
-- PersistentStore: The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>State</maml:name>
<maml:description>
<maml:para>Specifies an arrary of states of neighbor cache entries. The cmdlet removes the neighbor cache entries that have the states you specify. The neighbor cache contains information maintained by Neighbor Unreachability Detection. Neighbor Unreachability Detection for IPv4 tracks the reachable state of IPv4 nodes in the IPv4 route cache. The acceptable values for this parameter are:
-- Unreachable. The IP address is unreachable.
-- Incomplete. Address resolution is in progress and Neighbor Unreachability Detection has not determined the link-layer address of the neighbor.
-- Probe. The neighbor is no longer known to be reachable, and Neighbor Unreachability Detection is sending unicast Neighbor Solicitation probes to verify reachability.
-- Delay. The neighbor is no longer known to be reachable, and traffic was recently sent to the neighbor. Neighbor Unreachability Detection does not probe the neighbor immediately. Neighbor Unreachability Detection delays sending probes for a short time so that the upper layer protocols can provide reachability confirmation.
-- Stale. The neighbor is no longer known to be reachable. and Until traffic is sent to the neighbor, Neighbor Unreachability Detection makes no attempt to verify its reachability.
-- Reachable. The neighbor is known to have been reachable recently, within the last minute.
-- Permanent. The neighbor is statically provisioned and will not expire unless you remove it through configuration.
-- Maximum. A maximum value for testing purposes. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">State[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Remove-NetNeighbor</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address families. The cmdlet removes the neighbor cache entries that belong to the IP address families you specify. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
<dev:type>
<maml:name>AddressFamily[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedIPInterface</maml:name>
<maml:description>
<maml:para>Specifies an IP interface as a CIM object. The cmdlet removes neighbor cache entries that belong to this interface. To obtain an IP interface, use the Get-NetIPInterface cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
<dev:type>
<maml:name>CimInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes neighbor cache entries from all configured network compartments. If you do not specify this parameter, the cmdlet removes only neighbor cache entries in the default network compartment.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>IPAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of IP addresses. The cmdlet removes neighbor cache entries that have the IP addresses you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LinkLayerAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of link-layer addresses of the neighbor cache entry. The cmdlet removes the neighbor cache entries that have the link-layer addresses you specify.</maml:para>
<maml:para>The link-layer address is also called the media access control (MAC) address. A link-layer address that uses IPv4 address syntax is a tunnel technology that encapsulates packets over an IPv4 tunnel, such as Intra-Site Automatic Tunnel Addressing Protocol (ISATAP) or Teredo. A link-layer address of all zeroes indicates that the neighbor is unreachable and the neighbor cache entry does not have a link-layer address entry. An empty link-layer address indicates that the link layer does not use link-layer addresses, such as on a loopback interface.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet removes neighbor cache entries for the network interfaces that have the aliases you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet removes neighbor cache entries for the network interfaces located at the indexes you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The cmdlet removes the neighbor cache entries that have the PolicyStore value you specify. The acceptable values for this parameter are:
-- ActiveStore: The IP address information is valid.
-- PersistentStore: The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>State</maml:name>
<maml:description>
<maml:para>Specifies an arrary of states of neighbor cache entries. The cmdlet removes the neighbor cache entries that have the states you specify. The neighbor cache contains information maintained by Neighbor Unreachability Detection. Neighbor Unreachability Detection for IPv4 tracks the reachable state of IPv4 nodes in the IPv4 route cache. The acceptable values for this parameter are:
-- Unreachable. The IP address is unreachable.
-- Incomplete. Address resolution is in progress and Neighbor Unreachability Detection has not determined the link-layer address of the neighbor.
-- Probe. The neighbor is no longer known to be reachable, and Neighbor Unreachability Detection is sending unicast Neighbor Solicitation probes to verify reachability.
-- Delay. The neighbor is no longer known to be reachable, and traffic was recently sent to the neighbor. Neighbor Unreachability Detection does not probe the neighbor immediately. Neighbor Unreachability Detection delays sending probes for a short time so that the upper layer protocols can provide reachability confirmation.
-- Stale. The neighbor is no longer known to be reachable. and Until traffic is sent to the neighbor, Neighbor Unreachability Detection makes no attempt to verify its reachability.
-- Reachable. The neighbor is known to have been reachable recently, within the last minute.
-- Permanent. The neighbor is statically provisioned and will not expire unless you remove it through configuration.
-- Maximum. A maximum value for testing purposes. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">State[]</command:parameterValue>
<dev:type>
<maml:name>State[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetNeighbor</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Remove unreachable neighbor cache entries</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Remove-NetNeighbor –State Unreachable
</dev:code>
<dev:remarks>
<maml:para>This command removes all neighbor cache entries that are unreachable.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Remove neighbor cache entries associated with a network adapter</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetAdapter | Where-Object –FilterScript {$_.LinkSpeed –Eq "100 Mbps"} | Remove-NetNeighbor –AddressFamily IPv4
</dev:code>
<dev:remarks>
<maml:para>This command gets a NetAdapter object that contains network adapters, and then passes the NetAdapter object to the Where-Object cmdlet by using the pipeline operator. The Where-Object cmdlet filters the network adapters that have a link speed of 100 Mbps, and then passes the network NetAdapter object to the Remove-NetNeighbor cmdlet. The Remove-NetNeighbor cmdlet removes all neighbor cache entries that have IPv4 addresses and are associated with a network adapter that has a link speed of 100 Mbps.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=288399</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetAdapter</maml:linkText>
<maml:uri>
</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetNeighbor</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>New-NetNeighbor</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetNeighbor</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Remove-NetRoute</command:name>
<maml:description>
<maml:para>Removes IP routes from the IP routing table. </maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Remove</command:verb>
<command:noun>NetRoute</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Remove-NetRoute cmdlet removes IP routes from the IP routing table. Run this cmdlet without any parameters to remove all IP routes from the routing table, including default routes. You can also specify routes to remove by specifying parameters, or by using the Get-NetRoute cmdlet. </maml:para>
<maml:para>For more information about routing, see <maml:navigationLink><maml:linkText>Chapter 5 - IP Routing</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://technet.microsoft.com/library/bb727001.aspx) in the TechNet library.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Remove-NetRoute</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>DestinationPrefix</maml:name>
<maml:description>
<maml:para>Specifies an array of destination prefixes of IP routes. The cmdlet removes IP routes that use the prefixes that you specify. A destination prefix contains an IP address prefix and a prefix length, separated by a slash (/). A value of 0.0.0.0/0 for IPv4 or ::/0 for IPv6 indicates that the value of the NextHop parameter is a default gateway. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address families of IP routes. The cmdlet removes IP routes that belong to the families that you specify. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedIPInterface</maml:name>
<maml:description>
<maml:para>Specifies an IP interface as a CIM object. The cmdlet removes IP routes that belong to the interfaces that you specify. To obtain an IP interface, use the Get-NetIPInterface cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CompartmentId</maml:name>
<maml:description>
<maml:para>Specifies an array of identifiers for network compartments in the protocol stack. By default, the cmdlet only removes Net routes in the default compartment. If you specify a value, the cmdlet removes any matching Net routes in all compartments in this field.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes routes from all configured network compartments. If you do not specify this parameter, the cmdlet removes only routes in the default network compartment.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet removes IP routes for the interfaces that have the aliases that you specify. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet removes IP routes for the interfaces located at the indexes that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>InterfaceMetric</maml:name>
<maml:description>
<maml:para>Specifies an array of integer interface metrics for network interfaces. The cmdlet removes IP routes for the interfaces that have the metric that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NextHop</maml:name>
<maml:description>
<maml:para>Specifies an array of next hop values. The cmdlet removes routes that have the next hop values that you specify. A value of 0.0.0.0 for IPv4 or :: for IPv6 indicates that the route is on the local subnet. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The cmdlet removes IP routes that have the PolicyStore value that you specify. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values for preferred lifetime, as TimeSpan objects, of IP routes. The cmdlet removes IP routes that have the lifetimes that you specify. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. For more information, type Get-Help New-TimeSpan. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Protocol</maml:name>
<maml:description>
<maml:para>Specifies an array of types of routing protocols. The cmdlet removes IP routes that use the protocols that you specify. The acceptable values for this parameter are:
-- Bbn
-- Bgp
-- Dhcp
-- Dvmrp
-- Egp
-- Eigrp
-- EsIs
-- Ggp
-- Hello
-- Icmp
-- Idpr
-- Igrp
-- IsIs
-- Local
-- NetMgmt
-- Ospf
-- Rip
-- Rpl
-- Other</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Protocol[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Publish</maml:name>
<maml:description>
<maml:para>Specifies an array of publish settings of IP routes. The cmdlet removes IP routes that have the publish settings that you specify. The acceptable values for this parameter are:
-- No. Do not publish or advertise IP route information in router advertisements.
-- Yes. Publish and advertise IP route information that includes an infinite valid lifetime in router advertisements
-- Age. Publish and advertise IP route information with a finite valid lifetime in router advertisements. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Publish[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RouteMetric</maml:name>
<maml:description>
<maml:para>Specifies an array of integer route metrics for IP routes. The cmdlet removes IP routes that have the metrics that you specify. To choose among multiple routes, the computer adds this value to the interface metric value. The computer selects the route with the lowest combined value. To modify the interface metric, use the Set-NetIPInterface cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>State</maml:name>
<maml:description>
<maml:para>Specifies an array of state values for IP routes. The cmdlet gets entries that have the state values that you specify. </maml:para>
<maml:para>The acceptable values for this parameter are:
-- Alive
-- Dead
-- Probe</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">State[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values for valid lifetime, as a TimeSpan object, for IP routes. The cmdlet removes IP routes that have the lifetime that you specify. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Remove-NetRoute</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address families of IP routes. The cmdlet removes IP routes that belong to the families that you specify. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
<dev:type>
<maml:name>AddressFamily[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedIPInterface</maml:name>
<maml:description>
<maml:para>Specifies an IP interface as a CIM object. The cmdlet removes IP routes that belong to the interfaces that you specify. To obtain an IP interface, use the Get-NetIPInterface cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
<dev:type>
<maml:name>CimInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CompartmentId</maml:name>
<maml:description>
<maml:para>Specifies an array of identifiers for network compartments in the protocol stack. By default, the cmdlet only removes Net routes in the default compartment. If you specify a value, the cmdlet removes any matching Net routes in all compartments in this field.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>DestinationPrefix</maml:name>
<maml:description>
<maml:para>Specifies an array of destination prefixes of IP routes. The cmdlet removes IP routes that use the prefixes that you specify. A destination prefix contains an IP address prefix and a prefix length, separated by a slash (/). A value of 0.0.0.0/0 for IPv4 or ::/0 for IPv6 indicates that the value of the NextHop parameter is a default gateway. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes routes from all configured network compartments. If you do not specify this parameter, the cmdlet removes only routes in the default network compartment.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet removes IP routes for the interfaces that have the aliases that you specify. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet removes IP routes for the interfaces located at the indexes that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>InterfaceMetric</maml:name>
<maml:description>
<maml:para>Specifies an array of integer interface metrics for network interfaces. The cmdlet removes IP routes for the interfaces that have the metric that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NextHop</maml:name>
<maml:description>
<maml:para>Specifies an array of next hop values. The cmdlet removes routes that have the next hop values that you specify. A value of 0.0.0.0 for IPv4 or :: for IPv6 indicates that the route is on the local subnet. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The cmdlet removes IP routes that have the PolicyStore value that you specify. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values for preferred lifetime, as TimeSpan objects, of IP routes. The cmdlet removes IP routes that have the lifetimes that you specify. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. For more information, type Get-Help New-TimeSpan. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
<dev:type>
<maml:name>TimeSpan[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Protocol</maml:name>
<maml:description>
<maml:para>Specifies an array of types of routing protocols. The cmdlet removes IP routes that use the protocols that you specify. The acceptable values for this parameter are:
-- Bbn
-- Bgp
-- Dhcp
-- Dvmrp
-- Egp
-- Eigrp
-- EsIs
-- Ggp
-- Hello
-- Icmp
-- Idpr
-- Igrp
-- IsIs
-- Local
-- NetMgmt
-- Ospf
-- Rip
-- Rpl
-- Other</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Protocol[]</command:parameterValue>
<dev:type>
<maml:name>Protocol[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Publish</maml:name>
<maml:description>
<maml:para>Specifies an array of publish settings of IP routes. The cmdlet removes IP routes that have the publish settings that you specify. The acceptable values for this parameter are:
-- No. Do not publish or advertise IP route information in router advertisements.
-- Yes. Publish and advertise IP route information that includes an infinite valid lifetime in router advertisements
-- Age. Publish and advertise IP route information with a finite valid lifetime in router advertisements. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Publish[]</command:parameterValue>
<dev:type>
<maml:name>Publish[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RouteMetric</maml:name>
<maml:description>
<maml:para>Specifies an array of integer route metrics for IP routes. The cmdlet removes IP routes that have the metrics that you specify. To choose among multiple routes, the computer adds this value to the interface metric value. The computer selects the route with the lowest combined value. To modify the interface metric, use the Set-NetIPInterface cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
<dev:type>
<maml:name>UInt16[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>State</maml:name>
<maml:description>
<maml:para>Specifies an array of state values for IP routes. The cmdlet gets entries that have the state values that you specify. </maml:para>
<maml:para>The acceptable values for this parameter are:
-- Alive
-- Dead
-- Probe</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">State[]</command:parameterValue>
<dev:type>
<maml:name>State[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values for valid lifetime, as a TimeSpan object, for IP routes. The cmdlet removes IP routes that have the lifetime that you specify. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">TimeSpan[]</command:parameterValue>
<dev:type>
<maml:name>TimeSpan[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#rootStandardCimv2MSFT_NetRoute</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Remove all routes</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Remove-NetRoute
</dev:code>
<dev:remarks>
<maml:para>This command removes all of the IP routes on the computer, including default routes.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Remove routes for a specified next hop</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Remove-NetRoute –NextHop "192.168.0.1"
</dev:code>
<dev:remarks>
<maml:para>This command removes all of the IP routes that have a next hop of 192.168.0.1.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkID=288400</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Find-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>New-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetIPInterface</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Remove-NetTransportFilter</command:name>
<maml:description>
<maml:para>Removes transport filters.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Remove</command:verb>
<command:noun>NetTransportFilter</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Remove-NetTransportFilter cmdlet removes transport filters. </maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Remove-NetTransportFilter</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedTCPSetting</maml:name>
<maml:description>
<maml:para>Specifies a NetTCPSetting object. The cmdlet removes transport filters associated with the setting that you specify. To obtain a NetTCPSetting object, use the Get-NetTCPSetting cmdlet. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DestinationPrefix</maml:name>
<maml:description>
<maml:para>Specifies an array of destination prefixes of IP routes. The cmdlet removes transport filters that have the prefixes that you specify. A destination prefix consists of an IP address prefix and a prefix length, separated by a slash (/).</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LocalPortEnd</maml:name>
<maml:description>
<maml:para>Specifies an array of upper bounds of ranges of local TCP ports. The cmdlet removes transport filters that have the upper bounds that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LocalPortStart</maml:name>
<maml:description>
<maml:para>Specifies an array of lower bounds of ranges of local TCP ports. The cmdlet removes transport filters that have the lower bounds that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Protocol</maml:name>
<maml:description>
<maml:para>Specifies an array of types of routing protocols. The cmdlet removes transport filters based on the protocols that you specify. The acceptable values for this parameter are:
-- Bbn
-- Bgp
-- Dhcp
-- Dvmrp
-- Egp
-- Eigrp
-- EsIs
-- Ggp
-- Hello
-- Icmp
-- Idpr
-- Igrp
-- IsIs
-- Local
-- NetMgmt
-- Ospf
-- Rip
-- Rpl
-- Other</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Protocol[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RemotePortEnd</maml:name>
<maml:description>
<maml:para>Specifies an array of upper bounds of ranges of remote TCP ports. The cmdlet removes transport filters that have the upper bounds that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RemotePortStart</maml:name>
<maml:description>
<maml:para>Specifies an array of lower bounds of ranges of remote TCP ports. The cmdlet removes transport filters that have the lower bounds that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SettingName</maml:name>
<maml:description>
<maml:para>Specifies an array of setting names. The cmdlet removes transport filters that have the settings that you specify. The acceptable values for this parameter are:
-- Internet
-- Datacenter
-- Compat
-- Custom</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Remove-NetTransportFilter</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
<maml:name>AssociatedTCPSetting</maml:name>
<maml:description>
<maml:para>Specifies a NetTCPSetting object. The cmdlet removes transport filters associated with the setting that you specify. To obtain a NetTCPSetting object, use the Get-NetTCPSetting cmdlet. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CimInstance</command:parameterValue>
<dev:type>
<maml:name>CimInstance</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DestinationPrefix</maml:name>
<maml:description>
<maml:para>Specifies an array of destination prefixes of IP routes. The cmdlet removes transport filters that have the prefixes that you specify. A destination prefix consists of an IP address prefix and a prefix length, separated by a slash (/).</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LocalPortEnd</maml:name>
<maml:description>
<maml:para>Specifies an array of upper bounds of ranges of local TCP ports. The cmdlet removes transport filters that have the upper bounds that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
<dev:type>
<maml:name>UInt16[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LocalPortStart</maml:name>
<maml:description>
<maml:para>Specifies an array of lower bounds of ranges of local TCP ports. The cmdlet removes transport filters that have the lower bounds that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
<dev:type>
<maml:name>UInt16[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Protocol</maml:name>
<maml:description>
<maml:para>Specifies an array of types of routing protocols. The cmdlet removes transport filters based on the protocols that you specify. The acceptable values for this parameter are:
-- Bbn
-- Bgp
-- Dhcp
-- Dvmrp
-- Egp
-- Eigrp
-- EsIs
-- Ggp
-- Hello
-- Icmp
-- Idpr
-- Igrp
-- IsIs
-- Local
-- NetMgmt
-- Ospf
-- Rip
-- Rpl
-- Other</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Protocol[]</command:parameterValue>
<dev:type>
<maml:name>Protocol[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RemotePortEnd</maml:name>
<maml:description>
<maml:para>Specifies an array of upper bounds of ranges of remote TCP ports. The cmdlet removes transport filters that have the upper bounds that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
<dev:type>
<maml:name>UInt16[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RemotePortStart</maml:name>
<maml:description>
<maml:para>Specifies an array of lower bounds of ranges of remote TCP ports. The cmdlet removes transport filters that have the lower bounds that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt16[]</command:parameterValue>
<dev:type>
<maml:name>UInt16[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SettingName</maml:name>
<maml:description>
<maml:para>Specifies an array of setting names. The cmdlet removes transport filters that have the settings that you specify. The acceptable values for this parameter are:
-- Internet
-- Datacenter
-- Compat
-- Custom</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetTransportFilter</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Remove transport filters for a setting name</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Remove-NetTransportFilter –SettingName Custom
</dev:code>
<dev:remarks>
<maml:para>This command removes all of the transport filters on the server that have the setting name of Custom. </maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Remove transit filters for objects with a specified congestion window</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetTCPSetting –InitialCongestionWindowMss 4 | Remove-NetTransportFilter
</dev:code>
<dev:remarks>
<maml:para>This command uses the Get-NetTCPSetting cmdlet to get all of the NetTcpSetting objects that have an initial congestion window of 4 maximum segment size (MSS) units, and then passes them to the current cmdlet by using the pipeline operator. The command removes transport filters for these settings.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkID=288401</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetTCPSetting</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetTransportFilter</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>New-NetTransportFilter</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Set-NetIPAddress</command:name>
<maml:description>
<maml:para>Modifies the configuration of an IP address.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Set</command:verb>
<command:noun>NetIPAddress</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Set-NetIPAddress cmdlet modifies IP address configuration properties of an existing IP address. </maml:para>
<maml:para>To create an IPv4 address or IPv6 address, use the New-NetIPAddress cmdlet.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Set-NetIPAddress</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="LocalAddress">
<maml:name>IPAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of IPv4 or IPv6 addresses.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address families. The cmdlet modifies the IP address configuration that matches the families. The acceptable values for this parameter are:
-- IPv4
-- IPv6 </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressState</maml:name>
<maml:description>
<maml:para>Specifies an array of duplicate address detection (DAD) state values for the IP address. The acceptable values for this parameter are:
-- Invalid. IP address configuration information for addresses that are not valid and will not be used.
-- Tentative. IP address configuration information for addresses that are not used for communication, as the uniqueness of those IP addresses is being verified.
-- Duplicate. IP address configuration information for addresses for which a duplicate IP address has been detected and the current IP address will not be used.
-- Deprecated. IP address configuration information for addresses that will no longer be used to establish new connections, but will continue to be used with existing connections.
-- Preferred. IP address configuration information for addresses that are valid and available for use.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressState[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes addresses from all configured network compartments. If you do not specify this parameter, the cmdlet modifies only addresses in the default network compartment.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet modifies IP addresses that match the aliases.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet modifies IP addresses that match the indexes. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
The default value is ActiveStore. Specify ActiveStore only.</maml:para>
<maml:para>If you do not specify this parameter, the default entries are created in both the ActiveStore and the PersistentStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies a preferred lifetime, as a TimeSpan object, for an IP address. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PrefixLength</maml:name>
<maml:description>
<maml:para>Specifies a prefix length. This parameter defines the local subnet size, and is also known as a subnet mask.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Byte</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PrefixOrigin</maml:name>
<maml:description>
<maml:para>ps_deprecate_para</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">PrefixOrigin[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SkipAsSource</maml:name>
<maml:description>
<maml:para>Indicates whether an address is a primary IP address. This parameter identifies the primary IP address for outgoing traffic in a multiple IP address scenario. If this parameter is set to True, the address is not used for outgoing traffic and is not registered in DNS.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SuffixOrigin</maml:name>
<maml:description>
<maml:para>Specifies an array of origins for address suffixes. IP addresses are divided into two parts, the prefix and the suffix. The address prefix identifies the network portion of an IP address, and the address suffix identifies the host portion. The acceptable values for this parameter are:
-- Manual. The IP address suffix was manually specified.
-- WellKnown. The IP address suffix is from a well-known source.
-- DHCP. The IP address suffix was provided by DHCP settings.
-- Link. The IP address suffix was obtained from the link-layer address.
-- Random. The IP address suffix was obtained from a random source.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">SuffixOrigin[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Type</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address types. The acceptable values for this parameter are:
-- Unicast
-- Anycast
The default value is Unicast. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Type[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies a valid lifetime, as a TimeSpan object, for an IP address. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Set-NetIPAddress</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies a preferred lifetime, as a TimeSpan object, for an IP address. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PrefixLength</maml:name>
<maml:description>
<maml:para>Specifies a prefix length. This parameter defines the local subnet size, and is also known as a subnet mask.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Byte</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SkipAsSource</maml:name>
<maml:description>
<maml:para>Indicates whether an address is a primary IP address. This parameter identifies the primary IP address for outgoing traffic in a multiple IP address scenario. If this parameter is set to True, the address is not used for outgoing traffic and is not registered in DNS.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies a valid lifetime, as a TimeSpan object, for an IP address. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address families. The cmdlet modifies the IP address configuration that matches the families. The acceptable values for this parameter are:
-- IPv4
-- IPv6 </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
<dev:type>
<maml:name>AddressFamily[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressState</maml:name>
<maml:description>
<maml:para>Specifies an array of duplicate address detection (DAD) state values for the IP address. The acceptable values for this parameter are:
-- Invalid. IP address configuration information for addresses that are not valid and will not be used.
-- Tentative. IP address configuration information for addresses that are not used for communication, as the uniqueness of those IP addresses is being verified.
-- Duplicate. IP address configuration information for addresses for which a duplicate IP address has been detected and the current IP address will not be used.
-- Deprecated. IP address configuration information for addresses that will no longer be used to establish new connections, but will continue to be used with existing connections.
-- Preferred. IP address configuration information for addresses that are valid and available for use.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressState[]</command:parameterValue>
<dev:type>
<maml:name>AddressState[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes addresses from all configured network compartments. If you do not specify this parameter, the cmdlet modifies only addresses in the default network compartment.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet modifies IP addresses that match the aliases.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet modifies IP addresses that match the indexes. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="LocalAddress">
<maml:name>IPAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of IPv4 or IPv6 addresses.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
The default value is ActiveStore. Specify ActiveStore only.</maml:para>
<maml:para>If you do not specify this parameter, the default entries are created in both the ActiveStore and the PersistentStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies a preferred lifetime, as a TimeSpan object, for an IP address. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
<dev:type>
<maml:name>TimeSpan</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PrefixLength</maml:name>
<maml:description>
<maml:para>Specifies a prefix length. This parameter defines the local subnet size, and is also known as a subnet mask.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Byte</command:parameterValue>
<dev:type>
<maml:name>Byte</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PrefixOrigin</maml:name>
<maml:description>
<maml:para>ps_deprecate_para</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">PrefixOrigin[]</command:parameterValue>
<dev:type>
<maml:name>PrefixOrigin[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SkipAsSource</maml:name>
<maml:description>
<maml:para>Indicates whether an address is a primary IP address. This parameter identifies the primary IP address for outgoing traffic in a multiple IP address scenario. If this parameter is set to True, the address is not used for outgoing traffic and is not registered in DNS.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
<maml:name>Boolean</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SuffixOrigin</maml:name>
<maml:description>
<maml:para>Specifies an array of origins for address suffixes. IP addresses are divided into two parts, the prefix and the suffix. The address prefix identifies the network portion of an IP address, and the address suffix identifies the host portion. The acceptable values for this parameter are:
-- Manual. The IP address suffix was manually specified.
-- WellKnown. The IP address suffix is from a well-known source.
-- DHCP. The IP address suffix was provided by DHCP settings.
-- Link. The IP address suffix was obtained from the link-layer address.
-- Random. The IP address suffix was obtained from a random source.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">SuffixOrigin[]</command:parameterValue>
<dev:type>
<maml:name>SuffixOrigin[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Type</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address types. The acceptable values for this parameter are:
-- Unicast
-- Anycast
The default value is Unicast. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Type[]</command:parameterValue>
<dev:type>
<maml:name>Type[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies a valid lifetime, as a TimeSpan object, for an IP address. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
<dev:type>
<maml:name>TimeSpan</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetIPAddress</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Modify an IP address</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\> Set-NetIPAddress –InterfaceIndex 12 –IPAddress 192.168.0.1
PS C:\> Set-NetIPAddress –InterfaceIndex 12 –IPAddress 192.168.0.1 –PrefixLength 24
</dev:code>
<dev:remarks>
<maml:para>This command adds the IP address 192.168.0.1 to the interface located at index 12.</maml:para>
<maml:para>The PrefixLength parameter may also be specified as part of the Set-NetIPAddress cmdlet.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Modify an IP address and set the valid lifetime</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\> $Timesp = ( New-TimeSpan –Days 1 )
PS C:\> Set-NetIPAddress –InterfaceIndex 12 –IPAddress 192.168.0.1 –PreferredLifetime $Timesp
</dev:code>
<dev:remarks>
<maml:para>The first command creates a new TimeSpan object of one day, and stores it in the variable named $Timesp. </maml:para>
<maml:para>The second command then uses the TimeSpan object to set the preferred lifetime of the IP address located at interface 12 to one day.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=289165</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>New-TimeSpan</maml:linkText>
<maml:uri>
</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetIPAddress</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>New-NetIPAddress</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-NetIPAddress</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Set-NetIPInterface</command:name>
<maml:description>
<maml:para>Modifies an IP interface.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Set</command:verb>
<command:noun>NetIPInterface</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Set-NetIPInterface cmdlet modifies an IP interface, including Dynamic Host Configuration Protocol (DHCP), IPv6 neighbor discovery settings, router settings and Wake On LAN (WOL) settings. </maml:para>
<maml:para>If you do not specify any parameters, this cmdlet sets all of the IP interface properties on the computer, including virtual interfaces and loopback interfaces.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Set-NetIPInterface</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet modifies IP interfaces that match the aliases.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address families. The cmdlet modifies the IP interface that matches the families. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AdvertiseDefaultRoute</maml:name>
<maml:description>
<maml:para>Specifies the default router advertisement for an interface. This parameter value indicates whether the IP interface should advertise itself as a default router regardless of whether the node has a default route itself. This parameter is valid only for advertising interfaces. The acceptable values for this parameter are:
-- Enabled
-- Disabled </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AdvertisedRouterLifetime</maml:name>
<maml:description>
<maml:para>Specifies a lifetime, as a TimeSpan object, for a default route. This parameter value indicates the lifetime of default routes when advertising routes on the IP interface. The default value is 1800. This parameter is valid only for advertising interfaces. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Advertising</maml:name>
<maml:description>
<maml:para>Specifies the router advertisement value for the IP interface. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutomaticMetric</maml:name>
<maml:description>
<maml:para>Specifies the value for automatic metric calculation. Automatic metric determines whether TCP/IP automatically calculates a value for an interface metric that is based on the speed of the interface. The fastest interface has the lowest interface metric value. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="BaseReachableTime">
<maml:name>BaseReachableTimeMs</maml:name>
<maml:description>
<maml:para>Specifies the base value for random reachable time, in milliseconds. For more information, see <maml:navigationLink><maml:linkText>RFC 2461</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.
The default value is 30. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ClampMss</maml:name>
<maml:description>
<maml:para>Specifies the MSS clamping value for the IP interface. This value determines if this IP interface clamps MSS on the forwarded TCP packets that are sent out of this interface. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CompartmentId</maml:name>
<maml:description>
<maml:para>Specifies an array of identifiers for network compartments in the protocol stack. By default, the cmdlet only sets Net IP interfaces in the default compartment. If you specify a value, the cmdlet sets any matching NetIPInterface in all compartments in this field.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CurrentHopLimit</maml:name>
<maml:description>
<maml:para>Specifies a hop limit. This parameter is the value that the IP interface writes in the hop limit field for IPv6, or the Time To Live (TTL) field for IPv4, in all outbound traffic. When forwarding a packet, routers decrement the hop limit, or TTL, by 1, and discard the packet when the hop limit reaches 0. The default is defined as DefaultHopLimit in the NetIPv4Protocol and NetIPv6Protocol objects. When this parameter value is set to 0, it uses this default.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="DadRetransmitTime">
<maml:name>DadRetransmitTimeMs</maml:name>
<maml:description>
<maml:para>Specifies a value for the time interval between neighbor solicitation messages.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DadTransmits</maml:name>
<maml:description>
<maml:para>Specifies a value for the number of consecutive messages sent while the network driver performs duplicate address detection.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Dhcp</maml:name>
<maml:description>
<maml:para>Specifies the Dynamic Host Configuration Protocol (DHCP) value for an IP interface. This setting is persistent across reboots and only stored in the active policy store.
Changes to the persistent store will have no effect. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DirectedMacWolPattern</maml:name>
<maml:description>
<maml:para>Specifies the wake-up packet value for an IP interface. This parameter value determines if an IP interface is configured to wake up a computer with directed MAC packet patterns. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EcnMarking</maml:name>
<maml:description>
<maml:para>Specifies the value for Explicit Congestion Notification (ECN) marking. This parameter value controls the specific ECN marking in the ECN field of the IP header. The acceptable values for this parameter are:
-- AppDecide. Allow an application or higher layer protocol, such as TCP, to decide how to apply ECN marking. In order for an application to fully control ECN capability value in the Network TCP setting must also be set to Enabled.
-- Disabled. Disable the ECN marking on the IP interface.
-- UseEct0. Mark all of the egress IP packets on the IP interface with the Ect0 bit set.
-- UseEct1. Mark all of the egress IP packets on the IP interface with the Ect1 bit set.
The default value is AppDecide. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">UseEct1</command:parameterValue>
<command:parameterValue required="false" variableLength="false">UseEct0</command:parameterValue>
<command:parameterValue required="false" variableLength="false">AppDecide</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ForceArpNdWolPattern</maml:name>
<maml:description>
<maml:para>Specifies the Wake On LAN (WOL) value for the IP interface. This parameter value determines if an IP interface is configured to wake up a computer with Address Resolution Protocol (ARP) or Neighbor Discovery (ND) packet patterns. The default value is Disabled. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Forwarding</maml:name>
<maml:description>
<maml:para>Specifies the packet forwarding value for the IP interface. This value determines if this IP interface forwards packets that arrive on this interface to other interfaces. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IgnoreDefaultRoutes</maml:name>
<maml:description>
<maml:para>Specifies a value for Default Route advertisements. If you enable this setting, default routes will not be dynamically added to the routing table. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes all non-default compartments.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet modifies IP interfaces that match the indexes.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>InterfaceMetric</maml:name>
<maml:description>
<maml:para>Specifies a metric for an IP interface. When routes are chosen, the overall metric used to determine the preference is the sum of the route metric and the interface metric. Typically, the interface metric gives preference to a particular interface, such as using wired if both wired and wireless are available. This parameter value uses the value generated by AutomaticMetric by default. If this parameter value is set, then the AutomaticMetric parameter is automatically disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ManagedAddressConfiguration</maml:name>
<maml:description>
<maml:para>Specifies the value for managed address configuration. This parameter determines if an IP interface uses a stateful protocol, such as DHCP, to obtain an address. Setting this parameter has no effect on an interface that has router discovery enabled and advertising disabled. In that case, the parameter is controlled by router discovery. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NeighborDiscoverySupported</maml:name>
<maml:description>
<maml:para>Specifies an array of neighbor discovery values for the IP interface. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">NeighborDiscoverySupported[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NeighborUnreachabilityDetection</maml:name>
<maml:description>
<maml:para>Specifies the value for Neighbor Unreachability Detection (NUD). Use this parameter to determine when a neighbor is no longer reachable. For more information, see <maml:navigationLink><maml:linkText>RFC 2461</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. For ActiveStore, you can modify the NUD from Disabled to Enabled, but modifying NUD from Enabled to Disabled for ActiveStore fails with an invalid parameter. For the PersistentStore, you can modify the NUD to either Enabled or Disabled, but you will have to restart the interface for the setting to take effect.
The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NlMtuBytes</maml:name>
<maml:description>
<maml:para>Specifies the network layer Maximum Transmission Unit (MTU) value, in bytes, for an IP interface. For IPv4 the minimum value is 576 bytes. For IPv6 the minimum is value is 1280 bytes. For both IPv4 and IPv6, the maximum value is 2^32-1 (4294967295). You cannot set values outside these ranges. If this parameter is set to 0, then it will remain unchanged and maintain its current value. The IP interface will not transmit packets larger than the maximum value.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>OtherStatefulConfiguration</maml:name>
<maml:description>
<maml:para>Specifies the value for configuration other than addresses. This parameter determines if an IP interface uses a stateful protocol, such as DHCP, to obtain configuration information other than addresses. This parameter setting has no effect on an interface that has router discovery enabled and advertising disabled. In that case, the parameter is controlled by router discovery. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
The default value is ActiveStore. Specify ActiveStore only.</maml:para>
<maml:para>If you do not specify this parameter, the default entries are created in both the ActiveStore and the PersistentStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ReachableTime</maml:name>
<maml:description>
<maml:para>Specifies an array of reachable time values. This parameter is the time, in milliseconds, that a node assumes that a neighbor is reachable after having received a reachability confirmation. This parameter works with the NeighborUnreachabilityDetection parameter. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="RetransmitTime">
<maml:name>RetransmitTimeMs</maml:name>
<maml:description>
<maml:para>Specifies a value for timeout and retransmission, in milliseconds, for Neighbor Solicitation messages. For more information, see RetransTimer in <maml:navigationLink><maml:linkText>RFC 2461</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. By default, the value is set to 1000.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RouterDiscovery</maml:name>
<maml:description>
<maml:para>Specifies the value for router discovery for an IP interface, The acceptable values for this parameter are:
-- ControlledByDHCP. DHCP determines if the IP Interface can be used by the computer to locate routers that reside on an attached link.
-- Disabled: IP Interface will not be used by the computer to locate routers that reside on an attached link.
-- Enabled. IP Interface can be used by the computer to locate routers that reside on an attached link.
By default, the value of this parameter is ControlledByDHCP for IPv4 and Enabled for IPv6. If the value of this parameter is enabled, an IP host can locate routers that reside on an attached link.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">ControlledByDHCP</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>WeakHostReceive</maml:name>
<maml:description>
<maml:para>Specifies the receive value for a weak host model. By default, interface properties set this parameter to disabled. If this parameter is enabled, an IP host can receive IP packets on an interface that is not assigned the destination IP address of the packet being received. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>WeakHostSend</maml:name>
<maml:description>
<maml:para>Specifies the send value for a weak host model. By default, interface properties set this parameter to disabled. If this parameter is enabled, an IP host can send IP packets on an interface that is not assigned the destination IP address of the packet being sent.The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Set-NetIPInterface</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AdvertiseDefaultRoute</maml:name>
<maml:description>
<maml:para>Specifies the default router advertisement for an interface. This parameter value indicates whether the IP interface should advertise itself as a default router regardless of whether the node has a default route itself. This parameter is valid only for advertising interfaces. The acceptable values for this parameter are:
-- Enabled
-- Disabled </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AdvertisedRouterLifetime</maml:name>
<maml:description>
<maml:para>Specifies a lifetime, as a TimeSpan object, for a default route. This parameter value indicates the lifetime of default routes when advertising routes on the IP interface. The default value is 1800. This parameter is valid only for advertising interfaces. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Advertising</maml:name>
<maml:description>
<maml:para>Specifies the router advertisement value for the IP interface. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutomaticMetric</maml:name>
<maml:description>
<maml:para>Specifies the value for automatic metric calculation. Automatic metric determines whether TCP/IP automatically calculates a value for an interface metric that is based on the speed of the interface. The fastest interface has the lowest interface metric value. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="BaseReachableTime">
<maml:name>BaseReachableTimeMs</maml:name>
<maml:description>
<maml:para>Specifies the base value for random reachable time, in milliseconds. For more information, see <maml:navigationLink><maml:linkText>RFC 2461</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.
The default value is 30. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ClampMss</maml:name>
<maml:description>
<maml:para>Specifies the MSS clamping value for the IP interface. This value determines if this IP interface clamps MSS on the forwarded TCP packets that are sent out of this interface. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CurrentHopLimit</maml:name>
<maml:description>
<maml:para>Specifies a hop limit. This parameter is the value that the IP interface writes in the hop limit field for IPv6, or the Time To Live (TTL) field for IPv4, in all outbound traffic. When forwarding a packet, routers decrement the hop limit, or TTL, by 1, and discard the packet when the hop limit reaches 0. The default is defined as DefaultHopLimit in the NetIPv4Protocol and NetIPv6Protocol objects. When this parameter value is set to 0, it uses this default.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="DadRetransmitTime">
<maml:name>DadRetransmitTimeMs</maml:name>
<maml:description>
<maml:para>Specifies a value for the time interval between neighbor solicitation messages.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DadTransmits</maml:name>
<maml:description>
<maml:para>Specifies a value for the number of consecutive messages sent while the network driver performs duplicate address detection.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Dhcp</maml:name>
<maml:description>
<maml:para>Specifies the Dynamic Host Configuration Protocol (DHCP) value for an IP interface. This setting is persistent across reboots and only stored in the active policy store.
Changes to the persistent store will have no effect. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DirectedMacWolPattern</maml:name>
<maml:description>
<maml:para>Specifies the wake-up packet value for an IP interface. This parameter value determines if an IP interface is configured to wake up a computer with directed MAC packet patterns. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EcnMarking</maml:name>
<maml:description>
<maml:para>Specifies the value for Explicit Congestion Notification (ECN) marking. This parameter value controls the specific ECN marking in the ECN field of the IP header. The acceptable values for this parameter are:
-- AppDecide. Allow an application or higher layer protocol, such as TCP, to decide how to apply ECN marking. In order for an application to fully control ECN capability value in the Network TCP setting must also be set to Enabled.
-- Disabled. Disable the ECN marking on the IP interface.
-- UseEct0. Mark all of the egress IP packets on the IP interface with the Ect0 bit set.
-- UseEct1. Mark all of the egress IP packets on the IP interface with the Ect1 bit set.
The default value is AppDecide. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">UseEct1</command:parameterValue>
<command:parameterValue required="false" variableLength="false">UseEct0</command:parameterValue>
<command:parameterValue required="false" variableLength="false">AppDecide</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ForceArpNdWolPattern</maml:name>
<maml:description>
<maml:para>Specifies the Wake On LAN (WOL) value for the IP interface. This parameter value determines if an IP interface is configured to wake up a computer with Address Resolution Protocol (ARP) or Neighbor Discovery (ND) packet patterns. The default value is Disabled. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Forwarding</maml:name>
<maml:description>
<maml:para>Specifies the packet forwarding value for the IP interface. This value determines if this IP interface forwards packets that arrive on this interface to other interfaces. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IgnoreDefaultRoutes</maml:name>
<maml:description>
<maml:para>Specifies a value for Default Route advertisements. If you enable this setting, default routes will not be dynamically added to the routing table. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>InterfaceMetric</maml:name>
<maml:description>
<maml:para>Specifies a metric for an IP interface. When routes are chosen, the overall metric used to determine the preference is the sum of the route metric and the interface metric. Typically, the interface metric gives preference to a particular interface, such as using wired if both wired and wireless are available. This parameter value uses the value generated by AutomaticMetric by default. If this parameter value is set, then the AutomaticMetric parameter is automatically disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ManagedAddressConfiguration</maml:name>
<maml:description>
<maml:para>Specifies the value for managed address configuration. This parameter determines if an IP interface uses a stateful protocol, such as DHCP, to obtain an address. Setting this parameter has no effect on an interface that has router discovery enabled and advertising disabled. In that case, the parameter is controlled by router discovery. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NeighborUnreachabilityDetection</maml:name>
<maml:description>
<maml:para>Specifies the value for Neighbor Unreachability Detection (NUD). Use this parameter to determine when a neighbor is no longer reachable. For more information, see <maml:navigationLink><maml:linkText>RFC 2461</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. For ActiveStore, you can modify the NUD from Disabled to Enabled, but modifying NUD from Enabled to Disabled for ActiveStore fails with an invalid parameter. For the PersistentStore, you can modify the NUD to either Enabled or Disabled, but you will have to restart the interface for the setting to take effect.
The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NlMtuBytes</maml:name>
<maml:description>
<maml:para>Specifies the network layer Maximum Transmission Unit (MTU) value, in bytes, for an IP interface. For IPv4 the minimum value is 576 bytes. For IPv6 the minimum is value is 1280 bytes. For both IPv4 and IPv6, the maximum value is 2^32-1 (4294967295). You cannot set values outside these ranges. If this parameter is set to 0, then it will remain unchanged and maintain its current value. The IP interface will not transmit packets larger than the maximum value.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>OtherStatefulConfiguration</maml:name>
<maml:description>
<maml:para>Specifies the value for configuration other than addresses. This parameter determines if an IP interface uses a stateful protocol, such as DHCP, to obtain configuration information other than addresses. This parameter setting has no effect on an interface that has router discovery enabled and advertising disabled. In that case, the parameter is controlled by router discovery. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="RetransmitTime">
<maml:name>RetransmitTimeMs</maml:name>
<maml:description>
<maml:para>Specifies a value for timeout and retransmission, in milliseconds, for Neighbor Solicitation messages. For more information, see RetransTimer in <maml:navigationLink><maml:linkText>RFC 2461</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. By default, the value is set to 1000.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RouterDiscovery</maml:name>
<maml:description>
<maml:para>Specifies the value for router discovery for an IP interface, The acceptable values for this parameter are:
-- ControlledByDHCP. DHCP determines if the IP Interface can be used by the computer to locate routers that reside on an attached link.
-- Disabled: IP Interface will not be used by the computer to locate routers that reside on an attached link.
-- Enabled. IP Interface can be used by the computer to locate routers that reside on an attached link.
By default, the value of this parameter is ControlledByDHCP for IPv4 and Enabled for IPv6. If the value of this parameter is enabled, an IP host can locate routers that reside on an attached link.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">ControlledByDHCP</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>WeakHostReceive</maml:name>
<maml:description>
<maml:para>Specifies the receive value for a weak host model. By default, interface properties set this parameter to disabled. If this parameter is enabled, an IP host can receive IP packets on an interface that is not assigned the destination IP address of the packet being received. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>WeakHostSend</maml:name>
<maml:description>
<maml:para>Specifies the send value for a weak host model. By default, interface properties set this parameter to disabled. If this parameter is enabled, an IP host can send IP packets on an interface that is not assigned the destination IP address of the packet being sent.The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address families. The cmdlet modifies the IP interface that matches the families. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
<dev:type>
<maml:name>AddressFamily[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AdvertiseDefaultRoute</maml:name>
<maml:description>
<maml:para>Specifies the default router advertisement for an interface. This parameter value indicates whether the IP interface should advertise itself as a default router regardless of whether the node has a default route itself. This parameter is valid only for advertising interfaces. The acceptable values for this parameter are:
-- Enabled
-- Disabled </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">AdvertiseDefaultRoute</command:parameterValue>
<dev:type>
<maml:name>AdvertiseDefaultRoute</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AdvertisedRouterLifetime</maml:name>
<maml:description>
<maml:para>Specifies a lifetime, as a TimeSpan object, for a default route. This parameter value indicates the lifetime of default routes when advertising routes on the IP interface. The default value is 1800. This parameter is valid only for advertising interfaces. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
<dev:type>
<maml:name>TimeSpan</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Advertising</maml:name>
<maml:description>
<maml:para>Specifies the router advertisement value for the IP interface. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Advertising</command:parameterValue>
<dev:type>
<maml:name>Advertising</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutomaticMetric</maml:name>
<maml:description>
<maml:para>Specifies the value for automatic metric calculation. Automatic metric determines whether TCP/IP automatically calculates a value for an interface metric that is based on the speed of the interface. The fastest interface has the lowest interface metric value. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">AutomaticMetric</command:parameterValue>
<dev:type>
<maml:name>AutomaticMetric</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="BaseReachableTime">
<maml:name>BaseReachableTimeMs</maml:name>
<maml:description>
<maml:para>Specifies the base value for random reachable time, in milliseconds. For more information, see <maml:navigationLink><maml:linkText>RFC 2461</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.
The default value is 30. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ClampMss</maml:name>
<maml:description>
<maml:para>Specifies the MSS clamping value for the IP interface. This value determines if this IP interface clamps MSS on the forwarded TCP packets that are sent out of this interface. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetIPInterface.ClampMss</command:parameterValue>
<dev:type>
<maml:name>Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetIPInterface.ClampMss</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CompartmentId</maml:name>
<maml:description>
<maml:para>Specifies an array of identifiers for network compartments in the protocol stack. By default, the cmdlet only sets Net IP interfaces in the default compartment. If you specify a value, the cmdlet sets any matching NetIPInterface in all compartments in this field.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CurrentHopLimit</maml:name>
<maml:description>
<maml:para>Specifies a hop limit. This parameter is the value that the IP interface writes in the hop limit field for IPv6, or the Time To Live (TTL) field for IPv4, in all outbound traffic. When forwarding a packet, routers decrement the hop limit, or TTL, by 1, and discard the packet when the hop limit reaches 0. The default is defined as DefaultHopLimit in the NetIPv4Protocol and NetIPv6Protocol objects. When this parameter value is set to 0, it uses this default.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="DadRetransmitTime">
<maml:name>DadRetransmitTimeMs</maml:name>
<maml:description>
<maml:para>Specifies a value for the time interval between neighbor solicitation messages.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DadTransmits</maml:name>
<maml:description>
<maml:para>Specifies a value for the number of consecutive messages sent while the network driver performs duplicate address detection.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Dhcp</maml:name>
<maml:description>
<maml:para>Specifies the Dynamic Host Configuration Protocol (DHCP) value for an IP interface. This setting is persistent across reboots and only stored in the active policy store.
Changes to the persistent store will have no effect. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Dhcp</command:parameterValue>
<dev:type>
<maml:name>Dhcp</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DirectedMacWolPattern</maml:name>
<maml:description>
<maml:para>Specifies the wake-up packet value for an IP interface. This parameter value determines if an IP interface is configured to wake up a computer with directed MAC packet patterns. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">DirectedMacWolPattern</command:parameterValue>
<dev:type>
<maml:name>DirectedMacWolPattern</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EcnMarking</maml:name>
<maml:description>
<maml:para>Specifies the value for Explicit Congestion Notification (ECN) marking. This parameter value controls the specific ECN marking in the ECN field of the IP header. The acceptable values for this parameter are:
-- AppDecide. Allow an application or higher layer protocol, such as TCP, to decide how to apply ECN marking. In order for an application to fully control ECN capability value in the Network TCP setting must also be set to Enabled.
-- Disabled. Disable the ECN marking on the IP interface.
-- UseEct0. Mark all of the egress IP packets on the IP interface with the Ect0 bit set.
-- UseEct1. Mark all of the egress IP packets on the IP interface with the Ect1 bit set.
The default value is AppDecide. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">EcnMarking</command:parameterValue>
<dev:type>
<maml:name>EcnMarking</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ForceArpNdWolPattern</maml:name>
<maml:description>
<maml:para>Specifies the Wake On LAN (WOL) value for the IP interface. This parameter value determines if an IP interface is configured to wake up a computer with Address Resolution Protocol (ARP) or Neighbor Discovery (ND) packet patterns. The default value is Disabled. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">ForceArpNdWolPattern</command:parameterValue>
<dev:type>
<maml:name>ForceArpNdWolPattern</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Forwarding</maml:name>
<maml:description>
<maml:para>Specifies the packet forwarding value for the IP interface. This value determines if this IP interface forwards packets that arrive on this interface to other interfaces. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Forwarding</command:parameterValue>
<dev:type>
<maml:name>Forwarding</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IgnoreDefaultRoutes</maml:name>
<maml:description>
<maml:para>Specifies a value for Default Route advertisements. If you enable this setting, default routes will not be dynamically added to the routing table. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">IgnoreDefaultRoutes</command:parameterValue>
<dev:type>
<maml:name>IgnoreDefaultRoutes</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes all non-default compartments.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet modifies IP interfaces that match the aliases.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet modifies IP interfaces that match the indexes.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>InterfaceMetric</maml:name>
<maml:description>
<maml:para>Specifies a metric for an IP interface. When routes are chosen, the overall metric used to determine the preference is the sum of the route metric and the interface metric. Typically, the interface metric gives preference to a particular interface, such as using wired if both wired and wireless are available. This parameter value uses the value generated by AutomaticMetric by default. If this parameter value is set, then the AutomaticMetric parameter is automatically disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ManagedAddressConfiguration</maml:name>
<maml:description>
<maml:para>Specifies the value for managed address configuration. This parameter determines if an IP interface uses a stateful protocol, such as DHCP, to obtain an address. Setting this parameter has no effect on an interface that has router discovery enabled and advertising disabled. In that case, the parameter is controlled by router discovery. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">ManagedAddressConfiguration</command:parameterValue>
<dev:type>
<maml:name>ManagedAddressConfiguration</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NeighborDiscoverySupported</maml:name>
<maml:description>
<maml:para>Specifies an array of neighbor discovery values for the IP interface. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">NeighborDiscoverySupported[]</command:parameterValue>
<dev:type>
<maml:name>NeighborDiscoverySupported[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NeighborUnreachabilityDetection</maml:name>
<maml:description>
<maml:para>Specifies the value for Neighbor Unreachability Detection (NUD). Use this parameter to determine when a neighbor is no longer reachable. For more information, see <maml:navigationLink><maml:linkText>RFC 2461</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. For ActiveStore, you can modify the NUD from Disabled to Enabled, but modifying NUD from Enabled to Disabled for ActiveStore fails with an invalid parameter. For the PersistentStore, you can modify the NUD to either Enabled or Disabled, but you will have to restart the interface for the setting to take effect.
The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">NeighborUnreachabilityDetection</command:parameterValue>
<dev:type>
<maml:name>NeighborUnreachabilityDetection</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NlMtuBytes</maml:name>
<maml:description>
<maml:para>Specifies the network layer Maximum Transmission Unit (MTU) value, in bytes, for an IP interface. For IPv4 the minimum value is 576 bytes. For IPv6 the minimum is value is 1280 bytes. For both IPv4 and IPv6, the maximum value is 2^32-1 (4294967295). You cannot set values outside these ranges. If this parameter is set to 0, then it will remain unchanged and maintain its current value. The IP interface will not transmit packets larger than the maximum value.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>OtherStatefulConfiguration</maml:name>
<maml:description>
<maml:para>Specifies the value for configuration other than addresses. This parameter determines if an IP interface uses a stateful protocol, such as DHCP, to obtain configuration information other than addresses. This parameter setting has no effect on an interface that has router discovery enabled and advertising disabled. In that case, the parameter is controlled by router discovery. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">OtherStatefulConfiguration</command:parameterValue>
<dev:type>
<maml:name>OtherStatefulConfiguration</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
The default value is ActiveStore. Specify ActiveStore only.</maml:para>
<maml:para>If you do not specify this parameter, the default entries are created in both the ActiveStore and the PersistentStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ReachableTime</maml:name>
<maml:description>
<maml:para>Specifies an array of reachable time values. This parameter is the time, in milliseconds, that a node assumes that a neighbor is reachable after having received a reachability confirmation. This parameter works with the NeighborUnreachabilityDetection parameter. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="RetransmitTime">
<maml:name>RetransmitTimeMs</maml:name>
<maml:description>
<maml:para>Specifies a value for timeout and retransmission, in milliseconds, for Neighbor Solicitation messages. For more information, see RetransTimer in <maml:navigationLink><maml:linkText>RFC 2461</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. By default, the value is set to 1000.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RouterDiscovery</maml:name>
<maml:description>
<maml:para>Specifies the value for router discovery for an IP interface, The acceptable values for this parameter are:
-- ControlledByDHCP. DHCP determines if the IP Interface can be used by the computer to locate routers that reside on an attached link.
-- Disabled: IP Interface will not be used by the computer to locate routers that reside on an attached link.
-- Enabled. IP Interface can be used by the computer to locate routers that reside on an attached link.
By default, the value of this parameter is ControlledByDHCP for IPv4 and Enabled for IPv6. If the value of this parameter is enabled, an IP host can locate routers that reside on an attached link.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">RouterDiscovery</command:parameterValue>
<dev:type>
<maml:name>RouterDiscovery</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>WeakHostReceive</maml:name>
<maml:description>
<maml:para>Specifies the receive value for a weak host model. By default, interface properties set this parameter to disabled. If this parameter is enabled, an IP host can receive IP packets on an interface that is not assigned the destination IP address of the packet being received. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">WeakHostReceive</command:parameterValue>
<dev:type>
<maml:name>WeakHostReceive</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>WeakHostSend</maml:name>
<maml:description>
<maml:para>Specifies the send value for a weak host model. By default, interface properties set this parameter to disabled. If this parameter is enabled, an IP host can send IP packets on an interface that is not assigned the destination IP address of the packet being sent.The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">WeakHostSend</command:parameterValue>
<dev:type>
<maml:name>WeakHostSend</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetIPInterface</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Modify an interface by the index value</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Set-NetIPInterface –InterfaceIndex 12 –Dhcp Disabled
</dev:code>
<dev:remarks>
<maml:para>This command modifies an IP interface object by using the interface index value of 12. The command also disables DHCP on the interface.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Modify the interface metrics</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetAdapter | Where-Object –FilterScript {$_.LinkSpeed –Eq "100 Mbps"} | Set-NetIPInterface –InterfaceMetric 21
</dev:code>
<dev:remarks>
<maml:para>This command modifies all of the network adapters on the computer with a link speed of 100 Mbps and sets the interface metric on them to 21.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=289166</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetAdapter</maml:linkText>
<maml:uri>
</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetIPInterface</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Set-NetIPv4Protocol</command:name>
<maml:description>
<maml:para>Modifies information about the IPv4 Protocol configuration.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Set</command:verb>
<command:noun>NetIPv4Protocol</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Set-NetIPv4Protocol cmdlet modifies the global IPv4 protocol configuration for a computer. If you do not specify any parameters for the cmdlet, the cmdlet sets the default values for the global IPv6 protocol configuration. </maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Set-NetIPv4Protocol</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressMaskReply</maml:name>
<maml:description>
<maml:para>Specifies a value for address mask reply. The cmdlet modifies the value for this setting. Address mask reply specifies how the computer responds to ICMP address mask packets. The acceptable values for this parameter are:
-- Enabled. The computer responds to ICMP address mask packets.
-- Disabled. The computer does not respond to ICMP address mask packets. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DeadGatewayDetection</maml:name>
<maml:description>
<maml:para>Specifies a value for dead gateway detection. The cmdlet modifies the value for this setting.</maml:para>
<maml:para>Dead gateway detection is a feature that identifies gateways that are not operating properly and switches the computer to a new default gateway if available. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DefaultHopLimit</maml:name>
<maml:description>
<maml:para>Specifies a value for the default hop limit. The cmdlet modifies the value for this setting. This parameter sets the default value for the CurrentHopLimit property in the IP interface. The current hop limit is the value that the IP interface writes in the hop limit field in all outbound IPv4 traffic. When routers forward a packet, they decrement the hop limit by 1 and discard the packet when the hop limit is 0. The default value is 128. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DhcpMediaSense</maml:name>
<maml:description>
<maml:para>Specifies a value for Media Sense. The cmdlet modifies the value for this setting.</maml:para>
<maml:para>Media Sense provides a mechanism for the network adapter to notify the protocol stack of media connect and disconnect events. These events trigger the DHCP client to take an action, such as attempting to renew a DHCP lease or removing routes that are related to a disconnected network. When Media Sense is enabled, the network parameters on the laptop of a roaming user are automatically and transparently updated without requiring a restart when the user moves from one location to another. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>GroupForwardedFragments</maml:name>
<maml:description>
<maml:para>Specifies a value for group forwarded fragments. The cmdlet modifies the value for this setting. Group forwarded fragments specifies whether the IP interface collects fragments into groups before it forwards the fragments. This parameter sets the GroupForwardedFragments property in the IP interface. The acceptable values for this parameter are:
-- Enabled. The IP interface collects IPv6 protocol fragments into groups before it forwards the fragments.
-- Disabled. The IP interface does not collect IPv6 protocol fragments into groups before it forwards the fragments.
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IcmpRedirects</maml:name>
<maml:description>
<maml:para>Specifies a value for Internet Control Message Protocol (ICMP) redirect. The cmdlet modifies the value for this setting. ICMP redirect specifies whether to update the path cache in response to ICMP redirect packets. This parameter sets the IcmpRedirects property in the IP interface. The acceptable values for this parameter are:
-- Enabled. The IP interface updates the path cache in response to ICMP redirect packets.
-- Disabled. The IP interface does not update the path cache in response to ICMP redirect packets.
The default value is Enabled. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="MldLevel">
<maml:name>IGMPLevel</maml:name>
<maml:description>
<maml:para>Specifies a value for Internet Group Management Protocol (IGMP) level. The cmdlet modifies the value for this setting. The IGMP level specifies the level of multicast support. The acceptable values for this parameter are:
-- None
-- SendOnly
-- All
The default value is All.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">None</command:parameterValue>
<command:parameterValue required="false" variableLength="false">SendOnly</command:parameterValue>
<command:parameterValue required="false" variableLength="false">All</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="MldVersion">
<maml:name>IGMPVersion</maml:name>
<maml:description>
<maml:para>Specifies a value for the IGMP version number. The cmdlet modifies the value for this setting. The IGMP version is the maximum IGMP version supported by the host.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Version1</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Version2</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Version3</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MediaSenseEventLog</maml:name>
<maml:description>
<maml:para>Specifies a value for Media Sense event log. The cmdlet modifies the value for this setting. The acceptable values for this parameter are:
-- Enabled. The IP interface logs DHCP Media Sense events in the event log for troubleshooting purposes.
-- Disabled. The IP interface does not log DHCP Media Sense events in the event log.
The default value is Disabled. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MinimumMtu</maml:name>
<maml:description>
<maml:para>Specifies a value, in bytes, for the network layer Maximum Transmission Unit (MTU). For IPv4 the minimum value is 576 bytes. For IPv6 the minimum is value is 1280 bytes. For both IPv4 and IPv6, the maximum value is 2^32-1 (4294967295). You cannot set values outside these ranges. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MulticastForwarding</maml:name>
<maml:description>
<maml:para>Specifies a value for multicast forwarding. The cmdlet modifies the value for this setting. The acceptable values for this parameter are:
-- Enabled. The computer can forward multicast packets.
-- Disabled. The computer cannot forward multicast packets.
The default value is Disabled. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NeighborCacheLimit">
<maml:name>NeighborCacheLimitEntries</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of neighbor cache entries. The cmdlet modifies the value for this setting.
The default value is 256. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RandomizeIdentifiers</maml:name>
<maml:description>
<maml:para>Specifies a value for the randomization of identifiers. The cmdlet modifies the value for this setting. The acceptable values for this parameter are:
-- Enabled. The IP interface randomizes identifiers when it creates an IP address.
-- Disabled. The IP interface does not randomize identifiers when it creates an IP address.
The default value is Enabled. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ReassemblyLimit">
<maml:name>ReassemblyLimitBytes</maml:name>
<maml:description>
<maml:para>Specifies a value for the maximum size of the reassembly buffer. The cmdlet modifies the value for this setting.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="RouteCacheLimit">
<maml:name>RouteCacheLimitEntries</maml:name>
<maml:description>
<maml:para>Specifies a value for the maximum number of route cache entries. The cmdlet modifies the value for this setting.
The default value is 128. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SourceRoutingBehavior</maml:name>
<maml:description>
<maml:para>Specifies a value for source routing behavior. The cmdlet modifies the value for this setting. The acceptable values for this parameter are:
-- DontForward. The computer can receive but not forward source-routed packets.
-- Drop. The computer drops source-routed packets.
The default value is DontForward. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Forward</command:parameterValue>
<command:parameterValue required="false" variableLength="false">DontForward</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Drop</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressMaskReply</maml:name>
<maml:description>
<maml:para>Specifies a value for address mask reply. The cmdlet modifies the value for this setting. Address mask reply specifies how the computer responds to ICMP address mask packets. The acceptable values for this parameter are:
-- Enabled. The computer responds to ICMP address mask packets.
-- Disabled. The computer does not respond to ICMP address mask packets. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">AddressMaskReply</command:parameterValue>
<dev:type>
<maml:name>AddressMaskReply</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DeadGatewayDetection</maml:name>
<maml:description>
<maml:para>Specifies a value for dead gateway detection. The cmdlet modifies the value for this setting.</maml:para>
<maml:para>Dead gateway detection is a feature that identifies gateways that are not operating properly and switches the computer to a new default gateway if available. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetIPv4Protocol.DeadGatewayDetection</command:parameterValue>
<dev:type>
<maml:name>Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetIPv4Protocol.DeadGatewayDetection</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DefaultHopLimit</maml:name>
<maml:description>
<maml:para>Specifies a value for the default hop limit. The cmdlet modifies the value for this setting. This parameter sets the default value for the CurrentHopLimit property in the IP interface. The current hop limit is the value that the IP interface writes in the hop limit field in all outbound IPv4 traffic. When routers forward a packet, they decrement the hop limit by 1 and discard the packet when the hop limit is 0. The default value is 128. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DhcpMediaSense</maml:name>
<maml:description>
<maml:para>Specifies a value for Media Sense. The cmdlet modifies the value for this setting.</maml:para>
<maml:para>Media Sense provides a mechanism for the network adapter to notify the protocol stack of media connect and disconnect events. These events trigger the DHCP client to take an action, such as attempting to renew a DHCP lease or removing routes that are related to a disconnected network. When Media Sense is enabled, the network parameters on the laptop of a roaming user are automatically and transparently updated without requiring a restart when the user moves from one location to another. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">DhcpMediaSense</command:parameterValue>
<dev:type>
<maml:name>DhcpMediaSense</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>GroupForwardedFragments</maml:name>
<maml:description>
<maml:para>Specifies a value for group forwarded fragments. The cmdlet modifies the value for this setting. Group forwarded fragments specifies whether the IP interface collects fragments into groups before it forwards the fragments. This parameter sets the GroupForwardedFragments property in the IP interface. The acceptable values for this parameter are:
-- Enabled. The IP interface collects IPv6 protocol fragments into groups before it forwards the fragments.
-- Disabled. The IP interface does not collect IPv6 protocol fragments into groups before it forwards the fragments.
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">GroupForwardedFragments</command:parameterValue>
<dev:type>
<maml:name>GroupForwardedFragments</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="MldLevel">
<maml:name>IGMPLevel</maml:name>
<maml:description>
<maml:para>Specifies a value for Internet Group Management Protocol (IGMP) level. The cmdlet modifies the value for this setting. The IGMP level specifies the level of multicast support. The acceptable values for this parameter are:
-- None
-- SendOnly
-- All
The default value is All.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">MldLevel</command:parameterValue>
<dev:type>
<maml:name>MldLevel</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="MldVersion">
<maml:name>IGMPVersion</maml:name>
<maml:description>
<maml:para>Specifies a value for the IGMP version number. The cmdlet modifies the value for this setting. The IGMP version is the maximum IGMP version supported by the host.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">MldVersion</command:parameterValue>
<dev:type>
<maml:name>MldVersion</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IcmpRedirects</maml:name>
<maml:description>
<maml:para>Specifies a value for Internet Control Message Protocol (ICMP) redirect. The cmdlet modifies the value for this setting. ICMP redirect specifies whether to update the path cache in response to ICMP redirect packets. This parameter sets the IcmpRedirects property in the IP interface. The acceptable values for this parameter are:
-- Enabled. The IP interface updates the path cache in response to ICMP redirect packets.
-- Disabled. The IP interface does not update the path cache in response to ICMP redirect packets.
The default value is Enabled. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">IcmpRedirects</command:parameterValue>
<dev:type>
<maml:name>IcmpRedirects</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MediaSenseEventLog</maml:name>
<maml:description>
<maml:para>Specifies a value for Media Sense event log. The cmdlet modifies the value for this setting. The acceptable values for this parameter are:
-- Enabled. The IP interface logs DHCP Media Sense events in the event log for troubleshooting purposes.
-- Disabled. The IP interface does not log DHCP Media Sense events in the event log.
The default value is Disabled. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">MediaSenseEventLog</command:parameterValue>
<dev:type>
<maml:name>MediaSenseEventLog</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MinimumMtu</maml:name>
<maml:description>
<maml:para>Specifies a value, in bytes, for the network layer Maximum Transmission Unit (MTU). For IPv4 the minimum value is 576 bytes. For IPv6 the minimum is value is 1280 bytes. For both IPv4 and IPv6, the maximum value is 2^32-1 (4294967295). You cannot set values outside these ranges. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MulticastForwarding</maml:name>
<maml:description>
<maml:para>Specifies a value for multicast forwarding. The cmdlet modifies the value for this setting. The acceptable values for this parameter are:
-- Enabled. The computer can forward multicast packets.
-- Disabled. The computer cannot forward multicast packets.
The default value is Disabled. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">MulticastForwarding</command:parameterValue>
<dev:type>
<maml:name>MulticastForwarding</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NeighborCacheLimit">
<maml:name>NeighborCacheLimitEntries</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of neighbor cache entries. The cmdlet modifies the value for this setting.
The default value is 256. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RandomizeIdentifiers</maml:name>
<maml:description>
<maml:para>Specifies a value for the randomization of identifiers. The cmdlet modifies the value for this setting. The acceptable values for this parameter are:
-- Enabled. The IP interface randomizes identifiers when it creates an IP address.
-- Disabled. The IP interface does not randomize identifiers when it creates an IP address.
The default value is Enabled. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">RandomizeIdentifiers</command:parameterValue>
<dev:type>
<maml:name>RandomizeIdentifiers</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ReassemblyLimit">
<maml:name>ReassemblyLimitBytes</maml:name>
<maml:description>
<maml:para>Specifies a value for the maximum size of the reassembly buffer. The cmdlet modifies the value for this setting.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="RouteCacheLimit">
<maml:name>RouteCacheLimitEntries</maml:name>
<maml:description>
<maml:para>Specifies a value for the maximum number of route cache entries. The cmdlet modifies the value for this setting.
The default value is 128. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SourceRoutingBehavior</maml:name>
<maml:description>
<maml:para>Specifies a value for source routing behavior. The cmdlet modifies the value for this setting. The acceptable values for this parameter are:
-- DontForward. The computer can receive but not forward source-routed packets.
-- Drop. The computer drops source-routed packets.
The default value is DontForward. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SourceRoutingBehavior</command:parameterValue>
<dev:type>
<maml:name>SourceRoutingBehavior</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetIPv4Protocol</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Enable the DHCP Media Sense event log</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Set-NetIPv4Protocol –MediaSenseEventLog Enabled
</dev:code>
<dev:remarks>
<maml:para>This command enables the DHCP Media Sense event log.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Increase the number of neighbors</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Set-NetIPv4Protocol –NeighborCacheLimitEntries 1000
</dev:code>
<dev:remarks>
<maml:para>This command increases the size of the cache of on-link neighbors on the subnet to 1,000. The default value is 256.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=289167</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Architectural Overview of the TCP/IP Protocol Suite on TechNet</maml:linkText>
<maml:uri>
</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetIPv4Protocol</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Set-NetIPv6Protocol</command:name>
<maml:description>
<maml:para>Modifies the IPv6 protocol configuration.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Set</command:verb>
<command:noun>NetIPv6Protocol</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Set-NetIPv6Protocol cmdlet modifies the global IPv6 protocol configuration for a computer. If you do not specify any parameters for the cmdlet, the cmdlet sets the default values for the IPv6 protocol configuration. </maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Set-NetIPv6Protocol</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressMaskReply</maml:name>
<maml:description>
<maml:para>Specifies a value for address mask reply. The cmdlet modifies the value for this setting. Address mask reply specifies how the computer responds to ICMP address mask packets. The acceptable values for this parameter are:
-- Enabled. The computer responds to ICMP address mask packets.
-- Disabled. The computer does not respond to ICMP address mask packets. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DeadGatewayDetection</maml:name>
<maml:description>
<maml:para>Specifies a value for dead gateway detection. The cmdlet modifies the value for this setting.</maml:para>
<maml:para>Dead gateway detection is a feature that identifies gateways that are not operating properly and switches the computer to a new default gateway if available. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DefaultHopLimit</maml:name>
<maml:description>
<maml:para>Specifies a value for the default hop limit. The cmdlet modifies the value for this setting. This parameter sets the default value for the CurrentHopLimit property in the IP interface. The current hop limit is the value that the IP interface writes in the hop limit field in all outbound IPv6 traffic. When routers forward a packet, they decrement the hop limit by 1 and discard the packet when the hop limit is 0. The default value is 128. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DhcpMediaSense</maml:name>
<maml:description>
<maml:para>Specifies a value for Media Sense. The cmdlet modifies the value for this setting.</maml:para>
<maml:para>Media Sense provides a mechanism for the network adapter to notify the protocol stack of media connect and disconnect events. These events trigger the DHCP client to take an action, such as attempting to renew a DHCP lease or removing routes that are related to a disconnected network. When Media Sense is enabled, the network parameters on the laptop of a roaming user are automatically and transparently updated without requiring a restart when the user moves from one location to another. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>GroupForwardedFragments</maml:name>
<maml:description>
<maml:para>Specifies a value for group forwarded fragments. The cmdlet modifies the value for this setting. Group forwarded fragments specifies whether the IP interface collects fragments into groups before it forwards the fragments. This parameter sets the GroupForwardedFragments property in the IP interface. The acceptable values for this parameter are:
-- Enabled. The IP interface collects IPv6 protocol fragments into groups before it forwards the fragments.
-- Disabled. The IP interface does not collect IPv6 protocol fragments into groups before it forwards the fragments.
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IcmpRedirects</maml:name>
<maml:description>
<maml:para>Specifies a value for Internet Control Message Protocol (ICMP) redirect. The cmdlet modifies the value for this setting. ICMP redirect specifies whether to update the path cache in response to ICMP redirect packets. This parameter sets the IcmpRedirects property in the IP interface. The acceptable values for this parameter are:
-- Enabled. The IP interface updates the path cache in response to ICMP redirect packets.
-- Disabled. The IP interface does not update the path cache in response to ICMP redirect packets.
The default value is Enabled. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="MaxDadAttempts">
<maml:name>MaxTemporaryDadAttempts</maml:name>
<maml:description>
<maml:para>Specifies a value for the maximum number of duplicate address detection attempts for temporary addresses. The cmdlet modifies the value for this setting.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="MaxRandomTime">
<maml:name>MaxTemporaryDesyncTime</maml:name>
<maml:description>
<maml:para>Specifies a value for the maximum time to desynchronize temporary address preferred lifetimes. The cmdlet modifies the value for this setting.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="MaxPreferredLifetime">
<maml:name>MaxTemporaryPreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values, as TimeSpan objects, for the maximum preferred lifetime over which to prefer a temporary address. The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="MaxValidLifetime">
<maml:name>MaxTemporaryValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies a value, as a TimeSpan object, for the maximum lifetime over which a temporary address is valid. The cmdlet modifies the value for this setting. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MediaSenseEventLog</maml:name>
<maml:description>
<maml:para>Specifies a value for Media Sense event log. The cmdlet modifies the value for this setting. The acceptable values for this parameter are:
-- Enabled. The IP interface logs DHCP Media Sense events in the event log for troubleshooting purposes.
-- Disabled. The IP interface does not log DHCP Media Sense events in the event log.
The default value is Disabled. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MldLevel</maml:name>
<maml:description>
<maml:para>Specifies a value for the level of Multicast Listener Discovery (MLD) support. The cmdlet modifies the value for this setting. The acceptable values for this parameter are:
-- All. The computer can send and receive multicast packets.
-- None. The computer cannot send or receive multicast packets.
-- SendOnly. The computer can send but not receive multicast packets.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">None</command:parameterValue>
<command:parameterValue required="false" variableLength="false">SendOnly</command:parameterValue>
<command:parameterValue required="false" variableLength="false">All</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MldVersion</maml:name>
<maml:description>
<maml:para>Specifies a value for the maximum version of Multicast Listener Discovery that the host supports. The cmdlet modifies the value for this setting.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Version1</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Version2</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MulticastForwarding</maml:name>
<maml:description>
<maml:para>Specifies a value for multicast forwarding. The cmdlet modifies the value for this setting. The acceptable values for this parameter are:
-- Enabled. The computer can forward multicast packets.
-- Disabled. The computer cannot forward multicast packets.
The default value is Disabled. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NeighborCacheLimit">
<maml:name>NeighborCacheLimitEntries</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of neighbor cache entries. The cmdlet modifies the value for this setting.
The default value is 256. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RandomizeIdentifiers</maml:name>
<maml:description>
<maml:para>Specifies a value for the randomization of identifiers. The cmdlet modifies the value for this setting. The acceptable values for this parameter are:
-- Enabled. The IP interface randomizes identifiers when it creates an IP address.
-- Disabled. The IP interface does not randomize identifiers when it creates an IP address.
The default value is Enabled. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ReassemblyLimit">
<maml:name>ReassemblyLimitBytes</maml:name>
<maml:description>
<maml:para>Specifies a value for the maximum size of the reassembly buffer. The cmdlet modifies the value for this setting.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="RouteCacheLimit">
<maml:name>RouteCacheLimitEntries</maml:name>
<maml:description>
<maml:para>Specifies a value for the maximum number of route cache entries. The cmdlet modifies the value for this setting.
The default value is 128. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SourceRoutingBehavior</maml:name>
<maml:description>
<maml:para>Specifies a value for source routing behavior. The cmdlet modifies the value for this setting. The acceptable values for this parameter are:
-- DontForward. The computer can receive but not forward source-routed packets.
-- Drop. The computer drops source-routed packets.
The default value is DontForward. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Forward</command:parameterValue>
<command:parameterValue required="false" variableLength="false">DontForward</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Drop</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="RegenerateTime">
<maml:name>TemporaryRegenerateTime</maml:name>
<maml:description>
<maml:para>Specifies a value, as a TimeSpan object, for the time prior to deprecating a temporary address when a new address is generated. </maml:para>
<maml:para>The cmdlet modifies the value for this setting.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>UseTemporaryAddresses</maml:name>
<maml:description>
<maml:para>Specifies a value for temporary addresses. The cmdlet modifies the value for this setting.
-- Always. The computer always generates temporary addresses by using random numbers.
-- Counter. The computer generates temporary addresses by using the interface identifier. You typically use this identifier for test purposes.
-- Disabled. The computer does not use temporary addresses.
-- Enabled. The computer uses temporary addresses. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Always</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressMaskReply</maml:name>
<maml:description>
<maml:para>Specifies a value for address mask reply. The cmdlet modifies the value for this setting. Address mask reply specifies how the computer responds to ICMP address mask packets. The acceptable values for this parameter are:
-- Enabled. The computer responds to ICMP address mask packets.
-- Disabled. The computer does not respond to ICMP address mask packets. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">AddressMaskReply</command:parameterValue>
<dev:type>
<maml:name>AddressMaskReply</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DeadGatewayDetection</maml:name>
<maml:description>
<maml:para>Specifies a value for dead gateway detection. The cmdlet modifies the value for this setting.</maml:para>
<maml:para>Dead gateway detection is a feature that identifies gateways that are not operating properly and switches the computer to a new default gateway if available. The acceptable values for this parameter are:
-- Enabled
-- Disabled</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetIPv6Protocol.DeadGatewayDetection</command:parameterValue>
<dev:type>
<maml:name>Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetIPv6Protocol.DeadGatewayDetection</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DefaultHopLimit</maml:name>
<maml:description>
<maml:para>Specifies a value for the default hop limit. The cmdlet modifies the value for this setting. This parameter sets the default value for the CurrentHopLimit property in the IP interface. The current hop limit is the value that the IP interface writes in the hop limit field in all outbound IPv6 traffic. When routers forward a packet, they decrement the hop limit by 1 and discard the packet when the hop limit is 0. The default value is 128. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DhcpMediaSense</maml:name>
<maml:description>
<maml:para>Specifies a value for Media Sense. The cmdlet modifies the value for this setting.</maml:para>
<maml:para>Media Sense provides a mechanism for the network adapter to notify the protocol stack of media connect and disconnect events. These events trigger the DHCP client to take an action, such as attempting to renew a DHCP lease or removing routes that are related to a disconnected network. When Media Sense is enabled, the network parameters on the laptop of a roaming user are automatically and transparently updated without requiring a restart when the user moves from one location to another. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">DhcpMediaSense</command:parameterValue>
<dev:type>
<maml:name>DhcpMediaSense</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>GroupForwardedFragments</maml:name>
<maml:description>
<maml:para>Specifies a value for group forwarded fragments. The cmdlet modifies the value for this setting. Group forwarded fragments specifies whether the IP interface collects fragments into groups before it forwards the fragments. This parameter sets the GroupForwardedFragments property in the IP interface. The acceptable values for this parameter are:
-- Enabled. The IP interface collects IPv6 protocol fragments into groups before it forwards the fragments.
-- Disabled. The IP interface does not collect IPv6 protocol fragments into groups before it forwards the fragments.
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">GroupForwardedFragments</command:parameterValue>
<dev:type>
<maml:name>GroupForwardedFragments</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IcmpRedirects</maml:name>
<maml:description>
<maml:para>Specifies a value for Internet Control Message Protocol (ICMP) redirect. The cmdlet modifies the value for this setting. ICMP redirect specifies whether to update the path cache in response to ICMP redirect packets. This parameter sets the IcmpRedirects property in the IP interface. The acceptable values for this parameter are:
-- Enabled. The IP interface updates the path cache in response to ICMP redirect packets.
-- Disabled. The IP interface does not update the path cache in response to ICMP redirect packets.
The default value is Enabled. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">IcmpRedirects</command:parameterValue>
<dev:type>
<maml:name>IcmpRedirects</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="MaxDadAttempts">
<maml:name>MaxTemporaryDadAttempts</maml:name>
<maml:description>
<maml:para>Specifies a value for the maximum number of duplicate address detection attempts for temporary addresses. The cmdlet modifies the value for this setting.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="MaxRandomTime">
<maml:name>MaxTemporaryDesyncTime</maml:name>
<maml:description>
<maml:para>Specifies a value for the maximum time to desynchronize temporary address preferred lifetimes. The cmdlet modifies the value for this setting.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
<dev:type>
<maml:name>TimeSpan</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="MaxPreferredLifetime">
<maml:name>MaxTemporaryPreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies an array of values, as TimeSpan objects, for the maximum preferred lifetime over which to prefer a temporary address. The cmdlet gets IPv6 protocol configurations that have these values.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
<dev:type>
<maml:name>TimeSpan</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="MaxValidLifetime">
<maml:name>MaxTemporaryValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies a value, as a TimeSpan object, for the maximum lifetime over which a temporary address is valid. The cmdlet modifies the value for this setting. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
<dev:type>
<maml:name>TimeSpan</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MediaSenseEventLog</maml:name>
<maml:description>
<maml:para>Specifies a value for Media Sense event log. The cmdlet modifies the value for this setting. The acceptable values for this parameter are:
-- Enabled. The IP interface logs DHCP Media Sense events in the event log for troubleshooting purposes.
-- Disabled. The IP interface does not log DHCP Media Sense events in the event log.
The default value is Disabled. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">MediaSenseEventLog</command:parameterValue>
<dev:type>
<maml:name>MediaSenseEventLog</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MldLevel</maml:name>
<maml:description>
<maml:para>Specifies a value for the level of Multicast Listener Discovery (MLD) support. The cmdlet modifies the value for this setting. The acceptable values for this parameter are:
-- All. The computer can send and receive multicast packets.
-- None. The computer cannot send or receive multicast packets.
-- SendOnly. The computer can send but not receive multicast packets.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">MldLevel</command:parameterValue>
<dev:type>
<maml:name>MldLevel</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MldVersion</maml:name>
<maml:description>
<maml:para>Specifies a value for the maximum version of Multicast Listener Discovery that the host supports. The cmdlet modifies the value for this setting.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">MldVersion</command:parameterValue>
<dev:type>
<maml:name>MldVersion</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MulticastForwarding</maml:name>
<maml:description>
<maml:para>Specifies a value for multicast forwarding. The cmdlet modifies the value for this setting. The acceptable values for this parameter are:
-- Enabled. The computer can forward multicast packets.
-- Disabled. The computer cannot forward multicast packets.
The default value is Disabled. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">MulticastForwarding</command:parameterValue>
<dev:type>
<maml:name>MulticastForwarding</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NeighborCacheLimit">
<maml:name>NeighborCacheLimitEntries</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of neighbor cache entries. The cmdlet modifies the value for this setting.
The default value is 256. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RandomizeIdentifiers</maml:name>
<maml:description>
<maml:para>Specifies a value for the randomization of identifiers. The cmdlet modifies the value for this setting. The acceptable values for this parameter are:
-- Enabled. The IP interface randomizes identifiers when it creates an IP address.
-- Disabled. The IP interface does not randomize identifiers when it creates an IP address.
The default value is Enabled. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">RandomizeIdentifiers</command:parameterValue>
<dev:type>
<maml:name>RandomizeIdentifiers</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ReassemblyLimit">
<maml:name>ReassemblyLimitBytes</maml:name>
<maml:description>
<maml:para>Specifies a value for the maximum size of the reassembly buffer. The cmdlet modifies the value for this setting.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="RouteCacheLimit">
<maml:name>RouteCacheLimitEntries</maml:name>
<maml:description>
<maml:para>Specifies a value for the maximum number of route cache entries. The cmdlet modifies the value for this setting.
The default value is 128. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>SourceRoutingBehavior</maml:name>
<maml:description>
<maml:para>Specifies a value for source routing behavior. The cmdlet modifies the value for this setting. The acceptable values for this parameter are:
-- DontForward. The computer can receive but not forward source-routed packets.
-- Drop. The computer drops source-routed packets.
The default value is DontForward. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SourceRoutingBehavior</command:parameterValue>
<dev:type>
<maml:name>SourceRoutingBehavior</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="RegenerateTime">
<maml:name>TemporaryRegenerateTime</maml:name>
<maml:description>
<maml:para>Specifies a value, as a TimeSpan object, for the time prior to deprecating a temporary address when a new address is generated. </maml:para>
<maml:para>The cmdlet modifies the value for this setting.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
<dev:type>
<maml:name>TimeSpan</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>UseTemporaryAddresses</maml:name>
<maml:description>
<maml:para>Specifies a value for temporary addresses. The cmdlet modifies the value for this setting.
-- Always. The computer always generates temporary addresses by using random numbers.
-- Counter. The computer generates temporary addresses by using the interface identifier. You typically use this identifier for test purposes.
-- Disabled. The computer does not use temporary addresses.
-- Enabled. The computer uses temporary addresses. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UseTemporaryAddresses</command:parameterValue>
<dev:type>
<maml:name>UseTemporaryAddresses</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetIPv6Protocol</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Enable the DHCP Media Sense event log</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Set-NetIPv6Protocol –MediaSenseEventLog Enabled
</dev:code>
<dev:remarks>
<maml:para>This command enables the DHCP Media Sense event log.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Increase the number of neighbors</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Set-NetIPv6Protocol –NeighborCacheLimitEntries 1000
</dev:code>
<dev:remarks>
<maml:para>This command increases the size of the cache of on-link neighbors on the subnet to 1,000. The default value is 256.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=289168</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetIPv6Protocol</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetIPv4Protocol</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Set-NetNeighbor</command:name>
<maml:description>
<maml:para>Modifies a neighbor cache entry.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Set</command:verb>
<command:noun>NetNeighbor</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Set-NetNeighbor cmdlet modifies a neighbor cache entry. The neighbor cache maintains information for each on-link neighbor, including the IP address and the associated link-layer address. You can modify only neighbor cache entries that are in a permanent state on interfaces that have link-layer addresses. Use this cmdlet to modify the link-layer address and policy store setting of a neighbor cache entry.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Set-NetNeighbor</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>IPAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of IP addresses. The cmdlet modifies neighbor cache entries that have the IP addresses you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address families. The cmdlet modifies the neighbor cache entries that belong to the IP address families you specify. If you do not specify this parameter, the cmdlet automatically generates the address families of the neighbor cache entries. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes neighbor cache entries from all configured network compartments. If you do not specify this parameter, the cmdlet modifies only neighbor cache entries in the default network compartment.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet modifies neighbor cache entries for the network interfaces that have the aliases you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet modifies neighbor cache entries for the network interfaces located at the indexes you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LinkLayerAddress</maml:name>
<maml:description>
<maml:para>Specifies the link-layer address of the neighbor cache entry. The cmdlet modifies the link-layer address of the neighbor cache entry you specify.</maml:para>
<maml:para>The link-layer address is also called the media access control (MAC) address. A link-layer address that uses IPv4 address syntax is a tunnel technology that encapsulates packets over an IPv4 tunnel, such as Intra-Site Automatic Tunnel Addressing Protocol (ISATAP) or Teredo. A link-layer address of all zeroes indicates that the neighbor is unreachable and the neighbor cache entry does not have a link-layer address entry. An empty link-layer address indicates that the link layer does not use link-layer addresses, such as on a loopback interface.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The cmdlet modifies the PolicyStore setting for the neighbor cache entry to the value you specify. The acceptable values for this parameter are:
-- ActiveStore: The IP address information is valid.
-- PersistentStore: The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
Specify ActiveStore only.</maml:para>
<maml:para>If you do not specify this parameter, the default entries are created in both the ActiveStore and the PersistentStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>State</maml:name>
<maml:description>
<maml:para>Specifies an array of states of the neighbor cache entry. The cmdlet modifies the neighbor cache entries that have the states you specify. You can modify only neighbor cache entries that are in a permanent state. The acceptable values for this parameter are:
-- Permanent. The neighbor is statically provisioned and will not expire unless you remove it.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">State[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Set-NetNeighbor</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LinkLayerAddress</maml:name>
<maml:description>
<maml:para>Specifies the link-layer address of the neighbor cache entry. The cmdlet modifies the link-layer address of the neighbor cache entry you specify.</maml:para>
<maml:para>The link-layer address is also called the media access control (MAC) address. A link-layer address that uses IPv4 address syntax is a tunnel technology that encapsulates packets over an IPv4 tunnel, such as Intra-Site Automatic Tunnel Addressing Protocol (ISATAP) or Teredo. A link-layer address of all zeroes indicates that the neighbor is unreachable and the neighbor cache entry does not have a link-layer address entry. An empty link-layer address indicates that the link layer does not use link-layer addresses, such as on a loopback interface.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address families. The cmdlet modifies the neighbor cache entries that belong to the IP address families you specify. If you do not specify this parameter, the cmdlet automatically generates the address families of the neighbor cache entries. The acceptable values for this parameter are:
-- IPv4
-- IPv6</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
<dev:type>
<maml:name>AddressFamily[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes neighbor cache entries from all configured network compartments. If you do not specify this parameter, the cmdlet modifies only neighbor cache entries in the default network compartment.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>IPAddress</maml:name>
<maml:description>
<maml:para>Specifies an array of IP addresses. The cmdlet modifies neighbor cache entries that have the IP addresses you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>LinkLayerAddress</maml:name>
<maml:description>
<maml:para>Specifies the link-layer address of the neighbor cache entry. The cmdlet modifies the link-layer address of the neighbor cache entry you specify.</maml:para>
<maml:para>The link-layer address is also called the media access control (MAC) address. A link-layer address that uses IPv4 address syntax is a tunnel technology that encapsulates packets over an IPv4 tunnel, such as Intra-Site Automatic Tunnel Addressing Protocol (ISATAP) or Teredo. A link-layer address of all zeroes indicates that the neighbor is unreachable and the neighbor cache entry does not have a link-layer address entry. An empty link-layer address indicates that the link layer does not use link-layer addresses, such as on a loopback interface.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet modifies neighbor cache entries for the network interfaces that have the aliases you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet modifies neighbor cache entries for the network interfaces located at the indexes you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The cmdlet modifies the PolicyStore setting for the neighbor cache entry to the value you specify. The acceptable values for this parameter are:
-- ActiveStore: The IP address information is valid.
-- PersistentStore: The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
Specify ActiveStore only.</maml:para>
<maml:para>If you do not specify this parameter, the default entries are created in both the ActiveStore and the PersistentStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>State</maml:name>
<maml:description>
<maml:para>Specifies an array of states of the neighbor cache entry. The cmdlet modifies the neighbor cache entries that have the states you specify. You can modify only neighbor cache entries that are in a permanent state. The acceptable values for this parameter are:
-- Permanent. The neighbor is statically provisioned and will not expire unless you remove it.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">State[]</command:parameterValue>
<dev:type>
<maml:name>State[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetNeighbor</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Set the link-layer address for a neighbor cache entry</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Set-NetNeighbor –InterfaceIndex 12 –IPAddress "192.168.0.5" –LinkLayerAddress "00-00-12-00-00-ff"
</dev:code>
<dev:remarks>
<maml:para>This command sets the link-layer address for the neighbor cache entry that has the IP address 192.168.0.5 and the interface index value of 12.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Set the link-layer address for a neighbor cache entry by using an input object</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Get-NetNeighbor –InterfaceIndex 12 –IPAddress "192.168.0.5" | Set-NetNeighbor –LinkLayerAddress "00-00-12-00-00-ff"
</dev:code>
<dev:remarks>
<maml:para>This command gets the NetNeighbor object that has the IP address 192.168.0.5 and the interface index value of 12. The command passes the object to the Set-NetNeighbor cmdlet by using the pipeline operator. Set-NetNeighbor sets the link-layer address for the neighbor cache entry to 00-00-12-00-00-ff.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=289169</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetNeighbor</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>New-NetNeighbor</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-NetNeighbor</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Set-NetOffloadGlobalSetting</command:name>
<maml:description>
<maml:para>Modifies the global TCP/IP offload settings.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Set</command:verb>
<command:noun>NetOffloadGlobalSetting</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Set-NetOffloadGlobalSetting cmdlet modifies the global TCP/IP offload settings. The global settings include Receive Side Scaling, Receive Segment Coalescing, task offload, and NetworkDirect properties.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Set-NetOffloadGlobalSetting</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Chimney</maml:name>
<maml:description>
<maml:para>Specifies the TCP Chimney global state on the computer. The acceptable values for this parameter are:
-- Enabled
-- Disabled
-- Automatic
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Automatic</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NetworkDirect</maml:name>
<maml:description>
<maml:para>Specifies the NetworkDirect Remote Direct Memory Access (RDMA) value on the computer. Use this parameter only on servers. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NetworkDirectAcrossIPSubnets</maml:name>
<maml:description>
<maml:para>Specifies a value for NetworkDirect connectivity from outside a local IP network. The acceptable values for this parameter are:
-- Allowed
-- Blocked</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Blocked</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Allowed</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PacketCoalescingFilter</maml:name>
<maml:description>
<maml:para>Specifies the values for the packet-coalescing filter on the computer. To reduce the number of interrupts that a computer processes, the packet-coalescing filter combines random broadcast and multicast packets, such as Address Resolution Protocol (ARP) requests, Neighbor Discovery messages, and Simple Service Discovery Protocol (SSDP) requests, into a single packet. Use this parameter only on client computers. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ReceiveSegmentCoalescing</maml:name>
<maml:description>
<maml:para>Specifies the Receive Segment Coalescing settings on the computer. Receive Segment Coalescing parses small packets of data and combines the data into a single packet. Coalescing small packets into a single packet reduces the overhead that is required to process packets. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ReceiveSideScaling</maml:name>
<maml:description>
<maml:para>Specifies the Receive Side Scaling settings on the computer. Receive Side Scaling distributes the network processing load across multiple processor cores. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>TaskOffload</maml:name>
<maml:description>
<maml:para>Specifies the global TCP/IP task offload settings. Task offload settings include IP checksum offload, Internet Protocol security (IPsec) task offload, and Large Send Offload. These features reduce the overhead of per-packet processing by distributing packet processing tasks, such as checksum calculation, to a network adapter. A modification takes effect after a computer restarts or a network adapter restarts. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Chimney</maml:name>
<maml:description>
<maml:para>Specifies the TCP Chimney global state on the computer. The acceptable values for this parameter are:
-- Enabled
-- Disabled
-- Automatic
The default value is Disabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">ChimneyEnum</command:parameterValue>
<dev:type>
<maml:name>ChimneyEnum</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NetworkDirect</maml:name>
<maml:description>
<maml:para>Specifies the NetworkDirect Remote Direct Memory Access (RDMA) value on the computer. Use this parameter only on servers. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">EnabledDisabledEnum</command:parameterValue>
<dev:type>
<maml:name>EnabledDisabledEnum</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NetworkDirectAcrossIPSubnets</maml:name>
<maml:description>
<maml:para>Specifies a value for NetworkDirect connectivity from outside a local IP network. The acceptable values for this parameter are:
-- Allowed
-- Blocked</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">AllowedBlockedEnum</command:parameterValue>
<dev:type>
<maml:name>AllowedBlockedEnum</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PacketCoalescingFilter</maml:name>
<maml:description>
<maml:para>Specifies the values for the packet-coalescing filter on the computer. To reduce the number of interrupts that a computer processes, the packet-coalescing filter combines random broadcast and multicast packets, such as Address Resolution Protocol (ARP) requests, Neighbor Discovery messages, and Simple Service Discovery Protocol (SSDP) requests, into a single packet. Use this parameter only on client computers. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">EnabledDisabledEnum</command:parameterValue>
<dev:type>
<maml:name>EnabledDisabledEnum</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ReceiveSegmentCoalescing</maml:name>
<maml:description>
<maml:para>Specifies the Receive Segment Coalescing settings on the computer. Receive Segment Coalescing parses small packets of data and combines the data into a single packet. Coalescing small packets into a single packet reduces the overhead that is required to process packets. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">EnabledDisabledEnum</command:parameterValue>
<dev:type>
<maml:name>EnabledDisabledEnum</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ReceiveSideScaling</maml:name>
<maml:description>
<maml:para>Specifies the Receive Side Scaling settings on the computer. Receive Side Scaling distributes the network processing load across multiple processor cores. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">EnabledDisabledEnum</command:parameterValue>
<dev:type>
<maml:name>EnabledDisabledEnum</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>TaskOffload</maml:name>
<maml:description>
<maml:para>Specifies the global TCP/IP task offload settings. Task offload settings include IP checksum offload, Internet Protocol security (IPsec) task offload, and Large Send Offload. These features reduce the overhead of per-packet processing by distributing packet processing tasks, such as checksum calculation, to a network adapter. A modification takes effect after a computer restarts or a network adapter restarts. The acceptable values for this parameter are:
-- Enabled
-- Disabled
The default value is Enabled.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">EnabledDisabledEnum</command:parameterValue>
<dev:type>
<maml:name>EnabledDisabledEnum</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetOffloadGlobalSetting</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Enable Receive Segment Coalescing</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Set-NetOffloadGlobalSetting –ReceiveSegmentCoalescing Enabled
</dev:code>
<dev:remarks>
<maml:para>This command enables Receive Segment Coalescing on the computer.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=289170</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetOffloadGlobalSetting</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Set-NetRoute</command:name>
<maml:description>
<maml:para>Modifies an entry or entries in the IP routing table.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Set</command:verb>
<command:noun>NetRoute</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Set-NetRoute cmdlet modifies entries in the IP routing table. Specify routes to modify by using the DestinationPrefix parameter or the NextHop parameter. You can also specify routes by using the Get-NetRoute cmdlet. If you do not specify which routes to modify, the cmdlets modifies all of the routes on the computer. </maml:para>
<maml:para>IP routing is the process of forwarding a packet based on the destination IP address. Routing occurs at TCP/IP hosts and at IP routers. The sending host or router determines where to forward the packet. To determine where to forward a packet, the host or router consults a routing table that is stored in memory. When TCP/IP starts, it creates entries in the routing table. You can add entries either manually or automatically. </maml:para>
<maml:para>For more information about routing, see <maml:navigationLink><maml:linkText>Chapter 5 - IP Routing</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://technet.microsoft.com/library/bb727001.aspx) in the TechNet library.</maml:para>
<maml:para>After you create an entry in the routing table, you cannot modify the destination prefix or the next hop value. If necessary, use the Remove-NetRoute cmdlet to remove the entry, and then recreate it with the desired values by using the New-NetRoute cmdlet.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Set-NetRoute</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>DestinationPrefix</maml:name>
<maml:description>
<maml:para>Specifies an array of destination prefixes of IP routes. The cmdlet modifies settings for this IP route. A destination prefix contains an IP address prefix and a prefix length, separated by a slash (/). A value of 0.0.0.0/0 for IPv4 or ::/0 for IPv6 indicates that the value of the NextHop parameter is a default gateway.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address families of IP routes. The cmdlet modifies the family that you specify for the IP route. The acceptable values for this parameter are:
-- IPv4
-- IPv6 </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes routes from all configured network compartments. If you do not specify this parameter, the cmdlet modifies only routes in the default network compartment. </maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet modifies IP routes for the interfaces that have the aliases that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet modifies IP routes for the interfaces located at the indexes that you specify. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NextHop</maml:name>
<maml:description>
<maml:para>Specifies an array of next hop values. The cmdlet modifies the routes that have these values. A value of 0.0.0.0 for IPv4 or :: for IPv6 indicates that the route is on the local subnet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The cmdlet changes the PolicyStore value to the value that you specify. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
Specify ActiveStore only.</maml:para>
<maml:para>If you do not specify this parameter, the default entries are created in both the ActiveStore and the PersistentStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies a preferred lifetime, as a TimeSpan object, of an IP route. The cmdlet changes the lifetime to the value that you specify. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. For more information, type Get-Help New-TimeSpan. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Protocol</maml:name>
<maml:description>
<maml:para>Specifies an array of types of routing protocols. The cmdlet changes the protocol to the value you specify. The acceptable values for this parameter are:
-- Bbn
-- Bgp
-- Dhcp
-- Dvmrp
-- Egp
-- Eigrp
-- EsIs
-- Ggp
-- Hello
-- Icmp
-- Idpr
-- Igrp
-- IsIs
-- Local
-- NetMgmt
-- Ospf
-- Rip
-- Rpl
-- Other</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Protocol[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Publish</maml:name>
<maml:description>
<maml:para>Specifies the publish setting of an IP route. The cmdlet changes the publish value to the value that you specify. The acceptable values for this parameter are:
-- No. Do not publish or advertise IP route information in router advertisements.
-- Yes. Publish and advertise IP route information with an infinite valid lifetime in router advertisements.
-- Age. Publish and advertise IP route information with a finite valid lifetime, in router advertisements. Specify a valid lifetime by using the ValidLifetime parameter. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">No</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Age</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Yes</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RouteMetric</maml:name>
<maml:description>
<maml:para>Specifies an integer route metric for an IP route. The cmdlet changes the metric to the value that you specify. To choose among multiple routes, the computer adds this value to the interface metric value. The computer selects the route with the lowest combined value. To modify the interface metric, use the Set-NetIPInterface cmdlet. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies a valid lifetime, as a TimeSpan object, for an IP route. The cmdlet changes the lifetime to the value that you specify. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Set-NetRoute</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies a preferred lifetime, as a TimeSpan object, of an IP route. The cmdlet changes the lifetime to the value that you specify. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. For more information, type Get-Help New-TimeSpan. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Publish</maml:name>
<maml:description>
<maml:para>Specifies the publish setting of an IP route. The cmdlet changes the publish value to the value that you specify. The acceptable values for this parameter are:
-- No. Do not publish or advertise IP route information in router advertisements.
-- Yes. Publish and advertise IP route information with an infinite valid lifetime in router advertisements.
-- Age. Publish and advertise IP route information with a finite valid lifetime, in router advertisements. Specify a valid lifetime by using the ValidLifetime parameter. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">No</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Age</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Yes</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RouteMetric</maml:name>
<maml:description>
<maml:para>Specifies an integer route metric for an IP route. The cmdlet changes the metric to the value that you specify. To choose among multiple routes, the computer adds this value to the interface metric value. The computer selects the route with the lowest combined value. To modify the interface metric, use the Set-NetIPInterface cmdlet. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies a valid lifetime, as a TimeSpan object, for an IP route. The cmdlet changes the lifetime to the value that you specify. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AddressFamily</maml:name>
<maml:description>
<maml:para>Specifies an array of IP address families of IP routes. The cmdlet modifies the family that you specify for the IP route. The acceptable values for this parameter are:
-- IPv4
-- IPv6 </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">AddressFamily[]</command:parameterValue>
<dev:type>
<maml:name>AddressFamily[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>DestinationPrefix</maml:name>
<maml:description>
<maml:para>Specifies an array of destination prefixes of IP routes. The cmdlet modifies settings for this IP route. A destination prefix contains an IP address prefix and a prefix length, separated by a slash (/). A value of 0.0.0.0/0 for IPv4 or ::/0 for IPv6 indicates that the value of the NextHop parameter is a default gateway.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>IncludeAllCompartments</maml:name>
<maml:description>
<maml:para>Indicates that the cmdlet includes routes from all configured network compartments. If you do not specify this parameter, the cmdlet modifies only routes in the default network compartment. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifAlias">
<maml:name>InterfaceAlias</maml:name>
<maml:description>
<maml:para>Specifies an array of aliases of network interfaces. The cmdlet modifies IP routes for the interfaces that have the aliases that you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ifIndex">
<maml:name>InterfaceIndex</maml:name>
<maml:description>
<maml:para>Specifies an array of indexes of network interfaces. The cmdlet modifies IP routes for the interfaces located at the indexes that you specify. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">UInt32[]</command:parameterValue>
<dev:type>
<maml:name>UInt32[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NextHop</maml:name>
<maml:description>
<maml:para>Specifies an array of next hop values. The cmdlet modifies the routes that have these values. A value of 0.0.0.0 for IPv4 or :: for IPv6 indicates that the route is on the local subnet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PolicyStore</maml:name>
<maml:description>
<maml:para>Specifies a PolicyStore value. The cmdlet changes the PolicyStore value to the value that you specify. The acceptable values for this parameter are:
-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.
Specify ActiveStore only.</maml:para>
<maml:para>If you do not specify this parameter, the default entries are created in both the ActiveStore and the PersistentStore.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PreferredLifetime</maml:name>
<maml:description>
<maml:para>Specifies a preferred lifetime, as a TimeSpan object, of an IP route. The cmdlet changes the lifetime to the value that you specify. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. For more information, type Get-Help New-TimeSpan. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
<dev:type>
<maml:name>TimeSpan</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Protocol</maml:name>
<maml:description>
<maml:para>Specifies an array of types of routing protocols. The cmdlet changes the protocol to the value you specify. The acceptable values for this parameter are:
-- Bbn
-- Bgp
-- Dhcp
-- Dvmrp
-- Egp
-- Eigrp
-- EsIs
-- Ggp
-- Hello
-- Icmp
-- Idpr
-- Igrp
-- IsIs
-- Local
-- NetMgmt
-- Ospf
-- Rip
-- Rpl
-- Other</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">Protocol[]</command:parameterValue>
<dev:type>
<maml:name>Protocol[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Publish</maml:name>
<maml:description>
<maml:para>Specifies the publish setting of an IP route. The cmdlet changes the publish value to the value that you specify. The acceptable values for this parameter are:
-- No. Do not publish or advertise IP route information in router advertisements.
-- Yes. Publish and advertise IP route information with an infinite valid lifetime in router advertisements.
-- Age. Publish and advertise IP route information with a finite valid lifetime, in router advertisements. Specify a valid lifetime by using the ValidLifetime parameter. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Publish</command:parameterValue>
<dev:type>
<maml:name>Publish</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>RouteMetric</maml:name>
<maml:description>
<maml:para>Specifies an integer route metric for an IP route. The cmdlet changes the metric to the value that you specify. To choose among multiple routes, the computer adds this value to the interface metric value. The computer selects the route with the lowest combined value. To modify the interface metric, use the Set-NetIPInterface cmdlet. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
<dev:type>
<maml:name>UInt16</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ValidLifetime</maml:name>
<maml:description>
<maml:para>Specifies a valid lifetime, as a TimeSpan object, for an IP route. The cmdlet changes the lifetime to the value that you specify. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue>
<dev:type>
<maml:name>TimeSpan</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetPrefixPolicy</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Change the route metric</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Set-NetRoute –RouteMetric 257
</dev:code>
<dev:remarks>
<maml:para>This command changes the route metric to 257. This route is less preferred than routes that have the default value of 256. </maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Modify the preferred lifetime</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\> $TimeSpan = New-TimeSpan –Days 1
PS C:\> Set-NetRoute –DestinationPrefix "192.168.0.0/24" –PreferredLifetime $TimeSpan
</dev:code>
<dev:remarks>
<maml:para>The first command uses the New-TimeSpan cmdlet to create a time span of one day, and then stores it in the $TimeSpan variable. For more information, type Get-Help New-TimeSpan.</maml:para>
<maml:para>The second command changes the lifetime of the IP route that has the destination prefix 192.168.0.0/24. The command specifies the object stored in the $TimeSpan variable as the new preferred lifetime.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkID=289171</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>New-TimeSpan</maml:linkText>
<maml:uri>
</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Find-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>New-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-NetRoute</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetIPInterface</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Set-NetTCPSetting</command:name>
<maml:description>
<maml:para>Modifies a TCP setting.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Set</command:verb>
<command:noun>NetTCPSetting</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Set-NetTCPSetting cmdlet modifies a TCP setting. TCP settings are optimized for different network conditions including latency and congestion. To apply a TCP setting to a port number or destination IP address range, create a transport filter by using the New-NetTransportFilter cmdlet.</maml:para>
<maml:para>You can only modify the Custom TCP setting. </maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Set-NetTCPSetting</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>SettingName</maml:name>
<maml:description>
<maml:para>Specifies an array of setting names. You can specify only Custom for this parameter. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutomaticUseCustom</maml:name>
<maml:description>
<maml:para>Specifies whether the automatic profile assigns a custom template, either Datacenter Custom or Internet Custom, to a connection. The acceptable values for this parameter are:
-- True
-- False </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoReusePortRangeNumberOfPorts</maml:name>
<maml:description>
<maml:para>Specifies the number of ports for the auto-reuse port range, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. </maml:para>
<maml:para>If you specify 0, the auto-reuse feature is disabled and ephemeral ports are drawn instead from the dynamic port range as specified by DynamicPortRangeStartPort and DynamicPortRangeNumberOfPorts, even if SO_REUSE_UNICASTPORT is set on a socket.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoReusePortRangeStartPort</maml:name>
<maml:description>
<maml:para>Specifies the number of ports for the auto-reuse port range, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. </maml:para>
<maml:para>If you specify 0, the auto-reuse feature is disabled and ephemeral ports are drawn instead from the dynamic port range as specified by DynamicPortRangeStartPort and DynamicPortRangeNumberOfPorts, even if SO_REUSE_UNICASTPORT is set on a socket.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoTuningLevelLocal</maml:name>
<maml:description>
<maml:para>Specifies a TCP auto-tuning level for the host computer. TCP auto-tuning can improve throughput on high throughput, high latency networks. The acceptable values for this parameter are:
-- Disabled. Sets the TCP receive window to the default value.
-- HighlyRestricted. Sets the TCP receive window to grow beyond the default value, but very conservatively.
-- Restricted. Sets the TCP receive window to grow beyond the default value, but less conservatively than HighlyRestricted.
-- Normal. Sets the TCP receive window to grow to accommodate almost all scenarios.
-- Experimental. Sets the TCP receive window to grow to accommodate extreme scenarios.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">HighlyRestricted</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Restricted</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Normal</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Experimental</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CongestionProvider</maml:name>
<maml:description>
<maml:para>Specifies the congestion provider property that TCP uses. The acceptable values for this parameter are:
-- CTCP. Compound TCP increases the receive window and amount of data sent. CTCP can improve throughput on higher latency connections.
-- DCTCP. Data Center TCP adjusts the TCP window based on network congestion feedback based on Explicit Congestion Notification (ECN) signaling. DCTCP may improve throughput on low latency links.
-- Default. Servers use DCTCP by default. Client computers use NewReno. For information about NewReno, see <maml:navigationLink><maml:linkText>RFC 3782</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.ietf.org/rfc/rfc3782.txt).</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Default</command:parameterValue>
<command:parameterValue required="false" variableLength="false">CTCP</command:parameterValue>
<command:parameterValue required="false" variableLength="false">DCTCP</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CwndRestart</maml:name>
<maml:description>
<maml:para>Specifies whether to enable congestion window restart. Congestion window restart can avoid slow start to optimize throughput on low latency networks. For more information about congestion window restart, see <maml:navigationLink><maml:linkText>RFC 2581</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.ietf.org/rfc/rfc2581.txt). The acceptable values for this parameter are:
-- True. TCP uses congestion window restart.
-- False. TCP uses the default setting of the connection.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">False</command:parameterValue>
<command:parameterValue required="false" variableLength="false">True</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DelayedAckFrequency</maml:name>
<maml:description>
<maml:para>Specifies the number of acknowledgments (ACKs) received before the computer sends a response.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Byte</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="DelayedAckTimeout">
<maml:name>DelayedAckTimeoutMs</maml:name>
<maml:description>
<maml:para>Specifies the time to wait, in milliseconds, before the computer sends an ACK if the computer receives fewer than delayed acknowledgment frequency of packets. Use the DelayedAckFrequency parameter to specify the delayed ACK frequency value. Reducing the time to wait can increase throughput on low latency networks by accelerating growth in TCP window size. The acceptable values for this parameter are: increments of 10, from 10 through 600. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DynamicPortRangeNumberOfPorts</maml:name>
<maml:description>
<maml:para>Specifies the number of ports for the dynamic port range that starts from the port that you specify for the DynamicPortRangeStartPort parameter.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DynamicPortRangeStartPort</maml:name>
<maml:description>
<maml:para>Specifies the starting port for the dynamic port range. This parameter sets the starting port to send and receive TCP traffic. The acceptable values for this parameter are: 1 through 65535.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EcnCapability</maml:name>
<maml:description>
<maml:para>Specifies whether to enable ECN capability. The acceptable values for this parameter are:
-- Enabled. Uses ECN capability.
-- Disabled. Does not use ECN capability.
If you specify a value of Disabled, UseECT0, or UseEct1 for the EcnMarking parameter of the Set-NetIPInterface cmdlet, the current parameter has no effect.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ForceWS</maml:name>
<maml:description>
<maml:para>Specifies whether to force window scaling for retransmission. The acceptable values for this parameter are:
-- Enabled. Requires window scaling for retransmission.
-- Disabled. Does not require window scaling for retransmission.
The default value is Disabled. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="InitialCongestionWindow">
<maml:name>InitialCongestionWindowMss</maml:name>
<maml:description>
<maml:para>Specifies the initial size of the congestion window. Provide a value to multiply by the maximum segment size (MSS). The acceptable values for this parameter are: even numbers from 2 through 64.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="InitialRto">
<maml:name>InitialRtoMs</maml:name>
<maml:description>
<maml:para>Specifies the period, in milliseconds, before connect, or SYN, retransmit. The acceptable values for this parameter are: increments of 10, from 300 ms through 3000 ms. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MaxSynRetransmissions</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of times the computer sends SYN packets without receiving a response. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Byte</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MemoryPressureProtection</maml:name>
<maml:description>
<maml:para>Specifies whether to use memory pressure protection. TCP memory pressure protection helps ensure that a computer continues normal operation when low on memory due to denial of service attacks. The acceptable values for this parameter are:
-- Enabled. When low on memory, during an attack, close existing TCP connections and drop incoming SYN requests.
-- Disabled. Do not use memory pressure protection.
-- Default. Use the computer default value for memory pressure protection. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Default</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="MinRto">
<maml:name>MinRtoMs</maml:name>
<maml:description>
<maml:para>Specifies a value, in milliseconds, for the TCP retransmission to time out. The acceptable values for this parameter are: increments of 10, from 20 ms through 300 ms.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NonSackRttResiliency</maml:name>
<maml:description>
<maml:para>Specifies whether to enable round trip time resiliency for clients that do not support selective acknowledgment. The acceptable values for this parameter are:
-- Enabled
-- Disabled </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ScalingHeuristics</maml:name>
<maml:description>
<maml:para>Specifies whether to enable scaling heuristics. The acceptable values for this parameter are:
-- Enabled
-- Disabled </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Timestamps</maml:name>
<maml:description>
<maml:para>Specifies whether to enable timestamps. Timestamps facilitate round trip measurement, and can help protect against wrapped sequence numbers on high throughput links. For more information about TCP timestamps, see <maml:navigationLink><maml:linkText>RFC 1323</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.ietf.org/rfc/rfc1323.txt). The acceptable values for this parameter are:
-- Enabled
-- Disabled </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Set-NetTCPSetting</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutomaticUseCustom</maml:name>
<maml:description>
<maml:para>Specifies whether the automatic profile assigns a custom template, either Datacenter Custom or Internet Custom, to a connection. The acceptable values for this parameter are:
-- True
-- False </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoReusePortRangeNumberOfPorts</maml:name>
<maml:description>
<maml:para>Specifies the number of ports for the auto-reuse port range, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. </maml:para>
<maml:para>If you specify 0, the auto-reuse feature is disabled and ephemeral ports are drawn instead from the dynamic port range as specified by DynamicPortRangeStartPort and DynamicPortRangeNumberOfPorts, even if SO_REUSE_UNICASTPORT is set on a socket.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoReusePortRangeStartPort</maml:name>
<maml:description>
<maml:para>Specifies the number of ports for the auto-reuse port range, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. </maml:para>
<maml:para>If you specify 0, the auto-reuse feature is disabled and ephemeral ports are drawn instead from the dynamic port range as specified by DynamicPortRangeStartPort and DynamicPortRangeNumberOfPorts, even if SO_REUSE_UNICASTPORT is set on a socket.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoTuningLevelLocal</maml:name>
<maml:description>
<maml:para>Specifies a TCP auto-tuning level for the host computer. TCP auto-tuning can improve throughput on high throughput, high latency networks. The acceptable values for this parameter are:
-- Disabled. Sets the TCP receive window to the default value.
-- HighlyRestricted. Sets the TCP receive window to grow beyond the default value, but very conservatively.
-- Restricted. Sets the TCP receive window to grow beyond the default value, but less conservatively than HighlyRestricted.
-- Normal. Sets the TCP receive window to grow to accommodate almost all scenarios.
-- Experimental. Sets the TCP receive window to grow to accommodate extreme scenarios.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">HighlyRestricted</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Restricted</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Normal</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Experimental</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CongestionProvider</maml:name>
<maml:description>
<maml:para>Specifies the congestion provider property that TCP uses. The acceptable values for this parameter are:
-- CTCP. Compound TCP increases the receive window and amount of data sent. CTCP can improve throughput on higher latency connections.
-- DCTCP. Data Center TCP adjusts the TCP window based on network congestion feedback based on Explicit Congestion Notification (ECN) signaling. DCTCP may improve throughput on low latency links.
-- Default. Servers use DCTCP by default. Client computers use NewReno. For information about NewReno, see <maml:navigationLink><maml:linkText>RFC 3782</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.ietf.org/rfc/rfc3782.txt).</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Default</command:parameterValue>
<command:parameterValue required="false" variableLength="false">CTCP</command:parameterValue>
<command:parameterValue required="false" variableLength="false">DCTCP</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CwndRestart</maml:name>
<maml:description>
<maml:para>Specifies whether to enable congestion window restart. Congestion window restart can avoid slow start to optimize throughput on low latency networks. For more information about congestion window restart, see <maml:navigationLink><maml:linkText>RFC 2581</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.ietf.org/rfc/rfc2581.txt). The acceptable values for this parameter are:
-- True. TCP uses congestion window restart.
-- False. TCP uses the default setting of the connection.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">False</command:parameterValue>
<command:parameterValue required="false" variableLength="false">True</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DelayedAckFrequency</maml:name>
<maml:description>
<maml:para>Specifies the number of acknowledgments (ACKs) received before the computer sends a response.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Byte</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="DelayedAckTimeout">
<maml:name>DelayedAckTimeoutMs</maml:name>
<maml:description>
<maml:para>Specifies the time to wait, in milliseconds, before the computer sends an ACK if the computer receives fewer than delayed acknowledgment frequency of packets. Use the DelayedAckFrequency parameter to specify the delayed ACK frequency value. Reducing the time to wait can increase throughput on low latency networks by accelerating growth in TCP window size. The acceptable values for this parameter are: increments of 10, from 10 through 600. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DynamicPortRangeNumberOfPorts</maml:name>
<maml:description>
<maml:para>Specifies the number of ports for the dynamic port range that starts from the port that you specify for the DynamicPortRangeStartPort parameter.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DynamicPortRangeStartPort</maml:name>
<maml:description>
<maml:para>Specifies the starting port for the dynamic port range. This parameter sets the starting port to send and receive TCP traffic. The acceptable values for this parameter are: 1 through 65535.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EcnCapability</maml:name>
<maml:description>
<maml:para>Specifies whether to enable ECN capability. The acceptable values for this parameter are:
-- Enabled. Uses ECN capability.
-- Disabled. Does not use ECN capability.
If you specify a value of Disabled, UseECT0, or UseEct1 for the EcnMarking parameter of the Set-NetIPInterface cmdlet, the current parameter has no effect.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ForceWS</maml:name>
<maml:description>
<maml:para>Specifies whether to force window scaling for retransmission. The acceptable values for this parameter are:
-- Enabled. Requires window scaling for retransmission.
-- Disabled. Does not require window scaling for retransmission.
The default value is Disabled. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="InitialCongestionWindow">
<maml:name>InitialCongestionWindowMss</maml:name>
<maml:description>
<maml:para>Specifies the initial size of the congestion window. Provide a value to multiply by the maximum segment size (MSS). The acceptable values for this parameter are: even numbers from 2 through 64.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="InitialRto">
<maml:name>InitialRtoMs</maml:name>
<maml:description>
<maml:para>Specifies the period, in milliseconds, before connect, or SYN, retransmit. The acceptable values for this parameter are: increments of 10, from 300 ms through 3000 ms. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MaxSynRetransmissions</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of times the computer sends SYN packets without receiving a response. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Byte</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MemoryPressureProtection</maml:name>
<maml:description>
<maml:para>Specifies whether to use memory pressure protection. TCP memory pressure protection helps ensure that a computer continues normal operation when low on memory due to denial of service attacks. The acceptable values for this parameter are:
-- Enabled. When low on memory, during an attack, close existing TCP connections and drop incoming SYN requests.
-- Disabled. Do not use memory pressure protection.
-- Default. Use the computer default value for memory pressure protection. </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Default</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="MinRto">
<maml:name>MinRtoMs</maml:name>
<maml:description>
<maml:para>Specifies a value, in milliseconds, for the TCP retransmission to time out. The acceptable values for this parameter are: increments of 10, from 20 ms through 300 ms.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NonSackRttResiliency</maml:name>
<maml:description>
<maml:para>Specifies whether to enable round trip time resiliency for clients that do not support selective acknowledgment. The acceptable values for this parameter are:
-- Enabled
-- Disabled </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ScalingHeuristics</maml:name>
<maml:description>
<maml:para>Specifies whether to enable scaling heuristics. The acceptable values for this parameter are:
-- Enabled
-- Disabled </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Timestamps</maml:name>
<maml:description>
<maml:para>Specifies whether to enable timestamps. Timestamps facilitate round trip measurement, and can help protect against wrapped sequence numbers on high throughput links. For more information about TCP timestamps, see <maml:navigationLink><maml:linkText>RFC 1323</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.ietf.org/rfc/rfc1323.txt). The acceptable values for this parameter are:
-- Enabled
-- Disabled </maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutomaticUseCustom</maml:name>
<maml:description>
<maml:para>Specifies whether the automatic profile assigns a custom template, either Datacenter Custom or Internet Custom, to a connection. The acceptable values for this parameter are:
-- True
-- False </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">AutomaticUseCustom</command:parameterValue>
<dev:type>
<maml:name>AutomaticUseCustom</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoReusePortRangeNumberOfPorts</maml:name>
<maml:description>
<maml:para>Specifies the number of ports for the auto-reuse port range, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. </maml:para>
<maml:para>If you specify 0, the auto-reuse feature is disabled and ephemeral ports are drawn instead from the dynamic port range as specified by DynamicPortRangeStartPort and DynamicPortRangeNumberOfPorts, even if SO_REUSE_UNICASTPORT is set on a socket.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
<dev:type>
<maml:name>UInt16</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoReusePortRangeStartPort</maml:name>
<maml:description>
<maml:para>Specifies the number of ports for the auto-reuse port range, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. </maml:para>
<maml:para>If you specify 0, the auto-reuse feature is disabled and ephemeral ports are drawn instead from the dynamic port range as specified by DynamicPortRangeStartPort and DynamicPortRangeNumberOfPorts, even if SO_REUSE_UNICASTPORT is set on a socket.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
<dev:type>
<maml:name>UInt16</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>AutoTuningLevelLocal</maml:name>
<maml:description>
<maml:para>Specifies a TCP auto-tuning level for the host computer. TCP auto-tuning can improve throughput on high throughput, high latency networks. The acceptable values for this parameter are:
-- Disabled. Sets the TCP receive window to the default value.
-- HighlyRestricted. Sets the TCP receive window to grow beyond the default value, but very conservatively.
-- Restricted. Sets the TCP receive window to grow beyond the default value, but less conservatively than HighlyRestricted.
-- Normal. Sets the TCP receive window to grow to accommodate almost all scenarios.
-- Experimental. Sets the TCP receive window to grow to accommodate extreme scenarios.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">AutoTuningLevelLocal</command:parameterValue>
<dev:type>
<maml:name>AutoTuningLevelLocal</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CongestionProvider</maml:name>
<maml:description>
<maml:para>Specifies the congestion provider property that TCP uses. The acceptable values for this parameter are:
-- CTCP. Compound TCP increases the receive window and amount of data sent. CTCP can improve throughput on higher latency connections.
-- DCTCP. Data Center TCP adjusts the TCP window based on network congestion feedback based on Explicit Congestion Notification (ECN) signaling. DCTCP may improve throughput on low latency links.
-- Default. Servers use DCTCP by default. Client computers use NewReno. For information about NewReno, see <maml:navigationLink><maml:linkText>RFC 3782</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.ietf.org/rfc/rfc3782.txt).</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CongestionProvider</command:parameterValue>
<dev:type>
<maml:name>CongestionProvider</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>CwndRestart</maml:name>
<maml:description>
<maml:para>Specifies whether to enable congestion window restart. Congestion window restart can avoid slow start to optimize throughput on low latency networks. For more information about congestion window restart, see <maml:navigationLink><maml:linkText>RFC 2581</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.ietf.org/rfc/rfc2581.txt). The acceptable values for this parameter are:
-- True. TCP uses congestion window restart.
-- False. TCP uses the default setting of the connection.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">CwndRestart</command:parameterValue>
<dev:type>
<maml:name>CwndRestart</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DelayedAckFrequency</maml:name>
<maml:description>
<maml:para>Specifies the number of acknowledgments (ACKs) received before the computer sends a response.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Byte</command:parameterValue>
<dev:type>
<maml:name>Byte</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="DelayedAckTimeout">
<maml:name>DelayedAckTimeoutMs</maml:name>
<maml:description>
<maml:para>Specifies the time to wait, in milliseconds, before the computer sends an ACK if the computer receives fewer than delayed acknowledgment frequency of packets. Use the DelayedAckFrequency parameter to specify the delayed ACK frequency value. Reducing the time to wait can increase throughput on low latency networks by accelerating growth in TCP window size. The acceptable values for this parameter are: increments of 10, from 10 through 600. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DynamicPortRangeNumberOfPorts</maml:name>
<maml:description>
<maml:para>Specifies the number of ports for the dynamic port range that starts from the port that you specify for the DynamicPortRangeStartPort parameter.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
<dev:type>
<maml:name>UInt16</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DynamicPortRangeStartPort</maml:name>
<maml:description>
<maml:para>Specifies the starting port for the dynamic port range. This parameter sets the starting port to send and receive TCP traffic. The acceptable values for this parameter are: 1 through 65535.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
<dev:type>
<maml:name>UInt16</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>EcnCapability</maml:name>
<maml:description>
<maml:para>Specifies whether to enable ECN capability. The acceptable values for this parameter are:
-- Enabled. Uses ECN capability.
-- Disabled. Does not use ECN capability.
If you specify a value of Disabled, UseECT0, or UseEct1 for the EcnMarking parameter of the Set-NetIPInterface cmdlet, the current parameter has no effect.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">EcnCapability</command:parameterValue>
<dev:type>
<maml:name>EcnCapability</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ForceWS</maml:name>
<maml:description>
<maml:para>Specifies whether to force window scaling for retransmission. The acceptable values for this parameter are:
-- Enabled. Requires window scaling for retransmission.
-- Disabled. Does not require window scaling for retransmission.
The default value is Disabled. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">ForceWS</command:parameterValue>
<dev:type>
<maml:name>ForceWS</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="InitialCongestionWindow">
<maml:name>InitialCongestionWindowMss</maml:name>
<maml:description>
<maml:para>Specifies the initial size of the congestion window. Provide a value to multiply by the maximum segment size (MSS). The acceptable values for this parameter are: even numbers from 2 through 64.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="InitialRto">
<maml:name>InitialRtoMs</maml:name>
<maml:description>
<maml:para>Specifies the period, in milliseconds, before connect, or SYN, retransmit. The acceptable values for this parameter are: increments of 10, from 300 ms through 3000 ms. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MaxSynRetransmissions</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of times the computer sends SYN packets without receiving a response. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Byte</command:parameterValue>
<dev:type>
<maml:name>Byte</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>MemoryPressureProtection</maml:name>
<maml:description>
<maml:para>Specifies whether to use memory pressure protection. TCP memory pressure protection helps ensure that a computer continues normal operation when low on memory due to denial of service attacks. The acceptable values for this parameter are:
-- Enabled. When low on memory, during an attack, close existing TCP connections and drop incoming SYN requests.
-- Disabled. Do not use memory pressure protection.
-- Default. Use the computer default value for memory pressure protection. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">MemoryPressureProtection</command:parameterValue>
<dev:type>
<maml:name>MemoryPressureProtection</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="MinRto">
<maml:name>MinRtoMs</maml:name>
<maml:description>
<maml:para>Specifies a value, in milliseconds, for the TCP retransmission to time out. The acceptable values for this parameter are: increments of 10, from 20 ms through 300 ms.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>NonSackRttResiliency</maml:name>
<maml:description>
<maml:para>Specifies whether to enable round trip time resiliency for clients that do not support selective acknowledgment. The acceptable values for this parameter are:
-- Enabled
-- Disabled </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">NonSackRttResiliency</command:parameterValue>
<dev:type>
<maml:name>NonSackRttResiliency</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ScalingHeuristics</maml:name>
<maml:description>
<maml:para>Specifies whether to enable scaling heuristics. The acceptable values for this parameter are:
-- Enabled
-- Disabled </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">ScalingHeuristics</command:parameterValue>
<dev:type>
<maml:name>ScalingHeuristics</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none">
<maml:name>SettingName</maml:name>
<maml:description>
<maml:para>Specifies an array of setting names. You can specify only Custom for this parameter. </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Timestamps</maml:name>
<maml:description>
<maml:para>Specifies whether to enable timestamps. Timestamps facilitate round trip measurement, and can help protect against wrapped sequence numbers on high throughput links. For more information about TCP timestamps, see <maml:navigationLink><maml:linkText>RFC 1323</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.ietf.org/rfc/rfc1323.txt). The acceptable values for this parameter are:
-- Enabled
-- Disabled </maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Timestamps</command:parameterValue>
<dev:type>
<maml:name>Timestamps</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetTCPSetting</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Change the custom TCP setting </maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Set-NetTCPSetting –SettingName "Custom" –CongestionProvider CTCP –InitialCongestionWindowMss 6
</dev:code>
<dev:remarks>
<maml:para>This command changes the custom TCP setting to have a value of 6 for the initial congestion window and use compound TCP.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkID=289172</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetTCPSetting</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetTransportFilter</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetUDPSetting</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>New-NetTransportFilter</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Remove-NetTransportFilter</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetUDPSetting</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Set-NetUDPSetting</command:name>
<maml:description>
<maml:para>Modifies UDP settings.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Set</command:verb>
<command:noun>NetUDPSetting</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Set-NetUDPSetting cmdlet modifies UDP settings of the IP interface. Use this cmdlet to change the starting port and the number of ports for the dynamic port range. You can use the InputObject parameter to specify a NetUDPSetting object for the input to this cmdlet. Use the Get-NetUDPSetting to get a NetUDPSetting object.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Set-NetUDPSetting</maml:name>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DynamicPortRangeNumberOfPorts</maml:name>
<maml:description>
<maml:para>Specifies the number of ports for the dynamic port range that starts from the port that you specify for the DynamicPortRangeStartPort parameter. The cmdlet modifies the number of ports to the value you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DynamicPortRangeStartPort</maml:name>
<maml:description>
<maml:para>Specifies the starting port for the dynamic port range. The cmdlet modifies the value for starting port to the value you specify. This parameter sets the starting port to send and receive UDP traffic. The acceptable values for this parameter are:1 through 65535.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session">
<maml:name>CimSession</maml:name>
<maml:description>
<maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="true">CimSession[]</command:parameterValue>
<dev:type>
<maml:name>CimSession[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DynamicPortRangeNumberOfPorts</maml:name>
<maml:description>
<maml:para>Specifies the number of ports for the dynamic port range that starts from the port that you specify for the DynamicPortRangeStartPort parameter. The cmdlet modifies the number of ports to the value you specify.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
<dev:type>
<maml:name>UInt16</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DynamicPortRangeStartPort</maml:name>
<maml:description>
<maml:para>Specifies the starting port for the dynamic port range. The cmdlet modifies the value for starting port to the value you specify. This parameter sets the starting port to send and receive UDP traffic. The acceptable values for this parameter are:1 through 65535.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt16</command:parameterValue>
<dev:type>
<maml:name>UInt16</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>PassThru</maml:name>
<maml:description>
<maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ThrottleLimit</maml:name>
<maml:description>
<maml:para>Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>Confirm</maml:name>
<maml:description>
<maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
<maml:name>WhatIf</maml:name>
<maml:description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>false</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetPrefixPolicy</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Modify the dynamic port range for UDP</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\>Set-NetUDPSetting –DynamicPortRangeStartPort 49152 –DynamicPortRangeNumberOfPorts 1700
</dev:code>
<dev:remarks>
<maml:para>This command modifies the port range from which applications can send and receive UDP traffic.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=289173</maml:uri>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetTransportFilter</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Get-NetUDPSetting</maml:linkText>
<maml:uri />
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Set-NetTCPSetting</maml:linkText>
<maml:uri />
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<command:details>
<command:name>Test-NetConnection</command:name>
<maml:description>
<maml:para>Displays diagnostic information for a connection.</maml:para>
</maml:description>
<maml:copyright>
<maml:para />
</maml:copyright>
<command:verb>Test</command:verb>
<command:noun>NetConnection</command:noun>
<dev:version />
</command:details>
<maml:description>
<maml:para>The Test-NetConnection cmdlet displays diagnostic information for a connection. It supports ping test, TCP test, route tracing, and route selection diagnostics. Depending on the input parameters, the output can include the DNS lookup results, a list of IP interfaces, IPsec rules, route/source address selection results, and/or confirmation of connection establishment.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Test-NetConnection</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1" aliases="RemoteAddress,cn">
<maml:name>ComputerName</maml:name>
<maml:description>
<maml:para>Specifies the Domain Name System (DNS) name or IP address of the target computer that runs the Dynamic Host Configuration Protocol (DHCP) server service.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>CommonTCPPort</maml:name>
<maml:description>
<maml:para>Specifies the common service TCP port number. The acceptable values for this parameter are:
-- SMB
-- HTTP
-- RDP
-- WINRM</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="true" variableLength="false">HTTP</command:parameterValue>
<command:parameterValue required="true" variableLength="false">RDP</command:parameterValue>
<command:parameterValue required="true" variableLength="false">SMB</command:parameterValue>
<command:parameterValue required="true" variableLength="false">WINRM</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>InformationLevel</maml:name>
<maml:description>
<maml:para>Specifies the information level. The acceptable values for this parameter are:
-- Detailed
-- Quiet
If you set this parameter to Quiet, the cmdlet returns basic information. For example, for a ping test, this cmdlet returns a Boolean value that indicates whether the attempt to ping a host or port is successful.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Quiet</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Detailed</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Test-NetConnection</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1" aliases="RemoteAddress,cn">
<maml:name>ComputerName</maml:name>
<maml:description>
<maml:para>Specifies the Domain Name System (DNS) name or IP address of the target computer that runs the Dynamic Host Configuration Protocol (DHCP) server service.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Hops</maml:name>
<maml:description>
<maml:para>Specifies the number of hops to traverse in a trace route command.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>InformationLevel</maml:name>
<maml:description>
<maml:para>Specifies the information level. The acceptable values for this parameter are:
-- Detailed
-- Quiet
If you set this parameter to Quiet, the cmdlet returns basic information. For example, for a ping test, this cmdlet returns a Boolean value that indicates whether the attempt to ping a host or port is successful.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Quiet</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Detailed</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>TraceRoute</maml:name>
<maml:description>
<maml:para>Indicates that Tracert runs to test connectivity to the remote host.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Test-NetConnection</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1" aliases="RemoteAddress,cn">
<maml:name>ComputerName</maml:name>
<maml:description>
<maml:para>Specifies the Domain Name System (DNS) name or IP address of the target computer that runs the Dynamic Host Configuration Protocol (DHCP) server service.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>InformationLevel</maml:name>
<maml:description>
<maml:para>Specifies the information level. The acceptable values for this parameter are:
-- Detailed
-- Quiet
If you set this parameter to Quiet, the cmdlet returns basic information. For example, for a ping test, this cmdlet returns a Boolean value that indicates whether the attempt to ping a host or port is successful.</maml:para>
</maml:description>
<command:parameterValueGroup>
<command:parameterValue required="false" variableLength="false">Quiet</command:parameterValue>
<command:parameterValue required="false" variableLength="false">Detailed</command:parameterValue>
</command:parameterValueGroup>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="RemotePort">
<maml:name>Port</maml:name>
<maml:description>
<maml:para>Specifies the TCP port number on the remote computer. The cmdlet uses this port number to test connectivity to the remote computer.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Test-NetConnection</maml:name>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ConstrainInterface</maml:name>
<maml:description>
<maml:para>Specifies the interface constraint to use for route diagnostics.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ConstrainSourceAddress</maml:name>
<maml:description>
<maml:para>Specifies the source address constraint to use for route diagnostics.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DiagnoseRouting</maml:name>
<maml:description>
<maml:para>Indicates that route diagnostics runs to output the route and source address selection information for the remote host.</maml:para>
</maml:description>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none">
<maml:name>CommonTCPPort</maml:name>
<maml:description>
<maml:para>Specifies the common service TCP port number. The acceptable values for this parameter are:
-- SMB
-- HTTP
-- RDP
-- WINRM</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1" aliases="RemoteAddress,cn">
<maml:name>ComputerName</maml:name>
<maml:description>
<maml:para>Specifies the Domain Name System (DNS) name or IP address of the target computer that runs the Dynamic Host Configuration Protocol (DHCP) server service.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ConstrainInterface</maml:name>
<maml:description>
<maml:para>Specifies the interface constraint to use for route diagnostics.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
<dev:type>
<maml:name>UInt32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>ConstrainSourceAddress</maml:name>
<maml:description>
<maml:para>Specifies the source address constraint to use for route diagnostics.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>DiagnoseRouting</maml:name>
<maml:description>
<maml:para>Indicates that route diagnostics runs to output the route and source address selection information for the remote host.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Hops</maml:name>
<maml:description>
<maml:para>Specifies the number of hops to traverse in a trace route command.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>InformationLevel</maml:name>
<maml:description>
<maml:para>Specifies the information level. The acceptable values for this parameter are:
-- Detailed
-- Quiet
If you set this parameter to Quiet, the cmdlet returns basic information. For example, for a ping test, this cmdlet returns a Boolean value that indicates whether the attempt to ping a host or port is successful.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="RemotePort">
<maml:name>Port</maml:name>
<maml:description>
<maml:para>Specifies the TCP port number on the remote computer. The cmdlet uses this port number to test connectivity to the remote computer.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>TraceRoute</maml:name>
<maml:description>
<maml:para>Indicates that Tracert runs to test connectivity to the remote host.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>none</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>NetRouteDiagnostics</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>This object displays route diagnostics information and is returned if you specify the NetRouteDiagnostics parameter set.</maml:para>
</maml:description>
</command:returnValue>
<command:returnValue>
<dev:type>
<maml:name>NetConnectionResults</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para />
</maml:description>
</dev:type>
<maml:description>
<maml:para>This object displays connection results and is returned if you specify the CommonTCPPort, RemotePort, or ICMP parameter set. </maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<command:terminatingErrors />
<command:nonTerminatingErrors />
<command:examples>
<command:example>
<maml:title>Example 1: Test ping connectivity</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\> Test-NetConnection
ComputerName : internetbeacon.msedge.net
RemoteAddress : 2a01:111:2003::52
InterfaceAlias : Ethernet
SourceAddress : 2001:4898:d8:33:81e8:7b49:8bf5:8710
PingSucceeded : True
PingReplyDetails (RTT) : 5 ms
</dev:code>
<dev:remarks>
<maml:para>This command tests ping connectivity to a default server.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 2: Test ping connectivity with detailed results</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\> Test-NetConnection -InformationLevel "Detailed"
ComputerName : internetbeacon.msedge.net
RemoteAddress : 2a01:111:2003::52
NameResolutionResults : 2a01:111:2003::52
13.107.4.52
InterfaceAlias : Ethernet
SourceAddress : 2001:4898:d8:33:81e8:7b49:8bf5:8710
NetRoute (NextHop) : fe80::200:5eff:fe00:203
PingSucceeded : True
PingReplyDetails (RTT) : 6 ms
</dev:code>
<dev:remarks>
<maml:para>This command tests ping connectivity to a default server and sets the InformationLevel parameter to Detailed.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 3: Test TCP connectivity and display detailed results</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\> Test-NetConnection -Port 80 -InformationLevel "Detailed"
ComputerName : internetbeacon.msedge.net
RemoteAddress : 2a01:111:2003::52
RemotePort : 80
NameResolutionResults : 2a01:111:2003::52
13.107.4.52
MatchingIPsecRules : Ipsec/Domain-TrafficFromInternet-v6
NetworkIsolationContext : Internet
IsAdmin : False
InterfaceAlias : Ethernet
SourceAddress : 2001:4898:d8:33:81e8:7b49:8bf5:8710
NetRoute (NextHop) : fe80::200:5eff:fe00:203
TcpTestSucceeded : True
</dev:code>
<dev:remarks>
<maml:para>This command tests TCP connectivity to a default server and sets the InformationLevel parameter to Detailed. </maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 4: Test a connection to a remote host</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\> Test-NetConnection -ComputerName "www.contoso.com" -InformationLevel "Detailed"
PingReplyDetails (RTT) : 164 ms
ComputerName : www.contoso.com
RemoteAddress : 65.55.39.10
NameResolutionResults : 65.55.39.10
64.4.6.100
InterfaceAlias : Ethernet
SourceAddress : 10.137.193.122
NetRoute (NextHop) : 10.137.192.1
PingSucceeded : True
PingReplyDetails (RTT) : 164 ms
</dev:code>
<dev:remarks>
<maml:para>This command tests ping connectivity to a remote host named www.contoso.com.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 5: Perform route diagnostics to connect to a remote host</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\> Test-NetConnection -ComputerName www.contoso.com -DiagnoseRouting -InformationLevel Detailed
ComputerName : www.contoso.com
RemoteAddress : 2001:428:3805:187::2768
SelectedSourceAddress : 2001:4898:e0:79:f17c:d212:8743:43c2
OutgoingInterfaceIndex : 4
SelectedNetRoute : DestinationPrefix: ::/0 NextHop: fe80::200:5eff:fe00:202
RouteSelectionEvents : IP: Route [DestinationPrefix: ::/0 NextHop: fe80::200:5eff:fe00:202 InterfaceIndex: 4 InterfaceMetric: 10 RouteMetric: 256] is preferred over
Route [DestinationPrefix: ::/0 NextHop: fe80::200:5eff:fe00:202 InterfaceIndex: 5 InterfaceMetric: 10 RouteMetric: 256] for
Destination: 2001:428:3805:187::2768 in Compartment: 1, Reason: RouteOrder.
SourceAddressSelectionEvents : IP: Source address 2001:4898:e0:79:f17c:d212:8743:43c2 is preferred over fe80::f17c:d212:8743:43c2 for destination 2001:428:3805:187::2768 Rule = 2.0.
RouteDiagnosticsSucceeded : True
</dev:code>
<dev:remarks>
<maml:para>This command performs route diagnostics to reach a remote host named www.contoso.com.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>Example 6: Perform route diagnostics to connect to a remote host with routing constraints</maml:title>
<maml:introduction>
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\> Test-NetConnection -ComputerName "www.contoso.com" -ConstrainInterface 5 -DiagnoseRouting -InformationLevel "Detailed"
ComputerName : www.contoso.com
RemoteAddress : 2600:1409:a:185::2768
ConstrainInterfaceIndex : 5
SelectedSourceAddress : 2001:4898:e0:79:75dd:64cf:d9ff:f86
OutgoingInterfaceIndex : 5
SelectedNetRoute : DestinationPrefix: ::/0
NextHop: fe80::200:5eff:fe00:202
RouteSelectionEvents : IP: Route [DestinationPrefix: ::/0 NextHop: fe80::200:5eff:fe00:202 InterfaceIndex: 4
RouteMetric: 256] is blocked for Destination: 2600:1409:a:185::2768 ConstrainInterfaceIndex: 5 ConstrainScopeZone: 1 in Compartment: 1, Reason: InterfaceConstraint.
SourceAddressSelectionEvents : IP: Source address 2001:4898:e0:79:75dd:64cf:d9ff:f86 is preferred over fe80::75dd:64cf:d9ff:f86 for destination 2600:1409:a:185::2768 Rule = 2.0.
IP: Source address 2001:4898:e0:79:75dd:64cf:d9ff:f86 is preferred over fe80::75dd:64cf:d9ff:f86 for destination 2600:1409:a:185::2768 Rule = 2.0.
RouteDiagnosticsSucceeded : True
</dev:code>
<dev:remarks>
<maml:para>This command performs route diagnostics to reach a remote host named www.contoso.com with routing constraints.</maml:para>
<maml:para />
<maml:para />
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText />
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
<maml:uri>http://go.microsoft.com/fwlink/?LinkId=313146</maml:uri>
</maml:navigationLink>
</maml:relatedLinks>
</command:command>
</helpItems>