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 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
|
from __future__ import annotations
from itertools import chain
from typing import TYPE_CHECKING
from typing import Optional
from typing import Union
import typer
from zabbix_cli.app import Example
from zabbix_cli.app import app
from zabbix_cli.commands.common.args import ARG_GROUP_NAMES_OR_IDS
from zabbix_cli.commands.common.args import ARG_TEMPLATE_NAMES_OR_IDS
from zabbix_cli.output.console import error
from zabbix_cli.output.console import exit_err
from zabbix_cli.output.console import info
from zabbix_cli.output.console import success
from zabbix_cli.output.formatting.grammar import pluralize as p
from zabbix_cli.output.render import render_result
from zabbix_cli.pyzabbix.enums import UsergroupPermission
from zabbix_cli.utils.args import parse_hostgroups_arg
from zabbix_cli.utils.args import parse_list_arg
from zabbix_cli.utils.args import parse_templategroups_arg
from zabbix_cli.utils.args import parse_templates_arg
if TYPE_CHECKING:
from zabbix_cli.pyzabbix.types import HostGroup
from zabbix_cli.pyzabbix.types import TemplateGroup
HELP_PANEL = "Template Group"
# Changed in V3: Changed name to reflect introduction of template groups in >=6.2
@app.command("add_template_to_group", rich_help_panel=HELP_PANEL)
@app.command(
# old name for backwards compatibility
"link_template_to_hostgroup",
hidden=True,
deprecated=True,
rich_help_panel=HELP_PANEL,
help="DEPRECATED: Use add_template_to_group instead.",
)
def add_template_to_group(
ctx: typer.Context,
template_names_or_ids: str = ARG_TEMPLATE_NAMES_OR_IDS,
group_names_or_ids: str = ARG_GROUP_NAMES_OR_IDS,
strict: bool = typer.Option(
False,
"--strict",
help="Fail if any host groups or templates aren't found. Should not be used in conjunction with wildcards.",
),
) -> None:
"""Add templates to groups.
[bold]NOTE:[/] Group arguments are interpreted as template groups in >= 6.2,
otherwise as host groups.
"""
from zabbix_cli.commands.results.template import TemplateGroupResult
groups: Union[list[HostGroup], list[TemplateGroup]]
if app.state.client.version.release >= (6, 2, 0):
groups = parse_templategroups_arg(app, group_names_or_ids, strict=strict)
else:
groups = parse_hostgroups_arg(app, group_names_or_ids, strict=strict)
templates = parse_templates_arg(app, template_names_or_ids, strict=strict)
with app.state.console.status("Adding templates..."):
app.state.client.link_templates_to_groups(templates, groups)
render_result(TemplateGroupResult.from_result(templates, groups))
success(f"Added {len(templates)} templates to {len(groups)} groups.")
@app.command(
"create_templategroup",
rich_help_panel=HELP_PANEL,
examples=[
Example(
"Create a template group with default user group permissions",
"create_templategroup 'My Template Group'",
),
Example(
"Create a template group with specific RO and RW groups",
"create_templategroup 'My Template Group' --ro-groups users --rw-groups admins",
),
Example(
"Create a template group with no user group permissions",
"create_templategroup 'My Template Group' --no-usergroup-permissions",
),
],
)
def create_templategroup(
ctx: typer.Context,
templategroup: str = typer.Argument(
help="Name of the group.",
show_default=False,
),
rw_groups: Optional[str] = typer.Option(
None,
help="User group(s) to give read/write permissions. Comma-separated.",
),
ro_groups: Optional[str] = typer.Option(
None,
help="User group(s) to give read-only permissions. Comma-separated.",
),
no_usergroup_permissions: bool = typer.Option(
False,
"--no-usergroup-permissions",
help="Do not assign user group permissions.",
),
) -> None:
"""Create a new template group.
Assigns default user group permissions by default.
* [option]--rw-groups[/] defaults to config option [configopt]app.default_admin_usergroups[/].
* [option]--ro-groups[/] defaults to config option [configopt]app.default_create_user_usergroups[/].
* Use [option]--no-usergroup-permissions[/] to create a group without any user group permissions.
[b]NOTE:[/] Calls [command]create_hostgroup[/] for Zabbix versions < 6.2.0.
"""
from zabbix_cli.models import Result
if app.state.client.version.release < (6, 2, 0):
from zabbix_cli.commands.hostgroup import create_hostgroup
create_hostgroup(
hostgroup=templategroup,
rw_groups=rw_groups,
ro_groups=ro_groups,
no_usergroup_permissions=no_usergroup_permissions,
)
return
groupid = app.state.client.create_templategroup(templategroup)
app_config = app.state.config.app
rw_grps: list[str] = []
ro_grps: list[str] = []
if not no_usergroup_permissions:
rw_grps = parse_list_arg(rw_groups) or app_config.default_admin_usergroups
ro_grps = parse_list_arg(ro_groups) or app_config.default_create_user_usergroups
try:
# Admin group(s) gets Read/Write
for usergroup in rw_grps:
app.state.client.update_usergroup_rights(
usergroup,
[templategroup],
UsergroupPermission.READ_WRITE,
hostgroup=False,
)
info(f"Assigned Read/Write permission for user group {usergroup!r}")
# Default group(s) gets Read
for usergroup in ro_grps:
app.state.client.update_usergroup_rights(
usergroup,
[templategroup],
UsergroupPermission.READ_ONLY,
hostgroup=False,
)
info(f"Assigned Read-only permission for user group {usergroup!r}")
except Exception as e:
error(f"Failed to assign permissions to template group {templategroup!r}: {e}")
info("Deleting template group...")
app.state.client.delete_templategroup(groupid)
exit_err(f"Failed to create template group {templategroup!r}.")
render_result(
Result(message=f"Created template group {templategroup} ({groupid}).")
)
@app.command("extend_templategroup", rich_help_panel=HELP_PANEL)
def extend_templategroup(
ctx: typer.Context,
src_group: str = typer.Argument(
help="Group to get templates from.",
show_default=False,
),
dest_group: str = typer.Argument(
help="Group(s) to add templates to. Comma-separated. Supports wildcards.",
show_default=False,
),
dryrun: bool = typer.Option(
False,
"--dryrun",
help="Show groups and templates without copying.",
),
) -> None:
"""Add all templates from a group to other groups.
Interprets the source group as a template group in >= 6.2, otherwise as a host group.
Does not modify the source group or its templates.
To remove the templates from the source group, use the [command]move_templates[/] command instead.
"""
from zabbix_cli.commands.results.templategroup import ExtendTemplateGroupResult
dest_arg = parse_list_arg(dest_group)
src: Union[HostGroup, TemplateGroup]
dest: Union[list[HostGroup], list[TemplateGroup]]
if app.state.client.version.release > (6, 2, 0):
src = app.state.client.get_templategroup(src_group, select_templates=True)
dest = app.state.client.get_templategroups(
*dest_arg, select_templates=True, search=True
)
else:
src = app.state.client.get_hostgroup(src_group, select_templates=True)
dest = app.state.client.get_hostgroups(
*dest_arg, select_templates=True, search=True
)
if not src.templates:
exit_err(f"No templates found in {src_group!r}")
if not dest:
exit_err(f"No groups found matching {dest_group!r}")
if not dryrun:
app.state.client.add_templates_to_groups(src.templates, dest)
else:
info("Would copy the following templates:")
render_result(ExtendTemplateGroupResult.from_result(src, dest, src.templates))
if not dryrun:
success(
f"Copied {len(src.templates)} templates from {src.name} to {len(dest)} groups."
)
@app.command("move_templates", rich_help_panel=HELP_PANEL)
def move_templates(
src_group: str = typer.Argument(
help="Group to move templates from.",
show_default=False,
),
dest_group: str = typer.Argument(
help="Group to move templates to.",
show_default=False,
),
rollback: bool = typer.Option(
True,
"--rollback/--no-rollback",
help="Rollback changes if templates cannot be removed from source group afterwards.",
),
dryrun: bool = typer.Option(
False,
"--dryrun",
help="Show templates and groups without making changes.",
),
) -> None:
"""Move all templates from one group to another."""
from zabbix_cli.commands.results.templategroup import MoveTemplatesResult
src: Union[HostGroup, TemplateGroup]
dest: Union[HostGroup, TemplateGroup]
if app.state.client.version.release < (6, 2, 0):
src = app.state.client.get_hostgroup(src_group, select_templates=True)
dest = app.state.client.get_hostgroup(dest_group, select_templates=True)
else:
src = app.state.client.get_templategroup(src_group, select_templates=True)
dest = app.state.client.get_templategroup(dest_group, select_templates=True)
if not src.templates:
exit_err(f"No templates found in template group {src_group!r}.")
if dryrun:
info(f"Would copy {len(src.templates)} templates from {src.name!r}:")
else:
app.state.client.add_templates_to_groups(
src.templates,
# Clunky typing semantics here:
# We cannot prove that list is homogenous ("list[HostGroup] | list[TemplateGroup]")
# because inferred type is "list[HostGroup | TemplateGroup]""
[dest], # pyright: ignore[reportArgumentType]
)
info(f"Added templates to {dest.name!r}.")
try:
app.state.client.remove_templates_from_groups(
src.templates,
[src], # pyright: ignore[reportArgumentType] # ditto
)
except Exception as e:
if rollback:
error(
f"Failed to remove hosts from {src.name!r}. Attempting to roll back changes."
)
app.state.client.remove_templates_from_groups(
src.templates,
[dest], # pyright: ignore[reportArgumentType] # ditto
)
raise e
else:
info(f"Removed templates from {src.name!r}.")
render_result(MoveTemplatesResult.from_result(src, dest))
if not dryrun:
success(
f"Moved {len(src.templates)} templates from {src.name!r} to {dest.name!r}."
)
@app.command("remove_templategroup", rich_help_panel=HELP_PANEL)
def remove_templategroup(
ctx: typer.Context,
templategroup: str = typer.Argument(
help="Name of the group to delete.",
show_default=False,
),
) -> None:
"""Delete a template group.
NOTE: Calls [command]remove_hostgroup[/] for Zabbix <6.2.
"""
from zabbix_cli.models import Result
if app.state.client.version.release < (6, 2, 0):
from zabbix_cli.commands.hostgroup import delete_hostgroup
delete_hostgroup(hostgroup=templategroup)
return
app.state.client.delete_templategroup(templategroup)
render_result(Result(message=f"Deleted template group {templategroup!r}."))
# Changed in V3: Changed name to reflect introduction of template groups in >=6.2
@app.command(
"remove_template_from_group",
rich_help_panel=HELP_PANEL,
examples=[
Example(
"Remove one template from one group",
"remove_template_from_group 'Apache by HTTP' foo_group",
),
Example(
"Remove many templates from many groups",
"remove_template_from_group 'Apache by HTTP,HAProxy by Zabbix agent' foo_group,bar_group",
),
Example(
"Remove all templates starting with 'Apache' from a group",
"remove_template_from_group 'Apache*' foo_group",
),
Example(
"Remove all templates containing 'HTTP' from all groups",
"remove_template_from_group '*HTTP*' '*'",
),
],
)
@app.command(
# old name for backwards compatibility
"unlink_template_from_hostgroup",
hidden=True,
deprecated=True,
rich_help_panel=HELP_PANEL,
help="Use `remove_template_from_group` instead.",
)
def remove_template_from_group(
ctx: typer.Context,
template_names_or_ids: str = ARG_TEMPLATE_NAMES_OR_IDS,
group_names_or_ids: str = ARG_GROUP_NAMES_OR_IDS,
strict: bool = typer.Option(
False,
"--strict",
help="Fail if any host groups or templates aren't found. Should not be used in conjunction with wildcards.",
),
dryrun: bool = typer.Option(
False,
"--dryrun",
help="Preview changes.",
),
# TODO: add toggle for NOT clearing when unlinking?
) -> None:
"""Remove templates from groups."""
from zabbix_cli.commands.results.template import RemoveTemplateFromGroupResult
from zabbix_cli.models import AggregateResult
groups: Union[list[HostGroup], list[TemplateGroup]]
if app.state.client.version.release >= (6, 2, 0):
groups = parse_templategroups_arg(
app, group_names_or_ids, strict=strict, select_templates=True
)
else:
groups = parse_hostgroups_arg(
app, group_names_or_ids, strict=strict, select_templates=True
)
templates = parse_templates_arg(app, template_names_or_ids, strict=strict)
if not dryrun:
with app.state.console.status("Removing templates from groups..."):
# LEGACY: This used to also pass the templateids to templateids_clear,
# which would unlink and clear all the templates from each other
# This was a mistake, and has been removed in V3.
# Users should use `unlink_templates_from_templates` for that.
app.state.client.remove_templates_from_groups(
templates,
groups,
)
result: list[RemoveTemplateFromGroupResult] = []
for group in groups:
r = RemoveTemplateFromGroupResult.from_result(templates, group)
if not r.templates:
continue
result.append(r)
total_templates = len(set(chain.from_iterable((r.templates) for r in result)))
total_groups = len(result)
render_result(AggregateResult(result=result, empty_ok=True))
base_msg = f"{p('template', total_templates)} from {p('group', total_groups)}"
if dryrun:
info(f"Would remove {base_msg}.")
else:
success(f"Removed {base_msg}.")
@app.command("show_templategroup", rich_help_panel=HELP_PANEL)
def show_templategroup(
ctx: typer.Context,
templategroup: str = typer.Argument(
help="Name of the group to show. Supports wildcards.",
show_default=False,
),
templates: bool = typer.Option(
True,
"--templates/--no-templates",
help="Show/hide templates associated with the group.",
),
) -> None:
"""Show details for a template group."""
from zabbix_cli.commands.results.templategroup import ShowTemplateGroupResult
tg: HostGroup | TemplateGroup
if app.state.client.version.release < (6, 2, 0):
tg = app.state.client.get_hostgroup(
templategroup, search=True, select_templates=templates
)
else:
tg = app.state.client.get_templategroup(
templategroup, search=True, select_templates=templates
)
render_result(ShowTemplateGroupResult.from_result(tg, show_templates=templates))
@app.command(
"show_templategroups",
rich_help_panel=HELP_PANEL,
examples=[
Example(
"Show all template groups",
"show_templategroups",
),
Example(
"Show all template groups starting with 'Web-'",
"show_templategroups 'Web-*'",
),
Example(
"Show template groups with 'web' in the name",
"show_templategroups '*web*'",
),
],
)
def show_templategroups(
ctx: typer.Context,
name: Optional[str] = typer.Argument(
None,
help="Name of template group(s). Comma-separated. Supports wildcards.",
show_default=False,
),
templates: bool = typer.Option(
True,
"--templates/--no-templates",
help="Show/hide templates associated with each group.",
),
) -> None:
"""Show template groups.
Fetches all groups by default, but can be filtered by name.
"""
from zabbix_cli.commands.results.templategroup import ShowTemplateGroupResult
from zabbix_cli.models import AggregateResult
names = parse_list_arg(name)
groups: Union[list[HostGroup], list[TemplateGroup]]
with app.status("Fetching template groups..."):
if app.state.client.version.release < (6, 2, 0):
groups = app.state.client.get_hostgroups(
*names,
search=True,
select_templates=True,
sort_field="name",
sort_order="ASC",
)
else:
groups = app.state.client.get_templategroups(
*names,
search=True,
select_templates=True,
sort_field="name",
sort_order="ASC",
)
# Sort by name before rendering
groups = sorted(groups, key=lambda tg: tg.name) # type: ignore # unable to infer that type doesn't change?
render_result(
AggregateResult(
result=[ShowTemplateGroupResult.from_result(tg, templates) for tg in groups]
)
)
|