HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/394/help/man/man1/gcloud_database-migration_connection-profiles_update.1
.TH "GCLOUD_DATABASE\-MIGRATION_CONNECTION\-PROFILES_UPDATE" 1



.SH "NAME"
.HP
gcloud database\-migration connection\-profiles update \- update a Database Migration Service connection profile



.SH "SYNOPSIS"
.HP
\f5gcloud database\-migration connection\-profiles update\fR (\fICONNECTION_PROFILE\fR\ :\ \fB\-\-region\fR=\fIREGION\fR) [\fB\-\-alloydb\-cluster\fR=\fIALLOYDB_CLUSTER\fR] [\fB\-\-ca\-certificate\fR=\fICA_CERTIFICATE\fR] [\fB\-\-client\-certificate\fR=\fICLIENT_CERTIFICATE\fR] [\fB\-\-cloudsql\-instance\fR=\fICLOUDSQL_INSTANCE\fR] [\fB\-\-cloudsql\-project\-id\fR=\fICLOUDSQL_PROJECT_ID\fR] [\fB\-\-database\fR=\fIDATABASE\fR] [\fB\-\-database\-service\fR=\fIDATABASE_SERVICE\fR] [\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR] [\fB\-\-host\fR=\fIHOST\fR] [\fB\-\-port\fR=\fIPORT\fR] [\fB\-\-private\-key\fR=\fIPRIVATE_KEY\fR] [\fB\-\-ssl\-type\fR=\fISSL_TYPE\fR] [\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-username\fR=\fIUSERNAME\fR] [\fB\-\-clear\-labels\fR\ |\ \fB\-\-remove\-labels\fR=[\fIKEY\fR,...]] [\fB\-\-gcs\-bucket\fR=\fIGCS_BUCKET\fR\ :\ \fB\-\-gcs\-prefix\fR=\fIGCS_PREFIX\fR] [\fB\-\-password\fR=\fIPASSWORD\fR\ |\ \fB\-\-prompt\-for\-password\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Update a Database Migration Service connection profile.
.RS 2m
.IP "\(bu" 2m
Draft connection profile: the user can update all flags available in
\f5connection\-profiles create\fR command.
.IP "\(bu" 2m
Existing connection profile: the user can update a limited list of flags, see
\f5connection\-profiles update\fR Synopsis.
.IP "\(bu" 2m
If a migration job is using the connection profile, then updates to fields
\f5host\fR, \f5port\fR, \f5username\fR, and \f5password\fR will propagate to the
destination instance.
.RE
.sp



.SH "EXAMPLES"

To update the username of a connection profile:

.RS 2m
$ gcloud database\-migration connection\-profiles update my\-profile \e
  \-\-region=us\-central1 \-\-username=new\-user
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Connection profile resource \- The connection profile to update. The arguments
in this group can be used to specify the attributes of this 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 \f5connection_profile\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
\fICONNECTION_PROFILE\fR

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

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

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

.TP 2m
\fB\-\-region\fR=\fIREGION\fR

The Cloud region for the connection_profile.

To set the \f5region\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5connection_profile\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-region\fR on the command line.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-alloydb\-cluster\fR=\fIALLOYDB_CLUSTER\fR

If the destination is an AlloyDB cluster, use this field to provide the AlloyDB
cluster ID.

.TP 2m
\fB\-\-ca\-certificate\fR=\fICA_CERTIFICATE\fR

x509 PEM\-encoded certificate of the CA that signed the database server's
certificate. The value for this flag needs to be the content of the certificate
file, not the path to the file. For example, on a Linux machine you can use
command substitution:
<code>\-\-ca\-certificate=$(</path/to/certificate_file.pem)</code>. Database
Migration Service will use this certificate to verify it's connecting to the
correct host. Database Migration Service encrypts the value when storing it.

.TP 2m
\fB\-\-client\-certificate\fR=\fICLIENT_CERTIFICATE\fR

x509 PEM\-encoded certificate that will be used by the replica to authenticate
against the database server. The value for this flag needs to be the content of
the certificate file, not the path to the file. For example, on a Linux machine
you can use command substitution:
<code>\-\-ca\-certificate=$(</path/to/certificate_file.pem)</code>. Database
Migration Service encrypts the value when storing it.

.TP 2m
\fB\-\-cloudsql\-instance\fR=\fICLOUDSQL_INSTANCE\fR

If the source or destination is a Cloud SQL database, then use this field to
provide the respective Cloud SQL instance ID.

.TP 2m
\fB\-\-cloudsql\-project\-id\fR=\fICLOUDSQL_PROJECT_ID\fR

The project id of the Cloud SQL instance. Only needed if the Cloud SQL instance
is in a different project than the connection profile. This is only supported
for source connection profiles for SQL Server.

.TP 2m
\fB\-\-database\fR=\fIDATABASE\fR

The name of the specific database within the host.

.TP 2m
\fB\-\-database\-service\fR=\fIDATABASE_SERVICE\fR

database service for the oracle connection profile.

.TP 2m
\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR

A user\-friendly name for the connection profile. The display name can include
letters, numbers, spaces, and hyphens, and must start with a letter.

.TP 2m
\fB\-\-host\fR=\fIHOST\fR

IP or hostname of the database. When \f5\-\-psc\-service\-attachment\fR is also
specified, this field value should be: 1. For Cloud SQL PSC enabled instance \-
the dns_name field (e.g <uid>.<region>.sql.goog.). 2. For Cloud SQL PSA instance
(vpc peering) \- the private ip of the instance.

.TP 2m
\fB\-\-port\fR=\fIPORT\fR

Network port of the database.

.TP 2m
\fB\-\-private\-key\fR=\fIPRIVATE_KEY\fR

Unencrypted PKCS#1 or PKCS#8 PEM\-encoded private key associated with the Client
Certificate. The value for this flag needs to be the content of the certificate
file, not the path to the file. For example, on a Linux machine you can use
command substitution:
<code>\-\-ca\-certificate=$(</path/to/certificate_file.pem)</code>. Database
Migration Service encrypts the value when storing it.

.TP 2m
\fB\-\-ssl\-type\fR=\fISSL_TYPE\fR

The type of SSL configuration. \fISSL_TYPE\fR must be one of: \fBSERVER_ONLY\fR,
\fBSERVER_CLIENT\fR, \fBREQUIRED\fR, \fBNONE\fR.

.TP 2m
\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to update. If a label exists, its value is
modified. Otherwise, a new label is created.

Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

.TP 2m
\fB\-\-username\fR=\fIUSERNAME\fR

Username that Database Migration Service uses to connect to the database.
Database Migration Service encrypts the value when storing it.

.TP 2m

At most one of these can be specified:


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

Remove all labels. If \f5\-\-update\-labels\fR is also specified then
\f5\-\-clear\-labels\fR is applied first.

For example, to remove all labels:

.RS 2m
$ gcloud database\-migration connection\-profiles update \-\-clear\-labels
.RE

To remove all existing labels and create two new labels, \f5\fIfoo\fR\fR and
\f5\fIbaz\fR\fR:

.RS 2m
$ gcloud database\-migration connection\-profiles update \e
  \-\-clear\-labels \-\-update\-labels foo=bar,baz=qux
.RE

.TP 2m
\fB\-\-remove\-labels\fR=[\fIKEY\fR,...]

List of label keys to remove. If a label does not exist it is silently ignored.
If \f5\-\-update\-labels\fR is also specified then \f5\-\-update\-labels\fR is
applied first.

.RE
.sp
.TP 2m
\fB\-\-gcs\-bucket\fR=\fIGCS_BUCKET\fR

Cloud Storage bucket for the source SQL Server connection profile where the
backups are stored. This flag is used only for SQL Server to Cloud SQL
migrations.

.TP 2m
\fB\-\-gcs\-prefix\fR=\fIGCS_PREFIX\fR

Cloud Storage prefix path within the bucket for the source SQL Server connection
profile where the backups are stored. This flag is used only for SQL Server to
Cloud SQL migrations.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-password\fR=\fIPASSWORD\fR

Password for the user that Database Migration Service uses to connect to the
database. Database Migration Service encrypts the value when storing it, and the
field is not returned on request.

.TP 2m
\fB\-\-prompt\-for\-password\fR

Prompt for the password used to connect to the database.


.RE
.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 "NOTES"

This variant is also available:

.RS 2m
$ gcloud alpha database\-migration connection\-profiles update
.RE