You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`list`| List all locations (name and id) that the authenticated session has access to, grouped by organization |**organization id** : (_optional_) return results for specified organization only |
566
-
|`api-key`| Work with an api-key for your location |`create`|
566
+
|`api-key`| Work with an API key for your location |`create`|
567
567
|`--help`| Return help | - |
568
568
569
569
##### Positional arguments: `api-key`
@@ -1190,6 +1190,9 @@ viam profiles list
1190
1190
1191
1191
# Remove a profile
1192
1192
viam profiles remove --profile-name=mycompany
1193
+
1194
+
# Example of using a profile to see a list of machines available to that profile
1195
+
viam --profile=mycompany machines list
1193
1196
```
1194
1197
1195
1198
See [create an organization API key](#create-an-organization-api-key) for more information.
@@ -1250,7 +1253,7 @@ Examples:
1250
1253
viam machines list
1251
1254
1252
1255
# get machine status
1253
-
viam machines status --machine=123 --location=myLoc
1256
+
viam machines status --machine=123
1254
1257
1255
1258
# create an api key for a machine
1256
1259
viam machines api-key create --machine-id=123 --name=MyKey
@@ -1297,7 +1300,7 @@ viam machine part cp --part=123 -r -p machine:my_dir machine:my_file ~/some/exis
|`list`| List all machines that the authenticated session has access to, filtered by organization and location. | - |
1300
-
|`api-key`| Work with an api-key for your machine |`create` (see [positional arguments: api-key](#positional-arguments-api-key)) |
1303
+
|`api-key`| Work with an API key for your machine |`create` (see [positional arguments: api-key](#positional-arguments-api-key)) |
1301
1304
|`status`| Retrieve machine status for a specified machine | - |
1302
1305
|`logs`| Retrieve logs for a specified machine | - |
1303
1306
|`part`| Manage a specified machine part |`status`, `run`, `logs`, `shell`, `restart`, `tunnel`, `cp` (see [positional arguments: part](#positional-arguments-part)). To use the `part shell` and `part cp` commands, you must add the [ViamShellDanger fragment](https://app.viam.com/fragment/b511adfa-80ab-4a70-9bd5-fbb14696b17e/json) to your machine. |
@@ -1332,7 +1335,7 @@ viam machine part cp --part=123 -r -p machine:my_dir machine:my_file ~/some/exis
|`--organization`| Organization name or ID that the machine belongs to |`list`, `status`, `logs`, `part`| Optional |
1334
1337
|`--location`| Location name or ID that the machine belongs to or to list machines in |`list`, `status`, `logs`, `part`| Optional |
1335
-
|`--machine`| Machine name or ID for which the command is being issued. If machine name is used instead of ID, `--organization` and `--location` are required. |`status`, `logs`, `part`|**Required**|
1338
+
|`--machine`| Machine name or ID for which the command is being issued. If machine name is used instead of ID, `--organization` and `--location` are required. |`status`, `logs`, `part`|Optional|
1336
1339
|`--errors`| Boolean, return only errors (default: false) |`logs`| Optional |
1337
1340
|`--levels`| Filter logs by levels (debug, info, warn, error). Accepts multiple inputs in comma-separated list. |`logs`| Optional |
1338
1341
|`--part`| Part name or ID for which the command is being issued |`logs`, `part`| Optional |
0 commit comments