promote-zone-dnssec-key-version

Description

Promotes a specified DnssecKeyVersion on the zone.

If the DnssecKeyVersion identified in the request body is a key signing key (KSK) that is replacing another DnssecKeyVersion, then the old DnssecKeyVersion is scheduled for removal from the zone.

For key signing keys (KSKs), you must create the DS record with the new key information before promoting the new key to establish a chain of trust. To avoid a service disruption, remove the old DS record as soon as its TTL (time to live) expires.

For more information, see DNSSEC.

Usage

oci dns zone promote-zone-dnssec-key-version [OPTIONS]

Required Parameters

--dnssec-key-version-uuid [text]

The UUID of the DnssecKeyVersion that is being promoted.

--zone-id [text]

The OCID of the target zone.

Optional Parameters

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

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.

--if-unmodified-since [text]

The If-Unmodified-Since header field makes the request method conditional on the selected representation’s last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.

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

--scope [text]

Specifies to operate only on resources that have a matching DNS scope.

Accepted values are:

GLOBAL, PRIVATE
--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, FAILED, IN_PROGRESS, SUCCEEDED
--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.

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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dns/zone/create.html#cmdoption-compartment-id
    export name=<substitute-value-of-name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dns/zone/create.html#cmdoption-name
    export zone_type=<substitute-value-of-zone_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dns/zone/create.html#cmdoption-zone-type
    export dnssec_key_version_uuid=<substitute-value-of-dnssec_key_version_uuid> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dns/zone/promote-zone-dnssec-key-version.html#cmdoption-dnssec-key-version-uuid

    zone_id=$(oci dns zone create --compartment-id $compartment_id --name $name --zone-type $zone_type --query data.id --raw-output)

    oci dns zone promote-zone-dnssec-key-version --dnssec-key-version-uuid $dnssec_key_version_uuid --zone-id $zone_id