vmware::vcenter::trusted_infrastructure::kms::Services Interface Reference

The Services interface contains information about the registered instances of the Key Provider Service in vCenter. More...

Inherited by vmware::vcenter::trusted_infrastructure::kms::ServicesStub.

List of all members.

Public Member Functions
global::System.Collections.Generic.List < vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.Summary >	List (vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.FilterSpec spec)
	Returns basic information about all registered Key Provider Service instances in this vCenter.
global::System.Collections.Generic.List < vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.Summary >	List (vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.FilterSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns basic information about all registered Key Provider Service instances in this vCenter.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.Summary > >	ListAsync (vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.FilterSpec spec)
	Returns basic information about all registered Key Provider Service instances in this vCenter.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.Summary > >	ListAsync (vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.FilterSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns basic information about all registered Key Provider Service instances in this vCenter.
vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.Info	Get (string service)
	Returns the detailed information about a registered Key Provider Service instance in this vCenter.
vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.Info	Get (string service, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the detailed information about a registered Key Provider Service instance in this vCenter.
global::System.Threading.Tasks.Task < vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.Info >	GetAsync (string service)
	Returns the detailed information about a registered Key Provider Service instance in this vCenter.
global::System.Threading.Tasks.Task < vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.Info >	GetAsync (string service, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the detailed information about a registered Key Provider Service instance in this vCenter.
string	Create (vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.CreateSpec spec)
	Registers a Key Provider Service instance in this vCenter.
string	Create (vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Registers a Key Provider Service instance in this vCenter.
global::System.Threading.Tasks.Task < string >	CreateAsync (vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.CreateSpec spec)
	Registers a Key Provider Service instance in this vCenter.
global::System.Threading.Tasks.Task < string >	CreateAsync (vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Registers a Key Provider Service instance in this vCenter.
void	Delete (string service)
	Removes a currently registered Key Provider Service instance from this vCenter.
void	Delete (string service, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Removes a currently registered Key Provider Service instance from this vCenter.
global::System.Threading.Tasks.Task	DeleteAsync (string service)
	Removes a currently registered Key Provider Service instance from this vCenter.
global::System.Threading.Tasks.Task	DeleteAsync (string service, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Removes a currently registered Key Provider Service instance from this vCenter.

---

Detailed Description

The Services interface contains information about the registered instances of the Key Provider Service in vCenter.

This interface was added in vSphere API 7.0.0.

---

Member Function Documentation

string vmware::vcenter::trusted_infrastructure::kms::Services::Create

(

vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.CreateSpec

spec

)

Registers a Key Provider Service instance in this vCenter.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if there is already a Key Provider Service instance with the same Address.
vmware.vapi.std.errors.Error	if there is a generic error.
vmware.vapi.std.errors.InvalidArgument	if the CreateSpec contains invalid data.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires TrustedAdmin.ManageTrustedHosts .

Parameters:

spec	The CreateSpec for the new service.

Returns:

ID of the newly registered Key Provider Service instance. The result will be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service .

Implemented in vmware::vcenter::trusted_infrastructure::kms::ServicesStub.

string vmware::vcenter::trusted_infrastructure::kms::Services::Create	(	vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.CreateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Registers a Key Provider Service instance in this vCenter.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if there is already a Key Provider Service instance with the same Address.
vmware.vapi.std.errors.Error	if there is a generic error.
vmware.vapi.std.errors.InvalidArgument	if the CreateSpec contains invalid data.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires TrustedAdmin.ManageTrustedHosts .

Parameters:

spec	The CreateSpec for the new service.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

ID of the newly registered Key Provider Service instance. The result will be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service .

Implemented in vmware::vcenter::trusted_infrastructure::kms::ServicesStub.

global::System.Threading.Tasks.Task<string> vmware::vcenter::trusted_infrastructure::kms::Services::CreateAsync

(

vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.CreateSpec

spec

)

Registers a Key Provider Service instance in this vCenter.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if there is already a Key Provider Service instance with the same Address.
vmware.vapi.std.errors.Error	if there is a generic error.
vmware.vapi.std.errors.InvalidArgument	if the CreateSpec contains invalid data.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires TrustedAdmin.ManageTrustedHosts .

Parameters:

spec	The CreateSpec for the new service.

Returns:

ID of the newly registered Key Provider Service instance. The result will be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service .

Implemented in vmware::vcenter::trusted_infrastructure::kms::ServicesStub.

global::System.Threading.Tasks.Task<string> vmware::vcenter::trusted_infrastructure::kms::Services::CreateAsync	(	vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.CreateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Registers a Key Provider Service instance in this vCenter.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if there is already a Key Provider Service instance with the same Address.
vmware.vapi.std.errors.Error	if there is a generic error.
vmware.vapi.std.errors.InvalidArgument	if the CreateSpec contains invalid data.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires TrustedAdmin.ManageTrustedHosts .

Parameters:

spec	The CreateSpec for the new service.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

ID of the newly registered Key Provider Service instance. The result will be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service .

Implemented in vmware::vcenter::trusted_infrastructure::kms::ServicesStub.

void vmware::vcenter::trusted_infrastructure::kms::Services::Delete

(

string

service

)

Removes a currently registered Key Provider Service instance from this vCenter.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if an error occurred while deleting the service.
vmware.vapi.std.errors.NotFound	if the Key Provider Service instance is not found.
vmware.vapi.std.errors.ResourceBusy	if the Key Provider Service instance is used by a configuration on a cluster level.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires TrustedAdmin.ManageTrustedHosts .

Parameters:

service

the Key Provider Service instance unique identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service .

Implemented in vmware::vcenter::trusted_infrastructure::kms::ServicesStub.

void vmware::vcenter::trusted_infrastructure::kms::Services::Delete	(	string	service,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Removes a currently registered Key Provider Service instance from this vCenter.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if an error occurred while deleting the service.
vmware.vapi.std.errors.NotFound	if the Key Provider Service instance is not found.
vmware.vapi.std.errors.ResourceBusy	if the Key Provider Service instance is used by a configuration on a cluster level.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires TrustedAdmin.ManageTrustedHosts .

Parameters:

service	the Key Provider Service instance unique identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::trusted_infrastructure::kms::ServicesStub.

global::System.Threading.Tasks.Task vmware::vcenter::trusted_infrastructure::kms::Services::DeleteAsync

(

string

service

)

Removes a currently registered Key Provider Service instance from this vCenter.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if an error occurred while deleting the service.
vmware.vapi.std.errors.NotFound	if the Key Provider Service instance is not found.
vmware.vapi.std.errors.ResourceBusy	if the Key Provider Service instance is used by a configuration on a cluster level.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires TrustedAdmin.ManageTrustedHosts .

Parameters:

service

the Key Provider Service instance unique identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service .

Implemented in vmware::vcenter::trusted_infrastructure::kms::ServicesStub.

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

Removes a currently registered Key Provider Service instance from this vCenter.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if an error occurred while deleting the service.
vmware.vapi.std.errors.NotFound	if the Key Provider Service instance is not found.
vmware.vapi.std.errors.ResourceBusy	if the Key Provider Service instance is used by a configuration on a cluster level.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires TrustedAdmin.ManageTrustedHosts .

Parameters:

service	the Key Provider Service instance unique identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::trusted_infrastructure::kms::ServicesStub.

vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.Info vmware::vcenter::trusted_infrastructure::kms::Services::Get

(

string

service

)

Returns the detailed information about a registered Key Provider Service instance in this vCenter.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if an error occurred while getting the data.
vmware.vapi.std.errors.NotFound	if there is no Key Provider Service instance with the specified ID.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires TrustedAdmin.ReadTrustedHosts .

Parameters:

service

the Key Provider Service instance unique identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service .

Returns:

Detailed information about the specified Key Provider Service instance.

Implemented in vmware::vcenter::trusted_infrastructure::kms::ServicesStub.

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

Returns the detailed information about a registered Key Provider Service instance in this vCenter.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if an error occurred while getting the data.
vmware.vapi.std.errors.NotFound	if there is no Key Provider Service instance with the specified ID.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires TrustedAdmin.ReadTrustedHosts .

Parameters:

service	the Key Provider Service instance unique identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Detailed information about the specified Key Provider Service instance.

Implemented in vmware::vcenter::trusted_infrastructure::kms::ServicesStub.

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

Returns the detailed information about a registered Key Provider Service instance in this vCenter.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if an error occurred while getting the data.
vmware.vapi.std.errors.NotFound	if there is no Key Provider Service instance with the specified ID.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires TrustedAdmin.ReadTrustedHosts .

Parameters:

service	the Key Provider Service instance unique identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Detailed information about the specified Key Provider Service instance.

Implemented in vmware::vcenter::trusted_infrastructure::kms::ServicesStub.

global::System.Threading.Tasks.Task<vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.Info> vmware::vcenter::trusted_infrastructure::kms::Services::GetAsync

(

string

service

)

Returns the detailed information about a registered Key Provider Service instance in this vCenter.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if an error occurred while getting the data.
vmware.vapi.std.errors.NotFound	if there is no Key Provider Service instance with the specified ID.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires TrustedAdmin.ReadTrustedHosts .

Parameters:

service

the Key Provider Service instance unique identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service .

Returns:

Detailed information about the specified Key Provider Service instance.

Implemented in vmware::vcenter::trusted_infrastructure::kms::ServicesStub.

global::System.Collections.Generic.List<vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.Summary> vmware::vcenter::trusted_infrastructure::kms::Services::List	(	vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.FilterSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns basic information about all registered Key Provider Service instances in this vCenter.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if an error occurred while getting the data.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires TrustedAdmin.ReadTrustedHosts .

Parameters:

spec	Return only services matching the specified filters. If {.unset} return all services.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Basic information about all registered Key Provider Service instances in this vCenter.

Implemented in vmware::vcenter::trusted_infrastructure::kms::ServicesStub.

global::System.Collections.Generic.List<vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.Summary> vmware::vcenter::trusted_infrastructure::kms::Services::List

(

vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.FilterSpec

spec

)

Returns basic information about all registered Key Provider Service instances in this vCenter.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if an error occurred while getting the data.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires TrustedAdmin.ReadTrustedHosts .

Parameters:

spec	Return only services matching the specified filters. If {.unset} return all services.

Returns:

Basic information about all registered Key Provider Service instances in this vCenter.

Implemented in vmware::vcenter::trusted_infrastructure::kms::ServicesStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.Summary> > vmware::vcenter::trusted_infrastructure::kms::Services::ListAsync

(

vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.FilterSpec

spec

)

Returns basic information about all registered Key Provider Service instances in this vCenter.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if an error occurred while getting the data.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires TrustedAdmin.ReadTrustedHosts .

Parameters:

spec	Return only services matching the specified filters. If {.unset} return all services.

Returns:

Basic information about all registered Key Provider Service instances in this vCenter.

Implemented in vmware::vcenter::trusted_infrastructure::kms::ServicesStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.Summary> > vmware::vcenter::trusted_infrastructure::kms::Services::ListAsync	(	vmware.vcenter.trusted_infrastructure.kms.ServicesTypes.FilterSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns basic information about all registered Key Provider Service instances in this vCenter.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if an error occurred while getting the data.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires TrustedAdmin.ReadTrustedHosts .

Parameters:

spec	Return only services matching the specified filters. If {.unset} return all services.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Basic information about all registered Key Provider Service instances in this vCenter.

Implemented in vmware::vcenter::trusted_infrastructure::kms::ServicesStub.

---

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

• vcenter/trusted_infrastructure/kms/Services.cs