Share via

az scvmm vmmserver

Note

This reference is part of the scvmm extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az scvmm vmmserver command. Learn more about extensions.

Manage Arc for SCVMM VMMServer resources.

Commands

Name Description Type Status
az scvmm vmmserver connect

Create a vmmserver resource.

 Extension GA
az scvmm vmmserver delete

Delete a vmmserver resource.

 Extension GA
az scvmm vmmserver inventory-item

Inventory item resource.

 Extension GA
az scvmm vmmserver inventory-item list

Retrieve a list of inventory items present in a vmmserver.

 Extension GA
az scvmm vmmserver inventory-item show

Get details of an inventory item present in a vmmserver.

 Extension GA
az scvmm vmmserver list

Retrieve a list of vmmservers.

 Extension GA
az scvmm vmmserver show

Get details of a vmmserver.

 Extension GA
az scvmm vmmserver update

Update vmmserver resource.

 Extension GA
az scvmm vmmserver wait

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

 Extension GA

az scvmm vmmserver connect

Create a vmmserver resource.

az scvmm vmmserver connect --custom-___location
                           --___location
                           [--fqdn]
                           [--ids]
                           [--name]
                           [--no-wait]
                           [--password]
                           [--port]
                           [--resource-group]
                           [--subscription]
                           [--tags]
                           [--username]

Examples

Connect to a vmmserver

az scvmm vmmserver connect --subscription contoso-sub --resource-group contoso-rg --___location eastus --custom-___location contoso-cl --name contoso-vmmserver --fqdn vmm.contoso.com --port 8100 --username contoso-user --password contoso-password

Required Parameters

--custom-___location

Name or ID of the custom ___location that will manage this resource.

--___location -l

Location. Values from: az account list-locations. You can configure the default ___location using az configure --defaults ___location=<___location>.

Optional Parameters

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

--fqdn

FQDN/IP address of the vmmserver.

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

Name of the resource.

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

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

Property Value
Default value: False
--password

Username password credentials to use for connecting to the vmmserver.

--port

The port of the vmmserver.

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

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--username

Username to use for connecting to the vmmserver.

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 scvmm vmmserver delete

Delete a vmmserver resource.

az scvmm vmmserver delete [--force]
                          [--ids]
                          [--name]
                          [--no-wait]
                          [--resource-group]
                          [--subscription]

Examples

Delete a vmmserver resource by Name

az scvmm vmmserver delete --name contoso-vmmserver --resource-group contoso-rg --subscription contoso-sub

Delete a vmmserver resource by ARM ID

az scvmm vmmserver delete --ids /subscriptions/01234567-0123-0123-0123-0123456789ab/resourceGroups/contoso-rg/providers/Microsoft.ScVmm/vmmServers/contoso-vmmserver

Optional Parameters

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

--force

Force the resource to be deleted from azure.

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

Name of the resource.

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

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

Property Value
Default value: False
--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 scvmm vmmserver list

Retrieve a list of vmmservers.

az scvmm vmmserver list [--resource-group]

Examples

Retrieve a list of vmmservers present in a resource group

az scvmm vmmserver list --subscription contoso-sub --resource-group contoso-rg

Retrieve a list of vmmservers present in a subscription

az scvmm vmmserver list --subscription contoso-sub

Optional Parameters

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

--resource-group -g

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

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 scvmm vmmserver show

Get details of a vmmserver.

az scvmm vmmserver show [--ids]
                        [--name]
                        [--resource-group]
                        [--subscription]

Examples

Get details of a vmmserver by ARM ID

az scvmm vmmserver show --ids /subscriptions/01234567-0123-0123-0123-0123456789ab/resourceGroups/contoso-rg/providers/Microsoft.ScVmm/vmmServers/contoso-vmmserver

Get details of a vmmserver by name

az scvmm vmmserver show --subscription contoso-sub --resource-group contoso-rg --name contoso-vmmserver

Optional Parameters

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

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

Name of the resource.

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 scvmm vmmserver update

Update vmmserver resource.

az scvmm vmmserver update [--ids]
                          [--name]
                          [--no-wait]
                          [--resource-group]
                          [--subscription]
                          [--tags]

Examples

Update a vmmserver by ARM ID

az scvmm vmmserver update --ids /subscriptions/01234567-0123-0123-0123-0123456789ab/resourceGroups/contoso-rg/providers/Microsoft.ScVmm/vmmservers/contoso-vmmserver --tags department=Sales

Update a vmmserver by name

az scvmm vmmserver update --subscription contoso-sub --resource-group contoso-rg --name contoso-vmmserver --tags department=Sales

Optional Parameters

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

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

Name of the resource.

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

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

Property Value
Default value: False
--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
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 scvmm vmmserver wait

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

az scvmm vmmserver wait --resource-group
                        --vmm-server-name
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--timeout]
                        [--updated]

Required Parameters

--resource-group -g

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

--vmm-server-name

Name of the VmmServer.

Optional Parameters

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

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

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--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.

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