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
Copy file name to clipboardExpand all lines: articles/operator-nexus/howto-baremetal-review-read-output.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ ms.date: 03/23/2023
9
9
ms.custom: template-how-to
10
10
---
11
11
12
-
# How to view the output of an `az networkcloud run-read-command` in the Cluster Manager Storage account
12
+
# How to view the output of an `az networkcloud baremetalmachine run-read-command` in the Cluster Manager Storage account
13
13
14
14
This guide walks you through accessing the output file that is created in the Cluster Manager Storage account when an `az networkcloud baremetalmachine run-read-command` is executed on a server. The name of the file is identified in the `az rest` status output.
@@ -75,60 +75,50 @@ These commands to not require `arguments`:
75
75
-`ss`
76
76
-`ulimit -a`
77
77
78
-
All other inputs are required. Multiple commands are each specified with their own `--commands` option.
78
+
All other inputs are required.
79
79
80
-
Each `--commands` option specifies `command` and `arguments`. For a command with multiple arguments, `arguments` is repeated for each one.
80
+
Multiple commands can be provided in json format to `--commands` option.
81
81
82
-
`--debug` is required to get the operation status that can be queried to get the URL for the output file.
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.
83
+
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. For more information, see [how to track asynchronous operations](howto-track-async-operations-cli.md).
Check the status of the operation with the `az rest`command:
105
+
Sample output looks something as below. It prints the top 4K 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).
107
106
108
107
```azurecli
109
-
az rest --method get --url <Azure-AsyncOperation-URL>
110
-
```
108
+
====Action Command Output====
109
+
+ hostname
110
+
rack1compute01
111
+
+ ping 198.51.102.1 -c 3
112
+
PING 198.51.102.1 (198.51.102.1) 56(84) bytes of data.
111
113
112
-
Repeat until the response to the URL displays the result of the run-read-command.
114
+
--- 198.51.102.1 ping statistics ---
115
+
3 packets transmitted, 0 received, 100% packet loss, time 2049ms
113
116
114
-
Sample output looks something like this. The `Succeeded``status` indicates the command was executed on the BMM. The `resultUrl` provides a link to the zipped output file that contains the output 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.
115
117
116
-
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.
117
118
118
-
```azurecli
119
-
az rest --method get --url https://management.azure.com/subscriptions/xxxxxx-xxxxxx-xxxx-xxxx-xxxxxx/providers/Microsoft.NetworkCloud/locations/EASTUS/operationStatuses/932a8fe6-12ef-419c-bdc2-5bb11a2a071d*C0123456789E735D5D572DECFF4EECE2DFDC121CC3FC56CD50069249183110F?api-version=2022-09-30-preview
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-manager.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ Some arguments that are available for every Azure CLI command
51
51
52
52
## Create a Cluster Manager
53
53
54
-
Use the `az network clustermanager create` command to create a Cluster Manager. This command creates a new Cluster Manager or updates the properties of the Cluster Manager if it exists. If you have multiple Azure subscriptions, select the appropriate subscription ID using the [az account set](/cli/azure/account#az-account-set) command.
54
+
Use the `az networkcloud clustermanager create` command to create a Cluster Manager. This command creates a new Cluster Manager or updates the properties of the Cluster Manager if it exists. If you have multiple Azure subscriptions, select the appropriate subscription ID using the [az account set](/cli/azure/account#az-account-set) command.
Copy file name to clipboardExpand all lines: articles/operator-nexus/howto-cluster-metrics-configuration-management.md
+55-70Lines changed: 55 additions & 70 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,115 +14,100 @@ ms.custom: template-how-to
14
14
When the user deploys a Cluster, a standard set of metrics are enabled for collection. For the list of metrics, see
15
15
[List of Metrics Collected](List-of-metrics-collected.md).
16
16
17
-
Users can't control the behavior (enable or disable) for collection of these included standard metrics. Though, users can control the collection of some optional metrics that aren't part of the link to the list. To enable this experience, users will have to create and update a MetricsConfiguration resource for a cluster. By default, creation of this MetricsConfiguration resource doesn't change the collection of metrics. User will have to update the resource to enable or disable these optional metrics collection.
17
+
Users can't control the behavior (enable or disable) for collection of these included standard metrics. Though, users can control the collection of some optional metrics that aren't part of the link to the list. To enable this experience, users have to create and update a MetricsConfiguration resource for a cluster. By default, creation of this MetricsConfiguration resource doesn't change the collection of metrics. User has to update the resource to enable or disable these optional metrics collection.
18
18
19
19
> [!NOTE]
20
20
> * For a cluster, at max, only one MetricsConfiguration resource can be created.
21
21
> * Users need to create a MetricsConfiguration resource to check a list of optional metrics that can be controlled.
22
-
> * Deletion of the MetricsConfiguration resource will result in the standard set of metrics being restored.
22
+
> * Deletion of the MetricsConfiguration resource results in the standard set of metrics being restored.
23
23
24
24
## How to manage cluster metrics configuration
25
25
26
-
To support the lifecycle of cluster metrics configurations, the following `az rest`interactions allow for the creation and management of a cluster's metrics configurations.
26
+
To support the lifecycle of cluster metrics configurations, the following interactions allow for the creation and management of a cluster's metrics configurations.
27
27
28
28
### Creating a metrics configuration
29
29
30
-
Use of the `az rest` command requires that the request input is defined, and then a `PUT` request is made to the `Microsoft.NetworkCloud` resource provider.
31
-
32
-
Define a file with the desired metrics configuration.
30
+
Use the `az network cluster metricsconfiguration create` command to create metrics configuration for cluster. If you have multiple Azure subscriptions, select the appropriate subscription ID using the [az account set](/cli/azure/account#az-account-set) command.
31
+
32
+
```azurecli
33
+
az networkcloud cluster metricsconfiguration create \
> * 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
+
> * There can be only one set of metrics configuration defined per cluster. The resource is created with the name `default`.
59
50
60
-
The following commands will create the metrics configuration. The only name allowed for the metricsConfiguration is `default`.
51
+
Specifying `--no-wait --debug` options in az cli command results in the execution of this command asynchronously. For more information, see [how to track asynchronous operations](howto-track-async-operations-cli.md).
61
52
62
-
```sh
63
-
export SUBSCRIPTION=<the subscription id for the cluster>
64
-
export RESOURCE_GROUP=<the resource group for the cluster>
65
-
export CLUSTER=<the cluter name>
53
+
### Metrics configuration elements
66
54
67
-
az rest -m put -u "https://management.azure.com/subscriptions/${SUBSCRIPTION}/resourceGroups/${RESOURCE_GROUP}/providers/Microsoft.NetworkCloud/clusters/${CLUSTER}/metricsConfigurations/default?api-version=2022-12-12-preview" -b @create_metrics_configuration.json --debug
| LOCATION | The Azure Region where the Cluster is 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 is enabled in addition to the default metrics |
67
+
| METRIC_TO_ENABLE_2 | Optional metric2 that is enabled in addition to the default metrics |
69
68
70
-
Specifying `--debug` in REST API 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).
69
+
Specifying `--no-wait --debug`options in az cli command results in the execution of this command asynchronously. For more information, see [how to track asynchronous operations](howto-track-async-operations-cli.md).
71
70
72
71
## Retrieving a metrics configuration
73
72
74
73
After a metrics configuration is created, it can be retrieved using a `az rest` command:
75
74
76
-
```sh
77
-
export SUBSCRIPTION=<the subscription id for the cluster>
78
-
export RESOURCE_GROUP=<the resource group for the cluster>
79
-
export CLUSTER=<the cluter name>
80
75
81
-
az rest -m get -u "https://management.azure.com/subscriptions/${SUBSCRIPTION}/resourceGroups/${RESOURCE_GROUP}/providers/Microsoft.NetworkCloud/clusters/${CLUSTER}/metricsConfigurations/default?api-version=2022-12-12-preview"
76
+
```azurecli
77
+
az networkcloud cluster metricsconfiguration show \
78
+
--cluster-name "<CLUSTER>" \
79
+
--resource-group "<RESOURCE_GROUP>"
82
80
```
83
81
84
-
This command will return a JSON representation of the metrics configuration.
82
+
This command returns a JSON representation of the metrics configuration.
85
83
86
84
## Updating a metrics configuration
87
85
88
-
Much like the creation of a metrics configuration, an update can be performed to change the configuration. A file, containing the metrics to be updated, is consumed as an input.
89
-
90
-
Example filename: update_metrics_configuration.json
86
+
Much like the creation of a metrics configuration, an update can be performed to change the configuration or update the tags assigned to the metrics configuration.
This file is used as input to an `az rest` command. 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.
105
98
106
-
```sh
107
-
export SUBSCRIPTION=<the subscription id for the cluster>
108
-
export RESOURCE_GROUP=<the resource group for the cluster>
109
-
export CLUSTER=<the cluter name>
110
-
111
-
az rest -m put -u "https://management.azure.com/subscriptions/${SUBSCRIPTION}/resourceGroups/${RESOURCE_GROUP}/providers/Microsoft.NetworkCloud/clusters/${CLUSTER}/metricsConfigurations/default?api-version=2022-12-12-preview" -b @update_metrics_configuration.json --debug
112
-
```
113
-
114
-
Specifying `--debug` in REST API 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).
99
+
Specifying `--no-wait --debug` options in az cli command results in the execution of this command asynchronously. For more information, see [how to track asynchronous operations](howto-track-async-operations-cli.md).
115
100
116
101
## Deleting a metrics configuration
117
102
118
-
Deletion of the metrics configuration will return the cluster to an unaltered configuration. To delete a metrics configuration, `az rest` API is used.
103
+
Deletion of the metrics configuration returns the cluster to an unaltered configuration. To delete a metrics configuration, use the below command:
119
104
120
-
```sh
121
-
export SUBSCRIPTION=<the subscription id for the cluster>
122
-
export RESOURCE_GROUP=<the resource group for the cluster>
123
-
export CLUSTER=<the cluter name>
124
-
125
-
az rest -m delete -u "https://management.azure.com/subscriptions/${SUBSCRIPTION}/resourceGroups/${RESOURCE_GROUP}/providers/Microsoft.NetworkCloud/clusters/${CLUSTER}/metricsConfigurations/default?api-version=2022-12-12-preview" --debug
105
+
```azurecli
106
+
az networkcloud cluster metricsconfiguration delete \
107
+
--cluster-name "<CLUSTER>" \
108
+
--resource-group "<RESOURCE_GROUP>"
126
109
```
127
110
128
-
Specifying `--debug` in REST API 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).
111
+
Specifying `--no-wait --debug` options in az cli command results in the execution of this command asynchronously. For more information, see [how to track asynchronous operations](howto-track-async-operations-cli.md).
0 commit comments