com.vmware.vcenter.hvc package¶

Subpackages¶

com.vmware.vcenter.hvc.links package
- Submodules
- com.vmware.vcenter.hvc.links.sync_client module

Submodules¶

com.vmware.vcenter.hvc.links_client module¶

class com.vmware.vcenter.hvc.links_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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

class com.vmware.vcenter.hvc.links_client.Sync(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Sync class provides methods to create a sync session, get information on Sync. Warning: This class is available as technical preview. It may be changed in a future release.

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

reset(link)¶

Resets the sync state between the linked domains by initiating a fresh sync for all providers. If an existing sync is in progress this cancels the sync. Warning: This method is available as technical preview. It may be changed in a future release.

Parameters:	link (`str`) – Unique identifier of the link. The parameter must be an identifier for the resource type: `com.vmware.vcenter.hvc.Links`.
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.NotFound` if the link Identifier associated with `link` does not exist.
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` if the user is not authorized to perform this operation.

com.vmware.vcenter.hvc.management_client module¶

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

Bases: vmware.vapi.bindings.stub.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. Warning: This class is available as technical preview. It may be changed in a future release.

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. Warning: This method is available as technical preview. It may be changed in a future release.

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.

get()¶

Enumerates the set of all the groups in the local sso group. Warning: This method is available as technical preview. It may be changed in a future release.

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.

remove(group_name)¶

Remove the group from the local sso group. Warning: This method is available as technical preview. It may be changed in a future release.

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.

set(group_names)¶

Sets the groups in the local sso group. Warning: This method is available as technical preview. It may be changed in a future release.

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.

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

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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