oci-cli 3.62.1__py3-none-any.whl → 3.63.0__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/marketplace-publisher/artifact/update-artifact-update-machine-image-artifact-details.txt

@@ -0,0 +1,177 @@
+"update-artifact-update-machine-image-artifact-details"
+*******************************************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Updates the specified artifact identified by the id.
+
+
+Usage
+=====
+
+   oci marketplace-publisher artifact update-artifact-update-machine-image-artifact-details [OPTIONS]
+
+
+Required Parameters
+===================
+
+--artifact-id [text]
+
+artifact OCID
+
+
+Optional Parameters
+===================
+
+--compartment-id, -c [text]
+
+The unique identifier for the compartment.
+
+--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.
+
+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]
+
+The display name for the artifact.
+
+--force
+
+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.
+
+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 will be
+updated or deleted only if the etag you provide matches the resource’s
+current etag value.
+
+--machine-image [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.
+
+--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.
+
+--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, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
+
+--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 artifact_type=<substitute-value-of-artifact_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/artifact/create.html#cmdoption-artifact-type
+       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/artifact/create.html#cmdoption-compartment-id
+
+       artifact_id=$(oci marketplace-publisher artifact create --artifact-type $artifact_type --compartment-id $compartment_id --query data.id --raw-output)
+
+       oci marketplace-publisher artifact update-artifact-update-machine-image-artifact-details --artifact-id $artifact_id

oci_cli/help_text_producer/data_files/text/cmdref/marketplace-publisher/artifact/update-artifact-update-stack-artifact-details.txt

@@ -0,0 +1,177 @@
+"update-artifact-update-stack-artifact-details"
+***********************************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Updates the specified artifact identified by the id.
+
+
+Usage
+=====
+
+   oci marketplace-publisher artifact update-artifact-update-stack-artifact-details [OPTIONS]
+
+
+Required Parameters
+===================
+
+--artifact-id [text]
+
+artifact OCID
+
+
+Optional Parameters
+===================
+
+--compartment-id, -c [text]
+
+The unique identifier for the compartment.
+
+--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.
+
+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]
+
+The display name for the artifact.
+
+--force
+
+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.
+
+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 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.
+
+--stack [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
+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, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
+
+--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 artifact_type=<substitute-value-of-artifact_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/artifact/create.html#cmdoption-artifact-type
+       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/artifact/create.html#cmdoption-compartment-id
+
+       artifact_id=$(oci marketplace-publisher artifact create --artifact-type $artifact_type --compartment-id $compartment_id --query data.id --raw-output)
+
+       oci marketplace-publisher artifact update-artifact-update-stack-artifact-details --artifact-id $artifact_id

oci_cli/help_text_producer/data_files/text/cmdref/marketplace-publisher/artifact/update.txt

@@ -43,7 +43,7 @@ Artifact Type for the artifact.
 
 Accepted values are:
 
-   CONTAINER_IMAGE, HELM_CHART
+   CONTAINER_IMAGE, HELM_CHART, MACHINE_IMAGE, STACK
 
 --compartment-id, -c [text]
 

oci_cli/help_text_producer/data_files/text/cmdref/marketplace-publisher/artifact.txt

@@ -19,6 +19,10 @@ Available Commands
 
 * create-artifact-create-kubernetes-image-artifact-details
 
+* create-artifact-create-machine-image-artifact-details
+
+* create-artifact-create-stack-artifact-details
+
 * delete
 
 * get
@@ -29,4 +33,8 @@ Available Commands
 
 * update-artifact-update-kubernetes-image-artifact-details
 
+* update-artifact-update-machine-image-artifact-details
+
+* update-artifact-update-stack-artifact-details
+
 * validate-and-publish

oci_cli/help_text_producer/data_files/text/cmdref/marketplace-publisher/{offer/offer-collection/list-offers.txt → available-service-collection/list-available-services.txt}

@@ -1,10 +1,12 @@
-"list-offers"
-*************
+"list-available-services"
+*************************
 
 * Description
 
 * Usage
 
+* Required Parameters
+
 * Optional Parameters
 
 * Global Parameters
@@ -15,33 +17,30 @@
 Description
 ===========
 
-Returns a list of Offers. Requires either the BuyerCompartmentId or
-the SellerCompartmentId params. If neither or both are provided, then
-the API will return a 400.
+List all published service listing revisions
 
 
 Usage
 =====
 
-   oci marketplace-publisher offer offer-collection list-offers [OPTIONS]
+   oci marketplace-publisher available-service-collection list-available-services [OPTIONS]
 
 
-Optional Parameters
+Required Parameters
 ===================
 
---all
+--compartment-id, -c [text]
 
-Fetches all pages of results. If you provide this option, then you
-cannot provide the "--limit" option.
+The ID of the compartment in which to list resources.
 
---buyer-compartment-id [text]
 
-The ID of the buyer compartment this offer is associated with.
+Optional Parameters
+===================
 
---display-name [text]
+--all
 
-A filter to return only resources that match the entire display name
-given.
+Fetches all pages of results. If you provide this option, then you
+cannot provide the "--limit" option.
 
 --from-json [text]
 
@@ -65,23 +64,14 @@ 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]
-
-unique Offer identifier
-
---lifecycle-state [text]
-
-A filter to return only resources their lifecycleState matches the
-given lifecycleState.
-
-Accepted values are:
-
-   ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
-
 --limit [integer]
 
 The maximum number of items to return.
 
+--name [text]
+
+A filter to return only resources that match the entire name given.
+
 --page [text]
 
 A token representing the position at which to start retrieving
@@ -93,10 +83,6 @@ previous response.
 When fetching results, the number of results to fetch per call. Only
 valid when used with "--all" or "--limit", and ignored otherwise.
 
---seller-compartment-id [text]
-
-The ID of the seller compartment this offer is associated with.
-
 --sort-by [text]
 
 The field to sort by. Only one sort order may be provided. Default
@@ -142,4 +128,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.
 
-       oci marketplace-publisher offer offer-collection list-offers
+       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/available-service-collection/list-available-services.html#cmdoption-compartment-id
+
+       oci marketplace-publisher available-service-collection list-available-services --compartment-id $compartment_id

oci_cli/help_text_producer/data_files/text/cmdref/marketplace-publisher/available-service-collection.txt

@@ -0,0 +1,15 @@
+available-service-collection
+****************************
+
+
+Description
+===========
+
+Results of available service provider search, returns available
+services
+
+
+Available Commands
+==================
+
+* list-available-services

oci_cli/help_text_producer/data_files/text/cmdref/marketplace-publisher/{attachment/attachment-collection/list-attachments.txt → customer-instance-report-record-collection/list-customer-instance-report-records.txt}

@@ -1,5 +1,5 @@
-"list-attachments"
-******************
+"list-customer-instance-report-records"
+***************************************
 
 * Description
 
@@ -17,23 +17,29 @@
 Description
 ===========
 
-Returns a list of Attachments. Requires either the BuyerCompartmentId
-or the SellerCompartmentId params. If neither or both are provided,
-then the API will return a 400.
+List customer instance report records
 
 
 Usage
 =====
 
-   oci marketplace-publisher attachment attachment-collection list-attachments [OPTIONS]
+   oci marketplace-publisher customer-instance-report-record-collection list-customer-instance-report-records [OPTIONS]
 
 
 Required Parameters
 ===================
 
---offer-id [text]
+--compartment-id, -c [text]
 
-unique Offer identifier
+The ID of the compartment in which to list resources.
+
+--date-range [text]
+
+The date range of the report
+
+Accepted values are:
+
+   LAST_MONTH, LAST_THREE_MONTHS, LAST_WEEK, THIS_MONTH, THIS_WEEK
 
 
 Optional Parameters
@@ -44,15 +50,6 @@ Optional Parameters
 Fetches all pages of results. If you provide this option, then you
 cannot provide the "--limit" option.
 
---buyer-compartment-id [text]
-
-The ID of the buyer compartment this offer is associated with.
-
---display-name [text]
-
-A filter to return only resources that match the entire display name
-given.
-
 --from-json [text]
 
 Provide input to this command as a JSON document from a file using the
@@ -75,23 +72,14 @@ 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]
-
-unique Offer identifier
-
---lifecycle-state [text]
-
-A filter to return only resources their lifecycleState matches the
-given lifecycleState.
-
-Accepted values are:
-
-   ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
-
 --limit [integer]
 
 The maximum number of items to return.
 
+--name [text]
+
+A filter to return only resources that match the entire name given.
+
 --page [text]
 
 A token representing the position at which to start retrieving
@@ -103,10 +91,6 @@ previous response.
 When fetching results, the number of results to fetch per call. Only
 valid when used with "--all" or "--limit", and ignored otherwise.
 
---seller-compartment-id [text]
-
-The ID of the seller compartment this offer is associated with.
-
 --sort-by [text]
 
 The field to sort by. Only one sort order may be provided. Default
@@ -152,9 +136,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 display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/offer/offer/create.html#cmdoption-display-name
-       export seller_compartment_id=<substitute-value-of-seller_compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/offer/offer/create.html#cmdoption-seller-compartment-id
-
-       offer_id=$(oci marketplace-publisher offer offer create --display-name $display_name --seller-compartment-id $seller_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/marketplace-publisher/customer-instance-report-record-collection/list-customer-instance-report-records.html#cmdoption-compartment-id
+       export date_range=<substitute-value-of-date_range> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/customer-instance-report-record-collection/list-customer-instance-report-records.html#cmdoption-date-range
 
-       oci marketplace-publisher attachment attachment-collection list-attachments --offer-id $offer_id
+       oci marketplace-publisher customer-instance-report-record-collection list-customer-instance-report-records --compartment-id $compartment_id --date-range $date_range

oci_cli/help_text_producer/data_files/text/cmdref/marketplace-publisher/customer-instance-report-record-collection.txt

@@ -0,0 +1,14 @@
+customer-instance-report-record-collection
+******************************************
+
+
+Description
+===========
+
+Customer instance report
+
+
+Available Commands
+==================
+
+* list-customer-instance-report-records