Module: ha
Inheritance diagram
Configuration tree diagram
Class Reference
High availability objects to configure HA for a firewall or Panorama
- class panos.ha.HA1(*args, **kwargs)[source]
HA1 interface
- Parameters:
ip_address (str) – IP of the interface
netmask (str) – Netmask of the interface
port (str) – Interface to use for this HA interface (eg. ethernet1/5)
gateway (str) – Default gateway of the interface
link_speed (str) – Link speed
link_duplex (str) – Link duplex
monitor_hold_time (int) – Monitor hold time
- class panos.ha.HA1Backup(*args, **kwargs)[source]
HA1 Backup interface
- Parameters:
ip_address (str) – IP of the interface
netmask (str) – Netmask of the interface
port (str) – Interface to use for this HA interface (eg. ethernet1/5)
gateway (str) – Default gateway of the interface
link_speed (str) – Link speed
link_duplex (str) – Link duplex
- class panos.ha.HA2(*args, **kwargs)[source]
HA2 interface
- Parameters:
ip_address (str) – IP of the interface
netmask (str) – Netmask of the interface
port (str) – Interface to use for this HA interface (eg. ethernet1/5)
gateway (str) – Default gateway of the interface
link_speed (str) – Link speed
link_duplex (str) – Link duplex
- class panos.ha.HA2Backup(*args, **kwargs)[source]
HA2 Backup interface
- Parameters:
ip_address (str) – IP of the interface
netmask (str) – Netmask of the interface
port (str) – Interface to use for this HA interface (eg. ethernet1/5)
gateway (str) – Default gateway of the interface
link_speed (str) – Link speed
link_duplex (str) – Link duplex
- class panos.ha.HA3(*args, **kwargs)[source]
HA3 interface
- Parameters:
port (str) – Interface to use for this HA interface (eg. ethernet1/5)
link_speed (str) – Link speed
link_duplex (str) – Link duplex
- class panos.ha.HighAvailability(*args, **kwargs)[source]
High availability configuration base object
All high availability configuration is in this object or is a child of this object
- Parameters:
name – (unused, and may be omitted)
enabled (bool) – Enable HA (Default: True)
group_id (int) – The group identifier
description (str) – Description for HA pairing
config_sync (bool) – Enabled configuration synchronization (Default: True)
peer_ip (str) – HA Peer’s HA1 IP address
mode (str) – Mode of HA: ‘active-passive’ or ‘active-active’ (Default: ‘active-passive’)
passive_link_state (str) – Passive link state
state_sync (bool) – Enabled state synchronization (Default: False)
ha2_keepalive (bool) – Enable HA2 keepalives
ha2_keepalive_action (str) – HA2 keepalive action
ha2_keepalive_threshold (int) – HA2 keepalive threshold
peer_ip_backup (str) – HA Peer’s HA1 backup IP address
device_id (int) – HA3 device id (0 or 1)
session_owner_selection (str) – active-active session owner mode
session_setup (str) – active-active session setup mode
tentative_hold_time (int) – active-active tentative hold timer
sync_qos (bool) – active-active network sync qos
sync_virtual_router (bool) – active-active network sync virtual router
ip_hash_key (str) – active-active hash key used by ip-hash algorithm
- class panos.ha.HighAvailabilityInterface(*args, **kwargs)[source]
Base class for high availability interface classes
Do not instantiate this class. Use its subclasses.
- delete_interface(interface=None, pan_device=None)[source]
Delete the data interface used by this HA interface
- Parameters:
interface (HighAvailabilityInterface) – The HA interface (HA1, HA2, etc)
pan_device (PanDevice) – The PanDevice object to apply the change
- delete_old_interface()[source]
Delete the data interface previously used by this HA interface
Use this if the ‘port’ of an HA interface was changed and the old interface needs to be cleaned up.