com.vmware.vcenter.namespaces package¶

Submodules¶

The com.vmware.vcenter.namespaces.user_client module provides classes to access namespaces for non-administrative users.

class com.vmware.vcenter.namespaces.user_client.Instances(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Instances class provides methods to access namespaces for non-administrative users.

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

class Summary(namespace=None, master_host=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Instances.Summary class contains information about a namespace that user is authorized to access.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

namespace (str) – Identifier of the namespace. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.
master_host (str) – IP address or FQDN of the API endpoint for the given namespace.

list()¶

Returns namespaces matching the FilterSpec. TODO: we need to put the link back for FilterSpec, https://jira.eng.vmware.com/browse/VKAL-13522.

Return type: list of Instances.Summary
Returns: List of Namespace identifiers together with the API endpoint for each namespace.
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.Unauthenticated If the user can not be authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthorized If the user does not have Namespaces.ListAccess privilege to perform this operation.

class com.vmware.vcenter.namespaces.user_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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