update-certificate-by-importing-config-details

Description

Updates the properties of a certificate.

Usage

oci certs-mgmt certificate update-certificate-by-importing-config-details [OPTIONS]

Required Parameters

--cert-chain-pem [text]

The certificate chain (in PEM format) for the imported certificate.

--certificate-id [text]

The OCID of the certificate.

--certificate-pem [text]

The certificate (in PEM format) for the imported certificate.

--private-key-pem [text]

The private key (in PEM format) for the imported certificate.

Optional Parameters

--certificate-rules [complex type]

An optional list of rules that control how the certificate is used and managed.

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

--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: {“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 brief description of the certificate. Avoid entering confidential information.

--force

Perform update without prompting for confirmation.

--freeform-tags [complex type]

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 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/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 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 resource to reach the lifecycle state defined by --wait-for-state. Defaults to 1200 seconds.

--private-key-pem-passphrase [text]

An optional passphrase for the private key.

--stage [text]

The rotation state of the certificate. The default is CURRENT, meaning that the certificate is currently in use. A certificate version that you mark as PENDING is staged and available for use, but you don’t yet want to rotate it into current, active use. For example, you might update a certificate and mark its rotation state as PENDING if you haven’t yet updated the certificate on the target system.

Accepted values are:

CURRENT, PENDING
--version-name [text]

A name for the certificate version. When the value is not null, a name is unique across versions of a given certificate.

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

ACTIVE, CANCELLING_DELETION, CREATING, DELETED, DELETING, FAILED, PENDING_DELETION, SCHEDULING_DELETION, UPDATING
--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 cert_chain_pem=<substitute-value-of-cert_chain_pem> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/certs-mgmt/certificate/update-certificate-by-importing-config-details.html#cmdoption-cert-chain-pem
    export certificate_id=<substitute-value-of-certificate_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/certs-mgmt/certificate/update-certificate-by-importing-config-details.html#cmdoption-certificate-id
    export certificate_pem=<substitute-value-of-certificate_pem> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/certs-mgmt/certificate/update-certificate-by-importing-config-details.html#cmdoption-certificate-pem
    export private_key_pem=<substitute-value-of-private_key_pem> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/certs-mgmt/certificate/update-certificate-by-importing-config-details.html#cmdoption-private-key-pem

    oci certs-mgmt certificate update-certificate-by-importing-config-details --cert-chain-pem $cert_chain_pem --certificate-id $certificate_id --certificate-pem $certificate_pem --private-key-pem $private_key_pem