Merge pull request #3788 from Xelu86/Update_SmbServerAlternativePort

Added new SMBServerAlternativePort cmdlet

Author: Xelu86

docset/winserver2025-ps/smbshare/Get-SmbServerAlternativePort.md

@@ -0,0 +1,179 @@
+---
+description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
+external help file: SmbServerAlternativePort.cdxml-help.xml
+Module Name: SmbShare
+ms.date: 02/22/2024
+online version: https://learn.microsoft.com/powershell/module/smbshare/get-smbserveralternativeport?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
+schema: 2.0.0
+title: Get-SmbServerAlternativePort
+---
+
+# Get-SmbServerAlternativePort
+
+## SYNOPSIS
+Gets the alternative ports configured for the Server Message Block (SMB) protocol on the local
+server.
+
+## SYNTAX
+
+```
+Get-SmbServerAlternativePort [[-TransportType] <TransportType[]>] [[-Port] <UInt16[]>]
+ [-IncludeHidden] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
+ [<CommonParameters>]
+```
+
+## DESCRIPTION
+
+The `Get-SmbServerAlternativePort` retrieves the alternative ports configured for the Server
+Message Block (SMB) protocol on the local server. This cmdlet can be used to view the alternate
+ports that have been configured for SMB, which can be useful for troubleshooting or configuring
+firewalls. The cmdlet returns a list of the alternate ports that are currently configured for SMB
+on the local server.
+
+## EXAMPLES
+
+### Example 1: Get all SMB Server alternative ports
+
+```powershell
+Get-SmbServerAlternativePort
+```
+
+This command retrieves a list of all SMB server alternative ports that are currently configured on
+the local server.
+
+## PARAMETERS
+
+### -AsJob
+
+Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
+complete.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -CimSession
+
+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 [New-CimSession](/powershell/module/cimcmdlets/new-cimsession)
+or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
+current session on the local computer.
+
+```yaml
+Type: CimSession[]
+Parameter Sets: (All)
+Aliases: Session
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -IncludeHidden
+
+Not used.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Port
+
+Specifies the port number that the SMB connection should use.
+
+```yaml
+Type: UInt16[]
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 2
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -ThrottleLimit
+
+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.
+
+```yaml
+Type: Int32
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -TransportType
+
+Specifies the transport protocol to use for the SMB connection. The only accepted value for this
+parameter is `QUIC`.
+
+```yaml
+Type: TransportType[]
+Parameter Sets: (All)
+Aliases:
+Accepted values: QUIC
+
+Required: False
+Position: 1
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### CommonParameters
+
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
+-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
+-WarningAction, and -WarningVariable. For more information, see
+[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
+
+## INPUTS
+
+### Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbServerAlternativePort.TransportType[]
+
+### System.UInt16[]
+
+## OUTPUTS
+
+### Microsoft.Management.Infrastructure.CimInstance
+
+### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/SMB/MSFT_SmbServerAlternativePort
+
+## NOTES
+
+## RELATED LINKS
+
+[New-SmbServerAlternativePort](New-SmbServerAlternativePort.md)
+
+[Remove-SmbServerAlternativePort](Remove-SmbServerAlternativePort.md)
+
+[Set-SmbServerAlternativePort](Set-SmbServerAlternativePort.md)