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

.. raw:: html

    <div id="json-schema">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    <div class="accordion" id="accordionCall_parameters">
    <div class="card">
    <div class="card-header" id="headingCall_parameters">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters" data-toggle="collapse" onclick="setAnchor('#Call_parameters')" type="button"><span class="property-name">Call parameters</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters" class="collapse property-definition-div" data-parent="#accordionCall_parameters" id="Call_parameters">
    <div class="card-body pl-5">
    <span class="badge badge-dark value-type">Type: array</span><br/>
    <span class="badge badge-info no-additional">No Additional Items</span><h4>Tuple Validation</h4>
    <h5>Parameter 1: id</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>id</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>ID of the virtual machine to get display web URI for.</p>
    </span>
    </div>
    </div>
    <h5>Parameter 2: host</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i1">
    <h4>host</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: ""</span><br/>
    <span class="description"><p>Hostname or IP address to use in the URI. Empty string for automatic detection.</p>
    </span>
    </div>
    </div>
    <h5>Parameter 3: options</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i2">
    <h4>options</h4><span class="badge badge-dark value-type">Type: object</span> <span class="badge badge-success default-value">Default: {"protocol": "HTTP"}</span><br/>
    <span class="description"><p>Options for generating the web display URI.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i2_protocol">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i2_protocol">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i2_protocol" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i2_protocol" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i2_protocol')" type="button"><span class="property-name">protocol</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i2_protocol" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i2_protocol" id="Call_parameters_items_i2_protocol">
    <div class="card-body pl-5">
    <h4>Protocol</h4><span class="badge badge-dark value-type">Type: enum (of string)</span> <span class="badge badge-success default-value">Default: "HTTP"</span><br/>
    <span class="description"><p>Protocol to use for the web display URI (HTTP or HTTPS).</p>
    </span><div class="enum-value" id="Call_parameters_items_i2_protocol_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"HTTP"</li><li class="list-group-item enum-item">"HTTPS"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value">
    <div class="card">
    <div class="card-header" id="headingReturn_value">
    <h2 class="mb-0">
    <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value">
    <div class="card-body pl-5">
    <h4>VMGetDisplayWebUriResult</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>VMGetDisplayWebUriResult return fields.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_error">
    <div class="card">
    <div class="card-header" id="headingReturn_value_error">
    <h2 class="mb-0">
    <button aria-controls="Return_value_error" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_error" data-toggle="collapse" onclick="setAnchor('#Return_value_error')" type="button"><span class="property-name">error</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_error" class="collapse property-definition-div" data-parent="#accordionReturn_value_error" id="Return_value_error">
    <div class="card-body pl-5">
    <h4>Error</h4><br/>
    <span class="description"><p>Error message if URI generation failed. <code>null</code> on success.</p>
    </span><div class="any-of-value" id="Return_value_error_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_error_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_error_anyOf_i0" id="Return_value_error_anyOf_i0" onclick="setAnchor('#Return_value_error_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_error_anyOf_i1" id="Return_value_error_anyOf_i1" onclick="setAnchor('#Return_value_error_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_error_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_error_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_uri">
    <div class="card">
    <div class="card-header" id="headingReturn_value_uri">
    <h2 class="mb-0">
    <button aria-controls="Return_value_uri" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_uri" data-toggle="collapse" onclick="setAnchor('#Return_value_uri')" type="button"><span class="property-name">uri</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_uri" class="collapse property-definition-div" data-parent="#accordionReturn_value_uri" id="Return_value_uri">
    <div class="card-body pl-5">
    <h4>Uri</h4><br/>
    <span class="description"><p>Generated web URI for accessing the VM display. <code>null</code> on error.</p>
    </span><div class="any-of-value" id="Return_value_uri_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_uri_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_uri_anyOf_i0" id="Return_value_uri_anyOf_i0" onclick="setAnchor('#Return_value_uri_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_uri_anyOf_i1" id="Return_value_uri_anyOf_i1" onclick="setAnchor('#Return_value_uri_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_uri_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_uri_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* VM_READ