Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: New-NcSecurityCertificate


NAME
New-NcSecurityCertificate

SYNOPSIS
Create a new digital security certificate.

SYNTAX
New-NcSecurityCertificate [-CommonName] <String> [-Type] <String> [-Size <St
ring>] [-Country <String>] [-State <String>] [-Locality <String>] [-Organiza
tion <String>] [-OrganizationUnit <String>] [-EmailAddress <String>] [-Expir
eDays <Int32>] [-HashFunction <String>] [-Vserver <String>] [-Controller <Nc
Controller[]>] [<CommonParameters>]


DESCRIPTION
Create a new digital security certificate. If a certificate is created with
the existing Common Name then a new certificate is generated with a differe
nt serial number.


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

-Size <String>
Size of requested certificate in bits. Default value is '2048'.

Possible values:
'512' - 512 bits private key,
'1024' - 1024 bits private key,
'1536' - 1536 bits private key,
'2048' - 2048 bits private key

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Country <String>
Name of the country. Default value is 'US'.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-State <String>
Name of the state. Default value is empty string.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Locality <String>
Name of the locality Default value is empty string.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Organization <String>
Name of the organization. Default value is empty string.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-OrganizationUnit <String>
Name of the unit. Example: IT, Finance. Default value is empty string.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-EmailAddress <String>
Email address of administrator. Default value is empty string.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-ExpireDays <Int32>
Number of days until expiration. Default value is '365'.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-HashFunction <String>
Hashing function used to sign the certificate. Default value is 'sha256'
. Possible values: 'sha1', 'sha256', 'md5'

Required? false
Position? named
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

<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-create
Family: cluster,vserver

-------------- Example 1 --------------

C:\PS>New-NcSecurityCertificate -CommonName beam01.cert2 -Type root_ca -Size
2048


Create a new security certificate with the given common name.






RELATED LINKS
Get-NcSecurityCertificate
Remove-NcSecurityCertificate







 Data ONTAP® PowerShell Toolkit