...

SCS’s CLI (command-line interface) is installed by default on the SCS server and supports common administrative tasks.

Getting Help

Every command within the CLI offers help. Some examples:

...

scsctl help

...

scsctl init dhcp help

...

Getting Help

Every command within the CLI offers help. Some examples:

• scsctl help

• scsctl init dhcp help

• scsctl repo component add help

Listing Components

...

List the instances within a given the default group of a component :(most common usage):

scsctl {component} instance list -d

List the instances within a specific group of a component:

scsctl {component} instance list --group "{group name}"

...

scsctl storage instance list -d

Assuming an Old Instance Identity

...

Assuming an Old Instance Identity

Whenever the identity of an instance changes (typically when a storage node has a change to its networking cards), SCS will recognize it as an entirely new instance, even if the change is not substantial. The former identity still exists in SCS, but will never be used ( including any instance-specific setting or template overrides). There However, there is a way method to tell instruct SCS to associate the former identity with the new instance ID, clearing which will also clear out the old identity in the process.

scsctl {component} instance rename "{new instance ID}" "{former instance ID}" --force

curl -X PATCH --data-binary '{"name": "{former instance ID}"}' "http://{SCS IP address}:8095/platform/components/{component name}/groups/{group name}/instances/{new instance ID}/?force=yes"

Defining the Storage Cluster

The storage component within SCS only allows a single group/cluster to be defined for that site. The name of that cluster is governed by the name assigned to its group within SCS.

Create the Cluster

To create a group for Swarm Storage:

scsctl storage group add "{cluster name}"

Assigning a Storage Node to a Subcluster

Each node forms a de-facto subcluster if no explicit subcluster assignments are made in Swarm Storage configuration. The Swarm Storage component (storage) provides the node.subcluster setting as a free-form name that may be assigned to one or more nodes.

The storage process looks at all names assigned to the different nodes and forms them into groups, which can then be used to determine how object replica distribution and protection are handled. The nodes may be grouped using subclusters in any way needed to achieve the desired replica/fail-over paradigm.

...

Removing an Instance

If SCS ever needs to “forget” an instance, use the following command to fully remove it from SCS. The example below uses the default group, but you can use the -g {group name} form of the command as needed.

scsctl {component} instance remove -d {instance ID}

Defining the Storage Cluster

The storage component within SCS only allows a single group/cluster to be defined for that site. The name of that cluster is governed by the name assigned to its group within SCS.

Create the Cluster

To create a group for Swarm Storage:

scsctl storage configgroup set -d --instance add "{instancecluster name/ID}" "node.subcluster={subcluster name}"

Updating a Cluster Setting

Update a cluster setting for Swarm Storage:

scsctl storage config set -d "{setting name}={setting value}"

Some specific examples:

scsctl storage config set -d "policy.versioning=allowed"

Assigning a Storage Node to a Subcluster

Each node forms a de-facto subcluster if no explicit subcluster assignments are made in the Swarm Storage configuration. The Swarm Storage component (storage) provides the node.subcluster setting as a free-form name that can be assigned to one or more nodes.

The storage process groups nodes based on their assigned names, which are then used to manage object replica distribution and protection. Nodes that are grouped using subclusters can be configured in any way necessary to achieve the desired replica/fail-over strategy.

Update the subcluster for a storage node:

scsctl storage config set -d "policy.eCEncoding=4:2--instance "{instance ID}" "node.subcluster={subcluster name}"

Updating a

...

Cluster Setting

Update a cluster setting for Swarm Storage:

scsctl storage config set -d --instance "{instance name/ID}" "{setting name}={setting value}"

...

scsctl storage config set -d --instance "{instance name/ID}" "ec.protectionLevel=nodepolicy.versioning=allowed"
scsctl storage config set -d "policy.eCEncoding=4:2"

Updating a Storage Node Setting

Update a cluster setting for Swarm Storage:

scsctl storage config set -d --instance "{instance name/ID}" "feeds.maxMem=500000"

Resetting a Setting

Removing a setting override means that the value for the setting is inherited from a higher scope. Removing an instance-level override means that the value for the setting is obtained from either the group (if a group-level override has been set) or component level. Removing a group-level override has no influence on any existing instance-level overrides that may exist within that group.

Instance Level

Reset an instance-level override:

scsctl {component} config unset --group "{group name}" --{setting name}={setting value}"

Some specific examples:

scsctl storage config set -d --instance "{instance ID}" "ec.protectionLevel=node"
scsctl storage config set -d --instance "{instance name/ID}" "{setting name}"

Group Level

Reset a group-level override:

scsctl {component} config unset --group "{group name}" "{setting name}"

Updating Network Settings

Shared network settings, such as DNS information and NTP time sources, may be updated as the need arises.

DNS Servers

Update the list of DNS servers (specified as comma- or space-delimited list):

scsctl network_boot config set -d "network.dnsServers={new DNS servers}"

This also requires that the DHCP server be updated so the setting can be made available to booting Storage nodes.

scsctl init dhcp {reserved ranges}

NTP Servers

Update the list of NTP servers (specified as comma- or space-delimited list):

scsctl platform config set -d "network.ntpServers={new NTP servers}"

This also requires that the DHCP server be updated so the setting can be made available to booting Storage nodes.

scsctl init dhcp {reserved ranges}

Swarm (Internal) Network MTU

Network MTU for the entire Swarm storage cluster is governed by the MTU set on the internal network interface of SCS. This value is put into DHCP configuration during the init dhcp process, and served to all storage nodes on boot.

1. Update the MTU on the internal network interface.

2. List the interface details on the SCS to ensure that the change is correct.

3. Re-initialize DHCP to apply to changes to any future booting storage nodes:

   Code Block
   scsctl init dhcp {reserved ranges}

Swarm (Internal) Network Gateway

The network gateway for the entire Swarm storage cluster is governed by a setting available in SCS as of version 1.5. The setting is provided by the network_boot component, and is called network.gateway. By default, this setting points to the IP address of the internal network interface of SCS, but may be overridden by normal means using the CLI. This value is put into DHCP configuration during the init dhcp process, and served to all storage nodes on boot.

1. Update the network.gateway setting.

   Code Block
   scsctl network_boot config set -d "network.gateway={gateway_ip_address}"

2. Re-initialize DHCP to apply to changes to any future booting storage nodes:

   Code Block
   scsctl init dhcp {reserved ranges}

Updating Network Bonding Mode in Swarm Storage

This list of supported network bonding modes can be found at Network Devices and Priority.

...

ID}" "feeds.maxMem=500000"

Resetting a Setting

Removing a setting override means that the value for the setting is inherited from a higher scope. Removing an instance-level override means that the value for the setting is obtained from either the group (if a group-level override exists) or the component level. Removing a group-level override does not affect any existing instance-level overrides within that group.

Instance Level

Reset an instance-level override. Either the default-group or specific-group form of the command may be used:

scsctl {component} config unset -d --instance "{instance ID}" "{setting name}"

or

scsctl {component} config unset --group "{group name}" --instance "{instance ID}" "{setting name}"

Group Level

Reset a group-level override. Either the default-group or specific-group form of the command may be used:

scsctl {component} config unset -d "{setting name}"

or

scsctl {component} config unset --group "{group name}" "{setting name}"

Updating Network Settings

Shared network settings, such as DNS information and NTP time sources, can be updated as per requirement.

DNS Servers

Update the list of DNS servers (specified as comma- or space-delimited list).

scsctl network_boot config set -d "network.dnsServers={new DNS servers}"

The example output is:

scsctl network_boot config show -d network.dnsServers 
['10.166.2.18']

This also requires updating the DHCP server so the setting can be made available to booting Storage nodes. See Configure DHCP.

scsctl init dhcp {reserved ranges}

It is recommended to check the bash history on the SCS to view the prior command and its settings. Run the below command on the SCS to view the last DHCP setting command used.

history | grep "scsctl init dhcp" | tail -1

DNS Domain

Update the DNS domain (specified as comma- or space-delimited list):

scsctl platform config set -d "network.dnsDomain={new DNS domain}"

The example output is:

scsctl platform config show -d network.dnsDomain
certlab.local

This also requires updating the DHCP server so the setting can be made available to booting Storage nodes. See Configure DHCP.

scsctl init dhcp {reserved ranges}

It is recommended to check the bash history on the SCS to view the prior command and its settings. Run the below command on the SCS to view the last DHCP setting command used.

history | grep "scsctl init dhcp" | tail -1

NTP Servers

Update the list of NTP servers (specified as comma- or space-delimited list):

scsctl platform config set -d "network.ntpServers={new NTP servers}"

This also requires updating the DHCP server so the setting can be made available to booting Storage nodes. See Configure DHCP.

scsctl init dhcp {reserved ranges}

It is recommended to check the bash history on the SCS to view the prior command and its settings. Run the below command on the SCS to view the last DHCP setting command used.

history | grep "scsctl init dhcp" | tail -1

Swarm (Internal) Network MTU

Network MTU for the entire Swarm storage cluster is governed by the MTU set on the internal network interface of SCS. This value is put into DHCP configuration during the init dhcp process, and served to all storage nodes on boot.

1. Update the MTU on the internal network interface.

2. List the interface details on the SCS to ensure that the change is correct.

3. Re-initialize DHCP to apply to changes to any future booting storage nodes:

   Code Block
   scsctl init dhcp {reserved ranges}

Swarm (Internal) Network Gateway

The network gateway for the entire Swarm storage cluster is governed by a setting available in SCS as of version 1.5. The setting is provided by the network_boot component, and is called network.gateway. By default, this setting points to the IP address of the internal network interface of SCS, but may be overridden by normal means using the CLI. This value is put into DHCP configuration during the init dhcp process and served to all storage nodes on boot.

1. Update the network.gateway setting.

   Code Block
   scsctl network_boot config set -d "network.gateway={gateway IP address}"

2. Re-initialize DHCP to apply changes to any future booting storage nodes. See Configure DHCP.

   Code Block
   scsctl init dhcp {reserved ranges}

   It is recommended to check the bash history on the SCS to view the prior command and its settings. Run the below command on the SCS to view the last DHCP setting command used.

   Code Block
   history | grep "scsctl init dhcp" | tail -1

Updating Network Bonding in Swarm Storage

Swarm Storage supports customizing network bonding for NICs and bonding mode. Additionally, a sysctl file may be specified for storage nodes. Refer to the following sections for bonding NICs and/or mode. In either case, the setting(s) must be applied to the PXE boot system before the new values are available to booting storage nodes.

Relevant bonding information can be found at Network Devices and Priority.

Bonding NICs

Update the bonding NICs setting in SCS:

scsctl network_boot config set -d "kernel.bondingNics={comma-delimited list of NICs}"

The list of NICs should look like: eth0,eth1, with whatever values are appropriate.

Confirm the new setting value:

scsctl network_boot config show -d "kernel.bondingNics"

Bonding Mode

Update the bonding mode setting in SCS:

...

Obtain the component bundle for the desired version from DataCore Downloads to upgrade the Swarm Storage software of a running cluster. Transfer the bundle to the SCS server and run the following commands to register it with SCS.

Replace new-version with the version being installed:

unzip Swarm-new-version.zip

Navigate to the Storage directory and tun the following:

cd Swarm-new-version/Storage/
scsctl repo component add -f swarm-scs-storage-new-version.tgz

Verify the the new version is present in the list of available versions:

scsctl storage software list
old-version (old-version) (active)
new-version (new-version)

It has been successfully registered if the new version is in the list. It is not used for booting nodes and the current active version is used. Mark it as active to complete the upgrade:

scsctl storage software activate "new-version (new-version)"
activated

...

Obtain the component bundle for the latest version from DataCore Downloads to upgrade the Swarm Storage software of a running cluster. Transfer the bundle to the SCS server and run the following commands to register it with SCS:

1. Use the command below to get the list of Storage software versions that have been registered with SCS.

   Code Block
   scsctl storage software list

If the desired version already present in the list, continue with step 5 when ready to boot Swarm Storage nodes to the desired version.

2. Unpack the downloaded Swarm Storage software bundle

3. Navigate to the Storage directory within that bundle and run the following command to register the Swarm storage software with SCS (please insert the correct version string where needed).

   Code Block
   cd Swarm-{desired version}/Storage/ scsctl repo component add -f swarm-scs-storage-{desired version}.tgz

4. Verify the desired version is present in the list of available versions.

   Code Block
   scsctl storage software list

...

5. Activate this desired version to complete the upgrade.

   Code Block
   scsctl storage software activate

   Choose the desired version in the menu. The activated version will be used the next time that storage nodes reboot.

Removing an Installed Version of Swarm Storage

...

scsctl storage software list
14.0.1 (14.0.1) (active)
14.1.2 (14.1.2)

...

Remove the desired version, using the entire version string:

...