ha

Documentation

Overview

Package ha is the client.Device.HaConfig namespace.

Normalized object: Config

Index

• Constants
• type Config
  • func (o *Config) Copy(s Config)
  • func (o Config) Specify(v version.Number) (string, interface{})
• type Firewall
  • func FirewallNamespace(client util.XapiClient) *Firewall
  • func (c *Firewall) Delete() error
  • func (c *Firewall) Edit(e Config) error
  • func (c *Firewall) Get() (Config, error)
  • func (c *Firewall) Set(e Config) error
  • func (c *Firewall) Show() (Config, error)
• type Ha1BackupInterface
• type Ha1Interface
• type Ha2Interface
• type Ha3Interface
• type Ha4Interface

Constants

const (
	// Mode Values
	ModeActivePassive = "active-passive"
	ModeActiveActive  = "active-active"

	// ApPassiveLinkState Values
	ApPassiveLinkStateAuto     = "auto"
	ApPassiveLinkStateShutdown = "shutdown"

	// AaSessionOwnerSelection Values
	AaSessionOwnerSelectionPrimaryDevice = "primary-device"
	AaSessionOwnerSelectionFirstPacket   = "first-packet"

	// AaFpSessionSetup Values
	AaFpSessionSetupPrimaryDevice = "primary-device"
	AaFpSessionSetupFirstPacket   = "first-packet"
	AaFpSessionSetupIpModulo      = "ip-modulo"
	AaFpSessionSetupIpHash        = "ip-hash"

	// AaFpSessionSetupIpHashKey Values
	AaFpSessionSetupIpHashKeySource     = "source"
	AaFpSessionSetupIpHashKeySourceDest = "source-and-destination"

	// ElectionTimersMode Values
	ElectionTimersModeRecommended = "recommended"
	ElectionTimersModeAggressive  = "aggressive"
	ElectionTimersModeAdvanced    = "advanced"

	// ElectionTimersAdvFlapMax Values
	ElectionTimersAdvFlapMaxInfinite = "infinite"
	ElectionTimersAdvFlapMaxDisable  = "disable"

	// Ha2StateSyncTransport Values
	Ha2StateSyncTransportEthernet = "ethernet"
	Ha2StateSyncTransportIp       = "ip"
	Ha2StateSyncTransportUdp      = "udp"

	// Ha2StateSyncKeepAliveAction Values
	Ha2StateSyncKeepAliveActionLogOnly       = "log-only"
	Ha2StateSyncKeepAliveActionSplitDatapath = "split-datapath"

	// LinkMonitorFailureCondition Values
	LinkMonitorFailureConditionAny = "any"
	LinkMonitorFailureConditionAll = "all"
)

Types

type Config

type Config struct {
	Enable                 bool
	GroupId                int
	Description            string
	Mode                   string
	PeerHa1IpAddress       string
	BackupPeerHa1IpAddress string
	ConfigSyncEnable       bool

	Ha1       *Ha1Interface
	Ha1Backup *Ha1BackupInterface
	Ha2       *Ha2Interface
	Ha2Backup *Ha2Interface
	Ha3       *Ha3Interface
	Ha4       *Ha4Interface
	Ha4Backup *Ha4Interface

	// active passive
	ApPassiveLinkState        string
	ApMonitorFailHoldDownTime int

	// active active
	AaDeviceId string
	// HA3 packet forwarding
	AaTentativeHoldTime     string
	AaSyncVirtualRouter     bool
	AaSyncQos               bool
	AaSessionOwnerSelection string // primary-device, first-packet
	// session owner selection: first-packet
	AaFpSessionSetup string // primary-device, first-packet, ip-modulo, ip-hash
	// session setup: ip-hash
	AaFpSessionSetupIpHashKey  string
	AaFpSessionSetupIpHashSeed string

	ElectionDevicePriority  string
	ElectionPreemptive      bool
	ElectionHeartBeatBackup bool

	ElectionTimersMode                          string
	ElectionTimersAdvPromotionHoldTime          string
	ElectionTimersAdvHelloInterval              int
	ElectionTimersAdvHeartBeatInterval          int
	ElectionTimersAdvFlapMax                    string
	ElectionTimersAdvPreemptionHoldTime         int
	ElectionTimersAdvMonitorFailHoldUpTime      string
	ElectionTimersAdvAdditionalMasterHoldUpTime string

	Ha2StateSyncEnable             bool
	Ha2StateSyncTransport          string
	Ha2StateSyncKeepAliveEnable    bool
	Ha2StateSyncKeepAliveAction    string
	Ha2StateSyncKeepAliveThreshold int

	LinkMonitorEnable           bool
	LinkMonitorFailureCondition string
	// contains filtered or unexported fields
}

Config is a normalized, version independent representation of a device HA configuration.

func (*Config) Copy

func (o *Config) Copy(s Config)

Copy copies the information from source Config `s` to this object.

func (Config) Specify

func (o Config) Specify(v version.Number) (string, interface{})

type Firewall

type Firewall struct {
	// contains filtered or unexported fields
}

Firewall is the client.Device.HaConfig namespace.

func FirewallNamespace

func FirewallNamespace(client util.XapiClient) *Firewall

FirewallNamespace returns an initialized namespace.

func (*Firewall) Delete

func (c *Firewall) Delete() error

Delete performs DELETE to remove the config.

func (*Firewall) Edit

func (c *Firewall) Edit(e Config) error

Edit performs EDIT to configure the specified object.

func (*Firewall) Get

func (c *Firewall) Get() (Config, error)

Get performs GET to retrieve configuration for the given object.

func (*Firewall) Set

func (c *Firewall) Set(e Config) error

Set performs SET to configure the specified objects.

func (*Firewall) Show

func (c *Firewall) Show() (Config, error)

Show performs SHOW to retrieve configuration for the given object.

type Ha1BackupInterface

type Ha1BackupInterface struct {
	Port      string
	IpAddress string
	Netmask   string
	Gateway   string
}

type Ha1Interface

type Ha1Interface struct {
	Port             string
	IpAddress        string
	Netmask          string
	Gateway          string
	EncryptionEnable bool
	MonitorHoldTime  int
}

type Ha2Interface

type Ha2Interface struct {
	Port      string
	IpAddress string
	Netmask   string
	Gateway   string
}

type Ha3Interface

type Ha3Interface struct {
	Port string
}

type Ha4Interface

type Ha4Interface struct {
	Port      string
	IpAddress string
	Netmask   string
}