# unikraft instances

Manage Unikraft Cloud instances.

## Options inherited from parent commands

```
  --config file               Path to the configuration file.
  --log-level level           Set the logging level. (default info)
  --log-type type             Set the log type. (default text)
  --profile name              Set the current profile.
  --telemetry                 Toggle anonymous usage analytics. (default true)
```

## Resource Fields

| Field                         | Type                                                | Operations  |
| ----------------------------- | --------------------------------------------------- | ----------- |
| `metro`                       | `string`                                            | create      |
| `name`                        | `string`                                            | create      |
| `uuid`                        | `string`                                            |             |
| `tags`                        | `[string]`                                          |             |
| `state`                       | `string`                                            | edit        |
| `image`                       | `imageref[github.com/distribution/reference.named]` | create/edit |
| `runtime`                     |                                                     |             |
| `runtime.args`                | `[string]`                                          | create/edit |
| `runtime.env`                 | `{string: string}`                                  | create/edit |
| `resources`                   |                                                     |             |
| `resources.memory`            | `integer`                                           | create/edit |
| `resources.vcpus`             | `integer`                                           | create/edit |
| `service`                     |                                                     | create      |
| `service.name`                | `string`                                            |             |
| `service.uuid`                | `string`                                            |             |
| `service.services`            |                                                     | create      |
| `service.domains`             |                                                     | create      |
| `service.soft-limit`          |                                                     | create      |
| `service.hard-limit`          |                                                     | create      |
| `volumes`                     |                                                     | create      |
| `roms`                        |                                                     | create/edit |
| `networks`                    |                                                     |             |
| `timestamps`                  |                                                     |             |
| `timestamps.created`          | `relativetime`                                      |             |
| `timestamps.started`          | `relativetime`                                      |             |
| `timestamps.stopped`          | `relativetime`                                      |             |
| `scale-to-zero`               |                                                     | create/edit |
| `scale-to-zero.enabled`       | `bool`                                              |             |
| `scale-to-zero.policy`        | `string`                                            |             |
| `scale-to-zero.stateful`      | `bool`                                              |             |
| `scale-to-zero.cooldown-time` | `integer`                                           |             |
| `scale-to-zero.notify-time`   | `integer`                                           |             |
| `timing`                      |                                                     |             |
| `timing.uptime`               | `integer`                                           |             |
| `timing.boot-time`            | `integer`                                           |             |
| `timing.net-time`             | `integer`                                           |             |
| `restart`                     |                                                     |             |
| `restart.policy`              | `string`                                            | create      |
| `restart.start-count`         | `integer`                                           |             |
| `restart.restart-count`       | `integer`                                           |             |
| `autostart`                   |                                                     | create      |
| `replicas`                    |                                                     | create      |
| `wait-timeout`                |                                                     | create      |
| `features`                    |                                                     | create      |
| `vsock`                       |                                                     | create/edit |
| `template`                    |                                                     | create      |
| `stop`                        |                                                     |             |
| `stop.reason`                 | `string`                                            |             |
| `stop.origin`                 | `string`                                            |             |
| `stop.errno`                  | `uintptr`                                           |             |
| `stop.exit-code`              | `integer`                                           |             |

## See Also

* [`unikraft`](../unikraft.mdx): The Unikraft Command-Line Interface.
* [`unikraft instances get`](instances/get.mdx): Inspect a instance.
* [`unikraft instances wait`](instances/wait.mdx): Wait for instances to match a filter.
* [`unikraft instances list`](instances/list.mdx): List instances.
* [`unikraft instances delete`](instances/delete.mdx): Remove a instance.
* [`unikraft instances create`](instances/create.mdx): Create an instance.
* [`unikraft instances edit`](instances/edit.mdx): Edit an instance.
* [`unikraft instances template`](instances/template.mdx): Manage instance templates.
* [`unikraft instances logs`](instances/logs.mdx): Fetch and display instance logs.
* [`unikraft instances start`](instances/start.mdx): Start one or more instances.
* [`unikraft instances stop`](instances/stop.mdx): Stop one or more instances.
* [`unikraft instances suspend`](instances/suspend.mdx): Suspend one or more instances.
* [`unikraft instances restart`](instances/restart.mdx): Restart one or more instances.