Remote stub implementation of the Services API service. More...

Inherits vmware::appliance::Services.

Public Member Functions
	ServicesStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.TypeConverter typeConverter, vmware.vapi.bindings.IStubConfiguration config)
	ServicesStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.IStubConfiguration config)
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

Remote stub implementation of the Services API service.

Constructor & Destructor Documentation

vmware::appliance::ServicesStub::ServicesStub	(	vmware.vapi.core.IApiProvider	iApiProvider,
		vmware.vapi.bindings.TypeConverter	typeConverter,
		vmware.vapi.bindings.IStubConfiguration	config
	)		`[inline]`

vmware::appliance::ServicesStub::ServicesStub	(	vmware.vapi.core.IApiProvider	iApiProvider,
		vmware.vapi.bindings.IStubConfiguration	config
	)		`[inline]`

Member Function Documentation

vmware.appliance.ServicesTypes.Info vmware::appliance::ServicesStub::Get ( string service ) [inline]

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.

Implements vmware::appliance::Services.

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

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.

Implements vmware::appliance::Services.

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

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.

Implements vmware::appliance::Services.

global::System.Threading.Tasks.Task<vmware.appliance.ServicesTypes.Info> vmware::appliance::ServicesStub::GetAsync ( string service ) [inline]

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.

Implements vmware::appliance::Services.

global::System.Collections.Generic.Dictionary<string, vmware.appliance.ServicesTypes.Info> vmware::appliance::ServicesStub::List ( ) [inline]

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 .

Implements vmware::appliance::Services.

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

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 .

Implements vmware::appliance::Services.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.Dictionary<string, vmware.appliance.ServicesTypes.Info> > vmware::appliance::ServicesStub::ListAsync ( ) [inline]

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 .

Implements vmware::appliance::Services.

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

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 .

Implements vmware::appliance::Services.

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

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

Implements vmware::appliance::Services.

void vmware::appliance::ServicesStub::Restart ( string service ) [inline]

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 .

Implements vmware::appliance::Services.

global::System.Threading.Tasks.Task vmware::appliance::ServicesStub::RestartAsync ( string service ) [inline]

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 .

Implements vmware::appliance::Services.

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

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

Implements vmware::appliance::Services.

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

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

Implements vmware::appliance::Services.

void vmware::appliance::ServicesStub::Start ( string service ) [inline]

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 .

Implements vmware::appliance::Services.

global::System.Threading.Tasks.Task vmware::appliance::ServicesStub::StartAsync ( string service ) [inline]

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 .

Implements vmware::appliance::Services.

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

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

Implements vmware::appliance::Services.

void vmware::appliance::ServicesStub::Stop ( string service ) [inline]

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 .

Implements vmware::appliance::Services.

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

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

Implements vmware::appliance::Services.

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

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

Implements vmware::appliance::Services.

global::System.Threading.Tasks.Task vmware::appliance::ServicesStub::StopAsync ( string service ) [inline]

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 .

Implements vmware::appliance::Services.

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

appliance/ServicesStub.cs

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation