com.solidfire.element.api

Class ResetNodeRequest

java.lang.Object

com.solidfire.element.api.ResetNodeRequest

All Implemented Interfaces:

java.io.Serializable

public class ResetNodeRequest
extends java.lang.Object
implements java.io.Serializable

ResetNodeRequest The ResetNode API method enables you to reset a node to the factory settings. All data, packages (software upgrades, and so on), configurations, and log files are deleted from the node when you call this method. However, network settings for the node are preserved during this operation. Nodes that are participating in a cluster cannot be reset to the factory settings. The ResetNode API can only be used on nodes that are in an "Available" state. It cannot be used on nodes that are "Active" in a cluster, or in a "Pending" state. Caution: This method clears any data that is on the node. Exercise caution when using this method. Note: This method is available only through the per-node API endpoint 5.0 or later.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResetNodeRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ResetNodeRequest()
ResetNodeRequest(java.lang.String build, java.lang.Boolean force)
ResetNodeRequest(java.lang.String build, java.lang.Boolean force, Optional<java.lang.Boolean> reboot, Optional<java.lang.String> options)

Method Summary

Modifier and Type	Method and Description
ResetNodeRequest.Builder	asBuilder()
static ResetNodeRequest.Builder	builder()
boolean	equals(java.lang.Object o)
java.lang.String	getBuild() Specifies the URL to a remote Element software image to which the node will be reset.
java.lang.Boolean	getForce() Required parameter to successfully reset the node.
Optional<java.lang.String>	getOptions() Used to enter specifications for running the reset operation.
Optional<java.lang.Boolean>	getReboot() Set to true if you want to reboot the node.
int	hashCode()
void	setBuild(java.lang.String build)
void	setForce(java.lang.Boolean force)
void	setOptions(Optional<java.lang.String> options)
void	setReboot(Optional<java.lang.Boolean> reboot)
java.util.Map<java.lang.String,java.lang.Object>	toMap()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ResetNodeRequest

@Since(value="7.0")
public ResetNodeRequest()

ResetNodeRequest

@Since(value="7.0")
public ResetNodeRequest(java.lang.String build,
                                            java.lang.Boolean force)

ResetNodeRequest

@Since(value="9.0")
public ResetNodeRequest(java.lang.String build,
                                            java.lang.Boolean force,
                                            Optional<java.lang.Boolean> reboot,
                                            Optional<java.lang.String> options)

Method Detail

getBuild

public java.lang.String getBuild()

Specifies the URL to a remote Element software image to which the node will be reset.

setBuild

public void setBuild(java.lang.String build)

getForce

public java.lang.Boolean getForce()

Required parameter to successfully reset the node.

setForce

public void setForce(java.lang.Boolean force)

getReboot

public Optional<java.lang.Boolean> getReboot()

Set to true if you want to reboot the node.

setReboot

public void setReboot(Optional<java.lang.Boolean> reboot)

getOptions

public Optional<java.lang.String> getOptions()

Used to enter specifications for running the reset operation. Available options: 'edebug': '', 'sf_auto': '0', 'sf_bond_mode': 'ActivePassive', 'sf_check_hardware': '0', 'sf_disable_otpw': '0', 'sf_fa_host': '', 'sf_hostname': 'SF-FA18', 'sf_inplace': '1', 'sf_inplace_die_action': 'kexec', 'sf_inplace_safe': '0', 'sf_keep_cluster_config': '0', 'sf_keep_data': '0', 'sf_keep_hostname': '0', 'sf_keep_network_config': '0', 'sf_keep_paths': '/var/log/hardware.xml 'sf_max_archives': '5', 'sf_nvram_size': '', 'sf_oldroot': '', 'sf_postinst_erase_root_drive': '0', 'sf_root_drive': '', 'sf_rtfi_cleanup_state': '', 'sf_secure_erase': '1', 'sf_secure_erase_retries': '5', 'sf_slice_size': '', 'sf_ssh_key': '1', 'sf_ssh_root': '1', 'sf_start_rtfi': '1', 'sf_status_httpserver': '1', 'sf_status_httpserver_stop_delay': '5m', 'sf_status_inject_failure': '', 'sf_status_json': '0', 'sf_support_host': 'sfsupport.solidfire.com', 'sf_test_hardware': '0', 'sf_upgrade': '0', 'sf_upgrade_firmware': '0', 'sf_upload_logs_url': ''

setOptions

public void setOptions(Optional<java.lang.String> options)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toMap

public java.util.Map<java.lang.String,java.lang.Object> toMap()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static ResetNodeRequest.Builder builder()

asBuilder

public final ResetNodeRequest.Builder asBuilder()