Registering tenant virtual machines
Registering tenant virtual machines
July 22, 2024
ID 199653
Allows you to add information about the tenant virtual machines to the Integration Server database.
Method:
POST /api/2.0/virtualization/tenants/{tenant ID
}/vms/register
where:
{
tenant ID
}
– tenant identifier in the Integration Server database (required parameter).
The following parameters must be specified In the request body:
<vm biosId="{BIOS ID
}">
<name>{name
}</name>
<userData><![CDATA[{additional information
}]]></userData>
</vm>
where:
{
BIOS ID}
– unique virtual machine identifier (BIOS ID) (required parameter).{
name
}
– virtual machine name (optional parameter).{
additional information
}
– additional information about the virtual machine (optional parameter).
Return codes:
200 (OK)
– request completed successfully (information about the virtual machine is added to the Integration Server database).403 (Forbidden)
– access to the resource is denied.404 (Not Found) VIRMT_TenantWithSpecifiedIdNotFound
– tenant with the specified identifier is not found in the Integration Server database.409 (Conflict) VIRMT_VmWithSpecifiedBiosIdAlreadyExists
– virtual machine with the specified identifier is already registered in the Integration Server database.
Did you find this article helpful?
What can we do better?
Thank you for your feedback! You're helping us improve.
Thank you for your feedback! You're helping us improve.