swarmctl Overview

Owned by Mary Connor (Deactivated)
Last updated: Feb 21, 2023 by Kyle Miller (Deactivated)
2 min read

  • Like snmp-castor-tool.sh, swarmctl resides in the support tools bundle (swarm-support-tools.tgz)

  • Uses the Management API for all operations

  • Is akin to a Swiss army knife for many support operations

  • Can query the cluster AND perform operations against the cluster

  • Can change cluster settings in real-time

  • Cannot perform a rolling reboot of a cluster (see the swarmrestart script)

  • Does not collect SNMP OID output

  • Relies on the Management API, which is very fast compared to SNMP

  • Is the go-forward support tool for the majority of support operations (Swarm 10+)

  • If SCSP_HOST is set in the environment, -d [ip address] is not necessary

  • -x is commonly used to get more output, in some cases MUCH more

  • -x is used to output to a CSV file automatically for more analysis

  • By default, only takes action or retrieves information from the node specified in SCSP_HOST or -d [ip address] options.

  • -a takes action or gets information from ALL nodes in the cluster as seen in the cluster status page

  • -a is not necessary to change a value that affects the PSS as the PSS is automatically read by all nodes

  • -n is used to take action or query node IPs specified in a file called NODES.csv in the directory where swarmctl script is executed (same note regarding -a applies here this works the same as in the snmp-castor-tool.sh script)

  • -j removes the text table lines to declutter the output

  • -h is used for help (usage)

  • most query output includes the default value, the current value, if it can be changed, and scope of the setting's effect (node/ cluster/ etc)

© DataCore Software Corporation. · https://www.datacore.com · All rights reserved.