POST v1/bunits/{bunitId}/vms
Assign a VM to a business unit.
This will create a consumer as well
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
bunitId |
The ID of the business unit the VM should be assigned to | integer |
Required |
Body Parameters
The VM object
Vm| Name | Description | Type | Additional information |
|---|---|---|---|
UniqueId |
Unique Id Provided by SP Plus |
string |
None. |
Location |
Location Provided by SP Plus |
string |
None. |
VmVersion |
Version of VM Provided by SP Plus |
string |
None. |
HypervisorHostName |
Hypervisor host name Provided by SP Plus |
string |
None. |
Memory |
Amount of memory assigned to the VM Provided by SP Plus |
integer |
None. |
ClusterName |
Name of cluster Provided by SP Plus |
string |
None. |
DataCenterName |
Name of data center Provided by SP Plus |
string |
None. |
OsName |
OS Provided by SP Plus |
string |
None. |
VmToolsStatus |
Status of VM Tools Provided by SP Plus |
string |
None. |
GuestNetworkInfo |
Information about network Provided by SP Plus Represented as a string, but contains json |
string |
None. |
Hypervisor |
The hypervisor hosting the VM |
Hypervisor |
None. |
BackupPolicies |
Backup policies related to the VM |
Collection of BackupPolicy |
None. |
RestorePoints |
Restore points found on SPP |
Collection of RestorePoint |
None. |
Backups |
Backups performed on the VM |
Collection of VmBackup |
None. |
Name |
Name of the data-source |
string |
None. |
DataSourceState |
DataSourceState |
None. |
|
DataSourcePlatform |
DataSourcePlatform |
None. |
|
DataSourceType |
DataSourceType |
None. |
|
BackupServer |
Server |
None. |
|
Consumer |
Consumption unit that relates the VM to a business unit |
Consumer |
None. |
Id |
A unique ID for the object. |
integer |
Read-only. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
Operations |
Collection of OperationResult |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
Response Information
Resource Description
The VM object with the information created
Vm| Name | Description | Type | Additional information |
|---|---|---|---|
UniqueId |
Unique Id Provided by SP Plus |
string |
None. |
Location |
Location Provided by SP Plus |
string |
None. |
VmVersion |
Version of VM Provided by SP Plus |
string |
None. |
HypervisorHostName |
Hypervisor host name Provided by SP Plus |
string |
None. |
Memory |
Amount of memory assigned to the VM Provided by SP Plus |
integer |
None. |
ClusterName |
Name of cluster Provided by SP Plus |
string |
None. |
DataCenterName |
Name of data center Provided by SP Plus |
string |
None. |
OsName |
OS Provided by SP Plus |
string |
None. |
VmToolsStatus |
Status of VM Tools Provided by SP Plus |
string |
None. |
GuestNetworkInfo |
Information about network Provided by SP Plus Represented as a string, but contains json |
string |
None. |
Hypervisor |
The hypervisor hosting the VM |
Hypervisor |
None. |
BackupPolicies |
Backup policies related to the VM |
Collection of BackupPolicy |
None. |
RestorePoints |
Restore points found on SPP |
Collection of RestorePoint |
None. |
Backups |
Backups performed on the VM |
Collection of VmBackup |
None. |
Name |
Name of the data-source |
string |
None. |
DataSourceState |
DataSourceState |
None. |
|
DataSourcePlatform |
DataSourcePlatform |
None. |
|
DataSourceType |
DataSourceType |
None. |
|
BackupServer |
Server |
None. |
|
Consumer |
Consumption unit that relates the VM to a business unit |
Consumer |
None. |
Id |
A unique ID for the object. |
integer |
Read-only. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
Operations |
Collection of OperationResult |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.