- Timestamp:
- Apr 13, 2022 10:52:27 PM (3 years ago)
- Location:
- trunk/src/VBox/Main/idl
- Files:
-
- 2 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/VBox/Main/idl/VirtualBox.dtd
r85310 r94601 64 64 for webservice APIs that have no counterpart in COM and are hard-coded in 65 65 the webservice server, such as IManagedObjectReference and ISessionManager. --> 66 <!ATTLIST interface rest (managed|suppress) "suppress"> 67 <!-- rest specifies how this interface is mapped to the 68 web services API (RESTful). One of the following must be specified: 69 managed: objects of this type are represented 70 suppress: the default value, skip this interface entirely --> 66 71 <!ATTLIST interface autogen CDATA #IMPLIED> 67 72 <!-- autogen names the style of code auto-generation for this … … 97 102 <!ATTLIST attribute safearray (yes|no) "no"> 98 103 <!ATTLIST attribute wsmap (managed|suppress) "managed"> 104 <!ATTLIST attribute rest (uuid|suppress|default) "default"> 99 105 <!ATTLIST attribute wrap-hint-server CDATA #IMPLIED> 100 106 <!-- DTrace has a probe name length limit, so dtracename helps dealing with excessivly long names. --> 101 107 <!ATTLIST attribute dtracename CDATA #IMPLIED> 102 <!ELEMENT method ( desc?,param*,result*)> <!-- done -->108 <!ELEMENT method (rest?,desc?,param*,result*)> <!-- done --> 103 109 <!ATTLIST method name CDATA #REQUIRED> 104 110 <!ATTLIST method const CDATA "no"> … … 108 114 <!-- DTrace has a probe name length limit, so dtracename helps dealing with excessivly long names. --> 109 115 <!ATTLIST method dtracename CDATA #IMPLIED> 116 <!ELEMENT rest ANY> <!-- done --> 117 <!ATTLIST rest name CDATA #IMPLIED> 118 <!ATTLIST rest request (get|put|post|delete|patch) "get"> 119 <!ATTLIST rest path CDATA #REQUIRED> 110 120 <!ELEMENT param (desc?)> <!-- done --> 111 121 <!ATTLIST param name CDATA #REQUIRED> -
trunk/src/VBox/Main/idl/VirtualBox.xidl
r94533 r94601 1765 1765 supportsErrorInfo="no" 1766 1766 wsmap="managed" 1767 rest="managed" 1767 1768 > 1768 1769 <desc> … … 1870 1871 uuid="4fdebbf0-be30-49c0-b315-e9749e1bded1" 1871 1872 wsmap="managed" 1873 rest="managed" 1872 1874 reservedMethods="2" reservedAttributes="8" 1873 1875 > … … 1923 1925 1924 1926 <method name="addLocalMapping"> 1927 <rest request="post" path="/natnetworks/{networkid}/configuration/"/> 1925 1928 <desc> 1926 1929 </desc> … … 1940 1943 </attribute> 1941 1944 <method name="addPortForwardRule"> 1945 <rest request="post" path="/natnetworks/{networkid}/configuration/"/> 1942 1946 <param name="isIpv6" type="boolean" dir="in"/> 1943 1947 <param name="ruleName" type="wstring" dir="in"/> … … 1963 1967 </method> 1964 1968 <method name="removePortForwardRule"> 1969 <rest request="post" path="/natnetworks/{networkid}/configuration/"/> 1965 1970 <param name="iSipv6" type="boolean" dir="in"/> 1966 1971 <param name="ruleName" type="wstring" dir="in"/> 1967 1972 </method> 1968 <method name="start"/> 1969 <method name="stop"/> 1973 <method name="start"> 1974 <rest request="post" path="/natnetworks/{networkid}/actions/"/> 1975 </method> 1976 <method name="stop"> 1977 <rest request="post" path="/natnetworks/{networkid}/actions/"/> 1978 </method> 1970 1979 </interface> 1971 1980 … … 1979 1988 uuid="d8e3496e-735f-4fde-8a54-427d49409b5f" 1980 1989 wsmap="managed" 1990 rest="managed" 1981 1991 reservedMethods="4" reservedAttributes="12" 1982 1992 > … … 2014 2024 uuid="6eb5de7d-9a67-4fde-83be-f768084d03b5" 2015 2025 wsmap="managed" 2026 rest="managed" 2016 2027 reservedMethods="4" reservedAttributes="8" 2017 2028 > … … 2179 2190 uuid="cadef0a2-a1a9-4ac2-8e80-c049af69dac8" 2180 2191 wsmap="managed" 2192 rest="managed" 2181 2193 reservedMethods="0" reservedAttributes="3" 2182 2194 > … … 2258 2270 --> 2259 2271 <method name="setConfiguration"> 2272 <rest request="post" path="/dhcpservers/{serverid}/configuration/"/> 2260 2273 <desc> 2261 2274 configures the server … … 2287 2300 2288 2301 <method name="start"> 2302 <rest request="post" path="/dhcpservers/{serverid}/actions/"/> 2289 2303 <desc> 2290 2304 Starts DHCP server process. … … 2306 2320 2307 2321 <method name="stop"> 2322 <rest request="post" path="/dhcpservers/{serverid}/actions/"/> 2308 2323 <desc> 2309 2324 Stops DHCP server process. … … 2315 2330 2316 2331 <method name="restart"> 2332 <rest request="post" path="/dhcpservers/{serverid}/actions/"/> 2317 2333 <desc> 2318 2334 Restart running DHCP server process. … … 2354 2370 2355 2371 <method name="getConfig"> 2372 <rest request="get" path="/dhcpservers/{serverid}/configuration/"/> 2356 2373 <desc> 2357 2374 Gets or adds a configuration. … … 2394 2411 uuid="00f4a8dc-0002-4b81-0077-1dcb004571ba" 2395 2412 wsmap="managed" 2413 rest="managed" 2396 2414 reservedMethods="8" reservedAttributes="16" 2397 2415 > … … 2507 2525 uuid="46735de7-f4c4-4020-a185-0d2881bcfa8b" 2508 2526 wsmap="managed" 2527 rest="managed" 2509 2528 reservedMethods="4" reservedAttributes="4" 2510 2529 > … … 2519 2538 uuid="5ca9e537-5a1d-43f1-6f27-6a0db298a9a8" 2520 2539 wsmap="managed" 2540 rest="managed" 2521 2541 reservedMethods="3" reservedAttributes="3" 2522 2542 > … … 2539 2559 uuid="537707f7-ebf9-4d5c-7aea-877bfc4256ba" 2540 2560 wsmap="managed" 2561 rest="managed" 2541 2562 reservedMethods="8" reservedAttributes="8" 2542 2563 > … … 2576 2597 uuid="c40c2b86-73a5-46cc-8227-93fe57d006a6" 2577 2598 wsmap="managed" 2599 rest="managed" 2578 2600 reservedMethods="8" reservedAttributes="8" 2579 2601 > … … 2611 2633 uuid="6c59f776-3693-4801-8ebf-17e005a62e0c" 2612 2634 wsmap="managed" 2635 rest="managed" 2636 wrap-gen-hook="yes" 2613 2637 reservedMethods="8" reservedAttributes="12" 2614 wrap-gen-hook="yes"2615 2638 > 2616 2639 <desc> … … 2849 2872 2850 2873 <method name="composeMachineFilename"> 2874 <rest request="get" path="/server/methods/"/> 2851 2875 <desc> 2852 2876 Returns a recommended full path of the settings file name for a new virtual … … 2906 2930 2907 2931 <method name="createMachine"> 2932 <rest name="create" request="post" path="/vms/"/> 2908 2933 <desc> 2909 2934 Creates a new virtual machine by creating a machine settings file at … … 3012 3037 3013 3038 <method name="openMachine"> 3039 <rest name="open" request="post" path="/vms/{vmid}/actions/"/> 3014 3040 <desc> 3015 3041 Opens a virtual machine from the existing settings file. … … 3042 3068 3043 3069 <method name="registerMachine"> 3070 <rest name="register" request="post" path="/vms/{vmid}/actions/"/> 3044 3071 <desc> 3045 3072 … … 3067 3094 3068 3095 <method name="findMachine" const="yes"> 3096 <rest name="find" request="get" path="/vms/{vmid}/"/> 3069 3097 <desc> 3070 3098 Attempts to find a virtual machine given its name or UUID. … … 3087 3115 3088 3116 <method name="getMachinesByGroups"> 3117 <rest request="get" path="/server/methods/"/> 3089 3118 <desc> 3090 3119 Gets all machine references which are in one of the specified groups. … … 3101 3130 3102 3131 <method name="getMachineStates"> 3132 <rest request="get" path="/server/methods/"/> 3103 3133 <desc> 3104 3134 Gets the state of several machines in a single operation. … … 3113 3143 3114 3144 <method name="createAppliance"> 3145 <rest name="create" request="post" path="/appliances/"/> 3115 3146 <desc> 3116 3147 Creates a new appliance object, which represents an appliance in the Open Virtual Machine … … 3124 3155 3125 3156 <method name="createUnattendedInstaller"> 3157 <rest request="post" path="/server/methods/"/> 3126 3158 <desc> 3127 3159 Creates a new <link to="IUnattended"/> guest installation object. This can be used to … … 3135 3167 3136 3168 <method name="createMedium"> 3169 <rest name="create" request="post" path="/mediums/"/> 3137 3170 <desc> 3138 3171 Creates a new base medium object that will use the given storage … … 3213 3246 3214 3247 <method name="openMedium"> 3248 <rest request="post" path="/server/methods/"/> 3215 3249 <desc> 3216 3250 Finds existing media or opens a medium from an existing storage location. … … 3309 3343 3310 3344 <method name="getGuestOSType"> 3345 <rest request="get" path="/server/methods/"/> 3311 3346 <desc> 3312 3347 Returns an object describing the specified guest OS type. … … 3341 3376 3342 3377 <method name="createSharedFolder"> 3378 <rest name="create" request="post" path="/sharedfolders/"/> 3343 3379 <desc> 3344 3380 Creates a new global shared folder by associating the given logical … … 3373 3409 3374 3410 <method name="removeSharedFolder"> 3411 <rest name="remove" request="delete" path="/sharedfolders/"/> 3375 3412 <desc> 3376 3413 Removes the global shared folder with the given name previously … … 3388 3425 3389 3426 <method name="getExtraDataKeys"> 3427 <rest request="get" path="/server/methods/"/> 3390 3428 <desc> 3391 3429 Returns an array representing the global extra data keys which currently … … 3398 3436 3399 3437 <method name="getExtraData"> 3438 <rest request="get" path="/server/methods/"/> 3400 3439 <desc> 3401 3440 Returns associated global extra data. … … 3421 3460 3422 3461 <method name="setExtraData"> 3462 <rest request="put" path="/server/methods/"/> 3423 3463 <desc> 3424 3464 Sets associated global extra data. … … 3499 3539 3500 3540 <method name="createDHCPServer"> 3541 <rest name="create" request="post" path="/dhcpservers/"/> 3501 3542 <desc> 3502 3543 Creates a DHCP server settings to be used for the given internal network name … … 3514 3555 3515 3556 <method name="findDHCPServerByNetworkName"> 3557 <rest name="find" request="get" path="/dhcpservers/"/> 3516 3558 <desc> 3517 3559 Searches a DHCP server settings to be used for the given internal network name … … 3545 3587 3546 3588 <method name="removeDHCPServer"> 3589 <rest name="remove" request="delete" path="/dhcpservers/"/> 3547 3590 <desc> 3548 3591 Removes the DHCP server settings … … 3563 3606 servicing the guests. 3564 3607 --> 3608 <rest name="create" request="post" path="/natnetworks/"/> 3565 3609 <param name="networkName" type="wstring" dir="in"/> 3566 3610 <param name="network" type="INATNetwork" dir="return"/> … … 3571 3615 --> 3572 3616 <method name="findNATNetworkByName"> 3617 <rest name="find" request="get" path="/natnetworks/"/> 3573 3618 <param name="networkName" type="wstring" dir="in"/> 3574 3619 <param name="network" type="INATNetwork" dir="return"/> … … 3578 3623 --> 3579 3624 <method name="removeNATNetwork"> 3625 <rest name="remove" request="delete" path="/natnetworks/"/> 3580 3626 <param name="network" type="INATNetwork" dir="in"/> 3581 3627 </method> 3582 3628 3583 3629 <!-- bunch of methods to manage host-only networks --> 3630 <!-- 3631 Here we create a record in cloud network array with specified name. 3632 --> 3584 3633 <method name="createHostOnlyNetwork"> 3585 <!-- Here we create a record in cloud network array with specified name. 3586 --> 3634 <rest name="create" request="post" path="/hostonlynetworks/"/> 3587 3635 <param name="networkName" type="wstring" dir="in"/> 3588 3636 <param name="network" type="IHostOnlyNetwork" dir="return"/> … … 3600 3648 --> 3601 3649 <method name="findHostOnlyNetworkById"> 3650 <rest name="find" request="get" path="/hostonlynetworks/"/> 3602 3651 <desc> 3603 3652 Searches through all host networks for one with … … 3619 3668 --> 3620 3669 <method name="removeHostOnlyNetwork"> 3670 <rest name="remove" request="delete" path="/hostonlynetworks/"/> 3621 3671 <param name="network" type="IHostOnlyNetwork" dir="in"/> 3622 3672 </method> … … 3626 3676 <!-- Here we create a record in cloud network array with specified name. 3627 3677 --> 3678 <rest name="create" request="post" path="/cloudnetworks/"/> 3628 3679 <param name="networkName" type="wstring" dir="in"/> 3629 3680 <param name="network" type="ICloudNetwork" dir="return"/> … … 3634 3685 --> 3635 3686 <method name="findCloudNetworkByName"> 3687 <rest name="find" request="get" path="/cloudnetworks/"/> 3636 3688 <param name="networkName" type="wstring" dir="in"/> 3637 3689 <param name="network" type="ICloudNetwork" dir="return"/> … … 3641 3693 --> 3642 3694 <method name="removeCloudNetwork"> 3695 <rest name="remove" request="delete" path="/cloudnetworks/"/> 3643 3696 <param name="network" type="ICloudNetwork" dir="in"/> 3644 3697 </method> 3645 3698 3646 3699 <method name="checkFirmwarePresent"> 3700 <rest request="get" path="/server/methods/"/> 3647 3701 <desc> 3648 3702 Check if this VirtualBox installation has a firmware … … 3678 3732 3679 3733 <method name="findProgressById"> 3734 <rest name="find" request="get" path="/progresses/{progressid}/"/> 3680 3735 <desc> 3681 3736 Searches through all progress objects known to VBoxSVC for an … … 3889 3944 uuid="392f1de4-80e1-4a8a-93a1-67c5f92a838a" 3890 3945 wsmap="managed" 3946 rest="managed" 3891 3947 reservedAttributes="12" reservedMethods="2" 3892 3948 > … … 3989 4045 uuid="86a98347-7619-41aa-aece-b21ac5c1a7e6" 3990 4046 wsmap="managed" 4047 rest="managed" 3991 4048 reservedMethods="7" reservedAttributes="8" 3992 4049 > … … 4002 4059 file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If 4003 4060 this descriptor file references other files such as disk images, as OVF appliances typically 4004 do, those additional files must be in the same directory as the descriptor file.</li> 4005 4006 <li>If the appliance is distributed as a single file, it must be in TAR format and have the 4061 do, those additional files must be in the same directory as the descriptor file. 4062 </li> 4063 4064 <li>If the appliance is distributed as a single file, it must be in TAR format and have the 4007 4065 <tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor 4008 4066 files and optionally other files. 4009 4067 4010 4068 At this time, VirtualBox does not not yet support the packed (TAR) variant; support will 4011 be added with a later version.</li> 4069 be added with a later version. 4070 </li> 4012 4071 </ol> 4013 4072 … … 4138 4197 4139 4198 <method name="read"> 4199 <rest request="post" path="/appliances/{applianceid}/actions/"/> 4140 4200 <desc> 4141 4201 Reads an OVF file into the appliance object. … … 4157 4217 4158 4218 <method name="interpret"> 4219 <rest request="post" path="/appliances/{applianceid}/actions/"/> 4159 4220 <desc> 4160 4221 Interprets the OVF data that was read when the appliance was constructed. After … … 4174 4235 4175 4236 <method name="importMachines"> 4237 <rest request="post" path="/appliances/{applianceid}/actions/"/> 4176 4238 <desc> 4177 4239 Imports the appliance into VirtualBox by creating instances of <link to="IMachine" /> … … 4213 4275 4214 4276 <method name="write"> 4277 <rest request="post" path="/appliances/{applianceid}/actions/"/> 4215 4278 <desc> 4216 4279 Writes the contents of the appliance exports into a new OVF file. … … 4248 4311 4249 4312 <method name="getWarnings"> 4313 <rest request="get" path="/appliances/{applianceid}/configuration/"/> 4250 4314 <desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc> 4251 4315 … … 4256 4320 4257 4321 <method name="getPasswordIds"> 4322 <rest request="get" path="/appliances/{applianceid}/configuration/"/> 4258 4323 <desc> 4259 4324 Returns a list of password identifiers which must be supplied to import or export … … 4267 4332 4268 4333 <method name="getMediumIdsForPasswordId"> 4334 <rest request="get" path="/appliances/{applianceid}/configuration/"/> 4269 4335 <desc> 4270 4336 Returns a list of medium identifiers which use the given password identifier. … … 4280 4346 4281 4347 <method name="addPasswords"> 4348 <rest request="post" path="/appliances/{applianceid}/configuration/"/> 4282 4349 <desc> 4283 4350 Adds a list of passwords required to import or export encrypted virtual … … 4295 4362 4296 4363 <method name="createVirtualSystemDescriptions"> 4364 <rest request="post" path="/appliances/{applianceid}/configuration/"/> 4297 4365 <desc>Creates a number of <link to="IVirtualSystemDescription" /> objects and store them 4298 4366 in the <link to="#virtualSystemDescriptions" /> array. … … 4405 4473 uuid="01510f40-c196-4d26-b8db-4c8c389f1f82" 4406 4474 wsmap="managed" 4475 rest="managed" 4407 4476 reservedMethods="4" reservedAttributes="4" 4408 4477 > 4409 4478 4410 <desc>Represents one virtual system (machine) in an appliance. This interface is used in 4479 <desc> 4480 Represents one virtual system (machine) in an appliance. This interface is used in 4411 4481 the <link to="IAppliance::virtualSystemDescriptions" /> array. After 4412 4482 <link to="IAppliance::interpret" /> has been called, that array contains information … … 4678 4748 uuid="6f89464f-7773-436a-a4df-592e4e537fa0" 4679 4749 wsmap="managed" 4750 rest="managed" 4680 4751 reservedMethods="4" reservedAttributes="16" 4681 4752 > … … 5462 5533 uuid="f692806f-febe-4049-b476-1292a8e45b09" 5463 5534 wsmap="managed" 5535 rest="managed" 5464 5536 reservedMethods="4" reservedAttributes="8" 5465 5537 > … … 5505 5577 uuid="a0a7f210-b857-4468-be26-c29f36a84345" 5506 5578 wsmap="managed" 5579 rest="managed" 5507 5580 reservedMethods="2" reservedAttributes="8" 5508 5581 > … … 5753 5826 uuid="678fbd9a-93af-42a7-7f13-79ad6ef1a18d" 5754 5827 wsmap="managed" 5828 rest="managed" 5755 5829 > 5756 5830 … … 5937 6011 uuid="D88F2A5A-47C7-4A3F-AAE1-1B516817DB41" 5938 6012 wsmap="managed" 6013 rest="managed" 5939 6014 > 5940 6015 … … 5973 6048 uuid="c984d15f-e191-400b-840e-970f3dad7296" 5974 6049 wsmap="managed" 6050 rest="managed" 5975 6051 > 5976 6052 … … 6016 6092 uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5" 6017 6093 wsmap="struct" 6094 rest="managed" 6018 6095 > 6019 6096 … … 6464 6541 uuid="8d2e6ace-0162-4985-9424-37d17fd87657" 6465 6542 wsmap="managed" 6543 rest="managed" 6466 6544 wrap-hint-server-addinterfaces="IInternalMachineControl" 6467 6545 wrap-hint-server="manualaddinterfaces" … … 6509 6587 </desc> 6510 6588 6511 <attribute name="parent" type="IVirtualBox" readonly="yes" wrap-hint-server="limitedcaller" >6589 <attribute name="parent" type="IVirtualBox" readonly="yes" wrap-hint-server="limitedcaller" rest="suppress"> 6512 6590 <desc>Associated parent object.</desc> 6513 6591 </attribute> … … 6845 6923 </attribute> 6846 6924 6847 <attribute name="settingsAuxFilePath" type="wstring" readonly="yes" wrap-hint-server="limitedcaller" >6925 <attribute name="settingsAuxFilePath" type="wstring" readonly="yes" wrap-hint-server="limitedcaller" rest="suppress"> 6848 6926 <desc> 6849 6927 Full name of the file containing auxiliary machine settings data. … … 6851 6929 </attribute> 6852 6930 6853 <attribute name="settingsModified" type="boolean" readonly="yes" >6931 <attribute name="settingsModified" type="boolean" readonly="yes" rest="suppress"> 6854 6932 <desc> 6855 6933 Whether the settings of this machine have been modified … … 7210 7288 7211 7289 <method name="lockMachine"> 7290 <rest name="lock" request="post" path="/vms/{vmid}/actions/"/> 7212 7291 <desc> 7213 7292 Locks the machine for the given session to enable the caller … … 7309 7388 7310 7389 <method name="launchVMProcess"> 7390 <rest name="launch" request="post" path="/vms/{vmid}/actions/"/> 7311 7391 <desc> 7312 7392 Spawns a new process that will execute the virtual machine and obtains a shared … … 7418 7498 7419 7499 <method name="setBootOrder"> 7500 <rest name="bootorder" request="post" path="/vms/{vmid}/configuration/"/> 7420 7501 <desc> 7421 7502 Puts the given device to the specified position in … … 7450 7531 7451 7532 <method name="getBootOrder" const="yes"> 7533 <rest name="bootorder" request="get" path="/vms/{vmid}/configuration/"/> 7452 7534 <desc> 7453 7535 Returns the device type that occupies the specified … … 7484 7566 7485 7567 <method name="attachDevice"> 7568 <rest request="post" path="/vms/{vmid}/configuration/"/> 7486 7569 <desc> 7487 7570 Attaches a device and optionally mounts a medium to the given storage … … 7576 7659 </method> 7577 7660 7578 <method name="attachDeviceWithoutMedium"> 7661 <method name="attachDeviceWithoutMedium"> 7662 <rest request="post" path="/vms/{vmid}/configuration/"/> 7579 7663 <desc> 7580 7664 Attaches a device and optionally mounts a medium to the given storage … … 7662 7746 7663 7747 <method name="detachDevice"> 7748 <rest request="post" path="/vms/{vmid}/configuration/"/> 7664 7749 <desc> 7665 7750 Detaches the device attached to a device slot of the specified bus. … … 7708 7793 7709 7794 <method name="passthroughDevice"> 7795 <rest request="post" path="/vms/{vmid}/configuration/"/> 7710 7796 <desc> 7711 7797 Sets the passthrough mode of an existing DVD device. Changing the … … 7744 7830 7745 7831 <method name="temporaryEjectDevice"> 7832 <rest request="post" path="/vms/{vmid}/configuration/"/> 7746 7833 <desc> 7747 7834 Sets the behavior for guest-triggered medium eject. In some situations … … 7780 7867 7781 7868 <method name="nonRotationalDevice"> 7869 <rest request="post" path="/vms/{vmid}/configuration/"/> 7782 7870 <desc> 7783 7871 Sets a flag in the device information which indicates that the medium … … 7819 7907 7820 7908 <method name="setAutoDiscardForDevice"> 7909 <rest request="post" path="/vms/{vmid}/configuration/"/> 7821 7910 <desc> 7822 7911 Sets a flag in the device information which indicates that the medium … … 7858 7947 7859 7948 <method name="setHotPluggableForDevice"> 7949 <rest request="post" path="/vms/{vmid}/configuration/"/> 7860 7950 <desc> 7861 7951 Sets a flag in the device information which indicates that the attached … … 7898 7988 7899 7989 <method name="setBandwidthGroupForDevice"> 7990 <rest request="post" path="/vms/{vmid}/configuration/"/> 7900 7991 <desc> 7901 7992 Sets the bandwidth group of an existing storage device. … … 7932 8023 7933 8024 <method name="setNoBandwidthGroupForDevice"> 8025 <rest request="post" path="/vms/{vmid}/configuration/"/> 7934 8026 <desc> 7935 8027 Sets no bandwidth group for an existing storage device. … … 7961 8053 7962 8054 <method name="unmountMedium"> 8055 <rest name="unmount" request="post" path="/vms/{vmid}/mediums/{mediumid}/actions/"/> 7963 8056 <desc> 7964 8057 Unmounts any currently mounted medium (<link to="IMedium" />, … … 8013 8106 8014 8107 <method name="mountMedium"> 8108 <rest name="mount" request="post" path="/vms/{vmid}/mediums/{mediumid}/actions/"/> 8015 8109 <desc> 8016 8110 Mounts a medium (<link to="IMedium" />, identified … … 8067 8161 8068 8162 <method name="getMedium" const="yes"> 8163 <rest name="find" request="get" path="/vms/{vmid}/mediums/{mediumid}/"/> 8069 8164 <desc> 8070 8165 Returns the virtual medium attached to a device slot of the specified … … 8097 8192 8098 8193 <method name="getMediumAttachmentsOfController" const="yes"> 8194 <rest request="get" path="/vms/{vmid}/configuration/"/> 8099 8195 <desc> 8100 8196 Returns an array of medium attachments which are attached to the … … 8110 8206 8111 8207 <method name="getMediumAttachment" const="yes"> 8208 <rest request="get" path="/vms/{vmid}/configuration/"/> 8112 8209 <desc> 8113 8210 Returns a medium attachment which corresponds to the controller with … … 8125 8222 8126 8223 <method name="attachHostPCIDevice"> 8224 <rest request="post" path="/vms/{vmid}/configuration/"/> 8127 8225 <desc> 8128 8226 Attaches host PCI device with the given (host) PCI address to the … … 8157 8255 8158 8256 <method name="detachHostPCIDevice"> 8257 <rest request="post" path="/vms/{vmid}/configuration/"/> 8159 8258 <desc> 8160 8259 Detach host PCI device from the virtual machine. … … 8184 8283 8185 8284 <method name="getNetworkAdapter" const="yes"> 8285 <rest request="get" path="/vms/{vmid}/configuration/"/> 8186 8286 <desc> 8187 8287 Returns the network adapter associated with the given slot. … … 8201 8301 8202 8302 <method name="addStorageController"> 8303 <rest request="post" path="/vms/{vmid}/configuration/"/> 8203 8304 <desc> 8204 8305 Adds a new storage controller (SCSI, SAS or SATA controller) to the … … 8228 8329 8229 8330 <method name="getStorageControllerByName" const="yes"> 8331 <rest request="get" path="/vms/{vmid}/configuration/"/> 8230 8332 <desc> 8231 8333 Returns a storage controller with the given name. … … 8240 8342 8241 8343 <method name="getStorageControllerByInstance" const="yes"> 8344 <rest request="get" path="/vms/{vmid}/configuration/"/> 8242 8345 <desc> 8243 8346 Returns a storage controller of a specific storage bus … … 8254 8357 8255 8358 <method name="removeStorageController"> 8359 <rest request="post" path="/vms/{vmid}/configuration/"/> 8256 8360 <desc> 8257 8361 Removes a storage controller from the machine with all devices attached to it. … … 8269 8373 8270 8374 <method name="setStorageControllerBootable"> 8375 <rest request="post" path="/vms/{vmid}/configuration/"/> 8271 8376 <desc> 8272 8377 Sets the bootable flag of the storage controller with the given name. … … 8284 8389 8285 8390 <method name="addUSBController"> 8391 <rest request="post" path="/vms/{vmid}/configuration/"/> 8286 8392 <desc> 8287 8393 Adds a new USB controller to the machine and returns it as an instance of … … 8301 8407 8302 8408 <method name="removeUSBController"> 8409 <rest request="post" path="/vms/{vmid}/configuration/"/> 8303 8410 <desc> 8304 8411 Removes a USB controller from the machine. … … 8312 8419 8313 8420 <method name="getUSBControllerByName" const="yes"> 8421 <rest request="get" path="/vms/{vmid}/configuration/"/> 8314 8422 <desc> 8315 8423 Returns a USB controller with the given type. … … 8324 8432 8325 8433 <method name="getUSBControllerCountByType" const="yes"> 8434 <rest request="get" path="/vms/{vmid}/configuration/"/> 8326 8435 <desc> 8327 8436 Returns the number of USB controllers of the given type attached to the VM. … … 8332 8441 8333 8442 <method name="getSerialPort" const="yes"> 8443 <rest request="get" path="/vms/{vmid}/configuration/"/> 8334 8444 <desc> 8335 8445 Returns the serial port associated with the given slot. … … 8349 8459 8350 8460 <method name="getParallelPort" const="yes"> 8461 <rest request="get" path="/vms/{vmid}/configuration/"/> 8351 8462 <desc> 8352 8463 Returns the parallel port associated with the given slot. … … 8366 8477 8367 8478 <method name="getExtraDataKeys"> 8368 <desc> 8479 <rest request="get" path="/vms/{vmid}/configuration/"/> 8480 <desc> 8369 8481 Returns an array representing the machine-specific extra data keys 8370 8482 which currently have values defined. 8371 8372 8373 8374 8483 </desc> 8484 <param name="keys" type="wstring" dir="return" safearray="yes"> 8485 <desc>Array of extra data keys.</desc> 8486 </param> 8375 8487 </method> 8376 8488 8377 8489 <method name="getExtraData"> 8490 <rest request="get" path="/vms/{vmid}/configuration/"/> 8378 8491 <desc> 8379 8492 Returns associated machine-specific extra data. … … 8399 8512 8400 8513 <method name="setExtraData"> 8514 <rest request="post" path="/vms/{vmid}/configuration/"/> 8401 8515 <desc> 8402 8516 Sets associated machine-specific extra data. … … 8447 8561 8448 8562 <method name="getCPUProperty" const="yes"> 8563 <rest request="get" path="/vms/{vmid}/configuration/"/> 8449 8564 <desc> 8450 8565 Returns the virtual CPU boolean value of the specified property. … … 8468 8583 8469 8584 <method name="setCPUProperty"> 8585 <rest request="post" path="/vms/{vmid}/configuration/"/> 8470 8586 <desc> 8471 8587 Sets the virtual CPU boolean value of the specified property. … … 8667 8783 8668 8784 <method name="getHWVirtExProperty" const="yes"> 8785 <rest request="get" path="/vms/{vmid}/configuration/"/> 8669 8786 <desc> 8670 8787 Returns the value of the specified hardware virtualization boolean property. … … 8688 8805 8689 8806 <method name="setHWVirtExProperty"> 8807 <rest request="post" path="/vms/{vmid}/configuration/"/> 8690 8808 <desc> 8691 8809 Sets a new value for the specified hardware virtualization boolean property. … … 8709 8827 8710 8828 <method name="setSettingsFilePath"> 8829 <rest request="post" path="/vms/{vmid}/configuration/"/> 8711 8830 <desc> 8712 8831 Currently, it is an error to change this property on any machine. … … 8738 8857 8739 8858 <method name="saveSettings"> 8859 <rest request="post" path="/vms/{vmid}/configuration/"/> 8740 8860 <desc> 8741 8861 Saves any changes to machine settings made since the session … … 8772 8892 8773 8893 <method name="discardSettings"> 8894 <rest request="post" path="/vms/{vmid}/configuration/"/> 8774 8895 <desc> 8775 8896 Discards any changes to the machine settings made since the session … … 8793 8914 8794 8915 <method name="unregister" wrap-hint-server="limitedcaller,passcaller"> 8916 <rest request="post" path="/vms/{vmid}/actions/"/> 8795 8917 <desc> 8796 8918 Unregisters a machine previously registered with … … 8875 8997 8876 8998 <method name="deleteConfig"> 8999 <rest name="remove" request="delete" path="/vms/{vmid}/"/> 8877 9000 <desc> 8878 9001 Deletes the files associated with this machine from disk. If medium objects are passed … … 8926 9049 8927 9050 <method name="exportTo"> 9051 <rest name="export" request="post" path="/vms/{vmid}/actions/"/> 8928 9052 <desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the 8929 9053 steps required to export VirtualBox machines to OVF. … … 8942 9066 8943 9067 <method name="findSnapshot"> 9068 <rest request="get" path="/vms/{vmid}/configuration/"/> 8944 9069 <desc> 8945 9070 Returns a snapshot of this machine with the given name or UUID. … … 8965 9090 8966 9091 <method name="createSharedFolder"> 9092 <rest request="post" path="/vms/{vmid}/methods/"/> 8967 9093 <desc> 8968 9094 Creates a new permanent shared folder by associating the given logical … … 9001 9127 9002 9128 <method name="removeSharedFolder"> 9129 <rest request="delete" path="/vms/{vmid}/methods/"/> 9003 9130 <desc> 9004 9131 Removes the permanent shared folder with the given name previously … … 9075 9202 9076 9203 <method name="getGuestProperty" const="yes"> 9204 <rest name="Property" request="get" path="/vms/{vmid}/guest/"/> 9205 9077 9206 <desc> 9078 9207 Reads an entry from the machine's guest property store. … … 9153 9282 9154 9283 <method name="setGuestProperty"> 9284 <rest name="Property" request="patch" path="/vms/{vmid}/guest/"/> 9155 9285 <desc> 9156 9286 Sets, changes or deletes an entry in the machine's guest property … … 9224 9354 9225 9355 <method name="deleteGuestProperty" const="yes"> 9356 <rest name="Property" request="delete" path="/vms/{vmid}/guest/"/> 9226 9357 <desc> 9227 9358 Deletes an entry from the machine's guest property store. … … 9400 9531 9401 9532 <method name="hotPlugCPU"> 9533 <rest request="post" path="/vms/{vmid}/configuration/"/> 9402 9534 <desc> 9403 9535 Plugs a CPU into the machine. … … 9411 9543 9412 9544 <method name="hotUnplugCPU"> 9545 <rest request="post" path="/vms/{vmid}/configuration/"/> 9413 9546 <desc> 9414 9547 Removes a CPU from the machine. … … 9422 9555 9423 9556 <method name="getCPUStatus"> 9557 <rest request="get" path="/vms/{vmid}/configuration/"/> 9424 9558 <desc> 9425 9559 Returns the current status of the given CPU. … … 9438 9572 9439 9573 <method name="getEffectiveParavirtProvider" const="yes"> 9574 <rest request="get" path="/vms/{vmid}/configuration/"/> 9440 9575 <desc> 9441 9576 Returns the effective paravirtualization provider for this VM. … … 9449 9584 9450 9585 <method name="queryLogFilename"> 9586 <rest request="get" path="/vms/{vmid}/logs/"/> 9451 9587 <desc> 9452 9588 Queries for the VM log file name of an given index. Returns an empty … … 9496 9632 9497 9633 <method name="cloneTo"> 9634 <rest name="clone" request="put" path="/vms/{vmid}/actions/"/> 9498 9635 <desc> 9499 9636 Creates a clone of this machine, either as a full clone (which means … … 9531 9668 9532 9669 <method name="moveTo"> 9670 <rest name="move" request="post" path="/vms/{vmid}/actions/"/> 9533 9671 <desc> 9534 9672 Move machine on to new place/folder … … 9557 9695 9558 9696 <method name="saveState"> 9697 <rest name="save" request="post" path="/vms/{vmid}/actions/"/> 9559 9698 <desc> 9560 9699 Saves the current execution state of a running virtual machine … … 9630 9769 9631 9770 <method name="discardSavedState"> 9771 <rest request="post" path="/vms/{vmid}/actions/"/> 9632 9772 <desc> 9633 9773 Forcibly resets the machine to "Powered Off" state if it is … … 9657 9797 9658 9798 <method name="takeSnapshot"> 9799 <rest request="put" path="/vms/{vmid}/actions/"/> 9659 9800 <desc> 9660 9801 Saves the current execution state … … 9704 9845 9705 9846 <method name="deleteSnapshot"> 9847 <rest request="delete" path="/vms/{vmid}/actions/"/> 9706 9848 <desc> 9707 9849 Starts deleting the specified snapshot asynchronously. … … 9775 9917 9776 9918 <method name="deleteSnapshotAndAllChildren"> 9919 <rest request="post" path="/vms/{vmid}/actions/"/> 9777 9920 <desc> 9778 9921 Starts deleting the specified snapshot and all its children … … 9808 9951 9809 9952 <method name="deleteSnapshotRange"> 9953 <rest request="post" path="/vms/{vmid}/actions/"/> 9810 9954 <desc> 9811 9955 Starts deleting the specified snapshot range. This is limited to … … 9846 9990 9847 9991 <method name="restoreSnapshot"> 9992 <rest request="post" path="/vms/{vmid}/actions/"/> 9848 9993 <desc> 9849 9994 Starts resetting the machine's current state to the state contained … … 9885 10030 9886 10031 <method name="applyDefaults"> 10032 <rest request="post" path="/vms/{vmid}/configuration/"/> 9887 10033 <desc> 9888 10034 Applies the defaults for the configured guest OS type. This is … … 9962 10108 uuid="c39ef4d6-7532-45e8-96da-eb5986ae76e4" 9963 10109 wsmap="struct" 10110 rest="managed" 9964 10111 reservedAttributes="8" 9965 10112 > … … 10071 10218 uuid="872da645-4a9b-1727-bee2-5585105b9eed" 10072 10219 wsmap="managed" 10220 rest="managed" 10073 10221 reservedMethods="8" reservedAttributes="8" 10074 10222 > … … 10090 10238 </desc> 10091 10239 10092 <attribute name="machine" type="IMachine" readonly="yes" >10240 <attribute name="machine" type="IMachine" readonly="yes" rest="uuid"> 10093 10241 <desc> 10094 10242 Machine object for this console session. … … 10217 10365 10218 10366 <method name="powerUp"> 10367 <rest request="post" path="/vms/{vmid}/console/actions/"/> 10219 10368 <desc> 10220 10369 Starts the virtual machine execution using the current machine … … 10269 10418 10270 10419 <method name="powerUpPaused"> 10420 <rest request="post" path="/vms/{vmid}/console/actions/"/> 10271 10421 <desc> 10272 10422 Identical to powerUp except that the VM will enter the … … 10291 10441 10292 10442 <method name="powerDown"> 10443 <rest request="post" path="/vms/{vmid}/console/actions/"/> 10293 10444 <desc> 10294 10445 Initiates the power down procedure to stop the virtual machine … … 10308 10459 10309 10460 <method name="reset"> 10461 <rest request="post" path="/vms/{vmid}/console/actions/"/> 10310 10462 <desc>Resets the virtual machine. 10311 10463 <result name="VBOX_E_INVALID_VM_STATE"> … … 10319 10471 10320 10472 <method name="pause"> 10473 <rest request="post" path="/vms/{vmid}/console/actions/"/> 10321 10474 <desc>Pauses the virtual machine execution. 10322 10475 <result name="VBOX_E_INVALID_VM_STATE"> … … 10330 10483 10331 10484 <method name="resume"> 10485 <rest request="post" path="/vms/{vmid}/console/actions/"/> 10332 10486 <desc>Resumes the virtual machine execution. 10333 10487 <result name="VBOX_E_INVALID_VM_STATE"> … … 10341 10495 10342 10496 <method name="powerButton"> 10497 <rest request="post" path="/vms/{vmid}/console/actions/"/> 10343 10498 <desc>Sends the ACPI power button event to the guest. 10344 10499 <result name="VBOX_E_INVALID_VM_STATE"> … … 10352 10507 10353 10508 <method name="sleepButton"> 10509 <rest request="post" path="/vms/{vmid}/console/actions/"/> 10354 10510 <desc>Sends the ACPI sleep button event to the guest. 10355 10511 <result name="VBOX_E_INVALID_VM_STATE"> … … 10394 10550 10395 10551 <method name="attachUSBDevice"> 10552 <rest request="post" path="/vms/{vmid}/configuration/"/> 10396 10553 <desc> 10397 10554 Attaches a host USB device with the given UUID to the … … 10426 10583 10427 10584 <method name="detachUSBDevice"> 10585 <rest request="post" path="/vms/{vmid}/configuration/"/> 10428 10586 <desc> 10429 10587 Detaches an USB device with the given UUID from the USB controller … … 10454 10612 10455 10613 <method name="findUSBDeviceByAddress"> 10614 <rest request="get" path="/vms/{vmid}/configuration/"/> 10456 10615 <desc> 10457 10616 Searches for a USB device with the given host address. … … 10475 10634 10476 10635 <method name="findUSBDeviceById"> 10636 <rest request="get" path="/vms/{vmid}/configuration/"/> 10477 10637 <desc> 10478 10638 Searches for a USB device with the given UUID. … … 10493 10653 10494 10654 <method name="createSharedFolder"> 10655 <rest request="post" path="/vms/{vmid}/console/methods/"/> 10495 10656 <desc> 10496 10657 Creates a transient new shared folder by associating the given logical … … 10528 10689 10529 10690 <method name="removeSharedFolder"> 10691 <rest request="post" path="/vms/{vmid}/console/methods/"/> 10530 10692 <desc> 10531 10693 Removes a transient shared folder with the given name previously … … 10584 10746 10585 10747 <method name="addDiskEncryptionPassword"> 10748 <rest request="post" path="/vms/{vmid}/console/methods/"/> 10586 10749 <desc> 10587 10750 Adds a password used for hard disk encryption/decryption. … … 10610 10773 10611 10774 <method name="addDiskEncryptionPasswords"> 10775 <rest request="post" path="/vms/{vmid}/console/methods/"/> 10612 10776 <desc> 10613 10777 Adds a password used for hard disk encryption/decryption. … … 10636 10800 10637 10801 <method name="removeDiskEncryptionPassword"> 10802 <rest request="post" path="/vms/{vmid}/console/methods/"/> 10638 10803 <desc> 10639 10804 Removes a password used for hard disk encryption/decryption from … … 10651 10816 10652 10817 <method name="clearAllDiskEncryptionPasswords"> 10818 <rest request="post" path="/vms/{vmid}/console/methods/"/> 10653 10819 <desc>Clears all provided supplied disk encryption passwords.</desc> 10654 10820 </method> … … 10735 10901 uuid="455f8c45-44a0-a470-ba20-27890b96dba9" 10736 10902 wsmap="managed" 10903 rest="managed" 10737 10904 reservedMethods="2" reservedAttributes="4" 10738 10905 > … … 10845 11012 uuid="e8c25d4d-ac97-4c16-b3e2-81bd8a57cc27" 10846 11013 wsmap="managed" 11014 rest="managed" 10847 11015 reservedAttributes="4" 10848 11016 > … … 10884 11052 uuid="6fa2671b-0547-448e-bc7c-94e9e173bf57" 10885 11053 wsmap="managed" 11054 rest="managed" 10886 11055 reservedMethods="12" reservedAttributes="24" 10887 11056 > … … 10936 11105 uuid="4f529a14-ace3-407c-9c49-066e8e8027f0" 10937 11106 wsmap="struct" 11107 rest="managed" 10938 11108 > 10939 11109 <desc> … … 11048 11218 uuid="70e2e0c3-332c-4d72-b822-2db16e2cb31b" 11049 11219 wsmap="managed" 11220 rest="managed" 11050 11221 > 11051 11222 <desc> … … 11108 11279 uuid="fc0759a6-a5e2-41e1-93ca-64776335eb2d" 11109 11280 wsmap="managed" 11281 rest="managed" 11110 11282 reservedMethods="6" reservedAttributes="12" 11111 11283 > … … 11623 11795 uuid="b7fda727-7a08-46ee-8dd8-f8d7308b519c" 11624 11796 wsmap="managed" 11797 rest="managed" 11625 11798 reservedMethods="4" reservedAttributes="8" 11626 11799 > … … 11673 11846 uuid="31cdb11d-9bb0-455a-b2ca-a1a5b1177912" 11674 11847 wsmap="managed" 11848 rest="managed" 11675 11849 reservedMethods="4" reservedAttributes="16" 11676 11850 > … … 12449 12623 uuid="966303d0-36a8-4180-8971-18650b0d1055" 12450 12624 wsmap="struct" 12625 rest="managed" 12451 12626 reservedAttributes="16" 12452 12627 > … … 12718 12893 uuid="f2f7fae4-4a06-81fc-a916-78b2da1fa0e5" 12719 12894 wsmap="struct" 12895 rest="managed" 12720 12896 reservedAttributes="2" 12721 12897 > … … 16423 16599 uuid="d7b98d2b-30e8-447e-99cb-e31becae6ae4" 16424 16600 wsmap="managed" 16601 rest="managed" 16425 16602 wrap-hint-server-addinterfaces="IInternalProgressControl" 16426 16603 reservedMethods="8" reservedAttributes="12" … … 16559 16736 </attribute> 16560 16737 16561 <attribute name="eventSource" type="IEventSource" readonly="yes" />16738 <attribute name="eventSource" type="IEventSource" readonly="yes" rest="suppress"/> 16562 16739 16563 16740 <method name="waitForCompletion"> 16741 <rest request="post" path="/progresses/{progressid}/actions/"/> 16564 16742 <desc> 16565 16743 Waits until the task is done (including all sub-operations) … … 16587 16765 16588 16766 <method name="waitForOperationCompletion"> 16767 <rest request="post" path="/progresses/{progressid}/actions/"/> 16589 16768 <desc> 16590 16769 Waits until the given operation is done with a given timeout in … … 16612 16791 16613 16792 <method name="cancel"> 16793 <rest request="post" path="/progresses/{progressid}/actions/"/> 16614 16794 <desc> 16615 16795 Cancels the task. … … 16699 16879 uuid="6cc49055-dad4-4496-85cf-3f76bcb3b5fa" 16700 16880 wsmap="managed" 16881 rest="managed" 16701 16882 reservedMethods="4" reservedAttributes="8" 16702 16883 > … … 16819 17000 </attribute> 16820 17001 16821 <attribute name="machine" type="IMachine" readonly="yes" >17002 <attribute name="machine" type="IMachine" readonly="yes" rest="uuid"> 16822 17003 <desc> 16823 17004 Virtual machine this snapshot is taken on. This object … … 16830 17011 </attribute> 16831 17012 16832 <attribute name="parent" type="ISnapshot" readonly="yes" >17013 <attribute name="parent" type="ISnapshot" readonly="yes" rest="uuid"> 16833 17014 <desc> 16834 17015 Parent snapshot (a snapshot this one is based on), or … … 16837 17018 </attribute> 16838 17019 16839 <attribute name="children" type="ISnapshot" readonly="yes" safearray="yes" >17020 <attribute name="children" type="ISnapshot" readonly="yes" safearray="yes" rest="uuid"> 16840 17021 <desc> 16841 17022 Child snapshots (all snapshots having this one as a parent). … … 17034 17215 uuid="8d095cb0-0126-43e0-b05d-326e74abb356" 17035 17216 wsmap="struct" 17217 rest="managed" 17036 17218 reservedAttributes="8" 17037 17219 > … … 17215 17397 </desc> 17216 17398 17217 <attribute name="machine" type="IMachine" readonly="yes" >17399 <attribute name="machine" type="IMachine" readonly="yes" rest="uuid"> 17218 17400 <desc>Machine object for this medium attachment.</desc> 17219 17401 </attribute> 17220 17402 17221 <attribute name="medium" type="IMedium" readonly="yes" >17403 <attribute name="medium" type="IMedium" readonly="yes" rest="uuid"> 17222 17404 <desc>Medium object associated with this attachment; it 17223 17405 can be @c null for removable devices.</desc> … … 17281 17463 uuid="ad47ad09-787b-44ab-b343-a082a3f2dfb1" 17282 17464 wsmap="managed" 17465 rest="managed" 17283 17466 reservedMethods="8" reservedAttributes="12" 17284 17467 > … … 17611 17794 </attribute> 17612 17795 17613 <attribute name="parent" type="IMedium" readonly="yes" wrap-hint-server="passcaller" >17796 <attribute name="parent" type="IMedium" readonly="yes" wrap-hint-server="passcaller" rest="uuid"> 17614 17797 <desc> 17615 17798 Parent of this medium (the medium this medium is directly based … … 17621 17804 </attribute> 17622 17805 17623 <attribute name="children" type="IMedium" safearray="yes" readonly="yes" wrap-hint-server="passcaller" >17806 <attribute name="children" type="IMedium" safearray="yes" readonly="yes" wrap-hint-server="passcaller" rest="uuid"> 17624 17807 <desc> 17625 17808 Children of this medium (all differencing media directly based … … 17629 17812 </attribute> 17630 17813 17631 <attribute name="base" type="IMedium" readonly="yes" wrap-hint-server="passcaller" >17814 <attribute name="base" type="IMedium" readonly="yes" wrap-hint-server="passcaller" rest="uuid"> 17632 17815 <desc> 17633 17816 Base medium of this medium. … … 17744 17927 17745 17928 <method name="setIds" wrap-hint-server="passcaller"> 17929 <rest request="post" path="/mediums/{mediumid}/configuration/"/> 17746 17930 <desc> 17747 17931 Changes the UUID and parent UUID for a hard disk medium. … … 17780 17964 17781 17965 <method name="refreshState" wrap-hint-server="passcaller"> 17966 <rest request="post" path="/mediums/{mediumid}/configuration/"/> 17782 17967 <desc> 17783 17968 If the current medium state (see <link to="MediumState"/>) is one of … … 17816 18001 17817 18002 <method name="getSnapshotIds"> 18003 <rest request="get" path="/mediums/{mediumid}/configuration/"/> 17818 18004 <desc> 17819 18005 Returns an array of UUIDs of all snapshots of the given machine where … … 17845 18031 17846 18032 <method name="lockRead"> 18033 <rest request="post" path="/mediums/{mediumid}/configuration/"/> 17847 18034 <desc> 17848 18035 Locks this medium for reading. … … 17906 18093 17907 18094 <method name="lockWrite"> 18095 <rest request="post" path="/mediums/{mediumid}/configuration/"/> 17908 18096 <desc> 17909 18097 Locks this medium for writing. … … 17959 18147 17960 18148 <method name="close" wrap-hint-server="passcaller"> 18149 <rest request="post" path="/mediums/{mediumid}/actions/"/> 17961 18150 <desc> 17962 18151 Closes this medium. … … 17997 18186 17998 18187 <method name="getProperty" const="yes"> 18188 <rest request="get" path="/mediums/{mediumid}/configuration/"/> 17999 18189 <desc> 18000 18190 Returns the value of the custom medium property with the given name. … … 18020 18210 18021 18211 <method name="setProperty"> 18212 <rest request="post" path="/mediums/{mediumid}/configuration/"/> 18022 18213 <desc> 18023 18214 Sets the value of the custom medium property with the given name. … … 18045 18236 18046 18237 <method name="getProperties" const="yes"> 18238 <rest request="get" path="/mediums/{mediumid}/configuration/"/> 18047 18239 <desc> 18048 18240 Returns values for a group of properties in one call. … … 18081 18273 18082 18274 <method name="setProperties"> 18275 <rest request="post" path="/mediums/{mediumid}/configuration/"/> 18083 18276 <desc> 18084 18277 Sets values for a group of properties in one call. … … 18115 18308 18116 18309 <method name="createBaseStorage"> 18310 <rest request="post" path="/mediums/{mediumid}/actions/"/> 18117 18311 <desc> 18118 18312 Starts creating a hard disk storage unit (fixed/dynamic, according … … 18149 18343 18150 18344 <method name="deleteStorage"> 18345 <rest request="post" path="/mediums/{mediumid}/actions/"/> 18151 18346 <desc> 18152 18347 Starts deleting the storage unit of this medium. … … 18195 18390 18196 18391 <method name="createDiffStorage" wrap-hint-server="passcaller"> 18392 <rest request="post" path="/mediums/{mediumid}/actions/"/> 18197 18393 <desc> 18198 18394 Starts creating an empty differencing storage unit based on this … … 18232 18428 18233 18429 <method name="mergeTo"> 18430 <rest request="post" path="/mediums/{mediumid}/actions/"/> 18234 18431 <desc> 18235 18432 Starts merging the contents of this medium and all intermediate … … 18314 18511 18315 18512 <method name="cloneTo"> 18513 <rest request="post" path="/mediums/{mediumid}/actions/"/> 18316 18514 <desc> 18317 18515 Starts creating a clone of this medium in the format and at the … … 18363 18561 18364 18562 <method name="cloneToBase"> 18563 <rest request="post" path="/mediums/{mediumid}/actions/"/> 18365 18564 <desc> 18366 18565 Starts creating a clone of this medium in the format and at the … … 18410 18609 18411 18610 <method name="moveTo" wrap-hint-server="passcaller"> 18611 <rest request="post" path="/mediums/{mediumid}/actions/"/> 18412 18612 <desc> 18413 18613 Changes the location of this medium. Some medium types may support … … 18446 18646 18447 18647 <method name="compact"> 18648 <rest request="post" path="/mediums/{mediumid}/actions/"/> 18448 18649 <desc> 18449 18650 Starts compacting of this medium. This means that the medium is … … 18472 18673 18473 18674 <method name="resize"> 18675 <rest request="post" path="/mediums/{mediumid}/actions/"/> 18474 18676 <desc> 18475 18677 Starts resizing this medium. This means that the nominal size of the … … 18503 18705 18504 18706 <method name="reset" wrap-hint-server="passcaller"> 18707 <rest request="post" path="/mediums/{mediumid}/actions/"/> 18505 18708 <desc> 18506 18709 Starts erasing the contents of this differencing medium. … … 18529 18732 18530 18733 <method name="changeEncryption"> 18734 <rest request="post" path="/mediums/{mediumid}/actions/"/> 18531 18735 <desc> 18532 18736 Starts encryption of this medium. This means that the stored data in the … … 18572 18776 18573 18777 <method name="getEncryptionSettings" const="yes" wrap-hint-server="passcaller"> 18778 <rest request="get" path="/mediums/{mediumid}/configuration/"/> 18574 18779 <desc> 18575 18780 Returns the encryption settings for this medium. … … 18588 18793 18589 18794 <method name="checkEncryptionPassword" const="yes"> 18795 <rest request="get" path="/mediums/{mediumid}/configuration/"/> 18590 18796 <desc> 18591 18797 Checks whether the supplied password is correct for the medium. … … 18741 18947 uuid="11be93c7-a862-4dc9-8c89-bf4ba74a886a" 18742 18948 wsmap="managed" 18949 rest="managed" 18743 18950 reservedMethods="2" reservedAttributes="4" 18744 18951 > … … 19072 19279 uuid="20479eaf-d8ed-44cf-85ac-c83a26c95a4d" 19073 19280 wsmap="managed" 19281 rest="managed" 19074 19282 reservedMethods="1" reservedAttributes="2" 19075 19283 > … … 19126 19334 uuid="755e6bdf-1640-41f9-bd74-3ef5fd653250" 19127 19335 wsmap="managed" 19336 rest="managed" 19128 19337 reservedMethods="4" reservedAttributes="4" 19129 19338 > … … 19261 19470 uuid="1e775ea3-9070-4f9c-b0d5-53054496dbe0" 19262 19471 wsmap="managed" 19472 rest="managed" 19263 19473 reservedAttributes="4" 19264 19474 > … … 19335 19545 uuid="10cd08d0-e8b8-4838-b10c-45ba193734c1" 19336 19546 wsmap="managed" 19547 rest="managed" 19337 19548 reservedMethods="4" reservedAttributes="4" 19338 19549 > … … 19607 19818 19608 19819 <interface 19609 name="IDisplaySourceBitmap" extends="$unknown" wsmap="suppress"19820 name="IDisplaySourceBitmap" extends="$unknown" 19610 19821 uuid="5094f67a-8084-11e9-b185-dbe296e54799" 19822 wsmap="suppress" 19823 rest="managed" 19611 19824 > 19612 19825 <attribute name="screenId" type="unsigned long" readonly="yes"/> … … 20644 20857 uuid="dcf47a1d-ed70-4db8-9a4b-2646bd166905" 20645 20858 wsmap="managed" 20859 rest="managed" 20646 20860 reservedMethods="4" reservedAttributes="8" 20647 20861 > … … 20921 21135 uuid="5587d0f6-a227-4f23-8278-2f675eea1bb2" 20922 21136 wsmap="managed" 21137 rest="managed" 20923 21138 reservedAttributes="4" 20924 21139 > … … 21016 21231 uuid="788b87df-7708-444b-9eef-c116ce423d39" 21017 21232 wsmap="managed" 21233 rest="managed" 21018 21234 reservedAttributes="4" 21019 21235 > … … 21098 21314 uuid="fa43579a-2272-47c4-a443-9713f19a902f" 21099 21315 wsmap="managed" 21316 rest="managed" 21100 21317 reservedMethods="16" reservedAttributes="16" 21101 21318 > … … 21638 21855 uuid="9709db9b-3346-49d6-8f1c-41b0c4784ff2" 21639 21856 wsmap="managed" 21857 rest="managed" 21640 21858 reservedMethods="2" reservedAttributes="2" 21641 21859 > … … 21783 22001 uuid="ee206a6e-7ff8-4a84-bd34-0c651e118bb5" 21784 22002 wsmap="managed" 22003 rest="managed" 21785 22004 reservedAttributes="4" 21786 22005 > … … 21869 22088 uuid="6dc83c2c-81a9-4005-9d52-fc45a78bf3f5" 21870 22089 wsmap="managed" 22090 rest="managed" 21871 22091 reservedAttributes="4" 21872 22092 > … … 21989 22209 uuid="45587218-4289-ef4e-8e6a-e5b07816b631" 21990 22210 wsmap="managed" 22211 rest="managed" 21991 22212 reservedAttributes="8" 21992 22213 > … … 22236 22457 uuid="c19073dd-cc7b-431b-98b2-951fda8eab89" 22237 22458 wsmap="managed" 22459 rest="managed" 22238 22460 reservedAttributes="4" 22239 22461 > … … 22290 22512 uuid="01adb2d6-aedf-461c-be2c-99e91bdad8a1" 22291 22513 wsmap="managed" 22514 rest="managed" 22292 22515 reservedAttributes="8" 22293 22516 > … … 22329 22552 uuid="dfe56449-6989-4002-80cf-3607f377d40c" 22330 22553 wsmap="managed" 22554 rest="managed" 22331 22555 reservedMethods="4" reservedAttributes="8" 22332 22556 > … … 22435 22659 uuid="5155bfd3-7ba7-45a8-b26d-c91ae3754e37" 22436 22660 wsmap="managed" 22661 rest="managed" 22437 22662 reservedMethods="4" reservedAttributes="8" 22438 22663 > … … 22544 22769 uuid="08e25756-08a2-41af-a05f-d7c661abaebe" 22545 22770 wsmap="managed" 22771 rest="managed" 22546 22772 reservedMethods="2" reservedAttributes="4" 22547 22773 > … … 22638 22864 uuid="9622225a-5409-414b-bd16-77df7ba3451e" 22639 22865 wsmap="managed" 22866 rest="managed" 22640 22867 reservedAttributes="8" 22641 22868 > … … 23477 23704 uuid="c0447716-ff5a-4795-b57a-ecd5fffa18a4" 23478 23705 wsmap="managed" 23706 rest="managed" 23479 23707 wrap-hint-server-addinterfaces="IInternalSessionControl" 23480 23708 reservedMethods="4" reservedAttributes="8" … … 23508 23736 or because the machine is running. 23509 23737 </li> 23510 <li> 23511 To start a VM using one of the existing VirtualBox front-ends (e.g. the 23738 <li>To start a VM using one of the existing VirtualBox front-ends (e.g. the 23512 23739 VirtualBox GUI or VBoxHeadless), one would use 23513 23740 <link to="IMachine::launchVMProcess"/>, which also takes a session object … … 23560 23787 </attribute> 23561 23788 23562 <attribute name="machine" type="IMachine" readonly="yes" >23789 <attribute name="machine" type="IMachine" readonly="yes" rest="uuid"> 23563 23790 <desc>Machine object associated with this session.</desc> 23564 23791 </attribute> … … 23697 23924 wsmap="managed" 23698 23925 reservedMethods="4" reservedAttributes="8" 23926 rest="managed" 23699 23927 > 23700 23928 <desc> … … 23913 24141 name="IPerformanceMetric" extends="$unknown" 23914 24142 uuid="81314d14-fd1c-411a-95c5-e9bb1414e632" wsmap="managed" 24143 rest="managed" 23915 24144 reservedAttributes="8" 23916 24145 > … … 24358 24587 uuid="a06253a7-dcd2-44e3-8689-9c9c4b6b6234" 24359 24588 wsmap="managed" 24589 rest="managed" 24360 24590 reservedMethods="4" reservedAttributes="8" 24361 24591 > … … 24809 25039 uuid="31587f93-2d12-4d7c-ba6d-ce51d0d5b265" 24810 25040 wsmap="managed" 25041 rest="managed" 24811 25042 reservedAttributes="4" 24812 25043 > … … 24840 25071 uuid="48c7f4c0-c9d6-4742-957c-a6fd52e8c4ae" 24841 25072 wsmap="managed" 25073 rest="managed" 24842 25074 reservedMethods="2" reservedAttributes="2" 24843 25075 > … … 25446 25678 uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538" 25447 25679 wsmap="managed" 25680 rest="managed" 25448 25681 > 25449 25682 <desc> … … 25589 25822 uuid="67099191-32e7-4f6c-85ee-422304c71b90" 25590 25823 wsmap="managed" 25824 rest="managed" 25591 25825 > 25592 25826 <desc> … … 25616 25850 uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0" 25617 25851 wsmap="managed" 25852 rest="managed" 25618 25853 > 25619 25854 <desc> … … 27834 28069 uuid="147816c8-17e0-11eb-81fa-87cea6263e1a" 27835 28070 wsmap="managed" 27836 reservedMethods="16" reservedAttributes="8"> 28071 rest="managed" 28072 reservedMethods="16" reservedAttributes="8" 28073 > 27837 28074 <desc> 27838 28075 Virtual virtual machine (sic) in the cloud. … … 28100 28337 name="ICloudClient" extends="$unknown" 28101 28338 uuid="c2db178a-7485-11ec-aec4-2fbf90681a84" 28102 wsmap="managed" reservedMethods="16" reservedAttributes="8" 28339 wsmap="managed" 28340 reservedMethods="16" reservedAttributes="8" 28103 28341 > 28104 28342 … … 28641 28879 name="ICloudProfile" extends="$unknown" 28642 28880 uuid="b1d978b8-f7b7-4b05-900e-2a9253c00f51" 28643 wsmap="managed" reservedMethods="4" reservedAttributes="8" 28881 wsmap="managed" 28882 rest="managed" 28883 reservedMethods="4" reservedAttributes="8" 28644 28884 > 28645 28885 … … 28774 29014 name="ICloudProvider" extends="$unknown" 28775 29015 uuid="22363cfc-07da-41ec-ac4a-3dd99db35594" 28776 wsmap="managed" reservedMethods="8" reservedAttributes="16" 29016 wsmap="managed" 29017 rest="managed" 29018 reservedMethods="8" reservedAttributes="16" 28777 29019 > 28778 29020 … … 28880 29122 name="ICloudProviderManager" extends="$unknown" 28881 29123 uuid="9128800f-762e-4120-871c-a2014234a607" 28882 wsmap="managed" reservedMethods="4" reservedAttributes="8" 29124 wsmap="managed" 29125 rest="managed" 29126 reservedMethods="4" reservedAttributes="8" 28883 29127 > 28884 29128
Note:
See TracChangeset
for help on using the changeset viewer.