replace-node

Description

Replaces a node of a Big Data Service cluster from backup.

Usage

oci bds instance replace-node [OPTIONS]

Required Parameters

--bds-instance-id [text]

The OCID of the cluster.

--cluster-admin-password [text]

Base-64 encoded password for the cluster admin user.

--node-backup-id [text]

The id of the nodeBackup to use for replacing the node.

--node-host-name [text]

Host name of the node to replace. MASTER, UTILITY and EDGE node are only supported types

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]

This if-match is for the BdsInstance. 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 work request to reach the state defined by --wait-for-state. Defaults to 1200 seconds.

--shape [text]

Shape of the new vm when replacing the node. If not provided, BDS will attempt to replace the node with the shape of current node.

--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, CANCELED, CANCELING, 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 bds_instance_id=<substitute-value-of-bds_instance_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/bds/instance/replace-node.html#cmdoption-bds-instance-id
    export cluster_admin_password=<substitute-value-of-cluster_admin_password> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/bds/instance/replace-node.html#cmdoption-cluster-admin-password
    export node_backup_id=<substitute-value-of-node_backup_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/bds/instance/replace-node.html#cmdoption-node-backup-id
    export node_host_name=<substitute-value-of-node_host_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/bds/instance/replace-node.html#cmdoption-node-host-name

    oci bds instance replace-node --bds-instance-id $bds_instance_id --cluster-admin-password $cluster_admin_password --node-backup-id $node_backup_id --node-host-name $node_host_name