| getvridResult Structure Definition |
The getvridResult structure defines the return type for getvrid API. |
Syntax |
Members |
rc |
If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings. |
message |
If the method succeeds, message is NULL else message contains Error/Warning message. |
vridList |
List of vrids |
| vrid Structure Definition |
The vrid structure defines the actual return type values for getvrid API. |
Syntax |
Members |
id |
Integer value that uniquely identifies the VMAC address. |
ifaces |
Interfaces bound to this VRID. |
ifnum |
Interfaces to bind to the VMAC, specified in (slot/port) notation (for example, 1/2).Use spaces to separate multiple entries. |
type |
Indicates whether this VRID entry was added manually or dynamically. When you manually add a VRID entry, the value for this parameter is STATIC. Otherwise, it is DYNAMIC. |
vlan |
The VLAN in which this VRID resides. |
priority |
Base priority (BP), in an active-active mode configuration, which ordinarily determines the master VIP address. |
effectivepriority |
The effective priority of this VRID. |
preemption |
In an active-active mode configuration, make a backup VIP address the master if its priority becomes higher than that of a master VIP address bound to this VMAC address.
If you disable pre-emption while a backup VIP address is the master, the backup VIP address remains master until the original master VIP's priority becomes higher than that of the current master. |
sharing |
In an active-active mode configuration, enable the backup VIP address to process any traffic instead of dropping it. |
tracking |
The effective priority (EP) value, relative to the base priority (BP) value in an active-active mode configuration. When EP is set to a value other than None, it is EP, not BP, which determines the master VIP address.
Available settings function as follows:
* NONE - No tracking. EP = BP
* ALL - If the status of all virtual servers is UP, EP = BP. Otherwise, EP = 0.
* ONE - If the status of at least one virtual server is UP, EP = BP. Otherwise, EP = 0.
* PROGRESSIVE - If the status of all virtual servers is UP, EP = BP. If the status of all virtual servers is DOWN, EP = 0. Otherwise EP = BP (1 - K/N), where N is the total number of virtual servers associated with the VIP address and K is the number of virtual servers for which the status is DOWN.
Default: NONE. |
flags |
Flags. |
ipaddress |
The IP address bound to the VRID. |
state |
State of this VRID. |
operationalownernode |
Run time owner node of the vrid. |
ownernode |
In a cluster setup, assign a cluster node as the owner of this VMAC address for IP based VRRP configuration. If no owner is configured, owner node is displayed as ALL and one node is dynamically elected as the owner. |
trackifnum |
Interfaces which need to be tracked for this vrID. |
trackifnumpriority |
Priority by which the Effective priority will be reduced if any of the tracked interfaces goes down in an active-active configuration. |
preemptiondelaytimer |
Preemption delay time, in seconds, in an active-active configuration. If any high priority node will come in network, it will wait for these many seconds before becoming master. |
_nextgenapiresource |
boundip |
vridipbindflags |
boundifaces |
vridvlanbindflags |
vridvlanbindflags2 |
vridipbindflags2 |
See Also |