This API has a deprecated equivalent from v7.0U1.
Update Service
Updates the properties of a service.
Request
URLURL
https://{api_host}/api/vcenter/services/{service}
Path Parameters
Path Parameters
string
service
Required
identifier of the service whose properties are being updated. The parameter must be an identifier for the resource type: com.vmware.vcenter.services.Service.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
{
"startup_type": "MANUAL"
}
startup_type
Optional
The Service.StartupType enumerated type defines valid Startup Type for vCenter Server services.
MANUAL : Service Startup type is Manual, thus issuing an explicit start on the service will start it.
AUTOMATIC : Service Startup type is Automatic, thus during starting all services or issuing explicit start on the service will start it.
DISABLED : Service Startup type is Disabled, thus it will not start unless the startup type changes to manual or automatic.
Possible values are: MANUAL , AUTOMATIC , DISABLED
Authentication
This operation uses the following authentication methods.
Code Samples
Code Samples
PowerCLI Client SDK Example
$ServicesServiceUpdateSpec = Initialize-ServicesServiceUpdateSpec -StartupType "MANUAL"
Invoke-UpdateService -Service "MyService" -ServicesServiceUpdateSpec $ServicesServiceUpdateSpec
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"startup_type":"MANUAL"}' https://{api_host}/api/vcenter/services/{service}
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the operation is denied in the current state of the service. If a start, stop or restart operation is in progress, update operation will fail with this error. if a request to set the Service.UpdateSpec.startup-type field of spec to DISABLED comes in for a service that is not in STOPPED state.
404
com.vmware.vapi.std.errors.not_found : if the service associated with service does not exist.
500
com.vmware.vapi.std.errors.error : if any other error occurs during the execution of the operation.
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: patch
x-vmw-doc-deprecated-path: /rest/vcenter/services/{service}
x-vmw-doc-operation: update
Availability
Added in 7.0U2
On This Page
Service Operations
patch
get
post
post
post
