az aro hcp cluster nodepool

  • Preview

Note

This reference is part of the aro extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az aro hcp cluster nodepool command. Learn more about extensions.

Command group 'aro' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Azure Red Hat OpenShift with hosted control plane node pools.

Commands

Name Description Type Status
az aro hcp cluster nodepool create

Create an Azure Red Hat OpenShift with hosted control plane node pool.

 Extension Preview
az aro hcp cluster nodepool delete

Delete an Azure Red Hat OpenShift with hosted control plane node pool.

 Extension Preview
az aro hcp cluster nodepool list

List Azure Red Hat OpenShift with hosted control plane node pools.

 Extension Preview
az aro hcp cluster nodepool show

Get an Azure Red Hat OpenShift with hosted control plane node pool.

 Extension Preview
az aro hcp cluster nodepool update

Update an Azure Red Hat OpenShift with hosted control plane node pool.

 Extension Preview
az aro hcp cluster nodepool wait

Place the CLI in a waiting state until a condition is met.

 Extension Preview

az aro hcp cluster nodepool create

Preview

Command group 'aro' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create an Azure Red Hat OpenShift with hosted control plane node pool.

az aro hcp cluster nodepool create --cluster-name
                                   --name
                                   --resource-group
                                   [--acquire-policy-token]
                                   [--auto-repair {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--availability-zone]
                                   [--change-reference]
                                   [--channel-group]
                                   [--disk-encryption-set]
                                   [--disk-size]
                                   [--disk-storage-account-type --disk-storage-type {Premium_LRS, StandardSSD_LRS, Standard_LRS}]
                                   [--disk-type {Ephemeral, Managed}]
                                   [--encryption-at-host {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--labels]
                                   [--location]
                                   [--max-replicas]
                                   [--min-replicas]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--node-drain-timeout]
                                   [--replicas]
                                   [--subnet-id]
                                   [--tags]
                                   [--taints]
                                   [--version]
                                   [--vm-size]

Examples

Create a node pool

az aro hcp cluster nodepool create --resource-group MyResourceGroup --cluster-name MyCluster --name MyNodePool --location eastus --replicas 3 --vm-size Standard_D8s_v3 --version 4.19.0 --channel-group stable

Create an autoscaling node pool with labels, taints and disk config

az aro hcp cluster nodepool create --resource-group MyResourceGroup --cluster-name MyCluster --name MyNodePool --location eastus --vm-size Standard_D8s_v3 --version 4.19.0 --channel-group stable --min-replicas 1 --max-replicas 5 --disk-size 128 --disk-storage-account-type Premium_LRS --auto-repair true --labels "[{key:tier,value:frontend}]" --taints "[{key:dedicated,value:gpu,effect:NoSchedule}]"

Required Parameters

--cluster-name -c

The name of the Azure Red Hat OpenShift with hosted control plane cluster.

--name -n

The Name of the Node Pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--auto-repair

Auto-repair.

Property Value
Parameter group: Properties Arguments
Default value: True
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--availability-zone

The availability zone for the node pool.

Property Value
Parameter group: Platform Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--channel-group

ChannelGroup is the name of the set to which this version belongs. Each version belongs to only a single set. If not specified, the default value is 'stable'.

Property Value
Parameter group: Version Arguments
--disk-encryption-set

The ID of the DiskEncryptionSet resource to use to encrypt the OS disks for the VMs. This needs to exist in the same subscription id listed in the Hosted Cluster, HostedCluster.Spec.Platform.Azure.SubscriptionID. DiskEncryptionSetID should also exist in a resource group under the same subscription id and the same location listed in the Hosted Cluster, HostedCluster.Spec.Platform.Azure.Location. Details on how to create a Disk Encryption Set can be found here: https://learn.microsoft.com/en-us/azure/virtual-machines/disks-enable-customer-managed-keys-portal#set-up-your-disk-encryption-set.

Property Value
Parameter group: OS Disk Arguments
--disk-size

The OS disk size in GiB. Maximum is 4095 GiB for Managed disks. For Ephemeral disks, the maximum is 2040 GiB; Azure may enforce a lower effective limit based on the selected VM size's local cache, temp, or NVMe capacity.

Property Value
Parameter group: OS Disk Arguments
Default value: 64
--disk-storage-account-type --disk-storage-type

The type of the disk storage account - https://learn.microsoft.com/en-us/azure/virtual-machines/disks-types.

Property Value
Parameter group: OS Disk Arguments
Default value: Premium_LRS
Accepted values: Premium_LRS, StandardSSD_LRS, Standard_LRS
--disk-type

The type of the OS disk. - https://learn.microsoft.com/en-us/azure/virtual-machines/ephemeral-os-disks.

Property Value
Parameter group: OS Disk Arguments
Default value: Managed
Accepted values: Ephemeral, Managed
--encryption-at-host

Whether to enable host based OS and data drive encryption. - https://learn.microsoft.com/en-us/azure/virtual-machines/disk-encryption#encryption-at-host---end-to-end-encryption-for-your-vm-data.

Property Value
Parameter group: Platform Arguments
Default value: False
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--labels

Kubernetes labels to propagate to the NodePool Nodes. Note that when the labels are updated this is only applied to newly create nodes in the NodePool, existing node labels remain unchanged. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property Value
Parameter group: Resource Arguments
--max-replicas

The maximum number of nodes in the node pool. Validation: - Minimum: 0 (must be >= min) - Maximum: 200 (only when availabilityZone is not specified) - No maximum when availabilityZone is specified.

Property Value
Parameter group: Autoscaling Arguments
--min-replicas

The minimum number of nodes in the node pool. Validation: - Minimum: 0 - Maximum: 200 (only when availabilityZone is not specified) - No maximum when availabilityZone is specified.

Property Value
Parameter group: Autoscaling Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--node-drain-timeout

NodeDrainTimeoutMinutes is the grace period for how long Pod Disruption Budget-protected workloads will be respected during any node draining operation. After this grace period, any workloads protected by Pod Disruption Budgets that have not been successfully drained from a node will be forcibly evicted. This is especially relevant to cluster upgrades. Valid values are from 0 to 10080 minutes (1 week) . 0 means that the NodePool can be drained without any time limitation. If unset the cluster nodeDrainTimeoutMinutes value is used as a default.

Property Value
Parameter group: Properties Arguments
--replicas

The number of worker nodes, it cannot be used together with autoscaling. Validation: - Minimum: 0 - Maximum: 200 (only when availabilityZone is not specified) - No maximum when availabilityZone is specified.

Property Value
Parameter group: Properties Arguments
--subnet-id

The Azure resource ID of the worker subnet. Note that a subnet cannot be reused between ARO-HCP Clusters.

Property Value
Parameter group: Platform Arguments
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Resource Arguments
--taints

Taints for the nodes. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--version

ID is the desired X.Y version of the cluster control plane.

Property Value
Parameter group: Version Arguments
--vm-size

The VM size according to the documentation: - https://learn.microsoft.com/en-us/azure/virtual-machines/sizes.

Property Value
Parameter group: Platform Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az aro hcp cluster nodepool delete

Preview

Command group 'aro' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete an Azure Red Hat OpenShift with hosted control plane node pool.

az aro hcp cluster nodepool delete [--acquire-policy-token]
                                   [--change-reference]
                                   [--cluster-name]
                                   [--ids]
                                   [--name]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--resource-group]
                                   [--subscription]
                                   [--yes]

Examples

Delete a node pool

az aro hcp cluster nodepool delete --resource-group MyResourceGroup --cluster-name MyCluster --name MyNodePool --yes

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--cluster-name -c

The name of the Azure Red Hat OpenShift with hosted control plane cluster.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--name -n

The Name of the Node Pool.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az aro hcp cluster nodepool list

Preview

Command group 'aro' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List Azure Red Hat OpenShift with hosted control plane node pools.

az aro hcp cluster nodepool list --cluster-name
                                 --resource-group
                                 [--max-items]
                                 [--next-token]

Examples

List node pools of a cluster

az aro hcp cluster nodepool list --resource-group MyResourceGroup --cluster-name MyCluster

Required Parameters

--cluster-name -c

The name of the Azure Red Hat OpenShift with hosted control plane cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

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.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az aro hcp cluster nodepool show

Preview

Command group 'aro' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get an Azure Red Hat OpenShift with hosted control plane node pool.

az aro hcp cluster nodepool show [--cluster-name]
                                 [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]

Examples

Show a node pool

az aro hcp cluster nodepool show --resource-group MyResourceGroup --cluster-name MyCluster --name MyNodePool

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name -c

The name of the Azure Red Hat OpenShift with hosted control plane cluster.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--name -n

The Name of the Node Pool.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az aro hcp cluster nodepool update

Preview

Command group 'aro' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update an Azure Red Hat OpenShift with hosted control plane node pool.

az aro hcp cluster nodepool update [--acquire-policy-token]
                                   [--add]
                                   [--change-reference]
                                   [--channel-group]
                                   [--cluster-name]
                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--ids]
                                   [--labels]
                                   [--max-replicas]
                                   [--min-replicas]
                                   [--name]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--node-drain-timeout]
                                   [--remove]
                                   [--replicas]
                                   [--resource-group]
                                   [--set]
                                   [--subscription]
                                   [--tags]
                                   [--taints]
                                   [--version]

Examples

Scale a node pool

az aro hcp cluster nodepool update --resource-group MyResourceGroup --cluster-name MyCluster --name MyNodePool --replicas 5

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property Value
Parameter group: Generic Update Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--channel-group

ChannelGroup is the name of the set to which this version belongs. Each version belongs to only a single set. If not specified, the default value is 'stable'.

Property Value
Parameter group: Version Arguments
--cluster-name -c

The name of the Azure Red Hat OpenShift with hosted control plane cluster.

Property Value
Parameter group: Resource Id Arguments
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--labels

Kubernetes labels to propagate to the NodePool Nodes. Note that when the labels are updated this is only applied to newly create nodes in the NodePool, existing node labels remain unchanged. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--max-replicas

The maximum number of nodes in the node pool. Validation: - Minimum: 0 (must be >= min) - Maximum: 200 (only when availabilityZone is not specified) - No maximum when availabilityZone is specified.

Property Value
Parameter group: Autoscaling Arguments
--min-replicas

The minimum number of nodes in the node pool. Validation: - Minimum: 0 - Maximum: 200 (only when availabilityZone is not specified) - No maximum when availabilityZone is specified.

Property Value
Parameter group: Autoscaling Arguments
--name -n

The Name of the Node Pool.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--node-drain-timeout

NodeDrainTimeoutMinutes is the grace period for how long Pod Disruption Budget-protected workloads will be respected during any node draining operation. After this grace period, any workloads protected by Pod Disruption Budgets that have not been successfully drained from a node will be forcibly evicted. This is especially relevant to cluster upgrades. Valid values are from 0 to 10080 minutes (1 week) . 0 means that the NodePool can be drained without any time limitation. If unset the cluster nodeDrainTimeoutMinutes value is used as a default.

Property Value
Parameter group: Properties Arguments
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
--replicas

The number of worker nodes, it cannot be used together with autoscaling. Validation: - Minimum: 0 - Maximum: 200 (only when availabilityZone is not specified) - No maximum when availabilityZone is specified.

Property Value
Parameter group: Properties Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Resource Arguments
--taints

Taints for the nodes. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--version

ID is the desired X.Y version of the cluster control plane.

Property Value
Parameter group: Version Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az aro hcp cluster nodepool wait

Preview

Command group 'aro' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Place the CLI in a waiting state until a condition is met.

az aro hcp cluster nodepool wait [--acquire-policy-token]
                                 [--change-reference]
                                 [--cluster-name]
                                 [--created]
                                 [--custom]
                                 [--deleted]
                                 [--exists]
                                 [--ids]
                                 [--interval]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]
                                 [--timeout]
                                 [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--cluster-name -c

The name of the Azure Red Hat OpenShift with hosted control plane cluster.

Property Value
Parameter group: Resource Id Arguments
--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name -n

The Name of the Node Pool.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False