B Exascale Resources and Attributes
The ESCLI describe command displays
information about Exascale resources and their
attributes.
The following tables show information from the ESCLI
describe --all command. The information is current for Exascale resources and their attributes in Oracle
Exadata System Software release 26.1.0 (May 2026).
acfsFileSystems
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| acfsCompat | String | ACFS compatibility (default is the ACFS software version under which the file system was created). String size: 1 - 31 characters. | Optional | false |
| acfsVersion | String | ACFS version under which file system was created | No | false |
| auSize | Integer (ub4) | Allocation unit size | No | false |
| autoShrinkEnabled | Boolean | State of auto-shrink on this file system | No | false |
| compressionEnabled | Boolean | State of compression on this file system | No | false |
| creationTime | Date | Time file system created | No | false |
| encryptionAlgorithm | String | Encryption algorithm for this file system | No | false |
| encryptionEnabled | Boolean | State of ACFS-based encryption on this file system | Optional | false |
| encryptionKeyLength | Integer (ub4) | Encryption key length (in bytes) for this file system | No | false |
| fileEntryTableAllocation | SpaceSize | Size of the File Entry Table | No | false |
| flags | String | File system state flags | No | false |
| giClusterId | String | Global unique identifier (GUID) for the Oracle Grid Infrastructure (GI) cluster where the file system is attached. | No | false |
| label | String | Volume label (default is no label). String size: 0 - 63 characters. | Optional | false |
| logSectorSize | Integer (ub4) | Logical sector size for this volume | No | false |
| metadataSize | Integer (ub4) | Metadata block size (in bytes). Valid values: '512', or '4096'. Default: 4096. | Optional | false |
| mountLeafGroup | Integer (ub4) | Group ownership of the mount point leaf directory (specified as a numeric ID; default is zero (the root group)). | Optional | false |
| mountLeafMode | String | Mode of the mount point leaf directory (specified as an octal number). String size: 3 - 4 characters. Default: 755. | Optional | false |
| mountLeafOwner | Integer (ub4) | User ownership of the mount point leaf directory (specified as a numeric ID; default is zero (the root user)). | Optional | false |
| mountNoRootSUID | Boolean | Disallow set user ID binary execution by non-root user (default is false; i.e., allow set user ID binary execution). | Optional | false |
| mountPath | String | Absolute directory path on which volume is mounted. String size: 2 - 1023 characters. | Mandatory | false |
| mountReadOnly | Boolean | Mount the file system read-only (default is false; i.e., mount with read-write access). | Optional | false |
| mountTime | Date | Time of last mount | No | false |
| name | String | File system name (case-sensitive). If not specified during file system creation, the name is automatically generated. String size: 1 - 63 characters. | Optional | false |
| nodeCount | Integer (ub8) | Number of nodes having this file system mounted | No | false |
| nodeId | String | Identifier for the EDV node where the file system is attached. | No | false |
| onDiskVersion | String | ACFS on-disk version | No | false |
| replicationEnabled | Boolean | State of replication on this file system | No | false |
| size | SpaceSize | Size of the file system in bytes (default is the size of the containing block volume). If specified, must be less than or equal to the size of the containing block volume. | Optional | false |
| snapShots | JSON | JSON array of ACFS snapshots of this file system | No | false |
| snapshotCount | Integer (ub4) | Number of ACFS snapshots associated with this file system | No | false |
| snapshotSpaceUsage | SpaceSize | Number of bytes consumed by ACFS snapshots of this file system | No | false |
| state | String | State of the volume | No | false |
| storageInterestTrackingEnabled | Boolean | State of storage interest tracking on this file system | No | false |
| totalFree | SpaceSize | Number of free bytes on the file system | No | false |
| user | String | Exascale user ID associated with the file system. Default: 'null'. | Optional | false |
| volume | String | Volume ID. String size: 1 - 63 characters. | Mandatory | false |
| volumeType | String | Type of volume hosting the file system | No | false |
cellDisks
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| comment | String | User-specified comment | No | false |
| creationTime | String | Creation timestamp | No | false |
| deviceName | String | Operating system device name for the cell disk LUN | No | false |
| devicePartition | String | Operating system device name for the cell disk partition | No | false |
| diskType | String | Disk type | No | false |
| errorCount | String | Total error count | No | false |
| freeSpace | String | Total unused space (in bytes) | No | false |
| name | String | Cell disk name | No | false |
| physicalDisk | String | Physical disk that contains the cell disk | No | false |
| size | String | Total cell disk size (in bytes) | No | false |
| status | String | Cell disk status. For example: 'normal' or 'importRequired' | No | false |
| uuid | String | Cell disk global unique identifier (GUID) | No | false |
cells
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| accessLevelPerm | String | Cell access level: 'remoteLoginEnabled' or 'remoteLoginDisabled' | No | false |
| allCellPartners | String | All partner cells | No | false |
| bbuStatus | String | Status of the hard disk controller battery-backed unit (BBU) | No | false |
| bootDeviceStatus | String | Status of the boot device | No | false |
| bsmStatus | String | Status of the Exascale block store manager service | No | false |
| bswStatus | String | Status of the Exascale block store worker service | No | false |
| cellVersion | String | Cell software label | No | false |
| cellsrvStatus | String | Status of cell service | No | false |
| cpuCount | String | Number of CPUs on the cell | No | false |
| diagHistoryDays | String | Automatic diagnostic repository (ADR) retention period (in days) | No | false |
| doNotServiceLEDStatus | String | Status of the cell DoNotService LED: 'on' or 'off' | No | false |
| efDataCellPartners | String | Extreme flash (EF) data ring partner cells | No | false |
| efRecoCellPartners | String | Extreme flash (EF) recovery ring partner cells | No | false |
| egsStatus | String | Status of Exascale cluster services | No | false |
| ersStatus | String | Status of Exascale REST services | No | false |
| events | String | Trace events set | No | false |
| fanCount | String | Number of fans (working/total) | No | false |
| fanStatus | String | Fan status: 'normal', 'warning', or 'critical' | No | false |
| flashCacheMode | String | Flash cache mode: 'writethrough' or 'writeback'. The default is 'writethrough'. | No | false |
| hcDataCellPartners | String | High capacity (HC) data ring partner cells | No | false |
| hcRecoCellPartners | String | High capacity (HC) recovery ring partner cells | No | false |
| httpsAccess | String | IP addresses or subnets with access to Exadata REST services using HTTPs. The value can be 'ALL', 'NONE', or a comma-separated list of IP addresses or subnet masks. | No | false |
| ifdStatus | String | Exascale Instant Failure Detection (IFD) status | No | false |
| ilomIpAddress | String | Integrated Lights Out Management (ILOM) IP address | No | false |
| ilomSyslogClients | String | The remote destination to forward Syslog messages from the Integrated Lights Out Manager (ILOM) service processor (SP). The value is the hostname or IP address of a remote log server or a comma-separated list of up to two log servers. | No | false |
| interconnect1 | String | Network interface for interconnect1 | No | false |
| interconnect2 | String | Network interface for interconnect2 | No | false |
| interconnect3 | String | Network interface for interconnect3 | No | false |
| interconnect4 | String | Network interface for interconnect4 | No | false |
| interconnectCount | String | Number of active RDMA Network Fabric interfaces | No | false |
| iormBoost | String | Ratio of the cumulative number of positions in the I/O queue skipped because of IORM scheduling, relative to the total number of scheduled I/Os. The value is recalculated every minute. | No | false |
| ipaddress1 | String | ipaddress1 for the cell | No | false |
| ipaddress2 | String | ipaddress2 for the cell | No | false |
| ipaddress3 | String | ipaddress3 for the cell | No | false |
| ipaddress4 | String | ipaddress4 for the cell | No | false |
| kernelVersion | String | Operating system kernel software version | No | false |
| locatorLEDStatus | String | Status of the cell Locate LED: 'on' or 'off' | No | false |
| makeModel | String | Cell hardware make and model | No | false |
| managementIpAddress | String | Management IP address | No | false |
| memoryGB | String | Cell memory (GB) | No | false |
| metricCollection | String | Specifies if Management Server (MS) performs metric collection. If 'FALSE', then no metric collection or alert mining occurs in the cell. The default setting is 'TRUE'. | No | false |
| metricFGCollIntvlInSec | String | Controls fine-grained metric collection. If the value is between 1 and 60, fine-grained metric collection is enabled, and the value represents the collection interval (in seconds). If the value is zero, then fine-grained metric collection is disabled. | No | false |
| metricHistoryDays | String | Retention period (in days) for metric history files | No | false |
| metricStreamEndPoint | String | Specifies one or more collection endpoints that automatically receive the metric stream. The value uses the following syntax: ((host='<endpoint-URL>'[,type='<stream-format>'][,token='<authentication-token>'][,{httpProxy|httpsProxy}='<proxy-server>']) [,(host='<endpoint-URL>'[,type='<stream-format>'][,token='<authentication-token>'][,{httpProxy|httpsProxy}='<proxy-server>'])]...) | No | false |
| metricStreamIntvlInSec | String | Controls automatic metric upload, otherwise known as streaming. If the value is zero, then streaming is disabled. Otherwise, the value represents the upload interval (in seconds) for automatic uploads to the metric streaming endpoints specified by the metricStreamEndPoint attribute. | No | false |
| msStatus | String | Status of Management Server | No | false |
| name | String | Unique name for the cell | No | false |
| offloadGroupEvents | String | Used only under the guidance of Oracle Support | No | false |
| powerCount | String | Number of power supplies (working/total) | No | false |
| powerStatus | String | Power status: 'normal', 'warning', or 'critical' | No | false |
| ramCacheMaxSize | String | Maximum possible size for the cell RAM cache | No | false |
| ramCacheMode | String | Cell RAM cache mode: 'on' or 'off' (disabled) | No | false |
| ramCacheSize | String | Size of the cell RAM cache | No | false |
| releaseImageStatus | String | Cell imaging success indicator | No | false |
| releaseTrackingBug | String | Cell software patch number. For example: 11223344 | No | false |
| releaseVersion | String | Cell software release number. For example: 21.2.0.0.0 | No | false |
| restSubscriber | String | REST subscriber | No | false |
| rollbackVersion | String | Inactive image version maintained on the cell, which is reinstated if a patchmgr rollback operation is invoked | No | false |
| rpmVersion | String | Cell RPM version | No | false |
| rsStatus | String | Status of Restart Server | No | false |
| snmpSubscriber | String | List of hosts that subscribe to the SNMP alert notifications | No | false |
| status | String | Status of the cell | No | false |
| sysEdsStatus | String | Status of the Exascale system vault manager service | No | false |
| syslogConf | String | Specification for forwarding Syslog messages to remote management servers. In the value, each <selector> defines a message type, and each <node> is a target server. The <selector> and <node> specifications follow the standard syntax rules for syslog.conf. The value uses the following syntax: ('<selector> @<node>' [, '<selector> @<node>']... ) | No | false |
| syslogInput | String | Syslog input | No | false |
| temperatureReading | String | Current cell temperature (Celsius) from the baseboard management controller (BMC) | No | false |
| temperatureStatus | String | Temperature status: 'normal', 'warning', or 'critical' | No | false |
| traceLevel | String | Level of detail for trace messages | No | false |
| upTime | String | Time since system startup (days, hours:minutes) | No | false |
| usbStatus | String | Status of the USB device | No | false |
| usrEdsStatus | String | Status of the Exascale user vault manager service | No | false |
| uuid | String | Global unique identifier (GUID) for the cell hardware | No | false |
| xrmemCacheMode | String | Exadata RDMA memory (XRMEM) cache mode | No | false |
| xtDataCellPartners | String | Extended storage (XT) data ring partner cells | No | false |
| xtRecoCellPartners | String | Extended storage (XT) recovery ring partner cells | No | false |
clusterAlerts
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| alertAction | String | Alert action | No | false |
| alertDescription | String | Short description | No | false |
| alertMessage | String | Alert message | No | false |
| alertShortName | String | Short name | No | false |
| alertType | String | Alert type (case-sensitive). Valid values: 'Stateful', or 'Stateless'. | No | false |
| beginTime | Date | Alert begin time | No | false |
| clusterAlertName | String | Name | No | false |
| examinedBy | String | Name of the user that examined the alert | No | true |
| metricObjectName | String | Metric object name | No | false |
| notificationState | String | Alert notification state | No | false |
| releaseVersion | String | Cell image release version | No | false |
| rpmVersion | String | Cell image RPM version | No | false |
| sequenceBeginTime | Date | Alert sequence begin time | No | false |
| severity | String | Alert severity | No | false |
clusters
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| autoFileEncryption | Boolean | Automatic file encryption | No | true |
| autoGenVaultNames | Boolean | Automatic vault name generation | No | true |
| controlServicesFrontendPriorities | String | The priority storage servers for running front-end control service instances (expressed as <cellname1>:<priority>[;<cellnameN>:<priority>]...). Valid priority values: 1 - 255. String size: up to 660 characters. | No | true |
| controlServicesState | String | The availability state of control services. This attribute is displayed only when automatic service placement is enabled in the Exascale cluster (servicePlacement=auto). The possible values are: 'Available' - Indicates that the expected number of service instances are running; 'Available - reduced redundancy' - Indicates that some instances of the service are running, but the number is fewer than expected; 'Disabled' - Indicates that no instances are configured to run for this service; 'Unavailable' - Indicates that no instances of the service are running. | No | false |
| exaRootLeaderId | Integer (ub4) | Exascale cluster services leader ID | No | false |
| exaRootLeaderInc | Integer (ub4) | Exascale cluster services leader incarnation number | No | false |
| exaRootLeaderUrl | String | Exascale cluster services leader uniform resource locator (URL) | No | false |
| exaRootUrl | String | Exascale cluster services URL | No | false |
| guid | String | Exascale cluster globally unique identifier (GUID) | No | false |
| inclusionFilterControlServicesFrontends | String | The filter used by automatic service placement to govern placement of front-end control service instances. Any storage server hostname that matches the filter is a candidate for inclusion. The filter governs how automatic service placement starts Exascale processes on a storage server. The filter does not impact stopping an Exascale process on a storage server. A filter is a comma-separated list of sub-filters. A sub-filter string may contain any alphanumeric character. The following characters have special meanings: '*' matches any zero or more alphanumeric characters. '?' matches any one alphanumeric character. A character class is specified using a sequence of characters or character ranges within square brackets '[]'. For example, '[4-6a-c]' matches any of the following characters: '4', '5', '6', 'a', 'b', or 'c'. Preceding a character class with '!' or '^' applies a logical 'not' to the character class. For example, '[!4-6a-c]' matches any character except: '4', '5', '6', 'a', 'b', or 'c'. Examples of valid patterns include:'' (an empty string) - Matches any string. '*' - Matches any string. '?' - Matches any single character. 'pandora*' - Matches any string prefixed with 'pandora'. 'pandora[0-1][0-9]' - Matches any string starting with 'pandora' followed by numbers ranging from 00 to 19. String size: up to 255 characters. | No | true |
| minSupportedReleaseVersion | String | Minimum supported release version. String size: up to 255 characters. | No | true |
| name | String | Exascale cluster name | No | false |
| numControlServicesBackends | Integer (ub1) | The number of back-end control service instances to run. Valid values: 0 - 2. Default: 0. | Optional | true |
| numControlServicesFrontends | Integer (ub1) | The number of front-end control service instances to run. Valid values: 3 - 3. Default: 3. | Optional | true |
| numNodes | Integer (ub4) | Number of storage servers in the Exascale Cluster | No | false |
| numStorageVolumeWorkers | Integer (ub1) | The number of volume worker service instances to run on storage nodes. Valid values: 0 - 3. Default: 0. | Optional | true |
| numSystemVaultManagers | Integer (ub1) | The number of system vault manager service instances to run. Valid values: 3 - 5. Default: 3. | Optional | true |
| numUserVaultManagers | Integer (ub1) | The number of user vault manager service instances to run. Valid values: 3 - 5. Default: 3. | Optional | true |
| numVolumeManagers | Integer (ub1) | The number of volume manager service instances to run. Valid values: 0 - 3. Default: 3. | Optional | true |
| restEndPoint | String | Exascale REST services endpoint address. String size: up to 40 characters. | No | true |
| restNetworkID | Integer (ub1) | A unique id to help distinguish exascale clusters deployed on the same subnet. Valid values: 1 - 255. | No | true |
| storageVolumeWorkersState | String | The availability state of volume workers on storage nodes. This attribute is displayed only when automatic service placement is enabled in the Exascale cluster (servicePlacement=auto). The possible values are: 'Available' - Indicates that the expected number of service instances are running; 'Available - reduced redundancy' - Indicates that some instances of the service are running, but the number is fewer than expected; 'Disabled' - Indicates that no instances are configured to run for this service; 'Unavailable' - Indicates that no instances of the service are running. | No | false |
| systemVaultManagersState | String | The availability state of system vault managers. This attribute is displayed only when automatic service placement is enabled in the Exascale cluster (servicePlacement=auto). The possible values are: 'Available' - Indicates that the expected number of service instances are running; 'Available - reduced redundancy' - Indicates that some instances of the service are running, but the number is fewer than expected; 'Disabled' - Indicates that no instances are configured to run for this service; 'Unavailable' - Indicates that no instances of the service are running. | No | false |
| telemetryGenKeyPair | Boolean | Indicates whether to generate an authentication key pair | No | true |
| telemetryKeyId | String | Authentication key ID (case-sensitive). String size: up to 127 characters. | No | true |
| telemetryLogFileList | String | Log file list (case-sensitive). String size: up to 2047 characters. | No | true |
| telemetryProxyUrl | String | URL that receives Exascale alerts (case-sensitive). String size: up to 255 characters. | No | true |
| telemetryPubKey | String | Authentication public key (case-sensitive) | No | false |
| telemetryRemoveKeyPair | Boolean | Indicates whether to remove the existing authentication key pair | No | true |
| telemetryRootCertBundle | String | Root certificate bundle (case-sensitive). String size: up to 12287 characters. | No | true |
| telemetryRsyslogRelay | String | Rsyslog server for log messages (expressed as <host>:<port>). String size: up to 255 characters. | No | true |
| telemetryRsyslogRelayIlom | String | Rsyslog server for Integrated Lights Out Management (ILOM) log messages (expressed as <host>:<port>). String size: up to 255 characters. | No | true |
| trustStore | String | Trust store content in PEM format | No | false |
| trustStoreDigest | String | Trust store digest in HEX format | No | false |
| userVaultManagersState | String | The availability state of user vault managers. This attribute is displayed only when automatic service placement is enabled in the Exascale cluster (servicePlacement=auto). The possible values are: 'Available' - Indicates that the expected number of service instances are running; 'Available - reduced redundancy' - Indicates that some instances of the service are running, but the number is fewer than expected; 'Disabled' - Indicates that no instances are configured to run for this service; 'Unavailable' - Indicates that no instances of the service are running. | No | false |
| volumeManagersState | String | The availability state of volume managers. This attribute is displayed only when automatic service placement is enabled in the Exascale cluster (servicePlacement=auto). The possible values are: 'Available' - Indicates that the expected number of service instances are running; 'Available - reduced redundancy' - Indicates that some instances of the service are running, but the number is fewer than expected; 'Disabled' - Indicates that no instances are configured to run for this service; 'Unavailable' - Indicates that no instances of the service are running. | No | false |
computes
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| accessLevelPerm | String | Compute node access level: 'remoteLoginEnabled' or 'remoteLoginDisabled' | No | false |
| bswStatus | String | Status of the Exascale block store worker service | No | false |
| cpuCount | String | Number of CPUs on the compute node | No | false |
| diagHistoryDays | String | Automatic diagnostic repository (ADR) retention period (in days) | No | false |
| doNotServiceLEDStatus | String | Status of the server DoNotService LED: 'on' or 'off' | No | false |
| edvStatus | String | Status of the Exascale direct volume service | No | false |
| egsStatus | String | Status of Exascale cluster services | No | false |
| esnpStatus | String | Status of the Exascale node proxy service | No | false |
| events | String | Trace events set | No | false |
| fanCount | String | Number of fans (working/total) | No | false |
| fanStatus | String | Fan status: 'normal', 'warning', or 'critical' | No | false |
| flashCacheMode | String | Flash cache mode: 'writethrough' or 'writeback'. The default is 'writethrough'. | No | false |
| httpsAccess | String | IP addresses or subnets with access to Exadata REST services using HTTPs. The value can be 'ALL', 'NONE', or a comma-separated list of IP addresses or subnet masks. | No | false |
| ilomIpAddress | String | Integrated Lights Out Management (ILOM) IP address | No | false |
| interconnect1 | String | Network interface for interconnect1 | No | false |
| interconnect2 | String | Network interface for interconnect2 | No | false |
| interconnect3 | String | Network interface for interconnect3 | No | false |
| interconnect4 | String | Network interface for interconnect4 | No | false |
| interconnectCount | String | Number of active RDMA Network Fabric interfaces | No | false |
| iormBoost | String | Ratio of the cumulative number of positions in the I/O queue skipped because of IORM scheduling, relative to the total number of scheduled I/Os. The value is recalculated every minute. | No | false |
| ipaddress1 | String | ipaddress1 for the compute node | No | false |
| ipaddress2 | String | ipaddress2 for the compute node | No | false |
| ipaddress3 | String | ipaddress3 for the compute node | No | false |
| ipaddress4 | String | ipaddress4 for the compute node | No | false |
| kernelVersion | String | Operating system kernel software version | No | false |
| locatorLEDStatus | String | Status of the server Locate LED: 'on' or 'off' | No | false |
| makeModel | String | Compute hardware make and model | No | false |
| managementIpAddress | String | Management network IP address | No | false |
| memoryGB | String | Compute node memory (GB) | No | false |
| metricHistoryDays | String | Retention period (in days) for metric history files | No | false |
| msStatus | String | Status of Management Server | No | false |
| msVersion | String | Exadata software release number. For example: 21.2.0.0.0 | No | false |
| name | String | Unique compute node name | No | false |
| offloadGroupEvents | String | Used only under the guidance of Oracle Support | No | false |
| powerCount | String | Number of power supplies (working/total) | No | false |
| powerStatus | String | Power status: 'normal', 'warning', or 'critical' | No | false |
| ramCacheMaxSize | String | Maximum possible RAM cache size | No | false |
| ramCacheMode | String | RAM cache mode: 'on' or 'off' (disabled) | No | false |
| ramCacheSize | String | RAM cache size | No | false |
| releaseImageStatus | String | Imaging success indicator | No | false |
| releaseTrackingBug | String | Exadata software patch number. For example: 11223344 | No | false |
| releaseVersion | String | Exadata software release number. For example: 21.2.0.0.0 | No | false |
| rpmVersion | String | Compute node RPM version | No | false |
| rsStatus | String | Status of Restart Server | No | false |
| snmpSubscriber | String | List of hosts that subscribe to the SNMP alert notifications | No | false |
| status | String | Compute node status | No | false |
| temperatureReading | String | Current temperature (Celsius) from the baseboard management controller (BMC) | No | false |
| temperatureStatus | String | Temperature status: 'normal', 'warning', or 'critical' | No | false |
| traceLevel | String | Level of detail for trace messages | No | false |
| upTime | String | Time since system startup (days, hours:minutes) | No | false |
| usbStatus | String | Status of the USB device | No | false |
| uuid | String | Global unique identifier (GUID) for the compute hardware | No | false |
| xrmemCacheMode | String | Exadata RDMA memory (XRMEM) cache mode | No | false |
containerResources
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| flashCacheProv | SpaceSize | Provisioned flash cache space (in bytes). Valid values: up to 4503599626321920. | No | true |
| flashLogProv | Boolean | Specifies whether flash log is provisioned | No | true |
| guid | String | Storage pool global unique identifier (GUID) | No | true |
| iopsProv | IopsCount | IOPS Provisioned. Valid values: up to 4294967295. | No | true |
| mediaType | String | Storage pool media type. Valid values: 'HC', 'EF', or 'XT'. | No | true |
| spaceProv | SpaceSize | Provisioned storage space (in bytes). Valid values: up to 4503599626321920. | No | true |
| spaceUsed | SpaceSize | Used space (in bytes). Valid values: up to 4503599626321920. | No | true |
| storagePool | String | Storage pool name. String size: 1 - 64 characters. | No | true |
| vault | String | The name of the vault containing the provisioned resources | No | true |
| xrmemCacheProv | SpaceSize | Provisioned XRMEM cache space (in bytes). Valid values: up to 4503599626321920. | No | true |
| xrmemLogProv | Boolean | Specifies whether XRMEM log is provisioned | No | true |
datasets
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| datasetSpaceUsedEF | SpaceSize | Total space in EF media used by files in this and descendant datasets. | No | false |
| datasetSpaceUsedHC | SpaceSize | Total space in HC media used by files in this and descendant datasets. | No | false |
| datasetSpaceUsedXT | SpaceSize | Total space in XT media used by files in this and descendant datasets. | No | false |
| fileSpaceUsedEF | SpaceSize | Total space in EF media used by files in this dataset. | No | false |
| fileSpaceUsedHC | SpaceSize | Total space in HC media used by files in this dataset. | No | false |
| fileSpaceUsedXT | SpaceSize | Total space in XT media used by files in this dataset. | No | false |
| name | String | Dataset name. String size: up to 255 characters. | Optional | false |
| storagePoolSpaceUsed | JSON | JSON array of storage pool space usage statistics. | No | false |
edvNodes
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| edvBaseDriverVersion | String | Base version of the EDV driver resulting from the last system update or patch installation with reboot | No | false |
| edvEffectiveDriverVersion | String | Currently effective version of the EDV driver. Contains the base version plus any Ksplice updates that are in effect | No | false |
| giClusterId | String | Global unique identifier (GUID) for the Oracle Grid Infrastructure (GI) cluster that contains the EDV node | No | false |
| giClusterName | String | Name of the GI cluster that contains the EDV node | No | false |
| hostName | String | EDV node name | No | false |
| lastHeartbeat | Date | EDV node last heartbeat time | No | false |
| registerTime | Date | EDV node registration time | No | false |
| state | String | EDV node state. Valid values: 'INITIAL', 'REGISTERING', 'OFFLINING', or 'ONLINE'. | No | false |
| user | String | EDV node storage owner (Exascale user ID) | No | false |
| version | String | Software version of the EDV node | No | false |
edvVolumeAttachments
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| atomicToken | String | Identifier for an atomic operation that involves multiple volume attachments. Default: 'FALSE'. | Optional | true |
| attachTime | Date | Creation timestamp | No | false |
| deviceName | String | Name of the storage device associated with the attachment. String size: 1 - 127 characters. | Mandatory | false |
| devicePath | String | Absolute path of the storage device on the EDV node | No | false |
| enabledOnRestart | Boolean | Indicates whether the volume attachment will be enabled if the initiator restarts | No | false |
| giClusterId | String | Global unique identifier (GUID) for the Oracle Grid Infrastructure (GI) cluster that contains the EDV attachment. When creating an EDV attachment, either 'giClusterId' or 'initiator' must be specified. String size: 32 - 36 characters. | Optional | false |
| giClusterName | String | Name of the GI cluster that contains the EDV attachment | No | false |
| hostName | String | Host name associated with the attachment | No | false |
| initiator | String | Identifier for the EDV node that contains the attachment. When creating an EDV attachment, either 'giClusterId' or 'initiator' must be specified. String size: 32 - 36 characters. | Optional | false |
| kernelDeviceName | String | Kernel device name of the storage device associated with the attachment | No | false |
| logicalSectorSize | Integer (ub4) | Volume logical sector size | No | false |
| user | String | Exascale user ID associated with the attachment. Default: 'null'. | Optional | false |
| volume | String | Attached volume ID. String size: 1 - 63 characters. | Mandatory | false |
| volumeSnapshot | String | Snapshot identifier. Used only for snapshot attachments. | No | false |
files
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| acl | String | Access control list. String size: up to 16384 characters. | No | true |
| contentType | String | Content type. If not specified during file creation, the value is derived from the file type and associated template. Valid values: 'data', or 'reco'. | Optional | false |
| createTime | Date | File creation time | No | false |
| createdBy | String | File owner | No | false |
| fileType | String | Oracle file type: 'ARCHIVELOG', 'CONTROLFILE', 'DATAFILE', 'ONLINELOG', and so on. Default: 'null'. | Optional | false |
| mediaType | String | Media type. If not specified during file creation, the value is derived from the file type and associated template. Valid values: 'HC', 'EF', or 'XT'. | Optional | false |
| name | String | File name | Optional | false |
| redundancy | String | Redundancy setting. If not specified during file creation, the value is derived from the file type and associated template. | Optional | false |
| size | SpaceSize | File size (in bytes). Default: 0. | Optional | true |
| snapLockExpiryTime | Date | Snapshot lock expiry date and time (applies only to snapshot files). To unlock a locked snapshot, set the expiry time to 'null' (snapLockExpiryTime='null'). You can modify this attribute only if the snapshot lock is not immutable (snapLockImmutable=FALSE). | No | true |
| snapLockImmutable | Boolean | Indicates whether the lock is immutable. When a lock is immutable, the file cannot be unlocked before the lock expires, and the lock cannot be modified to expire sooner (applies only to snapshot files). | No | true |
| snapLockStatus | String | Indicates the snapshot lock status: 'locked' if the lock is active, or 'expired' if the lock expiry time has passed (applies only to snapshot files with a lock expiry time). | No | false |
| spaceUsed | SpaceSize | Vault space used by the file (in bytes). | No | false |
| storagePool | String | Name of the storage pool that contains the file. String size: 1 - 64 characters. | Optional | false |
| templateName | String | Name of the template used only during file creation (case-sensitive). The attribute value is not retained after file creation. String size: 1 - 31 characters. | Optional | false |
| usedBy | String | Oracle database that uses the file | No | false |
| vaultName | String | Name of the vault containing the file. The value may also be derived from the URL for some APIs. For example, myVault is the vault name in the following API call: PUT /files/@myVault/myFile | Optional | false |
| xAttrs | String | Comma-separated extended file attribute names | No | false |
gridDisks
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| asmDiskGroupName | String | Oracle ASM disk group containing the grid disk | No | false |
| asmDiskName | String | Oracle ASM disk name | No | false |
| asmFailGroupName | String | Oracle ASM failure group | No | false |
| availableTo | String | Clients with access to the grid disk | No | false |
| cachedBy | String | Flash disks currently used by write-back flash cache to cache grid disk data | No | false |
| cachingPolicy | String | Flash cache policy: 'DEFAULT' indicates that the grid disk uses flash cache. 'NONE' indicates that the grid disk does not use flash cache. | No | false |
| cell | String | Name of the cell containing the grid disk | No | false |
| cellDisk | String | Name of the cell disk containing the grid disk | No | false |
| comment | String | User-specified comment | No | false |
| creationTime | String | Creation timestamp | No | false |
| diskType | String | Disk type | No | false |
| errorCount | String | Total error count | No | false |
| name | String | Grid disk name | No | false |
| poolDiskStatus | String | Status of the associated pool disk | No | false |
| size | String | Total grid disk size (in bytes) | No | false |
| sizeAllocated | String | Total used space (in bytes) (applies only to sparse grid disks) | No | false |
| spaceUsed | String | Total used space (in bytes) (applies only to Exascale grid disks) | No | false |
| status | String | Grid disk status. For example: 'ACTIVE', 'INACTIVE', 'NOT PRESENT', or 'IMPORTREQUIRED'. | No | false |
| storagePool | String | Storage pool that contains the grid disk | No | false |
| uuid | String | Grid disk global unique identifier (GUID) | No | false |
poolDisks
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| cellId | Integer (ub4) | Cell ID for the cell containing the pool disk | No | false |
| gdName | String | Grid disk name associated with the pool disk | No | false |
| healthy | Boolean | Health indicator | No | false |
| incarnation | Integer (ub4) | Incarnation number | No | false |
| name | String | Pool disk name | No | false |
| size | SpaceSize | Total pool disk size (in bytes) | No | false |
| state | String | Life-cycle state | No | false |
| status | String | Pool disk status. You can only modify the pool disk status to 'ONLINE' or 'OFFLINE'. Valid values: 'BEING_ADDED', 'BEING_ADDED_FORCE', 'BEING_ONLINED', 'ONLINE', 'BEING_OFFLINED', 'OFFLINE', 'BEING_OFFLINED_MAINTENANCE', 'OFFLINE_MAINTENANCE', 'BEING_DROPPED', 'DROPPED', 'BEING_DROPPED_FORCE', 'DROPPED_FORCE', 'BEING_DROPPED_PERMANENT', or 'BEING_DROPPED_FORCE_PERMANENT'. | No | true |
| storagePool | String | Storage pool that contains the pool disk | No | false |
resourceProfiles
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| enableFlashCache | Boolean | Enable or disable use of flash cache for clients associated with the resource profile. A 'true' value means enabled. Default: 'true'. | Optional | true |
| enableFlashLog | Boolean | Enable or disable use of flash log for clients associated with the resource profile. A 'true' value means enabled. Default: 'true'. | Optional | true |
| enableXrmemCache | Boolean | Enable or disable use of XRMEM cache for clients associated with the resource profile. A 'true' value means enabled. Default: 'true'. | Optional | true |
| flashCacheMin | String | Guaranteed minimum share of flash cache available to each client. The value is a percentage with up to two decimal places.Valid values: 0 - 100. Default: 0. If the sum of all minimum values exceeds 100% across all clients and resource profiles, then all values are scaled down proportionally to ensure that share guarantees can be honored. Valid only if 'enableFlashCache=true'. A zero (0) value means no set minimum. | Optional | true |
| flashCacheSize | String | Upper limit of flash cache available to each client. The value is a percentage with up to two decimal places.Valid values: 0 - 100. Default: 100. Valid only if 'enableFlashCache=true'. | Optional | true |
| iopsLimitEF | String | Upper limit of extreme flash (EF) media IOPS available to each client. The value is a percentage with up to two decimal places.Valid values: 0 - 100. Default: 100. | Optional | true |
| iopsLimitHC | String | Upper limit of high capacity (HC) media IOPS available to each client. The value is a percentage with up to two decimal places.Valid values: 0 - 100. Default: 100. | Optional | true |
| iopsLimitXT | String | Upper limit of extended storage (XT) media IOPS available to each client. The value is a percentage with up to two decimal places.Valid values: 0 - 100. Default: 100. | Optional | true |
| iopsShareEF | Integer (ub4) | Share of IOPS from extreme flash (EF) media available to each client. Each client's share is relative to all other client shares. A higher share value implies higher priority. For example, a client with a share value of 2 gets twice as many IOPS as a client with a share value of 1, but both clients get far less than another client with a share value of 50. Valid values: 0 - 100. Default: 1. | Optional | true |
| iopsShareHC | Integer (ub4) | Share of IOPS from high capacity (HC) media available to each client. Each client's share is relative to all other client shares. A higher share value implies higher priority. For example, a client with a share value of 2 gets twice as many IOPS as a client with a share value of 1, but both clients get far less than another client with a share value of 50. Valid values: 0 - 100. Default: 1. | Optional | true |
| iopsShareXT | Integer (ub4) | Share of IOPS from extended storage (XT) media available to each client. Each client's share is relative to all other client shares. A higher share value implies higher priority. For example, a client with a share value of 2 gets twice as many IOPS as a client with a share value of 1, but both clients get far less than another client with a share value of 50. Valid values: 0 - 100. Default: 1. | Optional | true |
| name | String | Resource profile name. String size: up to 32 characters. | Mandatory | false |
| vault | String | Vault name. String size: up to 30 characters. | Mandatory | false |
| xrmemCacheMin | String | Guaranteed minimum share of XRMEM cache available to each client. The value is a percentage with up to two decimal places. Valid values: 0 - 100. Default: 0. If the sum of all minimum values exceeds 100% across all clients and resource profiles, then all values are scaled down proportionally to ensure that share guarantees can be honored. Valid only if 'enableXrmemCache=true'. A zero (0) value means no set minimum. | Optional | true |
| xrmemCacheSize | String | Upper limit of XRMEM cache available to each client. The value is a percentage with up to two decimal places.Valid values: 0 - 100. Default: 100. Valid only if 'enableXrmemCache=true'. | Optional | true |
services
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| cellName | String | Cell name on the server running the service | No | false |
| cssBirthIncarnation | Integer (ub4) | CSS cluster birth incarnation. Only for Exascale Node Proxy (ESNP). | No | false |
| cssClusterName | String | CSS cluster name. Only for Exascale Node Proxy (ESNP). | No | false |
| cssGUID | String | CSS cluster GUID. Only for Exascale Node Proxy (ESNP). | No | false |
| cssNodeID | Integer (ub4) | CSS node ID. Only for Exascale Node Proxy (ESNP). | No | false |
| cssNodeIncarnation | Integer (ub4) | CSS node incarnation. Only for Exascale Node Proxy (ESNP). | No | false |
| egsName | String | Service name chosen by Exascale cluster services | No | false |
| frontend | Boolean | Frontend deployed. Only for Exascale REST services (controlServices). | No | false |
| frontendPriority | Integer (ub4) | Frontend priority. Only for Exascale REST services (controlServices). | No | false |
| hostName | String | Host name of the server running the service | No | false |
| incarnation | Integer (ub4) | Incarnation number for the service | No | false |
| leader | Boolean | Service has leader role. Only for Exascale cluster services (rootServices) and volume manager services. | No | false |
| name | String | Service name | No | false |
| rackId | String | Rack identifier for the service | No | false |
| serviceType | String | Service type. Valid values: 'cellServices', 'systemVaultManagers', 'userVaultManagers', 'controlServices', 'rootServices', 'volumeManagers', or 'volumeWorkers'. | No | false |
| status | String | Service status | No | false |
| url | String | Service uniform resource locator (URL) | No | false |
| virtualRouterId | Integer (ub4) | Keepalived virtual router ID. Only for Exascale REST services (controlServices). | No | false |
storagePoolOperations
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| bytesCompleted | SpaceSize | Bytes completed | No | false |
| bytesRemaining | SpaceSize | Bytes remaining | No | false |
| contentType | String | Content Type | No | false |
| estimatedCompletionTime | String | Estimated completion time of the operation | No | false |
| name | String | Storage pool name | No | false |
| opType | String | Operation Type | No | false |
| startTime | String | Start time of the operation | No | false |
| state | String | State of the operation | No | false |
storagePools
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| cellOfflineTimerInMins | Integer (ub4) | Cell offline timer (in minutes). The timer starts when a cell goes offline. If the cell comes back online before the timer expires, the affected disks are automatically updated and returned to the storage pool. Otherwise, when the timer expires, the disks are dropped and the storage pool is reconfigured. | No | true |
| cellsCount | Integer (ub4) | Number of storage servers that host the storage pool | No | false |
| diskOfflineTimerInMins | Integer (ub4) | Disk offline timer (in minutes). The timer starts when a disk goes offline. If the disk comes back online before the timer expires, the disk is automatically updated and returned to the storage pool. Otherwise, when the timer expires, the disk is dropped and the storage pool is reconfigured. | No | true |
| disksCount | Integer (ub4) | Number of disks used by the storage pool | No | false |
| flashCacheProvisionableSize | SpaceSize | Total flash cache space (in bytes) available for provisioning | No | false |
| flashCacheProvisionedSize | SpaceSize | Provisioned flash cache space (in bytes) | No | false |
| flashCacheSize | SpaceSize | Total flash cache space (in bytes) used by the storage pool | No | false |
| guid | String | Storage pool global unique identifier (GUID) | No | false |
| highDataStatus | String | Status of the high-redundancy data ring | No | false |
| highRecoStatus | String | Status of the high-redundancy recovery ring | No | false |
| iopsProvisionable | Integer (ub8) | Total IOPS available for provisioning | No | false |
| iopsProvisioned | Integer (ub8) | Provisioned IOPS | No | false |
| iopsRaw | Integer (ub8) | Total IOPS (I/Os per second) provisioned for the storage pool | No | false |
| mediaType | String | Media type. Valid values: 'HC', 'EF', or 'XT'. | No | false |
| name | String | Storage pool name. String size: 1 - 64 characters. | Mandatory | false |
| normalDataStatus | String | Status of the normal-redundancy data ring | No | false |
| normalRecoStatus | String | Status of the normal-redundancy recovery ring | No | false |
| spaceProvisionable | SpaceSize | Total storage space (in bytes) available for provisioning | No | false |
| spaceProvisioned | SpaceSize | Provisioned storage space (in bytes) | No | false |
| spaceRaw | SpaceSize | Total storage space (in bytes) used by the storage pool | No | false |
| spaceUsed | SpaceSize | Used space (in bytes) | No | false |
| sysDataStorePresent | Boolean | Indicator that the storage pool contains the system metadata store. Default: 'false'. | Optional | false |
| sysDataStoreShardsCount | Integer (ub4) | Number of system metadata store shards (if applicable) | No | false |
| xrmemCacheProvisionableSize | SpaceSize | Total XRMEM cache space (in bytes) available for provisioning | No | false |
| xrmemCacheProvisionedSize | SpaceSize | Provisioned XRMEM cache space (in bytes) | No | false |
| xrmemCacheSize | SpaceSize | Total Exadata RDMA Memory (XRMEM) cache space (in bytes) used by the storage pool | No | false |
users
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| category | String | User category. Valid values: 'compute_server', 'storage_server', 'internal', or 'external'. | Optional | false |
| name | String | User name. The value must start with an alphanumeric character and contain only alphanumeric, hyphen ('-'), and period ('.') characters. If not specified during user creation, the user name matches the user ID. When creating a user, you must specify either 'id' or 'name'. String size: 1 - 63 characters. Default: 'null'. | Optional | true |
| privilege | String | List of user privileges. Valid combinations of: 'no_privilege', 'cellsrv', 'egs', 'ers', 'syseds', 'usreds', 'bsm', 'bsw', 'ms', 'vlt_manage', 'vlt_use', 'vlt_read', 'vlt_inspect', 'cl_admin', 'cl_operator', 'cl_monitor', 'on_behalf_of', 'user_create', and 'system_restore'. Each privilege is separated by '|'. For example: 'vlt_read | cl_operator'. Default: 'vlt_inspect'. | Optional | true |
| pubKeyFingerprint1 | String | User public key fingerprint (ID 1) | No | false |
| pubKeyFingerprint2 | String | User public key fingerprint (ID 2) | No | false |
| pubKeyFingerprint3 | String | User public key fingerprint (ID 3) | No | false |
| publicKey1 | String | User public key (ID 1). String size: up to 511 characters. Default: 'null'. | Optional | true |
| publicKey2 | String | User public key (ID 2). String size: up to 511 characters. Default: 'null'. | Optional | true |
| publicKey3 | String | User public key (ID 3). String size: up to 511 characters. Default: 'null'. | Optional | true |
vaults
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| acl | String | Access control list. String size: up to 16384 characters. | No | true |
| createTime | Date | Vault creation time | No | false |
| createdBy | String | Vault owner | No | false |
| flags | String | Vault flags: 'being_deleted' | No | false |
| flashCacheProv | SpaceSize | In sharedCloud deployment mode, this attribute represents the additional flash cache provisioned (in bytes) on top of the auto provisioned value. A zero value in this case indicates no additional flash cache is provisioned. In other deployment modes, this attribute represents the total space provisioned in flash cache (in bytes). A zero value disables flash cache use for the vault in such cases. Valid values: up to 4503599626321920. | Optional | true |
| flashLogProv | Boolean | Enable/disable flash log usage. Default: 'true'. | Optional | true |
| iopsProvEF | IopsCount | IOPS provisioned in EF media. Valid values: up to 4294967295, or 'unlimited'. Default: 'unlimited'. | Optional | true |
| iopsProvHC | IopsCount | IOPS provisioned in HC media. Valid values: up to 4294967295, or 'unlimited'. Default: 'unlimited'. | Optional | true |
| iopsProvXT | IopsCount | IOPS provisioned in XT media. Valid values: up to 4294967295, or 'unlimited'. Default: 'unlimited'. | Optional | true |
| name | String | Vault name. If not specified during vault creation, a unique name is automatically generated. String size: up to 30 characters. | Optional | false |
| spaceProvEF | SpaceSize | Vault space (in bytes) provisioned in EF media. Valid values: up to 4503599626321920, or 'unlimited'. Default: 'unlimited'. | Optional | true |
| spaceProvHC | SpaceSize | Vault space (in bytes) provisioned in HC media. Valid values: up to 4503599626321920, or 'unlimited'. Default: 'unlimited'. | Optional | true |
| spaceProvXT | SpaceSize | Vault space (in bytes) provisioned in XT media. Valid values: up to 4503599626321920, or 'unlimited'. Default: 'unlimited'. | Optional | true |
| spaceUsedEF | SpaceSize | Extreme flash (EF) media space used (in bytes) | No | false |
| spaceUsedHC | SpaceSize | High capacity (HC) media space used (in bytes) | No | false |
| spaceUsedXT | SpaceSize | Extended storage (XT) media space used (in bytes) | No | false |
| xAttrKeys | String | Comma-separated extended vault attribute names | No | false |
| xAttrs | JSON | JSON array of vault extended attributes, which is only displayed when the extended attribute query string ('?withXAttrs') is specified | No | false |
| xrmemCacheProv | SpaceSize | Space provisioned in Exadata RDMA Memory (XRMEM) cache (in bytes). A zero value disables XRMEM cache use for the vault. Use only on systems with HC or EF media, but not both. For systems with both HC and EF media, use xrmemCacheProvHC and xrmemCacheProvEF. This attribute cannot be specified in sharedCloud deployment mode. Valid values: up to 4503599626321920, or 'unlimited'. Default: 'unlimited'. | Optional | true |
| xrmemCacheProvEF | SpaceSize | Space provisioned in XRMEM cache for data stored on EF media (in bytes). A zero value disables the vault from using XRMEM cache for data stored on EF media. This attribute cannot be specified in sharedCloud deployment mode. Valid values: up to 4503599626321920, or 'unlimited'. Default: 'unlimited'. | Optional | true |
| xrmemCacheProvHC | SpaceSize | Space provisioned in XRMEM cache for data stored on HC media (in bytes). A zero value disables the vault from using XRMEM cache for data stored on HC media. This attribute cannot be specified in sharedCloud deployment mode. Valid values: up to 4503599626321920, or 'unlimited'. Default: 'unlimited'. | Optional | true |
volumeBackups
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| backupType | String | Backup type. Valid values: 'incremental', or 'full'. | Optional | false |
| contentType | String | Content type (only applies when an Exascale vault is the backup destination). Valid values: 'DATA', or 'RECO'. | Optional | false |
| creationTime | Date | Creation timestamp | No | false |
| destination | String | Backup destination | Optional | false |
| name | String | Volume backup name (case-sensitive). String size: 1 - 255 characters. | Optional | true |
| progress | String | Completion percentage | No | false |
| size | SpaceSize | Backup size (in bytes) | No | false |
| state | String | Backup state. Valid values: 'CREATING', 'AVAILABLE', 'DELETING', 'DELETED', 'RESTORING', 'FAILED', or 'UNKNOWN'. | No | false |
| volume | String | Volume ID | No | false |
| volumeSnapshot | String | Volume snapshot ID | Mandatory | false |
volumeGroups
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| creationTime | Date | Volume group creation timestamp | No | false |
| iopsProvisioned | IopsCount | Provisioned throughput available to the volume group (in IOPS). Valid values: 0 - 4294967295. Default: 0. | Optional | true |
| name | String | Volume group name (case-sensitive). If not specified during creation, the name is automatically generated. String size: 1 - 255 characters. | Optional | true |
| owners | String | List of volume group owners. Each Volume has at least one owner and up to two owners. Owners are separated by ','. For example: 'user1,user2'. | No | true |
| resourceProfile | String | Resource profile associated with the volume group. String size: 1 - 32 characters. | No | true |
| resourceSharing | String | Specifies the resource sharing policy applicable to the group. Valid values: 'aggregate', 'specified', or 'none'. Default: 'none'. | Optional | true |
| state | String | Volume group state. Valid values: 'UNAVAILABLE', 'AVAILABLE', 'DELETING', 'DELETED', 'RENAMING', or 'CHANGING IOPS'. | No | false |
| volumes | String | List of volumes associated with the volume group. | No | true |
volumeSnapshots
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| contentType | String | Content type (derived from the parent volume). For a volume snapshot, 'data' is the only valid value. | No | false |
| creationTime | Date | Creation timestamp | No | false |
| fileName | String | Name of the Exascale file that contains the volume snapshot data | No | false |
| filePath | String | File path of the Exascale file that contains the volume snapshot data | No | false |
| iopsProvisioned | Integer (ub4) | Provisioned throughput (in IOPS) available to the snapshot | No | false |
| lockExpiryTime | Date | Lock expiry date and time. To unlock a locked volume snapshot, set the expiry time to 'null' (lockExpiryTime='null'). You can modify this attribute only if the lock is not immutable (lockImmutable=FALSE). | No | true |
| lockImmutable | Boolean | Indicates whether the lock is immutable. When a lock is immutable, the volume snapshot cannot be unlocked before the lock expires, and the lock cannot be modified to expire sooner. | No | true |
| lockStatus | String | Indicates the volume snapshot lock status: 'locked' if the lock is active, or 'expired' if the lock expiry time has passed (applies only to volume snapshots with a lock expiry time). | No | false |
| mediaType | String | Media type (derived from the parent volume). Valid values: 'HC', 'EF', or 'XT'. | No | false |
| name | String | Volume snapshot name (case-sensitive). String size: 1 - 255 characters. | Optional | true |
| numAttachments | Integer (ub4) | Number of attachments associated with the snapshot | No | false |
| redundancy | String | Redundancy setting (derived from the parent volume) | No | false |
| size | SpaceSize | Snapshot size (derived from the parent volume) | No | false |
| spaceUsed | SpaceSize | Space (in bytes) used by the snapshot (including all mirrors) | No | false |
| state | String | Snapshot state. Valid values: 'UNAVAILABLE', 'AVAILABLE', 'DELETING', 'DELETED', 'ATTACHING', or 'DETACHING'. | No | false |
| user | String | Volume snapshot owners. Each snapshot has at least one owner and up to two owners. Owners are separated by ','. For example: 'user1,user2'. | No | false |
| vault | String | Name of the vault containing the snapshot (derived from the parent volume) | No | false |
| volume | String | Parent volume ID. String size: 32 - 64 characters. | Mandatory | false |
| volumeBackup | String | Backup ID associated with the snapshot | No | false |
| volumeGroup | Boolean | 'true', create snaps for a volume group. 'false', otherwise.'. Default: 'FALSE'. | Optional | false |
| volumeGroupSnapshot | String | ID of the volume group snapshot operation associated with the volume snapshot | No | false |
volumes
| Attribute | Type | Description | Settable on creation | Modifiable after creation |
|---|---|---|---|---|
| acfsFileSystem | String | ACFS File System (if any) hosted by the volume | No | false |
| contentType | String | Content type. Valid values: 'DATA', or 'RECO'. Default: 'DATA'. | Optional | false |
| createdBy | String | The user that created the volume | No | false |
| creationTime | Date | Creation timestamp | No | false |
| fileName | String | Name of the Exascale file that contains the volume data (case-sensitive). String size: 1 or more characters. | Optional | false |
| filePath | String | File path of the Exascale file that contains the volume data | No | false |
| iopsInherited | Boolean | 'true' share the IOPS with the parent volume. 'false' the clone volume IOPS are independent from its parent. Default: 'TRUE'. | Optional | true |
| iopsProvisioned | IopsCount | Provisioned throughput available to the volume (in IOPS). Valid values: 1 - 4294967295, or 'unlimited'. Default: 'unlimited'. | Optional | true |
| log | Boolean | Indicates whether the volume contains Oracle Database redo log files. | Optional | false |
| mediaType | String | Media type. Valid values: 'HC', 'EF', or 'XT'. Default: 'HC'. | Optional | false |
| name | String | Volume name (case-sensitive). If not specified during volume creation, the name is automatically generated. String size: 1 - 255 characters. | Optional | true |
| numAttachments | Integer (ub4) | Number of attachments associated with the volume | No | false |
| numBackups | Integer (ub4) | Total number of backups of the volume | No | false |
| numSnapshots | Integer (ub4) | Total number of snapshots of the volume | No | false |
| owners | String | List of volume owners. Each Volume has at least one owner and up to two owners. Owners are separated by ','. For example: 'user1,user2'. | No | true |
| redundancy | String | Redundancy setting. Default: 'high'. | Optional | false |
| resourceProfile | String | Resource profile associated with this volume. String size: 1 - 32 characters. Default: 'none'. | Optional | true |
| restoreProgress | String | Progress percentage during volume restoration | No | false |
| size | SpaceSize | Volume size (in bytes) Cannot be specified for volume clones or when restoring a backup to an existing volume. | Optional | true |
| spaceUsed | SpaceSize | Space (in bytes) used by the volume (including all mirrors) | No | false |
| state | String | Volume state. Valid values: 'UNAVAILABLE', 'AVAILABLE', 'DELETING', 'DELETED', 'ATTACHING', or 'DETACHING'. | No | false |
| vault | String | Name of the vault containing the volume. Must not be specified when creating a volume clone. | Optional | false |
| volume | String | ID of the existing volume where volume backup data will be restored. Used only for volumes restored from a backup in MD recovery mode. String size: 32 - 64 characters. Default: 'null'. | Optional | false |
| volumeBackup | String | Source volume backup ID. Used only for volumes restored from a backup. Default: 'null'. | Optional | false |
| volumeGroup | String | ID of the volume group associated with the volume | No | true |
| volumeSnapshot | String | Source volume snapshot ID. Used only for volumes cloned from a snapshot. Default: 'null'. | Optional | false |
| volumeSource | String | Source volume ID. Used only for volumes cloned directly from an existing volume. Default: 'null'. | Optional | false |