vmware::vcenter::hvc::management::Administrators Interface Reference

The Administrators provides methods to update, delete, and list groups in the local sso group. More...

Inherited by vmware::vcenter::hvc::management::AdministratorsStub.

List of all members.

Public Member Functions
void	Add (string groupName)
	Add the local sso group with the new group.
void	Add (string groupName, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Add the local sso group with the new group.
global::System.Threading.Tasks.Task	AddAsync (string groupName)
	Add the local sso group with the new group.
global::System.Threading.Tasks.Task	AddAsync (string groupName, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Add the local sso group with the new group.
void	Remove (string groupName)
	Remove the group from the local sso group.
void	Remove (string groupName, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Remove the group from the local sso group.
global::System.Threading.Tasks.Task	RemoveAsync (string groupName)
	Remove the group from the local sso group.
global::System.Threading.Tasks.Task	RemoveAsync (string groupName, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Remove the group from the local sso group.
void	Set (global::System.Collections.Generic.HashSet< string > groupNames)
	Sets the groups in the local sso group.
void	Set (global::System.Collections.Generic.HashSet< string > groupNames, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Sets the groups in the local sso group.
global::System.Threading.Tasks.Task	SetAsync (global::System.Collections.Generic.HashSet< string > groupNames)
	Sets the groups in the local sso group.
global::System.Threading.Tasks.Task	SetAsync (global::System.Collections.Generic.HashSet< string > groupNames, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Sets the groups in the local sso group.
global::System.Collections.Generic.HashSet < string >	Get ()
	Enumerates the set of all the groups in the local sso group.
global::System.Collections.Generic.HashSet < string >	Get (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Enumerates the set of all the groups in the local sso group.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.HashSet < string > >	GetAsync ()
	Enumerates the set of all the groups in the local sso group.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.HashSet < string > >	GetAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Enumerates the set of all the groups in the local sso group.

---

Detailed Description

The Administrators provides methods to update, delete, and list groups in the local sso group.

This is limited to the Hybrid Linked Mode service. Usage beyond VMware Cloud on AWS is not supported. Warning: This interface is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

---

Member Function Documentation

void vmware::vcenter::hvc::management::Administrators::Add

(

string

groupName

)

Add the local sso group with the new group.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:

vmware.vapi.std.errors.Unauthorized	If the user is not authorized.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.

Parameters:

groupName

Name of the new group to be added. Ex - xyz@abc.com where xyz is the group name and abc.com is the domain name

Implemented in vmware::vcenter::hvc::management::AdministratorsStub.

void vmware::vcenter::hvc::management::Administrators::Add	(	string	groupName,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Add the local sso group with the new group.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:

vmware.vapi.std.errors.Unauthorized	If the user is not authorized.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.

Parameters:

groupName	Name of the new group to be added. Ex - xyz@abc.com where xyz is the group name and abc.com is the domain name
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::hvc::management::AdministratorsStub.

global::System.Threading.Tasks.Task vmware::vcenter::hvc::management::Administrators::AddAsync	(	string	groupName,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Add the local sso group with the new group.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:

vmware.vapi.std.errors.Unauthorized	If the user is not authorized.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.

Parameters:

groupName	Name of the new group to be added. Ex - xyz@abc.com where xyz is the group name and abc.com is the domain name
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::hvc::management::AdministratorsStub.

global::System.Threading.Tasks.Task vmware::vcenter::hvc::management::Administrators::AddAsync

(

string

groupName

)

Add the local sso group with the new group.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:

vmware.vapi.std.errors.Unauthorized	If the user is not authorized.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.

Parameters:

groupName

Name of the new group to be added. Ex - xyz@abc.com where xyz is the group name and abc.com is the domain name

Implemented in vmware::vcenter::hvc::management::AdministratorsStub.

global::System.Collections.Generic.HashSet<string> vmware::vcenter::hvc::management::Administrators::Get

(

)

Enumerates the set of all the groups in the local sso group.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:

vmware.vapi.std.errors.Error

if the system reports an error while responding to the request.

Returns:

The set of all the groups.

Implemented in vmware::vcenter::hvc::management::AdministratorsStub.

global::System.Collections.Generic.HashSet<string> vmware::vcenter::hvc::management::Administrators::Get	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Enumerates the set of all the groups in the local sso group.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:

vmware.vapi.std.errors.Error

if the system reports an error while responding to the request.

Returns:

The set of all the groups.

Implemented in vmware::vcenter::hvc::management::AdministratorsStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.HashSet<string> > vmware::vcenter::hvc::management::Administrators::GetAsync

(

)

Enumerates the set of all the groups in the local sso group.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:

vmware.vapi.std.errors.Error

if the system reports an error while responding to the request.

Returns:

The set of all the groups.

Implemented in vmware::vcenter::hvc::management::AdministratorsStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.HashSet<string> > vmware::vcenter::hvc::management::Administrators::GetAsync	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Enumerates the set of all the groups in the local sso group.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:

vmware.vapi.std.errors.Error

if the system reports an error while responding to the request.

Returns:

The set of all the groups.

Implemented in vmware::vcenter::hvc::management::AdministratorsStub.

void vmware::vcenter::hvc::management::Administrators::Remove

(

string

groupName

)

Remove the group from the local sso group.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:

vmware.vapi.std.errors.Unauthorized	If the user is not authorized.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.

Parameters:

groupName

Name of the group to be removed. Ex - xyz@abc.com where xyz is the group name and abc.com is the domain name

Implemented in vmware::vcenter::hvc::management::AdministratorsStub.

void vmware::vcenter::hvc::management::Administrators::Remove	(	string	groupName,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Remove the group from the local sso group.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:

vmware.vapi.std.errors.Unauthorized	If the user is not authorized.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.

Parameters:

groupName	Name of the group to be removed. Ex - xyz@abc.com where xyz is the group name and abc.com is the domain name
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::hvc::management::AdministratorsStub.

global::System.Threading.Tasks.Task vmware::vcenter::hvc::management::Administrators::RemoveAsync	(	string	groupName,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Remove the group from the local sso group.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:

vmware.vapi.std.errors.Unauthorized	If the user is not authorized.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.

Parameters:

groupName	Name of the group to be removed. Ex - xyz@abc.com where xyz is the group name and abc.com is the domain name
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::hvc::management::AdministratorsStub.

global::System.Threading.Tasks.Task vmware::vcenter::hvc::management::Administrators::RemoveAsync

(

string

groupName

)

Remove the group from the local sso group.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:

vmware.vapi.std.errors.Unauthorized	If the user is not authorized.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.

Parameters:

groupName

Name of the group to be removed. Ex - xyz@abc.com where xyz is the group name and abc.com is the domain name

Implemented in vmware::vcenter::hvc::management::AdministratorsStub.

void vmware::vcenter::hvc::management::Administrators::Set	(	global::System.Collections.Generic.HashSet< string >	groupNames,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Sets the groups in the local sso group.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:

vmware.vapi.std.errors.Unauthorized	If the user is not authorized.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.

Parameters:

groupNames	Names the groups to be in the CloudAdminGroup Ex - xyz@abc.com where xyz is the group name and abc.com is the domain name
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::hvc::management::AdministratorsStub.

void vmware::vcenter::hvc::management::Administrators::Set

(

global::System.Collections.Generic.HashSet< string >

groupNames

)

Sets the groups in the local sso group.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:

vmware.vapi.std.errors.Unauthorized	If the user is not authorized.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.

Parameters:

groupNames

Names the groups to be in the CloudAdminGroup Ex - xyz@abc.com where xyz is the group name and abc.com is the domain name

Implemented in vmware::vcenter::hvc::management::AdministratorsStub.

global::System.Threading.Tasks.Task vmware::vcenter::hvc::management::Administrators::SetAsync	(	global::System.Collections.Generic.HashSet< string >	groupNames,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Sets the groups in the local sso group.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:

vmware.vapi.std.errors.Unauthorized	If the user is not authorized.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.

Parameters:

groupNames	Names the groups to be in the CloudAdminGroup Ex - xyz@abc.com where xyz is the group name and abc.com is the domain name
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::hvc::management::AdministratorsStub.

global::System.Threading.Tasks.Task vmware::vcenter::hvc::management::Administrators::SetAsync

(

global::System.Collections.Generic.HashSet< string >

groupNames

)

Sets the groups in the local sso group.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:

vmware.vapi.std.errors.Unauthorized	If the user is not authorized.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.

Parameters:

groupNames

Names the groups to be in the CloudAdminGroup Ex - xyz@abc.com where xyz is the group name and abc.com is the domain name

Implemented in vmware::vcenter::hvc::management::AdministratorsStub.

---

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

• Administrators.cs