oci-cli 3.67.0__py3-none-any.whl → 3.68.1__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/connection/change-subscription.txt

@@ -0,0 +1,134 @@
+"change-subscription"
+*********************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Associate a GoldanGate connection with a different subscription.
+
+
+Usage
+=====
+
+   oci goldengate connection change-subscription [OPTIONS]
+
+
+Required Parameters
+===================
+
+--connection-id [text]
+
+The OCID of a Connection.
+
+
+Optional Parameters
+===================
+
+--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
+
+--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-default [boolean]
+
+Indicates if the subscription is UCM or not.
+
+--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.
+
+--subscription-id [text]
+
+The OCID of the subscription with which resource needs to be
+associated with.
+
+--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/change-subscription.html#cmdoption-connection-id
+
+       oci goldengate connection change-subscription --connection-id $connection_id

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/connection/create-amazon-kinesis-connection.txt

@@ -49,6 +49,14 @@ The Amazon Kinesis technology type.
 Optional Parameters
 ===================
 
+--cluster-placement-group-id [text]
+
+The OCID(/Content/General/Concepts/identifiers.htm) of the cluster
+placement group for the resource. Only applicable for multicloud
+subscriptions. The cluster placement group id must be provided when a
+multicloud subscription id is provided. Otherwise the cluster
+placement group must not be provided.
+
 --connection-endpoint [text]
 
 Optional Amazon Kinesis service endpoint. Default value:
@@ -191,10 +199,33 @@ will be removed after February 15 2026.
 The OCID of the Secret where the secret access key is stored. Note:
 When provided, ‘secretAccessKey’ field must not be provided.
 
+--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.
+
 --subnet-id [text]
 
 The OCID of the target subnet of the dedicated connection.
 
+--subscription-id [text]
+
+The OCID of the subscription with which resource needs to be
+associated with.
+
 --vault-id [text]
 
 Refers to the customer’s vault OCID. If provided, it references a

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/connection/create-amazon-redshift-connection.txt

@@ -57,6 +57,14 @@ conform to the case sensitivty requirments defined in it.
 Optional Parameters
 ===================
 
+--cluster-placement-group-id [text]
+
+The OCID(/Content/General/Concepts/identifiers.htm) of the cluster
+placement group for the resource. Only applicable for multicloud
+subscriptions. The cluster placement group id must be provided when a
+multicloud subscription id is provided. Otherwise the cluster
+placement group must not be provided.
+
 --defined-tags [complex type]
 
 Tags defined for this resource. Each key is predefined and scoped to a
@@ -196,10 +204,33 @@ 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.
+
 --subnet-id [text]
 
 The OCID of the target subnet of the dedicated connection.
 
+--subscription-id [text]
+
+The OCID of the subscription with which resource needs to be
+associated with.
+
 --vault-id [text]
 
 Refers to the customer’s vault OCID. If provided, it references a

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/connection/create-amazon-s3-connection.txt

@@ -50,6 +50,14 @@ The Amazon S3 technology type.
 Optional Parameters
 ===================
 
+--cluster-placement-group-id [text]
+
+The OCID(/Content/General/Concepts/identifiers.htm) of the cluster
+placement group for the resource. Only applicable for multicloud
+subscriptions. The cluster placement group id must be provided when a
+multicloud subscription id is provided. Otherwise the cluster
+placement group must not be provided.
+
 --connection-endpoint [text]
 
 Optional Amazon S3 service endpoint. Default value: https://my-
@@ -194,10 +202,33 @@ the-secret” Deprecated: This field is deprecated and replaced by
 The OCID of the Secret where the Secret Access Key is stored. Note:
 When provided, ‘secretAccessKey’ field must not be provided.
 
+--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.
+
 --subnet-id [text]
 
 The OCID of the target subnet of the dedicated connection.
 
+--subscription-id [text]
+
+The OCID of the subscription with which resource needs to be
+associated with.
+
 --vault-id [text]
 
 Refers to the customer’s vault OCID. If provided, it references a

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/connection/create-azure-data-lake-storage-connection.txt

@@ -102,6 +102,14 @@ removed after February 15 2026.
 The OCID of the Secret where the client secret is stored. Note: When
 provided, ‘clientSecret’ field must not be provided.
 
+--cluster-placement-group-id [text]
+
+The OCID(/Content/General/Concepts/identifiers.htm) of the cluster
+placement group for the resource. Only applicable for multicloud
+subscriptions. The cluster placement group id must be provided when a
+multicloud subscription id is provided. Otherwise the cluster
+placement group must not be provided.
+
 --connection-endpoint [text]
 
 Azure Storage service endpoint. e.g:
@@ -244,10 +252,33 @@ sZbXwIQ%3D Deprecated: This field is deprecated and replaced by
 The OCID of the Secret where the sas token is stored. Note: When
 provided, ‘sasToken’ field must not be provided.
 
+--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.
+
 --subnet-id [text]
 
 The OCID of the target subnet of the dedicated connection.
 
+--subscription-id [text]
+
+The OCID of the subscription with which resource needs to be
+associated with.
+
 --vault-id [text]
 
 Refers to the customer’s vault OCID. If provided, it references a

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/connection/create-azure-synapse-connection.txt

@@ -59,6 +59,14 @@ conform to the case sensitivty requirments defined in it.
 Optional Parameters
 ===================
 
+--cluster-placement-group-id [text]
+
+The OCID(/Content/General/Concepts/identifiers.htm) of the cluster
+placement group for the resource. Only applicable for multicloud
+subscriptions. The cluster placement group id must be provided when a
+multicloud subscription id is provided. Otherwise the cluster
+placement group must not be provided.
+
 --defined-tags [complex type]
 
 Tags defined for this resource. Each key is predefined and scoped to a
@@ -198,10 +206,33 @@ 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.
+
 --subnet-id [text]
 
 The OCID of the target subnet of the dedicated connection.
 
+--subscription-id [text]
+
+The OCID of the subscription with which resource needs to be
+associated with.
+
 --vault-id [text]
 
 Refers to the customer’s vault OCID. If provided, it references a

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/connection/create-databricks-connection.txt

@@ -72,6 +72,14 @@ The OCID of the Secret where the client secret is stored. Only
 applicable for authenticationType == OAUTH_M2M. Note: When provided,
 ‘clientSecret’ field must not be provided.
 
+--cluster-placement-group-id [text]
+
+The OCID(/Content/General/Concepts/identifiers.htm) of the cluster
+placement group for the resource. Only applicable for multicloud
+subscriptions. The cluster placement group id must be provided when a
+multicloud subscription id is provided. Otherwise the cluster
+placement group must not be provided.
+
 --defined-tags [complex type]
 
 Tags defined for this resource. Each key is predefined and scoped to a
@@ -206,6 +214,24 @@ 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.
+
 --storage-credential-name [text]
 
 Optional. External storage credential name to access files on object
@@ -215,6 +241,11 @@ storage such as ADLS Gen2, S3 or GCS.
 
 The OCID of the target subnet of the dedicated connection.
 
+--subscription-id [text]
+
+The OCID of the subscription with which resource needs to be
+associated with.
+
 --vault-id [text]
 
 Refers to the customer’s vault OCID. If provided, it references a

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/connection/create-db2-connection.txt

@@ -84,6 +84,14 @@ 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.
 
+--cluster-placement-group-id [text]
+
+The OCID(/Content/General/Concepts/identifiers.htm) of the cluster
+placement group for the resource. Only applicable for multicloud
+subscriptions. The cluster placement group id must be provided when a
+multicloud subscription id is provided. Otherwise the cluster
+placement group must not be provided.
+
 --defined-tags [complex type]
 
 Tags defined for this resource. Each key is predefined and scoped to a
@@ -218,6 +226,24 @@ 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.
+
 --ssl-client-keystash [text]
 
 The base64 encoded keystash file which contains the encrypted password
@@ -267,6 +293,11 @@ specified.
 
 The OCID of the target subnet of the dedicated connection.
 
+--subscription-id [text]
+
+The OCID of the subscription with which resource needs to be
+associated with.
+
 --vault-id [text]
 
 Refers to the customer’s vault OCID. If provided, it references a

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/connection/create-elasticsearch-connection.txt

@@ -61,6 +61,14 @@ The Elasticsearch technology type.
 Optional Parameters
 ===================
 
+--cluster-placement-group-id [text]
+
+The OCID(/Content/General/Concepts/identifiers.htm) of the cluster
+placement group for the resource. Only applicable for multicloud
+subscriptions. The cluster placement group id must be provided when a
+multicloud subscription id is provided. Otherwise the cluster
+placement group must not be provided.
+
 --defined-tags [complex type]
 
 Tags defined for this resource. Each key is predefined and scoped to a
@@ -205,10 +213,33 @@ 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.
+
 --subnet-id [text]
 
 The OCID of the target subnet of the dedicated connection.
 
+--subscription-id [text]
+
+The OCID of the subscription with which resource needs to be
+associated with.
+
 --username [text]
 
 The username Oracle GoldenGate uses to connect the associated system

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/connection/create-generic-connection.txt

@@ -52,6 +52,14 @@ The Generic technology type.
 Optional Parameters
 ===================
 
+--cluster-placement-group-id [text]
+
+The OCID(/Content/General/Concepts/identifiers.htm) of the cluster
+placement group for the resource. Only applicable for multicloud
+subscriptions. The cluster placement group id must be provided when a
+multicloud subscription id is provided. Otherwise the cluster
+placement group must not be provided.
+
 --defined-tags [complex type]
 
 Tags defined for this resource. Each key is predefined and scoped to a
@@ -174,10 +182,33 @@ 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.
+
 --subnet-id [text]
 
 The OCID of the target subnet of the dedicated connection.
 
+--subscription-id [text]
+
+The OCID of the subscription with which resource needs to be
+associated with.
+
 --vault-id [text]
 
 Refers to the customer’s vault OCID. If provided, it references a

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/connection/create-goldengate-connection.txt

@@ -45,6 +45,14 @@ The GoldenGate technology type.
 Optional Parameters
 ===================
 
+--cluster-placement-group-id [text]
+
+The OCID(/Content/General/Concepts/identifiers.htm) of the cluster
+placement group for the resource. Only applicable for multicloud
+subscriptions. The cluster placement group id must be provided when a
+multicloud subscription id is provided. Otherwise the cluster
+placement group must not be provided.
+
 --defined-tags [complex type]
 
 Tags defined for this resource. Each key is predefined and scoped to a
@@ -205,10 +213,33 @@ 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.
+
 --subnet-id [text]
 
 The OCID of the target subnet of the dedicated connection.
 
+--subscription-id [text]
+
+The OCID of the subscription with which resource needs to be
+associated with.
+
 --username [text]
 
 The username credential existing in the Oracle GoldenGate used to be

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/connection/create-google-big-query-connection.txt

@@ -45,6 +45,14 @@ The Google BigQuery technology type.
 Optional Parameters
 ===================
 
+--cluster-placement-group-id [text]
+
+The OCID(/Content/General/Concepts/identifiers.htm) of the cluster
+placement group for the resource. Only applicable for multicloud
+subscriptions. The cluster placement group id must be provided when a
+multicloud subscription id is provided. Otherwise the cluster
+placement group must not be provided.
+
 --defined-tags [complex type]
 
 Tags defined for this resource. Each key is predefined and scoped to a
@@ -167,6 +175,24 @@ 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.
+
 --service-account-key-file [text]
 
 The base64 encoded content of the service account key file containing
@@ -185,6 +211,11 @@ be provided.
 
 The OCID of the target subnet of the dedicated connection.
 
+--subscription-id [text]
+
+The OCID of the subscription with which resource needs to be
+associated with.
+
 --vault-id [text]
 
 Refers to the customer’s vault OCID. If provided, it references a