HelpCache/SmbMultichannelConnection.cdxml-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>Get-SmbMultichannelConnection</command:name><maml:description><maml:para>Retrieves the Server Message Block (SMB) connections made between the SMB client network interfaces and the SMB server network interfaces.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>SmbMultichannelConnection</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-SmbMulitchannelConnection cmdlet retrieves the Server Message Block (SMB) connections made between the SMB client network interfaces and the SMB server network interfaces. This cmdlet provides information about how the SMB multi-channel pairs the client and the server network interfaces and which pairs are selected to use for the SMB connections.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-SmbMultichannelConnection</maml:name><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""><maml:name>ServerName</maml:name><maml:description><maml:para>Specifies that the multi-channel connections made to the given server are enumerated.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>AsJob</maml:name><maml:description><maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><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="true" variableLength="true">CimSession[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>IncludeNotSelected</maml:name><maml:description><maml:para>Indicates the client and server network interface combinations which are not selected are used by SMB are also enumerated.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><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="true" variableLength="false">Int32</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>AsJob</maml:name><maml:description><maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><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="true" variableLength="true">CimSession[]</command:parameterValue><dev:type><maml:name>CimSession[]</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>IncludeNotSelected</maml:name><maml:description><maml:para>Indicates the client and server network interface combinations which are not selected are used by SMB are also enumerated.</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""><maml:name>ServerName</maml:name><maml:description><maml:para>Specifies that the multi-channel connections made to the given server are enumerated.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">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>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="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</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>Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbMultiChannelConnection</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. The MSFT_SmbMultiChannelConnection object represents a pair of a client and a server network interface.</maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>EXAMPLE 1</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Get-SmbMulitchannelConnection Server Name Selected Client IP Server IP Client Server Client RSS Client RDMA Interface Interface Capable Capable Index Index ----------- -------- --------- --------- -------------- -------------- -------------- -------------- Contoso-SO True 192.168.102.13 192.168.102.11 15 15 False True Contoso-SO True 192.168.101.13 192.168.101.11 12 12 False True Contoso-FS True 192.168.101.13 192.168.101.22 12 12 False True Contoso-FS True 192.168.102.13 192.168.102.22 15 15 False True Contoso-FS1 True 192.168.102.13 192.168.102.22 15 15 False True Contoso-FS1 True 192.168.101.13 192.168.101.22 12 12 False True </dev:code><dev:remarks><maml:para>This example retrieves the SMB connections made between the SMB client network interfaces and the SMB server network interfaces.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>EXAMPLE 2</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Get-SmbMultichannelConnection -ServerName Contoso-SO Server Name Selected Client IP Server IP Client Server Client RSS Client RDMA Interface Interface Capable Capable Index Index ----------- -------- --------- --------- -------------- -------------- -------------- -------------- Contoso-SO True 192.168.102.13 192.168.102.11 15 15 False True Contoso-SO True 192.168.101.13 192.168.101.11 12 12 False True </dev:code><dev:remarks><maml:para>This example retrieves the SMB connections made between the SMB client network interfaces and the SMB server network interfaces for the SMB server named Contoso-SO.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>EXAMPLE 3</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Get-SmbMultichannelConnection -ServerName Contoso-SO | Select –Property * ClientInterfaceFriendlyName : RDMA2 ClientInterfaceIndex : 15 ClientIpAddress : 192.168.102.13 ClientLinkSpeed : 32000000000 ClientRdmaCapable : True ClientRSSCapable : False CurrentChannels : 2 Failed : False FailureCount : 0 MaxChannels : 2 Selected : True ServerInterfaceIndex : 15 ServerIpAddress : 192.168.102.11 ServerLinkSpeed : 32000000000 ServerName : Contoso-SO ServerRdmaCapable : True ServerRSSCapable : False PSComputerName : CimClass : ROOT/Microsoft/Windows/SMB:MSFT_SmbMultichannelConnection CimInstanceProperties : {ClientInterfaceFriendlyName, ClientInterfaceIndex, ClientIpAddress, ClientLinkSpeed...} CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties ClientInterfaceFriendlyName : RDMA1 ClientInterfaceIndex : 12 ClientIpAddress : 192.168.101.13 ClientLinkSpeed : 32000000000 ClientRdmaCapable : True ClientRSSCapable : False CurrentChannels : 2 Failed : False FailureCount : 0 MaxChannels : 2 Selected : True ServerInterfaceIndex : 12 ServerIpAddress : 192.168.101.11 ServerLinkSpeed : 32000000000 ServerName : Contoso-SO ServerRdmaCapable : True ServerRSSCapable : False PSComputerName : CimClass : ROOT/Microsoft/Windows/SMB:MSFT_SmbMultichannelConnection CimInstanceProperties : {ClientInterfaceFriendlyName, ClientInterfaceIndex, ClientIpAddress, ClientLinkSpeed...} CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties </dev:code><dev:remarks><maml:para>This example retrieves all of the information about the SMB connections made between the SMB client network interfaces and the SMB server network interfaces for the SMB server named Contoso-SO.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>EXAMPLE 4</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Get-SmbMultichannelConnection -ServerName Contoso-SO -IncludeNotSelected Server Name Selected Client IP Server IP Client Server Client RSS Client RDMA Interface Interface Capable Capable Index Index ----------- -------- --------- --------- -------------- -------------- -------------- -------------- Contoso-SO True 192.168.102.13 192.168.102.11 15 15 False True Contoso-SO False 192.168.102.13 192.168.102.11 15 15 True False Contoso-SO True 192.168.101.13 192.168.101.11 12 12 False True Contoso-SO False 192.168.101.13 192.168.101.11 12 12 True False Contoso-SO False 192.168.100.13 192.168.100.11 14 14 False False Contoso-SO False 172.30.182.10 192.168.102.11 32 15 False False Contoso-SO False 172.30.182.10 192.168.102.11 32 15 False False Contoso-SO False 172.30.182.10 192.168.100.11 32 14 False False Contoso-SO False 172.30.182.10 192.168.101.11 32 12 False False Contoso-SO False 172.30.182.10 192.168.101.11 32 12 False False </dev:code><dev:remarks><maml:para>This example retrieves the all of the connections made between the SMB client network interfaces and the SMB server network interfaces for the SMB server named Contoso-SO.</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=289513</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Update-SmbMultichannelConnection</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>Update-SmbMultichannelConnection</command:name><maml:description><maml:para>Forces the Server Message Block (SMB) client to update the multi-channel-related information.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Update</command:verb><command:noun>SmbMultichannelConnection</command:noun><dev:version /></command:details><maml:description><maml:para>The Update-SmbMulitchannelConnection cmdlet forces the Server Message Block (SMB) client to update the multi-channel-related information. To do this the SMB client will communicate with one or more servers to which it is connected, to get the latest information on the network interfaces that is shared. If a server name is provided, then the SMB client will communicate with only that server to get the information. If no parameter is provided, then the SMB client will communicate with all of the servers to which it is connected.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Update-SmbMultichannelConnection</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""><maml:name>ServerName</maml:name><maml:description><maml:para>Specifies the name of the server to which to connect from the SMB client to get the latest information on the network interfaces it has.</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>AsJob</maml:name><maml:description><maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><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="true" variableLength="true">CimSession[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><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="true" variableLength="false">Int32</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>AsJob</maml:name><maml:description><maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><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="true" variableLength="true">CimSession[]</command:parameterValue><dev:type><maml:name>CimSession[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""><maml:name>ServerName</maml:name><maml:description><maml:para>Specifies the name of the server to which to connect from the SMB client to get the latest information on the network interfaces it has.</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>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="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</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>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</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Update-SmbMulitchannelConnection </dev:code><dev:remarks><maml:para>This example forces the SMB client to update the multi-channel-related information.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>EXAMPLE 2</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Update-SmbMultichannelConnection -ServerName Contoso-SO </dev:code><dev:remarks><maml:para>This example forces the SMB client to update the multi-channel-related information for the SMB server named Contoso-SO.</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=291241</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-SmbMultichannelConnection</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> </helpItems> |