Fortinet black logo

Administration Guide

Main HA-Cluster CLI commands

Copy Link
Copy Doc ID 4f5a6250-a945-11ec-9fd1-fa163e15d75b:389713
Download PDF

Main HA-Cluster CLI commands

The table below lists the CLI commands to administer your HA-Cluster.

hc-settings

Configure the unit as a HA-Cluster mode unit. Set or unset cluster failover IP set.

hc-status -l

List the status of HA-Cluster units.

hc-worker

-a to add that worker or secondary unit to the cluster.

-r to remove that worker or secondary unit from the cluster.

-u to update that worker or secondary unit information.

hc-primary -s<10-100>

Turn on file scan on the primary node with 10% to 100% processing capacity.

hc-primary -r<serial number>

Remove the worker or secondary unit with the specified serial number from the primary node.

After removing a worker or secondary node, use hc-status -l on the primary node to verify that the worker or secondary node has been removed.

Setting primary node processing capacity

Primary node requires enough dedicated processing power for job distribution and cluster management. We recommend that for every 5 VM clones on the worker nodes, 1 VM should be removed from the Master.

Example:

You are using two FSA3KE units to setup a cluster. One FortiSandbox works as Primary node and the other works as the Worker node.

The Worker node operates 56 VM clones, so the Primary node should remove 11 clones from its processing capacity. In this example, the Primary node should be running 45 (56 – 11) VM clones.

The CLI command hc-primary -s80 will take the Primary node to 80% of its VM processing power, which is 45 clones. This means that even if you configure the Primary node to run 56 clones, at any moment, no more than 45 clones can be running.

Main HA-Cluster CLI commands

The table below lists the CLI commands to administer your HA-Cluster.

hc-settings

Configure the unit as a HA-Cluster mode unit. Set or unset cluster failover IP set.

hc-status -l

List the status of HA-Cluster units.

hc-worker

-a to add that worker or secondary unit to the cluster.

-r to remove that worker or secondary unit from the cluster.

-u to update that worker or secondary unit information.

hc-primary -s<10-100>

Turn on file scan on the primary node with 10% to 100% processing capacity.

hc-primary -r<serial number>

Remove the worker or secondary unit with the specified serial number from the primary node.

After removing a worker or secondary node, use hc-status -l on the primary node to verify that the worker or secondary node has been removed.

Setting primary node processing capacity

Primary node requires enough dedicated processing power for job distribution and cluster management. We recommend that for every 5 VM clones on the worker nodes, 1 VM should be removed from the Master.

Example:

You are using two FSA3KE units to setup a cluster. One FortiSandbox works as Primary node and the other works as the Worker node.

The Worker node operates 56 VM clones, so the Primary node should remove 11 clones from its processing capacity. In this example, the Primary node should be running 45 (56 – 11) VM clones.

The CLI command hc-primary -s80 will take the Primary node to 80% of its VM processing power, which is 45 clones. This means that even if you configure the Primary node to run 56 clones, at any moment, no more than 45 clones can be running.