com.vmware.vcenter.vm.console

Interface Tickets

All Superinterfaces:

Service, TicketsTypes

All Known Implementing Classes:

TicketsStub

public interface Tickets
extends Service, TicketsTypes

The Tickets interface provides methods for managing the virtual machine console tickets. Warning: This interface is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.vm.console.TicketsTypes

TicketsTypes.CreateSpec, TicketsTypes.Summary, TicketsTypes.Type

Field Summary

Fields inherited from interface com.vmware.vcenter.vm.console.TicketsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
TicketsTypes.Summary	create(java.lang.String vm, TicketsTypes.CreateSpec spec) Creates a virtual machine console ticket of a given ticket type.
void	create(java.lang.String vm, TicketsTypes.CreateSpec spec, AsyncCallback<TicketsTypes.Summary> asyncCallback) Creates a virtual machine console ticket of a given ticket type.
void	create(java.lang.String vm, TicketsTypes.CreateSpec spec, AsyncCallback<TicketsTypes.Summary> asyncCallback, InvocationConfig invocationConfig) Creates a virtual machine console ticket of a given ticket type.
TicketsTypes.Summary	create(java.lang.String vm, TicketsTypes.CreateSpec spec, InvocationConfig invocationConfig) Creates a virtual machine console ticket of a given ticket type.

Method Detail

create

TicketsTypes.Summary create(java.lang.String vm,
                            TicketsTypes.CreateSpec spec)

Creates a virtual machine console ticket of a given ticket type. The created ticket is a one time use URI. The validity of the ticket is 30 minutes, if not used with in the time frame the ticket expires.

The TicketsTypes.Type.VMRC ticket contains the IP address or the DNS resolvable name of the vCenter server. This ticket requires installation of VMware Workstation, VMware Fusion or VMRC to be installed on the machine where the ticket has to be opened. This ticket can be acquired even when the VM is turned off.

The TicketsTypes.Type.WEBMKS ticket contains the IP address of the DNS resolvable name of the ESX server. This ticket requires user to embed this ticket in a HTML page using VMware HTML Console SDK - https://www.vmware.com/support/developer/html-console This ticket can be acquired only when the VM is turned on.

. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

spec - Specification for the console ticket to be created.

Returns:

Commonly used information about the virtual machine console ticket.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - if the {@link CreateSpec#type) property contains a value that is not supported by the server.

NotAllowedInCurrentState - if the virtual machine is powered off and requested ticket type is TicketsTypes.Type.WEBMKS

NotFound - if the virtual machine is not found.

ResourceInaccessible - if the virtual machine's configuration or execution state cannot be accessed.

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.

create

TicketsTypes.Summary create(java.lang.String vm,
                            TicketsTypes.CreateSpec spec,
                            InvocationConfig invocationConfig)

Creates a virtual machine console ticket of a given ticket type. The created ticket is a one time use URI. The validity of the ticket is 30 minutes, if not used with in the time frame the ticket expires.

The TicketsTypes.Type.VMRC ticket contains the IP address or the DNS resolvable name of the vCenter server. This ticket requires installation of VMware Workstation, VMware Fusion or VMRC to be installed on the machine where the ticket has to be opened. This ticket can be acquired even when the VM is turned off.

The TicketsTypes.Type.WEBMKS ticket contains the IP address of the DNS resolvable name of the ESX server. This ticket requires user to embed this ticket in a HTML page using VMware HTML Console SDK - https://www.vmware.com/support/developer/html-console This ticket can be acquired only when the VM is turned on.

. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

spec - Specification for the console ticket to be created.

invocationConfig - Configuration for the method invocation.

Returns:

Commonly used information about the virtual machine console ticket.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - if the {@link CreateSpec#type) property contains a value that is not supported by the server.

NotAllowedInCurrentState - if the virtual machine is powered off and requested ticket type is TicketsTypes.Type.WEBMKS

NotFound - if the virtual machine is not found.

ResourceInaccessible - if the virtual machine's configuration or execution state cannot be accessed.

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.

create

void create(java.lang.String vm,
            TicketsTypes.CreateSpec spec,
            AsyncCallback<TicketsTypes.Summary> asyncCallback)

Creates a virtual machine console ticket of a given ticket type. The created ticket is a one time use URI. The validity of the ticket is 30 minutes, if not used with in the time frame the ticket expires.

The TicketsTypes.Type.VMRC ticket contains the IP address or the DNS resolvable name of the vCenter server. This ticket requires installation of VMware Workstation, VMware Fusion or VMRC to be installed on the machine where the ticket has to be opened. This ticket can be acquired even when the VM is turned off.

The TicketsTypes.Type.WEBMKS ticket contains the IP address of the DNS resolvable name of the ESX server. This ticket requires user to embed this ticket in a HTML page using VMware HTML Console SDK - https://www.vmware.com/support/developer/html-console This ticket can be acquired only when the VM is turned on.

. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

Invocation Result:
Commonly used information about the virtual machine console ticket.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if the CreateSpec#type) property contains a value that is not supported by the server.
{@link com.vmware.vapi.std.errors.NotAllowedInCurrentState} - if the virtual machine is powered off and requested ticket type is {@link com.vmware.vcenter.vm.console.TicketsTypes.Type#WEBMKS}
{@link com.vmware.vapi.std.errors.NotFound} - if the virtual machine is not found.
{@link com.vmware.vapi.std.errors.ResourceInaccessible} - if the virtual machine's configuration or execution state cannot be accessed.
{@link com.vmware.vapi.std.errors.ServiceUnavailable} - if the system is unable to communicate with a service to complete the request.
{@link com.vmware.vapi.std.errors.Unauthenticated} - if the user can not be authenticated.
{@link com.vmware.vapi.std.errors.Unauthorized} - if the user doesn't have the required privileges.

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

spec - Specification for the console ticket to be created.

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

create

void create(java.lang.String vm,
            TicketsTypes.CreateSpec spec,
            AsyncCallback<TicketsTypes.Summary> asyncCallback,
            InvocationConfig invocationConfig)

Creates a virtual machine console ticket of a given ticket type. The created ticket is a one time use URI. The validity of the ticket is 30 minutes, if not used with in the time frame the ticket expires.

The TicketsTypes.Type.VMRC ticket contains the IP address or the DNS resolvable name of the vCenter server. This ticket requires installation of VMware Workstation, VMware Fusion or VMRC to be installed on the machine where the ticket has to be opened. This ticket can be acquired even when the VM is turned off.

The TicketsTypes.Type.WEBMKS ticket contains the IP address of the DNS resolvable name of the ESX server. This ticket requires user to embed this ticket in a HTML page using VMware HTML Console SDK - https://www.vmware.com/support/developer/html-console This ticket can be acquired only when the VM is turned on.

. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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:
Commonly used information about the virtual machine console ticket.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if the CreateSpec#type) property contains a value that is not supported by the server.
{@link com.vmware.vapi.std.errors.NotAllowedInCurrentState} - if the virtual machine is powered off and requested ticket type is {@link com.vmware.vcenter.vm.console.TicketsTypes.Type#WEBMKS}
{@link com.vmware.vapi.std.errors.NotFound} - if the virtual machine is not found.
{@link com.vmware.vapi.std.errors.ResourceInaccessible} - if the virtual machine's configuration or execution state cannot be accessed.
{@link com.vmware.vapi.std.errors.ServiceUnavailable} - if the system is unable to communicate with a service to complete the request.
{@link com.vmware.vapi.std.errors.Unauthenticated} - if the user can not be authenticated.
{@link com.vmware.vapi.std.errors.Unauthorized} - if the user doesn't have the required privileges.

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

spec - Specification for the console ticket to be created.

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

invocationConfig - Configuration for the method invocation.