vm.get_display_web_uri

Retrieve Display URI for a given VM or appropriate error if there is no display device available or if it is not configured to use web interface

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

ID of the virtual machine to get display web URI for.

Parameter 2: host

host

Type: string Default: ""

Hostname or IP address to use in the URI. Empty string for automatic detection.

Parameter 3: options

options

Type: object Default: {"protocol": "HTTP"}

Options for generating the web display URI.

No Additional Properties

protocol

Protocol

Type: enum (of string) Default: "HTTP"

Protocol to use for the web display URI (HTTP or HTTPS).

Must be one of:

• "HTTP"
• "HTTPS"

Return value

VMGetDisplayWebUriResult

Type: object

VMGetDisplayWebUriResult return fields.

No Additional Properties

error Required

Error

Error message if URI generation failed. null on success.

Any of

• Option 1
• Option 2

Type: string

Type: null

uri Required

Uri

Generated web URI for accessing the VM display. null on error.

Any of

• Option 1
• Option 2

Type: string

Type: null

Required roles: VM_READ