The Swarm Platform configures and manages Swarm storage clusters. This command line interface helps you automate your hardware management tasks by letting you script common, high-level management tasks around cluster and node deployment:

Cluster	Create a storage cluster Read a storage cluster's settings Update a storage cluster's settings
Chassis	Add a chassis to the cluster Read a chassis' settings Update a chassis' settings
Software	Upgrade a storage cluster's software Add or update a storage license Update the storage cluster configuration, such as the location of Syslog and NTP servers

CLI Commands

1 platform add adminuser
2 platform add bonding-mode
3 platform add config
4 platform add def-storage-version
5 platform add dhcp
6 platform add dns
7 platform add gateway
8 platform add iprange
9 platform add kernelparam
10 platform add
11 platform add ntpkey
12 platform add tag
13 platform bootstrap
14 platform commission
15 platform commission setimage
16 platform delete adminuser
17 platform delete allchassisconfig
18 platform delete allclusterconfig
19 platform delete bonding-mode
20 platform delete config
21 platform delete iprange
22 platform delete kernelparam
23 platform delete
24 platform delete proxyimage
25 platform delete rollingreboot
26 platform delete storageimages
27 platform delete tag
28 platform deploy
29 platform deploy proxy
30 platform deploy storage
31 platform list adminusers
32 platform list bonding-mode
33 platform list config
34 platform list def-storage-version
35 platform list license
36 platform list
37 platform list nodes
38 platform list proxyimages
39 platform list rackcontrollers
40 platform list registration-command
41 platform list storageimages
42 platform list subnets
43 platform list tags
44 platform
45 platform pause
46 platform pause rollingreboot
47 platform release
48 platform release proxy
49 platform release storagechassis
50 platform restart
51 platform restart proxy
52 platform restart storagecluster
53 platform restart storagenode
54 platform resume
55 platform resume rollingreboot
56 platform status
57 platform status platform
58 platform status proxy
59 platform status rollingreboot
60 platform status storagechassis
61 platform status storagecluster
62 platform subcluster assign
63 platform subcluster list
64 platform subcluster
65 platform subcluster unassign
66 platform upload config
67 platform upload license
68 platform upload
69 platform upload storageimages

platform add adminuser

Add an admin user to the Storage cluster

Synopsis

Add a new admin user to the storage cluster. Can also be used to update the password for an existing admin user.

When updating the password for the snmp user, a cluster restart is required for the change to take effect. The cluster does not need to be running to change the password.

When updating the password for any non-snmp user, the cluster must be running for operation to succeed.

platform add adminuser [flags]

Options

--askpassword Use to read password from stdin (optional) -h, --help help for adminuser --password string The password to use --update Use to just update the password for the given user (optional) --username string The username to add

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform add bonding-mode

Set default bonding mode

Synopsis

Sets the default bonding mode to use when booting Storage chassis.

platform add bonding-mode [flags]

Options

--default-bonding-mode string The default bonding mode -h, --help help for bonding-mode

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform add config

Upload chassis config

Synopsis

Upload a chassis configuration file to the Platform server:

./platform upload config -c node10net.cfg

platform add config [flags]

Options

-f, --file string The full path for a certificate file (optional) -h, --help help for config -m, --mac string The MAC address for a specific storage chassis (optional) --name string The name of the setting --override Used to set custom configuration settings (optional) --value string The value of the setting

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform add def-storage-version

Set default storage version

Synopsis

Sets the default storage version.

platform add def-storage-version [flags]

Options

-h, --help help for def-storage-version -v, --storageversion string The Storage image version to use

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform add dhcp

Enable DHCP for another subnet

Synopsis

Used to Enable DHCP for an additional subnet other than the one provided during bootstrap

platform add dhcp [flags]

Options

-z, --endip string The ending IP of the DHCP range to use --force Use to force an unrecommended dynamic range -h, --help help for dhcp -a, --startip string The starting IP of the DHCP range to use -t, --subnet string The subnet to use for DHCP

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform add dns

Set the DNS server for a subnet

Synopsis

Used to set the DNS servers for a subnet

platform add dns [flags]

Options

--dns string The DNS servers for the subnet (comma separated list) -h, --help help for dns -t, --subnet string The subnet to set dns for

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform add gateway

Set the Gateway for a subnet

Synopsis

Used to set the gateway for a subnet

platform add gateway [flags]

Options

--gateway string The gateway to use for the subnet -h, --help help for gateway -t, --subnet string The subnet to set gateway for

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform add iprange

Add a reserved IP range

Synopsis

Add a new reserved range of IP addresses to a DHCP subnet:

./platform add iprange -a 172.16.1.1 -z 172.16.1.30

platform add iprange [flags]

Options

-z, --endip string The ending IP of the reserved range to use -h, --help help for iprange -a, --startip string The starting IP of the reserved range to use

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform add kernelparam

Add a kernel parameter to a chassis

Synopsis

Add a kernel parameter to a chassis. Requires a reboot of the chassis.

platform add kernelparam [flags]

Options

-h, --help help for kernelparam --kernel_params string The kernel parameters to add --replace Use to replace and not just append kernel parameters (optional)) -y, --systemid string The system_id of the chassis

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform add

Add to the Platform node

Synopsis

Add to the Platform node using add subcommands

platform add [flags]

Options

-h, --help help for add

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform add ntpkey

Add an ntp control key

Synopsis

Add a new ntp control key for use by Swarm Storage

platform add ntpkey [flags]

Options

-h, --help help for ntpkey --key-file string The NTP key file to use. (default "/etc/ntpkey_md5_zinc")

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform add tag

Add a node tag

Synopsis

Add a tag to a chassis

platform add tag [flags]

Options

-h, --help help for tag -y, --systemid string The system_id of the chassis --tagName string The name of the tag go add

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform bootstrap

Prepare the Platform environment services for Storage node deployment

Synopsis

Bootstrap the Platform services, adding Storage images and prepare the Swarm cluster environment.

Bootstrapping the Platform server uploads a starting Storage image, identifies the subnet for DHCP and prepares the Platform server to support the Storage chassis with enlisting/commissioning images while creating settings needed for the boot of chassis to a chosen image:

./platform bootstrap -t 10.0.0.0/24 -a 10.0.0.100 -z 10.0.0.200 -i ./Swarm-v9.1.1-x86_64.zip -v 9.1.1

platform bootstrap [flags]

Options

-s, --dnssuffix string The default DNS domain suffix to use -z, --endip string The ending IP of the DHCP range to use --force Use to force an unrecommended dynamic range -h, --help help for bootstrap -i, --image string The full path for the Storage image --offline Use for offline installations --skipReady Use to skip the ready check, use with caution -a, --startip string The starting IP of the DHCP range to use -v, --storageversion string The version of Storage image to use -t, --subnet string The subnet to use for DHCP

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform commission

Commissioning related commands

Synopsis

Commissioning related commands

platform commission [flags]

Options

-h, --help help for commission

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform commission setimage

Set the commissioning image to use

Synopsis

Used to set the ubuntu distribution to use for commissioning.

platform commission setimage [flags]

Options

--distro string The ubuntu distro (e.g. xenial, bionic) (default "bionic") -h, --help help for setimage

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform delete adminuser

Delete an admin user to the Storage cluster

Synopsis

Delete a new admin user to the storage cluster

platform delete adminuser [flags]

Options

-h, --help help for adminuser --override Use to delete user even if Storage can not be notified of change. Use caution. (optional) --username string The username to delete

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform delete allchassisconfig

Delete all chassis config settings

Synopsis

Clear all chassis configuration settings. This resets all settings back to their default.

NOTE: A cluster or chassis reboot is needed after this command is run.

platform delete allchassisconfig [flags]

Options

--force Use to not prompt for verification -h, --help help for allchassisconfig -m, --mac string The MAC address for a specific storage node (optional)

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform delete allclusterconfig

Delete all cluster config settings

Synopsis

Clear all cluster configuration settings. This resets all settings back to their default.

NOTE: A cluster reboot is needed after this command is run.

platform delete allclusterconfig [flags]

Options

--force Use to not prompt for verification -h, --help help for allclusterconfig

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform delete bonding-mode

Delete default bonding mode

Synopsis

Delete the default bonding mode to use when booting Storage chassis.

platform delete bonding-mode [flags]

Options

-h, --help help for bonding-mode

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform delete config

List node configuration

Synopsis

list config displays the configuration settings for the Swarm Storage cluster or for a single Storage chassis:

$> ./platform list config

platform delete config [flags]

Options

-h, --help help for config -m, --mac string The MAC address for a specific storage node (optional) --propertyname string The name of the property to delete

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform delete iprange

Delete a reserved IP range

Synopsis

Delete a reserved range of IP addresses:

./platform delete iprange -a 172.16.1.1 -z 172.16.1.30

platform delete iprange [flags]

Options

-h, --help help for iprange -a, --startip string The starting IP of the reserved range to use

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform delete kernelparam

Delete kernel parameters for a chassis

Synopsis

Delete kernel parameters for a chassis. Requires a reboot of the chassis.

platform delete kernelparam [flags]

Options

-h, --help help for kernelparam -y, --systemid string The system_id of the chassis

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform delete

Delete command

Synopsis

Delete objects using the subcommands

platform delete [flags]

Options

-h, --help help for delete

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform delete proxyimage

Delete Service Proxy image

Synopsis

Delete Service Proxy software image:

platform delete proxyimage [flags]

Options

-h, --help help for proxyimage --version string The version of the Service Proxy to remove

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform delete rollingreboot

Cancel rolling reboot

Synopsis

Cancel a currently running rolling reboot.

This command can also be used to remove chassis from a currently running rolling reboot using the --chassis argument

platform delete rollingreboot [flags]

Options

--cancel Do a full cancel of the rolling reboot --chassis string List of chassis to remove from rolling reboot. A comma-separated list of system IDs (optional) -h, --help help for rollingreboot

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform delete storageimages

Delete a Storage image

Synopsis

Delete a Swarm Storage image from the Platform server:

./platform delete storageimages -v 9.1base

platform delete storageimages [flags]

Options

-h, --help help for storageimages -v, --storageversion string The version of Storage image to delete

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform delete tag

Delete a node tag

Synopsis

Delete a tag to a chassis

platform delete tag [flags]

Options

-h, --help help for tag -y, --systemid string The system_id of the chassis --tagName string The name of the tag go add

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform deploy

Deploy command

Synopsis

Deploy command

platform deploy [flags]

Options

-h, --help help for deploy

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform deploy proxy

Deploy Service Proxy

Synopsis

Deploy a local Service Proxy instance:

Deploy a new Service Proxy instance, supplying the zip file for upload. The Storage cluster is validated, guaranteeing there are at least 2 Storage nodes running with the cluster settings for enforceTenancy on and noauth on:

./platform deploy gateway -b ./service_proxy.zip

platform deploy proxy [flags]

Options

-h, --help help for proxy -b, --proxybundle string The full path for the Service Proxy bundle zip file --skipChassisCheck Skip check for deployed chassis --skipSettingsCheck Skip check gateway compliant settings --upgrade Upgrade the currently running proxy --version string The version of the Service Proxy to use

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform deploy storage

Deploy Storage chassis

Synopsis

Deploy Swarm Storage chassis with a selected Storage image.

Deploy Storage chassis by supplying the configuration file and number of chassis. Optionally deploy to a single chassis by specifying the systemid instead of a number of chassis:

./platform deploy storage -n 1 -c ./node10net.cfg -v 9.1.1

platform deploy storage [flags]

Options

--askpassword Use to read password from stdin (optional) --askpasswordClear Use to read password from stdin but echo input (optional) --bondingMode string The network bonding mode to use for the chassis (optional) -h, --help help for storage --ipmiPassword string A custom password to use for IPMI control (optional) --ipmiUser string A custom username to use for IPMI control (optional) --kernelparams string general kernel params for the chassis (optional) --manual Force the chassis you use manual power control (optional) -n, --numchassis int The number of chassis to deploy --skipCheck Skip test to make sure chassis is deployable (optional) -c, --storageconfig string The full path for the Storage configuration (node.cfg) file -v, --storageversion string The version of Storage image to use -y, --systemid string The system_id of the chassis to deploy to (optional) --upgrade Just do an upgrade operation (optional)

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform list adminusers

List the current admin users for the Storage cluster

Synopsis

List the current admin users for the Storage cluster

platform list adminusers [flags]

Options

-h, --help help for adminusers --validate Validate the current passwords with Storage nodes to make sure they match (optional)

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform list bonding-mode

Show default bonding mode

Synopsis

Show the default bonding mode to use when booting Storage chassis.

platform list bonding-mode [flags]

Options

-h, --help help for bonding-mode

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform list config

List node configuration

Synopsis

list config displays the configuration settings for the Swarm Storage cluster or for a single Storage chassis:

$> ./platform list config

platform list config [flags]

Options

--all List all properties (optional) -h, --help help for config -m, --mac string The MAC address for a specific storage node (optional)

Options inherited from parent commands

--debug Enable debug logging --port int Platform server node API port (default 8095) --server string Platform server node IP address (default "127.0.0.1")

platform list def-storage-version

Show the default storage version

Platform CLI Commands

CLI Commands

platform add adminuser

Synopsis

Options

Options inherited from parent commands

platform add bonding-mode

Synopsis

Options

Options inherited from parent commands

platform add config

Synopsis

Options

Options inherited from parent commands

platform add def-storage-version

Synopsis

Options

Options inherited from parent commands

platform add dhcp

Synopsis

Options

Options inherited from parent commands

platform add dns

Synopsis

Options

Options inherited from parent commands

platform add gateway

Synopsis

Options

Options inherited from parent commands

platform add iprange

Synopsis

Options

Options inherited from parent commands

platform add kernelparam

Synopsis

Options

Options inherited from parent commands

platform add

Synopsis

Options

Options inherited from parent commands

platform add ntpkey

Synopsis

Options

Options inherited from parent commands

platform add tag

Synopsis

Options

Options inherited from parent commands

platform bootstrap

Synopsis

Options

Options inherited from parent commands

platform commission

Synopsis

Options

Options inherited from parent commands

platform commission setimage

Synopsis

Options

Options inherited from parent commands

platform delete adminuser

Synopsis

Options

Options inherited from parent commands

platform delete allchassisconfig

Synopsis

Options

Options inherited from parent commands

platform delete allclusterconfig

Synopsis

Options

Options inherited from parent commands

platform delete bonding-mode

Synopsis

Options

Options inherited from parent commands

platform delete config

Synopsis