system

El dominio system tiene 11 acciones. En la superficie meta se alcanzan todas a través de arcane_system; en la individual, cada una es una herramienta propia; en la dinámica se ejecutan con arcane_execute_action y el ID canónico.

Resumen

Acción	Título	Tipo
system.containers_start_all	Start all containers	escritura
system.containers_start_stopped	Start all stopped containers	escritura
system.containers_stop_all	Stop all containers	destructiva
system.convert_docker_run	Convert docker run command	lectura
system.docker_info	Get Docker info	lectura
system.prune_all	Prune Docker resources	destructiva
system.stats	Get host resource usage	lectura
system.update_all	Update all environments	destructiva
system.update_all_status	Get update-all status	lectura
system.upgrade	Trigger system upgrade	destructiva
system.upgrade_check	Check for system upgrade	lectura

Acciones

system.containers_start_all

Start all containers

Start all Docker containers

• Tipo: escritura
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_system con "action": "containers_start_all"
• Herramienta individual: arcane_system_containers_start_all
• Ruta de Arcane: POST /api/environments/{id}/system/containers/start-all
• ID de operación: start-all-containers
• Uso: Starts every container of the environment that is not running (created, exited and other states). Use system.containers_start_stopped to start only exited ones, container.start for one. Result lists started and failed container IDs with errors, and success is false if any failed. Needs containers:start.
• Acciones relacionadas: system.containers_start_stopped, system.containers_stop_all, container.list, container.start

system.containers_start_stopped

Start all stopped containers

Start all stopped Docker containers

• Tipo: escritura
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_system con "action": "containers_start_stopped"
• Herramienta individual: arcane_system_containers_start_stopped
• Ruta de Arcane: POST /api/environments/{id}/system/containers/start-stopped
• ID de operación: start-all-stopped-containers
• Uso: Starts only containers in state exited (never-started created containers are skipped). Use system.containers_start_all to also start those. Result lists started and failed container IDs with errors. Needs containers:start.
• Acciones relacionadas: system.containers_start_all, system.containers_stop_all, container.list

system.containers_stop_all

Stop all containers

Stop all running Docker containers

• Tipo: destructiva — exige confirm: true
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_system con "action": "containers_stop_all"
• Herramienta individual: arcane_system_containers_stop_all
• Ruta de Arcane: POST /api/environments/{id}/system/containers/stop-all
• ID de operación: stop-all-containers
• Uso: Stops every container of the environment except Arcane’s own container, interrupting all workloads. Use container.stop for one or project.down for a stack. Result lists stopped and failed container IDs with errors. Bring them back with system.containers_start_stopped. Needs containers:stop.
• Acciones relacionadas: system.containers_start_stopped, system.containers_start_all, container.list, container.stop

system.convert_docker_run

Convert docker run command

Convert a docker run command to docker-compose format

• Tipo: lectura
• Parámetros obligatorios: dockerRunCommand
• Meta-herramienta: arcane_system con "action": "convert_docker_run"
• Herramienta individual: arcane_system_convert_docker_run
• Ruta de Arcane: POST /api/environments/{id}/system/convert
• ID de operación: convert-docker-run
• Uso: Pass dockerRunCommand, a full ‘docker run …’ command line. Nothing is created or run. Returns dockerCompose (YAML), envVars (env-file text) and serviceName, and a syntax error returns 400. Feed the result to project.create to deploy it as a Compose project. Needs containers:create.
• Acciones relacionadas: project.create, container.create, container.generate_compose

system.docker_info

Get Docker info

Get Docker daemon version and system information

• Tipo: lectura
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_system con "action": "docker_info"
• Herramienta individual: arcane_system_docker_info
• Ruta de Arcane: GET /api/environments/{id}/system/docker/info
• ID de operación: get-docker-info
• Uso: Returns the daemon’s docker info (ServerVersion, NCPU, MemTotal, container and image counts, storage Driver, Swarm state, Warnings) plus apiVersion, os and arch. Use system.stats for live CPU/memory usage and server.app_version for Arcane’s own version.
• Acciones relacionadas: system.stats, server.app_version, swarm.info, dashboard.get

system.prune_all

Prune Docker resources

Remove unused Docker resources (containers, images, volumes, networks)

• Tipo: destructiva — exige confirm: true
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_system con "action": "prune_all"
• Herramienta individual: arcane_system_prune_all
• Ruta de Arcane: POST /api/environments/{id}/system/prune
• ID de operación: prune-all
• Uso: Prunes several resource types in one call. Each is an object {mode, until}: containers none|stopped|olderThan, images none|dangling|all|olderThan, volumes none|anonymous|all (all also removes unused named volumes), networks none|unused|olderThan, buildCache none|unused|all|olderThan. until is required with olderThan (a duration such as 24h or a timestamp). Omitted resources are left alone. Runs in the background and returns only an activityId (an already running prune returns its activityId instead). Follow its status, messages and errors with activity.get. Needs system:prune.
• Acciones relacionadas: activity.get, image.prune, volume.prune, network.prune, container.list

system.stats

Get host resource usage

Sample the Docker host’s live CPU, memory, disk and GPU usage

• Tipo: lectura
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_system con "action": "stats"
• Herramienta individual: arcane_system_stats
• Ruta de Arcane: GET /api/environments/{id}/ws/system/stats (WebSocket)
• ID de operación: ws-system-stats
• Uso: Each sample has cpuUsage (percent), memoryUsage/memoryTotal and diskUsage/diskTotal in bytes, cpuCount, architecture, platform, hostname and per-GPU stats. Pass samples (up to 60) with intervalSeconds (Arcane default 2) to watch a trend, and seconds bounds the wait. For per-container usage use container.stats_all.
• Acciones relacionadas: system.docker_info, container.stats_all, dashboard.get

system.update_all

Update all environments

Upgrade every Arcane environment: the remote agents one at a time first, then the manager last

• Tipo: destructiva — exige confirm: true
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_system con "action": "update_all"
• Herramienta individual: arcane_system_update_all
• Ruta de Arcane: POST /api/environments/{id}/system/upgrade/all
• ID de operación: trigger-update-all
• Uso: Upgrades the whole fleet in the background: every remote agent environment first, then the manager itself last (Arcane restarts). Only on the manager (400 on an agent), and refused while another update-all job is active. Returns the job with a per-environment results list. Poll system.update_all_status for progress. Needs system:upgrade.
• Acciones relacionadas: system.update_all_status, system.upgrade, environment.list, server.app_version

system.update_all_status

Get update-all status

Get the status of the latest update-all-environments job

• Tipo: lectura
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_system con "action": "update_all_status"
• Herramienta individual: arcane_system_update_all_status
• Ruta de Arcane: GET /api/environments/{id}/system/upgrade/all/status
• ID de operación: update-all-status
• Uso: Returns the latest update-all job: status running|pending_restart|completed|failed and results per environment (status pending|updating|updated|triggered|up_to_date|skipped_offline|failed, with stage and error). Answers 404 ‘no update-all job found’ until system.update_all has run once. Manager only.
• Acciones relacionadas: system.update_all, environment.list

system.upgrade

Trigger system upgrade

Trigger a system upgrade

• Tipo: destructiva — exige confirm: true
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_system con "action": "upgrade"
• Herramienta individual: arcane_system_upgrade
• Ruta de Arcane: POST /api/environments/{id}/system/upgrade
• ID de operación: trigger-upgrade
• Uso: Self-upgrades the Arcane instance serving environmentId (the manager for environment 0, that agent for a remote one): pulls the newest image and recreates Arcane’s container in the background, so the API drops briefly. Optional targetVersion picks the release instead of the version check. upToDate true means it already runs the newest image and no restart follows. One upgrade at a time. Needs system:upgrade.
• Acciones relacionadas: system.upgrade_check, server.app_version, system.update_all

system.upgrade_check

Check for system upgrade

Check if a system upgrade is available

• Tipo: lectura
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_system con "action": "upgrade_check"
• Herramienta individual: arcane_system_upgrade_check
• Ruta de Arcane: GET /api/environments/{id}/system/upgrade/check
• ID de operación: check-upgrade
• Uso: Only checks whether self-upgrade is possible here (Docker socket reachable and Arcane running in a container): canUpgrade true does not mean a newer version exists. Use server.app_version (updateAvailable, newestVersion) for that. Failures come back as error true with the reason in message, not as an HTTP error.
• Acciones relacionadas: server.app_version, system.upgrade