Updates the Metric Extension


oci stack-monitoring metric-extension update-jmx-metric-ext [OPTIONS]

Required Parameters

--metric-ext-id [text]

The OCID of the metric extension resource.

Optional Parameters

--auto-row-prefix [text]

Prefix for an auto generated metric, in case multiple rows with non unique key values are returned

--collection-schedule [text]

Schedule of metric extension should use RFC 5545 format -> recur-rule-part = “FREQ”;”INTERVAL” where FREQ rule part identifies the type of recurrence rule. Valid values are “MINUTELY”,”HOURLY”,”DAILY” to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1

--description [text]

Description of the metric extension.

--display-name [text]

Metric Extension resource display name.


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

--identity-metric [text]

Semi-colon separated list of key properties from Managed Bean ObjectName to be used as key metrics

--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.

--is-metric-service-enabled [boolean]

Indicates if Metric Service is enabled on server domain

--jmx-attributes [text]

List of JMX attributes or Metric Service Table columns separated by semi-colon

--managed-bean-query [text]

JMX Managed Bean Query or Metric Service Table name

--max-wait-seconds [integer]

The maximum time to wait for the resource to reach the lifecycle state defined by --wait-for-state. Defaults to 1200 seconds.

--metric-list [complex type]

List of metrics which are part of this metric extension

This option is a JSON list with items of type Metric. For documentation on Metric please see our API reference: https://docs.cloud.oracle.com/api/#/en/stackmonitoring/20210330/datatypes/Metric. 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 creates, modifies or deletes a resource that has a defined lifecycle state. Specify this option to perform the action and then wait until the resource reaches a given lifecycle 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:

--wait-interval-seconds [integer]

Check every --wait-interval-seconds to see whether the resource has reached the lifecycle state defined by --wait-for-state. Defaults to 30 seconds.

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 metric_ext_id=<substitute-value-of-metric_ext_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/stack-monitoring/metric-extension/update-jmx-metric-ext.html#cmdoption-metric-ext-id

    oci stack-monitoring metric-extension update-jmx-metric-ext --metric-ext-id $metric_ext_id