Remove-SmbClientCertificateMapping
Removes an existing client certificate mapping for the Server Message Block (SMB) protocol.
Syntax
Remove-SmbClientCertificateMapping
[-Namespace] <String[]>
[[-Subject] <String[]>]
[[-Thumbprint] <String[]>]
[[-DisplayName] <String[]>]
[[-StoreName] <String[]>]
[[-IssuerName] <String[]>]
[[-Type] <Type[]>]
[[-Flags] <Flags[]>]
[-IncludeHidden]
[-Force]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Remove-SmbClientCertificateMapping
-InputObject <CimInstance[]>
[-Force]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Remove-SmbClientCertificateMapping cmdlet removes an existing client certificate mapping for
the SMB protocol. These mappings are used to authenticate clients that connect to SMB servers using
certificates. You can use this cmdlet to remove a mapping between a client certificate and an SMB
client name.
Examples
Example 1: Remove all certificate mappings from a specific store
Remove-SmbClientCertificateMapping -StoreName "My" -ForceThis force removes all certificate mappings that have been stored in a specific certificate store.
Example 2: Remove a certificate mapping by thumbprint
Remove-SmbClientCertificateMapping -Thumbprint "MyThumbprint" -ForceThis force removes a certificate mapping with a specific thumbprint.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 or Get-CimSession cmdlet. The default is the current session on the local computer.
| Type: | CimSession[] |
| Aliases: | Session |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisplayName
Specifies the friendly name of the certificate.
| Type: | String[] |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Flags
Specifies if Named Pipes 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 the value of the RestrictNamedPipeAccessOverQuic parameter).DefaultCert: Not used.
| Type: | Flags[] |
| Accepted values: | None, AllowNamedPipe, DefaultCert |
| Position: | 7 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Force
Forces the command to run without asking for user confirmation.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IncludeHidden
Not used.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specifies the input object that's used in a pipeline command.
| Type: | CimInstance[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IssuerName
Filters the certificate mappings based on the issuer name of the certificate.
| Type: | String[] |
| Position: | 5 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Namespace
Specifies the namespace of the QUIC server. For example, server1.contoso.com. By default, the
cmdlet searches in the root\cimv2\Security\MicrosoftTlsCertificateMappingProvider namespace.
| Type: | String[] |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PassThru
Returns an object representing the item with which you're working. By default, this cmdlet doesn't generate any output.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StoreName
Specifies the path to the certificate store for the certificate. The recommended value is "My" for the local machine personal store.
| Type: | String[] |
| Position: | 5 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Subject
Specifies the subject name of the certificate.
| Type: | String[] |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| 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.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Thumbprint
Specifies the thumbprint value of the certificate.
| Type: | String[] |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Type
QUIC: Certificate mapping is for SMB over QUIC.
| Type: | Type[] |
| Accepted values: | QUIC |
| Position: | 6 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
String[]
Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbClientCertificateMapping.Type[]
Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbClientCertificateMapping.Flags[]