Get-SmbClientCertificateMapping
Retrieves the client certificate mappings for the Server Message Block (SMB) protocol.
Syntax
Default (Default)
Get-SmbClientCertificateMapping
[[-Namespace] <String[]>]
[[-Subject] <String[]>]
[-IssuerName <String[]>]
[-Thumbprint <String[]>]
[-DisplayName <String[]>]
[-StoreName <String[]>]
[-Type <Type[]>]
[-Flags <Flags[]>]
[-IncludeHidden]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
Description
The Get-SmbClientCertificateMapping cmdlet retrieves the client certificate mappings for the SMB
protocol, such as when using SMB over QUIC. These mappings are used to authenticate clients that
connect to SMB servers using certificates.
Examples
Example 1: Retrieve all certificate mappings for a specific store
Get-SmbClientCertificateMapping -StoreName "My"
This retrieves all certificate mappings that have been stored in a specific certificate store.
Example 2: Retrieve a specific certificate mapping by display name
Get-SmbClientCertificateMapping -DisplayName "MyCertificateMapping"
This retrieves a specific certificate mapping by its display name.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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 or Get-CimSession cmdlet. The default is the current session on the local computer.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DisplayName
Specifies the friendly name of the certificate.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Flags
Specifies if NamedPipes are enabled for SMB over QUIC. The acceptable values for this parameter
are:
None: Remove all flagsAllowNamedPipe: Enable use of named pipes in SMB over QUIC connections for this mapping (off by default, overrides value of the RestrictNamedPipeAccessOverQuic parameter)DefaultCert: Not used
Parameter properties
| Type: | Flags[] |
| Default value: | None |
| Accepted values: | None, AllowNamedPipe, DefaultCert |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-IncludeHidden
Not used.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IssuerName
Filters the certificate mappings based on the issuer name of the certificate.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Namespace
Specifies the namespace in which the certificate mappings are located. By default, the cmdlet
searches in the root\cimv2\Security\MicrosoftTlsCertificateMappingProvider namespace.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-StoreName
Specifies the path to the certificate store for the certificate.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Subject
Specifies the subject name of the certificate.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Thumbprint
Specifies the thumbprint value of the certificate.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Type
Specifies the type of certificate mapping. The acceptable value for this parameter is:
QUIC: Certificate mapping is for SMB over QUIC.
Parameter properties
| Type: | Type[] |
| Default value: | None |
| Accepted values: | QUIC |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.