com.vmware.nsx.fabric

Interface PhysicalServers

All Superinterfaces:

PhysicalServersTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

PhysicalServersStub

public interface PhysicalServers
extends com.vmware.vapi.bindings.Service, PhysicalServersTypes

Field Summary

Fields inherited from interface com.vmware.nsx.fabric.PhysicalServersTypes

_VAPI_SERVICE_ID, LIST_OS_TYPE_CENTOSSERVER, LIST_OS_TYPE_OELSERVER, LIST_OS_TYPE_RHELSERVER, LIST_OS_TYPE_SLESSERVER, LIST_OS_TYPE_UBUNTUSERVER, LIST_OS_TYPE_WINDOWSSERVER

Method Summary

Modifier and Type	Method and Description
PhysicalServer	get(java.lang.String physicalServerId) Returns information about physical/bare metal server based on given transport node id.
void	get(java.lang.String physicalServerId, com.vmware.vapi.bindings.client.AsyncCallback<PhysicalServer> asyncCallback) Returns information about physical/bare metal server based on given transport node id.
void	get(java.lang.String physicalServerId, com.vmware.vapi.bindings.client.AsyncCallback<PhysicalServer> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about physical/bare metal server based on given transport node id.
PhysicalServer	get(java.lang.String physicalServerId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about physical/bare metal server based on given transport node id.
PhysicalServerListResult	list(java.lang.String cursor, java.lang.String displayName, java.lang.String includedFields, java.lang.String osType, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Returns information of all physical/bare metal servers registered as TN.
void	list(java.lang.String cursor, java.lang.String displayName, java.lang.String includedFields, java.lang.String osType, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<PhysicalServerListResult> asyncCallback) Returns information of all physical/bare metal servers registered as TN.
void	list(java.lang.String cursor, java.lang.String displayName, java.lang.String includedFields, java.lang.String osType, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<PhysicalServerListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information of all physical/bare metal servers registered as TN.
PhysicalServerListResult	list(java.lang.String cursor, java.lang.String displayName, java.lang.String includedFields, java.lang.String osType, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information of all physical/bare metal servers registered as TN.

Method Detail

get

PhysicalServer get(java.lang.String physicalServerId)

Returns information about physical/bare metal server based on given transport node id.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

physicalServerId - (required)

Returns:

com.vmware.nsx.model.PhysicalServer

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

PhysicalServer get(java.lang.String physicalServerId,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about physical/bare metal server based on given transport node id.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

physicalServerId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.PhysicalServer

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

void get(java.lang.String physicalServerId,
         com.vmware.vapi.bindings.client.AsyncCallback<PhysicalServer> asyncCallback)

Returns information about physical/bare metal server based on given transport node id.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx.model.PhysicalServer

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

physicalServerId - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String physicalServerId,
         com.vmware.vapi.bindings.client.AsyncCallback<PhysicalServer> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about physical/bare metal server based on given transport node id.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
com.vmware.nsx.model.PhysicalServer

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

physicalServerId - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

list

PhysicalServerListResult list(java.lang.String cursor,
                              java.lang.String displayName,
                              java.lang.String includedFields,
                              java.lang.String osType,
                              java.lang.Long pageSize,
                              java.lang.Boolean sortAscending,
                              java.lang.String sortBy)

Returns information of all physical/bare metal servers registered as TN.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

displayName - Display Name of the physical server (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

osType - OS type of the physical server (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx.model.PhysicalServerListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

PhysicalServerListResult list(java.lang.String cursor,
                              java.lang.String displayName,
                              java.lang.String includedFields,
                              java.lang.String osType,
                              java.lang.Long pageSize,
                              java.lang.Boolean sortAscending,
                              java.lang.String sortBy,
                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information of all physical/bare metal servers registered as TN.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

displayName - Display Name of the physical server (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

osType - OS type of the physical server (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.PhysicalServerListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

void list(java.lang.String cursor,
          java.lang.String displayName,
          java.lang.String includedFields,
          java.lang.String osType,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<PhysicalServerListResult> asyncCallback)

Returns information of all physical/bare metal servers registered as TN.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx.model.PhysicalServerListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

displayName - Display Name of the physical server (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

osType - OS type of the physical server (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

void list(java.lang.String cursor,
          java.lang.String displayName,
          java.lang.String includedFields,
          java.lang.String osType,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<PhysicalServerListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information of all physical/bare metal servers registered as TN.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
com.vmware.nsx.model.PhysicalServerListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

displayName - Display Name of the physical server (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

osType - OS type of the physical server (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.