oo vm
The Sunport's VMs: create, power, resize, rename and remove them, their domains, and commands on them.
Plan, create and remove service VMs, power, resize and rename any VM and change service VMs' domains, as Compute does. That takes hosts.manage and jobs.create; renaming, hosts.manage on the VM; refreshing the machine list, hosts.read and jobs.create. Check which VM is meant in oo vm inventory before asking for any grant. An external VM (external: not managed by OpenOrange) can't be powered, resized or removed from here, whatever the grants.
Run bounded commands on service VMs and on the VMs agents run on. Agents need a human-approved grant; administrators don't. A command without one asks for it at the level it needs (root to run, write or restart; read for status and logs) and exits with code 3. A task that will install, run or change anything asks for root once, first, with oo vm request: root covers status and logs, and replaces your request for read still waiting. --agent makes NAME an agent ID. An agent works on its own VM in its own shell, with no grant: a command there asks for none and says so, and only root on it needs one. An administrator opens a root terminal on any of them with oo vm shell, copies files and folders of any size with oo vm cp, and lets rsync, scp and IDEs in over SSH with oo vm ssh-config. The same people read its live CPU, memory, disk, network and processes with oo vm stats.
oo vm inventory
oo vm plan build-1 --purpose "Build tools" --size standard-4-8-60
oo vm create <plan-job-id>
oo vm requests
oo vm power web-1 reboot
oo vm resize support-bot --agent --size <size>
oo vm rename web-1 "Blog"
oo vm domains list
oo vm list
oo vm status web-1
oo vm exec web-1 -- id
oo vm exec --agent support-bot -- uname -r
oo vm shell web-1
oo vm shell --agent support-bot
oo vm stats web-1
oo vm cp --agent ./report.pdf support-bot:docs/
oo vm ssh-config --agent support-bot
oo vm request web-1 --level read --for 2h --reason check
oo vm request --agent support-bot --level root --for 1h --reason restart
oo vm approve <request-id>
oo vm grants web-1
oo vm revoke <grant-id>oo vm list
List the service VMs and agent VMs with your grants and requests; an administrator sees every one.
oo vm listIt also takes the connection options.
oo vm grants
List current access grants, on every VM or one.
oo vm grants [options] [name]| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
name | no | exact service VM name, or agent ID with --agent; default every VM | ||
--agent | no | NAME is an agent ID: run on that agent's VM |
It also takes the connection options.
oo vm revoke
Revoke an access grant. An administrator needs a key with hosts.manage; an agent can revoke its own.
oo vm revoke [options] grant_id| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
grant_id | yes | grant ID from oo vm grants | ||
--reason REASON | no | recorded with the revocation |
It also takes the connection options.
oo vm access
Inspect a VM's access, or set up or check Sunport access to a service VM.
oo vm access [options] name| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
name | yes | exact service VM name, or agent ID with --agent | ||
--agent | no | NAME is an agent ID: run on that agent's VM | ||
--check | no | admin: independently pin and verify certificate login | ||
--setup | no | admin: get the existing-VM opt-in command | ||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm status
Read a VM's status.
oo vm status [options] name| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
name | yes | exact service VM name, or agent ID with --agent | ||
--agent | no | NAME is an agent ID: run on that agent's VM | ||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm logs
Read bounded unit or container logs.
oo vm logs [options] name| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
name | yes | exact service VM name, or agent ID with --agent | ||
--agent | no | NAME is an agent ID: run on that agent's VM | ||
--unit UNIT | no | |||
--container CONTAINER | no | |||
--lines LINES | no | 200 | ||
--since-minutes SINCE_MINUTES | no | |||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm restart
Restart a unit or container with approved root access. It asks first, or takes --yes.
oo vm restart [options] name| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
name | yes | exact service VM name, or agent ID with --agent | ||
--agent | no | NAME is an agent ID: run on that agent's VM | ||
--unit UNIT | no | |||
--container CONTAINER | no | |||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat |
It also takes the connection options.
oo vm exec
Run literal command arguments or a bounded script with approved root access. It asks first, or takes --yes.
oo vm exec [options] name [argv ...]| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
name | yes | exact service VM name, or agent ID with --agent | ||
--agent | no | NAME is an agent ID: run on that agent's VM | ||
--script FILE|- | no | bounded script file, or stdin; otherwise use -- argv... | ||
--cwd CWD | no | / | ||
--runtime RUNTIME | no | 120 | remote runtime, 1–900 seconds | |
argv | no | literal command arguments after -- | ||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat |
It also takes the connection options.
oo vm put
Write a bounded file atomically with approved root access. It asks first, or takes --yes.
oo vm put [options] name path| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
name | yes | exact service VM name, or agent ID with --agent | ||
--agent | no | NAME is an agent ID: run on that agent's VM | ||
path | yes | normalized absolute remote file path | ||
--file FILE|- | no | - | content file, default stdin (up to 256 KiB) | |
--mode MODE | no | 0644 | ||
--owner OWNER | no | root | ||
--group FILE_GROUP | no | root | ||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat |
It also takes the connection options.
oo vm shell
Open a root terminal on the VM, in this terminal, as the dashboard's Terminal does: an administrator's own, with hosts.manage and hosts.vm.admin on the VM, or on an agent's VM its owner's, never an agent's. The VM's log and the Sunport's audit name you. It asks first, or takes --yes. It ends when the shell exits or your access ends; oo then exits 0 if it ended normally, 1 otherwise.
oo vm shell [options] name| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
name | yes | exact service VM name, or agent ID with --agent | ||
--agent | no | NAME is an agent ID: run on that agent's VM | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat |
It also takes the connection options.
oo vm cp
Copy a file, or a folder with -r, between this computer and the VM through the Sunport: up to 16 GiB, streamed both ways. NAME:PATH is the VM's side, PATH from the home of the user the copy runs as: on an agent's VM the agent's user, so what you copy is the agent's, or root with --root; on a service VM root. Root writes only where no one else can change a folder on the way: into another user's, such as the agent's home, an upload goes as that user. An upload replaces a file there only once all of it arrived and its sha256 matched, and a folder goes to a new folder. A broken download goes on from where it stopped with --continue. Whoever may open oo vm shell there may copy, and the Sunport's audit names you. An upload asks first, or takes --yes.
oo vm cp [options] source destination| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
source | yes | a path on this computer, or NAME:PATH on the VM | ||
destination | yes | NAME:PATH on the VM, or a path on this computer | ||
-r, --recursive | no | copy a folder, as a tar packed and unpacked on the fly | ||
--continue | no | go on with a download that stopped, from its NAME.oo-partial file | ||
--overwrite | no | replace a file already at the local destination | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat | ||
--agent | no | NAME is an agent ID: run on that agent's VM | ||
--root | no | on an agent's VM, log in as root, not as the agent's user |
It also takes the connection options.
oo vm ls
List a folder on the VM as the user oo vm cp copies as: its entries, each with its type, and a file's size. NAME:PATH, PATH from that user's home; NAME alone lists the home. The people who may copy may list.
oo vm ls [options] NAME[:PATH]| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
NAME[:PATH] | yes | the VM, and a folder on it | ||
--agent | no | NAME is an agent ID: run on that agent's VM | ||
--root | no | on an agent's VM, log in as root, not as the agent's user |
It also takes the connection options.
oo vm stats
Read one live sample of the VM, as its Monitor in the dashboard shows it: CPU over the last second, each vCPU's and the load, memory and swap, the root disk and I/O, network rates and totals, and the busiest and largest processes. The people who may copy may read it. A process's command line, which can carry secrets, shows only to those who work there as root. --json prints the Sunport's answer.
oo vm stats [options] name| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
name | yes | exact service VM name, or agent ID with --agent | ||
--json | no | print the Sunport's JSON | ||
--agent | no | NAME is an agent ID: run on that agent's VM |
It also takes the connection options.
oo vm ssh-config
Print a Host block for your SSH config, by which rsync, scp, sftp and IDEs such as VS Code Remote-SSH reach the VM through the Sunport's relay with your credential; the VM's own keys never leave the Sunport. Whoever may open oo vm shell there may use it, and the VM's log and the Sunport's audit name you. On an agent's VM it logs in as the user the agent runs as, so what you copy is the agent's; --root logs in as root, as the host NAME-root. It asks first, or takes --yes. Append it to ~/.ssh/config, then use the host named NAME.
oo vm ssh-config [options] name| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
name | yes | exact service VM name, or agent ID with --agent | ||
--agent | no | NAME is an agent ID: run on that agent's VM | ||
--root | no | on an agent's VM, log in as root, not as the agent's user | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat |
It also takes the connection options.
oo vm ssh-proxy
Carry SSH over standard input and output, as the Host block from oo vm ssh-config runs it.
oo vm ssh-proxy [options] name| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
name | yes | exact service VM name, or agent ID with --agent | ||
--agent | no | NAME is an agent ID: run on that agent's VM | ||
--root | no | on an agent's VM, log in as root, not as the agent's user |
It also takes the connection options.
oo vm request
Ask an administrator for access; they approve or deny it on the VM's Access tab in Compute, or for an agent VM in the VM access section of that agent's page. On an agent's VM its owner also decides, by asking Clem. Ask once, at the level the whole task needs: root covers read, and replaces your request for read still waiting there. Clem's request goes on the card of the administrator asking in web chat.
oo vm request [options] name| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
name | yes | exact service VM name, or agent ID with --agent | ||
--agent | no | NAME is an agent ID: run on that agent's VM | ||
--level LEVEL | yes | read, root | ||
--for DURATION | no | duration such as 2h or 7d; defaults read=7d, root=8h | ||
--reason REASON | yes |
It also takes the connection options.
oo vm approve
Approve or deny a VM access request for the person who asked Clem in web chat: an administrator, or the owner of an agent for what it asks on its own VM; Clem's own request waits for an administrator's click. Any other key is refused: an administrator decides in Compute.
oo vm approve [options] request_id| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
request_id | yes | request ID from oo vm request or oo vm list | ||
--payload-hash PAYLOAD_HASH | no | the request's payload_hash; read from oo vm list when left out | ||
--deny | no | deny it instead |
It also takes the connection options.
oo vm mail-submission
Read, opt into or revoke approved service VM mail submission.
oo vm mail-submission [options] name| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
name | yes | exact service VM name | ||
--provider PROVIDER | no | approved provider ID from the status; stays off until OpenOrange enables it | ||
--revoke | no | revoke the VM's submission policy | ||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm inventory
Refresh and print Compute's machine list: every VM with its status, provider, size and addresses, displayName for one people named here, and the catalog of providers and sizes to plan from.
oo vm inventory [options]| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm plan
Plan a new service VM, as New VM in Compute does. The finished job is the plan, with its price; oo vm create JOB_ID creates the VM from it within 24 hours.
oo vm plan [options] name| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 | ||
name | yes | the VM's name: lowercase letters, digits and single dashes, from a letter | ||
--purpose PURPOSE | yes | what it is for, in one line | ||
--size SIZE | yes | the size, as oo vm inventory lists it | ||
--provider PROVIDER | no | incus | incus (OpenOrange capacity, the default), or another provider oo vm inventory lists; a HOSTKEY plan takes its catalog preset with oo run hosts.compute-plan | |
--region REGION | no | the region: required for all but incus; OpenOrange capacity picks a node with room | ||
--node NODE | no | on OpenOrange capacity, this node instead of any with room | ||
--ssh-key PUBLIC_KEY_FILE | no | optional owner public SSH key file (.pub); omitted, no owner login | ||
--ssh-from IPV4 | no | a public IPv4 address SSH is taken from, besides the Sunport; repeat for more | ||
--public-web | no | open public HTTP and HTTPS, which Domains & routes need | ||
--no-public-ip | no | on OpenOrange capacity, a VM without a public IP | ||
--owner-only | no | no Sunport access or root for Clem; optional --ssh-key gives owner login |
It also takes the connection options.
oo vm create
Create the VM of a plan, as Create VM in Compute does; for a connected agent's server request, this approves it.
oo vm create [options] PLAN_ID| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 | ||
PLAN_ID | yes | the plan's job ID, from oo vm plan |
It also takes the connection options.
oo vm requests
List the servers connected agents asked for this month, newest first, as Compute shows them: each with its ID, the agent, its name, purpose and size, the addresses it takes SSH from and its status (planning, waiting, creating, ready, declined, expired, withdrawn or failed); its price only for an administrator. It needs hosts.read. An administrator declines one that waits with oo vm decline REQUEST_ID.
oo vm requestsIt also takes the connection options.
oo vm decline
Decline a connected agent's request for a server, as Decline under VM plans in Compute does. It takes an administrator's own key; the agent hears it in its inbox.
oo vm decline REQUEST_ID| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
REQUEST_ID | yes | the request's ID, from oo vm requests or the agent's oo servers list |
It also takes the connection options.
oo vm power
Power a VM on or off, or reboot it, as its menu in Compute does. A VM that is off is still charged. An external VM isn't OpenOrange's to power.
oo vm power [options] name ACTION| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 | ||
name | yes | the service VM's name, or with --agent the agent's ID | ||
ACTION | yes | start, stop, reboot | start, stop or reboot | |
--agent | no | NAME is an agent ID: its VM | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat |
It also takes the connection options.
oo vm resize
Move a VM on OpenOrange capacity to another size, as Resize in Compute does: one of the VM's resize sizes in oo vm inventory. CPUs and more memory reach the running VM within seconds; less memory needs --restart, which stops it for about 10 seconds. A bigger disk grows at the VM's next start, or at once with --restart; disks never shrink. --keep-disk keeps the disk and changes only CPUs and memory, for a size marked fitsOnlyKeepingDisk. --move moves an agent's VM to another server with room, for a size marked fitsByMoving: it is off while its disk copies. Sizes marked staffOnly, and any bigger size on a free trial, are support's to pick. An external VM isn't OpenOrange's to resize.
oo vm resize [options] name| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 | ||
name | yes | the service VM's name, or with --agent the agent's ID | ||
--size SIZE | yes | a size's id from the VM's resize sizes in oo vm inventory | ||
--agent | no | NAME is an agent ID: its VM | ||
--price USD | no | a Hetzner VM: the new size's monthly price in USD, as its resize sizes show it, which you accept | ||
--grow-disk | no | a Hetzner VM: take the new size's bigger disk. It can't be undone, and the VM can't move to a size with a smaller disk afterwards; without it the disk is kept | ||
--keep-disk | no | a VM on OpenOrange capacity: keep its current disk and change only its CPUs and memory, so its server needs room for those alone (a size whose fitsOnlyKeepingDisk is true) | ||
--restart | no | accept a restart of about 10 seconds: less memory needs one, and a bigger disk grows at once | ||
--move | no | an agent's VM whose server has no room: move it to another server that has (a size whose fitsByMoving is true). It is off while its disk copies, then starts there with everything on it | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat |
It also takes the connection options.
oo vm rename
Give a VM the name people see for it here, as Rename in Compute does: Compute, oo vm inventory and Clem show it. Wherever the VM is addressed it keeps the name it was made with, in oo vm NAME too. It takes hosts.manage on the VM.
oo vm rename [options] name NEW_NAME| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
name | yes | the service VM's name, or with --agent the agent's ID | ||
NEW_NAME | yes | what to call it: one line of at most 80 characters | ||
--agent | no | NAME is an agent ID: its VM |
It also takes the connection options.
oo vm remove
Delete a service VM, with its data and no backup, as Delete VM in Compute does. Remove its domains first. An external VM isn't OpenOrange's to remove.
oo vm remove [options] name| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 | ||
name | yes | the service VM's name | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat |
It also takes the connection options.
oo vm enroll
Retry a service VM's enrollment in the Sunport network, as Retry enrollment in Compute does. Nothing new is created.
oo vm enroll [options] name| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 | ||
name | yes | the service VM's name |
It also takes the connection options.
oo vm forget
Forget a server OpenOrange doesn't manage that hasn't been seen for 24 hours, such as an adopted agent's own server that was deleted: the Sunport stops trusting it and OpenOrange drops its record of it, so deleting its agent can finish. An administrator's; a VM OpenOrange manages is deleted with its agent or oo vm remove instead.
oo vm forget [options] name| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 | ||
name | yes | the server's enrolled name: an adopted agent's ID | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat |
It also takes the connection options.
oo vm domains
List, refresh, add, change and remove the domains of service VMs and agents' VMs, and forward domains on the Sunport's own edge gateways to any server, as Domains & routes in Compute does.
oo vm domains [COMMAND]It also takes the connection options.
oo vm domains list
The last domain list OpenOrange gave, with the latest route changes
oo vm domains listIt also takes the connection options.
oo vm domains refresh
Ask OpenOrange for the domain list again
oo vm domains refresh [options]| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm domains put
Add a domain to a service VM, or with --agent to an agent's VM, or change the route it has. --gateway publishes it on that edge gateway, and with --from-gateway moves it there from another; once the new gateway serves it, --confirm-cutover finishes the move. --direct points a name under the Sunport's domain straight at the VM, and --port publishes one port of the VM through the Sunport. A new route through the Sunport asks for the OpenOrange sign-in at its name: only administrators and the people who may use the agent (administrators alone on a service VM), signed in to this Sunport, reach the app, whose own login stays. --public serves it to anyone instead; a route the Sunport serves already keeps what it has, and oo vm domains sign-in changes it. The finished job says which DNS records the name needs, if any, and what it waits for.
oo vm domains put [options] VM ROUTE hostname| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
VM | yes | the service VM's name, or with --agent the agent's ID | ||
ROUTE | yes | the route's name on the VM: lowercase letters, digits and dashes, from a letter; an existing one changes that route | ||
--agent | no | VM is an agent's ID: its VM | ||
hostname | yes | the domain, without a protocol or path | ||
--gateway GATEWAY | no | the edge gateway, from oo vm domains list | ||
--direct | no | a name under the Sunport's domain, straight to the VM | ||
--port PORT | no | the VM's port to publish through the Sunport, not 22 | ||
--from-gateway GATEWAY | no | with --gateway: the gateway the route moves from | ||
--confirm-cutover | no | with --from-gateway: finish the move to --gateway | ||
--public | no | with --port: serve it to anyone, without the OpenOrange sign-in | ||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm domains remove
Take a domain off its VM
oo vm domains remove [options] VM ROUTE| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
VM | yes | the service VM's name, or with --agent the agent's ID | ||
ROUTE | yes | the route's name on the VM: lowercase letters, digits and dashes, from a letter; an existing one changes that route | ||
--agent | no | VM is an agent's ID: its VM | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat | ||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm domains sign-in
Turn the OpenOrange sign-in at the name of a route through the Sunport (put --port) on or off, as its menu in Domains & routes does. On, only administrators and the people who may use the agent (administrators alone on a service VM), signed in to this Sunport, reach the app, from the Sunport's next look at its routes, within a minute; off, anyone with its address does, at once. Edge and direct routes don't pass the Sunport's nginx and have no such sign-in. oo vm domains list says which routes are open to anyone.
oo vm domains sign-in [options] VM ROUTE state| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
VM | yes | the service VM's name, or with --agent the agent's ID | ||
ROUTE | yes | the route's name on the VM | ||
state | yes | on, off | on asks for the sign-in; off serves the route to anyone | |
--agent | no | VM is an agent's ID: its VM | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat |
It also takes the connection options.
oo vm domains forward
Publish a domain on an edge gateway this Sunport owns and forward it straight to a server by its public IPv4 address: an agent VM, a service VM or any other server. The gateway reaches it over HTTPS and checks its certificate for --tls-name, the domain itself unless given. The same ROUTE with the same domain and gateway changes the server and the options; --from-gateway moves it to another of the Sunport's gateways, and --confirm-cutover finishes the move. The finished job says which DNS records the domain needs, if any.
oo vm domains forward [options] ROUTE hostname| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
ROUTE | yes | the route's name: lowercase letters, digits and dashes, from a letter | ||
hostname | yes | the domain, without a protocol or path | ||
--gateway GATEWAY | yes | an edge gateway this Sunport owns, from oo vm domains list | ||
--to ADDRESS[:PORT] | yes | the server's public IPv4 address, and its HTTPS port (443) | ||
--tls-name NAME | no | the name the server's certificate is for, such as its address for an IP certificate | ||
--path PREFIX | no | only this path prefix reaches the server, such as /app/; repeat it | ||
--origin-check | no | refuse other sites' pages (403), as for WebSockets | ||
--no-cookies | no | drop cookies in both directions | ||
--from-gateway GATEWAY | no | the gateway the route moves from to --gateway | ||
--confirm-cutover | no | with --from-gateway: finish the move to --gateway | ||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm domains unforward
Stop forwarding a domain to its server
oo vm domains unforward [options] ROUTE| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
ROUTE | yes | the route's name | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat | ||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm edges
List, create and remove the edge gateways this Sunport owns, take one offline or apply its settings again, choose which serves the Sunport's web and its model calls, and turn their failover on or off. Every finished job is the list: each gateway with its status, health, location, size, monthly price and whether it is in use, and the gateway and failover of the web and of model calls.
oo vm edges [COMMAND]It also takes the connection options.
oo vm edges list
The gateways, and what serves the web and model calls
oo vm edges list [options]| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm edges create
Create an edge gateway this Sunport owns, on a new server of a size from oo vm inventory's catalog (any provider but AWS), charged monthly until it is removed. --price is that size's monthlyListUsd, which confirms it; leave it out for a size with none. A price that changed is refused with the price now (edge_price_changed).
oo vm edges create [options] ID| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
ID | yes | the gateway's ID: lowercase letters, digits and dashes | ||
--name NAME | yes | what to call it | ||
--provider PROVIDER | yes | the provider, as oo vm inventory lists it | ||
--region REGION | yes | the region | ||
--size SIZE | yes | the size | ||
--node NODE | no | on OpenOrange capacity, this node | ||
--price USD | no | the size's monthlyListUsd from oo vm inventory | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat | ||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm edges status
Take a gateway offline, or apply its settings again
oo vm edges status [options] ID state| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
ID | yes | the gateway's ID | ||
state | yes | onboarding, offline | onboarding applies its settings again and tests it; offline takes it out of service | |
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm edges remove
Remove a gateway and destroy its server
oo vm edges remove [options] ID| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
ID | yes | the gateway's ID | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat | ||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm edges route
Choose the gateways serving the web and model calls
oo vm edges route [options]| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
--web ID|direct | yes | the gateway serving the Sunport's web, or direct | ||
--inference ID|direct | yes | the gateway serving the Sunport's model calls, or direct | ||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm edges failover
Turn edge failover on or off
oo vm edges failover [options] surface state| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
surface | yes | web, inference | the web or model calls | |
state | yes | on, off | on or off | |
--backup ID | no | with on: a gateway it fails over to, in order; give one or two | ||
--pause | no | hold failover without turning it off | ||
--resume | no | let a paused failover act again | ||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm volumes
List, add, grow, attach, detach and delete volumes: extra disks for agents' and service VMs on OpenOrange capacity, as a VM's Disks in Compute does. A volume is paid by its size each month, at the price oo vm volumes list shows (priceUsdPerGbMonth), with the limits it shows. On an agent's VM it is formatted (only when new) and mounted; on a service VM the job's result gives the script that mounts it, for oo vm exec --script -. Volumes aren't in backups or pre-update snapshots. Grow a VM's own disk (oo vm resize) for the system and its apps; add a volume for data that grows on its own.
oo vm volumes [COMMAND]It also takes the connection options.
oo vm volumes list
The volumes, their limits and price, and each VM's room for them
oo vm volumes list [options]| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm volumes add
Add a volume to a VM and mount it at --mount, /data/NAME by default. --price is its monthly list price, --size times priceUsdPerGbMonth from oo vm volumes list, which you accept; without it the job fails with the price to accept (vm_volume_price_confirmation_required). A VM whose server has no room fails with vm_volume_no_room; --move moves it first to a server that has, off while its disk copies. A volume the job added but couldn't mount, as on a VM that was off, is mounted by the same command again.
oo vm volumes add [options] NAME| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
NAME | yes | the service VM's name, or with --agent the agent's ID | ||
--agent | no | NAME is an agent ID: its VM | ||
--name NAME | yes | the volume's name: lowercase letters, digits and dashes, from a letter | ||
--size GB | yes | its size in GB | ||
--mount PATH | no | where it is mounted, an empty folder outside the system's own | ||
--price USD | no | its monthly list price, which you accept | ||
--move | no | move the VM to a server with room first; it is off meanwhile | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat | ||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm volumes grow
Grow a volume to --size GB; volumes never shrink. Its VM, if running, restarts for about a minute, and its filesystem grows. --price is the new monthly list price, which you accept.
oo vm volumes grow [options] VOLUME_ID| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
VOLUME_ID | yes | the volume's ID, from oo vm volumes list | ||
--size GB | yes | its new size in GB | ||
--price USD | no | its new monthly list price, which you accept | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat | ||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm volumes attach
Attach a detached volume to a VM on its server, and mount it
oo vm volumes attach [options] VOLUME_ID NAME| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
VOLUME_ID | yes | the volume's ID | ||
NAME | yes | the service VM's name, or with --agent the agent's ID | ||
--agent | no | NAME is an agent ID: its VM | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat | ||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm volumes detach
Unmount a volume on its VM and detach it. It keeps its files, and is charged while it is kept. On a running service VM, run the unmount script the refusal gives as root there first, then detach it again with --unmounted.
oo vm volumes detach [options] VOLUME_ID| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
VOLUME_ID | yes | the volume's ID | ||
--unmounted | no | a running service VM: you unmounted it there already | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat | ||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm volumes delete
Delete a detached volume. OpenOrange keeps it until deleteAfter, when its data is deleted for good; oo vm volumes cancel-delete takes it back meanwhile. It takes a person who is an administrator.
oo vm volumes delete [options] VOLUME_ID| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
VOLUME_ID | yes | the volume's ID | ||
--name NAME | yes | the volume's name, which confirms it | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat | ||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo vm volumes cancel-delete
Take a volume's deletion back during its hold
oo vm volumes cancel-delete [options] VOLUME_ID| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
VOLUME_ID | yes | the volume's ID | ||
--no-wait | no | print the accepted job instead of following it | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.