Host System Shutdown Host Task

Host System Shutdown Host Task

Shuts down a host.

If the command is successful, then the host has been shut down. Thus, the client never receives an indicator of success in the returned task if connected directly to the host.

This command is not supported on all hosts. Check the host capability shutdownSupported.

Required privileges: Host.Config.Maintenance

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostSystem/{moId}/ShutdownHost_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 HostSystem/{moId}.

string
release
Required

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


Request Body
ShutdownHostRequestType of type(s) application/json
Required
{
    "force": false
}
boolean
force
Required

Flag to specify whether or not the host should be shut down regardless of whether it is in maintenance mode. If true, the host is shut down, even if there are virtual machines running or other operations in progress.

Authentication
This operation uses the following authentication methods.
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

InvalidState: if "force" is false and the host is not in maintenance mode.

NotSupported: if the host does not support shutdown.

Returns InvalidState of type(s) application/json
This response body class contains all of the following: VimFault
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

Virtual Infrastructure Operations
POST
Host System Acquire Cim Services Ticket
POST
Host System Configure Crypto Key
POST
Host System Destroy Task
POST
Host System Disconnect Host Task
POST
Host System Enable Crypto
POST
Host System Enter Lockdown Mode
POST
Host System Enter Maintenance Mode Task
POST
Host System Exit Lockdown Mode
POST
Host System Exit Maintenance Mode Task
GET
Host System Get Alarm Actions Enabled
GET
Host System Get Answer File Validation Result
GET
Host System Get Answer File Validation State
GET
Host System Get Available Field
GET
Host System Get Capability
GET
Host System Get Compliance Check Result
GET
Host System Get Compliance Check State
GET
Host System Get Config
GET
Host System Get Config Issue
GET
Host System Get Config Manager
GET
Host System Get Config Status
GET
Host System Get Custom Value
GET
Host System Get Datastore
GET
Host System Get Datastore Browser
GET
Host System Get Declared Alarm State
GET
Host System Get Disabled Method
GET
Host System Get Effective Role
GET
Host System Get Hardware
GET
Host System Get Licensable Resource
GET
Host System Get Name
GET
Host System Get Network
GET
Host System Get Overall Status
GET
Host System Get Parent
GET
Host System Get Permission
GET
Host System Get Precheck Remediation Result
GET
Host System Get Recent Task
GET
Host System Get Remediation Result
GET
Host System Get Remediation State
GET
Host System Get Runtime
GET
Host System Get Summary
GET
Host System Get System Resources
GET
Host System Get Tag
GET
Host System Get Triggered Alarm State
GET
Host System Get Value
GET
Host System Get Vm
POST
Host System Power Down Host To Stand By Task
POST
Host System Power Up Host From Stand By Task
POST
Host System Prepare Crypto
POST
Host System Query Host Connection Info
POST
Host System Query Memory Overhead
POST
Host System Query Memory Overhead Ex
POST
Host System Query Product Locker Location
POST
Host System Query Tpm Attestation Report
POST
Host System Reboot Host Task
POST
Host System Reconfigure Host For DAS Task
POST
Host System Reconnect Host Task
POST
Host System Reload
POST
Host System Rename Task
POST
Host System Retrieve Free Epc Memory
POST
Host System Retrieve Hardware Uptime
POST
Host System Set Custom Value
POST
Host System Shutdown Host Task
POST
Host System Update Flags
POST
Host System Update Ipmi
POST
Host System Update Product Locker Location Task
POST
Host System Update System Resources
POST
Host System Update System Swap Configuration