ALIVECTL

Description

Client application used to access to information provided by the icmp monitoring daemon (alived)

Command

alivectl [-h] [-B] [-d] [-o] [-v] -s <hostname> | -l | -r <arg> | --dump-config

-h, --help : display this message
-B, --background : execute in background (will not print the results)

-d, --debug : enable debug mode

-o, --libxo <output format> : specify the output format, <output format> may be "text|html|xml|json[,pretty]" (default is "text,pretty")

-m, --force-hamode <arg> : Force alived to reload its configuration with the given ha mode <arg>. Exclusive with other queries. Arg must be one of: "active","passive"

-l, --list <arg> : list hosts monitored by alived. <arg> can be used to filter hosts to display

-s, --show-measure <arg> : show measurements published by alived. <arg> can be used to filter measurements to display with the following values :
	1. "host" : show the measurements for all links (gateway/ha link) of the specified router object or a HA peer.
	2. "host":"link" : show measurements for the link of the specified router object or a HA peer.
	3. :"link" : show measurements for the specified link regardless of the router object or a HA peer.

-c, --show-measure-counter <arg=5> : Number of measurements published by alived to show. To use in combination of -s option. <arg> can't be equal to 0.

-t, --show-measure-timeout <arg=60> : Timeout in seconds to show the measurements published by alived. To use in combination of -s option. <arg> can't be equal to 0.

-r, --reload-config <arg> : make alived reload its configuration. Exclusive with other queries. <arg> must be one of: "verbose", "objects", "all"
--dump-config : dump alived current configuration. Exclusive with other queries

Results

The statistics, the real-time measure and the list of monitored hosts.

Example

VMSNSX00Z0000A0>alivectl -l my_second_router --libxo json,pretty
{
  "RequestStatus": {
    "Status": "ok"
  },
  "Host": {
    "Status": "ok",
    "Result": {
      "my_second_router": [
        {
          "name": "dmz2_other_in",
          "ipAddress": "192.168.61.102",
          "enableMonitoring": 1,
          "endpoints": [
            {
              "target": "192.168.202.254"
            }
          ]
        },
        {
          "name": "target_network2_out",
          "ipAddress": "192.168.202.254",
          "enableMonitoring": 1,
          "endpoints": [
            {
              "target": "8.8.8.8"
            }
          ]
        },
        {
          "name": "dmz2_other_out",
          "ipAddress": "192.168.202.101",
          "enableMonitoring": 1,
          "endpoints": [
            {
              "target": "204.13.248.112"
            },
            {
              "target": "216.146.43.70"
            },
            {
              "target": "8.8.8.8"
            },
            {
              "target": "8.8.4.4"
            },
            {
              "target": "192.168.202.254"
            }
          ]
        }
      ]
    }
  }
}