Commonly used commands
Ansible command |
Description |
Notes/warnings |
---|---|---|
add_cluster_nodes |
runs required software transfer and system modification tasks on any new storage cluster nodes registered to a cluster. |
Note Must be logged into a cluster |
add_cvms |
runs required software transfer and system modification tasks on any new storage proxies (CVMs) registered to a cluster. |
Note Must be logged into a cluster |
collect logs |
collects all Hedvig HBlock, Pages, HPod, storage proxy, and system logs; packages them into a tarball; and stores them on the deployment server. |
|
delete_cluster_node |
deletes a storage cluster node from the cluster database. |
|
delete_ha_cvm_pair |
deletes an HA (high availability) storage proxy pair from the cluster database. |
|
delete_non_ha_cvm |
deletes a non-HA storage proxy from the cluster database. |
|
delete_node_from_db |
deletes the current storage cluster node from the cluster database. |
Note Must be logged into a cluster |
delete_specific_cluster |
deletes the current cluster from the database. |
|
deploy_new_cluster |
runs the main cluster deployment action for a new cluster. |
|
exit |
quits the |
|
history |
shows command history. |
|
logout_of_cluster |
logs out of the current cluster. |
|
register_new_cluster |
adds new cluster details to the cluster database for use with Ansible. Input is <cluster_name>.ansi file. |
|
remove_cluster_nodes |
removes a storage cluster node from a cluster. |
Warning This action is destructive. |
remove_cvms |
removes a storage proxy from a cluster. |
Warning This action is destructive. |
show_all_clusters |
shows names, and current cluster owner if any, of all clusters registered in the database. |
|
show_cluster_details |
shows current cluster information. |
Note Must be logged into a cluster |
show_cluster_nodes |
shows information for the storage cluster nodes in a cluster. |
Note Must be logged into a cluster |
show_commands |
shows all available commands. |
|
show_current_cluster |
shows the current cluster. |
Note Must be logged into a cluster |
show_cvms |
shows information for the storage proxies related to a cluster. |
|
show_ha_cvms |
shows information for the HA storage proxies related to a cluster. |
|
stop_cluster |
stops all Hedvig-related services on a deployed cluster. |
|
validate_cluster_settings |
runs a series of tasks on the storage cluster nodes and storage proxies to validate the cluster configuration stored locally. |
|
wipeout_cluster |
deletes all settings for a cluster. |
Warning This action is destructive and irreversible. Use this command with extreme caution. |
Other commands
Ansible command |
Description |
Notes/warnings |
---|---|---|
add_ssh_connections |
transfers the public SSH (secure shell) to remote machines to enable password-less SSH for Ansible. |
Note Must be logged into a cluster. |
clean_local_cluster_logs |
cleans the log path (which is usually /home/admin/<cluster_name>/logs). |
|
deploy_packages |
installs only the required RPMs (packages) on the storage cluster nodes and storage proxies. |
Note deploy_new_cluster should still be run to bring up the cluster. |
disable_all_flash |
disables the key for flash on a cluster. |
Note Run this before deploy_new_cluster. |
disable_dualdc |
disables the Dual DC (data center) setting on a cluster. |
Note Run this before deploy_new_cluster. |
enable_all_flash |
sets the key for flash on a cluster. |
Note Run this before deploy_new_cluster. |
enable_dualdc |
enables the Dual DC (data center) setting on a cluster. |
Note Run this before deploy_new_cluster. |
enable_flache_cvm |
enables flash cache on the storage proxies. |
|
getting_started |
shows a simple reminder of how to get started with cluster deployment. |
|
modify_cluster |
modifies select attributes of a cluster in the cluster database. |
Note Must be logged into a cluster. |
modify_cluster_node |
modifies select attributes of a storage cluster node in the cluster database. |
Note Must be logged into a cluster. |
modify_ha_cvm |
modifies select attributes of an HA storage proxy in the cluster database. |
Note Must be logged into a cluster. |
modify_ha_cvm_pair |
modifies select attributes of an HA storage proxy pair in the cluster database. |
Note Must be logged into a cluster. |
modify_non_ha_cvm |
modifies select attributes of a non-HA storage proxy in the cluster database. |
Note Must be logged into a cluster. |
refresh_ssh_socket_cache |
removes cached SSH sockets if Ansible cannot connect to a remote host. |
|
show_cluster_history |
displays the current cluster's history, which includes modifications made to the cluster, the storage cluster nodes, and the storage proxies in the database. |
|
show_cluster_inventory |
shows the formatted JSON output that is passed to Ansible. |
|
show_pages |
shows information for the Pages nodes related to a cluster. |
|
show_pod_groups |
shows information for the HPod groups related to a cluster. |
|
switch_cluster |
logs out of the current cluster and into a different existing cluster. |
|
take_ownership_of_cluster |
sets the cluster_owner attribute for the current cluster. |
Note This is an informational attribute that identifies the cluster administrator. |