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/update-oracle-ai-data-platform-connection.txt

@@ -0,0 +1,287 @@
+"update-oracle-ai-data-platform-connection"
+*******************************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Updates the Connection.
+
+
+Usage
+=====
+
+   oci goldengate connection update-oracle-ai-data-platform-connection [OPTIONS]
+
+
+Required Parameters
+===================
+
+--connection-id [text]
+
+The OCID of a Connection.
+
+
+Optional Parameters
+===================
+
+--connection-region [text]
+
+The name of the region. e.g.: us-ashburn-1
+
+--connection-url [text]
+
+Connection URL. It must start with ‘jdbc:spark://’
+
+--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
+
+--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.
+
+--private-key-file-secret-id [text]
+
+The OCID of the Secret that stores the content of the private key file
+(PEM file) corresponding to the API key of the fingerprint. See
+documentation: https://docs.oracle.com/en-
+us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When
+provided, ‘privateKeyFile’ field must not be provided.
+
+--private-key-passphrase-secret-id [text]
+
+The OCID of the Secret that stores the passphrase of the private key.
+Note: When provided, ‘privateKeyPassphrase’ field must not be
+provided.
+
+--public-key-fingerprint [text]
+
+The fingerprint of the API Key of the user specified by the userId.
+See documentation: https://docs.oracle.com/en-
+us/iaas/Content/Identity/Tasks/managingcredentials.htm
+
+--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.
+
+--should-use-resource-principal [boolean]
+
+Specifies that the user intends to authenticate to the instance using
+a resource principal. Default: false
+
+--subnet-id [text]
+
+The OCID of the target subnet of the dedicated connection.
+
+--tenancy-id [text]
+
+The OCID of the related OCI tenancy.
+
+--user-id [text]
+
+The OCID of the OCI user who will access the Object Storage. The user
+must have write access to the bucket they want to connect to. If the
+user is not provided, backend will default to the user who is calling
+the API endpoint.
+
+--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-oracle-ai-data-platform-connection.html#cmdoption-connection-id
+
+       oci goldengate connection update-oracle-ai-data-platform-connection --connection-id $connection_id

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/connection/update-oracle-connection.txt

@@ -208,6 +208,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.
+
 --session-mode [text]
 
 The mode of the database connection session to be established by the

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/connection/update-oracle-nosql-connection.txt

@@ -201,6 +201,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.
+
 --should-use-resource-principal [boolean]
 
 Specifies that the user intends to authenticate to the instance using

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/connection/update-postgresql-connection.txt

@@ -226,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.
+
 --security-protocol [text]
 
 Security protocol for PostgreSQL.

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/connection/update-redis-connection.txt

@@ -209,6 +209,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.
+
 --security-protocol [text]
 
 Security protocol for Redis.

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/connection/update-snowflake-connection.txt

@@ -211,6 +211,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.
+
 --subnet-id [text]
 
 The OCID of the target subnet of the dedicated connection.

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

@@ -16,6 +16,8 @@ Available Commands
 
 * change-compartment
 
+* change-subscription
+
 * create-amazon-kinesis-connection
 
 * create-amazon-redshift-connection
@@ -62,6 +64,8 @@ Available Commands
 
 * create-object-storage-connection
 
+* create-oracle-ai-data-platform-connection
+
 * create-oracle-connection
 
 * create-oracle-nosql-connection
@@ -128,6 +132,8 @@ Available Commands
 
 * update-object-storage-connection
 
+* update-oracle-ai-data-platform-connection
+
 * update-oracle-connection
 
 * update-oracle-nosql-connection

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/deployment/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 deployment with a different subscription.
+
+
+Usage
+=====
+
+   oci goldengate deployment change-subscription [OPTIONS]
+
+
+Required Parameters
+===================
+
+--deployment-id [text]
+
+A unique Deployment identifier.
+
+
+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 deployment_id=<substitute-value-of-deployment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/goldengate/deployment/change-subscription.html#cmdoption-deployment-id
+
+       oci goldengate deployment change-subscription --deployment-id $deployment_id

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/deployment/create.txt

@@ -84,6 +84,14 @@ License Included and billed.
 
 The SSL certificate for this deployment in PEM format.
 
+--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.
+
 --cpu-core-count [integer]
 
 The Minimum number of OCPUs to be made available for this Deployment.
@@ -317,10 +325,33 @@ via the file:// syntax.
 
 The private key for your certificate in PEM format.
 
+--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.
+
 --source-deployment-id [text]
 
 The OCID of the deployment being referenced.
 
+--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

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/deployment/list.txt

@@ -153,7 +153,7 @@ The connection type which the deployment must support.
 
 Accepted values are:
 
-   AMAZON_KINESIS, AMAZON_REDSHIFT, AMAZON_S3, AZURE_DATA_LAKE_STORAGE, AZURE_SYNAPSE_ANALYTICS, DATABRICKS, DB2, ELASTICSEARCH, GENERIC, GOLDENGATE, GOOGLE_BIGQUERY, GOOGLE_CLOUD_STORAGE, GOOGLE_PUBSUB, HDFS, ICEBERG, JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, MICROSOFT_FABRIC, MICROSOFT_SQLSERVER, MONGODB, MYSQL, OCI_OBJECT_STORAGE, ORACLE, ORACLE_NOSQL, POSTGRESQL, REDIS, SNOWFLAKE
+   AMAZON_KINESIS, AMAZON_REDSHIFT, AMAZON_S3, AZURE_DATA_LAKE_STORAGE, AZURE_SYNAPSE_ANALYTICS, DATABRICKS, DB2, ELASTICSEARCH, GENERIC, GOLDENGATE, GOOGLE_BIGQUERY, GOOGLE_CLOUD_STORAGE, GOOGLE_PUBSUB, HDFS, ICEBERG, JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, MICROSOFT_FABRIC, MICROSOFT_SQLSERVER, MONGODB, MYSQL, OCI_OBJECT_STORAGE, ORACLE, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL, POSTGRESQL, REDIS, SNOWFLAKE
 
 
 Global Parameters

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/deployment/update.txt

@@ -275,6 +275,24 @@ via the file:// syntax.
 
 The private key for your certificate in PEM format.
 
+--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 subnet of the deployment’s private endpoint. The

oci_cli/help_text_producer/data_files/text/cmdref/goldengate/deployment.txt

@@ -18,6 +18,8 @@ Available Commands
 
 * change-compartment
 
+* change-subscription
+
 * collect-diagnostics
 
 * create