Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Set-NcSecuritySsl


NAME
Set-NcSecuritySsl

SYNOPSIS
Modify SSL authentication for a Vserver.

SYNTAX
Set-NcSecuritySsl [[-Vserver] <String>] [-CertificateAuthority <String>] [-C
ertificateSerialNumber <String>] [-CommonName <String>] [-EnableServerAuthen
tication [<Boolean>]] [-EnableClientAuthentication [<Boolean>]] [-Controller
<NcController[]>] [<CommonParameters>]


DESCRIPTION
Modify SSL authentication for a Vserver.


PARAMETERS
-Vserver <String>
Name of vserver.

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

-CertificateAuthority <String>
Issuing Certificate Authority (CA) of server certificate. Mandatory if
EnableServerAuthentication is true.

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

-CertificateSerialNumber <String>
Serial number of certificate in hexadecimal format. Required if EnableS
erverAuthentication is true. If not specified, the serial number of the
default certificate is used.

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

-CommonName <String>
Domain name in FQDN form that specifies its exact location in the tree h
ierarchy of the Domain Name System (DNS).

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

-EnableServerAuthentication [<Boolean>]
If true, SSL Server Authentication is enabled.

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

-EnableClientAuthentication [<Boolean>]
If true, SSL Client Authentication is enabled.

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.SecuritySsl.VserverSslInfo


NOTES


Category: security ssl
API: security-ssl-modify
Family: cluster,vserver

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

C:\PS>Set-NcSecuritySsl -Vserver beam01 -CertificateAuthority test.cert -Cer
tificateSerialNumber 51C061AE


Change the beam01 SSL security certificate authority.


CertificateAuthority : test.cert
CertificateSerialNumber : 51C061AE
ClientAuthenticationEnabled : False
CommonName : test.cert
NcController : 10.63.165.62
ServerAuthenticationEnabled : True
Vserver : beam01
ClientAuthenticationEnabledSpecified : True
ServerAuthenticationEnabledSpecified : True



RELATED LINKS
Get-NcSecuritySsl







 Data ONTAP® PowerShell Toolkit