firmware_bundles
Creates, updates, deletes, gets or lists a firmware_bundles resource.
Overview​
| Name | firmware_bundles |
| Type | Resource |
| Id | oci.compute.firmware_bundles |
Fields​
The following fields are returned by SELECT queries:
- get
- list
A Firmware Bundle object.
| Name | Datatype | Description |
|---|---|---|
id | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this firmware bundle. |
allowableTransitions | object | A map of firmware bundle upgrades/downgrades validated by OCI. |
compartmentId | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment of this firmware bundle. |
description | string | A brief description or metadata about this firmware bundle. |
displayName | string | The user-friendly name of this firmware bundle. |
lifecycleState | string | The current state of the firmware bundle. (ACTIVE, INACTIVE, DELETE_SCHEDULED) |
platforms | array | A map of platforms to pinned firmware versions. |
timeCreated | string (date-time) | The date and time the firmware bundle 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 the firmware bundle was updated, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
The list is being retrieved.
| Name | Datatype | Description |
|---|---|---|
id | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this firmware bundle. |
allowableTransitions | object | A map of firmware bundle upgrades/downgrades validated by OCI. |
compartmentId | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment of this firmware bundle. |
description | string | A brief description or metadata about this firmware bundle. |
displayName | string | The user-friendly name of this firmware bundle. |
lifecycleState | string | The current state of the firmware bundle. (x-obmcs-enumref: #/definitions/FirmwareBundle/lifecycleState) |
platforms | array | A map of platforms to pinned firmware versions. |
timeCreated | string (date-time) | The date and time the firmware bundle 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 the firmware bundle 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 |
|---|---|---|---|---|
get | select | firmwareBundleId, region | opc-request-id | Returns the Firmware Bundle matching the provided firmwareBundleId.<br /> |
list | select | platform, region | compartmentId, isDefaultBundle, limit, page, lifecycleState, opc-request-id | Gets a list of all Firmware Bundles in a compartment for specified platform. Can filter results to include <br />only the default (recommended) Firmware Bundle for the given platform.<br /> |
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 |
|---|---|---|
firmwareBundleId | string | Unique identifier for the firmware bundle. |
platform | string | platform name |
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) |
compartmentId | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. |
isDefaultBundle | boolean | If true, return only the default firmware bundle for a given platform. Default is false. |
lifecycleState | string | A filter to return only resources that match the given lifecycle state name exactly. |
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). |
SELECT examples​
- get
- list
Returns the Firmware Bundle matching the provided firmwareBundleId.<br />
SELECT
id,
allowableTransitions,
compartmentId,
description,
displayName,
lifecycleState,
platforms,
timeCreated,
timeUpdated
FROM oci.compute.firmware_bundles
WHERE firmwareBundleId = '{{ firmwareBundleId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;
Gets a list of all Firmware Bundles in a compartment for specified platform. Can filter results to include <br />only the default (recommended) Firmware Bundle for the given platform.<br />
SELECT
id,
allowableTransitions,
compartmentId,
description,
displayName,
lifecycleState,
platforms,
timeCreated,
timeUpdated
FROM oci.compute.firmware_bundles
WHERE platform = '{{ platform }}' -- required
AND region = '{{ region }}' -- required
AND compartmentId = '{{ compartmentId }}'
AND isDefaultBundle = '{{ isDefaultBundle }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND lifecycleState = '{{ lifecycleState }}'
AND opc-request-id = '{{ opc-request-id }}'
;