vmware::vcenter::vm::console::Tickets Interface Reference

The Tickets interface provides methods for managing the virtual machine console tickets. More...

Inherited by vmware::vcenter::vm::console::TicketsStub.

List of all members.

Public Member Functions
vmware.vcenter.vm.console.TicketsTypes.Summary	Create (string vm, vmware.vcenter.vm.console.TicketsTypes.CreateSpec spec)
	Creates a virtual machine console ticket of a given ticket type.
vmware.vcenter.vm.console.TicketsTypes.Summary	Create (string vm, vmware.vcenter.vm.console.TicketsTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Creates a virtual machine console ticket of a given ticket type.
global::System.Threading.Tasks.Task < vmware.vcenter.vm.console.TicketsTypes.Summary >	CreateAsync (string vm, vmware.vcenter.vm.console.TicketsTypes.CreateSpec spec)
	Creates a virtual machine console ticket of a given ticket type.
global::System.Threading.Tasks.Task < vmware.vcenter.vm.console.TicketsTypes.Summary >	CreateAsync (string vm, vmware.vcenter.vm.console.TicketsTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Creates a virtual machine console ticket of a given ticket type.

---

Detailed Description

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.

---

Member Function Documentation

vmware.vcenter.vm.console.TicketsTypes.Summary vmware::vcenter::vm::console::Tickets::Create	(	string	vm,
		vmware.vcenter.vm.console.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 Tickets.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 Tickets.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.

Exceptions:

vmware.vapi.std.errors.Error

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

vmware.vapi.std.errors.InvalidArgument

if the field contains a value that is not supported by the server. Exceptions: vmware.vapi.std.errors.NotAllowedInCurrentState if the virtual machine is powered off and requested ticket type is Tickets.Type.WEBMKS vmware.vapi.std.errors.NotFound if the virtual machine is not found. vmware.vapi.std.errors.ResourceInaccessible if the virtual machine's configuration or execution state cannot be accessed. vmware.vapi.std.errors.ServiceUnavailable if the system is unable to communicate with a service to complete the request. vmware.vapi.std.errors.Unauthenticated if the user can not be authenticated. 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.

Returns:

Commonly used information about the virtual machine console ticket.

Implemented in vmware::vcenter::vm::console::TicketsStub.

vmware.vcenter.vm.console.TicketsTypes.Summary vmware::vcenter::vm::console::Tickets::Create	(	string	vm,
		vmware.vcenter.vm.console.TicketsTypes.CreateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.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 Tickets.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 Tickets.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.

Exceptions:

vmware.vapi.std.errors.Error

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

vmware.vapi.std.errors.InvalidArgument

if the field contains a value that is not supported by the server. Exceptions: vmware.vapi.std.errors.NotAllowedInCurrentState if the virtual machine is powered off and requested ticket type is Tickets.Type.WEBMKS vmware.vapi.std.errors.NotFound if the virtual machine is not found. vmware.vapi.std.errors.ResourceInaccessible if the virtual machine's configuration or execution state cannot be accessed. vmware.vapi.std.errors.ServiceUnavailable if the system is unable to communicate with a service to complete the request. vmware.vapi.std.errors.Unauthenticated if the user can not be authenticated. 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. _progress Progress notification call back _invocationConfig Configuration for the method invocation

Returns:

Commonly used information about the virtual machine console ticket.

Implemented in vmware::vcenter::vm::console::TicketsStub.

global::System.Threading.Tasks.Task<vmware.vcenter.vm.console.TicketsTypes.Summary> vmware::vcenter::vm::console::Tickets::CreateAsync	(	string	vm,
		vmware.vcenter.vm.console.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 Tickets.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 Tickets.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.

Exceptions:

vmware.vapi.std.errors.Error

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

vmware.vapi.std.errors.InvalidArgument

if the field contains a value that is not supported by the server. Exceptions: vmware.vapi.std.errors.NotAllowedInCurrentState if the virtual machine is powered off and requested ticket type is Tickets.Type.WEBMKS vmware.vapi.std.errors.NotFound if the virtual machine is not found. vmware.vapi.std.errors.ResourceInaccessible if the virtual machine's configuration or execution state cannot be accessed. vmware.vapi.std.errors.ServiceUnavailable if the system is unable to communicate with a service to complete the request. vmware.vapi.std.errors.Unauthenticated if the user can not be authenticated. 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.

Returns:

Commonly used information about the virtual machine console ticket.

Implemented in vmware::vcenter::vm::console::TicketsStub.

global::System.Threading.Tasks.Task<vmware.vcenter.vm.console.TicketsTypes.Summary> vmware::vcenter::vm::console::Tickets::CreateAsync	(	string	vm,
		vmware.vcenter.vm.console.TicketsTypes.CreateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.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 Tickets.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 Tickets.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.

Exceptions:

vmware.vapi.std.errors.Error

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

vmware.vapi.std.errors.InvalidArgument

if the field contains a value that is not supported by the server. Exceptions: vmware.vapi.std.errors.NotAllowedInCurrentState if the virtual machine is powered off and requested ticket type is Tickets.Type.WEBMKS vmware.vapi.std.errors.NotFound if the virtual machine is not found. vmware.vapi.std.errors.ResourceInaccessible if the virtual machine's configuration or execution state cannot be accessed. vmware.vapi.std.errors.ServiceUnavailable if the system is unable to communicate with a service to complete the request. vmware.vapi.std.errors.Unauthenticated if the user can not be authenticated. 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. _progress Progress notification call back _invocationConfig Configuration for the method invocation

Returns:

Commonly used information about the virtual machine console ticket.

Implemented in vmware::vcenter::vm::console::TicketsStub.

---

The documentation for this interface was generated from the following file:

• Tickets.cs