az vmware placement-policy vm

Note

This reference is part of the vmware extension for the Azure CLI (version 2.11.0 or higher). The extension will automatically install the first time you run an az vmware placement-policy vm command. Learn more about extensions.

Commands to manage VM placement policies.

Commands

az vmware placement-policy vm create	Create a VM placement policy in a private cloud cluster.
az vmware placement-policy vm delete	Delete a VM placement policy in a private cloud cluster.
az vmware placement-policy vm update	Update a VM placement policy in a private cloud cluster.

az vmware placement-policy vm create

Create a VM placement policy in a private cloud cluster.

az vmware placement-policy vm create --affinity-type {Affinity, AntiAffinity}
                                     --cluster-name
                                     --placement-policy-name
                                     --private-cloud
                                     --resource-group
                                     --vm-members
                                     [--display-name]
                                     [--state {Disabled, Enabled}]

Examples

Create a VM placement policy.

az vmware placement-policy vm create --resource-group group1 --private-cloud cloud1 --cluster-name cluster1 --placement-policy-name policy1 --state Enabled --display-name policy1 --vm-members /subscriptions/subId/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1/virtualMachines/vm-128 /subscriptions/subId/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1/virtualMachines/vm-256 --affinity-type AntiAffinity

Required Parameters

--affinity-type

Placement policy affinity type.

accepted values: Affinity, AntiAffinity

--cluster-name

Name of the cluster in the private cloud.

--placement-policy-name

Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy.

--private-cloud -c

Name of the private cloud.

--resource-group -g

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

--vm-members

Virtual machine members list.

Optional Parameters

--display-name

Display name of the placement policy.

--state

Whether the placement policy is enabled or disabled.

accepted values: Disabled, Enabled

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--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.

az vmware placement-policy vm delete

Delete a VM placement policy in a private cloud cluster.

az vmware placement-policy vm delete --cluster-name
                                     --placement-policy-name
                                     --private-cloud
                                     --resource-group
                                     [--yes]

Examples

Delete a VM placement policy.

az vmware placement-policy vm delete --resource-group group1 --private-cloud cloud1 --cluster-name cluster1 --placement-policy-name policy1

Required Parameters

--cluster-name

Name of the cluster in the private cloud.

--placement-policy-name

Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy.

--private-cloud -c

Name of the private cloud.

--resource-group -g

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

Optional Parameters

--yes

Delete without confirmation.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--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.

az vmware placement-policy vm update

Update a VM placement policy in a private cloud cluster.

az vmware placement-policy vm update --cluster-name
                                     --placement-policy-name
                                     --private-cloud
                                     --resource-group
                                     [--affinity-strength {Must, Should}]
                                     [--azure-hybrid-benefit {None, SqlHost}]
                                     [--host-members]
                                     [--state {Disabled, Enabled}]
                                     [--vm-members]

Examples

Update a VM placement policy.

az vmware placement-policy vm update --resource-group group1 --private-cloud cloud1 --cluster-name cluster1 --placement-policy-name policy1 --state Enabled --vm-members /subscriptions/subId/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1/virtualMachines/vm-128 /subscriptions/subId/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1/virtualMachines/vm-256

Required Parameters

--cluster-name

Name of the cluster in the private cloud.

--placement-policy-name

Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy.

--private-cloud -c

Name of the private cloud.

--resource-group -g

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

Optional Parameters

--affinity-strength

VM host placement policy affinity strength (should/must).

accepted values: Must, Should

--azure-hybrid-benefit

Placement policy azure hybrid benefit opt-in type.

accepted values: None, SqlHost

--host-members

Host members list.

--state

Whether the placement policy is enabled or disabled.

accepted values: Disabled, Enabled

--vm-members

Virtual machine members list.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--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.