az networkcloud cluster
Note
This reference is part of the networkcloud extension for the Azure CLI (version 2.66.0 or higher). The extension will automatically install the first time you run an az networkcloud cluster command. Learn more about extensions.
Manage cluster.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az networkcloud cluster baremetalmachinekeyset |
Manage cluster's bare metal machine key set. |
Extension | GA |
| az networkcloud cluster baremetalmachinekeyset create |
Create a new bare metal machine key set or update the existing one for the provided cluster. |
Extension | GA |
| az networkcloud cluster baremetalmachinekeyset delete |
Delete the bare metal machine key set of the provided cluster. |
Extension | GA |
| az networkcloud cluster baremetalmachinekeyset list |
List bare metal machine key sets of the cluster. |
Extension | GA |
| az networkcloud cluster baremetalmachinekeyset show |
Get bare metal machine key set of the provided cluster. |
Extension | GA |
| az networkcloud cluster baremetalmachinekeyset update |
Update properties of bare metal machine key set for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently. |
Extension | GA |
| az networkcloud cluster baremetalmachinekeyset wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
| az networkcloud cluster bmckeyset |
Manage cluster's baseboard management controller key set. |
Extension | GA |
| az networkcloud cluster bmckeyset create |
Create a new baseboard management controller key set or update the existing one for the provided cluster. |
Extension | GA |
| az networkcloud cluster bmckeyset delete |
Delete the baseboard management controller key set of the provided cluster. |
Extension | GA |
| az networkcloud cluster bmckeyset list |
List baseboard management controller key sets of the cluster. |
Extension | GA |
| az networkcloud cluster bmckeyset show |
Get baseboard management controller key set of the provided cluster. |
Extension | GA |
| az networkcloud cluster bmckeyset update |
Update properties of baseboard management controller key set for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently. |
Extension | GA |
| az networkcloud cluster bmckeyset wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
| az networkcloud cluster continue-update-version |
Trigger the continuation of an update for a cluster with a matching update strategy that has paused after completing a segment of the update. |
Extension | GA |
| az networkcloud cluster create |
Create a new cluster or update the properties of the cluster if it exists. |
Extension | GA |
| az networkcloud cluster delete |
Delete the provided cluster. |
Extension | GA |
| az networkcloud cluster deploy |
Deploy the cluster. |
Extension | GA |
| az networkcloud cluster list |
List clusters in the provided resource group or subscription. |
Extension | GA |
| az networkcloud cluster metricsconfiguration |
Manage cluster's metrics configuration. |
Extension | GA |
| az networkcloud cluster metricsconfiguration create |
Create the metrics configuration of the provided cluster. |
Extension | GA |
| az networkcloud cluster metricsconfiguration delete |
Delete the metrics configuration of the provided cluster. |
Extension | GA |
| az networkcloud cluster metricsconfiguration list |
List metrics configurations of the cluster. |
Extension | GA |
| az networkcloud cluster metricsconfiguration show |
Get metrics configuration of the provided cluster. |
Extension | GA |
| az networkcloud cluster metricsconfiguration update |
Update properties of metrics configuration for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently. |
Extension | GA |
| az networkcloud cluster metricsconfiguration wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
| az networkcloud cluster scan-runtime |
Trigger the execution of a runtime protection scan to detect and remediate detected issues, in accordance with the cluster configuration. |
Extension | GA |
| az networkcloud cluster show |
Get properties of the provided cluster. |
Extension | GA |
| az networkcloud cluster update |
Update the properties of the provided cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently. |
Extension | GA |
| az networkcloud cluster update-version |
Update the version of the provided cluster to one of the available supported versions. |
Extension | GA |
| az networkcloud cluster wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az networkcloud cluster continue-update-version
Trigger the continuation of an update for a cluster with a matching update strategy that has paused after completing a segment of the update.
az networkcloud cluster continue-update-version [--cluster-name]
[--ids]
[--machine-group-targeting-mode {AlphaByRack}]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]Examples
Continue a paused update to the cluster version
az networkcloud cluster continue-update-version --name "clusterName" --resource-group "resourceGroupName" --machine-group-targeting-mode "AlphaByRack"Optional Parameters
The name of the cluster.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The mode by which the cluster will target the next grouping of servers to continue the update.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud cluster create
Create a new cluster or update the properties of the cluster if it exists.
az networkcloud cluster create --aggregator-or-single-rack-definition
--cluster-name
--cluster-type {MultiRack, SingleRack}
--cluster-version
--extended-location
--network-fabric-id
--resource-group
[--analytics-workspace-id]
[--cluster-location]
[--cluster-service-principal]
[--co-settings]
[--compute-deployment-threshold]
[--compute-rack-definitions]
[--location]
[--managed-resource-group-configuration]
[--mi-system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
[--mi-user-assigned]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--runtime-protection]
[--secret-archive]
[--tags]
[--update-strategy]Examples
Create or update single rack cluster
az networkcloud cluster create --name "clusterName" -g "resourceGroupName" --extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" type="CustomLocation" --location "eastus" --analytics-workspace-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName" --cluster-location "Foo Street, 3rd Floor, row 9" --cluster-service-principal application-id="12345678-1234-1234-1234-123456789012" password="password" principal-id="00000008-0004-0004-0004-000000000012" tenant-id="80000000-4000-4000-4000-120000000000" --cluster-type "SingleRack" --cluster-version "3.0.0" --compute-deployment-threshold type="PercentSuccess" grouping="PerCluster" value=90 --network-fabric-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default" --aggregator-or-single-rack-definition network-rack-id="/subscriptions/subscriptionId/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/cmName/subnets/ClusterManagerSubnet" rack-sku-id="/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/VLab_Single_DellR750_8C2M_x70r3_9" rack-serial-number=b99m99r1 rack-location='b99m99r1' availability-zone=1 storage-appliance-configuration-data="[{rackSlot:1,adminCredentials:{username:'adminuser',password:'password'},storageApplianceName:name,serialNumber:serial}]" bare-metal-machine-configuration-data="[{bmcCredentials:{password:'bmcPassword',username:'root'},bmcMacAddress:'AA:BB:CC:DD:E7:08',bootMacAddress:'AA:BB:CC:F8:71:2E',machineName:lab00r750wkr1,rackSlot:2,serialNumber:5HS7PK3},{bmcCredentials:{password:'bmcPassword',username:'root'},bmcMacAddress:'AA:BB:CC:FD:DC:76',bootMacAddress:'AA:BB:CC:F8:50:CA',machineName:lab00r750wkr8,rackSlot:11,serialNumber:9M56PK3}]" --tags key1="myvalue1" key2="myvalue2" --mi-user-assigned "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI" --command-output-settings identity-type="UserAssignedIdentity" user-assigned-identity-resource-id="" container-url="https://myaccount.blob.core.windows.net/mycontainer?restype=container"Create or update single rack cluster using json file input
az networkcloud cluster create --name "clusterName" -g "resourceGroupName" --extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" type="CustomLocation" --location "eastus" --analytics-workspace-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName" --cluster-location "Foo Street, 3rd Floor, row 9" --cluster-service-principal application-id="12345678-1234-1234-1234-123456789012" password="password" principal-id="00000008-0004-0004-0004-000000000012" tenant-id="80000000-4000-4000-4000-120000000000" --cluster-type "SingleRack" --cluster-version "3.0.0" --compute-deployment-threshold type="PercentSuccess" grouping="PerCluster" value=90 --network-fabric-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default" --aggregator-or-single-rack-definition ./aggregator-or-single-rack-definition.json --tags key1="myvalue1" key2="myvalue2Create or update single rack cluster with user assigned identity and command output settings
az networkcloud cluster create --name "clusterName" -g "resourceGroupName" --extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" type="CustomLocation" --location "eastus" --analytics-workspace-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName" --cluster-location "Foo Street, 3rd Floor, row 9" --cluster-service-principal application-id="12345678-1234-1234-1234-123456789012" password="password" principal-id="00000008-0004-0004-0004-000000000012" tenant-id="80000000-4000-4000-4000-120000000000" --cluster-type "SingleRack" --cluster-version "3.0.0" --compute-deployment-threshold type="PercentSuccess" grouping="PerCluster" value=90 --network-fabric-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default" --aggregator-or-single-rack-definition ./aggregator-or-single-rack-definition.json --tags key1="myvalue1" key2="myvalue2 --mi-user-assigned "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI" --command-output-settings identity-type="UserAssignedIdentity" identity-resource-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI" container-url="https://myaccount.blob.core.windows.net/mycontainer?restype=container"Required Parameters
The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The name of the cluster.
The type of rack configuration for the cluster.
The current runtime version of the cluster.
The extended location of the cluster manager associated with the cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The resource ID of the Network Fabric associated with the cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The resource ID of the Log Analytics Workspace that will be used for storing relevant logs.
The customer-provided location information to identify where the cluster resides.
The service principal to be used by the cluster during Arc Appliance installation. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The validation threshold indicating the allowable failures of compute machines during environment validation and deployment. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
The configuration of the managed resource group associated with the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Enable system assigned identity.
Space separated resource IDs to add user-assigned identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
The settings for cluster runtime protection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The configuration for use of a key vault to store secrets for later retrieval by the operator. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The strategy for updating the cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud cluster delete
Delete the provided cluster.
az networkcloud cluster delete [--cluster-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]Examples
Delete cluster
az networkcloud cluster delete --name "clusterName" --resource-group "resourceGroupName"Optional Parameters
The name of the cluster.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud cluster deploy
Deploy the cluster.
az networkcloud cluster deploy [--cluster-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--skip-validations-for-machines]
[--subscription]Examples
Deploy cluster
az networkcloud cluster deploy --name "clusterName" --resource-group "resourceGroupName"Deploy cluster skipping validation
az networkcloud cluster deploy --name "clusterName" --resource-group "resourceGroupName" --skip-validations-for-machines "bmmName1"Optional Parameters
The name of the cluster.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The names of bare metal machines in the cluster that should be skipped during environment validation. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud cluster list
List clusters in the provided resource group or subscription.
az networkcloud cluster list [--max-items]
[--next-token]
[--resource-group]Examples
List clusters for resource group
az networkcloud cluster list --resource-group "resourceGroupName"List clusters for subscription
az networkcloud cluster listOptional Parameters
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud cluster scan-runtime
Trigger the execution of a runtime protection scan to detect and remediate detected issues, in accordance with the cluster configuration.
az networkcloud cluster scan-runtime [--cluster-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--scan-activity {Scan, Skip}]
[--subscription]Examples
Execute a runtime protection scan on the cluster
az networkcloud cluster scan-runtime -n "clusterName" -g "resourceGroupName" --scan-activity "Scan"Optional Parameters
The name of the cluster.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The choice of if the scan operation should run the scan.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud cluster show
Get properties of the provided cluster.
az networkcloud cluster show [--cluster-name]
[--ids]
[--resource-group]
[--subscription]Examples
Get cluster
az networkcloud cluster show --name "clusterName" --resource-group "resourceGroupName"Optional Parameters
The name of the cluster.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud cluster update
Update the properties of the provided cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently.
az networkcloud cluster update [--aggregator-or-single-rack-definition]
[--cluster-location]
[--cluster-name]
[--cluster-service-principal]
[--co-settings]
[--compute-deployment-threshold]
[--compute-rack-definitions]
[--ids]
[--mi-system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
[--mi-user-assigned]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--runtime-protection]
[--secret-archive]
[--subscription]
[--tags]
[--update-strategy]Examples
Patch cluster location
az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --cluster-location "Foo Street, 3rd Floor, row 9" --tags key1="myvalue1" key2="myvalue2"Patch cluster aggregatorOrSingleRackDefinition
az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName --aggregator-or-single-rack-definition "{networkRackId:'/subscriptions/subscriptionId/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/cmName/subnets/ClusterManagerSubnet',rackSkuId:'/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/VLab_Single_DellR750_8C2M_x70r3_9',rackSerialNumber:b99m99r1,rackLocation:b99m99r1,availabilityZone:1,storageApplianceConfigurationData:[{rackSlot:1,adminCredentials:{username:'adminuser',password:'password'},storageApplianceName:name,serialNumber:serial}],bareMetalMachineConfigurationData:[{bmcCredentials:{password:'bmcPassword',username:'root'},bmcMacAddress:'AA:BB:CC:DD:E7:08',bootMacAddress:'AA:BB:CC:F8:71:2E',machineName:lab00r750wkr1,rackSlot:2,serialNumber:5HS7PK3},{bmcCredentials:{password:'bmcPassword',username:'root'},bmcMacAddress:'AA:BB:CC:FD:DC:76',bootMacAddress:'AA:BB:CC:F8:50:CA',machineName:lab00r750wkr8,rackSlot:11,serialNumber:9M56PK3}]}" --compute-deployment-threshold type="PercentSuccess" grouping="PerCluster" value=90 --tags key1="myvalue1" key2="myvalue2"Patch cluster aggregatorOrSingleRackDefinition using json file input
az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --aggregator-or-single-rack-definition ./aggregator-or-single-rack-definition.json --compute-deployment-threshold type="PercentSuccess" grouping="PerCluster" value=90 --tags key1="myvalue1" key2="myvalue2"Patch cluster runtime protection configuration
az az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --runtime-protection enforcement-level="OnDemand"Patch secret archive
az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --secret-archive use-key-vault=True key-vault-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName"Patch update strategy
az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --update-strategy strategy-type="Rack" threshold-type="CountSuccess" threshold-value=4 max-unavailable=4 wait-time-minutes=10Add user assigned identity and command output settings to cluster
az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --mi-user-assigned "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI" --command-output-settings identity-type="UserAssignedIdentity" identity-resource-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI" container-url="https://myaccount.blob.core.windows.net/mycontainer?restype=container"Add system assigned identity to cluster
az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --mi-system-assignedOptional Parameters
The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The customer-provided location information to identify where the cluster resides.
The name of the cluster.
The service principal to be used by the cluster during Arc Appliance installation. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The validation threshold indicating the allowable failures of compute machines during environment validation and deployment. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Enable system assigned identity.
Space separated resource IDs to add user-assigned identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The settings for cluster runtime protection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The configuration for use of a key vault to store secrets for later retrieval by the operator. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The Azure resource tags that will replace the existing ones. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The strategy for updating the cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud cluster update-version
Update the version of the provided cluster to one of the available supported versions.
az networkcloud cluster update-version --target-cluster-version
[--cluster-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]Examples
Update cluster version
az networkcloud cluster update-version --cluster-name "clusterName" --target-cluster-version "2.0" --resource-group "resourceGroupName"Required Parameters
The version to be applied to the cluster during update.
Optional Parameters
The name of the cluster.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud cluster wait
Place the CLI in a waiting state until a condition is met.
az networkcloud cluster wait [--cluster-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
The name of the cluster.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
