com.vmware.vcenter.hvc package

Submodules

com.vmware.vcenter.hvc.management_client module

class com.vmware.vcenter.hvc.management_client.Administrators(config)

Bases: VapiInterface

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.

Parameters:

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

add(group_name)

Add the local sso group with the new group. Usage beyond VMware Cloud on AWS is not supported.

Parameters:

group_name (str) – 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

Raise:

com.vmware.vapi.std.errors_client.Unauthorized If the user is not authorized.

Raise:

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise:

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

• Method execution requires HLM.Manage.

get()

Enumerates the set of all the groups in the local sso group. Usage beyond VMware Cloud on AWS is not supported.

Return type:

set of str

Returns:

The set of all the groups.

Raise:

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise:

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

remove(group_name)

Remove the group from the local sso group. Usage beyond VMware Cloud on AWS is not supported.

Parameters:

group_name (str) – Name of the group to be removed. Ex - xyz\@abc.com where xyz is the group name and abc.com is the domain name

Raise:

com.vmware.vapi.std.errors_client.Unauthorized If the user is not authorized.

Raise:

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise:

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

• Method execution requires HLM.Manage.

set(group_names)

Sets the groups in the local sso group. Usage beyond VMware Cloud on AWS is not supported.

Parameters:

group_names (set of str) – 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

Raise:

com.vmware.vapi.std.errors_client.Unauthorized If the user is not authorized.

Raise:

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise:

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

• Method execution requires HLM.Manage.

class com.vmware.vcenter.hvc.management_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance