HelpCache/Test-NetConnection.psm1-help.xml
|
<?xml version = "1.0" encoding = "utf-8" ?>
<helpItems schema="maml"> <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. The output includes the results of a DNS lookup, a listing of IP interfaces, an option to test a TCP connection, IPsec rules, and 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="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><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 -- PING</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=""><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 a Boolean value that indicates if the attempt to ping a host or port succeeded.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></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="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><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="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><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 a Boolean value that indicates if the attempt to ping a host or port succeeded.</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=""><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="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><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 a Boolean value that indicates if the attempt to ping a host or port succeeded.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></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 machine.</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="2" aliases=""><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 -- PING</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></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="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><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="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><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 a Boolean value that indicates if the attempt to ping a host or port succeeded.</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></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 machine.</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></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><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></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>NetConnectionResults</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>Results of the connectivity test to the specified computer name</maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Test a connection</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Test-NetConnection ComputerName : gateway.contoso.com RemoteAddress : 2620:0:30::197 InterfaceAlias : Ethernet 3 SourceAddress : 2001:4898:1b:1046:cda8:e200:e2cd:1e8b PingSucceeded : True </dev:code><dev:remarks><maml:para>This command tests a network connection.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 2: Test a connection 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 : gateway.contoso.com RemoteAddress : 2620:0:30::197 RemotePort : 80 AllNameResolutionResults : 10.253.21.197 10.79.197.197 2620:0:30::197 MatchingIPsecRules : Ipsec-Win8/Domain-TrafficFromInternet-v6 NetworkIsolationContext : Internet InterfaceAlias : Ethernet 3 SourceAddress : 2001:4898:1b:1046:cda8:e200:e2cd:1e8b NetRoute (NextHop) : fe80::21a:30ff:feaf:5400 PingSucceeded : True PingReplyDetails (RTT) : 1 ms TcpTestSucceeded : True </dev:code><dev:remarks><maml:para>This command tests a network connection and sets the InformationLevel parameter to Detailed.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 3: 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 ComputerName : www.contoso.com RemoteAddress : 2600:1409::1703:6929 AllNameResolutionResults : 10.3.105.104 10.3.105.113 10.3.105.114 10.3.105.41 10.3.105.43 2600:1409::1703:6929 2600:1409::1703:692b 2600:1409::1703:6972 InterfaceAlias : Ethernet 3 SourceAddress : 2001:4898:1b:1046:cda8:e200:e2cd:1e8b NetRoute (NextHop) : fe80::21a:30ff:feaf:5400 PingSucceeded : True PingReplyDetails (RTT) : 164 ms </dev:code><dev:remarks><maml:para>This command tests a network connection to a remote host named www.contoso.com.</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> |