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
@@ -78,20 +77,22 @@ These commands do not require `arguments`:
78
77
79
78
All other inputs are required.
80
79
81
-
Multiple commands can be provided in json format to `--commands` option. Each `command` specifies command and the arguments.
80
+
Multiple commands can be provided in json format to `--commands` option.
82
81
83
82
For a command with multiple arguments, provide as a list to `arguments` parameter. See [Azure CLI Shorthand](https://github.com/Azure/azure-cli/blob/dev/doc/shorthand_syntax.md) for instructions on constructing the `--commands` structure.
84
83
85
-
These commands can be long running so the recommendation is to set `--limit-time-seconds` to at least 600 seconds (10 minutes). The `Debug` option or running multiple extracts might take longer that 10 minutes.
84
+
These commands can be long running so the recommendation is to set `--limit-time-seconds` to at least 600 seconds (10 minutes). Running multiple extracts might take longer that 10 minutes.
85
+
86
+
This command runs synchronously. If you wish to skip waiting for the command to complete, specify the `--no-wait --debug` options. In that case, follow the instructions on [how to track asynchronous operation](https://learn.microsoft.com/en-us/azure/operator-nexus/howto-track-async-operations-cli).
86
87
87
-
This command runs synchronously. If you wish to skip waiting for the command to complete, specify the `--no-wait` option.
88
+
When an optional argument `--output-directory` is provided, the output result will be downloaded and extracted to the local directory.
88
89
89
90
### This example executes the `hostname` command and a `ping` command.
90
91
91
92
```azurecli
92
93
az networkcloud baremetalmachine run-read-command --name "bareMetalMachineName" \
@@ -101,23 +102,23 @@ In the response, an HTTP status code of 202 is returned as the operation is perf
101
102
## Checking command status and viewing output
102
103
103
104
104
-
Sample output looks something like this and provides a link to the zipped output file(tar.gz) from the command execution. The tar.gz file name can be used to identify the file in the Storage account of the Cluster Manager resource group. You can also use the link to directly access the output zip file. Download the output file from storage blob to a local directory by specifying the directory path in the optional argument `--output-directory`.
105
+
Sample output looks something like below. It prints the top 5K characters of the result to the screen for convenience and provides a short-lived link to the storage blob containing the command execution result. You can use the link to download the zipped output file (tar.gz).
105
106
106
107
```azurecli
107
108
====Action Command Output====
108
109
+ hostname
109
110
rack1compute01
110
-
+ ping 192.168.0.99 -c 3
111
-
PING 192.168.0.99 (192.168.0.99) 56(84) bytes of data.
111
+
+ ping 198.51.102.1 -c 3
112
+
PING 198.51.102.1 (198.51.102.1) 56(84) bytes of data.
112
113
113
-
--- 192.168.0.99 ping statistics ---
114
+
--- 198.51.102.1 ping statistics ---
114
115
3 packets transmitted, 0 received, 100% packet loss, time 2049ms
115
116
116
117
117
118
118
119
================================
119
120
Script execution result can be found in storage account:
See [How To BareMetal Review Output Run-Read](howto-baremetal-review-read-output.md) for instructions on locating the output file in the Storage Account. You can also use the link to directly access the output zip file.
Copy file name to clipboardExpand all lines: articles/operator-nexus/howto-cluster-metrics-configuration-management.md
+17-15Lines changed: 17 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,8 +48,23 @@ az networkcloud cluster metricsconfiguration create \
48
48
> * The default metrics collection interval for standard set of metrics is set to every 5 minutes. Changing the `collectionInterval` will also impact the collection frequency for default standard metrics.
49
49
> * There can be only one set of metrics configuration defined per cluster. The resource is created with the name `default`.
50
50
51
+
Specifying `--no-wait --debug` options in az cli command will result in the execution of this command asynchronously. See [how to track asynchronous operations](howto-track-async-operations-cli.md) for more details.
51
52
52
-
Specifying `--debug` in az cli command will result in the tracking operation status in the returned command output. This operation status can be queried to monitor the progress of the operation. See: [How-to track asynchronous operations](howto-track-async-operations-cli.md).
| LOCATION | The Azure Region where the Cluster will be deployed |
59
+
| CLUSTER_EXTENDED_LOCATION_ID | The Cluster extended Location from Azure portal |
60
+
| COLLECTION_INTERVAL | The collection frequency for default standard metrics |
61
+
| RESOURCE_GROUP | The Cluster resource group name |
62
+
| TAG_KEY1 | Optional tag1 to pass to Cluster create |
63
+
| TAG_VALUE1 | Optional tag1 value to pass to Cluster Create |
64
+
| TAG_KEY2 | Optional tag2 to pass to Cluster create |
65
+
| TAG_VALUE2 | Optional tag2 value to pass to Cluster create |
66
+
| METRIC_TO_ENABLE_1 | Optional metric1 that have been chosen to be enabled in addition to the default metrics |
67
+
| METRIC_TO_ENABLE_2 | Optional metric2 that have been chosen to be enabled in addition to the default metrics |
53
68
54
69
## Retrieving a metrics configuration
55
70
@@ -79,7 +94,7 @@ az networkcloud cluster metricsconfiguration update \
79
94
--resource-group "<RESOURCE_GROUP>"
80
95
```
81
96
82
-
The change may include either or both of the updatable fields, `collectionInterval` or `enabledMetrics`. The `collectionInterval`can be updated independently of `enabledMetrics`. Omit fields that aren't being changed.
97
+
The `collection-interval`can be updated independently of `enabled-metrics` list. Omit fields that aren't being changed.
83
98
84
99
Specifying `--debug` in az cli will result in the tracking operation status in the returned command output. This operation status can be queried to monitor the progress of the operation. See: [How-to track asynchronous operations](howto-track-async-operations-cli.md).
85
100
@@ -95,16 +110,3 @@ az networkcloud cluster metricsconfiguration delete \
95
110
96
111
Specifying `--debug` in az cli will result in the tracking operation status in the returned command output. This operation status can be queried to monitor the progress of the operation. See: [How-to track asynchronous operations](howto-track-async-operations-cli.md).
0 commit comments