Merge pull request #3789 from Xelu86/Update_SmbServerCertificateMapping

Added new parameters for SmbServerCertificateMapping

Author: Xelu86

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

@@ -2,7 +2,7 @@
 description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
 external help file: SmbServerCertificateMapping.cdxml-help.xml
 Module Name: SmbShare
-ms.date: 08/31/2021
+ms.date: 02/22/2024
 online version: https://learn.microsoft.com/powershell/module/smbshare/get-smbservercertificatemapping?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
 schema: 2.0.0
 title: Get-SmbServerCertificateMapping
@@ -16,23 +16,29 @@ Retrieves a certificate associated with the SMB server for SMB over QUIC.
 ## SYNTAX
 
 ```
-Get-SmbServerCertificateMapping [[-Name] <String[]>] [[-Subject] <String[]>] [-Thumbprint <String[]>]
- [-DisplayName <String[]>] [-StoreName <String[]>] [-Type <Type[]>] [-Flags <Flags[]>] [-IncludeHidden]
- [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
+Get-SmbServerCertificateMapping [[-Name] <String[]>] [[-Subject] <String[]>]
+ [-Thumbprint <String[]>] [-DisplayName <String[]>] [-StoreName <String[]>] [-Type <Type[]>]
+ [-Flags <Flags[]>] [-RequireClientAuthentication <Boolean[]>]
+ [-SkipClientCertificateAccessCheck <Boolean[]>] [-IncludeHidden] [-CimSession <CimSession[]>]
+ [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-The **Get-SmbServerCertificateMapping** cmdlet retrieves the certificates associated with the SMB server for SMB over QUIC on ‘Windows Server 2022 Datacenter: Azure Edition’. This cmdlet is not used for Windows or other Windows Server editions. For more information, review [SMB over QUIC](https://aka.ms/smboverquic).
+
+The `Get-SmbServerCertificateMapping` cmdlet retrieves the certificates associated with the SMB
+server for SMB over QUIC. For more information, see [SMB over QUIC](https://aka.ms/smboverquic).
 
 ## EXAMPLES
 
 ### Example 1 - Retrieve the certificate mapped to two SMB over QUIC server names
 
-This command retrieves the certificate mapped to two SMB over QUIC server names that clients can connect to, `fs2.contoso.com` and `2022-ae-02.corp.contoso.com`.
+This command retrieves the certificate mapped to two SMB over QUIC server names that clients can
+connect to, `fs2.contoso.com` and `2022-ae-02.corp.contoso.com`.
 
 ```powershell
-PS C:\> Get-SmbServerCertificateMapping
+Get-SmbServerCertificateMapping
 ```
+
 ```output
 Name                        Subject       Thumbprint                               DisplayName StoreName Type Flags
 ----                        -------       ----------                               ----------- --------- ---- -----
@@ -43,7 +49,9 @@ fs2.contoso.com             CN=2022-ae-02 88032B3551FAF7DE26EFFFF814AA086E3DBD2A
 ## PARAMETERS
 
 ### -AsJob
-Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
+
+Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
+complete.
 
 ```yaml
 Type: SwitchParameter
@@ -58,7 +66,11 @@ 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`](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the current session on the local computer.
+
+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[]
@@ -73,6 +85,7 @@ Accept wildcard characters: False
 ```
 
 ### -DisplayName
+
 Specifies a friendly name to display for the mapping.
 
 ```yaml
@@ -88,12 +101,14 @@ Accept wildcard characters: False
 ```
 
 ### -Flags
-Specifies if `NamedPipes` are enabled for SMB over QUIC. The acceptable values for this parameter are:
 
+Specifies if `NamedPipes` are enabled for SMB over QUIC. The acceptable values for this parameter
+are:
 
-- `None:` Remove all flags
-- `AllowNamedPipe:` Enable use of named pipes in SMB over QUIC connections for this mapping (off by default, overrides value of RestrictNamedPipeAccessOverQuic)
-- `DefaultCert:` Not used
+- `None`: Remove all flags
+- `AllowNamedPipe`: Enable use of named pipes in SMB over QUIC connections for this mapping (off by
+  default, overrides value of RestrictNamedPipeAccessOverQuic)
+- `DefaultCert`: Not used
 
 ```yaml
 Type: Flags[]
@@ -109,6 +124,7 @@ Accept wildcard characters: False
 ```
 
 ### -IncludeHidden
+
 Not used.
 
 ```yaml
@@ -124,7 +140,9 @@ Accept wildcard characters: False
 ```
 
 ### -Name
-Specifies a fully-qualified DNS name or NetBIOS name that must match the certificate’s subject name or an entry in the certificate’s subject alternative names.
+
+Specifies a fully-qualified DNS name or NetBIOS name that must match the certificate's subject name
+or an entry in the certificate's subject alternative names.
 
 ```yaml
 Type: String[]
@@ -138,7 +156,49 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+### -RequireClientAuthentication
+
+Specifies whether client authentication is required for connections to the server. When this
+parameter is set to `$true`, clients must present a valid certificate to connect to the server.
+When it is set to `$false`, clients can connect without presenting a certificate.
+
+```yaml
+Type: Boolean[]
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -SkipClientCertificateAccessCheck
+
+Specifies whether the server should skip the check for client certificate access when a client
+connects. When this parameter is set to `$true`, the server will not check whether the client has
+access to the certificate it presents. This can be useful in scenarios where the server is acting
+as a gateway or proxy, and does not need to perform full certificate validation.
+
+However, it can also increase the risk of security breaches. When this parameter is set to
+`$false`, the server will check whether the client has access to the certificate it presents before
+allowing the client to connect.
+
+```yaml
+Type: Boolean[]
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
 ### -StoreName
+
 Specifies the path to the certificate store for the certificate.
 
 ```yaml
@@ -154,6 +214,7 @@ Accept wildcard characters: False
 ```
 
 ### -Subject
+
 Specifies the subject name of the certificate.
 
 ```yaml
@@ -169,7 +230,12 @@ 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.
+
+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
@@ -184,6 +250,7 @@ Accept wildcard characters: False
 ```
 
 ### -Thumbprint
+
 Specifies the thumbprint value of the certificate.
 
 ```yaml
@@ -199,9 +266,10 @@ Accept wildcard characters: False
 ```
 
 ### -Type
+
 Specifies the type of certificate mapping. The acceptable value for this parameter is:
 
-`QUIC:` Certificate mapping is for SMB over QUIC.
+- `QUIC`: Certificate mapping is for SMB over QUIC.
 
 ```yaml
 Type: Type[]
@@ -217,7 +285,11 @@ 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](https://go.microsoft.com/fwlink/?LinkID=113216).
+
+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
 
@@ -227,6 +299,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ### Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbServerCertificateMapping.Flags[]
 
+### System.Boolean[]
+
 ## OUTPUTS
 
 ### Microsoft.Management.Infrastructure.CimInstance
@@ -236,3 +310,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## NOTES
 
 ## RELATED LINKS
+
+[New-SmbServerCertificateMapping](New-SmbServerCertificateMapping.md)
+
+[Remove-SmbServerCertificateMapping](Remove-SmbServerCertificateMapping.md)
+
+[Set-SmbServerCertificateMapping](Set-SmbServerCertificateMapping.md)