Host Service System Stop Service

Stops the service.

Required privileges: Host.Config.NetService

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostServiceSystem/{moId}/StopService

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 HostServiceSystem/{moId}.

string

release

Required

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

Request Body

StopServiceRequestType of type(s) application/json

Required

{
    "id": "string"
}

string

Required

Service identifier (HostServiceSystem.serviceInfo.HostServiceInfo.service.HostService.key).

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

NotFound: if the service ID is unknown.

InvalidState: if the service is not running. Only hosts with ESX/ESXi 4.1 or earlier software use this fault. Hosts running later versions of ESXi do not throw a fault in this case.

HostConfigFault: for all other failures.

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

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Virtual Infrastructure Operations

GET

Host Service System Get Available Field