ltm rule command LB status

iRule(1)					  BIG-IP TMSH Manual					     iRule(1)

LB::status
       Returns the status of a node address or pool member.

SYNOPSIS
       LB::status (LB_STATUS)?

       LB::status node IP_ADDR (LB_STATUS)?

       LB::status pool POOL_OBJ member IP_ADDR PORT (LB_STATUS)?

DESCRIPTION
       Returns the status of a node address or pool member. Possible status values are up, down, session_enabled, and
       session_disabled. If you supply no arguments, returns the status of the currently-selected pool member.
       Syntax:
	   LB::status
	   LB::status node 

	   LB::status pool  member  
	   LB::status 
	   LB::status node 
 
	   LB::status pool  member 
  

       Slight difference for GTM syntax, rather than node, use vs:
	   LB::status vs  
	   LB::status vs   

RETURN VALUE
       LB::status
	   Returns the status of the currently-selected node (after LB_SELECTED event only). Possible values are: up
       | down | session_enabled | session_disabled

       LB::status node 
	   Returns the status of the node with the specified IP address. Possible values are: up | down |
       session_enabled | session_disabled

       LB::status pool  member  X
	   Returns the status of the specified pool member. Possible values are: up | down | session_enabled |
       session_disabled

       LB::status X
	   Returns TRUE if the status of the currently-selected node matches the specified status argument.

       LB::status node 
 X
	   Returns TRUE if the status of the specified node matches the specified status argument.

       LB::status pool  member 
  X
	   Returns TRUE if the status of the specified pool member matches the specified argument. (This syntax
       doesn't seem to be working as expected in 9.2.3 at least... use alternate syntax in Example below)

VALID DURING
       ANY_EVENT

EXAMPLES
	when LB_FAILED {
	    if { [LB::status pool $poolname member $ip $port] eq "down" } {
		log "Server $ip $port down!"
	    }
	}

HINTS
SEE ALSO
       Sample code: Load balancing based on ASP SessionID
        Open SSO Authentication
        Pool Member Status Page on a Virtual
       Server v9 
       Site_Maintenance_Trigger 

CHANGE LOG
       @BIGIP-10.0.0 --First introduced the command.

BIG-IP						      2020-06-23					     iRule(1)