com.vmware.nsx.pktcap

Interface Session

All Superinterfaces:

com.vmware.vapi.bindings.Service, SessionTypes

All Known Implementing Classes:

SessionStub

public interface Session
extends com.vmware.vapi.bindings.Service, SessionTypes

Field Summary

Fields inherited from interface com.vmware.nsx.pktcap.SessionTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
PacketCaptureSession	create(PacketCaptureRequest packetCaptureRequest) Create an new packet capture session on given node with specified options
void	create(PacketCaptureRequest packetCaptureRequest, com.vmware.vapi.bindings.client.AsyncCallback<PacketCaptureSession> asyncCallback) Create an new packet capture session on given node with specified options
void	create(PacketCaptureRequest packetCaptureRequest, com.vmware.vapi.bindings.client.AsyncCallback<PacketCaptureSession> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create an new packet capture session on given node with specified options
PacketCaptureSession	create(PacketCaptureRequest packetCaptureRequest, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create an new packet capture session on given node with specified options
PacketCaptureSession	delete(java.lang.String sessionId) Before calling this method, terminate any running capture session.
void	delete(java.lang.String sessionId, com.vmware.vapi.bindings.client.AsyncCallback<PacketCaptureSession> asyncCallback) Before calling this method, terminate any running capture session.
void	delete(java.lang.String sessionId, com.vmware.vapi.bindings.client.AsyncCallback<PacketCaptureSession> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Before calling this method, terminate any running capture session.
PacketCaptureSession	delete(java.lang.String sessionId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Before calling this method, terminate any running capture session.
PacketCaptureSession	get(java.lang.String sessionId) Get the packet capture status information by session id.
void	get(java.lang.String sessionId, com.vmware.vapi.bindings.client.AsyncCallback<PacketCaptureSession> asyncCallback) Get the packet capture status information by session id.
void	get(java.lang.String sessionId, com.vmware.vapi.bindings.client.AsyncCallback<PacketCaptureSession> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get the packet capture status information by session id.
PacketCaptureSession	get(java.lang.String sessionId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get the packet capture status information by session id.
PacketCaptureSession	restart(java.lang.String sessionId) Restart the packet capture session
void	restart(java.lang.String sessionId, com.vmware.vapi.bindings.client.AsyncCallback<PacketCaptureSession> asyncCallback) Restart the packet capture session
void	restart(java.lang.String sessionId, com.vmware.vapi.bindings.client.AsyncCallback<PacketCaptureSession> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Restart the packet capture session
PacketCaptureSession	restart(java.lang.String sessionId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Restart the packet capture session
PacketCaptureSession	terminate(java.lang.String sessionId) Terminate the packet capture session by session id.
void	terminate(java.lang.String sessionId, com.vmware.vapi.bindings.client.AsyncCallback<PacketCaptureSession> asyncCallback) Terminate the packet capture session by session id.
void	terminate(java.lang.String sessionId, com.vmware.vapi.bindings.client.AsyncCallback<PacketCaptureSession> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Terminate the packet capture session by session id.
PacketCaptureSession	terminate(java.lang.String sessionId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Terminate the packet capture session by session id.

Method Detail

create

PacketCaptureSession create(PacketCaptureRequest packetCaptureRequest)

Create an new packet capture session on given node with specified options

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

Parameters:

packetCaptureRequest - (required)

Returns:

com.vmware.nsx.model.PacketCaptureSession

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

create

PacketCaptureSession create(PacketCaptureRequest packetCaptureRequest,
                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create an new packet capture session on given node with specified options

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:

packetCaptureRequest - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.PacketCaptureSession

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

create

void create(PacketCaptureRequest packetCaptureRequest,
            com.vmware.vapi.bindings.client.AsyncCallback<PacketCaptureSession> asyncCallback)

Create an new packet capture session on given node with specified options

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

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

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

Parameters:

packetCaptureRequest - (required)

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

create

void create(PacketCaptureRequest packetCaptureRequest,
            com.vmware.vapi.bindings.client.AsyncCallback<PacketCaptureSession> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create an new packet capture session on given node with specified options

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.PacketCaptureSession

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

Parameters:

packetCaptureRequest - (required)

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

invocationConfig - Configuration for the method invocation.

delete

PacketCaptureSession delete(java.lang.String sessionId)

Before calling this method, terminate any running capture session.

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

Parameters:

sessionId - Packet capture session id (required)

Returns:

com.vmware.nsx.model.PacketCaptureSession

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

delete

PacketCaptureSession delete(java.lang.String sessionId,
                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Before calling this method, terminate any running capture session.

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:

sessionId - Packet capture session id (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.PacketCaptureSession

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

delete

void delete(java.lang.String sessionId,
            com.vmware.vapi.bindings.client.AsyncCallback<PacketCaptureSession> asyncCallback)

Before calling this method, terminate any running capture session.

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

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

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

Parameters:

sessionId - Packet capture session id (required)

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

delete

void delete(java.lang.String sessionId,
            com.vmware.vapi.bindings.client.AsyncCallback<PacketCaptureSession> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Before calling this method, terminate any running capture session.

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.PacketCaptureSession

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

Parameters:

sessionId - Packet capture session id (required)

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

invocationConfig - Configuration for the method invocation.

get

PacketCaptureSession get(java.lang.String sessionId)

Get the packet capture status information by session id.

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

Parameters:

sessionId - Packet capture session id (required)

Returns:

com.vmware.nsx.model.PacketCaptureSession

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

PacketCaptureSession get(java.lang.String sessionId,
                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get the packet capture status information by session 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:

sessionId - Packet capture session id (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.PacketCaptureSession

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 sessionId,
         com.vmware.vapi.bindings.client.AsyncCallback<PacketCaptureSession> asyncCallback)

Get the packet capture status information by session id.

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

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

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

Parameters:

sessionId - Packet capture session id (required)

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

get

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

Get the packet capture status information by session 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.PacketCaptureSession

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

Parameters:

sessionId - Packet capture session id (required)

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

invocationConfig - Configuration for the method invocation.

restart

PacketCaptureSession restart(java.lang.String sessionId)

Restart the packet capture session

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

Parameters:

sessionId - Packet capture session id (required)

Returns:

com.vmware.nsx.model.PacketCaptureSession

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

restart

PacketCaptureSession restart(java.lang.String sessionId,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Restart the packet capture session

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:

sessionId - Packet capture session id (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.PacketCaptureSession

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

restart

void restart(java.lang.String sessionId,
             com.vmware.vapi.bindings.client.AsyncCallback<PacketCaptureSession> asyncCallback)

Restart the packet capture session

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

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

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

Parameters:

sessionId - Packet capture session id (required)

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

restart

void restart(java.lang.String sessionId,
             com.vmware.vapi.bindings.client.AsyncCallback<PacketCaptureSession> asyncCallback,
             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Restart the packet capture session

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.PacketCaptureSession

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

Parameters:

sessionId - Packet capture session id (required)

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

invocationConfig - Configuration for the method invocation.

terminate

PacketCaptureSession terminate(java.lang.String sessionId)

Terminate the packet capture session by session id.

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

Parameters:

sessionId - Packet capture session id (required)

Returns:

com.vmware.nsx.model.PacketCaptureSession

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

terminate

PacketCaptureSession terminate(java.lang.String sessionId,
                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Terminate the packet capture session by session 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:

sessionId - Packet capture session id (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.PacketCaptureSession

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

terminate

void terminate(java.lang.String sessionId,
               com.vmware.vapi.bindings.client.AsyncCallback<PacketCaptureSession> asyncCallback)

Terminate the packet capture session by session id.

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

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

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

Parameters:

sessionId - Packet capture session id (required)

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

terminate

void terminate(java.lang.String sessionId,
               com.vmware.vapi.bindings.client.AsyncCallback<PacketCaptureSession> asyncCallback,
               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Terminate the packet capture session by session 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.PacketCaptureSession

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

Parameters:

sessionId - Packet capture session id (required)

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

invocationConfig - Configuration for the method invocation.