compute_capacity_topology_compute_bare_metal_hosts

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

Overview

Name	compute_capacity_topology_compute_bare_metal_hosts
Type	Resource
Id	oci.compute.compute_capacity_topology_compute_bare_metal_hosts

Fields

The following fields are returned by SELECT queries:

list

The list of compute bare metal hosts is being retrieved.

Name	Datatype	Description
id	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute bare metal host.
computeCapacityTopologyId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology.
computeHpcIslandId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island.
computeLocalBlockId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute network block.
computeNetworkBlockId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute local block.
instanceId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute instance that runs on the compute bare metal host.
instanceShape	string	The shape of the compute instance that runs on the compute bare metal host.
lifecycleDetails	string	The lifecycle state details of the compute bare metal host. (x-obmcs-enumref: #/definitions/ComputeBareMetalHost/lifecycleDetails)
lifecycleState	string	The current state of the compute bare metal host. (x-obmcs-enumref: #/definitions/ComputeBareMetalHost/lifecycleState)
timeCreated	string (date-time)	The date and time that the compute bare metal host was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
timeUpdated	string (date-time)	The date and time that the compute bare metal host was updated, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	computeCapacityTopologyId, region	availabilityDomain, compartmentId, computeHpcIslandId, computeNetworkBlockId, computeLocalBlockId, limit, page, opc-request-id, sortBy, sortOrder	Lists compute bare metal hosts in the specified compute capacity topology.

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.

Name	Datatype	Description
computeCapacityTopologyId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology.
region	string	OCI 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)
availabilityDomain	string	The name of the availability domain. Example: Uocm:PHX-AD-1
compartmentId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
computeHpcIslandId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island.
computeLocalBlockId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute local block.
computeNetworkBlockId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute network block.
limit	integer	For 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-id	string	Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
page	string	For 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).
sortBy	string	The 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.
sortOrder	string	The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

SELECT examples

list

Lists compute bare metal hosts in the specified compute capacity topology.

SELECT
id,
computeCapacityTopologyId,
computeHpcIslandId,
computeLocalBlockId,
computeNetworkBlockId,
instanceId,
instanceShape,
lifecycleDetails,
lifecycleState,
timeCreated,
timeUpdated
FROM oci.compute.compute_capacity_topology_compute_bare_metal_hosts
WHERE computeCapacityTopologyId = '{{ computeCapacityTopologyId }}' -- required
AND region = '{{ region }}' -- required
AND availabilityDomain = '{{ availabilityDomain }}'
AND compartmentId = '{{ compartmentId }}'
AND computeHpcIslandId = '{{ computeHpcIslandId }}'
AND computeNetworkBlockId = '{{ computeNetworkBlockId }}'
AND computeLocalBlockId = '{{ computeLocalBlockId }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND opc-request-id = '{{ opc-request-id }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
;