Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
fortios.system.getHa
Explore with Pulumi AI
Use this data source to get information on fortios system ha
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.
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)
// Output-based functions aren't available in Java yet
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.
- Arps
Interval int - Time between gratuitous ARPs (1 - 20 sec). Lower to reduce failover time. Higher to reduce traffic.
- Authentication string
- Enable/disable heartbeat message authentication.
- Cpu
Threshold string - Dynamic weighted load balancing CPU usage weight and high and low thresholds.
- Encryption string
- Enable/disable heartbeat message encryption.
- Evpn
Ttl int - HA EVPN FDB TTL on primary box (5 - 3600 sec).
- Failover
Hold intTime - Time to wait before failover (0 - 300 sec, default = 0), to avoid flip.
- Ftp
Proxy stringThreshold - Dynamic weighted load balancing weight and high and low number of FTP proxy sessions.
- Gratuitous
Arps string - 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 string - Cluster group name. Must be the same for all members.
- Ha
Direct string - Enable/disable using ha-mgmt interface for syslog, SNMP, remote authentication (RADIUS), FortiAnalyzer, and FortiSandbox.
- Ha
Eth stringType - HA heartbeat packet Ethertype (4-digit hex).
- Ha
Mgmt List<Pulumiverse.Interfaces Fortios. System. Outputs. Get Ha Ha Mgmt Interface> - Reserve interfaces to manage individual cluster units. The structure of
ha_mgmt_interfaces
block is documented below. - Ha
Mgmt stringStatus - Enable to reserve interfaces to manage individual cluster units.
- Ha
Uptime intDiff Margin - 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 stringIn Milliseconds - Number of milliseconds for each heartbeat interval: 100ms or 10ms.
- Hb
Lost intThreshold - 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.
- Hc
Eth stringType - 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 stringThreshold - 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.
- Imap
Proxy stringThreshold - Dynamic weighted load balancing weight and high and low number of IMAP proxy sessions.
- Inter
Cluster stringSession Sync - Enable/disable synchronization of sessions among HA clusters.
- Ipsec
Phase2Proposal string - IPsec phase2 proposal.
- Key string
- key
- L2ep
Eth stringType - Telnet session HA heartbeat packet Ethertype (4-digit hex).
- Link
Failed stringSignal - Enable to shut down all interfaces for 1 sec after a failover. Use if gratuitous ARPs do not update network.
- Load
Balance stringAll - Enable to load balance TCP sessions. Disable to load balance proxy sessions only.
- Logical
Sn string - Enable/disable usage of the logical serial number.
- Memory
Based stringFailover - Enable/disable memory based failover.
- Memory
Compatible stringMode - Enable/disable memory compatible mode.
- Memory
Failover intFlip Timeout - Time to wait between subsequent memory based failovers in minutes (6 - 2147483647, default = 6).
- Memory
Failover intMonitor Period - Duration of high memory usage before memory based failover is triggered in seconds (1 - 300, default = 60).
- Memory
Failover intSample Rate - Rate at which memory usage is sampled in order to measure memory usage in seconds (1 - 60, default = 1).
- Memory
Failover intThreshold - Memory usage threshold to trigger memory based failover (0 means using conserve mode threshold in system.global).
- Memory
Threshold 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).
- Multicast
Ttl int - HA multicast TTL on master (5 - 3600 sec).
- Nntp
Proxy stringThreshold - 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).
- Override
Wait intTime - 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.
- Pingserver
Failover intThreshold - Remote IP monitoring failover threshold (0 - 50).
- Pingserver
Flip intTimeout - Time to wait in minutes before renegotiating after a remote IP monitoring failover.
- Pingserver
Monitor stringInterface - Interfaces to check for remote IP monitoring.
- Pingserver
Secondary stringForce Reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- Pingserver
Slave stringForce Reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- Pop3Proxy
Threshold 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).
- 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 string
- Type of A-A load balancing. Use none if you have external load balancers.
- Secondary
Vclusters List<Pulumiverse.Fortios. System. Outputs. Get Ha Secondary Vcluster> - Configure virtual cluster 2. The structure of
secondary_vcluster
block is documented below. - Session
Pickup string - Enable/disable session pickup. Enabling it can reduce session down time when fail over happens.
- Session
Pickup stringConnectionless - Enable/disable UDP and ICMP session sync.
- Session
Pickup stringDelay - Enable to sync sessions longer than 30 sec. Only longer lived sessions need to be synced.
- Session
Pickup stringExpectation - Enable/disable session helper expectation session sync for FGSP.
- Session
Pickup stringNat - Enable/disable NAT session sync for FGSP.
- Session
Sync stringDev - Offload session-sync process to kernel and sync sessions using connected interface(s) directly.
- Smtp
Proxy stringThreshold - Dynamic weighted load balancing weight and high and low number of SMTP proxy sessions.
- Ssd
Failover string - Enable/disable automatic HA failover on SSD disk failure.
- Standalone
Config stringSync - Enable/disable FGSP configuration synchronization.
- Standalone
Mgmt stringVdom - Enable/disable standalone management VDOM.
- Sync
Config string - Enable/disable configuration synchronization.
- Sync
Packet stringBalance - Enable/disable HA packet distribution to multiple CPUs.
- Unicast
Gateway string - Default route gateway for unicast interface.
- Unicast
Hb string - Enable/disable unicast heartbeat.
- Unicast
Hb stringNetmask - Unicast heartbeat netmask.
- Unicast
Hb stringPeerip - Unicast heartbeat peer IP.
- Unicast
Peers List<Pulumiverse.Fortios. System. Outputs. Get Ha Unicast Peer> - Number of unicast peers. The structure of
unicast_peers
block is documented below. - Unicast
Status string - Enable/disable unicast connection.
- Uninterruptible
Primary intWait - 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 string - Enable to upgrade a cluster without blocking network traffic.
- Upgrade
Mode string - The mode to upgrade a cluster.
- Vcluster2 string
- Enable/disable virtual cluster 2 for virtual clustering.
- Vcluster
Id int - Cluster ID.
- Vcluster
Status string - Enable/disable virtual cluster for virtual clustering.
- Vclusters
List<Pulumiverse.
Fortios. System. Outputs. Get Ha Vcluster> - 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 string
- Enable/disable heartbeat message authentication.
- Cpu
Threshold string - Dynamic weighted load balancing CPU usage weight and high and low thresholds.
- Encryption string
- Enable/disable heartbeat message encryption.
- Evpn
Ttl int - HA EVPN FDB TTL on primary box (5 - 3600 sec).
- Failover
Hold intTime - Time to wait before failover (0 - 300 sec, default = 0), to avoid flip.
- Ftp
Proxy stringThreshold - Dynamic weighted load balancing weight and high and low number of FTP proxy sessions.
- Gratuitous
Arps string - 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 string - Cluster group name. Must be the same for all members.
- Ha
Direct string - Enable/disable using ha-mgmt interface for syslog, SNMP, remote authentication (RADIUS), FortiAnalyzer, and FortiSandbox.
- Ha
Eth stringType - HA heartbeat packet Ethertype (4-digit hex).
- Ha
Mgmt []GetInterfaces Ha Ha Mgmt Interface - Reserve interfaces to manage individual cluster units. The structure of
ha_mgmt_interfaces
block is documented below. - Ha
Mgmt stringStatus - Enable to reserve interfaces to manage individual cluster units.
- Ha
Uptime intDiff Margin - 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 stringIn Milliseconds - Number of milliseconds for each heartbeat interval: 100ms or 10ms.
- Hb
Lost intThreshold - 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.
- Hc
Eth stringType - 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 stringThreshold - 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.
- Imap
Proxy stringThreshold - Dynamic weighted load balancing weight and high and low number of IMAP proxy sessions.
- Inter
Cluster stringSession Sync - Enable/disable synchronization of sessions among HA clusters.
- Ipsec
Phase2Proposal string - IPsec phase2 proposal.
- Key string
- key
- L2ep
Eth stringType - Telnet session HA heartbeat packet Ethertype (4-digit hex).
- Link
Failed stringSignal - Enable to shut down all interfaces for 1 sec after a failover. Use if gratuitous ARPs do not update network.
- Load
Balance stringAll - Enable to load balance TCP sessions. Disable to load balance proxy sessions only.
- Logical
Sn string - Enable/disable usage of the logical serial number.
- Memory
Based stringFailover - Enable/disable memory based failover.
- Memory
Compatible stringMode - Enable/disable memory compatible mode.
- Memory
Failover intFlip Timeout - Time to wait between subsequent memory based failovers in minutes (6 - 2147483647, default = 6).
- Memory
Failover intMonitor Period - Duration of high memory usage before memory based failover is triggered in seconds (1 - 300, default = 60).
- Memory
Failover intSample Rate - Rate at which memory usage is sampled in order to measure memory usage in seconds (1 - 60, default = 1).
- Memory
Failover intThreshold - Memory usage threshold to trigger memory based failover (0 means using conserve mode threshold in system.global).
- Memory
Threshold 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).
- Multicast
Ttl int - HA multicast TTL on master (5 - 3600 sec).
- Nntp
Proxy stringThreshold - 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).
- Override
Wait intTime - 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.
- Pingserver
Failover intThreshold - Remote IP monitoring failover threshold (0 - 50).
- Pingserver
Flip intTimeout - Time to wait in minutes before renegotiating after a remote IP monitoring failover.
- Pingserver
Monitor stringInterface - Interfaces to check for remote IP monitoring.
- Pingserver
Secondary stringForce Reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- Pingserver
Slave stringForce Reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- Pop3Proxy
Threshold 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).
- 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 string
- Type of A-A load balancing. Use none if you have external load balancers.
- Secondary
Vclusters []GetHa Secondary Vcluster - Configure virtual cluster 2. The structure of
secondary_vcluster
block is documented below. - Session
Pickup string - Enable/disable session pickup. Enabling it can reduce session down time when fail over happens.
- Session
Pickup stringConnectionless - Enable/disable UDP and ICMP session sync.
- Session
Pickup stringDelay - Enable to sync sessions longer than 30 sec. Only longer lived sessions need to be synced.
- Session
Pickup stringExpectation - Enable/disable session helper expectation session sync for FGSP.
- Session
Pickup stringNat - Enable/disable NAT session sync for FGSP.
- Session
Sync stringDev - Offload session-sync process to kernel and sync sessions using connected interface(s) directly.
- Smtp
Proxy stringThreshold - Dynamic weighted load balancing weight and high and low number of SMTP proxy sessions.
- Ssd
Failover string - Enable/disable automatic HA failover on SSD disk failure.
- Standalone
Config stringSync - Enable/disable FGSP configuration synchronization.
- Standalone
Mgmt stringVdom - Enable/disable standalone management VDOM.
- Sync
Config string - Enable/disable configuration synchronization.
- Sync
Packet stringBalance - Enable/disable HA packet distribution to multiple CPUs.
- Unicast
Gateway string - Default route gateway for unicast interface.
- Unicast
Hb string - Enable/disable unicast heartbeat.
- Unicast
Hb stringNetmask - Unicast heartbeat netmask.
- Unicast
Hb stringPeerip - Unicast heartbeat peer IP.
- Unicast
Peers []GetHa Unicast Peer - Number of unicast peers. The structure of
unicast_peers
block is documented below. - Unicast
Status string - Enable/disable unicast connection.
- Uninterruptible
Primary intWait - 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 string - Enable to upgrade a cluster without blocking network traffic.
- Upgrade
Mode string - The mode to upgrade a cluster.
- Vcluster2 string
- Enable/disable virtual cluster 2 for virtual clustering.
- Vcluster
Id int - Cluster ID.
- Vcluster
Status string - Enable/disable virtual cluster for virtual clustering.
- Vclusters
[]Get
Ha Vcluster - 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.
- arps
Interval Integer - Time between gratuitous ARPs (1 - 20 sec). Lower to reduce failover time. Higher to reduce traffic.
- authentication String
- Enable/disable heartbeat message authentication.
- cpu
Threshold String - Dynamic weighted load balancing CPU usage weight and high and low thresholds.
- encryption String
- Enable/disable heartbeat message encryption.
- evpn
Ttl Integer - HA EVPN FDB TTL on primary box (5 - 3600 sec).
- failover
Hold IntegerTime - Time to wait before failover (0 - 300 sec, default = 0), to avoid flip.
- ftp
Proxy StringThreshold - Dynamic weighted load balancing weight and high and low number of FTP proxy sessions.
- gratuitous
Arps String - Enable/disable gratuitous ARPs. Disable if link-failed-signal enabled.
- group
Id Integer - Cluster group ID (0 - 255). Must be the same for all members.
- group
Name String - Cluster group name. Must be the same for all members.
- ha
Direct String - Enable/disable using ha-mgmt interface for syslog, SNMP, remote authentication (RADIUS), FortiAnalyzer, and FortiSandbox.
- ha
Eth StringType - HA heartbeat packet Ethertype (4-digit hex).
- ha
Mgmt List<GetInterfaces Ha Ha Mgmt Interface> - Reserve interfaces to manage individual cluster units. The structure of
ha_mgmt_interfaces
block is documented below. - ha
Mgmt StringStatus - Enable to reserve interfaces to manage individual cluster units.
- ha
Uptime IntegerDiff Margin - Normally you would only reduce this value for failover testing.
- hb
Interval Integer - Time between sending heartbeat packets (1 - 20 (100*ms)). Increase to reduce false positives.
- hb
Interval StringIn Milliseconds - Number of milliseconds for each heartbeat interval: 100ms or 10ms.
- hb
Lost IntegerThreshold - 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.
- hc
Eth StringType - Transparent mode HA heartbeat packet Ethertype (4-digit hex).
- hello
Holddown Integer - Time to wait before changing from hello to work state (5 - 300 sec).
- http
Proxy StringThreshold - 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.
- imap
Proxy StringThreshold - Dynamic weighted load balancing weight and high and low number of IMAP proxy sessions.
- inter
Cluster StringSession Sync - Enable/disable synchronization of sessions among HA clusters.
- ipsec
Phase2Proposal String - IPsec phase2 proposal.
- key String
- key
- l2ep
Eth StringType - Telnet session HA heartbeat packet Ethertype (4-digit hex).
- link
Failed StringSignal - Enable to shut down all interfaces for 1 sec after a failover. Use if gratuitous ARPs do not update network.
- load
Balance StringAll - Enable to load balance TCP sessions. Disable to load balance proxy sessions only.
- logical
Sn String - Enable/disable usage of the logical serial number.
- memory
Based StringFailover - Enable/disable memory based failover.
- memory
Compatible StringMode - Enable/disable memory compatible mode.
- memory
Failover IntegerFlip Timeout - Time to wait between subsequent memory based failovers in minutes (6 - 2147483647, default = 6).
- memory
Failover IntegerMonitor Period - Duration of high memory usage before memory based failover is triggered in seconds (1 - 300, default = 60).
- memory
Failover IntegerSample Rate - Rate at which memory usage is sampled in order to measure memory usage in seconds (1 - 60, default = 1).
- memory
Failover IntegerThreshold - Memory usage threshold to trigger memory based failover (0 means using conserve mode threshold in system.global).
- memory
Threshold 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).
- multicast
Ttl Integer - HA multicast TTL on master (5 - 3600 sec).
- nntp
Proxy StringThreshold - 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).
- override
Wait IntegerTime - 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.
- pingserver
Failover IntegerThreshold - Remote IP monitoring failover threshold (0 - 50).
- pingserver
Flip IntegerTimeout - Time to wait in minutes before renegotiating after a remote IP monitoring failover.
- pingserver
Monitor StringInterface - Interfaces to check for remote IP monitoring.
- pingserver
Secondary StringForce Reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- pingserver
Slave StringForce Reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- pop3Proxy
Threshold 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).
- route
Hold Integer - Time to wait between routing table updates to the cluster (0 - 3600 sec).
- route
Ttl Integer - TTL for primary unit routes (5 - 3600 sec). Increase to maintain active routes during failover.
- route
Wait 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.
- secondary
Vclusters List<GetHa Secondary Vcluster> - Configure virtual cluster 2. The structure of
secondary_vcluster
block is documented below. - session
Pickup String - Enable/disable session pickup. Enabling it can reduce session down time when fail over happens.
- session
Pickup StringConnectionless - Enable/disable UDP and ICMP session sync.
- session
Pickup StringDelay - Enable to sync sessions longer than 30 sec. Only longer lived sessions need to be synced.
- session
Pickup StringExpectation - Enable/disable session helper expectation session sync for FGSP.
- session
Pickup StringNat - Enable/disable NAT session sync for FGSP.
- session
Sync StringDev - Offload session-sync process to kernel and sync sessions using connected interface(s) directly.
- smtp
Proxy StringThreshold - Dynamic weighted load balancing weight and high and low number of SMTP proxy sessions.
- ssd
Failover String - Enable/disable automatic HA failover on SSD disk failure.
- standalone
Config StringSync - Enable/disable FGSP configuration synchronization.
- standalone
Mgmt StringVdom - Enable/disable standalone management VDOM.
- sync
Config String - Enable/disable configuration synchronization.
- sync
Packet StringBalance - Enable/disable HA packet distribution to multiple CPUs.
- unicast
Gateway String - Default route gateway for unicast interface.
- unicast
Hb String - Enable/disable unicast heartbeat.
- unicast
Hb StringNetmask - Unicast heartbeat netmask.
- unicast
Hb StringPeerip - Unicast heartbeat peer IP.
- unicast
Peers List<GetHa Unicast Peer> - Number of unicast peers. The structure of
unicast_peers
block is documented below. - unicast
Status String - Enable/disable unicast connection.
- uninterruptible
Primary IntegerWait - 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 String - Enable to upgrade a cluster without blocking network traffic.
- upgrade
Mode String - The mode to upgrade a cluster.
- vcluster2 String
- Enable/disable virtual cluster 2 for virtual clustering.
- vcluster
Id Integer - Cluster ID.
- vcluster
Status String - Enable/disable virtual cluster for virtual clustering.
- vclusters
List<Get
Ha Vcluster> - 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.
- arps
Interval number - Time between gratuitous ARPs (1 - 20 sec). Lower to reduce failover time. Higher to reduce traffic.
- authentication string
- Enable/disable heartbeat message authentication.
- cpu
Threshold string - Dynamic weighted load balancing CPU usage weight and high and low thresholds.
- encryption string
- Enable/disable heartbeat message encryption.
- evpn
Ttl number - HA EVPN FDB TTL on primary box (5 - 3600 sec).
- failover
Hold numberTime - Time to wait before failover (0 - 300 sec, default = 0), to avoid flip.
- ftp
Proxy stringThreshold - Dynamic weighted load balancing weight and high and low number of FTP proxy sessions.
- gratuitous
Arps string - Enable/disable gratuitous ARPs. Disable if link-failed-signal enabled.
- group
Id number - Cluster group ID (0 - 255). Must be the same for all members.
- group
Name string - Cluster group name. Must be the same for all members.
- ha
Direct string - Enable/disable using ha-mgmt interface for syslog, SNMP, remote authentication (RADIUS), FortiAnalyzer, and FortiSandbox.
- ha
Eth stringType - HA heartbeat packet Ethertype (4-digit hex).
- ha
Mgmt GetInterfaces Ha Ha Mgmt Interface[] - Reserve interfaces to manage individual cluster units. The structure of
ha_mgmt_interfaces
block is documented below. - ha
Mgmt stringStatus - Enable to reserve interfaces to manage individual cluster units.
- ha
Uptime numberDiff Margin - Normally you would only reduce this value for failover testing.
- hb
Interval number - Time between sending heartbeat packets (1 - 20 (100*ms)). Increase to reduce false positives.
- hb
Interval stringIn Milliseconds - Number of milliseconds for each heartbeat interval: 100ms or 10ms.
- hb
Lost numberThreshold - 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.
- hc
Eth stringType - Transparent mode HA heartbeat packet Ethertype (4-digit hex).
- hello
Holddown number - Time to wait before changing from hello to work state (5 - 300 sec).
- http
Proxy stringThreshold - 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.
- imap
Proxy stringThreshold - Dynamic weighted load balancing weight and high and low number of IMAP proxy sessions.
- inter
Cluster stringSession Sync - Enable/disable synchronization of sessions among HA clusters.
- ipsec
Phase2Proposal string - IPsec phase2 proposal.
- key string
- key
- l2ep
Eth stringType - Telnet session HA heartbeat packet Ethertype (4-digit hex).
- link
Failed stringSignal - Enable to shut down all interfaces for 1 sec after a failover. Use if gratuitous ARPs do not update network.
- load
Balance stringAll - Enable to load balance TCP sessions. Disable to load balance proxy sessions only.
- logical
Sn string - Enable/disable usage of the logical serial number.
- memory
Based stringFailover - Enable/disable memory based failover.
- memory
Compatible stringMode - Enable/disable memory compatible mode.
- memory
Failover numberFlip Timeout - Time to wait between subsequent memory based failovers in minutes (6 - 2147483647, default = 6).
- memory
Failover numberMonitor Period - Duration of high memory usage before memory based failover is triggered in seconds (1 - 300, default = 60).
- memory
Failover numberSample Rate - Rate at which memory usage is sampled in order to measure memory usage in seconds (1 - 60, default = 1).
- memory
Failover numberThreshold - Memory usage threshold to trigger memory based failover (0 means using conserve mode threshold in system.global).
- memory
Threshold 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).
- multicast
Ttl number - HA multicast TTL on master (5 - 3600 sec).
- nntp
Proxy stringThreshold - 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).
- override
Wait numberTime - 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.
- pingserver
Failover numberThreshold - Remote IP monitoring failover threshold (0 - 50).
- pingserver
Flip numberTimeout - Time to wait in minutes before renegotiating after a remote IP monitoring failover.
- pingserver
Monitor stringInterface - Interfaces to check for remote IP monitoring.
- pingserver
Secondary stringForce Reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- pingserver
Slave stringForce Reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- pop3Proxy
Threshold 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).
- route
Hold number - Time to wait between routing table updates to the cluster (0 - 3600 sec).
- route
Ttl number - TTL for primary unit routes (5 - 3600 sec). Increase to maintain active routes during failover.
- route
Wait 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.
- secondary
Vclusters GetHa Secondary Vcluster[] - Configure virtual cluster 2. The structure of
secondary_vcluster
block is documented below. - session
Pickup string - Enable/disable session pickup. Enabling it can reduce session down time when fail over happens.
- session
Pickup stringConnectionless - Enable/disable UDP and ICMP session sync.
- session
Pickup stringDelay - Enable to sync sessions longer than 30 sec. Only longer lived sessions need to be synced.
- session
Pickup stringExpectation - Enable/disable session helper expectation session sync for FGSP.
- session
Pickup stringNat - Enable/disable NAT session sync for FGSP.
- session
Sync stringDev - Offload session-sync process to kernel and sync sessions using connected interface(s) directly.
- smtp
Proxy stringThreshold - Dynamic weighted load balancing weight and high and low number of SMTP proxy sessions.
- ssd
Failover string - Enable/disable automatic HA failover on SSD disk failure.
- standalone
Config stringSync - Enable/disable FGSP configuration synchronization.
- standalone
Mgmt stringVdom - Enable/disable standalone management VDOM.
- sync
Config string - Enable/disable configuration synchronization.
- sync
Packet stringBalance - Enable/disable HA packet distribution to multiple CPUs.
- unicast
Gateway string - Default route gateway for unicast interface.
- unicast
Hb string - Enable/disable unicast heartbeat.
- unicast
Hb stringNetmask - Unicast heartbeat netmask.
- unicast
Hb stringPeerip - Unicast heartbeat peer IP.
- unicast
Peers GetHa Unicast Peer[] - Number of unicast peers. The structure of
unicast_peers
block is documented below. - unicast
Status string - Enable/disable unicast connection.
- uninterruptible
Primary numberWait - 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 string - Enable to upgrade a cluster without blocking network traffic.
- upgrade
Mode string - The mode to upgrade a cluster.
- vcluster2 string
- Enable/disable virtual cluster 2 for virtual clustering.
- vcluster
Id number - Cluster ID.
- vcluster
Status string - Enable/disable virtual cluster for virtual clustering.
- vclusters
Get
Ha Vcluster[] - 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_ inttime - Time to wait before failover (0 - 300 sec, default = 0), to avoid flip.
- ftp_
proxy_ strthreshold - 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_ strtype - HA heartbeat packet Ethertype (4-digit hex).
- ha_
mgmt_ Sequence[Getinterfaces Ha Ha Mgmt Interface] - Reserve interfaces to manage individual cluster units. The structure of
ha_mgmt_interfaces
block is documented below. - ha_
mgmt_ strstatus - Enable to reserve interfaces to manage individual cluster units.
- ha_
uptime_ intdiff_ margin - 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_ strin_ milliseconds - Number of milliseconds for each heartbeat interval: 100ms or 10ms.
- hb_
lost_ intthreshold - 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_ strtype - 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_ strthreshold - 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_ strthreshold - Dynamic weighted load balancing weight and high and low number of IMAP proxy sessions.
- inter_
cluster_ strsession_ sync - Enable/disable synchronization of sessions among HA clusters.
- ipsec_
phase2_ strproposal - IPsec phase2 proposal.
- key str
- key
- l2ep_
eth_ strtype - Telnet session HA heartbeat packet Ethertype (4-digit hex).
- link_
failed_ strsignal - Enable to shut down all interfaces for 1 sec after a failover. Use if gratuitous ARPs do not update network.
- load_
balance_ strall - 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_ strfailover - Enable/disable memory based failover.
- memory_
compatible_ strmode - Enable/disable memory compatible mode.
- memory_
failover_ intflip_ timeout - Time to wait between subsequent memory based failovers in minutes (6 - 2147483647, default = 6).
- memory_
failover_ intmonitor_ period - Duration of high memory usage before memory based failover is triggered in seconds (1 - 300, default = 60).
- memory_
failover_ intsample_ rate - Rate at which memory usage is sampled in order to measure memory usage in seconds (1 - 60, default = 1).
- memory_
failover_ intthreshold - 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_ strthreshold - 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_ inttime - 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_ intthreshold - Remote IP monitoring failover threshold (0 - 50).
- pingserver_
flip_ inttimeout - Time to wait in minutes before renegotiating after a remote IP monitoring failover.
- pingserver_
monitor_ strinterface - Interfaces to check for remote IP monitoring.
- pingserver_
secondary_ strforce_ reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- pingserver_
slave_ strforce_ reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- pop3_
proxy_ strthreshold - 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[GetHa Secondary Vcluster] - 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_ strconnectionless - Enable/disable UDP and ICMP session sync.
- session_
pickup_ strdelay - Enable to sync sessions longer than 30 sec. Only longer lived sessions need to be synced.
- session_
pickup_ strexpectation - Enable/disable session helper expectation session sync for FGSP.
- session_
pickup_ strnat - Enable/disable NAT session sync for FGSP.
- session_
sync_ strdev - Offload session-sync process to kernel and sync sessions using connected interface(s) directly.
- smtp_
proxy_ strthreshold - 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_ strsync - Enable/disable FGSP configuration synchronization.
- standalone_
mgmt_ strvdom - Enable/disable standalone management VDOM.
- sync_
config str - Enable/disable configuration synchronization.
- sync_
packet_ strbalance - 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_ strnetmask - Unicast heartbeat netmask.
- unicast_
hb_ strpeerip - Unicast heartbeat peer IP.
- unicast_
peers Sequence[GetHa Unicast Peer] - Number of unicast peers. The structure of
unicast_peers
block is documented below. - unicast_
status str - Enable/disable unicast connection.
- uninterruptible_
primary_ intwait - 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[Get
Ha Vcluster] - 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.
- arps
Interval Number - Time between gratuitous ARPs (1 - 20 sec). Lower to reduce failover time. Higher to reduce traffic.
- authentication String
- Enable/disable heartbeat message authentication.
- cpu
Threshold String - Dynamic weighted load balancing CPU usage weight and high and low thresholds.
- encryption String
- Enable/disable heartbeat message encryption.
- evpn
Ttl Number - HA EVPN FDB TTL on primary box (5 - 3600 sec).
- failover
Hold NumberTime - Time to wait before failover (0 - 300 sec, default = 0), to avoid flip.
- ftp
Proxy StringThreshold - Dynamic weighted load balancing weight and high and low number of FTP proxy sessions.
- gratuitous
Arps String - Enable/disable gratuitous ARPs. Disable if link-failed-signal enabled.
- group
Id Number - Cluster group ID (0 - 255). Must be the same for all members.
- group
Name String - Cluster group name. Must be the same for all members.
- ha
Direct String - Enable/disable using ha-mgmt interface for syslog, SNMP, remote authentication (RADIUS), FortiAnalyzer, and FortiSandbox.
- ha
Eth StringType - HA heartbeat packet Ethertype (4-digit hex).
- ha
Mgmt List<Property Map>Interfaces - Reserve interfaces to manage individual cluster units. The structure of
ha_mgmt_interfaces
block is documented below. - ha
Mgmt StringStatus - Enable to reserve interfaces to manage individual cluster units.
- ha
Uptime NumberDiff Margin - Normally you would only reduce this value for failover testing.
- hb
Interval Number - Time between sending heartbeat packets (1 - 20 (100*ms)). Increase to reduce false positives.
- hb
Interval StringIn Milliseconds - Number of milliseconds for each heartbeat interval: 100ms or 10ms.
- hb
Lost NumberThreshold - 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.
- hc
Eth StringType - Transparent mode HA heartbeat packet Ethertype (4-digit hex).
- hello
Holddown Number - Time to wait before changing from hello to work state (5 - 300 sec).
- http
Proxy StringThreshold - 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.
- imap
Proxy StringThreshold - Dynamic weighted load balancing weight and high and low number of IMAP proxy sessions.
- inter
Cluster StringSession Sync - Enable/disable synchronization of sessions among HA clusters.
- ipsec
Phase2Proposal String - IPsec phase2 proposal.
- key String
- key
- l2ep
Eth StringType - Telnet session HA heartbeat packet Ethertype (4-digit hex).
- link
Failed StringSignal - Enable to shut down all interfaces for 1 sec after a failover. Use if gratuitous ARPs do not update network.
- load
Balance StringAll - Enable to load balance TCP sessions. Disable to load balance proxy sessions only.
- logical
Sn String - Enable/disable usage of the logical serial number.
- memory
Based StringFailover - Enable/disable memory based failover.
- memory
Compatible StringMode - Enable/disable memory compatible mode.
- memory
Failover NumberFlip Timeout - Time to wait between subsequent memory based failovers in minutes (6 - 2147483647, default = 6).
- memory
Failover NumberMonitor Period - Duration of high memory usage before memory based failover is triggered in seconds (1 - 300, default = 60).
- memory
Failover NumberSample Rate - Rate at which memory usage is sampled in order to measure memory usage in seconds (1 - 60, default = 1).
- memory
Failover NumberThreshold - Memory usage threshold to trigger memory based failover (0 means using conserve mode threshold in system.global).
- memory
Threshold 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).
- multicast
Ttl Number - HA multicast TTL on master (5 - 3600 sec).
- nntp
Proxy StringThreshold - 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).
- override
Wait NumberTime - 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.
- pingserver
Failover NumberThreshold - Remote IP monitoring failover threshold (0 - 50).
- pingserver
Flip NumberTimeout - Time to wait in minutes before renegotiating after a remote IP monitoring failover.
- pingserver
Monitor StringInterface - Interfaces to check for remote IP monitoring.
- pingserver
Secondary StringForce Reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- pingserver
Slave StringForce Reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- pop3Proxy
Threshold 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).
- route
Hold Number - Time to wait between routing table updates to the cluster (0 - 3600 sec).
- route
Ttl Number - TTL for primary unit routes (5 - 3600 sec). Increase to maintain active routes during failover.
- route
Wait 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.
- secondary
Vclusters List<Property Map> - Configure virtual cluster 2. The structure of
secondary_vcluster
block is documented below. - session
Pickup String - Enable/disable session pickup. Enabling it can reduce session down time when fail over happens.
- session
Pickup StringConnectionless - Enable/disable UDP and ICMP session sync.
- session
Pickup StringDelay - Enable to sync sessions longer than 30 sec. Only longer lived sessions need to be synced.
- session
Pickup StringExpectation - Enable/disable session helper expectation session sync for FGSP.
- session
Pickup StringNat - Enable/disable NAT session sync for FGSP.
- session
Sync StringDev - Offload session-sync process to kernel and sync sessions using connected interface(s) directly.
- smtp
Proxy StringThreshold - Dynamic weighted load balancing weight and high and low number of SMTP proxy sessions.
- ssd
Failover String - Enable/disable automatic HA failover on SSD disk failure.
- standalone
Config StringSync - Enable/disable FGSP configuration synchronization.
- standalone
Mgmt StringVdom - Enable/disable standalone management VDOM.
- sync
Config String - Enable/disable configuration synchronization.
- sync
Packet StringBalance - Enable/disable HA packet distribution to multiple CPUs.
- unicast
Gateway String - Default route gateway for unicast interface.
- unicast
Hb String - Enable/disable unicast heartbeat.
- unicast
Hb StringNetmask - Unicast heartbeat netmask.
- unicast
Hb StringPeerip - Unicast heartbeat peer IP.
- unicast
Peers List<Property Map> - Number of unicast peers. The structure of
unicast_peers
block is documented below. - unicast
Status String - Enable/disable unicast connection.
- uninterruptible
Primary NumberWait - 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 String - Enable to upgrade a cluster without blocking network traffic.
- upgrade
Mode String - The mode to upgrade a cluster.
- vcluster2 String
- Enable/disable virtual cluster 2 for virtual clustering.
- vcluster
Id Number - Cluster ID.
- vcluster
Status 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 Integer
- 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).
- Override
Wait intTime - Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
- Pingserver
Failover intThreshold - Remote IP monitoring failover threshold (0 - 50).
- Pingserver
Monitor stringInterface - Interfaces to check for remote IP monitoring.
- Pingserver
Secondary stringForce Reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- Pingserver
Slave stringForce Reset - 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 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).
- Override
Wait intTime - Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
- Pingserver
Failover intThreshold - Remote IP monitoring failover threshold (0 - 50).
- Pingserver
Monitor stringInterface - Interfaces to check for remote IP monitoring.
- Pingserver
Secondary stringForce Reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- Pingserver
Slave stringForce Reset - 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 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).
- override
Wait IntegerTime - Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
- pingserver
Failover IntegerThreshold - Remote IP monitoring failover threshold (0 - 50).
- pingserver
Monitor StringInterface - Interfaces to check for remote IP monitoring.
- pingserver
Secondary StringForce Reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- pingserver
Slave StringForce Reset - 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).
- vcluster
Id 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).
- override
Wait numberTime - Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
- pingserver
Failover numberThreshold - Remote IP monitoring failover threshold (0 - 50).
- pingserver
Monitor stringInterface - Interfaces to check for remote IP monitoring.
- pingserver
Secondary stringForce Reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- pingserver
Slave stringForce Reset - 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).
- vcluster
Id 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_ inttime - Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
- pingserver_
failover_ intthreshold - Remote IP monitoring failover threshold (0 - 50).
- pingserver_
monitor_ strinterface - Interfaces to check for remote IP monitoring.
- pingserver_
secondary_ strforce_ reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- pingserver_
slave_ strforce_ reset - 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).
- override
Wait NumberTime - Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
- pingserver
Failover NumberThreshold - Remote IP monitoring failover threshold (0 - 50).
- pingserver
Monitor StringInterface - Interfaces to check for remote IP monitoring.
- pingserver
Secondary StringForce Reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- pingserver
Slave StringForce Reset - 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).
- vcluster
Id Number - Cluster ID.
- vdom String
- VDOMs in virtual cluster 2.
GetHaUnicastPeer
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).
- Override
Wait intTime - Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
- Pingserver
Failover intThreshold - Remote IP monitoring failover threshold (0 - 50).
- Pingserver
Flip intTimeout - Time to wait in minutes before renegotiating after a remote IP monitoring failover.
- Pingserver
Monitor stringInterface - Interfaces to check for remote IP monitoring.
- Pingserver
Secondary stringForce Reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- Pingserver
Slave stringForce Reset - 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
List<Pulumiverse.
Fortios. System. Inputs. Get Ha Vcluster Vdom> - 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).
- Override
Wait intTime - Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
- Pingserver
Failover intThreshold - Remote IP monitoring failover threshold (0 - 50).
- Pingserver
Flip intTimeout - Time to wait in minutes before renegotiating after a remote IP monitoring failover.
- Pingserver
Monitor stringInterface - Interfaces to check for remote IP monitoring.
- Pingserver
Secondary stringForce Reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- Pingserver
Slave stringForce Reset - 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
[]Get
Ha Vcluster Vdom - 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).
- override
Wait IntegerTime - Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
- pingserver
Failover IntegerThreshold - Remote IP monitoring failover threshold (0 - 50).
- pingserver
Flip IntegerTimeout - Time to wait in minutes before renegotiating after a remote IP monitoring failover.
- pingserver
Monitor StringInterface - Interfaces to check for remote IP monitoring.
- pingserver
Secondary StringForce Reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- pingserver
Slave StringForce Reset - 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).
- vcluster
Id Integer - Cluster ID.
- vdoms
List<Get
Ha Vcluster Vdom> - 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).
- override
Wait numberTime - Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
- pingserver
Failover numberThreshold - Remote IP monitoring failover threshold (0 - 50).
- pingserver
Flip numberTimeout - Time to wait in minutes before renegotiating after a remote IP monitoring failover.
- pingserver
Monitor stringInterface - Interfaces to check for remote IP monitoring.
- pingserver
Secondary stringForce Reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- pingserver
Slave stringForce Reset - 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).
- vcluster
Id number - Cluster ID.
- vdoms
Get
Ha Vcluster Vdom[] - 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_ inttime - Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
- pingserver_
failover_ intthreshold - Remote IP monitoring failover threshold (0 - 50).
- pingserver_
flip_ inttimeout - Time to wait in minutes before renegotiating after a remote IP monitoring failover.
- pingserver_
monitor_ strinterface - Interfaces to check for remote IP monitoring.
- pingserver_
secondary_ strforce_ reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- pingserver_
slave_ strforce_ reset - 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[Get
Ha Vcluster Vdom] - 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).
- override
Wait NumberTime - Delay negotiating if override is enabled (0 - 3600 sec). Reduces how often the cluster negotiates.
- pingserver
Failover NumberThreshold - Remote IP monitoring failover threshold (0 - 50).
- pingserver
Flip NumberTimeout - Time to wait in minutes before renegotiating after a remote IP monitoring failover.
- pingserver
Monitor StringInterface - Interfaces to check for remote IP monitoring.
- pingserver
Secondary StringForce Reset - Enable to force the cluster to negotiate after a remote IP monitoring failover.
- pingserver
Slave StringForce Reset - 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).
- vcluster
Id 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.