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}/update.txt

@@ -17,28 +17,33 @@
 Description
 ===========
 
-Updates the VirtualService.
+Updates a KafkaCluster.
 
 
 Usage
 =====
 
-   oci service-mesh virtual-service update [OPTIONS]
+   oci kafka cluster update [OPTIONS]
 
 
 Required Parameters
 ===================
 
---virtual-service-id [text]
+--kafka-cluster-id [text]
 
-Unique VirtualService identifier.
+The OCID of the KafkaCluster.
 
 
 Optional Parameters
 ===================
 
---default-routing-policy [complex type]
+--access-subnets [complex type]
 
+Subnets where broker/coordinator VNICs will be created.
+
+This option is a JSON list with items of type SubnetSet.  For
+documentation on SubnetSet please see our API reference: https://docs
+.cloud.oracle.com/api/#/en/kafkacluster/20240901/datatypes/SubnetSet.
 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.
@@ -48,27 +53,56 @@ 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]
+--broker-shape [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.
+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]
+--client-certificate-bundle [text]
+
+CA certificate bundle for mTLS broker authentication.
+
+--cluster-config-id [text]
 
-Description of the resource. It can be changed after creation. Avoid
-entering confidential information.
+The OCID of Kafka Cluster configuration object
+
+--cluster-config-version [integer]
+
+The version of configuration object
+
+--coordination-type [text]
+
+Kafka coordination type. Set of available types depends on Kafka
+version
+
+--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:
 
-   This is my new resource
+   {"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
+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.
+
+--display-name [text]
+
+A user-friendly name. Does not have to be unique, and it’s changeable.
+Avoid entering confidential information.
 
 --force
 
@@ -76,11 +110,17 @@ Perform update without prompting for confirmation.
 
 --freeform-tags [complex type]
 
-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.
+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:
+
+   {"Department": "Finance"}
+
+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
@@ -109,21 +149,6 @@ 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.
-
 --if-match [text]
 
 For optimistic concurrency control. In the PUT or DELETE call for a
@@ -137,17 +162,6 @@ current etag value.
 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
@@ -188,11 +202,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 service-mesh mesh create --generate-param-json-input certificate-authorities > certificate-authorities.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.
@@ -201,11 +210,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/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
-
-       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)
-
-       virtual_service_id=$(oci service-mesh virtual-service create --compartment-id $compartment_id --mesh-id $mesh_id --name $name --query data.id --raw-output)
+       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/update.html#cmdoption-kafka-cluster-id
 
-       oci service-mesh virtual-service update --virtual-service-id $virtual_service_id
+       oci kafka cluster update --kafka-cluster-id $kafka_cluster_id

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

@@ -17,14 +17,15 @@
 Description
 ===========
 
-Moves a Project resource from one compartment to another. When
-provided, If-Match is checked against ETag values of the resource.
+Moves a KafkaClusterConfig into a different compartment within the
+same tenancy. For information about moving resources between
+compartments, see Moving Resources to a Different Compartment.
 
 
 Usage
 =====
 
-   oci anomaly-detection project change-compartment [OPTIONS]
+   oci kafka cluster-config change-compartment [OPTIONS]
 
 
 Required Parameters
@@ -32,11 +33,11 @@ Required Parameters
 
 --compartment-id, -c [text]
 
-The OCID of the compartment into which the resource should be moved.
+The OCID of the compartment to move the KafkaClusterConfig to.
 
---project-id [text]
+--kafka-cluster-config-id [text]
 
-The OCID of the Project.
+The OCID of the KafkaClusterConfig.
 
 
 Optional Parameters
@@ -99,8 +100,7 @@ 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 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/change-compartment.html#cmdoption-compartment-id
+       export kafka_cluster_config_id=<substitute-value-of-kafka_cluster_config_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/cluster-config/change-compartment.html#cmdoption-kafka-cluster-config-id
 
-       project_id=$(oci anomaly-detection project create --compartment-id $compartment_id --query data.id --raw-output)
-
-       oci anomaly-detection project change-compartment --compartment-id $compartment_id --project-id $project_id
+       oci kafka cluster-config change-compartment --compartment-id $compartment_id --kafka-cluster-config-id $kafka_cluster_config_id

oci_cli/help_text_producer/data_files/text/cmdref/{anomaly-detection/data-asset → kafka/cluster-config}/create.txt

@@ -17,13 +17,13 @@
 Description
 ===========
 
-Creates a new DataAsset.
+Creates a KafkaClusterConfig.
 
 
 Usage
 =====
 
-   oci anomaly-detection data-asset create [OPTIONS]
+   oci kafka cluster-config create [OPTIONS]
 
 
 Required Parameters
@@ -31,9 +31,9 @@ Required Parameters
 
 --compartment-id, -c [text]
 
-The OCID for the data asset’s compartment.
+The OCID of the compartment to create the KafkaClusterConfig in.
 
---data-source-details [complex type]
+--latest-config [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
@@ -44,10 +44,6 @@ 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.
 
---project-id [text]
-
-The OCID of the project to associate with the data asset.
-
 
 Optional Parameters
 ===================
@@ -55,32 +51,39 @@ Optional Parameters
 --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.
+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
+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]
-
-A short description of the Ai data asset
-
 --display-name [text]
 
-A user-friendly display name for the resource. It does not have to be
-unique and can be modified. Avoid entering confidential information.
+A user-friendly name. Does not have to be unique, and it’s changeable.
+Avoid entering confidential information.
 
 --freeform-tags [complex type]
 
-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.
+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:
+
+   {"Department": "Finance"}
+
+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
@@ -114,10 +117,6 @@ nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
 The maximum time to wait for the resource to reach the lifecycle state
 defined by "--wait-for-state". Defaults to 1200 seconds.
 
---private-endpoint-id [text]
-
-OCID of Private Endpoint.
-
 --wait-for-state [text]
 
 This operation creates, modifies or deletes a resource that has a
@@ -131,7 +130,7 @@ is returned.
 
 Accepted values are:
 
-   ACTIVE, DELETED
+   ACTIVE, CREATING, DELETED, UPDATING
 
 --wait-interval-seconds [integer]
 
@@ -161,7 +160,7 @@ Example using required parameter
 Copy and paste the following example into a JSON file, replacing the
 example parameters with your own.
 
-       oci anomaly-detection data-asset create --generate-param-json-input data-source-details > data-source-details.json
+       oci kafka cluster-config create --generate-param-json-input latest-config > latest-config.json
 
 Copy the following CLI commands into a file named example.sh. Run the
 command by typing “bash example.sh” and replacing the example
@@ -171,8 +170,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
-
-       project_id=$(oci anomaly-detection project create --compartment-id $compartment_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-config/create.html#cmdoption-compartment-id
 
-       oci anomaly-detection data-asset create --compartment-id $compartment_id --data-source-details file://data-source-details.json --project-id $project_id
+       oci kafka cluster-config create --compartment-id $compartment_id --latest-config file://latest-config.json

oci_cli/help_text_producer/data_files/text/cmdref/{os-management/managed-instance-group → kafka/cluster-config}/delete.txt

@@ -17,21 +17,21 @@
 Description
 ===========
 
-Deletes a Managed Instance Group from the management system
+Deletes a KafkaClusterConfig.
 
 
 Usage
 =====
 
-   oci os-management managed-instance-group delete [OPTIONS]
+   oci kafka cluster-config delete [OPTIONS]
 
 
 Required Parameters
 ===================
 
---managed-instance-group-id [text]
+--kafka-cluster-config-id [text]
 
-OCID for the managed instance group
+The OCID of the KafkaClusterConfig.
 
 
 Optional Parameters
@@ -89,7 +89,7 @@ is returned.
 
 Accepted values are:
 
-   ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
+   ACTIVE, CREATING, DELETED, UPDATING
 
 --wait-interval-seconds [integer]
 
@@ -124,9 +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/os-management/managed-instance-group/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/os-management/managed-instance-group/create.html#cmdoption-display-name
+       export kafka_cluster_config_id=<substitute-value-of-kafka_cluster_config_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/cluster-config/delete.html#cmdoption-kafka-cluster-config-id
 
-       managed_instance_group_id=$(oci os-management managed-instance-group create --compartment-id $compartment_id --display-name $display_name --query data.id --raw-output)
-
-       oci os-management managed-instance-group delete --managed-instance-group-id $managed_instance_group_id
+       oci kafka cluster-config delete --kafka-cluster-config-id $kafka_cluster_config_id

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

@@ -17,21 +17,21 @@
 Description
 ===========
 
-Returns a Windows Update object.
+Gets information about a KafkaClusterConfig.
 
 
 Usage
 =====
 
-   oci os-management windows-update get [OPTIONS]
+   oci kafka cluster-config get [OPTIONS]
 
 
 Required Parameters
 ===================
 
---windows-update [text]
+--kafka-cluster-config-id [text]
 
-The Windows Update
+The OCID of the KafkaClusterConfig.
 
 
 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 windows_update=<substitute-value-of-windows_update> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/os-management/windows-update/get.html#cmdoption-windows-update
+       export kafka_cluster_config_id=<substitute-value-of-kafka_cluster_config_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/cluster-config/get.html#cmdoption-kafka-cluster-config-id
 
-       oci os-management windows-update get --windows-update $windows_update
+       oci kafka cluster-config get --kafka-cluster-config-id $kafka_cluster_config_id

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

@@ -5,8 +5,6 @@
 
 * Usage
 
-* Required Parameters
-
 * Optional Parameters
 
 * Global Parameters
@@ -17,21 +15,13 @@
 Description
 ===========
 
-Returns a list of Mesh objects.
+Gets a list of KafkaClusterConfigs.
 
 
 Usage
 =====
 
-   oci service-mesh mesh list [OPTIONS]
-
-
-Required Parameters
-===================
-
---compartment-id, -c [text]
-
-The ID of the compartment in which to list resources.
+   oci kafka cluster-config list [OPTIONS]
 
 
 Optional Parameters
@@ -42,10 +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]
 
-A filter to return only resources that match the entire displayName
-given.
+A filter to return only resources that match the given display name
+exactly.
 
 --from-json [text]
 
@@ -71,26 +65,28 @@ nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
 
 --id [text]
 
-Unique Mesh identifier.
+The OCID of the KafkaClusterConfig.
 
 --lifecycle-state [text]
 
-A filter to return only resources that match the life cycle state
-given.
+A filter to return only resources that match the given lifecycle
+state. The state value is case-insensitive.
 
 Accepted values are:
 
-   ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
+   ACTIVE, CREATING, DELETED, UPDATING
 
 --limit [integer]
 
-The maximum number of items to return.
+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.
 
 --page [text]
 
-A token representing the position at which to start retrieving
-results. This must come from the *opc-next-page* header field of a
-previous response.
+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.
 
 --page-size [integer]
 
@@ -99,17 +95,18 @@ valid when used with "--all" or "--limit", and ignored otherwise.
 
 --sort-by [text]
 
-The field to sort by. Only one sort order may be provided. Default
-order for timeCreated is descending. Default order for displayName is
-ascending.
+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, id, timeCreated
+   displayName, timeCreated
 
 --sort-order [text]
 
-The sort order to use, either ‘ASC’ or ‘DESC’.
+The sort order to use, either ascending (*ASC*) or descending
+(*DESC*).
 
 Accepted values are:
 
@@ -142,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/service-mesh/mesh/list.html#cmdoption-compartment-id
-
-       oci service-mesh mesh list --compartment-id $compartment_id
+       oci kafka cluster-config list