Skip to main content

dedicated_vm_hosts

Creates, updates, deletes, gets or lists a dedicated_vm_hosts resource.

Overview​

Namededicated_vm_hosts
TypeResource
Idoci.compute.dedicated_vm_hosts

Fields​

The following fields are returned by SELECT queries:

The dedicated virtual machine host was retrieved.

NameDatatypeDescription
idstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dedicated VM host.
availabilityDomainstringThe availability domain the dedicated virtual machine host is running in. Example: Uocm:PHX-AD-1
capacityBinsarray
capacityConfigstringThe capacity configuration selected to be configured for the Dedicated Virtual Machine host. Run [ListDedicatedVmHostShapes](#/en/iaas/latest/DedicatedVmHostShapeSummary/ListDedicatedVmHostShapes) API to see details of this capacity configuration.
compartmentIdstringThe OCID of the compartment that contains the dedicated virtual machine host.
computeBareMetalHostIdstringThe compute bare metal host OCID of the dedicated virtual machine host.
dedicatedVmHostShapestringThe dedicated virtual machine host shape. The shape determines the number of CPUs and other resources available for VMs.
definedTagsobjectDefined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
displayNamestringA user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
faultDomainstringThe fault domain for the dedicated virtual machine host's assigned instances. For more information, see [Fault Domains](/iaas/Content/General/Concepts/regions.htm#fault). If you do not specify the fault domain, the system selects one for you. To change the fault domain for a dedicated virtual machine host, delete it, and then create a new dedicated virtual machine host in the preferred fault domain. To get a list of fault domains, use the ListFaultDomains operation in the [Identity and Access Management Service API](/iaas/api/#/en/identity/20160918/). Example: FAULT-DOMAIN-1
freeformTagsobjectFree-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
isBurstablebooleanSpecifies if the Dedicated Virtual Machine Host (DVMH) is to running only Burstable VMs. If true, only Burstable VMs can be launched. If false, Burstable VMs cannot be launched.
isMemoryEncryptionEnabledbooleanSpecifies if the Dedicated Virtual Machine Host (DVMH) is restricted to running only Confidential VMs. If true, only Confidential VMs can be launched. If false, Confidential VMs cannot be launched.
lifecycleStatestringThe current state of the dedicated VM host. (CREATING, ACTIVE, UPDATING, DELETING, DELETED, FAILED)
placementConstraintDetailsobjectThe details for providing placement constraints.
remainingMemoryInGBsnumber (float)The remaining memory of the dedicated VM host, in GBs.
remainingOcpusnumber (float)The available OCPUs of the dedicated VM host.
timeCreatedstring (date-time)The date and time the dedicated VM host was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
totalMemoryInGBsnumber (float)The total memory of the dedicated VM host, in GBs.
totalOcpusnumber (float)The total OCPUs of the dedicated VM host.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectdedicatedVmHostId, regionopc-request-idGets information about the specified dedicated virtual machine host.
listselectcompartmentId, regionavailabilityDomain, lifecycleState, displayName, instanceShapeName, limit, page, opc-request-id, sortBy, sortOrder, remainingMemoryInGBsGreaterThanOrEqualTo, remainingOcpusGreaterThanOrEqualTo, isMemoryEncryptionEnabledReturns the list of dedicated virtual machine hosts that match the specified criteria in the specified compartment.<br /><br />You can limit the list by specifying a dedicated virtual machine host display name. The list will include all the identically-named<br />dedicated virtual machine hosts in the compartment.<br />
createinsertregion, availabilityDomain, compartmentId, dedicatedVmHostShapeopc-request-id, opc-retry-tokenCreates a new dedicated virtual machine host in the specified compartment and the specified availability domain.<br />Dedicated virtual machine hosts enable you to run your Compute virtual machine (VM) instances on dedicated servers<br />that are a single tenant and not shared with other customers.<br />For more information, see [Dedicated Virtual Machine Hosts](/iaas/Content/Compute/Concepts/dedicatedvmhosts.htm).<br />
updateupdatededicatedVmHostId, regionif-match, opc-request-id, opc-retry-tokenUpdates the displayName, freeformTags, and definedTags attributes for the specified dedicated virtual machine host.<br />If an attribute value is not included, it will not be updated.<br />
deletedeletededicatedVmHostId, regionopc-request-idDeletes the specified dedicated virtual machine host.<br /><br />If any VM instances are assigned to the dedicated virtual machine host,<br />the delete operation will fail and the service will return a 409 response code.<br />
change_compartmentexecdedicatedVmHostId, region, compartmentIdif-match, opc-request-id, opc-retry-tokenMoves a dedicated virtual machine host from one compartment to another.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
dedicatedVmHostIdstringThe OCID of the dedicated VM host.
regionstringOCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
availabilityDomainstringThe name of the availability domain. Example: Uocm:PHX-AD-1
displayNamestringA filter to return only resources that match the given display name exactly.
if-matchstringFor optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
instanceShapeNamestringThe name for the instance's shape.
isMemoryEncryptionEnabledbooleanA filter to return only confidential Dedicated VM hosts (DVMH) or confidential VM instances on DVMH.
lifecycleStatestringA filter to only return resources that match the given lifecycle state.
limitintegerFor list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: 50
opc-request-idstringUnique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-tokenstringA token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
pagestringFor list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
remainingMemoryInGBsGreaterThanOrEqualTonumber (float)The remaining memory of the dedicated VM host, in GBs.
remainingOcpusGreaterThanOrEqualTonumber (float)The available OCPUs of the dedicated VM host.
sortBystringThe field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.
sortOrderstringThe sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

SELECT examples​

Gets information about the specified dedicated virtual machine host.

SELECT
id,
availabilityDomain,
capacityBins,
capacityConfig,
compartmentId,
computeBareMetalHostId,
dedicatedVmHostShape,
definedTags,
displayName,
faultDomain,
freeformTags,
isBurstable,
isMemoryEncryptionEnabled,
lifecycleState,
placementConstraintDetails,
remainingMemoryInGBs,
remainingOcpus,
timeCreated,
totalMemoryInGBs,
totalOcpus
FROM oci.compute.dedicated_vm_hosts
WHERE dedicatedVmHostId = '{{ dedicatedVmHostId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Creates a new dedicated virtual machine host in the specified compartment and the specified availability domain.<br />Dedicated virtual machine hosts enable you to run your Compute virtual machine (VM) instances on dedicated servers<br />that are a single tenant and not shared with other customers.<br />For more information, see [Dedicated Virtual Machine Hosts](/iaas/Content/Compute/Concepts/dedicatedvmhosts.htm).<br />

INSERT INTO oci.compute.dedicated_vm_hosts (
availabilityDomain,
capacityConfig,
compartmentId,
dedicatedVmHostShape,
definedTags,
displayName,
faultDomain,
freeformTags,
isBaselineOcpuUtilizationEnabled,
isMemoryEncryptionEnabled,
placementConstraintDetails,
region,
opc-request-id,
opc-retry-token
)
SELECT 
'{{ availabilityDomain }}' /* required */,
'{{ capacityConfig }}',
'{{ compartmentId }}' /* required */,
'{{ dedicatedVmHostShape }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}',
'{{ faultDomain }}',
'{{ freeformTags }}',
{{ isBaselineOcpuUtilizationEnabled }},
{{ isMemoryEncryptionEnabled }},
'{{ placementConstraintDetails }}',
'{{ region }}',
'{{ opc-request-id }}',
'{{ opc-retry-token }}'
RETURNING
id,
availabilityDomain,
capacityBins,
capacityConfig,
compartmentId,
computeBareMetalHostId,
dedicatedVmHostShape,
definedTags,
displayName,
faultDomain,
freeformTags,
isBurstable,
isMemoryEncryptionEnabled,
lifecycleState,
placementConstraintDetails,
remainingMemoryInGBs,
remainingOcpus,
timeCreated,
totalMemoryInGBs,
totalOcpus
;

UPDATE examples​

Updates the displayName, freeformTags, and definedTags attributes for the specified dedicated virtual machine host.<br />If an attribute value is not included, it will not be updated.<br />

UPDATE oci.compute.dedicated_vm_hosts
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}'
WHERE 
dedicatedVmHostId = '{{ dedicatedVmHostId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
AND opc-retry-token = '{{ opc-retry-token}}'
RETURNING
id,
availabilityDomain,
capacityBins,
capacityConfig,
compartmentId,
computeBareMetalHostId,
dedicatedVmHostShape,
definedTags,
displayName,
faultDomain,
freeformTags,
isBurstable,
isMemoryEncryptionEnabled,
lifecycleState,
placementConstraintDetails,
remainingMemoryInGBs,
remainingOcpus,
timeCreated,
totalMemoryInGBs,
totalOcpus;

DELETE examples​

Deletes the specified dedicated virtual machine host.<br /><br />If any VM instances are assigned to the dedicated virtual machine host,<br />the delete operation will fail and the service will return a 409 response code.<br />

DELETE FROM oci.compute.dedicated_vm_hosts
WHERE dedicatedVmHostId = '{{ dedicatedVmHostId }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id }}'
;

Lifecycle Methods​

Moves a dedicated virtual machine host from one compartment to another.

EXEC oci.compute.dedicated_vm_hosts.change_compartment 
@dedicatedVmHostId='{{ dedicatedVmHostId }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;