Fortinet white logo
Fortinet white logo

CLI Reference

ha hb join

ha hb join

Use this command to manually trigger a FortiMail unit to join an HA cluster or group of HA clusters.

Before you run this command, if HA was previously configured, you must disable it. The command will not run if HA is currently enabled.

If joining did not succeed, use exec ha hb reset-status to reset the HA status. Then try again.

Once the unit joins the cluster, it replaces the HA configuration (if any) in config system ha.

Syntax

execute ha hb join {<primary_ipv4> | <primary_ipv6>} {true | false} "<shared-password_str>" <unit-name_str> [<group_name>]

Variable

Description

Default

{<primary_ipv4> | <primary_ipv6>}

Enter the IP address of the primary unit in the HA cluster. (If you have a group of HA clusters, enter the IP address of the primary cluster's primary unit.)

{true | false}

Select whether this FortiMail unit will be a primary backup.

If either:

then you should enter false. (true is ignored in those cases, because it is not valid.)

Otherwise you may enter true. This updates the configuration in config system ha on the primary unit, making this secondary unit the primary backup.

"<shared-password_str>"

Enter the password for this HA cluster.

Before FortiMail units in the HA cluster synchronize with each other, they verify that they have the same password. This prevents them from accidentally synchronizing with the wrong cluster. Therefore this must match the password "<password_str>" that was configured on other units in the cluster.

<unit-name_str> Enter the name of this FortiMail unit in the HA cluster. This may be different from the FQDN or hostname, in order to distinguish units in an HA cluster. This updates the configuration in config system ha.

[<group_name>]

Enter the name of the group of HA clusters that you want this FortiMail unit to join.

This applies only if, on the primary unit, type {group | member} is group. Otherwise leave it empty.

Related topics

system ha

ha hb reset-status

ha hb join

ha hb join

Use this command to manually trigger a FortiMail unit to join an HA cluster or group of HA clusters.

Before you run this command, if HA was previously configured, you must disable it. The command will not run if HA is currently enabled.

If joining did not succeed, use exec ha hb reset-status to reset the HA status. Then try again.

Once the unit joins the cluster, it replaces the HA configuration (if any) in config system ha.

Syntax

execute ha hb join {<primary_ipv4> | <primary_ipv6>} {true | false} "<shared-password_str>" <unit-name_str> [<group_name>]

Variable

Description

Default

{<primary_ipv4> | <primary_ipv6>}

Enter the IP address of the primary unit in the HA cluster. (If you have a group of HA clusters, enter the IP address of the primary cluster's primary unit.)

{true | false}

Select whether this FortiMail unit will be a primary backup.

If either:

then you should enter false. (true is ignored in those cases, because it is not valid.)

Otherwise you may enter true. This updates the configuration in config system ha on the primary unit, making this secondary unit the primary backup.

"<shared-password_str>"

Enter the password for this HA cluster.

Before FortiMail units in the HA cluster synchronize with each other, they verify that they have the same password. This prevents them from accidentally synchronizing with the wrong cluster. Therefore this must match the password "<password_str>" that was configured on other units in the cluster.

<unit-name_str> Enter the name of this FortiMail unit in the HA cluster. This may be different from the FQDN or hostname, in order to distinguish units in an HA cluster. This updates the configuration in config system ha.

[<group_name>]

Enter the name of the group of HA clusters that you want this FortiMail unit to join.

This applies only if, on the primary unit, type {group | member} is group. Otherwise leave it empty.

Related topics

system ha

ha hb reset-status