|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Remove-NcSecurityCertificate
NAME
Remove-NcSecurityCertificate
SYNOPSIS
Remove a security certificate object.
SYNTAX
Remove-NcSecurityCertificate [-CommonName] <String> [-Type] <String> [-Seria
lNumber] <String> [-CertificateAuthority] <String> [-Vserver <String>] [-Con
troller <NcController[]>] [<CommonParameters>]
Remove-NcSecurityCertificate -Query <CertificateInfo> [-ContinueOnFailure] [
-MaxFailureCount <Int32>] [-Controller <NcController[]>] [<CommonParameters>
]
DESCRIPTION
Remove a security certificate object.
PARAMETERS
-CommonName <String>
The domain name in FQDN form that specifies its exact location in the tr
ee hierarchy of the Domain Name System (DNS).
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Type <String>
Type of certificate.
Possible values:
'server' - Server certificate,
'root_ca' - Self-Signed Root CA,
'client_ca' - CA who signed user certificates',
'server_chain' - Intermediate certificate for server authentication
Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SerialNumber <String>
Serial number of certificate.
Required? true
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-CertificateAuthority <String>
Certificate authority.
Required? true
Position? 4
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Vserver <String>
Name of vserver.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Controller <NcController[]>
A clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on e
ach controller in succession.
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Query <CertificateInfo>
For advanced queries, provide a CertificateInfo object with various fiel
ds set to indicate which records to remove. Other fields should remain
set to null. Use "Get-NcSecurityCertificate -Template" to get the initi
ally empty CertificateInfo object.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ContinueOnFailure
If specified, the API will continue deleting the next matching security-
certificate even when the deletion of a previous security-certificate fa
ils.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-MaxFailureCount <Int32>
When allowing failures (ContinueOnFailure specified), MaxFailureCount li
mits the number of failed deletions before the server gives up and retur
ns.
When specified, the API will continue deleting the next matching securit
y-certificate even when the deletion of a previous matching security-cer
tificate fails, and do so until the total number of objects failed to be
deleted reaches the maximum specified.
If set to the maximum or not provided, then there will be no limit on th
e number of failed deletions.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".
INPUTS
OUTPUTS
NOTES
Category: security certificate
API: security-certificate-delete,security-certificate-delete-iter
Family: cluster,vserver
-------------- Example 1 --------------
C:\PS>Remove-NcSecurityCertificate -CommonName beam01.cert2 -Type root_ca -S
erialNumber 51BB6E69 -CertificateAuthority beam01.cert2 -Vserver sfp-cmode-0
2
Remove the given security certificate.
-------------- Example 2 --------------
C:\PS>$q = Get-NcSecurityCertificate -Template
$q.CommonName = 'beam01.cert2'
Remove-NcSecurityCertificate -Query $q
Remove the security certificate that matches the query.
SuccessCount : 1
FailureCount : 0
SuccessList : {DataONTAP.C.Types.SecurityCertificate.CertificateInfo}
FailureList : {}
RELATED LINKS
Get-NcSecurityCertificate
New-NcSecurityCertificate
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|