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 +76,48 @@ These commands to not require `arguments`:
75
76
-`ss`
76
77
-`ulimit -a`
77
78
78
-
All other inputs are required. Multiple commands are each specified with their own `--commands` option.
79
+
All other inputs are required.
79
80
80
-
Each `--commands` option specifies `command` and `arguments`. For a command with multiple arguments, `arguments` is repeated for each one.
81
+
Multiple commands can be provided in json format to `--commands` option. Each `command` specifies command and the arguments.
81
82
82
-
`--debug` is required to get the operation status that can be queried to get the URL for the output file.
83
+
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
+
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.
86
+
87
+
This command runs synchronously. If you wish to skip waiting for the command to complete, specify the `--no-wait` option.
83
88
84
89
### This example executes the `hostname` command and a `ping` command.
85
90
86
91
```azurecli
87
92
az networkcloud baremetalmachine run-read-command --name "bareMetalMachineName" \
Check the status of the operation with the `az rest` command:
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`.
107
105
108
106
```azurecli
109
-
az rest --method get --url <Azure-AsyncOperation-URL>
110
-
```
107
+
====Action Command Output====
108
+
+ hostname
109
+
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
112
112
-
Repeat until the response to the URL displays the result of the run-read-command.
113
+
--- 192.168.0.99 ping statistics ---
114
+
3 packets transmitted, 0 received, 100% packet loss, time 2049ms
113
115
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
116
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
117
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
+50-68Lines changed: 50 additions & 68 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,106 +23,88 @@ Users can't control the behavior (enable or disable) for collection of these inc
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`.
61
-
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>
66
51
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
68
-
```
69
-
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).
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).
71
53
72
54
## Retrieving a metrics configuration
73
55
74
56
After a metrics configuration is created, it can be retrieved using a `az rest` command:
75
57
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
58
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"
59
+
```azurecli
60
+
az networkcloud cluster metricsconfiguration show \
61
+
--cluster-name "<CLUSTER>" \
62
+
--resource-group "<RESOURCE_GROUP>"
82
63
```
83
64
84
65
This command will return a JSON representation of the metrics configuration.
85
66
86
67
## Updating a metrics configuration
87
68
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.
69
+
Much like the creation of a metrics configuration, an update can be performed to change the configuration.
89
70
90
-
Example filename: update_metrics_configuration.json
71
+
This command is used to patch properties of the provided metrics configuration of cluster, 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.
105
-
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>
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.
110
83
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).
84
+
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).
115
85
116
86
## Deleting a metrics configuration
117
87
118
-
Deletion of the metrics configuration will return the cluster to an unaltered configuration. To delete a metrics configuration, `az rest` API is used.
119
-
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>
88
+
Deletion of the metrics configuration will return the cluster to an unaltered configuration. To delete a metrics configuration, use the below command:
124
89
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
90
+
```azurecli
91
+
az networkcloud cluster metricsconfiguration delete \
92
+
--cluster-name "<CLUSTER>" \
93
+
--resource-group "<RESOURCE_GROUP>"
126
94
```
127
95
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).
96
+
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