com.vmware.vcenter

Interface Network

All Superinterfaces:

NetworkTypes, Service

All Known Implementing Classes:

NetworkStub

public interface Network
extends Service, NetworkTypes

The Network interface provides methods for manipulating a vCenter Server network.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.NetworkTypes

NetworkTypes.FilterSpec, NetworkTypes.Summary, NetworkTypes.Type

Field Summary

Fields inherited from interface com.vmware.vcenter.NetworkTypes

RESOURCE_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
List<NetworkTypes.Summary>	list(NetworkTypes.FilterSpec filter) Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the NetworkTypes.FilterSpec.
void	list(NetworkTypes.FilterSpec filter, AsyncCallback<List<NetworkTypes.Summary>> asyncCallback) Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the NetworkTypes.FilterSpec.
void	list(NetworkTypes.FilterSpec filter, AsyncCallback<List<NetworkTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the NetworkTypes.FilterSpec.
List<NetworkTypes.Summary>	list(NetworkTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the NetworkTypes.FilterSpec.

Method Detail

list

List<NetworkTypes.Summary> list(NetworkTypes.FilterSpec filter)

Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the NetworkTypes.FilterSpec.

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

Parameters:

filter - Specification of matching networks for which information should be returned. If null, the behavior is equivalent to a NetworkTypes.FilterSpec with all properties null which means all networks match the filter.

Returns:

Commonly used information about the networks matching the NetworkTypes.FilterSpec.

Throws:

InvalidArgument - if the NetworkTypes.FilterSpec.getTypes() property contains a value that is not supported by the server.

UnableToAllocateResource - if more than 1000 networks match the NetworkTypes.FilterSpec.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

list

List<NetworkTypes.Summary> list(NetworkTypes.FilterSpec filter,
                              InvocationConfig invocationConfig)

Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the NetworkTypes.FilterSpec.

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:

filter - Specification of matching networks for which information should be returned. If null, the behavior is equivalent to a NetworkTypes.FilterSpec with all properties null which means all networks match the filter.

invocationConfig - Configuration for the method invocation.

Returns:

Commonly used information about the networks matching the NetworkTypes.FilterSpec.

Throws:

InvalidArgument - if the NetworkTypes.FilterSpec.getTypes() property contains a value that is not supported by the server.

UnableToAllocateResource - if more than 1000 networks match the NetworkTypes.FilterSpec.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

list

void list(NetworkTypes.FilterSpec filter,
        AsyncCallback<List<NetworkTypes.Summary>> asyncCallback)

Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the NetworkTypes.FilterSpec.

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

Operation Result:
Commonly used information about the networks matching the NetworkTypes.FilterSpec.

Operation Errors:
InvalidArgument - if the NetworkTypes.FilterSpec.getTypes() property contains a value that is not supported by the server.
UnableToAllocateResource - if more than 1000 networks match the NetworkTypes.FilterSpec.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

filter - Specification of matching networks for which information should be returned. If null, the behavior is equivalent to a NetworkTypes.FilterSpec with all properties null which means all networks match the filter.

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

list

void list(NetworkTypes.FilterSpec filter,
        AsyncCallback<List<NetworkTypes.Summary>> asyncCallback,
        InvocationConfig invocationConfig)

Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the NetworkTypes.FilterSpec.

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

Operation Result:
Commonly used information about the networks matching the NetworkTypes.FilterSpec.

Operation Errors:
InvalidArgument - if the NetworkTypes.FilterSpec.getTypes() property contains a value that is not supported by the server.
UnableToAllocateResource - if more than 1000 networks match the NetworkTypes.FilterSpec.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

filter - Specification of matching networks for which information should be returned. If null, the behavior is equivalent to a NetworkTypes.FilterSpec with all properties null which means all networks match the filter.

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

invocationConfig - Configuration for the method invocation.