CLI Reference¶
All PteroCloud commands are read-only unless a command explicitly offers a
confirmation-gated mutation. There is no generic --fix, no arbitrary shell and
no command that disables TLS verification.
Every command that emits data supports --json where noted. Error codes are
resolved through the catalog: php artisan pterocloud:error <code|PC-XXX-###>.
Health, diagnostics and support¶
| Command | Purpose |
|---|---|
pterocloud:health |
Backend health; links a failing component to its error code, diagnostic command and docs article. |
pterocloud:compatibility |
Compatibility report (SUPPORTED/UNTESTED/UNSUPPORTED). |
pterocloud:diagnose |
Read-only diagnostics for a scope/target. --apply-safe-repairs applies SAFE repairs after interactive confirmation. |
pterocloud:diagnose:provider {uuid} |
Diagnostics for one provider. |
pterocloud:diagnose:hypervisor {uuid} |
Diagnostics for one hypervisor. |
pterocloud:diagnose:instance {uuid} |
Diagnostics for one instance. |
pterocloud:diagnose:network {uuid} |
Diagnostics for one network. |
pterocloud:diagnose:storage {uuid} |
Diagnostics for one storage pool. |
pterocloud:diagnostics |
Diagnostics for a scope (alias of diagnose). |
pterocloud:issues |
List detected issues. --flapping shows flapping issues. |
pterocloud:errors:list |
List recorded error events. |
pterocloud:error {code} |
Show an error definition. |
pterocloud:error:id {support-id} |
Look up an error by support id. |
pterocloud:docs:errors |
Generate the error-code reference from the catalog. |
pterocloud:support:bundle |
Generate a redacted support bundle. |
pterocloud:support:bundle:list |
List generated bundles. |
pterocloud:support:bundle:delete {id} |
Delete a generated bundle (confirmation). |
pterocloud:support:verify-bundle {path} |
Verify a bundle's checksums and secret scan. |
Providers, hypervisors and native hosts¶
| Command | Purpose |
|---|---|
pterocloud:proxmox:test |
Test a Proxmox connection. |
pterocloud:proxmox:sync |
Sync provider assets. |
pterocloud:hypervisors |
List hypervisors. |
pterocloud:native:readiness |
Native host readiness. |
pterocloud:native:reconcile |
Reconcile native state. |
pterocloud:native:instance |
Native instance operations. |
pterocloud:native:storage, pterocloud:native:storage:inspect |
Native storage. |
pterocloud:native:network, pterocloud:native:network:inspect |
Native networking. |
pterocloud:native:nested |
Nested virtualization. |
pterocloud:agent-simulate |
Simulate agent traffic (testing only). |
Instances, tasks and provisioning¶
| Command | Purpose |
|---|---|
pterocloud:instance:inspect {uuid} |
Inspect one instance (no secrets). |
pterocloud:provision:check |
Validate a provisioning request. |
pterocloud:provision:dry-run |
Dry-run provisioning. |
pterocloud:provision:reconcile |
Reconcile provisioning state. |
pterocloud:tasks:stale |
Report stale tasks. |
pterocloud:reservations:cleanup |
Release expired reservations. |
pterocloud:entitlement:grant |
Grant, update or revoke a user cloud provisioning entitlement. |
Networking, storage and images¶
| Command | Purpose |
|---|---|
pterocloud:ipam:audit |
IPAM audit (duplicates/capacity). |
pterocloud:ip:inspect {uuid} |
Inspect one address. |
pterocloud:network:inspect {uuid} |
Inspect one network. |
pterocloud:network:dry-run |
Dry-run a network change. |
pterocloud:storage:health, pterocloud:storage:inspect, pterocloud:storage:audit |
Storage health and inspection. |
pterocloud:storage:drain |
Storage drain. |
pterocloud:volume:inspect {uuid} |
Inspect a volume. |
pterocloud:image:inspect {uuid} |
Inspect an image. |
pterocloud:snapshot:inspect {uuid} |
Inspect a snapshot. |
Backups¶
pterocloud:backup:health, :inspect, :audit, :destination, :reconcile,
:retention.
Console¶
pterocloud:console:gateways, pterocloud:console:inspect,
pterocloud:console:session.
Migrations and evacuations¶
pterocloud:migration:preflight, :start, :status, :recover, :health;
pterocloud:hypervisor:evacuate.
Compute¶
pterocloud:compute:status, :cpus, :audit; pterocloud:hardware:list,
pterocloud:hardware:inspect; pterocloud:scheduler:simulate.
Licensing and security¶
pterocloud:license:status, :verify, :activate, :refresh, :deactivate,
:diagnostics; pterocloud:security:integrity,
pterocloud:security:incident-report; pterocloud:repair.
Metrics and verification¶
pterocloud:metrics:cleanup; pterocloud:verify; pterocloud:setup:verify.
Notifications¶
| Command | Purpose |
|---|---|
pterocloud:notifications:test {email} |
Send one sample of every customer notification to verify mail delivery. --dry-run renders each template without sending; --json emits machine-readable output. |