hsm_partitions

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

Overview

Name	hsm_partitions
Type	Resource
Id	oci.kms.hsm_partitions

Fields

The following fields are returned by SELECT queries:

get

The request is processed successfully. HSM information is returned as response.

Name	Datatype	Description
id	string	The OCID of the HSM resource. Each HSM resource has a unique OCID as an identifier.
compartmentId	string	The OCID of the compartment that contains a particular HSM resource.
lifecycleState	string	A HSMCluster resource's current lifecycle state. Example: ACTIVE (ACTIVE, INACTIVE, ACTIVATING, ACTIVATION_REQUIRED, SCHEDULING_DELETION, PENDING_DELETION, DELETING, DELETED)
portInformation	array	Details of a single portInformation item include the PortNumber (an integer used as an identifier) and the PortType (refers to either an enum value of Managementutility,Clientutility, or null)
timeCreated	string (date-time)	The date and time a HSMPartition was created, expressed in [RFC 3339](https:​//tools.ietf.org/html/rfc3339) timestamp format. Example: 2018-04-03T21:10:29.600Z
timeUpdated	string (date-time)	The date and time a HSMPartition was updated, expressed in [RFC 3339](https:​//tools.ietf.org/html/rfc3339) timestamp format. Example: 2018-04-03T21:10:29.600Z

list

List of HSM summary is returned.

Name	Datatype	Description
id	string	The OCID of the HSM resource. Each HSM resource will have a unique OCID identifier.
compartmentId	string	The OCID of the compartment that contains a particular HSM resource.
hsmClusterId	string	The OCID of the HSMCluster that contains a particular HSM resource.
lifecycleState	string	A HSMCluster resource's current lifecycle state. Example: ACTIVE (x-obmcs-enumref: #/definitions/HsmPartition/lifecycleState)
portInformation	array	Details of a single portInformation item include the PortNumber (an integer used as an identifier) and the PortType (refers to either an enum value of Managementutility,Clientutility, or null)
timeCreated	string (date-time)	The date and time an HSM was created, expressed in [RFC 3339](https:​//tools.ietf.org/html/rfc3339) timestamp format. Example: 2018-04-03T21:10:29.600Z
timeUpdated	string (date-time)	The date and time an HSM was updated, expressed in [RFC 3339](https:​//tools.ietf.org/html/rfc3339) timestamp format. Example: 2018-04-03T21:10:29.600Z

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	hsmClusterId, hsmPartitionId, region	opc-request-id, opc-retry-token	Retrieves HSM partition details for the specified HSM cluster.<br />
list	select	hsmClusterId, region	limit, page, opc-request-id, sortBy, sortOrder, lifecycleState	Lists all HSM partitions within the specified HSM Cluster resource.<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
hsmClusterId	string	The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.
hsmPartitionId	string	The OCID of the HSM Partition. This is a unique identifier which each hsmPartition will have.
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)
lifecycleState	string	A filter that returns only resources that match the specified lifecycle state. The state value is case-insensitive.
limit	integer	The maximum number of items to return in a paginated "List" call.
opc-request-id	string	Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
opc-retry-token	string	A 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 (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
page	string	The value of the opc-next-page response header from the previous "List" call.
sortBy	string	The field to sort by. You can specify only one sort order. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.
sortOrder	string	The sort order to use, either ascending (ASC) or descending (DESC).

SELECT examples

get

Retrieves HSM partition details for the specified HSM cluster.<br />

SELECT
id,
compartmentId,
lifecycleState,
portInformation,
timeCreated,
timeUpdated
FROM oci.kms.hsm_partitions
WHERE hsmClusterId = '{{ hsmClusterId }}' -- required
AND hsmPartitionId = '{{ hsmPartitionId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
AND opc-retry-token = '{{ opc-retry-token }}'
;

list

Lists all HSM partitions within the specified HSM Cluster resource.<br />

SELECT
id,
compartmentId,
hsmClusterId,
lifecycleState,
portInformation,
timeCreated,
timeUpdated
FROM oci.kms.hsm_partitions
WHERE hsmClusterId = '{{ hsmClusterId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND opc-request-id = '{{ opc-request-id }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
;