waft.cli.agent module¶
CLI commands for WAFT agent deployment and management.
- waft.cli.agent.deploy(check: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fdfdf92b150>] = False, verbose: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fdfdf93e450>] = False, verify_version: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fdfdf75cd10>] = True, config: ~typing.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7fdfe0b2d3d0>] = None)¶
Deploy WAFT agent to test system(s).
- waft.cli.agent.logs(lines: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7fdfdfc37c50>] = 100, output: ~types.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7fdfdfcccb90>] = None, config: ~typing.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7fdfe0b2d3d0>] = None)¶
Retrieve logs from the WAFT agent on a system.
- waft.cli.agent.schedule_create(name: ~typing.Annotated[str, <typer.models.OptionInfo object at 0x7fdfdfe27c10>], interval: ~typing.Annotated[str, <typer.models.OptionInfo object at 0x7fdfdfe25f90>], delivery_url: ~types.Annotated[str | None, <typer.models.OptionInfo object at 0x7fdfdfe24c90>] = None, wshim_token: ~types.Annotated[str | None, <typer.models.OptionInfo object at 0x7fdfdfe26190>] = None, auth_token: ~types.Annotated[str | None, <typer.models.OptionInfo object at 0x7fdfdfe262d0>] = None, enabled: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fdfdfe24d90>] = True, config: ~typing.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7fdfe0b2d3d0>] = None)¶
Create a new schedule for metrics collection on the agent.
Defaults: - URL: Uses default from settings if not provided - WShim token: Reads from ~/.waft/config/wshim_token if not provided - Delivery token: Reads from ~/.waft/config/metrics_delivery_token if not provided
- waft.cli.agent.schedule_delete(schedule_id: ~typing.Annotated[str, <typer.models.ArgumentInfo object at 0x7fdfdfc36810>], yes: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fdfdfc37890>] = False, config: ~typing.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7fdfe0b2d3d0>] = None)¶
Delete a schedule.
- waft.cli.agent.schedule_get(schedule_id: ~typing.Annotated[str, <typer.models.ArgumentInfo object at 0x7fdfdfe26ad0>], config: ~typing.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7fdfe0b2d3d0>] = None)¶
Get details of a specific schedule.
- waft.cli.agent.schedule_list(config: ~typing.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7fdfe0b2d3d0>] = None)¶
List all schedules for metrics collection on the agent.
- waft.cli.agent.schedule_update(schedule_id: ~typing.Annotated[str, <typer.models.ArgumentInfo object at 0x7fdfdfcddb10>], name: ~types.Annotated[str | None, <typer.models.OptionInfo object at 0x7fdfdfcddc50>] = None, interval: ~types.Annotated[str | None, <typer.models.OptionInfo object at 0x7fdfdfcdd190>] = None, delivery_url: ~types.Annotated[str | None, <typer.models.OptionInfo object at 0x7fdfdfcdc610>] = None, wshim_token: ~types.Annotated[str | None, <typer.models.OptionInfo object at 0x7fdfdfcdc1d0>] = None, update_wshim_token: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fdfdfdeda50>] = False, auth_token: ~types.Annotated[str | None, <typer.models.OptionInfo object at 0x7fdfdfded010>] = None, enabled: ~types.Annotated[bool | None, <typer.models.OptionInfo object at 0x7fdfdfc35e50>] = None, config: ~typing.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7fdfe0b2d3d0>] = None)¶
Update an existing schedule.
- waft.cli.agent.status(config: ~typing.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7fdfe0b2d3d0>] = None)¶
Check status of deployed WAFT agents on test system(s).