com.vmware.nsx.fabric.nodes package

Submodules

com.vmware.nsx.fabric.nodes.network_client module

class com.vmware.nsx.fabric.nodes.network_client.Interfaces(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

GET_SOURCE_CACHED = 'cached'

Possible value for source of method Interfaces.get().

GET_SOURCE_REALTIME = 'realtime'

Possible value for source of method Interfaces.get().

LIST_SOURCE_CACHED = 'cached'

Possible value for source of method Interfaces.list().

LIST_SOURCE_REALTIME = 'realtime'

Possible value for source of method Interfaces.list().

get(node_id, interface_id, source=None)

Returns detailed information about the specified interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method (static or DHCP).

Parameters

  • node_id (str) – (required)

  • interface_id (str) – (required)

  • source (str or None) – Data source type. (optional)

Return type

com.vmware.nsx.model_client.NodeInterfaceProperties

Returns

com.vmware.nsx.model.NodeInterfaceProperties

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

list(node_id, source=None)

Returns the number of interfaces on the node and detailed information about each interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method (static or DHCP).

Parameters

  • node_id (str) – (required)

  • source (str or None) – Data source type. (optional)

Return type

com.vmware.nsx.model_client.NodeInterfacePropertiesListResult

Returns

com.vmware.nsx.model.NodeInterfacePropertiesListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx.fabric.nodes.network_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

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