blob: 35d2e3dc8f22fabd2546dd22064185efca8470ee [file]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../includes/main.css" type="text/css">
<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon">
<title>Apache CloudStack | The Power Behind Your Cloud</title>
</head>
<body>
<div id="insidetopbg">
<div id="inside_wrapper">
<div class="uppermenu_panel">
<div class="uppermenu_box"></div>
</div>
<div id="main_controller">
<div id="inside_header">
<div class="header_top">
<a class="cloud_logo" href="http://cloudstack.org"></a>
<div class="mainemenu_panel"></div>
</div>
</div>
<div id="main_content">
<div class="inside_apileftpanel">
<div class="inside_contentpanel" style="width:930px;">
<div class="api_titlebox">
<div class="api_titlebox_left">
<span>
Apache CloudStack 4.21.0.0 Root Admin API Reference
</span>
<p></p>
<h1>createGpuDevice</h1>
<p>Creates a GPU device manually on a host</p>
</div>
<div class="api_titlebox_right">
<a class="api_backbutton" href="../index.html"></a>
</div>
</div>
<div class="api_tablepanel">
<h2>Request parameters</h2>
<table class="apitable">
<tr class="hed">
<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td>
</tr>
<tr>
<td style="width:200px;"><strong>busaddress</strong></td><td style="width:500px;"><strong>PCI bus address of the GPU device (e.g., 0000:01:00.0) or UUID for MDEV devices.</strong></td><td style="width:180px;"><strong>true</strong></td>
</tr>
<tr>
<td style="width:200px;"><strong>gpucardid</strong></td><td style="width:500px;"><strong>ID of the GPU card type</strong></td><td style="width:180px;"><strong>true</strong></td>
</tr>
<tr>
<td style="width:200px;"><strong>hostid</strong></td><td style="width:500px;"><strong>ID of the host where the GPU device is located</strong></td><td style="width:180px;"><strong>true</strong></td>
</tr>
<tr>
<td style="width:200px;"><strong>vgpuprofileid</strong></td><td style="width:500px;"><strong>ID of the vGPU profile</strong></td><td style="width:180px;"><strong>true</strong></td>
</tr>
<tr>
<td style="width:200px;"><i>numanode</i></td><td style="width:500px;"><i>NUMA node of the GPU device (e.g., 0, 1, etc.). This is optional and can be used to specify the NUMA node for the GPU device which is used during allocation. Defaults to -1</i></td><td style="width:180px;"><i>false</i></td>
</tr>
<tr>
<td style="width:200px;"><i>parentgpudeviceid</i></td><td style="width:500px;"><i>ID of the parent GPU device (for virtual GPU devices)</i></td><td style="width:180px;"><i>false</i></td>
</tr>
<tr>
<td style="width:200px;"><i>type</i></td><td style="width:500px;"><i>Type of GPU device (PCI, MDEV, VGPUOnly). Defaults to PCI.</i></td><td style="width:180px;"><i>false</i></td>
</tr>
</table>
</div>
<div class="api_tablepanel">
<h2>Response Tags</h2>
<table class="apitable">
<tr class="hed">
<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td>
</tr>
<tr>
<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">the ID of the GPU device</td>
</tr>
<tr>
<td style="width:200px;"><strong>busaddress</strong></td><td style="width:500px;">bus address of the GPU device or MDEV UUID for vGPU devices</td>
</tr>
<tr>
<td style="width:200px;"><strong>gpucardid</strong></td><td style="width:500px;">the GPU card ID associated with this GPU device</td>
</tr>
<tr>
<td style="width:200px;"><strong>gpucardname</strong></td><td style="width:500px;">the GPU card name associated with this GPU device</td>
</tr>
<tr>
<td style="width:200px;"><strong>gpudevicetype</strong></td><td style="width:500px;">bus address of the GPU device</td>
</tr>
<tr>
<td style="width:200px;"><strong>hostid</strong></td><td style="width:500px;">the host ID where the GPU device is attached</td>
</tr>
<tr>
<td style="width:200px;"><strong>hostname</strong></td><td style="width:500px;">the host name where the GPU device is attached</td>
</tr>
<tr>
<td style="width:200px;"><strong>managedstate</strong></td><td style="width:500px;">the managed state of the GPU device (Enabled/Disabled)</td>
</tr>
<tr>
<td style="width:200px;"><strong>numanode</strong></td><td style="width:500px;">the NUMA node where the GPU device is located</td>
</tr>
<tr>
<td style="width:200px;"><strong>parentgpudeviceid</strong></td><td style="width:500px;">the ID of the parent GPU device, if this is a vGPU</td>
</tr>
<tr>
<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the vGPU profile name assigned to this GPU device</td>
</tr>
<tr>
<td style="width:200px;"><strong>vgpuprofileid</strong></td><td style="width:500px;">the vGPU profile ID assigned to this GPU device</td>
</tr>
<tr>
<td style="width:200px;"><strong>vgpuprofilename</strong></td><td style="width:500px;">the vGPU profile name assigned to this GPU device</td>
</tr>
<tr>
<td style="width:200px;"><strong>virtualmachineid</strong></td><td style="width:500px;">the vGPU profile ID assigned to this GPU device</td>
</tr>
<tr>
<td style="width:200px;"><strong>virtualmachinename</strong></td><td style="width:500px;">the vGPU profile name assigned to this GPU device</td>
</tr>
<tr>
<td style="width:200px;"><strong>vmstate</strong></td><td style="width:500px;">the state of the virtual machine to which this GPU device is allocated</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="comments_thread">
<script src="https://comments.apache.org/show_comments.lua?site=test" async="true"></script>
<noscript>
<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&amp;page=4.2.0/rootadmin"></iframe>
</noscript>
</div>
<div id="footer_maincontroller">
<p>
Copyright &copy; 2015 The Apache Software Foundation, Licensed under the
<a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0.</a>
<br>
Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.
</p>
</div>
</div>
</div>
</div>
</body>
</html>