com.vmware.vcenter.namespace_management.networks.nsx package

Submodules

com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client module

class com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client.Compatibility(config)

Bases: VapiInterface

The Compatibility class provides methods to get Namespaces compatibility information of Distributed Switches. This class was added in vSphere API 8.0.0.1.

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

class Summary(distributed_switch=None, name=None, compatible=None, incompatibility_reasons=None)

Bases: VapiStruct

The Compatibility.Summary class contains basic and compatibility information of a Distributed Switch. This class was added in vSphere API 8.0.0.1.

Tip

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

Parameters:

distributed_switch (str) – Identifier of the switch. The value of this field refers to the UUID of a vim.DistributedVirtualSwitch. This attribute was added in vSphere API 8.0.0.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: vSphereDistributedSwitch. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: vSphereDistributedSwitch.
name (str) – Human-readable identifier of the switch. This attribute was added in vSphere API 8.0.0.1.
compatible (bool) – Compatibility of this Distributed Switch with the vSphere Namespaces. This attribute was added in vSphere API 8.0.0.1.
incompatibility_reasons (list of com.vmware.vapi.std_client.LocalizableMessage) – List of reasons for incompatibility. If empty, this Distributed Switch is compatible. This attribute was added in vSphere API 8.0.0.1.

check(filter=None)

Returns a list of Distributed Switches matching the given filter and their compatibility information. This method was added in vSphere API 8.0.0.1.

Parameters:: filter (com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.FilterSpec or None) – Specification of matching Distributed Switches for which information should be returned. If None, the behavior is equivalent to a filter with all attributes None which means all Distributed Switches and their compatibility information will be returned.
Return type:: list of Compatibility.Summary
Returns:: List of Distributed Switches compatibility summaries matching the given filter.
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.InvalidArgument if one or more fields of the given filter is incorrect.
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 System.Read privilege.

class com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

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

com.vmware.vcenter.namespace_management.networks.nsx.edges_client module

class com.vmware.vcenter.namespace_management.networks.nsx.edges_client.Compatibility(config)

Bases: VapiInterface

The Compatibility class provides methods to retrieve the basic and Namespaces compatibility information of Edges. This class was added in vSphere API 8.0.0.1.

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

class Summary(edge_cluster=None, name=None, compatible=None, incompatibility_reasons=None)

Bases: VapiStruct

The Compatibility.Summary class contains information about an Edge, including whether it is compatible with the vCenter Namespaces feature and incompatibility reasons. This class was added in vSphere API 8.0.0.1.

Tip

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

Parameters:

edge_cluster (str) – Identifier of the Edge. This attribute was added in vSphere API 8.0.0.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: NSXEdgeCluster. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: NSXEdgeCluster.
name (str) – User-friendly identifier of the Edge. This attribute was added in vSphere API 8.0.0.1.
compatible (bool) – Compatibility of this Edge with vSphere Namespaces. This attribute was added in vSphere API 8.0.0.1.
incompatibility_reasons (list of com.vmware.vapi.std_client.LocalizableMessage) – List of reasons for incompatibility. If empty, this Edge is compatible. This attribute was added in vSphere API 8.0.0.1.

check(filter=None)

Returns a list of Edges matching the given filter and their compatibility information. This method was added in vSphere API 8.0.0.1.

Parameters:: filter (com.vmware.vcenter.namespace_management.networks.nsx_client.Edges.FilterSpec or None) – Specification of matching Edges for which information should be returned. If None, the behavior is equivalent to a given filter with all attributes None which means all Edges will be returned.
Return type:: list of Compatibility.Summary
Returns:: List of Edge compatibility summaries matching the given filter.
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.InvalidArgument if one or more fields of the given filter is incorrect.
Raise:: com.vmware.vapi.std.errors_client.Unauthenticated if the user cannot be authenticated.
Raise:: com.vmware.vapi.std.errors_client.Unauthorized if the user does not have System.Read privilege.

class com.vmware.vcenter.namespace_management.networks.nsx.edges_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

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