Virtual Machine Disable Secondary VM Task

Virtual Machine Disable Secondary VM Task

Disables the specified secondary virtual machine in this fault tolerant group.

The specified secondary will not be automatically started on a subsequent power-on of the primary virtual machine. This operation could leave the primary virtual machine in a non-fault tolerant state.

Required privileges: VirtualMachine.Interact.DisableSecondary

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/VirtualMachine/{moId}/DisableSecondaryVM_Task

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case VirtualMachine/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Request Body

DisableSecondaryVMRequestType of type(s) application/json

Required

{
    "vm": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}

MoRefVirtualMachine

vm

Required

Reference to an instance of the VirtualMachine managed object.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

This method returns a Task object with which to monitor the operation.

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

VmFaultToleranceIssue: if any error is encountered with the fault tolerance configuration of the virtual machine. Typically, a more specific fault like InvalidOperationOnSecondaryVm is thrown.

TaskInProgress: if the virtual machine is busy.

InvalidState: if the host is in maintenance mode or if the virtual machine's configuration information is not available.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Request

Path Parameters

200 Response Body

Errors

Virtual Machine Operations

Virtual Machine Acquire Mks Ticket

Virtual Machine Acquire Ticket

Virtual Machine Answer VM

Virtual Machine Apply Evc Mode VM Task

Virtual Machine Attach Disk Task

Virtual Machine Check Customization Spec

Virtual Machine Clone VM Task

Virtual Machine Consolidate VM Disks Task

Virtual Machine Create Screenshot Task

Virtual Machine Create Secondary VM Task

Virtual Machine Create Secondary VM Ex Task

Virtual Machine Create Snapshot Task

Virtual Machine Create Snapshot Ex Task

Virtual Machine Crypto Unlock Task

Virtual Machine Customize VM Task

Virtual Machine Defragment All Disks

Virtual Machine Destroy Task

Virtual Machine Detach Disk Task

Virtual Machine Disable Secondary VM Task

Virtual Machine Drop Connections

Virtual Machine Enable Secondary VM Task

Virtual Machine Estimate Storage For Consolidate Snapshots Task

Virtual Machine Export Vm

Virtual Machine Extract Ovf Environment

Virtual Machine Get Alarm Actions Enabled

Virtual Machine Get Available Field

Virtual Machine Get Capability

Virtual Machine Get Config

Virtual Machine Get Config Issue

Virtual Machine Get Config Status

Virtual Machine Get Custom Value

Virtual Machine Get Datastore

Virtual Machine Get Declared Alarm State

Virtual Machine Get Disabled Method

Virtual Machine Get Effective Role

Virtual Machine Get Environment Browser

Virtual Machine Get Guest

Virtual Machine Get Guest Heartbeat Status

Virtual Machine Get Layout

Virtual Machine Get Layout Ex

Virtual Machine Get Name

Virtual Machine Get Network

Virtual Machine Get Overall Status

Virtual Machine Get Parent

Virtual Machine Get Parent V App

Virtual Machine Get Permission

Virtual Machine Get Recent Task

Virtual Machine Get Resource Config

Virtual Machine Get Resource Pool

Virtual Machine Get Root Snapshot

Virtual Machine Get Runtime

Virtual Machine Get Snapshot

Virtual Machine Get Storage

Virtual Machine Get Summary

Virtual Machine Get Tag

Virtual Machine Get Triggered Alarm State

Virtual Machine Get Value

Virtual Machine Instant Clone Task

Virtual Machine Make Primary VM Task

Virtual Machine Mark As Template

Virtual Machine Mark As Virtual Machine

Virtual Machine Migrate VM Task

Virtual Machine Mount Tools Installer

Virtual Machine Power Off VM Task

Virtual Machine Power On VM Task

Virtual Machine Promote Disks Task

Virtual Machine Put Usb Scan Codes

Virtual Machine Query Changed Disk Areas

Virtual Machine Query Connections

Virtual Machine Query Fault Tolerance Compatibility

Virtual Machine Query Fault Tolerance Compatibility Ex

Virtual Machine Query Unowned Files

Virtual Machine Reboot Guest

Virtual Machine Reconfig VM Task

Virtual Machine Refresh Storage Info

Virtual Machine Reload

Virtual Machine Reload Virtual Machine From Path Task

Virtual Machine Relocate VM Task

Virtual Machine Remove All Snapshots Task

Virtual Machine Rename Task

Virtual Machine Reset Guest Information

Virtual Machine Reset VM Task

Virtual Machine Revert To Current Snapshot Task

Virtual Machine Send NMI

Virtual Machine Set Custom Value

Virtual Machine Set Display Topology

Virtual Machine Set Screen Resolution

Virtual Machine Shutdown Guest

Virtual Machine Standby Guest

Virtual Machine Start Recording Task

Virtual Machine Start Replaying Task

Virtual Machine Stop Recording Task

Virtual Machine Stop Replaying Task

Virtual Machine Suspend VM Task

Virtual Machine Terminate Fault Tolerant VM Task

Virtual Machine Terminate VM

Virtual Machine Turn Off Fault Tolerance For VM Task

Virtual Machine Unmount Tools Installer

Virtual Machine Unregister VM

Virtual Machine Upgrade Tools Task

Virtual Machine Upgrade VM Task