io7m | single-page | multi-page
3.20. vm-kill
Previous
3. Command-Line Interface
Up
3.22. vm-list
Next
3.21

# vm-list-with-name

- 3.21. vm-list-with-name
  - 3.21.1. Name
  - 3.21.2. Description
  - 3.21.3. Example

3.21.1

## Name

1
vm-list-with-name - List defined virtual machines with a given name
3.21.2

## Description

1
The vm-list-with-name command lists the identifiers of all of the virtual machines that have a given name. The command raises an error if no virtual machines have the given name.
2

### 3.21.2.2 Parameters

Parameter | Type | Required | Description
--- | --- | --- | ---
--configuration | Path | false | The path to the configuration file (environment variable: $WAXMILL_CONFIGURATION_FILE)
--name | Machine Name | true | The name of the virtual machine
--verbose | Log Level | false | Set the minimum logging verbosity level.

3.21.3

## Example

1

### 3.21.3.1 Example

    $ waxmill vm-list-with-name --name com.io7m.example
    538a90e4-d50d-4511-8643-ae418279bac4

    $ waxmill vm-list-with-name --name nonexistent
    ERROR com.io7m.waxmill.cmdline.internal.WXMCommandVMListWithName: No virtual machines exist with the given name.
      Name:  nonexistent

3.20. vm-kill
Previous
3. Command-Line Interface
Up
3.22. vm-list
Next
io7m | single-page | multi-page