oci-cli 3.64.1__py3-none-any.whl → 3.65.1__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/{service-mesh/virtual-service → kafka/cluster}/create.txt

@@ -17,41 +17,84 @@
 Description
 ===========
 
-Creates a new VirtualService.
+Creates a KafkaCluster.
 
 
 Usage
 =====
 
-   oci service-mesh virtual-service create [OPTIONS]
+   oci kafka cluster create [OPTIONS]
 
 
 Required Parameters
 ===================
 
---compartment-id, -c [text]
+--access-subnets [complex type]
 
-The OCID of the compartment.
+Subnets where broker/coordinator VNICs will be created. 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.
 
---mesh-id [text]
+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.
 
-The OCID of the service mesh in which this virtual service is created.
+--broker-shape [complex type]
 
---name [text]
+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.
 
-A user-friendly name. The name has to be unique within the same
-service mesh and cannot be changed after creation. Avoid entering
-confidential information.
+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.
 
-Example:
+--cluster-config-id [text]
 
-   My unique resource name
+The OCID of Kafka Cluster configuration object
+
+--cluster-config-version [integer]
+
+The version of configuration object
+
+--cluster-type [text]
+
+Type of the cluster to spin up. DEVELOPMENT - setting that allows to
+sacrifice HA and spin up cluster on single node PRODUCTION - Minimum
+allowed broker count is 3
+
+--compartment-id, -c [text]
+
+The OCID of the compartment to create the KafkaCluster in.
+
+--coordination-type [text]
+
+Kafka coordination type. Set of available types depends on Kafka
+version
+
+--kafka-version [text]
+
+Version of Kafka to use to spin up the cluster
 
 
 Optional Parameters
 ===================
 
---default-routing-policy [complex type]
+--client-certificate-bundle [text]
+
+CA certificate bundle for mTLS broker authentication.
+
+--defined-tags [complex type]
+
+Defined tags for this resource. Each key is predefined and scoped to a
+namespace. For more information, see Resource Tags.
+
+Example:
+
+   {"Operations": {"CostCenter": "42"}}
 
 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
@@ -62,35 +105,24 @@ 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.
 
---defined-tags [complex type]
-
-Defined tags 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.
+--display-name [text]
 
-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.
+A user-friendly name. Does not have to be unique, and it’s changeable.
+Avoid entering confidential information.
 
---description [text]
+--freeform-tags [complex type]
 
-Description of the resource. It can be changed after creation. Avoid
-entering confidential information.
+Free-form tags for this resource. Each tag is a simple key-value pair
+with no predefined name, type, or namespace. For more information, see
+Resource Tags.
 
 Example:
 
-   This is my new resource
-
---freeform-tags [complex type]
+   {"Department": "Finance"}
 
-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.
+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
@@ -119,37 +151,11 @@ 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
 
---hosts [complex type]
-
-The DNS hostnames of the virtual service that is used by its callers.
-Wildcard hostnames are supported in the prefix form. Examples of valid
-hostnames are “www.example.com”, “*.example.com”, “*.com”. Can be
-omitted if the virtual service will only have TCP virtual deployments.
-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.
-
 --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.
 
---mtls [complex type]
-
-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.
-
 --wait-for-state [text]
 
 This operation asynchronously creates, modifies or deletes a resource
@@ -193,7 +199,10 @@ Example using required parameter
 Copy and paste the following example into a JSON file, replacing the
 example parameters with your own.
 
-       oci service-mesh mesh create --generate-param-json-input certificate-authorities > certificate-authorities.json
+       oci kafka cluster-config create --generate-param-json-input latest-config > latest-config.json
+
+       oci kafka cluster create --generate-param-json-input access-subnets > access-subnets.json
+       oci kafka cluster create --generate-param-json-input broker-shape > broker-shape.json
 
 Copy the following CLI commands into a file named example.sh. Run the
 command by typing “bash example.sh” and replacing the example
@@ -203,9 +212,12 @@ 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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/service-mesh/mesh/create.html#cmdoption-compartment-id
-       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/service-mesh/mesh/create.html#cmdoption-display-name
+       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/cluster-config/create.html#cmdoption-compartment-id
+       export cluster_config_version=<substitute-value-of-cluster_config_version> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/cluster/create.html#cmdoption-cluster-config-version
+       export cluster_type=<substitute-value-of-cluster_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/cluster/create.html#cmdoption-cluster-type
+       export coordination_type=<substitute-value-of-coordination_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/cluster/create.html#cmdoption-coordination-type
+       export kafka_version=<substitute-value-of-kafka_version> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/cluster/create.html#cmdoption-kafka-version
 
-       mesh_id=$(oci service-mesh mesh create --certificate-authorities file://certificate-authorities.json --compartment-id $compartment_id --display-name $display_name --query data.id --raw-output)
+       cluster_config_id=$(oci kafka cluster-config create --compartment-id $compartment_id --latest-config file://latest-config.json --query data.id --raw-output)
 
-       oci service-mesh virtual-service create --compartment-id $compartment_id --mesh-id $mesh_id --name $name
+       oci kafka cluster create --access-subnets file://access-subnets.json --broker-shape file://broker-shape.json --cluster-config-id $cluster_config_id --cluster-config-version $cluster_config_version --cluster-type $cluster_type --compartment-id $compartment_id --coordination-type $coordination_type --kafka-version $kafka_version

oci_cli/help_text_producer/data_files/text/cmdref/{anomaly-detection/project → kafka/cluster}/delete.txt

@@ -17,24 +17,21 @@
 Description
 ===========
 
-Deletes a Project resource by identifier. This operation fails with a
-409 error unless all associated resources (models deployments or data
-assets) are in a DELETED state. You must delete all associated
-resources before deleting a project.
+Deletes a KafkaCluster.
 
 
 Usage
 =====
 
-   oci anomaly-detection project delete [OPTIONS]
+   oci kafka cluster delete [OPTIONS]
 
 
 Required Parameters
 ===================
 
---project-id [text]
+--kafka-cluster-id [text]
 
-The OCID of the Project.
+The OCID of the KafkaCluster.
 
 
 Optional Parameters
@@ -92,7 +89,7 @@ of 2 is returned. For any other error, a return code of 1 is returned.
 
 Accepted values are:
 
-   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED, WAITING
+   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
 
 --wait-interval-seconds [integer]
 
@@ -127,8 +124,6 @@ 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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/anomaly-detection/project/create.html#cmdoption-compartment-id
+       export kafka_cluster_id=<substitute-value-of-kafka_cluster_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/cluster/delete.html#cmdoption-kafka-cluster-id
 
-       project_id=$(oci anomaly-detection project create --compartment-id $compartment_id --query data.id --raw-output)
-
-       oci anomaly-detection project delete --project-id $project_id
+       oci kafka cluster delete --kafka-cluster-id $kafka_cluster_id

oci_cli/help_text_producer/data_files/text/cmdref/{os-management/managed-instance/install-all-windows-updates.txt → kafka/cluster/disable-superuser.txt}

@@ -1,5 +1,5 @@
-"install-all-windows-updates"
-*****************************
+"disable-superuser"
+*******************
 
 * Description
 
@@ -17,21 +17,21 @@
 Description
 ===========
 
-Install all of the available Windows updates for the managed instance.
+Removes the SASL superuser to the Kafka cluster.
 
 
 Usage
 =====
 
-   oci os-management managed-instance install-all-windows-updates [OPTIONS]
+   oci kafka cluster disable-superuser [OPTIONS]
 
 
 Required Parameters
 ===================
 
---managed-instance-id [text]
+--kafka-cluster-id [text]
 
-OCID for the managed instance
+The OCID of the KafkaCluster.
 
 
 Optional Parameters
@@ -59,19 +59,19 @@ 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 will be
+updated or deleted only if the etag you provide matches the resource’s
+current etag value.
+
 --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.
 
---update-type [text]
-
-The type of updates to be applied
-
-Accepted values are:
-
-   ALL, BUGFIX, ENHANCEMENT, KSPLICE, OTHER, SECURITY
-
 --wait-for-state [text]
 
 This operation asynchronously creates, modifies or deletes a resource
@@ -85,7 +85,7 @@ of 2 is returned. For any other error, a return code of 1 is returned.
 
 Accepted values are:
 
-   ACCEPTED, CANCELED, CANCELLING, FAILED, IN_PROGRESS, SUCCEEDED
+   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
 
 --wait-interval-seconds [integer]
 
@@ -120,6 +120,6 @@ 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 managed_instance_id=<substitute-value-of-managed_instance_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/os-management/managed-instance/install-all-windows-updates.html#cmdoption-managed-instance-id
+       export kafka_cluster_id=<substitute-value-of-kafka_cluster_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/cluster/disable-superuser.html#cmdoption-kafka-cluster-id
 
-       oci os-management managed-instance install-all-windows-updates --managed-instance-id $managed_instance_id
+       oci kafka cluster disable-superuser --kafka-cluster-id $kafka_cluster_id

oci_cli/help_text_producer/data_files/text/cmdref/{anomaly-detection/pe/change-compartment.txt → kafka/cluster/enable-superuser.txt}

@@ -1,5 +1,5 @@
-"change-compartment"
-********************
+"enable-superuser"
+******************
 
 * Description
 
@@ -17,14 +17,14 @@
 Description
 ===========
 
-Moves a resource into a different compartment. When provided, ‘If-
-Match’ is checked against ‘ETag’ values of the resource.
+Adds a SASL superuser to the Kafka cluster. A generated password will
+be updated to the specified vault.
 
 
 Usage
 =====
 
-   oci anomaly-detection pe change-compartment [OPTIONS]
+   oci kafka cluster enable-superuser [OPTIONS]
 
 
 Required Parameters
@@ -32,11 +32,16 @@ Required Parameters
 
 --compartment-id, -c [text]
 
-The identifier of the compartment where the resource should be moved.
+The OCID of the compartment that contains the superuser secret.
 
---pe-id [text]
+--kafka-cluster-id [text]
 
-Unique private reverse connection identifier.
+The OCID of the KafkaCluster.
+
+--secret-id [text]
+
+The OCID of the secret that will be populated with the generated
+superuser password.
 
 
 Optional Parameters
@@ -90,7 +95,7 @@ of 2 is returned. For any other error, a return code of 1 is returned.
 
 Accepted values are:
 
-   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED, WAITING
+   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
 
 --wait-interval-seconds [integer]
 
@@ -117,11 +122,6 @@ info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
 Example using required parameter
 ================================
 
-Copy and paste the following example into a JSON file, replacing the
-example parameters with your own.
-
-       oci anomaly-detection pe create --generate-param-json-input dns-zones > dns-zones.json
-
 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.
@@ -130,9 +130,8 @@ 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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/anomaly-detection/pe/create.html#cmdoption-compartment-id
-       export subnet_id=<substitute-value-of-subnet_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/anomaly-detection/pe/create.html#cmdoption-subnet-id
-
-       pe_id=$(oci anomaly-detection pe create --compartment-id $compartment_id --dns-zones file://dns-zones.json --subnet-id $subnet_id --query data.id --raw-output)
+       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/cluster/enable-superuser.html#cmdoption-compartment-id
+       export kafka_cluster_id=<substitute-value-of-kafka_cluster_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/cluster/enable-superuser.html#cmdoption-kafka-cluster-id
+       export secret_id=<substitute-value-of-secret_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/cluster/enable-superuser.html#cmdoption-secret-id
 
-       oci anomaly-detection pe change-compartment --compartment-id $compartment_id --pe-id $pe_id
+       oci kafka cluster enable-superuser --compartment-id $compartment_id --kafka-cluster-id $kafka_cluster_id --secret-id $secret_id

oci_cli/help_text_producer/data_files/text/cmdref/{os-management/erratum → kafka/cluster}/get.txt

@@ -17,21 +17,21 @@
 Description
 ===========
 
-Returns a specific erratum.
+Gets information about a KafkaCluster.
 
 
 Usage
 =====
 
-   oci os-management erratum get [OPTIONS]
+   oci kafka cluster get [OPTIONS]
 
 
 Required Parameters
 ===================
 
---erratum-id [text]
+--kafka-cluster-id [text]
 
-The OCID of the erratum.
+The OCID of the KafkaCluster.
 
 
 Optional Parameters
@@ -86,6 +86,6 @@ 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 erratum_id=<substitute-value-of-erratum_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/os-management/erratum/get.html#cmdoption-erratum-id
+       export kafka_cluster_id=<substitute-value-of-kafka_cluster_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/cluster/get.html#cmdoption-kafka-cluster-id
 
-       oci os-management erratum get --erratum-id $erratum_id
+       oci kafka cluster get --kafka-cluster-id $kafka_cluster_id

oci_cli/help_text_producer/data_files/text/cmdref/{dts/job → kafka/cluster}/list.txt

@@ -5,8 +5,6 @@
 
 * Usage
 
-* Required Parameters
-
 * Optional Parameters
 
 * Global Parameters
@@ -17,21 +15,13 @@
 Description
 ===========
 
-Lists all transfer disk or appliance jobs.
+Gets a list of KafkaClusters.
 
 
 Usage
 =====
 
-   oci dts job list [OPTIONS]
-
-
-Required Parameters
-===================
-
---compartment-id, -c [text]
-
-compartment id
+   oci kafka cluster list [OPTIONS]
 
 
 Optional Parameters
@@ -42,9 +32,14 @@ Optional Parameters
 Fetches all pages of results. If you provide this option, then you
 cannot provide the "--limit" option.
 
+--compartment-id, -c [text]
+
+The OCID of the compartment in which to list resources.
+
 --display-name [text]
 
-filtering by displayName
+A filter to return only resources that match the given display name
+exactly.
 
 --from-json [text]
 
@@ -68,13 +63,18 @@ 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
 
+--id [text]
+
+The OCID of the KafkaCluster.
+
 --lifecycle-state [text]
 
-filtering by lifecycleState
+A filter to return only resources that match the given lifecycle
+state. The state value is case-insensitive.
 
 Accepted values are:
 
-   ACTIVE, CLOSED, DELETED, INITIATED, PREPARING
+   ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
 
 --limit [integer]
 
@@ -82,13 +82,9 @@ For list pagination. The maximum number of results per page, or items
 to return in a paginated “List” call. For important details about how
 pagination works, see List Pagination.
 
-Example:
-
-   50
-
 --page [text]
 
-For list pagination. The value of the *opc-next-page* response header
+For list pagination. The value of the opc-next-page response header
 from the previous “List” call. For important details about how
 pagination works, see List Pagination.
 
@@ -97,6 +93,25 @@ pagination works, see List Pagination.
 When fetching results, the number of results to fetch per call. Only
 valid when used with "--all" or "--limit", and ignored otherwise.
 
+--sort-by [text]
+
+The field to sort by. You can provide only one sort order. Default
+order for *timeCreated* is descending. Default order for *displayName*
+is ascending.
+
+Accepted values are:
+
+   displayName, timeCreated
+
+--sort-order [text]
+
+The sort order to use, either ascending (*ASC*) or descending
+(*DESC*).
+
+Accepted values are:
+
+   ASC, DESC
+
 
 Global Parameters
 =================
@@ -124,6 +139,4 @@ 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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/list.html#cmdoption-compartment-id
-
-       oci dts job list --compartment-id $compartment_id
+       oci kafka cluster list