com.vmware.vcenter.hvc.management

Interface Administrators

All Superinterfaces:

AdministratorsTypes, Service

All Known Implementing Classes:

AdministratorsStub

public interface Administrators
extends Service, AdministratorsTypes

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.

Field Summary

Fields inherited from interface com.vmware.vcenter.hvc.management.AdministratorsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String groupName) Add the local sso group with the new group.
void	add(java.lang.String groupName, AsyncCallback<java.lang.Void> asyncCallback) Add the local sso group with the new group.
void	add(java.lang.String groupName, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Add the local sso group with the new group.
void	add(java.lang.String groupName, InvocationConfig invocationConfig) Add the local sso group with the new group.
java.util.Set<java.lang.String>	get() Enumerates the set of all the groups in the local sso group.
void	get(AsyncCallback<java.util.Set<java.lang.String>> asyncCallback) Enumerates the set of all the groups in the local sso group.
void	get(AsyncCallback<java.util.Set<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Enumerates the set of all the groups in the local sso group.
java.util.Set<java.lang.String>	get(InvocationConfig invocationConfig) Enumerates the set of all the groups in the local sso group.
void	remove(java.lang.String groupName) Remove the group from the local sso group.
void	remove(java.lang.String groupName, AsyncCallback<java.lang.Void> asyncCallback) Remove the group from the local sso group.
void	remove(java.lang.String groupName, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Remove the group from the local sso group.
void	remove(java.lang.String groupName, InvocationConfig invocationConfig) Remove the group from the local sso group.
void	set(java.util.Set<java.lang.String> groupNames) Sets the groups in the local sso group.
void	set(java.util.Set<java.lang.String> groupNames, AsyncCallback<java.lang.Void> asyncCallback) Sets the groups in the local sso group.
void	set(java.util.Set<java.lang.String> groupNames, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Sets the groups in the local sso group.
void	set(java.util.Set<java.lang.String> groupNames, InvocationConfig invocationConfig) Sets the groups in the local sso group.

Method Detail

add

void add(java.lang.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.

Synchronous method overload. Result of the invocation will be reported as a method return value.

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

Throws:

Unauthorized - If the user is not authorized.

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

add

void add(java.lang.String groupName,
         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.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

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

invocationConfig - Configuration for the method invocation.

Throws:

Unauthorized - If the user is not authorized.

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

add

void add(java.lang.String groupName,
         AsyncCallback<java.lang.Void> asyncCallback)

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.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Unauthorized - If the user is not authorized.
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

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

add

void add(java.lang.String groupName,
         AsyncCallback<java.lang.Void> asyncCallback,
         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.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Unauthorized - If the user is not authorized.
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

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

remove

void remove(java.lang.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.

Synchronous method overload. Result of the invocation will be reported as a method return value.

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

Throws:

Unauthorized - If the user is not authorized.

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

remove

void remove(java.lang.String groupName,
            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.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

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

invocationConfig - Configuration for the method invocation.

Throws:

Unauthorized - If the user is not authorized.

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

remove

void remove(java.lang.String groupName,
            AsyncCallback<java.lang.Void> asyncCallback)

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.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Unauthorized - If the user is not authorized.
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

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

remove

void remove(java.lang.String groupName,
            AsyncCallback<java.lang.Void> asyncCallback,
            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.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Unauthorized - If the user is not authorized.
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

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

set

void set(java.util.Set<java.lang.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.

Synchronous method overload. Result of the invocation will be reported as a method return value.

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

Throws:

Unauthorized - If the user is not authorized.

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

set

void set(java.util.Set<java.lang.String> groupNames,
         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.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

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

invocationConfig - Configuration for the method invocation.

Throws:

Unauthorized - If the user is not authorized.

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

set

void set(java.util.Set<java.lang.String> groupNames,
         AsyncCallback<java.lang.Void> asyncCallback)

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.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Unauthorized - If the user is not authorized.
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

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

set

void set(java.util.Set<java.lang.String> groupNames,
         AsyncCallback<java.lang.Void> asyncCallback,
         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.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Unauthorized - If the user is not authorized.
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

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

get

java.util.Set<java.lang.String> 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.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Returns:

The Set of all the groups.

Throws:

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

get

java.util.Set<java.lang.String> get(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.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

The Set of all the groups.

Throws:

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

get

void get(AsyncCallback<java.util.Set<java.lang.String>> asyncCallback)

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.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
The Set of all the groups.

Operation Errors:
Error - if the system reports an error while responding to the request.

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(AsyncCallback<java.util.Set<java.lang.String>> asyncCallback,
         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.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
The Set of all the groups.

Operation Errors:
Error - if the system reports an error while responding to the request.

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.