Product Documentation

Route Health Injection Based on Virtual Server Settings

The following option and parameter are introduced for controlling the Route Health Injection (RHI) functionality of the Citrix ADC appliance for advertising the route of a VIP address.

  • VSVR_CNTRLD. It is an option for the (Vserver RHI Level) parameter of a VIP address. When this option is set to the Vserver RHI Level parameter, the RHI behavior for advertising the route of the VIP address depends on the RHI STATE parameter setting on all the associated virtual servers of the VIP address along with their states.
  • RHI STATE. It is a parameter of virtual server. You can set the RHI STATE parameter to either PASSIVE or ACTIVE. By default, the RHI STATE parameter is set to PASSIVE.

For a VIP address, when RHI (Vserver RHI Level) parameter is set to VSVR_CNTRLD, the following are different RHI behaviours for the VIP address on the basis of RHI STATE settings on the virtual servers associated with the VIP address:

  • If you set RHI STATE to PASSIVE on all virtual servers, the Citrix ADC always advertises the route for the VIP address.
  • If you set RHI STATE to ACTIVE on all virtual servers, the Citrix ADC advertises the route for the VIP address if at least one of the associated virtual servers is in UP state.
  • If you set RHI STATE to ACTIVE on some and PASSIVE on others, the Citrix ADC advertises the route for the VIP address if at least one of the associated virtual servers, whose RHI STATE set to ACTIVE, is in UP state.

Following table displays the sample RHI behaviour for a VIP address on the basis of RHI STATE settings on the virtual servers associated with the VIP address. The Citrix ADC appliance has two virtual servers V1 and V2 associated with the VIP address:

Associated virtual servers for a VIP State 1 State 2 State 3 State 4
RHI State set to PASSIVE on all virtual servers        
V1 UP UP DOWN DOWN
V2 UP DOWN UP DOWN
Advertise the route for this VIP address? Yes Yes Yes Yes
RHI State set to ACTIVE on all virtual servers        
V1 UP UP DOWN DOWN
V2 UP DOWN UP DOWN
Advertise the route for this VIP address? Yes Yes Yes No
RHI State set to ACTIVE on one virtual server and PASSIVE on the other        
V1 (RHI State = ACTIVE) UP UP DOWN DOWN
V2 (RHI State = PASSIVE) UP DOWN UP DOWN
Advertise the route for this VIP address? Yes Yes No No

To configure RHI for a VIP address, to be based on the RHI (RHI State) parameter setting of the associated virtual servers, perform the following steps:

  • Set the RHI (Vserver RHI Level) parameter to VSVR_CNTRLD for the VIP address.
  • Set the RHI State parameter for each virtual server associated with the VIP address.

To set the vServer RHI Level for a VIP address by using the CLI:

At the command prompt, type:

  • set ns ip <IPAddress> [-vserverRHILevel <vserverRHILevel>]

To set the RHI State parameter of a virtual server by using the CLI:

At the command prompt, type:

  • set lb vserver <name> [-RHIstate ( PASSIVE | ACTIVE )]

To set the vServer RHI Level for a VIP address by using GUI

  1. Navigate to System > Network > IPs.
  2. Select a VIP address, and then click Edit.
  3. Set the Vserver RHI Level parameter to VSVR_CNTRLD, and then click OK.

To set the RHI State parameter of a virtual server by using GUI

  1. Navigate to Traffic Management > Load Balancing > Virtual Servers.
  2. Select a load balancing virtual server, and then click Edit.
  3. Set the RHI State parameter, and then click OK.

Route Health Injection Based on Virtual Server Settings

In this article