HelpCache/SmbServerNetworkInterface.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-SmbServerNetworkInterface</command:name><maml:description><maml:para>Retrieves the network interfaces used by the Server Message Block (SMB) server.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>SmbServerNetworkInterface</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-SmbServerNetworkInterface cmdlet retrieves the network interfaces used by the Server Message Block (SMB) server.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-SmbServerNetworkInterface</maml:name><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="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:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/SMB/MSFT_SmbServerNetworkInterface</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>The MSFT_SmbServerNetworkInterface object represents the network interfaces of the SMB server.</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-SmbServerNetworkInterface Scope Name Interface Index RSS Capable RDMA Capable Speed IpAddress ---------- --------------- ----------- ------------ ----- --------- Contoso-FS 14 False False 1 Gbps 192.168.100.22 Contoso-FS 12 True True 32 Gbps 192.168.101.22 Contoso-FS 15 True True 32 Gbps 192.168.102.22 * 15 True True 32 Gbps 192.168.102.22 * 15 True True 32 Gbps 192.168.102.11 * 14 False False 1 Gbps 192.168.100.22 * 14 False False 1 Gbps 192.168.100.11 * 13 False False 1 Gbps 172.30.182.8 * 12 True True 32 Gbps 192.168.101.22 * 12 True True 32 Gbps 192.168.101.11 Contoso-SO 15 True True 32 Gbps 192.168.102.11 Contoso-SO 14 False False 1 Gbps 192.168.100.11 Contoso-SO 12 True True 32 Gbps 192.168.101.11 FE80::C8C0:F65D:... 13 False False 1 Gbps 172.30.182.8 </dev:code><dev:remarks><maml:para>This example retrieves the network interfaces used by the SMB server.</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-SmbServerNetworkInterface | Where-Object -Property LinkSpeed -Gt 10GB Scope Name Interface Index RSS Capable RDMA Capable Speed IpAddress ---------- --------------- ----------- ------------ ----- --------- Contoso-FS 12 True True 32 Gbps 192.168.101.22 Contoso-FS 15 True True 32 Gbps 192.168.102.22 * 15 True True 32 Gbps 192.168.102.22 * 15 True True 32 Gbps 192.168.102.11 * 12 True True 32 Gbps 192.168.101.22 * 12 True True 32 Gbps 192.168.101.11 Contoso-SO 15 True True 32 Gbps 192.168.102.11 Contoso-SO 12 True True 32 Gbps 192.168.101.11 </dev:code><dev:remarks><maml:para>This example retrieves the network interfaces used by the SMB server with the link speed of 10 gigabits or faster.</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-SmbServerNetworkInterface | Where-Object -Property ScopeName -Eq Contoso-FS Scope Name Interface Index RSS Capable RDMA Capable Speed IpAddress ---------- --------------- ----------- ------------ ----- --------- Contoso-FS 14 False False 1 Gbps 192.168.100.22 Contoso-FS 12 True True 32 Gbps 192.168.101.22 Contoso-FS 15 True True 32 Gbps 192.168.102.22 </dev:code><dev:remarks><maml:para>This example retrieves the network interfaces used by the SMB server named Contoso-FS.</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-SmbServerNetworkInterface | Where-Object -Property ScopeName -Eq Contoso-FS | Select-Object -Property * FriendlyName : Internal InterfaceIndex : 14 IpAddress : 192.168.100.22 LinkSpeed : 1000000000 RdmaCapable : False RssCapable : False ScopeName : Contoso-FS PSComputerName : CimClass : ROOT/Microsoft/Windows/SMB:MSFT_SmbServerNetworkInterface CimInstanceProperties : {FriendlyName, InterfaceIndex, IpAddress, LinkSpeed...} CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties FriendlyName : RDMA1 InterfaceIndex : 12 IpAddress : 192.168.101.22 LinkSpeed : 32000000000 RdmaCapable : True RssCapable : True ScopeName : Contoso-FS PSComputerName : CimClass : ROOT/Microsoft/Windows/SMB:MSFT_SmbServerNetworkInterface CimInstanceProperties : {FriendlyName, InterfaceIndex, IpAddress, LinkSpeed...} CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties FriendlyName : RDMA2 InterfaceIndex : 15 IpAddress : 192.168.102.22 LinkSpeed : 32000000000 RdmaCapable : True RssCapable : True ScopeName : Contoso-FS PSComputerName : CimClass : ROOT/Microsoft/Windows/SMB:MSFT_SmbServerNetworkInterface CimInstanceProperties : {FriendlyName, InterfaceIndex, IpAddress, LinkSpeed...} CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties </dev:code><dev:remarks><maml:para>This example retrieves all of the network interfaces used by the SMB server named Contoso-FS.</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=289534</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-SmbClientNetworkInterface</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> </helpItems> |