Jump to

• Request
• Response

ListShapes

get

/20160918/shapes

List the shapes that can be used to launch an instance within the specified compartment. You can filter the list by compatibility with a specific image.

Request

Supported Media Types

• application/json

Query Parameters

• availabilityDomain: string
  The availability domain of the pod shape.
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment.
• imageId: string
  The OCID of the image.
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.

  Default Value: 100
• operatingSystem: string
  The image's operating system. Example: Oracle Linux
• operatingSystemVersion: string
  The image's operating system version. Example: 7.9
• page: string
  Minimum Length: 1

  Maximum Length: 512

  For list pagination. The value of the opc-next-page response header from the previous List call.

  Default Value: oracle.doceng.json.BetterJsonNull@2c07545f

Back to Top

Response

Supported Media Types

• application/json

200 Response

The list is being retrieved.

Headers

• opc-next-page: string
  For list pagination. When this header appears in the response, additional pages of results remain. Use this value as the page parameter to get the next page of items.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Shape
  A compute instance shape that can be used in LaunchInstance.

{
    "items":{
        "$ref":"#/definitions/Shape"
    },
    "type":"array"
}

Nested Schema : Shape

Type: object

A compute instance shape that can be used in LaunchInstance.

Show Source

• availabilityDomain: string
  Minimum Length: 1

  Maximum Length: 255

  The shape's availability domain.
• baselineOcpuUtilizations: array baselineOcpuUtilizations
  For a subcore burstable VM, the supported baseline OCPU utilization for instances that use this shape.
• billingType: string
  Allowed Values: [ "ALWAYS_FREE", "LIMITED_FREE", "PAID" ]

  How instances that use this shape are charged.
• gpuDescription: string
  A short description of the graphics processing unit (GPU) available for this shape. If the shape does not have any GPUs, this field is null.
• gpus: integer
  Minimum Value: 0

  The number of GPUs available for this shape.
• isBilledForStoppedInstance: boolean
  Whether billing continues when the instances that use this shape are in the stopped state.
• isFlexible: boolean
  Whether the shape supports creating flexible instances. A flexible shape is a shape that lets you customize the number of OCPUs and the amount of memory when launching or resizing your instance.
• isLiveMigrationSupported: boolean
  Whether live migration is supported for this shape.
• isSubcore: boolean
  Whether the shape supports creating subcore or burstable instances. A burstable instance is a virtual machine (VM) instance that provides a baseline level of CPU performance with the ability to burst to a higher level to support occasional spikes in usage.
• localDiskDescription: string
  Minimum Length: 1

  Maximum Length: 255

  A short description of the local disks available for this shape. If the shape does not have any local disks, this field is null.
• localDisks: integer
  Minimum Value: 0

  The number of local disks available for this shape.
• localDisksTotalSizeInGBs: number(float)
  Minimum Value: 0

  The aggregate size of the local disks available for this shape, in gigabytes. If the shape does not have any local disks, this field is null.
• maxVnicAttachmentOptions: object ShapeMaxVnicAttachmentOptions
  For a flexible shape, the number of VNIC attachments that are available for instances that use this shape. If this field is null, then this shape has a fixed maximum number of VNIC attachments equal to maxVnicAttachments.
• maxVnicAttachments: integer
  Minimum Value: 0

  The maximum number of VNIC attachments available for this shape.
• memoryInGBs: number(float)
  Minimum Value: 0

  The default amount of memory available for this shape, in gigabytes.
• memoryOptions: object ShapeMemoryOptions
  For a flexible shape, the amount of memory available for instances that use this shape. If this field is null, then this shape has a fixed amount of memory equivalent to memoryInGBs.
• minTotalBaselineOcpusRequired: number(int32)
  Minimum Value: 0

  For a subcore burstable VM, the minimum total baseline OCPUs required. The total baseline OCPUs is equal to baselineOcpuUtilization chosen multiplied by the number of OCPUs chosen.
• networkingBandwidthInGbps: number(float)
  Minimum Value: 0

  The networking bandwidth available for this shape, in gigabits per second.
• networkingBandwidthOptions: object ShapeNetworkingBandwidthOptions
  For a flexible shape, the amount of networking bandwidth available for instances that use this shape. If this field is null, then this shape has a fixed amount of bandwidth equivalent to networkingBandwidthInGbps.
• networkPorts: integer
  Minimum Value: 0

  The number of physical network interface card (NIC) ports available for this shape.
• ocpuOptions: object ShapeOcpuOptions
  For a flexible shape, the number of OCPUs available for instances that use this shape. If this field is null, then this shape has a fixed number of OCPUs equal to ocpus.
• ocpus: number(float)
  Minimum Value: 0

  The default number of OCPUs available for this shape.
• platformConfigOptions: object ShapePlatformConfigOptions
  The list of supported platform configuration options for this shape.
• processorDescription: string
  Minimum Length: 1

  Maximum Length: 255

  A short description of the shape's processor (CPU).
• quotaNames: array quotaNames
  The list of of compartment quotas for the shape.
• rdmaBandwidthInGbps: integer
  Minimum Value: 0

  The networking bandwidth available for the remote direct memory access (RDMA) network for this shape, in gigabits per second.
• rdmaPorts: integer
  Minimum Value: 0

  The number of networking ports available for the remote direct memory access (RDMA) network between nodes in a high performance computing (HPC) cluster network. If the shape does not support cluster networks, this value is 0.
• recommendedAlternatives: array recommendedAlternatives
  The list of shapes and shape details (if applicable) that Oracle recommends that you use as an alternative to the current shape.
• resizeCompatibleShapes: array resizeCompatibleShapes
  The list of compatible shapes that this shape can be changed to.
• shape(required): string
  Minimum Length: 1

  Maximum Length: 255

  The name of the shape. You can enumerate all available shapes by calling ListShapes.

{
    "x-obmcs-splat":{
        "resourceKind":"Shape",
        "adLocality":"ad-local"
    },
    "description":"A compute instance shape that can be used in LaunchInstance.",
    "properties":{
        "availabilityDomain":{
            "description":"The shape's availability domain.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "baselineOcpuUtilizations":{
            "description":"For a subcore burstable VM, the supported baseline OCPU utilization for instances that use this shape.",
            "items":{
                "minimum":"0",
                "type":"string",
                "enum":[
                    "BASELINE_1_8",
                    "BASELINE_1_2",
                    "BASELINE_1_1"
                ]
            },
            "type":"array"
        },
        "minTotalBaselineOcpusRequired":{
            "description":"For a subcore burstable VM, the minimum total baseline OCPUs required. The total baseline OCPUs is equal to baselineOcpuUtilization chosen multiplied by the number of OCPUs chosen.",
            "format":"int32",
            "minimum":"0",
            "type":"number"
        },
        "shape":{
            "description":"The name of the shape. You can enumerate all available shapes by calling ListShapes.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "processorDescription":{
            "description":"A short description of the shape's processor (CPU).",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "ocpus":{
            "description":"The default number of OCPUs available for this shape.",
            "format":"float",
            "minimum":"0",
            "type":"number"
        },
        "memoryInGBs":{
            "description":"The default amount of memory available for this shape, in gigabytes.",
            "format":"float",
            "minimum":"0",
            "type":"number"
        },
        "networkPorts":{
            "description":"The number of physical network interface card (NIC) ports available for this shape.",
            "minimum":"0",
            "type":"integer"
        },
        "networkingBandwidthInGbps":{
            "description":"The networking bandwidth available for this shape, in gigabits per second.",
            "format":"float",
            "minimum":"0",
            "type":"number"
        },
        "maxVnicAttachments":{
            "description":"The maximum number of VNIC attachments available for this shape.",
            "minimum":"0",
            "type":"integer"
        },
        "gpus":{
            "description":"The number of GPUs available for this shape.",
            "minimum":"0",
            "type":"integer"
        },
        "gpuDescription":{
            "description":"A short description of the graphics processing unit (GPU) available for this shape. If the shape does not have any GPUs, this field is null.",
            "type":"string"
        },
        "localDisks":{
            "description":"The number of local disks available for this shape.",
            "minimum":"0",
            "type":"integer"
        },
        "localDisksTotalSizeInGBs":{
            "description":"The aggregate size of the local disks available for this shape, in gigabytes. If the shape does not have any local disks, this field is null.",
            "format":"float",
            "minimum":"0",
            "type":"number"
        },
        "localDiskDescription":{
            "description":"A short description of the local disks available for this shape. If the shape does not have any local disks, this field is null.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "rdmaPorts":{
            "description":"The number of networking ports available for the remote direct memory access (RDMA) network between nodes in a high performance computing (HPC) cluster network. If the shape does not support cluster networks, this value is 0.",
            "minimum":"0",
            "type":"integer"
        },
        "rdmaBandwidthInGbps":{
            "description":"The networking bandwidth available for the remote direct memory access (RDMA) network for this shape, in gigabits per second.",
            "minimum":"0",
            "type":"integer"
        },
        "isLiveMigrationSupported":{
            "description":"Whether live migration is supported for this shape.",
            "type":"boolean"
        },
        "ocpuOptions":{
            "$ref":"#/definitions/ShapeOcpuOptions"
        },
        "memoryOptions":{
            "$ref":"#/definitions/ShapeMemoryOptions"
        },
        "networkingBandwidthOptions":{
            "$ref":"#/definitions/ShapeNetworkingBandwidthOptions"
        },
        "maxVnicAttachmentOptions":{
            "$ref":"#/definitions/ShapeMaxVnicAttachmentOptions"
        },
        "platformConfigOptions":{
            "$ref":"#/definitions/ShapePlatformConfigOptions"
        },
        "isBilledForStoppedInstance":{
            "description":"Whether billing continues when the instances that use this shape are in the stopped state.",
            "type":"boolean"
        },
        "billingType":{
            "description":"How instances that use this shape are charged.",
            "enum":[
                "ALWAYS_FREE",
                "LIMITED_FREE",
                "PAID"
            ],
            "type":"string"
        },
        "quotaNames":{
            "description":"The list of of compartment quotas for the shape.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "isSubcore":{
            "description":"Whether the shape supports creating subcore or burstable instances. A burstable instance is a virtual machine (VM) instance that provides a baseline level of CPU performance with the ability to burst to a higher level to support occasional spikes in usage.",
            "type":"boolean"
        },
        "isFlexible":{
            "description":"Whether the shape supports creating flexible instances. A flexible shape is a shape that lets you customize the number of OCPUs and the amount of memory when launching or resizing your instance.",
            "type":"boolean"
        },
        "resizeCompatibleShapes":{
            "description":"The list of compatible shapes that this shape can be changed to.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "recommendedAlternatives":{
            "description":"The list of shapes and shape details (if applicable) that Oracle recommends that you use as an alternative to the current shape.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ShapeAlternativeObject"
            }
        }
    },
    "required":[
        "shape"
    ],
    "type":"object"
}

Nested Schema : baselineOcpuUtilizations

Type: array

For a subcore burstable VM, the supported baseline OCPU utilization for instances that use this shape.

Show Source

• Array of: string
  Minimum Value: 0

  Allowed Values: [ "BASELINE_1_8", "BASELINE_1_2", "BASELINE_1_1" ]

{
    "description":"For a subcore burstable VM, the supported baseline OCPU utilization for instances that use this shape.",
    "items":{
        "minimum":"0",
        "type":"string",
        "enum":[
            "BASELINE_1_8",
            "BASELINE_1_2",
            "BASELINE_1_1"
        ]
    },
    "type":"array"
}

Nested Schema : ShapeMaxVnicAttachmentOptions

Type: object

For a flexible shape, the number of VNIC attachments that are available for instances that use this shape. If this field is null, then this shape has a fixed maximum number of VNIC attachments equal to maxVnicAttachments.

Show Source

• defaultPerOcpu: number(float)
  Minimum Value: 0

  The default number of VNIC attachments allowed per OCPU.
• max: number(float)
  Minimum Value: 0

  The highest maximum value of VNIC attachments.
• min: integer
  Minimum Value: 0

  The lowest maximum value of VNIC attachments.

{
    "description":"For a flexible shape, the number of VNIC attachments that are available for instances that use this shape. If this field is null, then this shape has a fixed maximum number of VNIC attachments equal to maxVnicAttachments. ",
    "properties":{
        "min":{
            "description":"The lowest maximum value of VNIC attachments. ",
            "minimum":"0",
            "type":"integer"
        },
        "max":{
            "description":"The highest maximum value of VNIC attachments. ",
            "format":"float",
            "minimum":"0",
            "type":"number"
        },
        "defaultPerOcpu":{
            "description":"The default number of VNIC attachments allowed per OCPU. ",
            "format":"float",
            "minimum":"0",
            "type":"number"
        }
    },
    "type":"object"
}

Nested Schema : ShapeMemoryOptions

Type: object

For a flexible shape, the amount of memory available for instances that use this shape. If this field is null, then this shape has a fixed amount of memory equivalent to memoryInGBs.

Show Source

• defaultPerOcpuInGBs: number(float)
  Minimum Value: 0

  The default amount of memory per OCPU available for this shape, in gigabytes.
• maxInGBs: number(float)
  Minimum Value: 0

  The maximum amount of memory, in gigabytes.
• maxPerOcpuInGBs: number(float)
  Minimum Value: 0

  Minimum Value: > true

  The maximum amount of memory per OCPU available for this shape, in gigabytes.
• minInGBs: number(float)
  Minimum Value: 0

  The minimum amount of memory, in gigabytes.
• minPerOcpuInGBs: number(float)
  Minimum Value: 0

  Minimum Value: > true

  The minimum amount of memory per OCPU available for this shape, in gigabytes.

{
    "description":"For a flexible shape, the amount of memory available for instances that use this shape. If this field is null, then this shape has a fixed amount of memory equivalent to memoryInGBs. ",
    "properties":{
        "minInGBs":{
            "description":"The minimum amount of memory, in gigabytes. ",
            "format":"float",
            "minimum":"0",
            "type":"number"
        },
        "maxInGBs":{
            "description":"The maximum amount of memory, in gigabytes. ",
            "format":"float",
            "minimum":"0",
            "type":"number"
        },
        "defaultPerOcpuInGBs":{
            "description":"The default amount of memory per OCPU available for this shape, in gigabytes. ",
            "format":"float",
            "minimum":"0",
            "type":"number"
        },
        "minPerOcpuInGBs":{
            "description":"The minimum amount of memory per OCPU available for this shape, in gigabytes. ",
            "format":"float",
            "minimum":"0",
            "exclusiveMinimum":true,
            "type":"number"
        },
        "maxPerOcpuInGBs":{
            "description":"The maximum amount of memory per OCPU available for this shape, in gigabytes. ",
            "format":"float",
            "minimum":"0",
            "exclusiveMinimum":true,
            "type":"number"
        }
    },
    "type":"object"
}

Nested Schema : ShapeNetworkingBandwidthOptions

Type: object

For a flexible shape, the amount of networking bandwidth available for instances that use this shape. If this field is null, then this shape has a fixed amount of bandwidth equivalent to networkingBandwidthInGbps.

Show Source

• defaultPerOcpuInGbps: number(float)
  Minimum Value: 0

  The default amount of networking bandwidth per OCPU, in gigabits per second.
• maxInGbps: number(float)
  Minimum Value: 0

  The maximum amount of networking bandwidth, in gigabits per second.
• minInGbps: number(float)
  Minimum Value: 0

  The minimum amount of networking bandwidth, in gigabits per second.

{
    "description":"For a flexible shape, the amount of networking bandwidth available for instances that use this shape. If this field is null, then this shape has a fixed amount of bandwidth equivalent to networkingBandwidthInGbps. ",
    "properties":{
        "minInGbps":{
            "description":"The minimum amount of networking bandwidth, in gigabits per second. ",
            "format":"float",
            "minimum":"0",
            "type":"number"
        },
        "maxInGbps":{
            "description":"The maximum amount of networking bandwidth, in gigabits per second. ",
            "format":"float",
            "minimum":"0",
            "type":"number"
        },
        "defaultPerOcpuInGbps":{
            "description":"The default amount of networking bandwidth per OCPU, in gigabits per second. ",
            "format":"float",
            "minimum":"0",
            "type":"number"
        }
    },
    "type":"object"
}

Nested Schema : ShapeOcpuOptions

Type: object

For a flexible shape, the number of OCPUs available for instances that use this shape. If this field is null, then this shape has a fixed number of OCPUs equal to ocpus.

Show Source

• max: number(float)
  Minimum Value: 0

  The maximum number of OCPUs.
• min: number(float)
  Minimum Value: 0

  The minimum number of OCPUs.

{
    "description":"For a flexible shape, the number of OCPUs available for instances that use this shape. If this field is null, then this shape has a fixed number of OCPUs equal to ocpus. ",
    "properties":{
        "min":{
            "description":"The minimum number of OCPUs. ",
            "format":"float",
            "minimum":"0",
            "type":"number"
        },
        "max":{
            "description":"The maximum number of OCPUs. ",
            "format":"float",
            "minimum":"0",
            "type":"number"
        }
    },
    "type":"object"
}

Nested Schema : ShapePlatformConfigOptions

Type: object

The list of supported platform configuration options for this shape.

Show Source

• accessControlServiceOptions: object ShapeAccessControlServiceEnabledPlatformOptions
  Configuration options for the Access Control Service.
• inputOutputMemoryManagementUnitOptions: object ShapeInputOutputMemoryManagementUnitEnabledPlatformOptions
  Configuration options for the input-output memory management unit (IOMMU).
• measuredBootOptions: object ShapeMeasuredBootOptions
  Configuration options for the Measured Boot feature.
• memoryEncryptionOptions: object ShapeMemoryEncryptionOptions
  Configuration options for memory encryption.
• numaNodesPerSocketPlatformOptions: object ShapeNumaNodesPerSocketPlatformOptions
  Configuration options for NUMA nodes per socket.
• percentageOfCoresEnabledOptions: object PercentageOfCoresEnabledOptions
  Configuration options for the percentage of cores enabled.
• secureBootOptions: object ShapeSecureBootOptions
  Configuration options for Secure Boot.
• symmetricMultiThreadingOptions: object ShapeSymmetricMultiThreadingEnabledPlatformOptions
  Configuration options for symmetric multithreading (also called simultaneous multithreading or SMT).
• trustedPlatformModuleOptions: object ShapeTrustedPlatformModuleOptions
  Configuration options for the Trusted Platform Module (TPM).
• type: string
  Allowed Values: [ "AMD_MILAN_BM", "AMD_MILAN_BM_GPU", "AMD_ROME_BM", "AMD_ROME_BM_GPU", "INTEL_ICELAKE_BM", "INTEL_SKYLAKE_BM", "AMD_VM", "INTEL_VM" ]

  The type of platform being configured.
• virtualInstructionsOptions: object ShapeVirtualInstructionsEnabledPlatformOptions
  Configuration options for the virtualization instructions.

{
    "description":"The list of supported platform configuration options for this shape. ",
    "properties":{
        "type":{
            "description":"The type of platform being configured. ",
            "type":"string",
            "enum":[
                "AMD_MILAN_BM",
                "AMD_MILAN_BM_GPU",
                "AMD_ROME_BM",
                "AMD_ROME_BM_GPU",
                "INTEL_ICELAKE_BM",
                "INTEL_SKYLAKE_BM",
                "AMD_VM",
                "INTEL_VM"
            ]
        },
        "secureBootOptions":{
            "$ref":"#/definitions/ShapeSecureBootOptions"
        },
        "measuredBootOptions":{
            "$ref":"#/definitions/ShapeMeasuredBootOptions"
        },
        "trustedPlatformModuleOptions":{
            "$ref":"#/definitions/ShapeTrustedPlatformModuleOptions"
        },
        "numaNodesPerSocketPlatformOptions":{
            "$ref":"#/definitions/ShapeNumaNodesPerSocketPlatformOptions"
        },
        "memoryEncryptionOptions":{
            "$ref":"#/definitions/ShapeMemoryEncryptionOptions"
        },
        "symmetricMultiThreadingOptions":{
            "$ref":"#/definitions/ShapeSymmetricMultiThreadingEnabledPlatformOptions"
        },
        "accessControlServiceOptions":{
            "$ref":"#/definitions/ShapeAccessControlServiceEnabledPlatformOptions"
        },
        "virtualInstructionsOptions":{
            "$ref":"#/definitions/ShapeVirtualInstructionsEnabledPlatformOptions"
        },
        "inputOutputMemoryManagementUnitOptions":{
            "$ref":"#/definitions/ShapeInputOutputMemoryManagementUnitEnabledPlatformOptions"
        },
        "percentageOfCoresEnabledOptions":{
            "$ref":"#/definitions/PercentageOfCoresEnabledOptions"
        }
    },
    "type":"object"
}

Nested Schema : quotaNames

Type: array

The list of of compartment quotas for the shape.

Show Source

• Array of: string

{
    "description":"The list of of compartment quotas for the shape.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : recommendedAlternatives

Type: array

The list of shapes and shape details (if applicable) that Oracle recommends that you use as an alternative to the current shape.

Show Source

• Array of: object ShapeAlternativeObject
  The shape that Oracle recommends you to use an alternative to the current shape.

{
    "description":"The list of shapes and shape details (if applicable) that Oracle recommends that you use as an alternative to the current shape.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ShapeAlternativeObject"
    }
}

Nested Schema : resizeCompatibleShapes

Type: array

The list of compatible shapes that this shape can be changed to.

Show Source

• Array of: string

{
    "description":"The list of compatible shapes that this shape can be changed to.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ShapeAccessControlServiceEnabledPlatformOptions

Type: object

Configuration options for the Access Control Service.

Show Source

• allowedValues: array allowedValues
  Minimum Number of Items: 1

  Maximum Number of Items: 2

  Whether the Access Control Service can be enabled.
• isDefaultEnabled: boolean
  Whether the Access Control Service is enabled by default.

{
    "description":"Configuration options for the Access Control Service. ",
    "properties":{
        "allowedValues":{
            "description":"Whether the Access Control Service can be enabled. ",
            "type":"array",
            "items":{
                "type":"boolean"
            },
            "minItems":"1",
            "maxItems":"2"
        },
        "isDefaultEnabled":{
            "description":"Whether the Access Control Service is enabled by default. ",
            "type":"boolean"
        }
    },
    "type":"object"
}

Nested Schema : ShapeInputOutputMemoryManagementUnitEnabledPlatformOptions

Type: object

Configuration options for the input-output memory management unit (IOMMU).

Show Source

• allowedValues: array allowedValues
  Minimum Number of Items: 1

  Maximum Number of Items: 2

  Whether the input-output memory management unit can be enabled.
• isDefaultEnabled: boolean
  Whether the input-output memory management unit is enabled by default.

{
    "description":"Configuration options for the input-output memory management unit (IOMMU). ",
    "properties":{
        "allowedValues":{
            "description":"Whether the input-output memory management unit can be enabled. ",
            "type":"array",
            "items":{
                "type":"boolean"
            },
            "minItems":"1",
            "maxItems":"2"
        },
        "isDefaultEnabled":{
            "description":"Whether the input-output memory management unit is enabled by default. ",
            "type":"boolean"
        }
    },
    "type":"object"
}

Nested Schema : ShapeMeasuredBootOptions

Type: object

Configuration options for the Measured Boot feature.

Show Source

• allowedValues: array allowedValues
  Minimum Number of Items: 1

  Maximum Number of Items: 2

  Boolean values that indicate whether the Measured Boot feature can be enabled or disabled.
• isDefaultEnabled: boolean
  Whether the Measured Boot feature is enabled by default.

{
    "description":"Configuration options for the Measured Boot feature. ",
    "properties":{
        "allowedValues":{
            "description":"Boolean values that indicate whether the Measured Boot feature can be enabled or disabled. ",
            "type":"array",
            "items":{
                "type":"boolean"
            },
            "minItems":"1",
            "maxItems":"2"
        },
        "isDefaultEnabled":{
            "description":"Whether the Measured Boot feature is enabled by default. ",
            "type":"boolean"
        }
    },
    "type":"object"
}

Nested Schema : ShapeMemoryEncryptionOptions

Type: object

Configuration options for memory encryption.

Show Source

• allowedValues: array allowedValues
  Whether memory encryption can be enabled.
• isDefaultEnabled: boolean
  Whether memory encryption is enabled by default.

{
    "description":"Configuration options for memory encryption. ",
    "properties":{
        "allowedValues":{
            "description":"Whether memory encryption can be enabled. ",
            "type":"array",
            "items":{
                "type":"boolean"
            }
        },
        "isDefaultEnabled":{
            "description":"Whether memory encryption is enabled by default. ",
            "type":"boolean"
        }
    },
    "type":"object"
}

Nested Schema : ShapeNumaNodesPerSocketPlatformOptions

Type: object

Configuration options for NUMA nodes per socket.

Show Source

• allowedValues: array allowedValues
  Minimum Number of Items: 1

  Maximum Number of Items: 5

  The supported values for this platform configuration property.
• defaultValue: string
  The default NUMA nodes per socket configuration.

{
    "description":"Configuration options for NUMA nodes per socket. ",
    "properties":{
        "allowedValues":{
            "description":"The supported values for this platform configuration property. ",
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "NPS0",
                    "NPS1",
                    "NPS2",
                    "NPS4"
                ]
            },
            "minItems":"1",
            "maxItems":"5"
        },
        "defaultValue":{
            "description":"The default NUMA nodes per socket configuration. ",
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : PercentageOfCoresEnabledOptions

Type: object

Configuration options for the percentage of cores enabled.

Show Source

• defaultValue: integer
  Minimum Value: 0

  Maximum Value: 100

  The default percentage of cores enabled.
• max: integer
  Minimum Value: 0

  Maximum Value: 100

  The maximum allowed percentage of cores enabled.
• min: integer
  Minimum Value: 0

  Maximum Value: 100

  The minimum allowed percentage of cores enabled.

{
    "description":"Configuration options for the percentage of cores enabled. ",
    "properties":{
        "min":{
            "description":"The minimum allowed percentage of cores enabled. ",
            "type":"integer",
            "minimum":"0",
            "maximum":"100"
        },
        "max":{
            "description":"The maximum allowed percentage of cores enabled. ",
            "type":"integer",
            "minimum":"0",
            "maximum":"100"
        },
        "defaultValue":{
            "description":"The default percentage of cores enabled. ",
            "type":"integer",
            "minimum":"0",
            "maximum":"100"
        }
    },
    "type":"object"
}

Nested Schema : ShapeSecureBootOptions

Type: object

Configuration options for Secure Boot.

Show Source

• allowedValues: array allowedValues
  Minimum Number of Items: 1

  Maximum Number of Items: 2

  Boolean values that indicate whether Secure Boot can be enabled or disabled.
• isDefaultEnabled: boolean
  Whether Secure Boot is enabled by default.

{
    "description":"Configuration options for Secure Boot. ",
    "properties":{
        "allowedValues":{
            "description":"Boolean values that indicate whether Secure Boot can be enabled or disabled. ",
            "type":"array",
            "items":{
                "type":"boolean"
            },
            "minItems":"1",
            "maxItems":"2"
        },
        "isDefaultEnabled":{
            "description":"Whether Secure Boot is enabled by default. ",
            "type":"boolean"
        }
    },
    "type":"object"
}

Nested Schema : ShapeSymmetricMultiThreadingEnabledPlatformOptions

Type: object

Configuration options for symmetric multithreading (also called simultaneous multithreading or SMT).

Show Source

• allowedValues: array allowedValues
  Minimum Number of Items: 1

  Maximum Number of Items: 2

  Whether symmetric multithreading can be enabled.
• isDefaultEnabled: boolean
  Whether symmetric multithreading is enabled by default.

{
    "description":"Configuration options for symmetric multithreading (also called simultaneous multithreading or SMT). ",
    "properties":{
        "allowedValues":{
            "description":"Whether symmetric multithreading can be enabled. ",
            "type":"array",
            "items":{
                "type":"boolean"
            },
            "minItems":"1",
            "maxItems":"2"
        },
        "isDefaultEnabled":{
            "description":"Whether symmetric multithreading is enabled by default. ",
            "type":"boolean"
        }
    },
    "type":"object"
}

Nested Schema : ShapeTrustedPlatformModuleOptions

Type: object

Configuration options for the Trusted Platform Module (TPM).

Show Source

• allowedValues: array allowedValues
  Minimum Number of Items: 1

  Maximum Number of Items: 2

  Boolean values that indicate whether the Trusted Platform Module can be enabled or disabled.
• isDefaultEnabled: boolean
  Whether the Trusted Platform Module is enabled by default.

{
    "description":"Configuration options for the Trusted Platform Module (TPM). ",
    "properties":{
        "allowedValues":{
            "description":"Boolean values that indicate whether the Trusted Platform Module can be enabled or disabled. ",
            "type":"array",
            "items":{
                "type":"boolean"
            },
            "minItems":"1",
            "maxItems":"2"
        },
        "isDefaultEnabled":{
            "description":"Whether the Trusted Platform Module is enabled by default. ",
            "type":"boolean"
        }
    },
    "type":"object"
}

Nested Schema : ShapeVirtualInstructionsEnabledPlatformOptions

Type: object

Configuration options for the virtualization instructions.

Show Source

• allowedValues: array allowedValues
  Minimum Number of Items: 1

  Maximum Number of Items: 2

  Whether virtualization instructions can be enabled.
• isDefaultEnabled: boolean
  Whether virtualization instructions are enabled by default.

{
    "description":"Configuration options for the virtualization instructions. ",
    "properties":{
        "allowedValues":{
            "description":"Whether virtualization instructions can be enabled. ",
            "type":"array",
            "items":{
                "type":"boolean"
            },
            "minItems":"1",
            "maxItems":"2"
        },
        "isDefaultEnabled":{
            "description":"Whether virtualization instructions are enabled by default. ",
            "type":"boolean"
        }
    },
    "type":"object"
}

Nested Schema : allowedValues

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2

Whether the Access Control Service can be enabled.

Show Source

• Array of: boolean

{
    "description":"Whether the Access Control Service can be enabled. ",
    "type":"array",
    "items":{
        "type":"boolean"
    },
    "minItems":"1",
    "maxItems":"2"
}

Nested Schema : allowedValues

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2

Whether the input-output memory management unit can be enabled.

Show Source

• Array of: boolean

{
    "description":"Whether the input-output memory management unit can be enabled. ",
    "type":"array",
    "items":{
        "type":"boolean"
    },
    "minItems":"1",
    "maxItems":"2"
}

Nested Schema : allowedValues

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2

Boolean values that indicate whether the Measured Boot feature can be enabled or disabled.

Show Source

• Array of: boolean

{
    "description":"Boolean values that indicate whether the Measured Boot feature can be enabled or disabled. ",
    "type":"array",
    "items":{
        "type":"boolean"
    },
    "minItems":"1",
    "maxItems":"2"
}

Nested Schema : allowedValues

Type: array

Whether memory encryption can be enabled.

Show Source

• Array of: boolean

{
    "description":"Whether memory encryption can be enabled. ",
    "type":"array",
    "items":{
        "type":"boolean"
    }
}

Nested Schema : allowedValues

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 5

The supported values for this platform configuration property.

Show Source

• Array of: string
  Allowed Values: [ "NPS0", "NPS1", "NPS2", "NPS4" ]

{
    "description":"The supported values for this platform configuration property. ",
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "NPS0",
            "NPS1",
            "NPS2",
            "NPS4"
        ]
    },
    "minItems":"1",
    "maxItems":"5"
}

Nested Schema : allowedValues

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2

Boolean values that indicate whether Secure Boot can be enabled or disabled.

Show Source

• Array of: boolean

{
    "description":"Boolean values that indicate whether Secure Boot can be enabled or disabled. ",
    "type":"array",
    "items":{
        "type":"boolean"
    },
    "minItems":"1",
    "maxItems":"2"
}

Nested Schema : allowedValues

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2

Whether symmetric multithreading can be enabled.

Show Source

• Array of: boolean

{
    "description":"Whether symmetric multithreading can be enabled. ",
    "type":"array",
    "items":{
        "type":"boolean"
    },
    "minItems":"1",
    "maxItems":"2"
}

Nested Schema : allowedValues

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2

Boolean values that indicate whether the Trusted Platform Module can be enabled or disabled.

Show Source

• Array of: boolean

{
    "description":"Boolean values that indicate whether the Trusted Platform Module can be enabled or disabled. ",
    "type":"array",
    "items":{
        "type":"boolean"
    },
    "minItems":"1",
    "maxItems":"2"
}

Nested Schema : allowedValues

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2

Whether virtualization instructions can be enabled.

Show Source

• Array of: boolean

{
    "description":"Whether virtualization instructions can be enabled. ",
    "type":"array",
    "items":{
        "type":"boolean"
    },
    "minItems":"1",
    "maxItems":"2"
}

Nested Schema : ShapeAlternativeObject

Type: object

The shape that Oracle recommends you to use an alternative to the current shape.

Show Source

• shapeName(required): string
  The name of the shape.

{
    "description":"The shape that Oracle recommends you to use an alternative to the current shape. ",
    "properties":{
        "shapeName":{
            "description":"The name of the shape. ",
            "type":"string"
        }
    },
    "required":[
        "shapeName"
    ],
    "type":"object"
}

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top