``list`` ======== .. contents:: :local: :depth: 1 Description ------------ Gets a list of the maintenance runs in the specified compartment. Usage ----- .. code-block:: none oci db maintenance-run list [OPTIONS] Required Parameters -------------------- .. option:: --compartment-id, -c [text] The compartment `OCID `__. Optional Parameters -------------------- .. option:: --all Fetches all pages of results. If you provide this option, then you cannot provide the ``--limit`` option. .. option:: --availability-domain [text] A filter to return only resources that match the given availability domain exactly. .. option:: --from-json [text] Provide input to this command as a JSON document from a file using the file://path-to/file syntax. The :option:`--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 .. option:: --lifecycle-state [text] A filter to return only resources that match the given lifecycle state exactly. Accepted values are: .. code-block:: py CANCELED, DELETED, DELETING, FAILED, IN_PROGRESS, SCHEDULED, SKIPPED, SUCCEEDED, UPDATING .. option:: --limit [integer] The maximum number of items to return per page. .. option:: --maintenance-subtype [text] The sub-type of the maintenance run. Accepted values are: .. code-block:: py CRITICAL, DATABASE, HARDWARE, INFRASTRUCTURE, ONEOFF, QUARTERLY, SECURITY_MONTHLY, TIMEZONE .. option:: --maintenance-type [text] The maintenance type. Accepted values are: .. code-block:: py PLANNED, UNPLANNED .. option:: --page [text] The pagination token to continue listing from. .. option:: --page-size [integer] When fetching results, the number of results to fetch per call. Only valid when used with ``--all`` or ``--limit``, and ignored otherwise. .. option:: --sort-by [text] The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIME_SCHEDULED and TIME_ENDED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. Accepted values are: .. code-block:: py DISPLAYNAME, TIME_ENDED, TIME_SCHEDULED .. option:: --sort-order [text] The sort order to use, either ascending (`ASC`) or descending (`DESC`). Accepted values are: .. code-block:: py ASC, DESC .. option:: --target-resource-id [text] The target resource ID. .. option:: --target-resource-type [text] The type of the target resource. Accepted values are: .. code-block:: py AUTONOMOUS_CONTAINER_DATABASE, AUTONOMOUS_DATABASE, AUTONOMOUS_EXADATA_INFRASTRUCTURE, AUTONOMOUS_VM_CLUSTER, CLOUD_AUTONOMOUS_VM_CLUSTER, CLOUD_EXADATA_INFRASTRUCTURE, EXACC_INFRASTRUCTURE, EXADATA_DB_SYSTEM Global Parameters ------------------ Use ``oci --help`` for help on global parameters. :option:`--auth-purpose`, :option:`--auth`, :option:`--cert-bundle`, :option:`--cli-auto-prompt`, :option:`--cli-rc-file`, :option:`--config-file`, :option:`--connection-timeout`, :option:`--debug`, :option:`--defaults-file`, :option:`--endpoint`, :option:`--generate-full-command-json-input`, :option:`--generate-param-json-input`, :option:`--help`, :option:`--latest-version`, :option:`--max-retries`, :option:`--no-retry`, :option:`--opc-client-request-id`, :option:`--opc-request-id`, :option:`--output`, :option:`--profile`, :option:`--proxy`, :option:`--query`, :option:`--raw-output`, :option:`--read-timeout`, :option:`--realm-specific-endpoint`, :option:`--region`, :option:`--release-info`, :option:`--request-id`, :option:`--version`, :option:`-?`, :option:`-d`, :option:`-h`, :option:`-i`, :option:`-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. .. code-block:: none :class: copy-code-block export compartment_id= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/maintenance-run/list.html#cmdoption-compartment-id oci db maintenance-run list --compartment-id $compartment_id