vmware::appliance::Services Interface Reference

The Service interface provides methods to manage a single/set of appliance services. More...

Inherited by vmware::appliance::ServicesStub.

List of all members.

Public Member Functions
void	Start (string service)
	Starts a service.
void	Start (string service, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Starts a service.
global::System.Threading.Tasks.Task	StartAsync (string service)
	Starts a service.
global::System.Threading.Tasks.Task	StartAsync (string service, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Starts a service.
void	Stop (string service)
	Stops a service.
void	Stop (string service, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Stops a service.
global::System.Threading.Tasks.Task	StopAsync (string service)
	Stops a service.
global::System.Threading.Tasks.Task	StopAsync (string service, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Stops a service.
void	Restart (string service)
	Restarts a service.
void	Restart (string service, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Restarts a service.
global::System.Threading.Tasks.Task	RestartAsync (string service)
	Restarts a service.
global::System.Threading.Tasks.Task	RestartAsync (string service, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Restarts a service.
vmware.appliance.ServicesTypes.Info	Get (string service)
	Returns the state of a service.
vmware.appliance.ServicesTypes.Info	Get (string service, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the state of a service.
global::System.Threading.Tasks.Task < vmware.appliance.ServicesTypes.Info >	GetAsync (string service)
	Returns the state of a service.
global::System.Threading.Tasks.Task < vmware.appliance.ServicesTypes.Info >	GetAsync (string service, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the state of a service.
global::System.Collections.Generic.Dictionary < string, vmware.appliance.ServicesTypes.Info >	List ()
	Lists details of vCenter services.
global::System.Collections.Generic.Dictionary < string, vmware.appliance.ServicesTypes.Info >	List (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Lists details of vCenter services.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.Dictionary < string, vmware.appliance.ServicesTypes.Info > >	ListAsync ()
	Lists details of vCenter services.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.Dictionary < string, vmware.appliance.ServicesTypes.Info > >	ListAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Lists details of vCenter services.

---

Detailed Description

The Service interface provides methods to manage a single/set of appliance services.

This interface was added in vSphere API 6.7.

---

Member Function Documentation

vmware.appliance.ServicesTypes.Info vmware::appliance::Services::Get

(

string

service

)

Returns the state of a service.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the service associated with service does not exist.
vmware.vapi.std.errors.Error	if any other error occurs during the execution of the operation.

Parameters:

service

identifier of the service whose state is being queried. The parameter must be an identifier for the resource type: com.vmware.appliance.services .

Returns:

Service Info structure.

Implemented in vmware::appliance::ServicesStub.

vmware.appliance.ServicesTypes.Info vmware::appliance::Services::Get	(	string	service,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns the state of a service.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the service associated with service does not exist.
vmware.vapi.std.errors.Error	if any other error occurs during the execution of the operation.

Parameters:

service	identifier of the service whose state is being queried. The parameter must be an identifier for the resource type: com.vmware.appliance.services .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Service Info structure.

Implemented in vmware::appliance::ServicesStub.

global::System.Threading.Tasks.Task<vmware.appliance.ServicesTypes.Info> vmware::appliance::Services::GetAsync	(	string	service,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns the state of a service.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the service associated with service does not exist.
vmware.vapi.std.errors.Error	if any other error occurs during the execution of the operation.

Parameters:

service	identifier of the service whose state is being queried. The parameter must be an identifier for the resource type: com.vmware.appliance.services .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Service Info structure.

Implemented in vmware::appliance::ServicesStub.

global::System.Threading.Tasks.Task<vmware.appliance.ServicesTypes.Info> vmware::appliance::Services::GetAsync

(

string

service

)

Returns the state of a service.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the service associated with service does not exist.
vmware.vapi.std.errors.Error	if any other error occurs during the execution of the operation.

Parameters:

service

identifier of the service whose state is being queried. The parameter must be an identifier for the resource type: com.vmware.appliance.services .

Returns:

Service Info structure.

Implemented in vmware::appliance::ServicesStub.

global::System.Collections.Generic.Dictionary<string, vmware.appliance.ServicesTypes.Info> vmware::appliance::Services::List

(

)

Lists details of vCenter services.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

if any error occurs during the execution of the operation.

Returns:

Map of service identifiers to service Info structures. The key in the result map will be an identifier for the resource type: com.vmware.appliance.services .

Implemented in vmware::appliance::ServicesStub.

global::System.Collections.Generic.Dictionary<string, vmware.appliance.ServicesTypes.Info> vmware::appliance::Services::List	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Lists details of vCenter services.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

if any error occurs during the execution of the operation.

Returns:

Map of service identifiers to service Info structures. The key in the result map will be an identifier for the resource type: com.vmware.appliance.services .

Implemented in vmware::appliance::ServicesStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.Dictionary<string, vmware.appliance.ServicesTypes.Info> > vmware::appliance::Services::ListAsync

(

)

Lists details of vCenter services.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

if any error occurs during the execution of the operation.

Returns:

Map of service identifiers to service Info structures. The key in the result map will be an identifier for the resource type: com.vmware.appliance.services .

Implemented in vmware::appliance::ServicesStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.Dictionary<string, vmware.appliance.ServicesTypes.Info> > vmware::appliance::Services::ListAsync	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Lists details of vCenter services.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error

if any error occurs during the execution of the operation.

Returns:

Map of service identifiers to service Info structures. The key in the result map will be an identifier for the resource type: com.vmware.appliance.services .

Implemented in vmware::appliance::ServicesStub.

void vmware::appliance::Services::Restart	(	string	service,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Restarts a service.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the service associated with service does not exist.
vmware.vapi.std.errors.TimedOut	if any timeout occurs during the execution of the restart operation.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the operation is denied in the current state of the service. If a stop or start operation is in progress, issuing a restart operation will lead to this error.
vmware.vapi.std.errors.NotAllowedInCurrentState	if a restart operation is issued on a service which has startup type null
vmware.vapi.std.errors.Error	if any other error occurs during the execution of the operation.

Parameters:

service	identifier of the service to restart The parameter must be an identifier for the resource type: com.vmware.appliance.services .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::appliance::ServicesStub.

void vmware::appliance::Services::Restart

(

string

service

)

Restarts a service.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the service associated with service does not exist.
vmware.vapi.std.errors.TimedOut	if any timeout occurs during the execution of the restart operation.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the operation is denied in the current state of the service. If a stop or start operation is in progress, issuing a restart operation will lead to this error.
vmware.vapi.std.errors.NotAllowedInCurrentState	if a restart operation is issued on a service which has startup type null
vmware.vapi.std.errors.Error	if any other error occurs during the execution of the operation.

Parameters:

service

identifier of the service to restart The parameter must be an identifier for the resource type: com.vmware.appliance.services .

Implemented in vmware::appliance::ServicesStub.

global::System.Threading.Tasks.Task vmware::appliance::Services::RestartAsync

(

string

service

)

Restarts a service.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the service associated with service does not exist.
vmware.vapi.std.errors.TimedOut	if any timeout occurs during the execution of the restart operation.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the operation is denied in the current state of the service. If a stop or start operation is in progress, issuing a restart operation will lead to this error.
vmware.vapi.std.errors.NotAllowedInCurrentState	if a restart operation is issued on a service which has startup type null
vmware.vapi.std.errors.Error	if any other error occurs during the execution of the operation.

Parameters:

service

identifier of the service to restart The parameter must be an identifier for the resource type: com.vmware.appliance.services .

Implemented in vmware::appliance::ServicesStub.

global::System.Threading.Tasks.Task vmware::appliance::Services::RestartAsync	(	string	service,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Restarts a service.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the service associated with service does not exist.
vmware.vapi.std.errors.TimedOut	if any timeout occurs during the execution of the restart operation.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the operation is denied in the current state of the service. If a stop or start operation is in progress, issuing a restart operation will lead to this error.
vmware.vapi.std.errors.NotAllowedInCurrentState	if a restart operation is issued on a service which has startup type null
vmware.vapi.std.errors.Error	if any other error occurs during the execution of the operation.

Parameters:

service	identifier of the service to restart The parameter must be an identifier for the resource type: com.vmware.appliance.services .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::appliance::ServicesStub.

void vmware::appliance::Services::Start	(	string	service,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Starts a service.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the service associated with service does not exist.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the operation is denied in the current state of the service. If a stop or restart operation is in progress, the start operation will not be allowed.
vmware.vapi.std.errors.NotAllowedInCurrentState	if start operation is issued on a service which has startup type null.
vmware.vapi.std.errors.TimedOut	if any timeout occurs during the execution of the start operation. Timeout occurs when the service takes longer than StartTimeout to start.
vmware.vapi.std.errors.Error	if any other error occurs during the execution of the operation.

Parameters:

service	identifier of the service to start The parameter must be an identifier for the resource type: com.vmware.appliance.services .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::appliance::ServicesStub.

void vmware::appliance::Services::Start

(

string

service

)

Starts a service.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the service associated with service does not exist.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the operation is denied in the current state of the service. If a stop or restart operation is in progress, the start operation will not be allowed.
vmware.vapi.std.errors.NotAllowedInCurrentState	if start operation is issued on a service which has startup type null.
vmware.vapi.std.errors.TimedOut	if any timeout occurs during the execution of the start operation. Timeout occurs when the service takes longer than StartTimeout to start.
vmware.vapi.std.errors.Error	if any other error occurs during the execution of the operation.

Parameters:

service

identifier of the service to start The parameter must be an identifier for the resource type: com.vmware.appliance.services .

Implemented in vmware::appliance::ServicesStub.

global::System.Threading.Tasks.Task vmware::appliance::Services::StartAsync

(

string

service

)

Starts a service.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the service associated with service does not exist.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the operation is denied in the current state of the service. If a stop or restart operation is in progress, the start operation will not be allowed.
vmware.vapi.std.errors.NotAllowedInCurrentState	if start operation is issued on a service which has startup type null.
vmware.vapi.std.errors.TimedOut	if any timeout occurs during the execution of the start operation. Timeout occurs when the service takes longer than StartTimeout to start.
vmware.vapi.std.errors.Error	if any other error occurs during the execution of the operation.

Parameters:

service

identifier of the service to start The parameter must be an identifier for the resource type: com.vmware.appliance.services .

Implemented in vmware::appliance::ServicesStub.

global::System.Threading.Tasks.Task vmware::appliance::Services::StartAsync	(	string	service,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Starts a service.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the service associated with service does not exist.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the operation is denied in the current state of the service. If a stop or restart operation is in progress, the start operation will not be allowed.
vmware.vapi.std.errors.NotAllowedInCurrentState	if start operation is issued on a service which has startup type null.
vmware.vapi.std.errors.TimedOut	if any timeout occurs during the execution of the start operation. Timeout occurs when the service takes longer than StartTimeout to start.
vmware.vapi.std.errors.Error	if any other error occurs during the execution of the operation.

Parameters:

service	identifier of the service to start The parameter must be an identifier for the resource type: com.vmware.appliance.services .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::appliance::ServicesStub.

void vmware::appliance::Services::Stop

(

string

service

)

Stops a service.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the service associated with service does not exist.
vmware.vapi.std.errors.Error	if any other error occurs during the execution of the operation.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the operation is denied in the current state of the service. If a stop operation is in progress, issuing another stop operation will lead to this error.

Parameters:

service

identifier of the service to stop The parameter must be an identifier for the resource type: com.vmware.appliance.services .

Implemented in vmware::appliance::ServicesStub.

void vmware::appliance::Services::Stop	(	string	service,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Stops a service.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the service associated with service does not exist.
vmware.vapi.std.errors.Error	if any other error occurs during the execution of the operation.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the operation is denied in the current state of the service. If a stop operation is in progress, issuing another stop operation will lead to this error.

Parameters:

service	identifier of the service to stop The parameter must be an identifier for the resource type: com.vmware.appliance.services .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::appliance::ServicesStub.

global::System.Threading.Tasks.Task vmware::appliance::Services::StopAsync	(	string	service,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Stops a service.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the service associated with service does not exist.
vmware.vapi.std.errors.Error	if any other error occurs during the execution of the operation.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the operation is denied in the current state of the service. If a stop operation is in progress, issuing another stop operation will lead to this error.

Parameters:

service	identifier of the service to stop The parameter must be an identifier for the resource type: com.vmware.appliance.services .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::appliance::ServicesStub.

global::System.Threading.Tasks.Task vmware::appliance::Services::StopAsync

(

string

service

)

Stops a service.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.NotFound	if the service associated with service does not exist.
vmware.vapi.std.errors.Error	if any other error occurs during the execution of the operation.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the operation is denied in the current state of the service. If a stop operation is in progress, issuing another stop operation will lead to this error.

Parameters:

service

identifier of the service to stop The parameter must be an identifier for the resource type: com.vmware.appliance.services .

Implemented in vmware::appliance::ServicesStub.

---

The documentation for this interface was generated from the following file:

• appliance/Services.cs