FortiAnalyzer-BigData cluster controller CLI

This section describes how to use fazbdctl, the FortiAnalyzer-BigData Command Line Interface (CLI), and contains references for all fazbdctl commands.

fazbdctl is available on the cluster controller (see Connect to the FortiAnalyzer-BigData CLI) and is the main command used to manage the hosts of FortiAnalyzer-BigData.

Syntax

fazbdctl <command>

Commands

Show version

fazbdctl show version

Shows the FortiAnalyzer-BigData version of the host.

Show members

fazbdctl show members

Lists all the cluster hosts' information managed by the cluster controller.

Example response

In this example:

• Management IP/Mask is 10.106.2.168/24

Field descriptions

Example response in wide format

In this example:

• Management IP/Mask is 10.106.2.168/24
• Gateway is 10.106.2.254

Additional field descriptions for wide format

Upgrade

fazbdctl upgrade {bootloader | fazbd | cluster} [-U <URL>][-o <option>][-p <password>][-u <username>]

Use this command to upgrade bootloader with argument "bootloader" and upgrade FortiAnalyzer-BigData OS with argument "fazbd" or "cluster" for the whole cluster. For more information, see the FortiAnalyzer-BigData Administration Guide in the Fortinet Doc Library.

• This command should be executed only on the cluster controller. It has no effect if run on other hosts.
• This command is only allowed when all the FortiAnalyzer-BigData services are healthy, but you can use -f to force the upgrade to run.

  Extra options	Description
  {-U | --image-url} <URL>	URL for the image to be downloaded and installed.
  {-o | --option} <Option>	Re-run options when failed: skip | retry | restart.
  {-p | --password} [<password>]	Password for the download server if there is one.
  {-u | --username} [<user name>]	Username for the download server if there is one.

  Examples

  Command	Description
  fazbdctl upgrade cluster	Interactively upgrade FortiAnalyzer-BigData.
  fazbdctl upgrade cluster -o retry	If last upgrade fails, retry from the state where the upgrade fails.

Reset

fazbdctl reset [<worker-ip> | cluster] [-A | -I | -S | -B] [-o <option>][-n]

Reset the entire OS and optionally format all the disks for a single host or the whole cluster. When there is no argument specified, the reset applies to local host.

These are the available options in this command:

{-x | --exclude-faz}

If no option is set, a soft reset will be performed. Otherwise, a hard reset will be performed to additionally format all the disks.

Note: When -n is not specified, the following default subnet will be used:

Examples

For instructions on how to reset your device, see the FortiAnalyzer-BigData Administration Guide in the Fortinet Doc Library.

Init

fazbdctl init cluster [-o <option>]

Initialize the FortiAnalyzer-BigData cluster. This command initializes and configures the FortiAnalyzer-BigData cluster hosts. The process takes approximately 30 to 40 minutes. For more information, see the FortiAnalyzer-BigData Administration Guide in the Fortinet Doc Library.

• This command should be executed only on the cluster controller. It has no effect if run on other hosts.

  Extra options	Description
  {-o | --option} <Option>	Re-run options when failed: skip | retry |restart

If you run this command on an existing cluster, it will reinitialize and cause you to lose all log data and configurations.

Set management and external addresses

fazbdctl {set | unset} addr {<external ip/mask> | dhcp} [<gateway>] [--management] \ [-H] [-A] [-Y]

Set management IP address on the cluster controller and external IP addresses (used for Hyperscale logging) on cluster hosts to allow them to communicate with the outside world.

external ip/mask can be IP CIDR address or simply dhcp.

• The optional management flag indicates the data carried in the external ip/mask and gateway fields is used to set the main management IP address. This flag is not compatible with -H and -A and is only available on the cluster controller.
• The optional -H flag specifies the internal IP address of a host where the external IP will be assigned. Without this flag, the external IP address is assigned to the local host.
• The optional -A flag sets external IP addresses on all hosts from the controller. In this case, the external ip/mask field specifies the starting external IP address to be assigned to the first host. The remaining hosts are assigned external IP addresses incrementally from the starting external IP address within the network subnet, wrapping around when reaching the boundary of the network subnet. This flag is not compatible if external ip/mask is dhcp.
• The optional -Y flag lets you skip interactive confirmation when the command is issued.

Examples

Set appliance role

fazbdctl set appliance {extender-chassis-id}

Designate an appliance as an extender appliance so you can add it as an extender to the main appliance. For instructions on assigning a new chassis ID to the extender appliance, see the FortiAnalyzer-BigData Administration Guide in the Fortinet Doc Library.

• This command should be executed only on the cluster controller. It has no effect if run on other hosts.

Enable/Disable IP-Forward

fazbdctl [ enable | disable ] ip-forward

By default, all the cluster hosts except the cluster controller have no external network access. In some cases, you might want to allow external network access for all hosts, for example, to backup and restore data to external HDFS, to support Hyperscale log ingestion, etc.. This command allows you to forward packets from your internal network by enabling or disabling the NAT setup on the cluster controller.

• This command should be executed only on the cluster controller. It has no effect if run on other hosts.

Unstack chassis

fazbdctl unstack-chassis

Use this command in the cluster controller to unstack the chassis so that they can be separated safely. For more information see How to remove a chassis from a stacked setup in the FortiAnalyzer-BigData Administration Guide.