ha

Documentation

Index

• type Hafailover
• type Hafiles
• type Hanode
• type Hanodebinding
• type Hanodecibinding
• type Hanodefisbinding
• type Hanodepartialfailureinterfacesbinding
• type Hanoderoutemonitor6binding
• type Hanoderoutemonitorbinding
• type Hasync
• type Hasyncfailures

Types

type Hafailover

type Hafailover struct {
	/**
	* Force a failover without prompting for confirmation.
	 */
	Force bool `json:"force,omitempty"`
}

* * Configuration for failover resource.

type Hafiles

type Hafiles struct {
	/**
	* Specify one of the following modes of synchronization.
		* all - Synchronize files related to system configuration, Access Gateway bookmarks, SSL certificates, SSL CRL lists, HTML injection scripts, and Application Firewall XML objects.
		* bookmarks - Synchronize all Access Gateway bookmarks.
		* ssl - Synchronize all certificates, keys, and CRLs for the SSL feature.
		* htmlinjection. Synchronize all scripts configured for the HTML injection feature.
		* imports. Synchronize all XML objects (for example, WSDLs, schemas, error pages) configured for the application firewall.
		* misc - Synchronize all license files and the rc.conf file.
		* all_plus_misc - Synchronize files related to system configuration, Access Gateway bookmarks, SSL certificates, SSL CRL lists, HTML injection scripts, application firewall XML objects, licenses, and the rc.conf file.
	*/
	Mode []string `json:"mode,omitempty"`
}

* * Configuration for files resource.

type Hanode

type Hanode struct {
	/**
	* Number that uniquely identifies the node. For self node, it will always be 0. Peer node values can range from 1-64.
	 */
	Id int `json:"id"`
	/**
	* The NSIP or NSIP6 address of the node to be added for an HA configuration. This setting is neither propagated nor synchronized.
	 */
	Ipaddress string `json:"ipaddress,omitempty"`
	/**
	* This option is required if the HA nodes reside on different networks. When this mode is enabled, the following independent network entities and configurations are neither propagated nor synced to the other node: MIPs, SNIPs, VLANs, routes (except LLB routes), route monitors, RNAT rules (except any RNAT rule with a VIP as the NAT IP), and dynamic routing configurations. They are maintained independently on each node.
	 */
	Inc string `json:"inc,omitempty"`
	/**
	* The HA status of the node. The HA status STAYSECONDARY is used to force the secondary device stay as secondary independent of the state of the Primary device. For example, in an existing HA setup, the Primary node has to be upgraded and this process would take few seconds. During the upgradation, it is possible that the Primary node may suffer from a downtime for a few seconds. However, the Secondary should not take over as the Primary node. Thus, the Secondary node should remain as Secondary even if there is a failure in the Primary node.
		STAYPRIMARY configuration keeps the node in primary state in case if it is healthy, even if the peer node was the primary node initially. If the node with STAYPRIMARY setting (and no peer node) is added to a primary node (which has this node as the peer) then this node takes over as the new primary and the older node becomes secondary. ENABLED state means normal HA operation without any constraints/preferences. DISABLED state disables the normal HA operation of the node.
	*/
	Hastatus string `json:"hastatus,omitempty"`
	/**
	* Automatically maintain synchronization by duplicating the configuration of the primary node on the secondary node. This setting is not propagated. Automatic synchronization requires that this setting be enabled (the default) on the current secondary node. Synchronization uses TCP port 3010.
	 */
	Hasync string `json:"hasync,omitempty"`
	/**
	* Automatically propagate all commands from the primary to the secondary node, except the following:
		* All HA configuration related commands. For example, add ha node, set ha node, and bind ha node.
		* All Interface related commands. For example, set interface and unset interface.
		* All channels related commands. For example, add channel, set channel, and bind channel.
		The propagated command is executed on the secondary node before it is executed on the primary. If command propagation fails, or if command execution fails on the secondary, the primary node executes the command and logs an error.  Command propagation uses port 3010.
		Note: After enabling propagation, run force synchronization on either node.
	*/
	Haprop string `json:"haprop,omitempty"`
	/**
	* Interval, in milliseconds, between heartbeat messages sent to the peer node. The heartbeat messages are UDP packets sent to port 3003 of the peer node.
	 */
	Hellointerval int `json:"hellointerval,omitempty"`
	/**
	* Number of seconds after which a peer node is marked DOWN if heartbeat messages are not received from the peer node.
	 */
	Deadinterval int `json:"deadinterval,omitempty"`
	/**
	* Keep one node primary if both nodes fail the health check, so that a partially available node can back up data and handle traffic. This mode is set independently on each node.
	 */
	Failsafe string `json:"failsafe,omitempty"`
	/**
	* Max number of flips allowed before becoming sticky primary
	 */
	Maxflips int `json:"maxflips,omitempty"`
	/**
	* Interval after which flipping of node states can again start
	 */
	Maxfliptime int `json:"maxfliptime,omitempty"`
	/**
	* Vlan on which HA related communication is sent. This include sync, propagation , connection mirroring , LB persistency config sync, persistent session sync and session state sync. However HA heartbeats can go all interfaces.
	 */
	Syncvlan int `json:"syncvlan,omitempty"`
	/**
	* strict mode flag for sync status
	 */
	Syncstatusstrictmode string `json:"syncstatusstrictmode,omitempty"`

	Name                string `json:"name,omitempty"`
	Flags               string `json:"flags,omitempty"`
	State               string `json:"state,omitempty"`
	Enaifaces           string `json:"enaifaces,omitempty"`
	Disifaces           string `json:"disifaces,omitempty"`
	Hamonifaces         string `json:"hamonifaces,omitempty"`
	Haheartbeatifaces   string `json:"haheartbeatifaces,omitempty"`
	Pfifaces            string `json:"pfifaces,omitempty"`
	Ifaces              string `json:"ifaces,omitempty"`
	Netmask             string `json:"netmask,omitempty"`
	Ssl2                string `json:"ssl2,omitempty"`
	Masterstatetime     string `json:"masterstatetime,omitempty"`
	Routemonitor        string `json:"routemonitor,omitempty"`
	Curflips            string `json:"curflips,omitempty"`
	Completedfliptime   string `json:"completedfliptime,omitempty"`
	Routemonitorstate   string `json:"routemonitorstate,omitempty"`
	Hasyncfailurereason string `json:"hasyncfailurereason,omitempty"`
}

* * Configuration for node resource.

type Hanodebinding

type Hanodebinding struct {
	/**
	* ID of the node whose HA settings you want to display. (The ID of the local node is always 0.).<br/>Minimum value =  0<br/>Maximum value =  64
	 */
	Id int `json:"id,omitempty"`
}

* * Binding object which returns the resources bound to hanode_binding.

type Hanodecibinding

type Hanodecibinding struct {
	/**
	* Enabled interfaces.
	 */
	Enaifaces string `json:"enaifaces,omitempty"`
	/**
	* Number that uniquely identifies the local node. The ID of the local node is always 0.
	 */
	Id int `json:"id,omitempty"`
	/**
	* A route that you want the Citrix ADC to monitor in its internal routing table. You can specify an IPv4 address or network, or an IPv6 address or network prefix. If you specify an IPv4 network address or IPv6 network prefix, the appliance monitors any route that matches the network or prefix.
	 */
	Routemonitor string `json:"routemonitor,omitempty"`
}

* * Binding class showing the ci that can be bound to hanode.

type Hanodefisbinding

type Hanodefisbinding struct {
	/**
	* Node Name.
	 */
	Name string `json:"name,omitempty"`
	/**
	* Enabled interfaces.
	 */
	Enaifaces string `json:"enaifaces,omitempty"`
	/**
	* Number that uniquely identifies the local node. The ID of the local node is always 0.
	 */
	Id int `json:"id,omitempty"`
	/**
	* A route that you want the Citrix ADC to monitor in its internal routing table. You can specify an IPv4 address or network, or an IPv6 address or network prefix. If you specify an IPv4 network address or IPv6 network prefix, the appliance monitors any route that matches the network or prefix.
	 */
	Routemonitor string `json:"routemonitor,omitempty"`
}

* * Binding class showing the fis that can be bound to hanode.

type Hanodepartialfailureinterfacesbinding

type Hanodepartialfailureinterfacesbinding struct {
	/**
	* Interfaces causing Partial Failure.
	 */
	Pfifaces string `json:"pfifaces,omitempty"`
	/**
	* Number that uniquely identifies the local node. The ID of the local node is always 0.
	 */
	Id int `json:"id,omitempty"`
	/**
	* A route that you want the Citrix ADC to monitor in its internal routing table. You can specify an IPv4 address or network, or an IPv6 address or network prefix. If you specify an IPv4 network address or IPv6 network prefix, the appliance monitors any route that matches the network or prefix.
	 */
	Routemonitor string `json:"routemonitor,omitempty"`
}

* * Binding class showing the partialfailureinterfaces that can be bound to hanode.

type Hanoderoutemonitor6binding

type Hanoderoutemonitor6binding struct {
	/**
	* The IP address (IPv4 or IPv6).
	 */
	Routemonitor string `json:"routemonitor,omitempty"`
	/**
	* The netmask.
	 */
	Netmask string `json:"netmask,omitempty"`
	/**
	* The flags for this entry.
	 */
	Flags int `json:"flags,omitempty"`
	/**
	* State for route monitor
	 */
	Routemonitorstate string `json:"routemonitorstate,omitempty"`
	/**
	* Number that uniquely identifies the local node. The ID of the local node is always 0.
	 */
	Id int `json:"id"`
}

* * Binding class showing the routemonitor6 that can be bound to hanode.

type Hanoderoutemonitorbinding

type Hanoderoutemonitorbinding struct {
	/**
	* The IP address (IPv4 or IPv6).
	 */
	Routemonitor string `json:"routemonitor,omitempty"`
	/**
	* The netmask.
	 */
	Netmask string `json:"netmask,omitempty"`
	/**
	* The flags for this entry.
	 */
	Flags int `json:"flags,omitempty"`
	/**
	* State for route monitor
	 */
	Routemonitorstate string `json:"routemonitorstate,omitempty"`
	/**
	* Number that uniquely identifies the local node. The ID of the local node is always 0.
	 */
	Id int `json:"id"`
}

* * Binding class showing the routemonitor that can be bound to hanode.

type Hasync

type Hasync struct {
	/**
	* Force synchronization regardless of the state of HA propagation and HA synchronization on either node.
	 */
	Force bool `json:"force,omitempty"`
	/**
	* After synchronization, automatically save the configuration in the secondary node configuration file (ns.conf) without prompting for confirmation.
	 */
	Save string `json:"save,omitempty"`
}

* * Configuration for sync resource.

type Hasyncfailures

type Hasyncfailures struct {
	Response string `json:"response,omitempty"`
}

* * Configuration for HA sync failures resource.