vm_cluster_updates

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

Overview

Name	vm_cluster_updates
Type	Resource
Id	oci.database.vm_cluster_updates

Fields

The following fields are returned by SELECT queries:

get

The maintenance update package.

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update.
availableActions	array	The possible actions that can be performed using this maintenance update.
description	string	Details of the maintenance update package.
lastAction	string	The update action performed most recently using this maintenance update. (ROLLING_APPLY, PRECHECK, ROLLBACK)
lifecycleDetails	string	Descriptive text providing additional details about the lifecycle state.
lifecycleState	string	The current state of the maintenance update. Dependent on value of lastAction. (AVAILABLE, SUCCESS, IN_PROGRESS, FAILED)
timeReleased	string (date-time)	The date and time the maintenance update was released.
updateType	string	The type of VM cluster maintenance update. (GI_UPGRADE, GI_PATCH, OS_UPDATE)
version	string	The version of the maintenance update package.

list

A maintenance update for a VM cluster. Applies to Exadata Cloud@Customer instances only.<br /><br />To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,<br />talk to an administrator. If you're an administrator who needs to write policies to give users access,<br />see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).<br />

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update.
availableActions	array	The possible actions that can be performed using this maintenance update.
description	string	Details of the maintenance update package.
lastAction	string	The update action performed most recently using this maintenance update. (ROLLING_APPLY, PRECHECK, ROLLBACK)
lifecycleDetails	string	Descriptive text providing additional details about the lifecycle state.
lifecycleState	string	The current state of the maintenance update. Dependent on value of lastAction. (AVAILABLE, SUCCESS, IN_PROGRESS, FAILED)
timeReleased	string (date-time)	The date and time the maintenance update was released.
updateType	string	The type of VM cluster maintenance update. (GI_UPGRADE, GI_PATCH, OS_UPDATE)
version	string	The version of the maintenance update package.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	vmClusterId, updateId, region	opc-request-id	Gets information about a specified maintenance update package for a VM cluster. Applies to Exadata Cloud@Customer instances only.<br />
list	select	vmClusterId, region	updateType, lifecycleState, limit, page, opc-request-id	Lists the maintenance updates that can be applied to the specified VM cluster. Applies to Exadata Cloud@Customer instances only.<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
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)
updateId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update.
vmClusterId	string	The VM cluster [OCID](/Content/General/Concepts/identifiers.htm).
lifecycleState	string	A filter to return only resources that match the given lifecycle state exactly.
limit	integer	The maximum number of items to return per page.
opc-request-id	string	Unique identifier for the request.
page	string	The pagination token to continue listing from.
updateType	string	A filter to return only resources that match the given update type exactly.

SELECT examples

get

Gets information about a specified maintenance update package for a VM cluster. Applies to Exadata Cloud@Customer instances only.<br />

SELECT
id,
availableActions,
description,
lastAction,
lifecycleDetails,
lifecycleState,
timeReleased,
updateType,
version
FROM oci.database.vm_cluster_updates
WHERE vmClusterId = '{{ vmClusterId }}' -- required
AND updateId = '{{ updateId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

Lists the maintenance updates that can be applied to the specified VM cluster. Applies to Exadata Cloud@Customer instances only.<br />

SELECT
id,
availableActions,
description,
lastAction,
lifecycleDetails,
lifecycleState,
timeReleased,
updateType,
version
FROM oci.database.vm_cluster_updates
WHERE vmClusterId = '{{ vmClusterId }}' -- required
AND region = '{{ region }}' -- required
AND updateType = '{{ updateType }}'
AND lifecycleState = '{{ lifecycleState }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND opc-request-id = '{{ opc-request-id }}'
;