update-admin

Description

Update the product

Usage

oci oci-product-catalog product-admin product update-admin [OPTIONS]

Required Parameters

--product-id [text]

OCID of the product

Optional Parameters

--description [text]

description to the product

--force

Perform update without prompting for confirmation.

--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/Content/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-excluded [boolean]

Optional exclusion flag update. When true, marks the product as excluded. When false, clears the exclusion state.

--limits [complex type]

List of limits that this product is associated with.

This option is a JSON list with items of type Limit. For documentation on Limit please see our API reference: https://docs.oracle.com/en-us/iaas/api/#/en/productadmin/20250610/datatypes/Limit. 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.

--meters [complex type]

List of meters associated with this product

This option is a JSON list with items of type Meter. For documentation on Meter please see our API reference: https://docs.oracle.com/en-us/iaas/api/#/en/productadmin/20250610/datatypes/Meter. 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.

--name [text]

Name of the product, defined by service teams. Unique within one service

--service-name [text]

Name of the metering service this product relates to.

--state [text]

The current state of the product. READY - The product is fully configured and ready for activation. ENABLED - The product is active. DISABLED - The product is inactive and not ready for activation. DELETED - The product has been deleted. NEEDS_ATTENTION - Pricing not set.

Accepted values are:

DELETED, DISABLED, ENABLED, NEEDS_ATTENTION, READY

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 product_id=<substitute-value-of-product_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/oci-product-catalog/product-admin/product/update-admin.html#cmdoption-product-id

    oci oci-product-catalog product-admin product update-admin --product-id $product_id