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 |
561
-
|`api-key`| Work with an api-key for your location |`create`|
561
+
|`api-key`| Work with an API key for your location |`create`|
562
562
|`--help`| Return help | - |
563
563
564
564
##### Positional arguments: `api-key`
@@ -1184,6 +1184,9 @@ viam profiles list
1184
1184
1185
1185
# Remove a profile
1186
1186
viam profiles remove --profile-name=mycompany
1187
+
1188
+
# Example of using a profile to see a list of machines available to that profile
1189
+
viam --profile=mycompany machines list
1187
1190
```
1188
1191
1189
1192
See [create an organization API key](#create-an-organization-api-key) for more information.
@@ -1244,7 +1247,7 @@ Examples:
1244
1247
viam machines list
1245
1248
1246
1249
# get machine status
1247
-
viam machines status --machine=123 --location=myLoc
1250
+
viam machines status --machine=123
1248
1251
1249
1252
# create an api key for a machine
1250
1253
viam machines api-key create --machine-id=123 --name=MyKey
@@ -1288,7 +1291,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. | - |
1291
-
|`api-key`| Work with an api-key for your machine |`create` (see [positional arguments: api-key](#positional-arguments-api-key)) |
1294
+
|`api-key`| Work with an API key for your machine |`create` (see [positional arguments: api-key](#positional-arguments-api-key)) |
1292
1295
|`status`| Retrieve machine status for a specified machine | - |
1293
1296
|`logs`| Retrieve logs for a specified machine | - |
1294
1297
|`part`| Manage a specified machine part |`status`, `run`, `logs`, `shell`, `restart`, `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. |
@@ -1322,7 +1325,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 |
1324
1327
|`--location`| Location name or ID that the machine belongs to or to list machines in |`list`, `status`, `logs`, `part`| Optional |
1325
-
|`--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**|
1328
+
|`--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|
1326
1329
|`--errors`| Boolean, return only errors (default: false) |`logs`| Optional |
1327
1330
|`--levels`| Filter logs by levels (debug, info, warn, error). Accepts multiple inputs in comma-separated list. |`logs`| Optional |
1328
1331
|`--part`| Part name or ID for which the command is being issued |`logs`, `part`| Optional |
0 commit comments