network cluster-ip-service

The network cluster-ip-service command monitors the cluster IP (VIP) services shared between two devices and restarts them when needed. The VIPs themselves are defined with the network ip command by selecting --ipType cluster; this command shows the running state of those services.

There is no adding or deleting in this command

The service is created by itself when a cluster address is defined. The add, update and delete subcommands are not present; there are only status and restart.

Command Summary

TR7 WEB-CLI · network cluster-ip-service

# Tab after the command

admin@TR7LBWAF01> network cluster-ip-service

restart status

 

admin@TR7LBWAF01> network cluster-ip-service status list <vdevice> # the status of all of them

admin@TR7LBWAF01> network cluster-ip-service status id <vdevice> <table> # the status of one

admin@TR7LBWAF01> network cluster-ip-service restart <vdevice> namespace <table>

admin@TR7LBWAF01>  

Querying the Status

The status list brings the running state of all the cluster IP services in a region; in every row there are the identifier of the service, the routing table index, the service name and its current state. The status id gives the same information for a single service. Both of them are read-only operations; they do not change any configuration.

In both commands the vDevice, and in the status id command additionally the routing table, are written without the field name, directly as a value and in the following order.

Order	Field	Status	Value
1	v-device	Required	The vDevice whose services will be queried; Tab lists them
2	namespace	Required	Only in the status id command; the routing table of the service whose status will be queried

Field	What it does	What is written after it
--output	Selects the format of the output	json · jsonp · tab · comma · semicolon · compact · default
--filter	Filters the output	The text to be searched; the matching ones are highlighted

Restarting

Order	Field	Status	Value
1	v-device	Required	The vDevice on which the operation will be done. The field name is not written, the value is written right after the restart word
2	namespace	Required	The routing table of the service to be restarted; it is written together with the field name

Field	What it does	What is written after it
--hardReload	Determines how the restart will be done	false (the default) the soft restart · true the hard reload that stops and starts the service forcibly

The hard reload creates a short interruption

According to the explanation in the schema, the hard reload provides a clean state but can lead to a short service interruption. In the production environments the soft restart should be preferred as much as possible.

Examples

TR7 WEB-CLI · status and restart

# look at the status first

admin@TR7LBWAF01> network cluster-ip-service status list Host

admin@TR7LBWAF01> network cluster-ip-service status id Host DEFAULT

 

# the soft restart

admin@TR7LBWAF01> network cluster-ip-service restart Host namespace DEFAULT

 

# the hard reload: there can be a short interruption

admin@TR7LBWAF01> network cluster-ip-service restart Host namespace DEFAULT --hardReload true

admin@TR7LBWAF01>  

Things to Know

• The service is born together with the cluster address. In the network ip record, when --ipType cluster is selected, the related service is created as well; it is not added manually.
• The routing table is the identifier of the service. Which service is targeted in the restart is determined with the namespace field.
• Querying the status does not change the configuration. The status list and status id only read.
• The vDevice is written without the field name. In all three commands the vDevice is a path parameter: the CLI expects it as a value right after the command word; it is not written in the --v-device form.
• The address takeover settings are in the interface. With which method the VIP will be taken over is determined in the network interface record, with the --clusterIpMethod and --advertInt fields.