Module: Pvectl

Defined in:
lib/pvectl.rb,
lib/pvectl/cli.rb,
lib/pvectl/version.rb,
lib/pvectl/models/vm.rb,
lib/pvectl/connection.rb,
lib/pvectl/exit_codes.rb,
lib/pvectl/models/base.rb,
lib/pvectl/models/node.rb,
lib/pvectl/models/task.rb,
lib/pvectl/commands/apt.rb,
lib/pvectl/config/store.rb,
lib/pvectl/selectors/vm.rb,
lib/pvectl/commands/ping.rb,
lib/pvectl/commands/pull.rb,
lib/pvectl/commands/push.rb,
lib/pvectl/commands/stop.rb,
lib/pvectl/config/errors.rb,
lib/pvectl/config/wizard.rb,
lib/pvectl/models/backup.rb,
lib/pvectl/models/volume.rb,
lib/pvectl/plugin_loader.rb,
lib/pvectl/presenters/vm.rb,
lib/pvectl/commands/reset.rb,
lib/pvectl/commands/start.rb,
lib/pvectl/config/service.rb,
lib/pvectl/editor_session.rb,
lib/pvectl/models/service.rb,
lib/pvectl/models/storage.rb,
lib/pvectl/selectors/base.rb,
lib/pvectl/selectors/disk.rb,
lib/pvectl/commands/resume.rb,
lib/pvectl/commands/set_vm.rb,
lib/pvectl/config/provider.rb,
lib/pvectl/formatters/base.rb,
lib/pvectl/formatters/json.rb,
lib/pvectl/formatters/wide.rb,
lib/pvectl/formatters/yaml.rb,
lib/pvectl/models/snapshot.rb,
lib/pvectl/presenters/base.rb,
lib/pvectl/presenters/disk.rb,
lib/pvectl/presenters/node.rb,
lib/pvectl/repositories/vm.rb,
lib/pvectl/services/backup.rb,
lib/pvectl/services/set_vm.rb,
lib/pvectl/commands/console.rb,
lib/pvectl/commands/edit_vm.rb,
lib/pvectl/commands/restart.rb,
lib/pvectl/commands/service.rb,
lib/pvectl/commands/suspend.rb,
lib/pvectl/formatters/table.rb,
lib/pvectl/models/container.rb,
lib/pvectl/repositories/apt.rb,
lib/pvectl/repositories/dns.rb,
lib/pvectl/selectors/volume.rb,
lib/pvectl/services/console.rb,
lib/pvectl/services/edit_vm.rb,
lib/pvectl/services/sendkey.rb,
lib/pvectl/argv_preprocessor.rb,
lib/pvectl/commands/clone_vm.rb,
lib/pvectl/commands/edit_dns.rb,
lib/pvectl/commands/set_node.rb,
lib/pvectl/commands/shutdown.rb,
lib/pvectl/config_serializer.rb,
lib/pvectl/models/capability.rb,
lib/pvectl/models/dns_config.rb,
lib/pvectl/models/hosts_file.rb,
lib/pvectl/models/task_entry.rb,
lib/pvectl/presenters/backup.rb,
lib/pvectl/presenters/top_vm.rb,
lib/pvectl/presenters/volume.rb,
lib/pvectl/repositories/base.rb,
lib/pvectl/repositories/disk.rb,
lib/pvectl/repositories/node.rb,
lib/pvectl/repositories/task.rb,
lib/pvectl/services/clone_vm.rb,
lib/pvectl/services/edit_dns.rb,
lib/pvectl/services/set_node.rb,
lib/pvectl/services/snapshot.rb,
lib/pvectl/wizards/create_vm.rb,
lib/pvectl/commands/create_vm.rb,
lib/pvectl/commands/delete_vm.rb,
lib/pvectl/commands/edit_node.rb,
lib/pvectl/config/models/user.rb,
lib/pvectl/models/apt_package.rb,
lib/pvectl/models/time_config.rb,
lib/pvectl/parsers/net_config.rb,
lib/pvectl/parsers/smart_text.rb,
lib/pvectl/presenters/service.rb,
lib/pvectl/presenters/storage.rb,
lib/pvectl/repositories/hosts.rb,
lib/pvectl/services/cloudinit.rb,
lib/pvectl/services/create_vm.rb,
lib/pvectl/services/edit_node.rb,
lib/pvectl/services/move_disk.rb,
lib/pvectl/services/wakeonlan.rb,
lib/pvectl/commands/console_ct.rb,
lib/pvectl/commands/console_vm.rb,
lib/pvectl/commands/edit_hosts.rb,
lib/pvectl/commands/feature_vm.rb,
lib/pvectl/commands/migrate_vm.rb,
lib/pvectl/commands/sendkey_vm.rb,
lib/pvectl/commands/set_volume.rb,
lib/pvectl/formatters/registry.rb,
lib/pvectl/manifest_serializer.rb,
lib/pvectl/models/subscription.rb,
lib/pvectl/models/syslog_entry.rb,
lib/pvectl/parsers/disk_config.rb,
lib/pvectl/presenters/snapshot.rb,
lib/pvectl/presenters/template.rb,
lib/pvectl/presenters/top_node.rb,
lib/pvectl/repositories/backup.rb,
lib/pvectl/repositories/syslog.rb,
lib/pvectl/repositories/volume.rb,
lib/pvectl/selectors/container.rb,
lib/pvectl/services/edit_hosts.rb,
lib/pvectl/services/set_volume.rb,
lib/pvectl/commands/config/view.rb,
lib/pvectl/commands/edit_volume.rb,
lib/pvectl/commands/get/command.rb,
lib/pvectl/commands/template_vm.rb,
lib/pvectl/commands/top/command.rb,
lib/pvectl/models/journal_entry.rb,
lib/pvectl/models/physical_disk.rb,
lib/pvectl/models/task_log_line.rb,
lib/pvectl/presenters/container.rb,
lib/pvectl/repositories/journal.rb,
lib/pvectl/repositories/service.rb,
lib/pvectl/repositories/storage.rb,
lib/pvectl/services/edit_volume.rb,
lib/pvectl/services/pull_config.rb,
lib/pvectl/services/push_config.rb,
lib/pvectl/services/unlink_disk.rb,
lib/pvectl/commands/logs/command.rb,
lib/pvectl/commands/move_disk_vm.rb,
lib/pvectl/commands/shared_flags.rb,
lib/pvectl/config/models/cluster.rb,
lib/pvectl/config/models/context.rb,
lib/pvectl/presenters/capability.rb,
lib/pvectl/presenters/dns_config.rb,
lib/pvectl/presenters/hosts_file.rb,
lib/pvectl/presenters/task_entry.rb,
lib/pvectl/repositories/snapshot.rb,
lib/pvectl/repositories/task_log.rb,
lib/pvectl/services/task_listing.rb,
lib/pvectl/services/vm_lifecycle.rb,
lib/pvectl/commands/create_backup.rb,
lib/pvectl/commands/delete_backup.rb,
lib/pvectl/commands/set_container.rb,
lib/pvectl/parsers/lxc_net_config.rb,
lib/pvectl/presenters/apt_package.rb,
lib/pvectl/presenters/time_config.rb,
lib/pvectl/repositories/container.rb,
lib/pvectl/repositories/task_list.rb,
lib/pvectl/services/resize_volume.rb,
lib/pvectl/services/set_container.rb,
lib/pvectl/commands/cloudinit/dump.rb,
lib/pvectl/commands/config/command.rb,
lib/pvectl/commands/delete_command.rb,
lib/pvectl/commands/edit_container.rb,
lib/pvectl/commands/get/watch_loop.rb,
lib/pvectl/commands/restore_backup.rb,
lib/pvectl/commands/stop_container.rb,
lib/pvectl/commands/unlink_disk_vm.rb,
lib/pvectl/commands/wakeonlan_node.rb,
lib/pvectl/models/operation_result.rb,
lib/pvectl/presenters/subscription.rb,
lib/pvectl/presenters/syslog_entry.rb,
lib/pvectl/services/edit_container.rb,
lib/pvectl/utils/resource_resolver.rb,
lib/pvectl/commands/clone_container.rb,
lib/pvectl/commands/create_snapshot.rb,
lib/pvectl/commands/delete_snapshot.rb,
lib/pvectl/commands/feature_command.rb,
lib/pvectl/commands/migrate_command.rb,
lib/pvectl/commands/start_container.rb,
lib/pvectl/connection/retry_handler.rb,
lib/pvectl/console/terminal_session.rb,
lib/pvectl/formatters/color_support.rb,
lib/pvectl/formatters/output_helper.rb,
lib/pvectl/models/network_interface.rb,
lib/pvectl/parsers/lxc_mount_config.rb,
lib/pvectl/presenters/journal_entry.rb,
lib/pvectl/presenters/task_log_line.rb,
lib/pvectl/presenters/top_container.rb,
lib/pvectl/presenters/top_presenter.rb,
lib/pvectl/repositories/time_config.rb,
lib/pvectl/services/clone_container.rb,
lib/pvectl/services/resource_delete.rb,
lib/pvectl/wizards/create_container.rb,
lib/pvectl/commands/create_container.rb,
lib/pvectl/commands/delete_container.rb,
lib/pvectl/commands/describe/command.rb,
lib/pvectl/commands/get/handlers/dns.rb,
lib/pvectl/commands/get/handlers/vms.rb,
lib/pvectl/commands/template_command.rb,
lib/pvectl/commands/top/handlers/vms.rb,
lib/pvectl/parsers/cloud_init_config.rb,
lib/pvectl/presenters/config/context.rb,
lib/pvectl/repositories/capabilities.rb,
lib/pvectl/repositories/subscription.rb,
lib/pvectl/services/create_container.rb,
lib/pvectl/commands/cloudinit/command.rb,
lib/pvectl/commands/cloudinit/pending.rb,
lib/pvectl/commands/feature_container.rb,
lib/pvectl/commands/get/handlers/time.rb,
lib/pvectl/commands/migrate_container.rb,
lib/pvectl/commands/move_disk_command.rb,
lib/pvectl/commands/resource_registry.rb,
lib/pvectl/commands/restart_container.rb,
lib/pvectl/commands/rollback_snapshot.rb,
lib/pvectl/models/vm_operation_result.rb,
lib/pvectl/services/service_lifecycle.rb,
lib/pvectl/commands/config/set_cluster.rb,
lib/pvectl/commands/config/set_context.rb,
lib/pvectl/commands/config/use_context.rb,
lib/pvectl/commands/get/handlers/disks.rb,
lib/pvectl/commands/get/handlers/hosts.rb,
lib/pvectl/commands/get/handlers/nodes.rb,
lib/pvectl/commands/get/handlers/tasks.rb,
lib/pvectl/commands/shutdown_container.rb,
lib/pvectl/commands/template_container.rb,
lib/pvectl/commands/top/handlers/nodes.rb,
lib/pvectl/models/snapshot_description.rb,
lib/pvectl/presenters/operation_result.rb,
lib/pvectl/services/resource_migration.rb,
lib/pvectl/commands/config/get_contexts.rb,
lib/pvectl/commands/get/handlers/volume.rb,
lib/pvectl/commands/move_disk_container.rb,
lib/pvectl/models/node_operation_result.rb,
lib/pvectl/services/container_lifecycle.rb,
lib/pvectl/commands/cloudinit/regenerate.rb,
lib/pvectl/commands/get/handlers/backups.rb,
lib/pvectl/commands/get/handlers/storage.rb,
lib/pvectl/commands/get/resource_handler.rb,
lib/pvectl/commands/irreversible_command.rb,
lib/pvectl/commands/logs/handlers/syslog.rb,
lib/pvectl/commands/set_resource_command.rb,
lib/pvectl/commands/top/resource_handler.rb,
lib/pvectl/commands/vm_lifecycle_command.rb,
lib/pvectl/config/models/resolved_config.rb,
lib/pvectl/services/get/resource_service.rb,
lib/pvectl/commands/edit_resource_command.rb,
lib/pvectl/commands/get/handlers/services.rb,
lib/pvectl/commands/get/resource_registry.rb,
lib/pvectl/commands/logs/handlers/journal.rb,
lib/pvectl/commands/logs/resource_handler.rb,
lib/pvectl/commands/shared_config_parsers.rb,
lib/pvectl/commands/top/resource_registry.rb,
lib/pvectl/models/volume_operation_result.rb,
lib/pvectl/presenters/vm_operation_result.rb,
lib/pvectl/commands/config/set_credentials.rb,
lib/pvectl/commands/get/handlers/snapshots.rb,
lib/pvectl/commands/get/handlers/templates.rb,
lib/pvectl/commands/logs/resource_registry.rb,
lib/pvectl/commands/create_resource_command.rb,
lib/pvectl/commands/get/handlers/containers.rb,
lib/pvectl/commands/logs/handlers/task_logs.rb,
lib/pvectl/commands/top/handlers/containers.rb,
lib/pvectl/presenters/node_operation_result.rb,
lib/pvectl/models/container_operation_result.rb,
lib/pvectl/commands/get/handlers/capabilities.rb,
lib/pvectl/commands/get/handlers/subscription.rb,
lib/pvectl/commands/logs/handlers/task_detail.rb,
lib/pvectl/presenters/volume_operation_result.rb,
lib/pvectl/commands/resource_lifecycle_command.rb,
lib/pvectl/commands/container_lifecycle_command.rb,
lib/pvectl/presenters/snapshot_operation_result.rb,
lib/pvectl/presenters/container_operation_result.rb

Overview

Main module for the pvectl application - CLI tool for managing Proxmox clusters.

Pvectl provides a kubectl-style command line interface for managing virtual machines, containers, nodes, storage, and backups in Proxmox VE.

Examples:

Usage in code

Pvectl::CLI.run(ARGV)

See Also:

Defined Under Namespace

Modules: Commands, Config, ConfigSerializer, Console, ExitCodes, Formatters, ManifestSerializer, Models, Parsers, Presenters, Repositories, Selectors, Services, Utils, Wizards Classes: ArgvPreprocessor, CLI, Connection, EditorSession, Error, PluginLoader, ResourceNotFoundError

Constant Summary collapse

VERSION =

Current version of the pvectl gem.

Versioning follows Semantic Versioning (semver.org/):

  • MAJOR: breaking changes

  • MINOR: new features, backwards compatible

  • PATCH: bug fixes, backwards compatible

Returns:

  • (String) —

    version number in MAJOR.MINOR.PATCH format

"0.2.0"