change-compartment

Description

Moves a TSIG key into a different compartment.

Usage

oci dns tsig-key change-compartment [OPTIONS]

Required Parameters

--compartment-id, -c [text]

The OCID of the compartment into which the TSIG key should be moved.

--tsig-key-id [text]

The OCID of the target TSIG key.

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.

--scope [text]

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

Accepted values are:

GLOBAL, PRIVATE

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 algorithm=<substitute-value-of-algorithm> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dns/tsig-key/create.html#cmdoption-algorithm
    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/tsig-key/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/tsig-key/create.html#cmdoption-name
    export secret=<substitute-value-of-secret> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dns/tsig-key/create.html#cmdoption-secret

    tsig_key_id=$(oci dns tsig-key create --algorithm $algorithm --compartment-id $compartment_id --name $name --secret $secret --query data.id --raw-output)

    oci dns tsig-key change-compartment --compartment-id $compartment_id --tsig-key-id $tsig_key_id