|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Get-NcSecurityCertificate
NAME
Get-NcSecurityCertificate
SYNOPSIS
Get a list of security-certificate objects.
SYNTAX
Get-NcSecurityCertificate [[-CommonName] <String[]>] [-SerialNumber <String[
]>] [-CertificateAuthority <String[]>] [-Type <String[]>] [-Size <String[]>]
[-Vserver <String[]>] [-Attributes <CertificateInfo>] [-VserverContext <Str
ing>] [-Controller <NcController[]>] [<CommonParameters>]
Get-NcSecurityCertificate -Template [-VserverContext <String>] [-Controller
<NcController[]>] [<CommonParameters>]
Get-NcSecurityCertificate -Query <CertificateInfo> [-Attributes <Certificate
Info>] [-VserverContext <String>] [-Controller <NcController[]>] [<CommonPar
ameters>]
DESCRIPTION
Get a list of security-certificate objects.
PARAMETERS
-CommonName <String[]>
One or more domain names in FQDN form. Data ONTAP wildcards are permitt
ed.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SerialNumber <String[]>
One or more serial numbers of certificates. Data ONTAP wildcards are pe
rmitted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-CertificateAuthority <String[]>
One or more certificate authority values. Data ONTAP wildcards are perm
itted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Type <String[]>
Type of certificate. Possible values: server, root_ca, client_ca, serv
er_chain. Data ONTAP wildcards are permitted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Size <String[]>
Size of requested certificate in bits. Possible values: 512, 1024, 153
6, 2048. Data ONTAP wildcards are permitted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Vserver <String[]>
Restrict results to the specified vserver(s). Data ONTAP wildcards are
permitted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Attributes <CertificateInfo>
For improved scalability in large clusters, provide a CertificateInfo ob
ject with various fields set to indicate which fields to return on all o
bjects. Undesired fields should remain set to null. Use "Get-NcSecurit
yCertificate -Template" to get the initially empty CertificateInfo objec
t. If not specified, all data is returned for each object.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-VserverContext <String>
Vserver to which to direct this command. If the currently connected con
troller (as embodied by an NcController object) represents a cluster, th
ere are multiple means to address commands to one of its vservers. Eith
er set the Vserver field on the NcController object to direct all subseq
uent commands to that vserver, or supply the VserverContext parameter to
an individual cmdlet. Only cmdlets which may be invoked on vservers of
fer the VserverContext parameter.
Required? false
Position? named
Default value
Accept pipeline input? false
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
-Template
Specify to get an empty CertificateInfo object for use with advanced que
ries involving the Query attribute.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Query <CertificateInfo>
For advanced queries, provide a CertificateInfo object with various fiel
ds set to indicate which records to retrieve. Other fields should remai
n set to null. Use "Get-NcSecurityCertificate -Template" to get the ini
tially empty CertificateInfo object.
Required? true
Position? named
Default value
Accept pipeline input? false
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
DataONTAP.C.Types.SecurityCertificate.CertificateInfo
NOTES
Category: security certificate
API: security-certificate-get-iter
Family: cluster,vserver
-------------- Example 1 --------------
C:\PS>Get-NcSecurityCertificate -Vserver beam01
Get the security certificates for the beam01 vserver.
CertificateAuthority : beam01.cert
CommonName : beam01.cert
Country : US
EmailAddress :
ExpirationDate : 1392238850
ExpirationDateDT : 2/12/2014 4:00:50 PM
ExpireDays :
HashFunction : sha256
Locality :
NcController : 10.63.165.62
Organization :
OrganizationUnit :
Protocol : ssl
PublicCertificate : -----BEGIN CERTIFICATE-----
-----END CERTIFICATE-----
SerialNumber : 511AAD82
Size : 2048
StartDate : 1360702850
StartDateDT : 2/12/2013 4:00:50 PM
State :
Type : server
Vserver : beam01
ExpirationDateSpecified : True
ExpireDaysSpecified : False
StartDateSpecified : True
-------------- Example 2 --------------
C:\PS>$q = Get-NcSecurityCertificate -Template
$q.HashFunction = "sha256"
$q.Vserver = "beam01"
Get-NcSecurityCertificate -Query $q
Query for security certificates.
CertificateAuthority : beam01.cert
CommonName : beam01.cert
Country : US
EmailAddress :
ExpirationDate : 1392238850
ExpirationDateDT : 2/12/2014 4:00:50 PM
ExpireDays :
HashFunction : sha256
Locality :
NcController : 10.63.165.62
Organization :
OrganizationUnit :
Protocol : ssl
PublicCertificate : -----BEGIN CERTIFICATE-----
-----END CERTIFICATE-----
SerialNumber : 511AAD82
Size : 2048
StartDate : 1360702850
StartDateDT : 2/12/2013 4:00:50 PM
State :
Type : server
Vserver : beam01
ExpirationDateSpecified : True
ExpireDaysSpecified : False
StartDateSpecified : True
RELATED LINKS
Remove-NcSecurityCertificate
New-NcSecurityCertificate
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|