Apache CloudStack 4.19.0.0 Root Admin API Reference
addGuestOsMapping
Adds a guest OS name to hypervisor OS name mapping
Request parameters
| Parameter Name | Description | Required |
| hypervisor | Hypervisor type. One of : XenServer, KVM, VMWare | true |
| hypervisorversion | Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version | true |
| osnameforhypervisor | OS name specific to the hypervisor | true |
| forced | Forces add user defined guest os mapping, overrides any existing user defined mapping | false |
| osdisplayname | Display Name of Guest OS standard type. Either Display Name or UUID must be passed | false |
| osmappingcheckenabled | When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.) | false |
| ostypeid | UUID of Guest OS type. Either the UUID or Display Name must be passed | false |
Response Tags
| Response Name | Description |
| id | the ID of the Guest OS mapping |
| hypervisor | the hypervisor |
| hypervisorversion | version of the hypervisor for mapping |
| isuserdefined | is the mapping user defined |
| osdisplayname | standard display name for the Guest OS |
| osnameforhypervisor | hypervisor specific name for the Guest OS |
| ostypeid | the ID of the Guest OS type |