Xitogent CLI | Xitoring Document

Xitogent CLI

Xitogent will come with a lot of CLI features, You can easily manage the agent, including enabling or disabling an integration, pause, manage service, perform manual discovery, or gather information for debugging.

First of all, you can see a list of commands and arguments with:

xitogent help
1

It will show the below list:

Xitogent CLI

Commands:

help                  display help information
version               Show xitogent version
register              Add this server to your Xitoring account
start                 Start xitogent
pause                 Pause xitogent
unpause               Unpause xitogent
discover              Manually request for an IP scan (xitoring can automatically scan and add checks if you let it through server options)
integrate             Setup integration with supported softwares
integration-disable   Disable an integration
test                  Tests xitogent
debug                 Gathers some data for debugging
diagnosis             Runs some tests
unregister            Remove server on your control panel
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

Also, you can see the sub-arguments of command for example you can type:

xitogent help register
1

and it will show you a list of arguments that you can use with the register:

Add this server to your Xitoring account

Options:

-h, --help             display help information
-k, --key             *Your unique account API key for adding a new server - found on your control panel (required)
-g, --group            Servers group name (string)
-s, --subgroup         Servers subgroup name (string)
-n, --notification     Notification role (string)
-d, --auto_discovery   Automatically detect new services
-t, --auto_trigger     Automatically detect and create trigger when server added
-u, --auto_update      Enable auto update for xitogent
-p, --module_ping      Create ping check automatically
-l, --module_http      Create http check automatically
-b, --module_dns       Create dns check automatically
-f, --module_ftp       Create ftp check automatically
-m, --module_smtp      Create smtp check automatically
-i, --module_imap      Create imap check automatically
-o, --module_pop3      Create pop3 check automatically
-4, --ipv4             Detect IP v4
-6, --ipv6             Detect IP v6
-r, --heartbeat        Create xitogent heartbeat check automatically
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Last Updated: 12/14/2023, 11:58:46 AM