Fortios v0.0.6, Jul 9 24

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.system.getHa

Explore with Pulumi AI

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

Using getHa

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getHa(args: GetHaArgs, opts?: InvokeOptions): Promise<GetHaResult>
function getHaOutput(args: GetHaOutputArgs, opts?: InvokeOptions): Output<GetHaResult>

def get_ha(vdomparam: Optional[str] = None,
           opts: Optional[InvokeOptions] = None) -> GetHaResult
def get_ha_output(vdomparam: Optional[pulumi.Input[str]] = None,
           opts: Optional[InvokeOptions] = None) -> Output[GetHaResult]

func LookupHa(ctx *Context, args *LookupHaArgs, opts ...InvokeOption) (*LookupHaResult, error)
func LookupHaOutput(ctx *Context, args *LookupHaOutputArgs, opts ...InvokeOption) LookupHaResultOutput

> Note: This function is named LookupHa in the Go SDK.

public static class GetHa 
{
    public static Task<GetHaResult> InvokeAsync(GetHaArgs args, InvokeOptions? opts = null)
    public static Output<GetHaResult> Invoke(GetHaInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetHaResult> getHa(GetHaArgs args, InvokeOptions options)
public static Output<GetHaResult> getHa(GetHaArgs args, InvokeOptions options)

fn::invoke:
  function: fortios:system/getHa:getHa
  arguments:
    # arguments dictionary

The following arguments are supported:

Vdomparam string: Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Vdomparam string: Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

vdomparam String: Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

vdomparam string: Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

vdomparam str: Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

vdomparam String: Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

getHa Result

The following output properties are available:

Arps int: Number of gratuitous ARPs (1 - 60). Lower to reduce traffic. Higher to reduce failover time.
ArpsInterval int: Time between gratuitous ARPs (1 - 20 sec). Lower to reduce failover time. Higher to reduce traffic.
Authentication string: Enable/disable heartbeat message authentication.
CpuThreshold string: Dynamic weighted load balancing CPU usage weight and high and low thresholds.
Encryption string: Enable/disable heartbeat message encryption.
EvpnTtl int: HA EVPN FDB TTL on primary box (5 - 3600 sec).
FailoverHoldTime int: Time to wait before failover (0 - 300 sec, default = 0), to avoid flip.
FtpProxyThreshold string: Dynamic weighted load balancing weight and high and low number of FTP proxy sessions.
GratuitousArps string: Enable/disable gratuitous ARPs. Disable if link-failed-signal enabled.
GroupId int: Cluster group ID (0 - 255). Must be the same for all members.
GroupName string: Cluster group name. Must be the same for all members.
HaDirect string: Enable/disable using ha-mgmt interface for syslog, SNMP, remote authentication (RADIUS), FortiAnalyzer, and FortiSandbox.
HaEthType string: HA heartbeat packet Ethertype (4-digit hex).
HaMgmtInterfaces List<Pulumiverse.Fortios.System.Outputs.GetHaHaMgmtInterface>: Reserve interfaces to manage individual cluster units. The structure of ha_mgmt_interfaces block is documented below.
HaMgmtStatus string: Enable to reserve interfaces to manage individual cluster units.
HaUptimeDiffMargin int: Normally you would only reduce this value for failover testing.
HbInterval int: Time between sending heartbeat packets (1 - 20 (100*ms)). Increase to reduce false positives.
HbIntervalInMilliseconds string: Number of milliseconds for each heartbeat interval: 100ms or 10ms.
HbLostThreshold int: Number of lost heartbeats to signal a failure (1 - 60). Increase to reduce false positives.
Hbdev string: Heartbeat interfaces. Must be the same for all members.
HcEthType string: Transparent mode HA heartbeat packet Ethertype (4-digit hex).
HelloHolddown int: Time to wait before changing from hello to work state (5 - 300 sec).
HttpProxyThreshold string: Dynamic weighted load balancing weight and high and low number of HTTP proxy sessions.
Id string: The provider-assigned unique ID for this managed resource.
ImapProxyThreshold string: Dynamic weighted load balancing weight and high and low number of IMAP proxy sessions.
InterClusterSessionSync string: Enable/disable synchronization of sessions among HA clusters.
IpsecPhase2Proposal string: IPsec phase2 proposal.
Key string: key
L2epEthType string: Telnet session HA heartbeat packet Ethertype (4-digit hex).
LinkFailedSignal string: Enable to shut down all interfaces for 1 sec after a failover. Use if gratuitous ARPs do not update network.
LoadBalanceAll string: Enable to load balance TCP sessions. Disable to load balance proxy sessions only.
LogicalSn string: Enable/disable usage of the logical serial number.
MemoryBasedFailover string: Enable/disable memory based failover.
MemoryCompatibleMode string: Enable/disable memory compatible mode.
MemoryFailoverFlipTimeout int: Time to wait between subsequent memory based failovers in minutes (6 - 2147483647, default = 6).
MemoryFailoverMonitorPeriod int: Duration of high memory usage before memory based failover is triggered in seconds (1 - 300, default = 60).
MemoryFailoverSampleRate int: Rate at which memory usage is sampled in order to measure memory usage in seconds (1 - 60, default = 1).
MemoryFailoverThreshold int: Memory usage threshold to trigger memory based failover (0 means using conserve mode threshold in system.global).
MemoryThreshold string: Dynamic weighted load balancing memory usage weight and high and low thresholds.
Mode string: HA mode. Must be the same for all members. FGSP requires standalone.
Monitor string: Interfaces to check for port monitoring (or link failure).
MulticastTtl int: HA multicast TTL on master (5 - 3600 sec).
NntpProxyThreshold string: Dynamic weighted load balancing weight and high and low number of NNTP proxy sessions.
Override string: Enable and increase the priority of the unit that should always be primary (master).
OverrideWaitTime int: Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
Password string: Cluster password. Must be the same for all members.
PingserverFailoverThreshold int: Remote IP monitoring failover threshold (0 - 50).
PingserverFlipTimeout int: Time to wait in minutes before renegotiating after a remote IP monitoring failover.
PingserverMonitorInterface string: Interfaces to check for remote IP monitoring.
PingserverSecondaryForceReset string: Enable to force the cluster to negotiate after a remote IP monitoring failover.
PingserverSlaveForceReset string: Enable to force the cluster to negotiate after a remote IP monitoring failover.
Pop3ProxyThreshold string: Dynamic weighted load balancing weight and high and low number of POP3 proxy sessions.
Priority int: Increase the priority to select the primary unit (0 - 255).
RouteHold int: Time to wait between routing table updates to the cluster (0 - 3600 sec).
RouteTtl int: TTL for primary unit routes (5 - 3600 sec). Increase to maintain active routes during failover.
RouteWait int: Time to wait before sending new routes to the cluster (0 - 3600 sec).
Schedule string: Type of A-A load balancing. Use none if you have external load balancers.
SecondaryVclusters List<Pulumiverse.Fortios.System.Outputs.GetHaSecondaryVcluster>: Configure virtual cluster 2. The structure of secondary_vcluster block is documented below.
SessionPickup string: Enable/disable session pickup. Enabling it can reduce session down time when fail over happens.
SessionPickupConnectionless string: Enable/disable UDP and ICMP session sync.
SessionPickupDelay string: Enable to sync sessions longer than 30 sec. Only longer lived sessions need to be synced.
SessionPickupExpectation string: Enable/disable session helper expectation session sync for FGSP.
SessionPickupNat string: Enable/disable NAT session sync for FGSP.
SessionSyncDev string: Offload session-sync process to kernel and sync sessions using connected interface(s) directly.
SmtpProxyThreshold string: Dynamic weighted load balancing weight and high and low number of SMTP proxy sessions.
SsdFailover string: Enable/disable automatic HA failover on SSD disk failure.
StandaloneConfigSync string: Enable/disable FGSP configuration synchronization.
StandaloneMgmtVdom string: Enable/disable standalone management VDOM.
SyncConfig string: Enable/disable configuration synchronization.
SyncPacketBalance string: Enable/disable HA packet distribution to multiple CPUs.
UnicastGateway string: Default route gateway for unicast interface.
UnicastHb string: Enable/disable unicast heartbeat.
UnicastHbNetmask string: Unicast heartbeat netmask.
UnicastHbPeerip string: Unicast heartbeat peer IP.
UnicastPeers List<Pulumiverse.Fortios.System.Outputs.GetHaUnicastPeer>: Number of unicast peers. The structure of unicast_peers block is documented below.
UnicastStatus string: Enable/disable unicast connection.
UninterruptiblePrimaryWait int: Number of minutes the primary HA unit waits before the secondary HA unit is considered upgraded and the system is started before starting its own upgrade (1 - 300, default = 30).
UninterruptibleUpgrade string: Enable to upgrade a cluster without blocking network traffic.
UpgradeMode string: The mode to upgrade a cluster.
Vcluster2 string: Enable/disable virtual cluster 2 for virtual clustering.
VclusterId int: Cluster ID.
VclusterStatus string: Enable/disable virtual cluster for virtual clustering.
Vclusters List<Pulumiverse.Fortios.System.Outputs.GetHaVcluster>: Virtual cluster table. The structure of vcluster block is documented below.
Vdom string: VDOMs in virtual cluster 2.
Weight string: Weight-round-robin weight for each cluster unit. Syntax .
Vdomparam string

Arps int: Number of gratuitous ARPs (1 - 60). Lower to reduce traffic. Higher to reduce failover time.
ArpsInterval int: Time between gratuitous ARPs (1 - 20 sec). Lower to reduce failover time. Higher to reduce traffic.
Authentication string: Enable/disable heartbeat message authentication.
CpuThreshold string: Dynamic weighted load balancing CPU usage weight and high and low thresholds.
Encryption string: Enable/disable heartbeat message encryption.
EvpnTtl int: HA EVPN FDB TTL on primary box (5 - 3600 sec).
FailoverHoldTime int: Time to wait before failover (0 - 300 sec, default = 0), to avoid flip.
FtpProxyThreshold string: Dynamic weighted load balancing weight and high and low number of FTP proxy sessions.
GratuitousArps string: Enable/disable gratuitous ARPs. Disable if link-failed-signal enabled.
GroupId int: Cluster group ID (0 - 255). Must be the same for all members.
GroupName string: Cluster group name. Must be the same for all members.
HaDirect string: Enable/disable using ha-mgmt interface for syslog, SNMP, remote authentication (RADIUS), FortiAnalyzer, and FortiSandbox.
HaEthType string: HA heartbeat packet Ethertype (4-digit hex).
HaMgmtInterfaces []GetHaHaMgmtInterface: Reserve interfaces to manage individual cluster units. The structure of ha_mgmt_interfaces block is documented below.
HaMgmtStatus string: Enable to reserve interfaces to manage individual cluster units.
HaUptimeDiffMargin int: Normally you would only reduce this value for failover testing.
HbInterval int: Time between sending heartbeat packets (1 - 20 (100*ms)). Increase to reduce false positives.
HbIntervalInMilliseconds string: Number of milliseconds for each heartbeat interval: 100ms or 10ms.
HbLostThreshold int: Number of lost heartbeats to signal a failure (1 - 60). Increase to reduce false positives.
Hbdev string: Heartbeat interfaces. Must be the same for all members.
HcEthType string: Transparent mode HA heartbeat packet Ethertype (4-digit hex).
HelloHolddown int: Time to wait before changing from hello to work state (5 - 300 sec).
HttpProxyThreshold string: Dynamic weighted load balancing weight and high and low number of HTTP proxy sessions.
Id string: The provider-assigned unique ID for this managed resource.
ImapProxyThreshold string: Dynamic weighted load balancing weight and high and low number of IMAP proxy sessions.
InterClusterSessionSync string: Enable/disable synchronization of sessions among HA clusters.
IpsecPhase2Proposal string: IPsec phase2 proposal.
Key string: key
L2epEthType string: Telnet session HA heartbeat packet Ethertype (4-digit hex).
LinkFailedSignal string: Enable to shut down all interfaces for 1 sec after a failover. Use if gratuitous ARPs do not update network.
LoadBalanceAll string: Enable to load balance TCP sessions. Disable to load balance proxy sessions only.
LogicalSn string: Enable/disable usage of the logical serial number.
MemoryBasedFailover string: Enable/disable memory based failover.
MemoryCompatibleMode string: Enable/disable memory compatible mode.
MemoryFailoverFlipTimeout int: Time to wait between subsequent memory based failovers in minutes (6 - 2147483647, default = 6).
MemoryFailoverMonitorPeriod int: Duration of high memory usage before memory based failover is triggered in seconds (1 - 300, default = 60).
MemoryFailoverSampleRate int: Rate at which memory usage is sampled in order to measure memory usage in seconds (1 - 60, default = 1).
MemoryFailoverThreshold int: Memory usage threshold to trigger memory based failover (0 means using conserve mode threshold in system.global).
MemoryThreshold string: Dynamic weighted load balancing memory usage weight and high and low thresholds.
Mode string: HA mode. Must be the same for all members. FGSP requires standalone.
Monitor string: Interfaces to check for port monitoring (or link failure).
MulticastTtl int: HA multicast TTL on master (5 - 3600 sec).
NntpProxyThreshold string: Dynamic weighted load balancing weight and high and low number of NNTP proxy sessions.
Override string: Enable and increase the priority of the unit that should always be primary (master).
OverrideWaitTime int: Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
Password string: Cluster password. Must be the same for all members.
PingserverFailoverThreshold int: Remote IP monitoring failover threshold (0 - 50).
PingserverFlipTimeout int: Time to wait in minutes before renegotiating after a remote IP monitoring failover.
PingserverMonitorInterface string: Interfaces to check for remote IP monitoring.
PingserverSecondaryForceReset string: Enable to force the cluster to negotiate after a remote IP monitoring failover.
PingserverSlaveForceReset string: Enable to force the cluster to negotiate after a remote IP monitoring failover.
Pop3ProxyThreshold string: Dynamic weighted load balancing weight and high and low number of POP3 proxy sessions.
Priority int: Increase the priority to select the primary unit (0 - 255).
RouteHold int: Time to wait between routing table updates to the cluster (0 - 3600 sec).
RouteTtl int: TTL for primary unit routes (5 - 3600 sec). Increase to maintain active routes during failover.
RouteWait int: Time to wait before sending new routes to the cluster (0 - 3600 sec).
Schedule string: Type of A-A load balancing. Use none if you have external load balancers.
SecondaryVclusters []GetHaSecondaryVcluster: Configure virtual cluster 2. The structure of secondary_vcluster block is documented below.
SessionPickup string: Enable/disable session pickup. Enabling it can reduce session down time when fail over happens.
SessionPickupConnectionless string: Enable/disable UDP and ICMP session sync.
SessionPickupDelay string: Enable to sync sessions longer than 30 sec. Only longer lived sessions need to be synced.
SessionPickupExpectation string: Enable/disable session helper expectation session sync for FGSP.
SessionPickupNat string: Enable/disable NAT session sync for FGSP.
SessionSyncDev string: Offload session-sync process to kernel and sync sessions using connected interface(s) directly.
SmtpProxyThreshold string: Dynamic weighted load balancing weight and high and low number of SMTP proxy sessions.
SsdFailover string: Enable/disable automatic HA failover on SSD disk failure.
StandaloneConfigSync string: Enable/disable FGSP configuration synchronization.
StandaloneMgmtVdom string: Enable/disable standalone management VDOM.
SyncConfig string: Enable/disable configuration synchronization.
SyncPacketBalance string: Enable/disable HA packet distribution to multiple CPUs.
UnicastGateway string: Default route gateway for unicast interface.
UnicastHb string: Enable/disable unicast heartbeat.
UnicastHbNetmask string: Unicast heartbeat netmask.
UnicastHbPeerip string: Unicast heartbeat peer IP.
UnicastPeers []GetHaUnicastPeer: Number of unicast peers. The structure of unicast_peers block is documented below.
UnicastStatus string: Enable/disable unicast connection.
UninterruptiblePrimaryWait int: Number of minutes the primary HA unit waits before the secondary HA unit is considered upgraded and the system is started before starting its own upgrade (1 - 300, default = 30).
UninterruptibleUpgrade string: Enable to upgrade a cluster without blocking network traffic.
UpgradeMode string: The mode to upgrade a cluster.
Vcluster2 string: Enable/disable virtual cluster 2 for virtual clustering.
VclusterId int: Cluster ID.
VclusterStatus string: Enable/disable virtual cluster for virtual clustering.
Vclusters []GetHaVcluster: Virtual cluster table. The structure of vcluster block is documented below.
Vdom string: VDOMs in virtual cluster 2.
Weight string: Weight-round-robin weight for each cluster unit. Syntax .
Vdomparam string

arps Integer: Number of gratuitous ARPs (1 - 60). Lower to reduce traffic. Higher to reduce failover time.
arpsInterval Integer: Time between gratuitous ARPs (1 - 20 sec). Lower to reduce failover time. Higher to reduce traffic.
authentication String: Enable/disable heartbeat message authentication.
cpuThreshold String: Dynamic weighted load balancing CPU usage weight and high and low thresholds.
encryption String: Enable/disable heartbeat message encryption.
evpnTtl Integer: HA EVPN FDB TTL on primary box (5 - 3600 sec).
failoverHoldTime Integer: Time to wait before failover (0 - 300 sec, default = 0), to avoid flip.
ftpProxyThreshold String: Dynamic weighted load balancing weight and high and low number of FTP proxy sessions.
gratuitousArps String: Enable/disable gratuitous ARPs. Disable if link-failed-signal enabled.
groupId Integer: Cluster group ID (0 - 255). Must be the same for all members.
groupName String: Cluster group name. Must be the same for all members.
haDirect String: Enable/disable using ha-mgmt interface for syslog, SNMP, remote authentication (RADIUS), FortiAnalyzer, and FortiSandbox.
haEthType String: HA heartbeat packet Ethertype (4-digit hex).
haMgmtInterfaces List<GetHaHaMgmtInterface>: Reserve interfaces to manage individual cluster units. The structure of ha_mgmt_interfaces block is documented below.
haMgmtStatus String: Enable to reserve interfaces to manage individual cluster units.
haUptimeDiffMargin Integer: Normally you would only reduce this value for failover testing.
hbInterval Integer: Time between sending heartbeat packets (1 - 20 (100*ms)). Increase to reduce false positives.
hbIntervalInMilliseconds String: Number of milliseconds for each heartbeat interval: 100ms or 10ms.
hbLostThreshold Integer: Number of lost heartbeats to signal a failure (1 - 60). Increase to reduce false positives.
hbdev String: Heartbeat interfaces. Must be the same for all members.
hcEthType String: Transparent mode HA heartbeat packet Ethertype (4-digit hex).
helloHolddown Integer: Time to wait before changing from hello to work state (5 - 300 sec).
httpProxyThreshold String: Dynamic weighted load balancing weight and high and low number of HTTP proxy sessions.
id String: The provider-assigned unique ID for this managed resource.
imapProxyThreshold String: Dynamic weighted load balancing weight and high and low number of IMAP proxy sessions.
interClusterSessionSync String: Enable/disable synchronization of sessions among HA clusters.
ipsecPhase2Proposal String: IPsec phase2 proposal.
key String: key
l2epEthType String: Telnet session HA heartbeat packet Ethertype (4-digit hex).
linkFailedSignal String: Enable to shut down all interfaces for 1 sec after a failover. Use if gratuitous ARPs do not update network.
loadBalanceAll String: Enable to load balance TCP sessions. Disable to load balance proxy sessions only.
logicalSn String: Enable/disable usage of the logical serial number.
memoryBasedFailover String: Enable/disable memory based failover.
memoryCompatibleMode String: Enable/disable memory compatible mode.
memoryFailoverFlipTimeout Integer: Time to wait between subsequent memory based failovers in minutes (6 - 2147483647, default = 6).
memoryFailoverMonitorPeriod Integer: Duration of high memory usage before memory based failover is triggered in seconds (1 - 300, default = 60).
memoryFailoverSampleRate Integer: Rate at which memory usage is sampled in order to measure memory usage in seconds (1 - 60, default = 1).
memoryFailoverThreshold Integer: Memory usage threshold to trigger memory based failover (0 means using conserve mode threshold in system.global).
memoryThreshold String: Dynamic weighted load balancing memory usage weight and high and low thresholds.
mode String: HA mode. Must be the same for all members. FGSP requires standalone.
monitor String: Interfaces to check for port monitoring (or link failure).
multicastTtl Integer: HA multicast TTL on master (5 - 3600 sec).
nntpProxyThreshold String: Dynamic weighted load balancing weight and high and low number of NNTP proxy sessions.
override String: Enable and increase the priority of the unit that should always be primary (master).
overrideWaitTime Integer: Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
password String: Cluster password. Must be the same for all members.
pingserverFailoverThreshold Integer: Remote IP monitoring failover threshold (0 - 50).
pingserverFlipTimeout Integer: Time to wait in minutes before renegotiating after a remote IP monitoring failover.
pingserverMonitorInterface String: Interfaces to check for remote IP monitoring.
pingserverSecondaryForceReset String: Enable to force the cluster to negotiate after a remote IP monitoring failover.
pingserverSlaveForceReset String: Enable to force the cluster to negotiate after a remote IP monitoring failover.
pop3ProxyThreshold String: Dynamic weighted load balancing weight and high and low number of POP3 proxy sessions.
priority Integer: Increase the priority to select the primary unit (0 - 255).
routeHold Integer: Time to wait between routing table updates to the cluster (0 - 3600 sec).
routeTtl Integer: TTL for primary unit routes (5 - 3600 sec). Increase to maintain active routes during failover.
routeWait Integer: Time to wait before sending new routes to the cluster (0 - 3600 sec).
schedule String: Type of A-A load balancing. Use none if you have external load balancers.
secondaryVclusters List<GetHaSecondaryVcluster>: Configure virtual cluster 2. The structure of secondary_vcluster block is documented below.
sessionPickup String: Enable/disable session pickup. Enabling it can reduce session down time when fail over happens.
sessionPickupConnectionless String: Enable/disable UDP and ICMP session sync.
sessionPickupDelay String: Enable to sync sessions longer than 30 sec. Only longer lived sessions need to be synced.
sessionPickupExpectation String: Enable/disable session helper expectation session sync for FGSP.
sessionPickupNat String: Enable/disable NAT session sync for FGSP.
sessionSyncDev String: Offload session-sync process to kernel and sync sessions using connected interface(s) directly.
smtpProxyThreshold String: Dynamic weighted load balancing weight and high and low number of SMTP proxy sessions.
ssdFailover String: Enable/disable automatic HA failover on SSD disk failure.
standaloneConfigSync String: Enable/disable FGSP configuration synchronization.
standaloneMgmtVdom String: Enable/disable standalone management VDOM.
syncConfig String: Enable/disable configuration synchronization.
syncPacketBalance String: Enable/disable HA packet distribution to multiple CPUs.
unicastGateway String: Default route gateway for unicast interface.
unicastHb String: Enable/disable unicast heartbeat.
unicastHbNetmask String: Unicast heartbeat netmask.
unicastHbPeerip String: Unicast heartbeat peer IP.
unicastPeers List<GetHaUnicastPeer>: Number of unicast peers. The structure of unicast_peers block is documented below.
unicastStatus String: Enable/disable unicast connection.
uninterruptiblePrimaryWait Integer: Number of minutes the primary HA unit waits before the secondary HA unit is considered upgraded and the system is started before starting its own upgrade (1 - 300, default = 30).
uninterruptibleUpgrade String: Enable to upgrade a cluster without blocking network traffic.
upgradeMode String: The mode to upgrade a cluster.
vcluster2 String: Enable/disable virtual cluster 2 for virtual clustering.
vclusterId Integer: Cluster ID.
vclusterStatus String: Enable/disable virtual cluster for virtual clustering.
vclusters List<GetHaVcluster>: Virtual cluster table. The structure of vcluster block is documented below.
vdom String: VDOMs in virtual cluster 2.
weight String: Weight-round-robin weight for each cluster unit. Syntax .
vdomparam String

arps number: Number of gratuitous ARPs (1 - 60). Lower to reduce traffic. Higher to reduce failover time.
arpsInterval number: Time between gratuitous ARPs (1 - 20 sec). Lower to reduce failover time. Higher to reduce traffic.
authentication string: Enable/disable heartbeat message authentication.
cpuThreshold string: Dynamic weighted load balancing CPU usage weight and high and low thresholds.
encryption string: Enable/disable heartbeat message encryption.
evpnTtl number: HA EVPN FDB TTL on primary box (5 - 3600 sec).
failoverHoldTime number: Time to wait before failover (0 - 300 sec, default = 0), to avoid flip.
ftpProxyThreshold string: Dynamic weighted load balancing weight and high and low number of FTP proxy sessions.
gratuitousArps string: Enable/disable gratuitous ARPs. Disable if link-failed-signal enabled.
groupId number: Cluster group ID (0 - 255). Must be the same for all members.
groupName string: Cluster group name. Must be the same for all members.
haDirect string: Enable/disable using ha-mgmt interface for syslog, SNMP, remote authentication (RADIUS), FortiAnalyzer, and FortiSandbox.
haEthType string: HA heartbeat packet Ethertype (4-digit hex).
haMgmtInterfaces GetHaHaMgmtInterface[]: Reserve interfaces to manage individual cluster units. The structure of ha_mgmt_interfaces block is documented below.
haMgmtStatus string: Enable to reserve interfaces to manage individual cluster units.
haUptimeDiffMargin number: Normally you would only reduce this value for failover testing.
hbInterval number: Time between sending heartbeat packets (1 - 20 (100*ms)). Increase to reduce false positives.
hbIntervalInMilliseconds string: Number of milliseconds for each heartbeat interval: 100ms or 10ms.
hbLostThreshold number: Number of lost heartbeats to signal a failure (1 - 60). Increase to reduce false positives.
hbdev string: Heartbeat interfaces. Must be the same for all members.
hcEthType string: Transparent mode HA heartbeat packet Ethertype (4-digit hex).
helloHolddown number: Time to wait before changing from hello to work state (5 - 300 sec).
httpProxyThreshold string: Dynamic weighted load balancing weight and high and low number of HTTP proxy sessions.
id string: The provider-assigned unique ID for this managed resource.
imapProxyThreshold string: Dynamic weighted load balancing weight and high and low number of IMAP proxy sessions.
interClusterSessionSync string: Enable/disable synchronization of sessions among HA clusters.
ipsecPhase2Proposal string: IPsec phase2 proposal.
key string: key
l2epEthType string: Telnet session HA heartbeat packet Ethertype (4-digit hex).
linkFailedSignal string: Enable to shut down all interfaces for 1 sec after a failover. Use if gratuitous ARPs do not update network.
loadBalanceAll string: Enable to load balance TCP sessions. Disable to load balance proxy sessions only.
logicalSn string: Enable/disable usage of the logical serial number.
memoryBasedFailover string: Enable/disable memory based failover.
memoryCompatibleMode string: Enable/disable memory compatible mode.
memoryFailoverFlipTimeout number: Time to wait between subsequent memory based failovers in minutes (6 - 2147483647, default = 6).
memoryFailoverMonitorPeriod number: Duration of high memory usage before memory based failover is triggered in seconds (1 - 300, default = 60).
memoryFailoverSampleRate number: Rate at which memory usage is sampled in order to measure memory usage in seconds (1 - 60, default = 1).
memoryFailoverThreshold number: Memory usage threshold to trigger memory based failover (0 means using conserve mode threshold in system.global).
memoryThreshold string: Dynamic weighted load balancing memory usage weight and high and low thresholds.
mode string: HA mode. Must be the same for all members. FGSP requires standalone.
monitor string: Interfaces to check for port monitoring (or link failure).
multicastTtl number: HA multicast TTL on master (5 - 3600 sec).
nntpProxyThreshold string: Dynamic weighted load balancing weight and high and low number of NNTP proxy sessions.
override string: Enable and increase the priority of the unit that should always be primary (master).
overrideWaitTime number: Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
password string: Cluster password. Must be the same for all members.
pingserverFailoverThreshold number: Remote IP monitoring failover threshold (0 - 50).
pingserverFlipTimeout number: Time to wait in minutes before renegotiating after a remote IP monitoring failover.
pingserverMonitorInterface string: Interfaces to check for remote IP monitoring.
pingserverSecondaryForceReset string: Enable to force the cluster to negotiate after a remote IP monitoring failover.
pingserverSlaveForceReset string: Enable to force the cluster to negotiate after a remote IP monitoring failover.
pop3ProxyThreshold string: Dynamic weighted load balancing weight and high and low number of POP3 proxy sessions.
priority number: Increase the priority to select the primary unit (0 - 255).
routeHold number: Time to wait between routing table updates to the cluster (0 - 3600 sec).
routeTtl number: TTL for primary unit routes (5 - 3600 sec). Increase to maintain active routes during failover.
routeWait number: Time to wait before sending new routes to the cluster (0 - 3600 sec).
schedule string: Type of A-A load balancing. Use none if you have external load balancers.
secondaryVclusters GetHaSecondaryVcluster[]: Configure virtual cluster 2. The structure of secondary_vcluster block is documented below.
sessionPickup string: Enable/disable session pickup. Enabling it can reduce session down time when fail over happens.
sessionPickupConnectionless string: Enable/disable UDP and ICMP session sync.
sessionPickupDelay string: Enable to sync sessions longer than 30 sec. Only longer lived sessions need to be synced.
sessionPickupExpectation string: Enable/disable session helper expectation session sync for FGSP.
sessionPickupNat string: Enable/disable NAT session sync for FGSP.
sessionSyncDev string: Offload session-sync process to kernel and sync sessions using connected interface(s) directly.
smtpProxyThreshold string: Dynamic weighted load balancing weight and high and low number of SMTP proxy sessions.
ssdFailover string: Enable/disable automatic HA failover on SSD disk failure.
standaloneConfigSync string: Enable/disable FGSP configuration synchronization.
standaloneMgmtVdom string: Enable/disable standalone management VDOM.
syncConfig string: Enable/disable configuration synchronization.
syncPacketBalance string: Enable/disable HA packet distribution to multiple CPUs.
unicastGateway string: Default route gateway for unicast interface.
unicastHb string: Enable/disable unicast heartbeat.
unicastHbNetmask string: Unicast heartbeat netmask.
unicastHbPeerip string: Unicast heartbeat peer IP.
unicastPeers GetHaUnicastPeer[]: Number of unicast peers. The structure of unicast_peers block is documented below.
unicastStatus string: Enable/disable unicast connection.
uninterruptiblePrimaryWait number: Number of minutes the primary HA unit waits before the secondary HA unit is considered upgraded and the system is started before starting its own upgrade (1 - 300, default = 30).
uninterruptibleUpgrade string: Enable to upgrade a cluster without blocking network traffic.
upgradeMode string: The mode to upgrade a cluster.
vcluster2 string: Enable/disable virtual cluster 2 for virtual clustering.
vclusterId number: Cluster ID.
vclusterStatus string: Enable/disable virtual cluster for virtual clustering.
vclusters GetHaVcluster[]: Virtual cluster table. The structure of vcluster block is documented below.
vdom string: VDOMs in virtual cluster 2.
weight string: Weight-round-robin weight for each cluster unit. Syntax .
vdomparam string

arps int: Number of gratuitous ARPs (1 - 60). Lower to reduce traffic. Higher to reduce failover time.
arps_interval int: Time between gratuitous ARPs (1 - 20 sec). Lower to reduce failover time. Higher to reduce traffic.
authentication str: Enable/disable heartbeat message authentication.
cpu_threshold str: Dynamic weighted load balancing CPU usage weight and high and low thresholds.
encryption str: Enable/disable heartbeat message encryption.
evpn_ttl int: HA EVPN FDB TTL on primary box (5 - 3600 sec).
failover_hold_time int: Time to wait before failover (0 - 300 sec, default = 0), to avoid flip.
ftp_proxy_threshold str: Dynamic weighted load balancing weight and high and low number of FTP proxy sessions.
gratuitous_arps str: Enable/disable gratuitous ARPs. Disable if link-failed-signal enabled.
group_id int: Cluster group ID (0 - 255). Must be the same for all members.
group_name str: Cluster group name. Must be the same for all members.
ha_direct str: Enable/disable using ha-mgmt interface for syslog, SNMP, remote authentication (RADIUS), FortiAnalyzer, and FortiSandbox.
ha_eth_type str: HA heartbeat packet Ethertype (4-digit hex).
ha_mgmt_interfaces Sequence[GetHaHaMgmtInterface]: Reserve interfaces to manage individual cluster units. The structure of ha_mgmt_interfaces block is documented below.
ha_mgmt_status str: Enable to reserve interfaces to manage individual cluster units.
ha_uptime_diff_margin int: Normally you would only reduce this value for failover testing.
hb_interval int: Time between sending heartbeat packets (1 - 20 (100*ms)). Increase to reduce false positives.
hb_interval_in_milliseconds str: Number of milliseconds for each heartbeat interval: 100ms or 10ms.
hb_lost_threshold int: Number of lost heartbeats to signal a failure (1 - 60). Increase to reduce false positives.
hbdev str: Heartbeat interfaces. Must be the same for all members.
hc_eth_type str: Transparent mode HA heartbeat packet Ethertype (4-digit hex).
hello_holddown int: Time to wait before changing from hello to work state (5 - 300 sec).
http_proxy_threshold str: Dynamic weighted load balancing weight and high and low number of HTTP proxy sessions.
id str: The provider-assigned unique ID for this managed resource.
imap_proxy_threshold str: Dynamic weighted load balancing weight and high and low number of IMAP proxy sessions.
inter_cluster_session_sync str: Enable/disable synchronization of sessions among HA clusters.
ipsec_phase2_proposal str: IPsec phase2 proposal.
key str: key
l2ep_eth_type str: Telnet session HA heartbeat packet Ethertype (4-digit hex).
link_failed_signal str: Enable to shut down all interfaces for 1 sec after a failover. Use if gratuitous ARPs do not update network.
load_balance_all str: Enable to load balance TCP sessions. Disable to load balance proxy sessions only.
logical_sn str: Enable/disable usage of the logical serial number.
memory_based_failover str: Enable/disable memory based failover.
memory_compatible_mode str: Enable/disable memory compatible mode.
memory_failover_flip_timeout int: Time to wait between subsequent memory based failovers in minutes (6 - 2147483647, default = 6).
memory_failover_monitor_period int: Duration of high memory usage before memory based failover is triggered in seconds (1 - 300, default = 60).
memory_failover_sample_rate int: Rate at which memory usage is sampled in order to measure memory usage in seconds (1 - 60, default = 1).
memory_failover_threshold int: Memory usage threshold to trigger memory based failover (0 means using conserve mode threshold in system.global).
memory_threshold str: Dynamic weighted load balancing memory usage weight and high and low thresholds.
mode str: HA mode. Must be the same for all members. FGSP requires standalone.
monitor str: Interfaces to check for port monitoring (or link failure).
multicast_ttl int: HA multicast TTL on master (5 - 3600 sec).
nntp_proxy_threshold str: Dynamic weighted load balancing weight and high and low number of NNTP proxy sessions.
override str: Enable and increase the priority of the unit that should always be primary (master).
override_wait_time int: Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
password str: Cluster password. Must be the same for all members.
pingserver_failover_threshold int: Remote IP monitoring failover threshold (0 - 50).
pingserver_flip_timeout int: Time to wait in minutes before renegotiating after a remote IP monitoring failover.
pingserver_monitor_interface str: Interfaces to check for remote IP monitoring.
pingserver_secondary_force_reset str: Enable to force the cluster to negotiate after a remote IP monitoring failover.
pingserver_slave_force_reset str: Enable to force the cluster to negotiate after a remote IP monitoring failover.
pop3_proxy_threshold str: Dynamic weighted load balancing weight and high and low number of POP3 proxy sessions.
priority int: Increase the priority to select the primary unit (0 - 255).
route_hold int: Time to wait between routing table updates to the cluster (0 - 3600 sec).
route_ttl int: TTL for primary unit routes (5 - 3600 sec). Increase to maintain active routes during failover.
route_wait int: Time to wait before sending new routes to the cluster (0 - 3600 sec).
schedule str: Type of A-A load balancing. Use none if you have external load balancers.
secondary_vclusters Sequence[GetHaSecondaryVcluster]: Configure virtual cluster 2. The structure of secondary_vcluster block is documented below.
session_pickup str: Enable/disable session pickup. Enabling it can reduce session down time when fail over happens.
session_pickup_connectionless str: Enable/disable UDP and ICMP session sync.
session_pickup_delay str: Enable to sync sessions longer than 30 sec. Only longer lived sessions need to be synced.
session_pickup_expectation str: Enable/disable session helper expectation session sync for FGSP.
session_pickup_nat str: Enable/disable NAT session sync for FGSP.
session_sync_dev str: Offload session-sync process to kernel and sync sessions using connected interface(s) directly.
smtp_proxy_threshold str: Dynamic weighted load balancing weight and high and low number of SMTP proxy sessions.
ssd_failover str: Enable/disable automatic HA failover on SSD disk failure.
standalone_config_sync str: Enable/disable FGSP configuration synchronization.
standalone_mgmt_vdom str: Enable/disable standalone management VDOM.
sync_config str: Enable/disable configuration synchronization.
sync_packet_balance str: Enable/disable HA packet distribution to multiple CPUs.
unicast_gateway str: Default route gateway for unicast interface.
unicast_hb str: Enable/disable unicast heartbeat.
unicast_hb_netmask str: Unicast heartbeat netmask.
unicast_hb_peerip str: Unicast heartbeat peer IP.
unicast_peers Sequence[GetHaUnicastPeer]: Number of unicast peers. The structure of unicast_peers block is documented below.
unicast_status str: Enable/disable unicast connection.
uninterruptible_primary_wait int: Number of minutes the primary HA unit waits before the secondary HA unit is considered upgraded and the system is started before starting its own upgrade (1 - 300, default = 30).
uninterruptible_upgrade str: Enable to upgrade a cluster without blocking network traffic.
upgrade_mode str: The mode to upgrade a cluster.
vcluster2 str: Enable/disable virtual cluster 2 for virtual clustering.
vcluster_id int: Cluster ID.
vcluster_status str: Enable/disable virtual cluster for virtual clustering.
vclusters Sequence[GetHaVcluster]: Virtual cluster table. The structure of vcluster block is documented below.
vdom str: VDOMs in virtual cluster 2.
weight str: Weight-round-robin weight for each cluster unit. Syntax .
vdomparam str

arps Number: Number of gratuitous ARPs (1 - 60). Lower to reduce traffic. Higher to reduce failover time.
arpsInterval Number: Time between gratuitous ARPs (1 - 20 sec). Lower to reduce failover time. Higher to reduce traffic.
authentication String: Enable/disable heartbeat message authentication.
cpuThreshold String: Dynamic weighted load balancing CPU usage weight and high and low thresholds.
encryption String: Enable/disable heartbeat message encryption.
evpnTtl Number: HA EVPN FDB TTL on primary box (5 - 3600 sec).
failoverHoldTime Number: Time to wait before failover (0 - 300 sec, default = 0), to avoid flip.
ftpProxyThreshold String: Dynamic weighted load balancing weight and high and low number of FTP proxy sessions.
gratuitousArps String: Enable/disable gratuitous ARPs. Disable if link-failed-signal enabled.
groupId Number: Cluster group ID (0 - 255). Must be the same for all members.
groupName String: Cluster group name. Must be the same for all members.
haDirect String: Enable/disable using ha-mgmt interface for syslog, SNMP, remote authentication (RADIUS), FortiAnalyzer, and FortiSandbox.
haEthType String: HA heartbeat packet Ethertype (4-digit hex).
haMgmtInterfaces List<Property Map>: Reserve interfaces to manage individual cluster units. The structure of ha_mgmt_interfaces block is documented below.
haMgmtStatus String: Enable to reserve interfaces to manage individual cluster units.
haUptimeDiffMargin Number: Normally you would only reduce this value for failover testing.
hbInterval Number: Time between sending heartbeat packets (1 - 20 (100*ms)). Increase to reduce false positives.
hbIntervalInMilliseconds String: Number of milliseconds for each heartbeat interval: 100ms or 10ms.
hbLostThreshold Number: Number of lost heartbeats to signal a failure (1 - 60). Increase to reduce false positives.
hbdev String: Heartbeat interfaces. Must be the same for all members.
hcEthType String: Transparent mode HA heartbeat packet Ethertype (4-digit hex).
helloHolddown Number: Time to wait before changing from hello to work state (5 - 300 sec).
httpProxyThreshold String: Dynamic weighted load balancing weight and high and low number of HTTP proxy sessions.
id String: The provider-assigned unique ID for this managed resource.
imapProxyThreshold String: Dynamic weighted load balancing weight and high and low number of IMAP proxy sessions.
interClusterSessionSync String: Enable/disable synchronization of sessions among HA clusters.
ipsecPhase2Proposal String: IPsec phase2 proposal.
key String: key
l2epEthType String: Telnet session HA heartbeat packet Ethertype (4-digit hex).
linkFailedSignal String: Enable to shut down all interfaces for 1 sec after a failover. Use if gratuitous ARPs do not update network.
loadBalanceAll String: Enable to load balance TCP sessions. Disable to load balance proxy sessions only.
logicalSn String: Enable/disable usage of the logical serial number.
memoryBasedFailover String: Enable/disable memory based failover.
memoryCompatibleMode String: Enable/disable memory compatible mode.
memoryFailoverFlipTimeout Number: Time to wait between subsequent memory based failovers in minutes (6 - 2147483647, default = 6).
memoryFailoverMonitorPeriod Number: Duration of high memory usage before memory based failover is triggered in seconds (1 - 300, default = 60).
memoryFailoverSampleRate Number: Rate at which memory usage is sampled in order to measure memory usage in seconds (1 - 60, default = 1).
memoryFailoverThreshold Number: Memory usage threshold to trigger memory based failover (0 means using conserve mode threshold in system.global).
memoryThreshold String: Dynamic weighted load balancing memory usage weight and high and low thresholds.
mode String: HA mode. Must be the same for all members. FGSP requires standalone.
monitor String: Interfaces to check for port monitoring (or link failure).
multicastTtl Number: HA multicast TTL on master (5 - 3600 sec).
nntpProxyThreshold String: Dynamic weighted load balancing weight and high and low number of NNTP proxy sessions.
override String: Enable and increase the priority of the unit that should always be primary (master).
overrideWaitTime Number: Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
password String: Cluster password. Must be the same for all members.
pingserverFailoverThreshold Number: Remote IP monitoring failover threshold (0 - 50).
pingserverFlipTimeout Number: Time to wait in minutes before renegotiating after a remote IP monitoring failover.
pingserverMonitorInterface String: Interfaces to check for remote IP monitoring.
pingserverSecondaryForceReset String: Enable to force the cluster to negotiate after a remote IP monitoring failover.
pingserverSlaveForceReset String: Enable to force the cluster to negotiate after a remote IP monitoring failover.
pop3ProxyThreshold String: Dynamic weighted load balancing weight and high and low number of POP3 proxy sessions.
priority Number: Increase the priority to select the primary unit (0 - 255).
routeHold Number: Time to wait between routing table updates to the cluster (0 - 3600 sec).
routeTtl Number: TTL for primary unit routes (5 - 3600 sec). Increase to maintain active routes during failover.
routeWait Number: Time to wait before sending new routes to the cluster (0 - 3600 sec).
schedule String: Type of A-A load balancing. Use none if you have external load balancers.
secondaryVclusters List<Property Map>: Configure virtual cluster 2. The structure of secondary_vcluster block is documented below.
sessionPickup String: Enable/disable session pickup. Enabling it can reduce session down time when fail over happens.
sessionPickupConnectionless String: Enable/disable UDP and ICMP session sync.
sessionPickupDelay String: Enable to sync sessions longer than 30 sec. Only longer lived sessions need to be synced.
sessionPickupExpectation String: Enable/disable session helper expectation session sync for FGSP.
sessionPickupNat String: Enable/disable NAT session sync for FGSP.
sessionSyncDev String: Offload session-sync process to kernel and sync sessions using connected interface(s) directly.
smtpProxyThreshold String: Dynamic weighted load balancing weight and high and low number of SMTP proxy sessions.
ssdFailover String: Enable/disable automatic HA failover on SSD disk failure.
standaloneConfigSync String: Enable/disable FGSP configuration synchronization.
standaloneMgmtVdom String: Enable/disable standalone management VDOM.
syncConfig String: Enable/disable configuration synchronization.
syncPacketBalance String: Enable/disable HA packet distribution to multiple CPUs.
unicastGateway String: Default route gateway for unicast interface.
unicastHb String: Enable/disable unicast heartbeat.
unicastHbNetmask String: Unicast heartbeat netmask.
unicastHbPeerip String: Unicast heartbeat peer IP.
unicastPeers List<Property Map>: Number of unicast peers. The structure of unicast_peers block is documented below.
unicastStatus String: Enable/disable unicast connection.
uninterruptiblePrimaryWait Number: Number of minutes the primary HA unit waits before the secondary HA unit is considered upgraded and the system is started before starting its own upgrade (1 - 300, default = 30).
uninterruptibleUpgrade String: Enable to upgrade a cluster without blocking network traffic.
upgradeMode String: The mode to upgrade a cluster.
vcluster2 String: Enable/disable virtual cluster 2 for virtual clustering.
vclusterId Number: Cluster ID.
vclusterStatus String: Enable/disable virtual cluster for virtual clustering.
vclusters List<Property Map>: Virtual cluster table. The structure of vcluster block is documented below.
vdom String: VDOMs in virtual cluster 2.
weight String: Weight-round-robin weight for each cluster unit. Syntax .
vdomparam String

Supporting Types

GetHaHaMgmtInterface

Dst string: Default route destination for reserved HA management interface.
Gateway string: Default route gateway for reserved HA management interface.
Gateway6 string: Default IPv6 gateway for reserved HA management interface.
Id int: Table ID.
Interface string: Interface to reserve for HA management.

Dst string: Default route destination for reserved HA management interface.
Gateway string: Default route gateway for reserved HA management interface.
Gateway6 string: Default IPv6 gateway for reserved HA management interface.
Id int: Table ID.
Interface string: Interface to reserve for HA management.

dst String: Default route destination for reserved HA management interface.
gateway String: Default route gateway for reserved HA management interface.
gateway6 String: Default IPv6 gateway for reserved HA management interface.
id Integer: Table ID.
interface_ String: Interface to reserve for HA management.

dst string: Default route destination for reserved HA management interface.
gateway string: Default route gateway for reserved HA management interface.
gateway6 string: Default IPv6 gateway for reserved HA management interface.
id number: Table ID.
interface string: Interface to reserve for HA management.

dst str: Default route destination for reserved HA management interface.
gateway str: Default route gateway for reserved HA management interface.
gateway6 str: Default IPv6 gateway for reserved HA management interface.
id int: Table ID.
interface str: Interface to reserve for HA management.

dst String: Default route destination for reserved HA management interface.
gateway String: Default route gateway for reserved HA management interface.
gateway6 String: Default IPv6 gateway for reserved HA management interface.
id Number: Table ID.
interface String: Interface to reserve for HA management.

GetHaSecondaryVcluster

Monitor string: Interfaces to check for port monitoring (or link failure).
Override string: Enable and increase the priority of the unit that should always be primary (master).
OverrideWaitTime int: Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
PingserverFailoverThreshold int: Remote IP monitoring failover threshold (0 - 50).
PingserverMonitorInterface string: Interfaces to check for remote IP monitoring.
PingserverSecondaryForceReset string: Enable to force the cluster to negotiate after a remote IP monitoring failover.
PingserverSlaveForceReset string: Enable to force the cluster to negotiate after a remote IP monitoring failover.
Priority int: Increase the priority to select the primary unit (0 - 255).
VclusterId int: Cluster ID.
Vdom string: VDOMs in virtual cluster 2.

Monitor string: Interfaces to check for port monitoring (or link failure).
Override string: Enable and increase the priority of the unit that should always be primary (master).
OverrideWaitTime int: Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
PingserverFailoverThreshold int: Remote IP monitoring failover threshold (0 - 50).
PingserverMonitorInterface string: Interfaces to check for remote IP monitoring.
PingserverSecondaryForceReset string: Enable to force the cluster to negotiate after a remote IP monitoring failover.
PingserverSlaveForceReset string: Enable to force the cluster to negotiate after a remote IP monitoring failover.
Priority int: Increase the priority to select the primary unit (0 - 255).
VclusterId int: Cluster ID.
Vdom string: VDOMs in virtual cluster 2.

monitor String: Interfaces to check for port monitoring (or link failure).
override String: Enable and increase the priority of the unit that should always be primary (master).
overrideWaitTime Integer: Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
pingserverFailoverThreshold Integer: Remote IP monitoring failover threshold (0 - 50).
pingserverMonitorInterface String: Interfaces to check for remote IP monitoring.
pingserverSecondaryForceReset String: Enable to force the cluster to negotiate after a remote IP monitoring failover.
pingserverSlaveForceReset String: Enable to force the cluster to negotiate after a remote IP monitoring failover.
priority Integer: Increase the priority to select the primary unit (0 - 255).
vclusterId Integer: Cluster ID.
vdom String: VDOMs in virtual cluster 2.

monitor string: Interfaces to check for port monitoring (or link failure).
override string: Enable and increase the priority of the unit that should always be primary (master).
overrideWaitTime number: Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
pingserverFailoverThreshold number: Remote IP monitoring failover threshold (0 - 50).
pingserverMonitorInterface string: Interfaces to check for remote IP monitoring.
pingserverSecondaryForceReset string: Enable to force the cluster to negotiate after a remote IP monitoring failover.
pingserverSlaveForceReset string: Enable to force the cluster to negotiate after a remote IP monitoring failover.
priority number: Increase the priority to select the primary unit (0 - 255).
vclusterId number: Cluster ID.
vdom string: VDOMs in virtual cluster 2.

monitor str: Interfaces to check for port monitoring (or link failure).
override str: Enable and increase the priority of the unit that should always be primary (master).
override_wait_time int: Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
pingserver_failover_threshold int: Remote IP monitoring failover threshold (0 - 50).
pingserver_monitor_interface str: Interfaces to check for remote IP monitoring.
pingserver_secondary_force_reset str: Enable to force the cluster to negotiate after a remote IP monitoring failover.
pingserver_slave_force_reset str: Enable to force the cluster to negotiate after a remote IP monitoring failover.
priority int: Increase the priority to select the primary unit (0 - 255).
vcluster_id int: Cluster ID.
vdom str: VDOMs in virtual cluster 2.

monitor String: Interfaces to check for port monitoring (or link failure).
override String: Enable and increase the priority of the unit that should always be primary (master).
overrideWaitTime Number: Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
pingserverFailoverThreshold Number: Remote IP monitoring failover threshold (0 - 50).
pingserverMonitorInterface String: Interfaces to check for remote IP monitoring.
pingserverSecondaryForceReset String: Enable to force the cluster to negotiate after a remote IP monitoring failover.
pingserverSlaveForceReset String: Enable to force the cluster to negotiate after a remote IP monitoring failover.
priority Number: Increase the priority to select the primary unit (0 - 255).
vclusterId Number: Cluster ID.
vdom String: VDOMs in virtual cluster 2.

GetHaUnicastPeer

Id int: Table ID.
PeerIp string: Unicast peer IP.

Id int: Table ID.
PeerIp string: Unicast peer IP.

id Integer: Table ID.
peerIp String: Unicast peer IP.

id number: Table ID.
peerIp string: Unicast peer IP.

id int: Table ID.
peer_ip str: Unicast peer IP.

id Number: Table ID.
peerIp String: Unicast peer IP.

GetHaVcluster

Monitor string: Interfaces to check for port monitoring (or link failure).
Override string: Enable and increase the priority of the unit that should always be primary (master).
OverrideWaitTime int: Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
PingserverFailoverThreshold int: Remote IP monitoring failover threshold (0 - 50).
PingserverFlipTimeout int: Time to wait in minutes before renegotiating after a remote IP monitoring failover.
PingserverMonitorInterface string: Interfaces to check for remote IP monitoring.
PingserverSecondaryForceReset string: Enable to force the cluster to negotiate after a remote IP monitoring failover.
PingserverSlaveForceReset string: Enable to force the cluster to negotiate after a remote IP monitoring failover.
Priority int: Increase the priority to select the primary unit (0 - 255).
VclusterId int: Cluster ID.
Vdoms List<Pulumiverse.Fortios.System.Inputs.GetHaVclusterVdom>: VDOMs in virtual cluster 2.

Monitor string: Interfaces to check for port monitoring (or link failure).
Override string: Enable and increase the priority of the unit that should always be primary (master).
OverrideWaitTime int: Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
PingserverFailoverThreshold int: Remote IP monitoring failover threshold (0 - 50).
PingserverFlipTimeout int: Time to wait in minutes before renegotiating after a remote IP monitoring failover.
PingserverMonitorInterface string: Interfaces to check for remote IP monitoring.
PingserverSecondaryForceReset string: Enable to force the cluster to negotiate after a remote IP monitoring failover.
PingserverSlaveForceReset string: Enable to force the cluster to negotiate after a remote IP monitoring failover.
Priority int: Increase the priority to select the primary unit (0 - 255).
VclusterId int: Cluster ID.
Vdoms []GetHaVclusterVdom: VDOMs in virtual cluster 2.

monitor String: Interfaces to check for port monitoring (or link failure).
override String: Enable and increase the priority of the unit that should always be primary (master).
overrideWaitTime Integer: Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
pingserverFailoverThreshold Integer: Remote IP monitoring failover threshold (0 - 50).
pingserverFlipTimeout Integer: Time to wait in minutes before renegotiating after a remote IP monitoring failover.
pingserverMonitorInterface String: Interfaces to check for remote IP monitoring.
pingserverSecondaryForceReset String: Enable to force the cluster to negotiate after a remote IP monitoring failover.
pingserverSlaveForceReset String: Enable to force the cluster to negotiate after a remote IP monitoring failover.
priority Integer: Increase the priority to select the primary unit (0 - 255).
vclusterId Integer: Cluster ID.
vdoms List<GetHaVclusterVdom>: VDOMs in virtual cluster 2.

monitor string: Interfaces to check for port monitoring (or link failure).
override string: Enable and increase the priority of the unit that should always be primary (master).
overrideWaitTime number: Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
pingserverFailoverThreshold number: Remote IP monitoring failover threshold (0 - 50).
pingserverFlipTimeout number: Time to wait in minutes before renegotiating after a remote IP monitoring failover.
pingserverMonitorInterface string: Interfaces to check for remote IP monitoring.
pingserverSecondaryForceReset string: Enable to force the cluster to negotiate after a remote IP monitoring failover.
pingserverSlaveForceReset string: Enable to force the cluster to negotiate after a remote IP monitoring failover.
priority number: Increase the priority to select the primary unit (0 - 255).
vclusterId number: Cluster ID.
vdoms GetHaVclusterVdom[]: VDOMs in virtual cluster 2.

monitor str: Interfaces to check for port monitoring (or link failure).
override str: Enable and increase the priority of the unit that should always be primary (master).
override_wait_time int: Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
pingserver_failover_threshold int: Remote IP monitoring failover threshold (0 - 50).
pingserver_flip_timeout int: Time to wait in minutes before renegotiating after a remote IP monitoring failover.
pingserver_monitor_interface str: Interfaces to check for remote IP monitoring.
pingserver_secondary_force_reset str: Enable to force the cluster to negotiate after a remote IP monitoring failover.
pingserver_slave_force_reset str: Enable to force the cluster to negotiate after a remote IP monitoring failover.
priority int: Increase the priority to select the primary unit (0 - 255).
vcluster_id int: Cluster ID.
vdoms Sequence[GetHaVclusterVdom]: VDOMs in virtual cluster 2.

monitor String: Interfaces to check for port monitoring (or link failure).
override String: Enable and increase the priority of the unit that should always be primary (master).
overrideWaitTime Number: Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
pingserverFailoverThreshold Number: Remote IP monitoring failover threshold (0 - 50).
pingserverFlipTimeout Number: Time to wait in minutes before renegotiating after a remote IP monitoring failover.
pingserverMonitorInterface String: Interfaces to check for remote IP monitoring.
pingserverSecondaryForceReset String: Enable to force the cluster to negotiate after a remote IP monitoring failover.
pingserverSlaveForceReset String: Enable to force the cluster to negotiate after a remote IP monitoring failover.
priority Number: Increase the priority to select the primary unit (0 - 255).
vclusterId Number: Cluster ID.
vdoms List<Property Map>: VDOMs in virtual cluster 2.

GetHaVclusterVdom

Name string: Virtual domain name.

Name string: Virtual domain name.

name String: Virtual domain name.

name string: Virtual domain name.

name str: Virtual domain name.

name String: Virtual domain name.

Package Details

Repository: fortios pulumiverse/pulumi-fortios
License: Apache-2.0
Notes: This Pulumi package is based on the fortios Terraform Provider.

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

pulumiverse/pulumi-fortios

fortios.system.getHa

On this page

On this page

Using getHa

getHa Result

Supporting Types

GetHaHaMgmtInterface

GetHaSecondaryVcluster

GetHaUnicastPeer

GetHaVcluster

GetHaVclusterVdom

Package Details

On this page

On this page