Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lasseoe/zabbixctl

The most effective way for operating Zabbix servers on the command line
https://github.com/lasseoe/zabbixctl

zabbix zabbix-api

Last synced: about 1 month ago
JSON representation

The most effective way for operating Zabbix servers on the command line

Awesome Lists containing this project

README 

        
[![CI](https://github.com/lasseoe/zabbixctl/actions/workflows/go.yml/badge.svg)](https://github.com/lasseoe/zabbixctl/actions/workflows/go.yml) ![license](https://img.shields.io/github/license/lasseoe/zabbixctl)



[![zabbixctl](https://zabbixctl.com/img/zabbixctl-gh-logo.png)](https://zabbixctl.com)



**zabbixctl** is a tool for working with the Zabbix server API using the command line

interface, it provides an effective way for operating on trigger status,

latest host data and groups of users.



![dashboard](http://i.imgur.com/0WZkMN0.gif)



## :information_source: State of the project



### 2023-07-13

It would appear that the original project is dead, so I decided to clone it and will bring it up to date & add a lot of new features.

Suggestions are most welcome, please [create an issue](https://github.com/lasseoe/zabbixctl/issues) and describe what you'd like to see added or changed.



### 2023-07-23

- [x] Support for Zabbix v5.0 and above (support for <5.0 has been dropped).

- [x] Item type names are now correctly reported.

- [x] Support natural language date & times ([examples](https://zabbixctl.com/datetime.html)).

- [x] Override password config setting with env ZABBIXCTL_USERPASS.

- [x] Allow insecure HTTPS using "insecure" config setting.

- [ ] Documentation is a work in progress.



## Installation



Binaries are published on the [release page](https://github.com/lasseoe/zabbixctl/releases).



If you prefer to install from source and have Go installed, it's as simple as



```

go get github.com/lasseoe/zabbixctl

```



afterwards the executable will be available at `$GOPATH/bin/zabbixctl`



## Configuration



**zabbixctl** reads its configuration from ~/.config/zabbixctl.conf and must be

written using the following syntax:



```toml

[server]

  address  = "https://zabbix.local"

  username = "admin"

  password = "password"

  insecure = "false"



[session]

  path = "~/.cache/zabbixctl.session"

```



**zabbixctl** will authorize against 'zabbix.local' using given user

credentials and save a Zabbix session to a file `~/.cache/zabbixctl.session`

and at second run will use saved session instead of re-authorizing.

Zabbix sessions have a default TTL of 15 minutes, so if the saved Zabbix

session is outdated, zabbixctl will repeat authorization and rewrite the

session file.

The *password* setting is now optional and zabbixctl will use the password

found in environment variable ZABBIXCTL_USERPASS, if present.



## Usage



####  -T --triggers

Search on zabbix triggers statuses. Triggers could be filtered using

/ argument, for example, search and acknowledge all triggers in a

problem state and match the word 'cache':

```

  zabbixctl -Tp /cache

```



##### -y --only-nack

Show only not acknowledged triggers.



##### -x --severity

Specify minimum trigger severity.  Once for information, twice for

warning, three for disaster, four for high, five for disaster.



##### -p --problem

Show triggers that have a problem state.



##### -r --recent

Show triggers that have recently been in a problem state.



##### -s --since 

Show triggers that have changed their state after the given time, default: 7

days ago



##### -u --until 

Show triggers that have changed their state before the given time.



##### -m --maintenance

Show hosts in maintenance.



##### -i --sort 

Show triggers sorted by specified fields, default: lastchange,priority.



##### -o --order 

Show triggers in specified order, default: DESC.



##### -n --limit 

Show specified amount of triggers.



##### -k --acknowledge

Acknowledge all retrieved triggers.



##### -f --noconfirm

Do not prompt acknowledge confirmation dialog.



####  -L --latest-data

Search and show latest data for specified host(s). Hosts can be searched using

wildcard character '*'.  Latest data can be filtered using / argument,

for example retrieve latest data for database nodes and search information

about replication:



```

zabbixctl -L dbnode* /replication

```



##### -g --graph

Show links on graph pages.



#####  -G --groups

Search and operate on configuration of users groups.



##### -l --list

Show list users in specified users group.



##### -a --add

Add specified  to specified users group.



##### -r --remove

Remove specified  from speicifed users group.



##### -f --noconfirm

Do not prompt confirmation dialog.



##### -w --stacked | -b --normal

Returns single link which points to the stacked or normal graph for matched

items.



#### -M --maintenances

Search and operate on configuration of maintenance. Maintenance could be

filtered using / argument, for example, search maintenance match the

word 'update-kernel':



```

zabbixctl -M dbnode-* /update-kernel

```



##### -a --add

Add new specified  with timeperiod type once.



##### -r --remove

Remove specified .



#### -H --hosts

Search and operate with host.



```

zabbixctl -H dbnode-*

```



##### -r --remove

Remove specified .



## Examples



### Listing triggers in a problem state



```

zabbixctl -Tp

```



### Listing triggers that have recenty been in a problem state



```

zabbixctl -Tr

```



### Listing and filtering triggers that contain a word mysql



```

zabbixctl -T /mysql

```



### Listing and acknowledging triggers that severity level is DISASTER



```

zabbixctl -T -xxxxx -k

```



### Listing latest data for db nodes and filtering for information about replication lag



```

zabbixctl -L dbnode* /lag

```



### Opening stacked graph for CPU quote use of selected containers



```

zabbixctl -L 'container-*' /cpu quota --stacked

```



### Listing users groups that starts with 'HTTP_'



```

zabbixctl -G HTTP_*

```



### Listing users groups that contain user admin



```

zabbixctl -G /admin

```



### Adding user admin to groups that contain user guest



```

zabbixctl -G /guest -a admin

```



### Listing maintenances period



```

zabbixctl -M

```



### Listing maintenances period with hostname like 'dbnode*'



```

zabbixctl -M dbnode*

```



### Listing maintenances period with hostname like 'dbnode*' with filter

maintenance name update-kernel



```

zabbixctl -M dbnode* /update-kernel

```



### Add maintenance period name update-kernel with hostname like 'dbnode*'



```

zabbixctl -M dbnode* -a update-kernel

```



### Add maintenance period name update-kernel with host from stdin (must be flag -f)



axfr is a tool of your choice for retrieving domain information from your infrastructure DNS.



```

axfr | grep phpnode | zabbixctl -M -z -a update-kernel -f

```



### Add maintenance period name update-kernel with hostname like 'dbnode*' and read additional

host from stdin (must be flag -f)



axfr is a tool of your choice for retrieving domain information from your infrastructure DNS.



```

axfr | grep phpnode | zabbixctl -M -z dbnode* -a update-kernel -f

```



### Remove maintenance period name update-kernel



```

zabbixctl -M -r update-kernel

```



### Search host with hostname like 'dbnode*'



```

zabbixctl -H dbnode*

```



### Remove host with hostname 'dbnode1' (full uniq name)



```

zabbixctl -H -r dbnode1

```



## License



MIT.