1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
|
from __future__ import annotations
import ipaddress
from typing import Optional
import typer
from zabbix_cli._v2_compat import ARGS_POSITIONAL
from zabbix_cli.app import Example
from zabbix_cli.app import app
from zabbix_cli.commands.common.args import OPTION_LIMIT
from zabbix_cli.exceptions import ZabbixCLIError
from zabbix_cli.exceptions import ZabbixNotFoundError
from zabbix_cli.output.console import exit_err
from zabbix_cli.output.console import info
from zabbix_cli.output.render import render_result
from zabbix_cli.pyzabbix.enums import ActiveInterface
from zabbix_cli.pyzabbix.enums import InterfaceType
from zabbix_cli.pyzabbix.enums import InventoryMode
from zabbix_cli.pyzabbix.enums import MonitoringStatus
from zabbix_cli.utils.args import check_at_least_one_option_set
from zabbix_cli.utils.args import parse_list_arg
from zabbix_cli.utils.args import resolve_option
HELP_PANEL = "Host"
@app.command(name="create_host", rich_help_panel=HELP_PANEL)
def create_host(
ctx: typer.Context,
hostname_or_ip: str = typer.Argument(
help="Hostname or IP",
show_default=False,
),
hostgroups: Optional[str] = typer.Option(
None,
"--hostgroup",
help="Hostgroup name(s) or ID(s). Comma-separated.",
),
proxy: Optional[str] = typer.Option(
".+",
"--proxy",
help="Proxy server used to monitor the host. Supports regular expressions.",
),
status: MonitoringStatus = typer.Option(
MonitoringStatus.ON.value,
"--status",
help="Host monitoring status.",
),
default_hostgroup: bool = typer.Option(
True,
"--default-hostgroup/--no-default-hostgroup",
help="Add host to default host group(s) defined in config.",
),
name: Optional[str] = typer.Option(
None,
"--name",
help="Visible name of the host. Uses hostname or IP if omitted.",
),
description: Optional[str] = typer.Option(
None,
"--description",
help="Description of the host.",
),
create_interface: Optional[bool] = typer.Option(
None,
"--create-interface/--no-create-interface",
help="Do not create an interface for the host.",
),
# LEGACY: V2-style positional args
args: Optional[list[str]] = ARGS_POSITIONAL,
) -> None:
"""Create a host.
Always adds the host to the default host group unless --no-default-hostgroup
is specified.
Selects a random proxy by default unless [option]--proxy[/] [value]-[/] is specified.
Creates an interface for the host by default unless [option]--no-interface[/] is specified.
"""
# NOTE: this was one of the first commands ported over to V3, and as such
# it uses a lot of V2 semantics and patterns. It should be changed to have
# less implicit behavior such as default hostgroups.
from zabbix_cli.models import Result
from zabbix_cli.output.formatting.grammar import pluralize_no_count as pnc
from zabbix_cli.pyzabbix.types import HostInterface
from zabbix_cli.pyzabbix.utils import get_random_proxy
if args:
if len(args) != 3:
# Hostname + legacy args = 4
exit_err("create_host takes exactly 4 positional arguments.")
hostgroups = args[0]
proxy = args[1]
status = MonitoringStatus(args[2])
host_name = name or hostname_or_ip
if app.state.client.host_exists(host_name):
exit_err(f"Host {host_name!r} already exists")
# Check if we are using a hostname or IP
try:
ipaddress.ip_address(hostname_or_ip)
except ValueError:
useip = False
interface_ip = ""
interface_dns = hostname_or_ip
else:
useip = True
interface_ip = hostname_or_ip
interface_dns = ""
interfaces: list[HostInterface] = []
create_iface_opt = app.state.config.app.commands.create_host.create_interface
if resolve_option(create_interface, create_iface_opt):
interfaces.append(
HostInterface(
type=InterfaceType.AGENT.as_api_value(),
main=True,
useip=useip,
ip=interface_ip,
dns=interface_dns,
port=InterfaceType.AGENT.get_port(),
)
)
# Determine host group IDs
hg_args: list[str] = []
# Default host groups from config
def_hgs = app.state.config.app.default_hostgroups
if default_hostgroup and def_hgs:
grp = pnc("group", len(def_hgs)) # pluralize
info(f"Will add host to default host {grp}: {', '.join(def_hgs)}")
hg_args.extend(def_hgs)
# Host group args
if hostgroups:
hostgroup_args = parse_list_arg(hostgroups)
hg_args.extend(hostgroup_args)
hgs = [app.state.client.get_hostgroup(hg) for hg in set(hg_args)]
if not hgs:
raise ZabbixCLIError("Unable to create a host without at least one host group.")
# Find a proxy (No match = monitored by zabbix server)
try:
prox = get_random_proxy(app.state.client, pattern=proxy)
except ZabbixNotFoundError:
prox = None
if app.state.client.host_exists(hostname_or_ip):
exit_err(f"Host {hostname_or_ip!r} already exists.")
host_id = app.state.client.create_host(
host_name,
groups=hgs,
proxy=prox,
status=status,
interfaces=interfaces,
inventory_mode=InventoryMode.AUTOMATIC,
inventory={"name": hostname_or_ip},
description=description,
)
render_result(Result(message=f"Created host {host_name!r} ({host_id})"))
@app.command(name="remove_host", rich_help_panel=HELP_PANEL)
def remove_host(
ctx: typer.Context,
hostname: str = typer.Argument(
help="Name of host to remove.",
show_default=False,
),
) -> None:
"""Delete a host."""
from zabbix_cli.models import Result
host = app.state.client.get_host(hostname)
app.state.client.delete_host(host.hostid)
render_result(Result(message=f"Removed host {hostname!r}."))
@app.command(name="show_host", rich_help_panel=HELP_PANEL)
def show_host(
ctx: typer.Context,
hostname_or_id: str = typer.Argument(
help="Hostname or ID.",
show_default=False,
),
active: Optional[ActiveInterface] = typer.Option(
None,
"--active",
help="Active interface availability.",
case_sensitive=False,
),
maintenance: Optional[bool] = typer.Option(
None,
"--maintenance/--no-maintenance",
help="Maintenance status.",
show_default=False,
),
monitored: Optional[bool] = typer.Option(
None,
"--monitored/--no-monitored",
help="Monitoring status.",
show_default=False,
),
# This is the legacy filter argument from V2
filter_legacy: Optional[str] = typer.Argument(None, hidden=True),
) -> None:
"""Show a specific host."""
from zabbix_cli.commands.results.host import HostFilterArgs
from zabbix_cli.pyzabbix.utils import get_proxy_map
args = HostFilterArgs.from_command_args(
filter_legacy, active, maintenance, monitored
)
host = app.state.client.get_host(
hostname_or_id,
select_groups=True,
select_templates=True,
select_interfaces=True,
sort_field="host",
sort_order="ASC",
search=True, # we allow wildcard patterns
maintenance=args.maintenance_status,
monitored=args.status,
active_interface=args.active,
)
# HACK: inject proxy map to host for rendering
# TODO: cache the proxy map for some time? In case we run show_host multiple times
proxy_map = get_proxy_map(app.state.client)
host.set_proxy(proxy_map)
render_result(host)
@app.command(
name="show_hosts",
rich_help_panel=HELP_PANEL,
examples=[
Example(
"Show all monitored (enabled) hosts",
"show_hosts --monitored",
),
Example(
"Show all hosts with names ending in '.example.com'",
"show_hosts '*.example.com'",
),
Example(
"Show all hosts with names ending in '.example.com' or '.example.net'",
"show_hosts '*.example.com,*.example.net'",
),
Example(
"Show all hosts with names ending in '.example.com' or '.example.net'",
"show_hosts '*.example.com,*.example.net'",
),
Example(
"Show all hosts from a given hostgroup",
"show_hosts --hostgroup 'Linux servers'",
),
],
)
def show_hosts(
ctx: typer.Context,
hostname_or_id: Optional[str] = typer.Argument(
None,
help="Hostname pattern or ID to filter by. Comma-separated. Supports wildcards.",
show_default=False,
),
hostgroup: Optional[str] = typer.Option(
None,
"--hostgroup",
help="Hostgroup name(s) or ID(s). Comma-separated.",
),
active: Optional[ActiveInterface] = typer.Option(
None,
"--active",
help="Active interface availability.",
case_sensitive=False,
),
maintenance: Optional[bool] = typer.Option(
None,
"--maintenance/--no-maintenance",
help="Maintenance status.",
show_default=False,
),
monitored: Optional[bool] = typer.Option(
None,
"--monitored/--unmonitored",
help="Monitoring status.",
show_default=False,
),
limit: int = OPTION_LIMIT,
# V2 Legacy filter argument
filter_legacy: Optional[str] = typer.Argument(None, hidden=True),
# TODO: add sorting mode?
) -> None:
"""Show all hosts.
Hosts can be filtered by agent, monitoring and maintenance status.
Hosts are sorted by name.
"""
from zabbix_cli.commands.results.host import HostFilterArgs
from zabbix_cli.models import AggregateResult
from zabbix_cli.pyzabbix.utils import get_proxy_map
# Unified parsing of legacy and V3-style filter arguments
args = HostFilterArgs.from_command_args(
filter_legacy, active, maintenance, monitored
)
hostnames_or_ids = parse_list_arg(hostname_or_id)
hgs = parse_list_arg(hostgroup)
hostgroups = [app.state.client.get_hostgroup(hg) for hg in hgs]
with app.status("Fetching hosts..."):
hosts = app.state.client.get_hosts(
*hostnames_or_ids,
select_groups=True,
select_templates=True,
sort_field="host",
sort_order="ASC",
search=True, # we use a wildcard pattern here!
maintenance=args.maintenance_status,
monitored=args.status,
active_interface=args.active,
limit=limit,
hostgroups=hostgroups,
)
# HACK: inject proxy map for each host
# By default, each host only has a proxy ID.
# We need to determine inside each host object which
# Proxy object to select
proxy_map = get_proxy_map(app.state.client)
for host in hosts:
host.set_proxy(proxy_map)
render_result(AggregateResult(result=hosts))
@app.command(name="update_host", rich_help_panel=HELP_PANEL)
def update_host(
ctx: typer.Context,
hostname_or_ip: str = typer.Argument(
help="Hostname or IP",
show_default=False,
),
name: Optional[str] = typer.Option(
None,
"--name",
help="Visible name of the host.",
),
description: Optional[str] = typer.Option(
None,
"--description",
help="Description of the host.",
),
) -> None:
"""Update basic information about a host.
Other notable commands to update a host:
- [command]add_host_to_hostgroup[/]
- [command]create_host_interface[/]
- [command]monitor_host[/]
- [command]remove_host_from_hostgroup[/]
- [command]update_host_interface[/]
- [command]update_host_inventory[/]
"""
from zabbix_cli.models import Result
check_at_least_one_option_set(ctx)
host = app.state.client.get_host(hostname_or_ip)
app.state.client.update_host(
host,
name=name,
description=description,
)
render_result(Result(message=f"Updated host {host}."))
|