Skip to content

Commit 4cde75f

Browse files
committed
get the latest description from the specification for core service
1 parent 937114d commit 4cde75f

22 files changed

+163
-114
lines changed

website/docs/d/core_dhcp_options.html.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ description: |-
1111
This data source provides the list of Dhcp Options in Oracle Cloud Infrastructure Core service.
1212

1313
Lists the sets of DHCP options in the specified VCN and specified compartment.
14+
If Vcn ID is not provided, then it will list all sets of DHCP options in all the VCNs that are in the specified compartment.
1415
The response includes the default set of options that automatically comes with each VCN,
1516
plus any other sets you've created.
1617

website/docs/d/core_image.html.markdown

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,26 +53,26 @@ The following attributes are exported:
5353
* `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.
5454
* `launch_options` -
5555
* `boot_volume_type` - Emulation type for volume.
56-
* `ISCSI` - ISCSI attached block storage device. This is the default for Boot Volumes and Remote Block Storage volumes on Oracle provided images.
56+
* `ISCSI` - ISCSI attached block storage device.
5757
* `SCSI` - Emulated SCSI disk.
5858
* `IDE` - Emulated IDE disk.
5959
* `VFIO` - Direct attached Virtual Function storage. This is the default option for Local data volumes on Oracle provided images.
60-
* `PARAVIRTUALIZED` - Paravirtualized disk.
60+
* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for Boot Volumes and Remote Block Storage volumes on Oracle provided images.
6161
* `firmware` - Firmware used to boot VM. Select the option that matches your operating system.
6262
* `BIOS` - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
6363
* `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for Oracle provided images.
6464
* `is_consistent_volume_naming_enabled` - Whether to enable consistent volume naming feature. Defaults to false.
65-
* `is_pv_encryption_in_transit_enabled` - Whether to enable in-transit encryption for the boot volume's paravirtualized attachment. The default value is false.
65+
* `is_pv_encryption_in_transit_enabled` - Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/datatypes/LaunchInstanceDetails).
6666
* `network_type` - Emulation type for the physical network interface card (NIC).
6767
* `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
6868
* `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
6969
* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using virtio drivers.
7070
* `remote_data_volume_type` - Emulation type for volume.
71-
* `ISCSI` - ISCSI attached block storage device. This is the default for Boot Volumes and Remote Block Storage volumes on Oracle provided images.
71+
* `ISCSI` - ISCSI attached block storage device.
7272
* `SCSI` - Emulated SCSI disk.
7373
* `IDE` - Emulated IDE disk.
7474
* `VFIO` - Direct attached Virtual Function storage. This is the default option for Local data volumes on Oracle provided images.
75-
* `PARAVIRTUALIZED` - Paravirtualized disk.
75+
* `PARAVIRTUALIZED` - Paravirtualized disk.This is the default for Boot Volumes and Remote Block Storage volumes on Oracle provided images.
7676
* `operating_system` - The image's operating system. Example: `Oracle Linux`
7777
* `operating_system_version` - The image's operating system version. Example: `7.2`
7878
* `size_in_mbs` - The boot volume size for an instance launched from this image, (1 MB = 1048576 bytes). Note this is not the same as the size of the image when it was exported or the actual size of the image. Example: `47694`

website/docs/d/core_image_shape.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The following arguments are supported:
3434

3535
The following attributes are exported:
3636

37-
* `image_id` - The image OCID.
37+
* `image_id` - The image [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
3838
* `ocpu_constraints` -
3939
* `max` - The maximum number of OCPUs supported for this image and shape.
4040
* `min` - The minimum number of OCPUs supported for this image and shape.

website/docs/d/core_image_shapes.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: |-
1010
# Data Source: oci_core_image_shapes
1111
This data source provides the list of Image Shapes in Oracle Cloud Infrastructure Core service.
1212

13-
Lists the shape compatibilities for the image.
13+
Lists the compatible shapes for the specified image.
1414

1515
## Example Usage
1616

@@ -38,7 +38,7 @@ The following attributes are exported:
3838

3939
The following attributes are exported:
4040

41-
* `image_id` - The image OCID.
41+
* `image_id` - The image [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
4242
* `ocpu_constraints` -
4343
* `max` - The maximum number of OCPUs supported for this image and shape.
4444
* `min` - The minimum number of OCPUs supported for this image and shape.

website/docs/d/core_images.html.markdown

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,26 +81,26 @@ The following attributes are exported:
8181
* `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.
8282
* `launch_options` -
8383
* `boot_volume_type` - Emulation type for volume.
84-
* `ISCSI` - ISCSI attached block storage device. This is the default for Boot Volumes and Remote Block Storage volumes on Oracle provided images.
84+
* `ISCSI` - ISCSI attached block storage device.
8585
* `SCSI` - Emulated SCSI disk.
8686
* `IDE` - Emulated IDE disk.
8787
* `VFIO` - Direct attached Virtual Function storage. This is the default option for Local data volumes on Oracle provided images.
88-
* `PARAVIRTUALIZED` - Paravirtualized disk.
88+
* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for Boot Volumes and Remote Block Storage volumes on Oracle provided images.
8989
* `firmware` - Firmware used to boot VM. Select the option that matches your operating system.
9090
* `BIOS` - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
9191
* `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for Oracle provided images.
9292
* `is_consistent_volume_naming_enabled` - Whether to enable consistent volume naming feature. Defaults to false.
93-
* `is_pv_encryption_in_transit_enabled` - Whether to enable in-transit encryption for the boot volume's paravirtualized attachment. The default value is false.
93+
* `is_pv_encryption_in_transit_enabled` - Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/datatypes/LaunchInstanceDetails).
9494
* `network_type` - Emulation type for the physical network interface card (NIC).
9595
* `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
9696
* `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
9797
* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using virtio drivers.
9898
* `remote_data_volume_type` - Emulation type for volume.
99-
* `ISCSI` - ISCSI attached block storage device. This is the default for Boot Volumes and Remote Block Storage volumes on Oracle provided images.
99+
* `ISCSI` - ISCSI attached block storage device.
100100
* `SCSI` - Emulated SCSI disk.
101101
* `IDE` - Emulated IDE disk.
102102
* `VFIO` - Direct attached Virtual Function storage. This is the default option for Local data volumes on Oracle provided images.
103-
* `PARAVIRTUALIZED` - Paravirtualized disk.
103+
* `PARAVIRTUALIZED` - Paravirtualized disk.This is the default for Boot Volumes and Remote Block Storage volumes on Oracle provided images.
104104
* `operating_system` - The image's operating system. Example: `Oracle Linux`
105105
* `operating_system_version` - The image's operating system version. Example: `7.2`
106106
* `size_in_mbs` - The boot volume size for an instance launched from this image, (1 MB = 1048576 bytes). Note this is not the same as the size of the image when it was exported or the actual size of the image. Example: `47694`

website/docs/d/core_instance.html.markdown

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -73,28 +73,28 @@ The following attributes are exported:
7373
* `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
7474
* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using virtio drivers.
7575
* `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.
76-
* `launch_options` -
76+
* `launch_options` - Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
7777
* `boot_volume_type` - Emulation type for volume.
78-
* `ISCSI` - ISCSI attached block storage device. This is the default for Boot Volumes and Remote Block Storage volumes on Oracle provided images.
78+
* `ISCSI` - ISCSI attached block storage device.
7979
* `SCSI` - Emulated SCSI disk.
8080
* `IDE` - Emulated IDE disk.
8181
* `VFIO` - Direct attached Virtual Function storage. This is the default option for Local data volumes on Oracle provided images.
82-
* `PARAVIRTUALIZED` - Paravirtualized disk.
82+
* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for Boot Volumes and Remote Block Storage volumes on Oracle provided images.
8383
* `firmware` - Firmware used to boot VM. Select the option that matches your operating system.
8484
* `BIOS` - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
8585
* `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for Oracle provided images.
8686
* `is_consistent_volume_naming_enabled` - Whether to enable consistent volume naming feature. Defaults to false.
87-
* `is_pv_encryption_in_transit_enabled` - Whether to enable in-transit encryption for the boot volume's paravirtualized attachment. The default value is false.
87+
* `is_pv_encryption_in_transit_enabled` - Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/datatypes/LaunchInstanceDetails).
8888
* `network_type` - Emulation type for the physical network interface card (NIC).
8989
* `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
9090
* `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
9191
* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using virtio drivers.
9292
* `remote_data_volume_type` - Emulation type for volume.
93-
* `ISCSI` - ISCSI attached block storage device. This is the default for Boot Volumes and Remote Block Storage volumes on Oracle provided images.
93+
* `ISCSI` - ISCSI attached block storage device.
9494
* `SCSI` - Emulated SCSI disk.
9595
* `IDE` - Emulated IDE disk.
9696
* `VFIO` - Direct attached Virtual Function storage. This is the default option for Local data volumes on Oracle provided images.
97-
* `PARAVIRTUALIZED` - Paravirtualized disk.
97+
* `PARAVIRTUALIZED` - Paravirtualized disk.This is the default for Boot Volumes and Remote Block Storage volumes on Oracle provided images.
9898
* `metadata` - Custom metadata that you provide.
9999
* `private_ip` - The private IP address of instance VNIC. To set the private IP address, use the `private_ip` argument in create_vnic_details.
100100
* `public_ip` - The public IP address of instance VNIC (if enabled).
@@ -105,16 +105,22 @@ The following attributes are exported:
105105
Examples: `phx`, `eu-frankfurt-1`
106106
* `shape` - The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. You can enumerate all available shapes by calling [ListShapes](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/Shape/ListShapes).
107107
* `shape_config` -
108-
* `gpu_description` - A short description of the GPUs available to this instance. This field is `null` if `gpus` is `0`.
109-
* `gpus` - The number of GPUs available to this instance.
110-
* `local_disk_description` - A short description of the local disks available to this instance. This field is `null` if `localDisks` is equal to `0`.
108+
* `gpu_description` - A short description of the instance's graphics processing unit (GPU).
109+
110+
If the instance does not have any GPUs, this field is `null`.
111+
* `gpus` - The number of GPUs available to the instance.
112+
* `local_disk_description` - A short description of the local disks available to this instance.
113+
114+
If the instance does not have any local disks, this field is `null`.
111115
* `local_disks` - The number of local disks available to the instance.
112-
* `local_disks_total_size_in_gbs` - The size of the local disks, aggregated, in gigabytes. This field is `null` if `localDisks` is equal to `0`.
116+
* `local_disks_total_size_in_gbs` - The aggregate size of all local disks, in gigabytes.
117+
118+
If the instance does not have any local disks, this field is `null`.
113119
* `max_vnic_attachments` - The maximum number of VNIC attachments for the instance.
114-
* `memory_in_gbs` - The total amount of memory, in gigabytes, available to the instance.
115-
* `networking_bandwidth_in_gbps` - The networking bandwidth, in gigabits per second, available to the instance.
120+
* `memory_in_gbs` - The total amount of memory available to the instance, in gigabytes.
121+
* `networking_bandwidth_in_gbps` - The networking bandwidth available to the instance, in gigabits per second.
116122
* `ocpus` - The total number of OCPUs available to the instance.
117-
* `processor_description` - A short description of the processors available to the instance.
123+
* `processor_description` - A short description of the instance's processor (CPU).
118124
* `source_details` - Details for creating an instance
119125
* `boot_volume_size_in_gbs` - The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 16384 GB (16TB).
120126
* `kms_key_id` - The OCID of the Key Management key to assign as the master encryption key for the boot volume.

website/docs/d/core_instance_configuration.html.markdown

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,9 @@ The following attributes are exported:
8181
* `private_ip` - A private IP address of your choice to assign to the VNIC. See the `privateIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/CreateVnicDetails/) for more information.
8282
* `skip_source_dest_check` - Whether the source/destination check is disabled on the VNIC. See the `skipSourceDestCheck` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/CreateVnicDetails/) for more information.
8383
* `subnet_id` - The OCID of the subnet to create the VNIC in. See the `subnetId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/CreateVnicDetails/) for more information.
84-
* `dedicated_vm_host_id` - The OCID of dedicated VM host.
84+
* `dedicated_vm_host_id` - The OCID of dedicated VM host.
85+
86+
Dedicated VM hosts can be used when launching individual instances from an instance configuration. They cannot be used to launch instance pools.
8587
* `defined_tags` - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}`
8688
* `display_name` - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My bare metal instance`
8789
* `extended_metadata` - Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the 'metadata' object.
@@ -112,28 +114,28 @@ The following attributes are exported:
112114
* `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
113115
* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using virtio drivers.
114116
* `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.
115-
* `launch_options` -
117+
* `launch_options` - Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
116118
* `boot_volume_type` - Emulation type for volume.
117-
* `ISCSI` - ISCSI attached block storage device. This is the default for Boot Volumes and Remote Block Storage volumes on Oracle provided images.
119+
* `ISCSI` - ISCSI attached block storage device.
118120
* `SCSI` - Emulated SCSI disk.
119121
* `IDE` - Emulated IDE disk.
120122
* `VFIO` - Direct attached Virtual Function storage. This is the default option for Local data volumes on Oracle provided images.
121-
* `PARAVIRTUALIZED` - Paravirtualized disk.
123+
* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for Boot Volumes and Remote Block Storage volumes on Oracle provided images.
122124
* `firmware` - Firmware used to boot VM. Select the option that matches your operating system.
123125
* `BIOS` - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
124126
* `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for Oracle provided images.
125127
* `is_consistent_volume_naming_enabled` - Whether to enable consistent volume naming feature. Defaults to false.
126-
* `is_pv_encryption_in_transit_enabled` - Whether to enable in-transit encryption for the boot volume's paravirtualized attachment. The default value is false.
128+
* `is_pv_encryption_in_transit_enabled` - Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/datatypes/InstanceConfigurationLaunchInstanceDetails).
127129
* `network_type` - Emulation type for the physical network interface card (NIC).
128130
* `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
129131
* `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
130132
* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using virtio drivers.
131133
* `remote_data_volume_type` - Emulation type for volume.
132-
* `ISCSI` - ISCSI attached block storage device. This is the default for Boot Volumes and Remote Block Storage volumes on Oracle provided images.
134+
* `ISCSI` - ISCSI attached block storage device.
133135
* `SCSI` - Emulated SCSI disk.
134136
* `IDE` - Emulated IDE disk.
135137
* `VFIO` - Direct attached Virtual Function storage. This is the default option for Local data volumes on Oracle provided images.
136-
* `PARAVIRTUALIZED` - Paravirtualized disk.
138+
* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for Boot Volumes and Remote Block Storage volumes on Oracle provided images.
137139
* `metadata` - Custom metadata key/value pairs that you provide, such as the SSH public key required to connect to the instance.
138140

139141
A metadata service runs on every launched instance. The service is an HTTP endpoint listening on 169.254.169.254. You can use the service to:

0 commit comments

Comments
 (0)