
.TH "GCLOUD_ACTIVE\-DIRECTORY_DOMAINS_UPDATE\-LDAPS\-SETTINGS" 1



.SH "NAME"
.HP
gcloud active\-directory domains update\-ldaps\-settings \- update the LDAPS settings for a domain



.SH "SYNOPSIS"
.HP
\f5gcloud active\-directory domains update\-ldaps\-settings\fR \fIDOMAIN\fR (\fB\-\-clear\-certificates\fR\ |\ [\fB\-\-certificate\-pfx\-file\fR=\fIPATH_TO_FILE\fR\ :\ \fB\-\-certificate\-password\fR=\fICERTIFICATE_PASSWORD\fR]) [\fB\-\-async\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Update a Managed Microsoft AD domain's Lightweight Directory Access Protocol
over TLS/SSL (LDAPS) settings. You must be safelisted for the Managed AD LDAPS
Alpha in order to use this feature. Consult the API documentation for a list of
certificate requirements.

This command can fail for the following reasons:
.RS 2m
.IP "\(bu" 2m
The certificate is invalid.
.IP "\(bu" 2m
The domain specified does not exist.
.IP "\(bu" 2m
The active account does not have permission to view LDAPS settings for the
domain.
.RE
.sp



.SH "EXAMPLES"

To enable LDAPS for the first time or update the certificates being used:

.RS 2m
$ gcloud active\-directory domains update\-ldaps\-settings \e
    my\-domain.com \e
    \-\-certificate\-pfx\-file=certificate\-chain\-with\-private\-key.pfx \e
    \-\-certificate\-password="password"
.RE

To disable LDAPS:

.RS 2m
$ gcloud active\-directory domains update\-ldaps\-settings \e
    my\-domain.com \-\-clear\-certificates
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Domain resource \- Name of the managed Managed Microsoft AD domain you want to
update. This represents a Cloud resource. (NOTE) Some attributes are not given
arguments in this group but can be set in other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5domain\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIDOMAIN\fR

ID of the domain or fully qualified identifier for the domain.

To set the \f5domain\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5domain\fR on the command line.
.RE
.sp


.RE
.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m

Exactly one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-certificates\fR

Disable LDAPS by deleting all existing certificates. Certificates will need to
be re\-uploaded if LDAPS is to be re\-enabled.

.TP 2m

Or at least one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-certificate\-pfx\-file\fR=\fIPATH_TO_FILE\fR

PKCS#12\-formatted pfx file that specifies the certificate chain used to
configure LDAPS. If certificate\-password is not specified, command will prompt
user for secret. Use a full or relative path to a local file containing the
value of certificate_pfx_file.

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-certificate\-password\fR=\fICERTIFICATE_PASSWORD\fR

Password used to encrypt the PKCS#12 certificate. If not specified, command will
prompt user for secret.


.RE
.RE
.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.


.RE
.sp

.SH "GCLOUD WIDE FLAGS"

These flags are available to all commands: \-\-access\-token\-file, \-\-account,
\-\-billing\-project, \-\-configuration, \-\-flags\-file, \-\-flatten,
\-\-format, \-\-help, \-\-impersonate\-service\-account, \-\-log\-http,
\-\-project, \-\-quiet, \-\-trace\-token, \-\-user\-output\-enabled,
\-\-verbosity.

Run \fB$ gcloud help\fR for details.



.SH "API REFERENCE"

This command uses the \fBmanagedidentities/v1\fR API. The full documentation for
this API can be found at: https://cloud.google.com/managed\-microsoft\-ad/



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha active\-directory domains update\-ldaps\-settings
.RE

.RS 2m
$ gcloud beta active\-directory domains update\-ldaps\-settings
.RE


