"update-db2-connection"
***********************

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


Description
===========

Updates the Connection.


Usage
=====

   oci goldengate connection update-db2-connection [OPTIONS]


Required Parameters
===================

--connection-id [text]

The OCID of a Connection.


Optional Parameters
===================

--additional-attributes [complex type]

An array of name-value pair attribute entries. Used as additional
parameters in connection string.

This option is a JSON list with items of type NameValuePair.  For
documentation on NameValuePair please see our API reference: https://
docs.cloud.oracle.com/api/#/en/goldengate/20200407/datatypes/NameValu
ePair. This is a complex type whose value must be valid JSON. The
value can be provided as a string on the command line or passed in as
a file using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--database-name [text]

The name of the database.

--defined-tags [complex type]

Tags defined for this resource. Each key is predefined and scoped to a
namespace.

Example:

   {"foo-namespace": {"bar-key": "value"}}

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--description [text]

Metadata about this specific object.

--display-name [text]

An object’s Display Name.

--does-use-secret-ids [boolean]

Indicates that sensitive attributes are provided via Secrets.

--force

Perform update without prompting for confirmation.

--freeform-tags [complex type]

A simple key-value pair that is applied without any predefined name,
type, or scope. Exists for cross-compatibility only.

Example:

   {"bar-key": "value"}

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--from-json [text]

Provide input to this command as a JSON document from a file using the
file://path-to/file syntax.

The "--generate-full-command-json-input" option can be used to
generate a sample json file to be used with this command option. The
key names are pre-populated and match the command option names
(converted to camelCase format, e.g. compartment-id –> compartmentId),
while the values of the keys need to be populated by the user before
using the sample file as an input to this command. For any command
option that accepts multiple values, the value of the key can be a
JSON array.

Options can still be provided on the command line. If an option exists
in both the JSON document and the command line then the command line
specified value will be used.

For examples on usage of this option, please see our “using CLI with
advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--host [text]

The name or address of a host.

--if-match [text]

For optimistic concurrency control. In the PUT or DELETE call for a
resource, set the *if-match* parameter to the value of the etag from a
previous GET or POST response for that resource.  The resource is
updated or deleted only if the etag you provide matches the resource’s
current etag value.

--is-lock-override [boolean]

Whether to override locks (if any exist).

--key-id [text]

Refers to the customer’s master key OCID. If provided, it references a
key to manage secrets. Customers must add policies to permit
GoldenGate to use this key.

--max-wait-seconds [integer]

The maximum time to wait for the work request to reach the state
defined by "--wait-for-state". Defaults to 1200 seconds.

--nsg-ids [complex type]

An array of Network Security Group OCIDs used to define network access
for either Deployments or Connections. This is a complex type whose
value must be valid JSON. The value can be provided as a string on the
command line or passed in as a file using the file://path/to/file
syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--password [text]

The password Oracle GoldenGate uses to connect the associated DB2
database. Deprecated: This field is deprecated and replaced by
“passwordSecretId”. This field will be removed after February 15 2026.

--password-secret-id [text]

The OCID of the Secret where the password is stored, that Oracle
GoldenGate uses to connect the associated DB2 database. Note: When
provided, ‘password’ field must not be provided.

--port [integer]

The port of an endpoint usually specified for a connection.

--routing-method [text]

Controls the network traffic direction to the target:
SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate
Service’s network to public hosts. Cannot be used for private targets.
SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned
deployment’s private endpoint through the deployment’s subnet.
DEDICATED_ENDPOINT: A dedicated private endpoint is created in the
target VCN subnet for the connection. The subnetId is required when
DEDICATED_ENDPOINT networking is selected.

Accepted values are:

   DEDICATED_ENDPOINT, SHARED_DEPLOYMENT_ENDPOINT, SHARED_SERVICE_ENDPOINT

--security-attributes [complex type]

Security attributes for this resource. Each key is predefined and
scoped to a namespace. For more information, see Resource Tags.

Example:

   {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--security-protocol [text]

Security protocol for the DB2 database.

--ssl-client-keystash [text]

The base64 encoded keystash file which contains the encrypted password
to the key database file. This property is not supported for IBM Db2
for i, as client TLS mode is not available.

Deprecated: This field is deprecated and replaced by
“sslClientKeystashSecretId”. This field will be removed after February
15 2026.

--ssl-client-keystash-secret-id [text]

The OCID of the Secret where the keystash file is stored, which
contains the encrypted password to the key database file. This
property is not supported for IBM Db2 for i, as client TLS mode is not
available.

Note: When provided, ‘sslClientKeystash’ field must not be provided.

--ssl-client-keystoredb [text]

The base64 encoded keystore file created at the client containing the
server certificate / CA root certificate. This property is not
supported for IBM Db2 for i, as client TLS mode is not available.

Deprecated: This field is deprecated and replaced by
“sslClientKeystoredbSecretId”. This field will be removed after
February 15 2026.

--ssl-client-keystoredb-secret-id [text]

The OCID of the Secret where the keystore file stored, which created
at the client containing the server certificate / CA root certificate.
This property is not supported for IBM Db2 for i, as client TLS mode
is not available.

Note: When provided, ‘sslClientKeystoredb’ field must not be provided.

--ssl-server-certificate [text]

The base64 encoded file which contains the self-signed server
certificate / Certificate Authority (CA) certificate. It is not
included in GET responses if the *view=COMPACT* query parameter is
specified.

--subnet-id [text]

The OCID of the target subnet of the dedicated connection.

--username [text]

The username Oracle GoldenGate uses to connect to the DB2 database.
This username must already exist and be available by the DB2 to be
connected to.

--vault-id [text]

Refers to the customer’s vault OCID. If provided, it references a
vault where GoldenGate can manage secrets. Customers must add policies
to permit GoldenGate to manage secrets contained within this vault.

--wait-for-state [text]

This operation asynchronously creates, modifies or deletes a resource
and uses a work request to track the progress of the operation.
Specify this option to perform the action and then wait until the work
request reaches a certain state. Multiple states can be specified,
returning on the first state. For example, "--wait-for-state"
SUCCEEDED "--wait-for-state" FAILED would return on whichever
lifecycle state is reached first. If timeout is reached, a return code
of 2 is returned. For any other error, a return code of 1 is returned.

Accepted values are:

   ACCEPTED, CANCELED, FAILED, IN_PROGRESS, SUCCEEDED

--wait-interval-seconds [integer]

Check every "--wait-interval-seconds" to see whether the work request
has reached the state defined by "--wait-for-state". Defaults to 30
seconds.


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
defaults-file", "--endpoint", "--generate-full-command-json-input", "
--generate-param-json-input", "--help", "--latest-version", "--max-
retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
"--output", "--profile", "--proxy", "--query", "--raw-output", "--
read-timeout", "--realm-specific-endpoint", "--region", "--release-
info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"


Example using required parameter
================================

Copy the following CLI commands into a file named example.sh. Run the
command by typing “bash example.sh” and replacing the example
parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-
like shell. You need to set up the OCI configuration and appropriate
security policies before trying the examples.

       export connection_id=<substitute-value-of-connection_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/goldengate/connection/update-db2-connection.html#cmdoption-connection-id

       oci goldengate connection update-db2-connection --connection-id $connection_id
