Try SpotterFetches details about one or multiple InstanceConfiguration resources in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches details about one or multiple InstanceConfiguration resources in Oracle Cloud Infrastructure
Lists the instance configurations in the specified compartment.
If I(instance_configuration_id) is specified, the details of a single InstanceConfiguration will be returned.
- name: Get a specific instance_configuration
oci_compute_management_instance_configuration_facts:
# required
instance_configuration_id: "ocid1.instanceconfiguration.oc1..xxxxxxEXAMPLExxxxxx"
- name: List instance_configurations
oci_compute_management_instance_configuration_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
sort_by: TIMECREATED
sort_order: ASC
region:
description:
- The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set,
then the value of the OCI_REGION variable, if any, is used. This option is required
if the region is not specified through a configuration file (See C(config_file_location)).
Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm)
for more information on OCI regions.
type: str
sort_by:
choices:
- TIMECREATED
- DISPLAYNAME
description:
- The field to sort by. You can provide one sort order (`sortOrder`). Default order
for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
sort order is case sensitive.
- '**Note:** In general, some "List" operations (for example, `ListInstances`) let
you optionally filter by availability domain if the scope of the resource type is
within a single availability domain. If you call one of these "List" operations
without specifying an availability domain, the resources are grouped by availability
domain, then sorted.'
type: str
tenancy:
description:
- OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if
any, is used. This option is required if the tenancy OCID is not specified through
a configuration file (See C(config_file_location)). To get the tenancy OCID, please
refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm)
type: str
api_user:
description:
- The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the
value of the OCI_USER_ID environment variable, if any, is used. This option is required
if the user is not specified through a configuration file (See C(config_file_location)).
To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
- security_token
default: api_key
description:
- The type of authentication to use for making API requests. By default C(auth_type="api_key")
based authentication is performed and the API key (see I(api_user_key_file)) in
your config file will be used. If this 'auth_type' module option is not specified,
the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use C(auth_type="instance_principal")
to use instance principal based authentication when running ansible playbooks within
an OCI compute instance.
type: str
sort_order:
choices:
- ASC
- DESC
description:
- The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME
sort order is case sensitive.
type: str
cert_bundle:
description:
- The full path to a CA certificate bundle to be used for SSL verification. This will
override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE
variable, if any, is used.
type: str
auth_purpose:
choices:
- service_principal
description:
- The auth purpose which can be used in conjunction with 'auth_type=instance_principal'.
The default auth_purpose for instance_principal is None.
type: str
display_name:
description: Use I(display_name) along with the other options to return only resources
that match the given display name exactly.
type: str
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment.
- Required to list multiple instance_configurations.
type: str
api_user_key_file:
description:
- Full path and filename of the private key (in PEM format). If not set, then the
value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required
if the private key is not specified through a configuration file (See C(config_file_location)).
If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option
must also be provided.
type: str
config_profile_name:
description:
- The profile to load from the config file referenced by C(config_file_location).
If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any,
is used. Otherwise, defaults to the "DEFAULT" profile in C(config_file_location).
type: str
api_user_fingerprint:
description:
- Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT
environment variable, if any, is used. This option is required if the key fingerprint
is not specified through a configuration file (See C(config_file_location)). To
get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
config_file_location:
description:
- Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment
variable, if any, is used. Otherwise, defaults to ~/.oci/config.
type: str
api_user_key_pass_phrase:
description:
- Passphrase used by the key referenced in C(api_user_key_file), if it is encrypted.
If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is
used. This option is required if the key passphrase is not specified through a configuration
file (See C(config_file_location)).
type: str
instance_configuration_id:
aliases:
- id
description:
- The OCID of the instance configuration.
- Required to get a specific instance_configuration.
type: str
realm_specific_endpoint_template_enabled:
description:
- Enable/Disable realm specific endpoint template for service client. By Default,
realm specific endpoint template is disabled. If not set, then the value of the
OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
type: bool
instance_configurations:
contains:
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment containing the instance configuration.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
deferred_fields:
description:
- Parameters that were not specified when the instance configuration was created,
but that are required to launch an instance from the instance configuration.
See the L(LaunchInstanceConfiguration,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstanceConfiguration)
operation.
- Returned for get operation
returned: on success
sample: []
type: list
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's changeable. Avoid
entering confidential information.
returned: on success
sample: display_name_example
type: str
freeform_tags:
description:
- Free-form tags for this resource. Each tag is a simple key-value pair with
no predefined name, type, or namespace. For more information, see L(Resource
Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the instance configuration.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
instance_details:
contains:
block_volumes:
contains:
attach_details:
contains:
device:
description:
- The device name.
returned: on success
sample: device_example
type: str
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's changeable.
Avoid entering confidential information.
returned: on success
sample: display_name_example
type: str
is_pv_encryption_in_transit_enabled:
description:
- Whether to enable in-transit encryption for the data volume's
paravirtualized attachment. The default value is false.
returned: on success
sample: true
type: bool
is_read_only:
description:
- Whether the attachment should be created in read-only mode.
returned: on success
sample: true
type: bool
is_shareable:
description:
- Whether the attachment should be created in shareable mode. If
an attachment is created in shareable mode, then other instances
can attach the same volume, provided that they also create their
attachments in shareable mode. Only certain volume types can be
attached in shareable mode. Defaults to false if not specified.
returned: on success
sample: true
type: bool
type:
description:
- The type of volume. The only supported values are "iscsi" and
"paravirtualized".
returned: on success
sample: iscsi
type: str
use_chap:
description:
- Whether to use CHAP authentication for the volume attachment.
Defaults to false.
returned: on success
sample: true
type: bool
description:
- ''
returned: on success
type: complex
create_details:
contains:
autotune_policies:
contains:
autotune_type:
description:
- This specifies the type of autotunes supported by OCI.
returned: on success
sample: DETACHED_VOLUME
type: str
max_vpus_per_gb:
description:
- This will be the maximum VPUs/GB performance level that the
volume will be auto-tuned temporarily based on performance
monitoring.
returned: on success
sample: 56
type: int
description:
- The list of autotune policies enabled for this volume.
returned: on success
type: complex
availability_domain:
description:
- The availability domain of the volume.
- 'Example: `Uocm:PHX-AD-1`'
returned: on success
sample: Uocm:PHX-AD-1
type: str
backup_policy_id:
description:
- If provided, specifies the ID of the volume backup policy to assign
to the newly created volume. If omitted, no policy will be assigned.
returned: on success
sample: ocid1.backuppolicy.oc1..xxxxxxEXAMPLExxxxxx
type: str
block_volume_replicas:
contains:
availability_domain:
description:
- The availability domain of the block volume replica.
- 'Example: `Uocm:PHX-AD-1`'
returned: on success
sample: Uocm:PHX-AD-1
type: str
display_name:
description:
- The display name of the block volume replica. You may optionally
specify a *display name* for the block volume replica, otherwise
a default is provided.
returned: on success
sample: display_name_example
type: str
description:
- The list of block volume replicas to be enabled for this volume
in the specified destination availability domains.
returned: on success
type: complex
compartment_id:
description:
- The OCID of the compartment that contains the volume.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped
to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's changeable.
Avoid entering confidential information.
returned: on success
sample: display_name_example
type: str
freeform_tags:
description:
- Free-form tags for this resource. Each tag is a simple key-value
pair with no predefined name, type, or namespace. For more information,
see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
is_auto_tune_enabled:
description:
- Specifies whether the auto-tune performance is enabled for this
boot volume. This field is deprecated. Use the `InstanceConfigurationDetachedVolumeAutotunePolicy`
instead to enable the volume for detached autotune.
returned: on success
sample: true
type: bool
kms_key_id:
description:
- The OCID of the Vault service key to assign as the master encryption
key for the volume.
returned: on success
sample: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
type: str
size_in_gbs:
description:
- The size of the volume in GBs.
returned: on success
sample: 56
type: int
source_details:
contains:
id:
description:
- The OCID of the volume.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
type:
description:
- ''
returned: on success
sample: volume
type: str
description:
- ''
returned: on success
type: complex
vpus_per_gb:
description:
- The number of volume performance units (VPUs) that will be applied
to this volume per GB, representing the Block Volume service's
elastic performance options. See L(Block Volume Performance Levels,https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels)
for more information.
- 'Allowed values:'
- ' * `0`: Represents Lower Cost option.'
- ' * `10`: Represents Balanced option.'
- ' * `20`: Represents Higher Performance option.'
- ' * `30`-`120`: Represents the Ultra High Performance option.'
- For performance autotune enabled volumes, it would be the Default(Minimum)
VPUs/GB.
returned: on success
sample: 56
type: int
description:
- ''
returned: on success
type: complex
volume_id:
description:
- The OCID of the volume.
returned: on success
sample: ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- Block volume parameters.
returned: on success
type: complex
instance_type:
description:
- The type of instance details. Supported instanceType is compute
returned: on success
sample: compute
type: str
launch_details:
contains:
agent_config:
contains:
are_all_plugins_disabled:
description:
- Whether Oracle Cloud Agent can run all the available plugins.
This includes the management and monitoring plugins.
- To get a list of available plugins, use the L(ListInstanceagentAvailablePlugins,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins)
operation in the Oracle Cloud Agent API. For more information
about the available plugins, see L(Managing Plugins with Oracle
Cloud Agent,https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-
plugins.htm).
returned: on success
sample: true
type: bool
is_management_disabled:
description:
- Whether Oracle Cloud Agent can run all the available management
plugins. Default value is false (management plugins are enabled).
- 'These are the management plugins: OS Management Service Agent
and Compute Instance Run Command.'
- The management plugins are controlled by this parameter and by
the per-plugin configuration in the `pluginsConfig` object.
- '- If `isManagementDisabled` is true, all of the management plugins
are disabled, regardless of the per-plugin configuration. - If
`isManagementDisabled` is false, all of the management plugins
are enabled. You can optionally disable individual management
plugins by providing a value in the `pluginsConfig` object.'
returned: on success
sample: true
type: bool
is_monitoring_disabled:
description:
- Whether Oracle Cloud Agent can gather performance metrics and
monitor the instance using the monitoring plugins. Default value
is false (monitoring plugins are enabled).
- 'These are the monitoring plugins: Compute Instance Monitoring
and Custom Logs Monitoring.'
- The monitoring plugins are controlled by this parameter and by
the per-plugin configuration in the `pluginsConfig` object.
- '- If `isMonitoringDisabled` is true, all of the monitoring plugins
are disabled, regardless of the per-plugin configuration. - If
`isMonitoringDisabled` is false, all of the monitoring plugins
are enabled. You can optionally disable individual monitoring
plugins by providing a value in the `pluginsConfig` object.'
returned: on success
sample: true
type: bool
plugins_config:
contains:
desired_state:
description:
- Whether the plugin should be enabled or disabled.
- To enable the monitoring and management plugins, the `isMonitoringDisabled`
and `isManagementDisabled` attributes must also be set to
false.
returned: on success
sample: ENABLED
type: str
name:
description:
- The plugin name. To get a list of available plugins, use the
L(ListInstanceagentAvailablePlugins,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins)
operation in the Oracle Cloud Agent API. For more information
about the available plugins, see L(Managing Plugins with Oracle
Cloud Agent,https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-
plugins.htm).
returned: on success
sample: name_example
type: str
description:
- The configuration of plugins associated with this instance.
returned: on success
type: complex
description:
- ''
returned: on success
type: complex
availability_config:
contains:
is_live_migration_preferred:
description:
- Whether to live migrate supported VM instances to a healthy physical
VM host without disrupting running instances during infrastructure
maintenance events. If null, Oracle chooses the best option for
migrating the VM during infrastructure maintenance events.
returned: on success
sample: true
type: bool
recovery_action:
description:
- The lifecycle state for an instance when it is recovered after
infrastructure maintenance. * `RESTORE_INSTANCE` - The instance
is restored to the lifecycle state it was in before the maintenance
event. If the instance was running, it is automatically rebooted.
This is the default action when a value is not set. * `STOP_INSTANCE`
- The instance is recovered in the stopped state.
returned: on success
sample: RESTORE_INSTANCE
type: str
description:
- ''
returned: on success
type: complex
availability_domain:
description:
- The availability domain of the instance.
- 'Example: `Uocm:PHX-AD-1`'
returned: on success
sample: Uocm:PHX-AD-1
type: str
capacity_reservation_id:
description:
- The OCID of the compute capacity reservation this instance is launched
under.
returned: on success
sample: ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx
type: str
compartment_id:
description:
- The OCID of the compartment containing the instance. Instances created
from instance configurations are placed in the same compartment as
the instance that was used to create the instance configuration.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
create_vnic_details:
contains:
assign_private_dns_record:
description:
- Whether the VNIC should be assigned a private DNS record. See
the `assignPrivateDnsRecord` attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/CreateVnicDetails/)
for more information.
returned: on success
sample: true
type: bool
assign_public_ip:
description:
- Whether the VNIC should be assigned a public IP address. See the
`assignPublicIp` attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/CreateVnicDetails/)
for more information.
returned: on success
sample: true
type: bool
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped
to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's changeable.
Avoid entering confidential information.
returned: on success
sample: display_name_example
type: str
freeform_tags:
description:
- Free-form tags for this resource. Each tag is a simple key-value
pair with no predefined name, type, or namespace. For more information,
see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
hostname_label:
description:
- The hostname for the VNIC's primary private IP. See the `hostnameLabel`
attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.
returned: on success
sample: hostname_label_example
type: str
nsg_ids:
description:
- A list of the OCIDs of the network security groups (NSGs) to add
the VNIC to. For more information about NSGs, see L(NetworkSecurityGroup,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).
returned: on success
sample: []
type: list
private_ip:
description:
- A private IP address of your choice to assign to the VNIC. See
the `privateIp` attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.
returned: on success
sample: private_ip_example
type: str
skip_source_dest_check:
description:
- Whether the source/destination check is disabled on the VNIC.
See the `skipSourceDestCheck` attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.
returned: on success
sample: true
type: bool
subnet_id:
description:
- The OCID of the subnet to create the VNIC in. See the `subnetId`
attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.
returned: on success
sample: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- ''
returned: on success
type: complex
dedicated_vm_host_id:
description:
- The OCID of the dedicated virtual machine host to place the instance
on.
- Dedicated VM hosts can be used when launching individual instances
from an instance configuration. They cannot be used to launch instance
pools.
returned: on success
sample: ocid1.dedicatedvmhost.oc1..xxxxxxEXAMPLExxxxxx
type: str
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped
to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's changeable.
Avoid entering confidential information.
returned: on success
sample: display_name_example
type: str
extended_metadata:
description:
- Additional metadata key/value pairs that you provide. They serve the
same purpose and functionality as fields in the `metadata` object.
- They are distinguished from `metadata` fields in that these can be
nested JSON objects (whereas `metadata` fields are string/string maps
only).
- The combined size of the `metadata` and `extendedMetadata` objects
can be a maximum of 32,000 bytes.
returned: on success
sample: {}
type: dict
fault_domain:
description:
- A fault domain is a grouping of hardware and infrastructure within
an availability domain. Each availability domain contains three fault
domains. Fault domains let you distribute your instances so that they
are not on the same physical hardware within a single availability
domain. A hardware failure or Compute hardware maintenance that affects
one fault domain does not affect instances in other fault domains.
- If you do not specify the fault domain, the system selects one for
you.
- To get a list of fault domains, use the L(ListFaultDomains,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/identity/20160918/FaultDomain/ListFaultDomains)
operation in the Identity and Access Management Service API.
- 'Example: `FAULT-DOMAIN-1`'
returned: on success
sample: FAULT-DOMAIN-1
type: str
freeform_tags:
description:
- Free-form tags for this resource. Each tag is a simple key-value pair
with no predefined name, type, or namespace. For more information,
see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
instance_options:
contains:
are_legacy_imds_endpoints_disabled:
description:
- Whether to disable the legacy (/v1) instance metadata service
endpoints. Customers who have migrated to /v2 should set this
to true for added security. Default is false.
returned: on success
sample: true
type: bool
description:
- ''
returned: on success
type: complex
ipxe_script:
description:
- This is an advanced option.
- When a bare metal or virtual machine instance boots, the iPXE firmware
that runs on the instance is configured to run an iPXE script to continue
the boot process.
- If you want more control over the boot process, you can provide your
own custom iPXE script that will run when the instance boots; however,
you should be aware that the same iPXE script will run every time
an instance boots; not only after the initial LaunchInstance call.
- 'The default iPXE script connects to the instance''s local boot volume
over iSCSI and performs a network boot. If you use a custom iPXE script
and want to network-boot from the instance''s local boot volume over
iSCSI the same way as the default iPXE script, you should use the
following iSCSI IP address: 169.254.0.2, and boot volume IQN: iqn.2015-02.oracle.boot.'
- For more information about the Bring Your Own Image feature of Oracle
Cloud Infrastructure, see L(Bring Your Own Image,https://docs.cloud.oracle.com/iaas/Content/Compute/References/bringyourownimage.htm).
- For more information about iPXE, see http://ipxe.org.
returned: on success
sample: ipxe_script_example
type: str
is_pv_encryption_in_transit_enabled:
description:
- Whether to enable in-transit encryption for the data volume's paravirtualized
attachment. The default value is false.
returned: on success
sample: true
type: bool
launch_mode:
description:
- 'Specifies the configuration mode for launching virtual machine (VM)
instances. The configuration modes are: * `NATIVE` - VM instances
launch with iSCSI boot and VFIO devices. The default value for platform
images. * `EMULATED` - VM instances launch with emulated devices,
such as the E1000 network driver and emulated SCSI disk controller.
* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices
using VirtIO drivers. * `CUSTOM` - VM instances launch with custom
configuration settings specified in the `LaunchOptions` parameter.'
returned: on success
sample: NATIVE
type: str
launch_options:
contains:
boot_volume_type:
description:
- Emulation type for the boot volume. * `ISCSI` - ISCSI attached
block storage device. * `SCSI` - Emulated SCSI disk. * `IDE` -
Emulated IDE disk. * `VFIO` - Direct attached Virtual Function
storage. This is the default option for local data volumes on
platform images. * `PARAVIRTUALIZED` - Paravirtualized disk. This
is the default for boot volumes and remote block storage volumes
on platform images.
returned: on success
sample: ISCSI
type: str
firmware:
description:
- Firmware used to boot VM. Select the option that matches your
operating system. * `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. * `UEFI_64` - Boot VM using
UEFI style firmware compatible with 64 bit operating systems.
This is the default for platform images.
returned: on success
sample: BIOS
type: str
is_consistent_volume_naming_enabled:
description:
- Whether to enable consistent volume naming feature. Defaults to
false.
returned: on success
sample: true
type: bool
is_pv_encryption_in_transit_enabled:
description:
- Deprecated. Instead use `isPvEncryptionInTransitEnabled` in L(InstanceConfigurationLaunchInstanceDetails,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails).
returned: on success
sample: true
type: bool
network_type:
description:
- Emulation type for the physical network interface card (NIC).
* `E1000` - Emulated Gigabit ethernet controller. Compatible with
Linux e1000 network driver. * `VFIO` - Direct attached Virtual
Function network controller. This is the networking type when
you launch an instance using hardware-assisted (SR-IOV) networking.
* `PARAVIRTUALIZED` - VM instances launch with paravirtualized
devices using VirtIO drivers.
returned: on success
sample: E1000
type: str
remote_data_volume_type:
description:
- Emulation type for volume. * `ISCSI` - ISCSI attached block storage
device. * `SCSI` - Emulated SCSI disk. * `IDE` - Emulated IDE
disk. * `VFIO` - Direct attached Virtual Function storage. This
is the default option for local data volumes on platform images.
* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default
for boot volumes and remote block storage volumes on platform
images.
returned: on success
sample: ISCSI
type: str
description:
- ''
returned: on success
type: complex
metadata:
description:
- Custom metadata key/value pairs that you provide, such as the SSH
public key required to connect to the instance.
- '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:'
- '* Provide information to L(Cloud-Init,https://cloudinit.readthedocs.org/en/latest/)
to be used for various system initialization tasks.'
- '* Get information about the instance, including the custom metadata
that you provide when you launch the instance.'
- '**Providing Cloud-Init Metadata**'
- 'You can use the following metadata key names to provide information
to Cloud-Init:'
- '**"ssh_authorized_keys"** - Provide one or more public SSH keys to
be included in the `~/.ssh/authorized_keys` file for the default user
on the instance. Use a newline character to separate multiple keys.
The SSH keys must be in the format necessary for the `authorized_keys`
file, as shown in the example below.'
- '**"user_data"** - Provide your own base64-encoded data to be used
by Cloud-Init to run custom scripts or provide custom Cloud-Init configuration.
For information about how to take advantage of user data, see the
L(Cloud-Init Documentation,http://cloudinit.readthedocs.org/en/latest/topics/format.html).'
- '**Metadata Example**'
- ' "metadata" : { "quake_bot_level" : "Severe", "ssh_authorized_keys"
: "ssh-rsa <your_public_SSH_key>== rsa-key-20160227", "user_data"
: "<your_public_SSH_key>==" } **Getting Metadata on the Instance**'
- 'To get information about your instance, connect to the instance using
SSH and issue any of the following GET requests:'
- ' curl -H "Authorization: Bearer Oracle" http://169.254.169.254/opc/v2/instance/
curl -H "Authorization: Bearer Oracle" http://169.254.169.254/opc/v2/instance/metadata/
curl -H "Authorization: Bearer Oracle" http://169.254.169.254/opc/v2/instance/metadata/<any-key-name>'
- You'll get back a response that includes all the instance information;
only the metadata information; or the metadata information for the
specified key name, respectively.
- The combined size of the `metadata` and `extendedMetadata` objects
can be a maximum of 32,000 bytes.
returned: on success
sample: {}
type: dict
platform_config:
contains:
are_virtual_instructions_enabled:
description:
- Whether virtualization instructions are available. For example,
Secure Virtual Machine for AMD shapes or VT-x for Intel shapes.
returned: on success
sample: true
type: bool
is_access_control_service_enabled:
description:
- Whether the Access Control Service is enabled on the instance.
When enabled, the platform can enforce PCIe device isolation,
required for VFIO device pass-through.
returned: on success
sample: true
type: bool
is_input_output_memory_management_unit_enabled:
description:
- Whether the input-output memory management unit is enabled.
returned: on success
sample: true
type: bool
is_measured_boot_enabled:
description:
- Whether the Measured Boot feature is enabled on the instance.
returned: on success
sample: true
type: bool
is_memory_encryption_enabled:
description:
- Whether the instance is a confidential instance. If this value
is `true`, the instance is a confidential instance. The default
value is `false`.
returned: on success
sample: true
type: bool
is_secure_boot_enabled:
description:
- Whether Secure Boot is enabled on the instance.
returned: on success
sample: true
type: bool
is_symmetric_multi_threading_enabled:
description:
- Whether symmetric multithreading is enabled on the instance. Symmetric
multithreading is also called simultaneous multithreading (SMT)
or Intel Hyper-Threading.
- Intel and AMD processors have two hardware execution threads per
core (OCPU). SMT permits multiple independent threads of execution,
to better use the resources and increase the efficiency of the
CPU. When multithreading is disabled, only one thread is permitted
to run on each core, which can provide higher or more predictable
performance for some workloads.
returned: on success
sample: true
type: bool
is_trusted_platform_module_enabled:
description:
- Whether the Trusted Platform Module (TPM) is enabled on the instance.
returned: on success
sample: true
type: bool
numa_nodes_per_socket:
description:
- The number of NUMA nodes per socket (NPS).
returned: on success
sample: NPS0
type: str
percentage_of_cores_enabled:
description:
- The percentage of cores enabled. Value must be a multiple of 25%.
If the requested percentage results in a fractional number of
cores, the system rounds up the number of cores across processors
and provisions an instance with a whole number of cores.
- If the applications that you run on the instance use a core-based
licensing model and need fewer cores than the full size of the
shape, you can disable cores to reduce your licensing costs. The
instance itself is billed for the full shape, regardless of whether
all cores are enabled.
returned: on success
sample: 56
type: int
type:
description:
- The type of platform being configured.
returned: on success
sample: AMD_MILAN_BM
type: str
description:
- ''
returned: on success
type: complex
preemptible_instance_config:
contains:
preemption_action:
contains:
preserve_boot_volume:
description:
- Whether to preserve the boot volume that was used to launch
the preemptible instance when the instance is terminated.
Defaults to false if not specified.
returned: on success
sample: true
type: bool
type:
description:
- The type of action to run when the instance is interrupted
for eviction.
returned: on success
sample: TERMINATE
type: str
description:
- ''
returned: on success
type: complex
description:
- ''
returned: on success
type: complex
preferred_maintenance_action:
description:
- The preferred maintenance action for an instance. The default is LIVE_MIGRATE,
if live migration is supported. * `LIVE_MIGRATE` - Run maintenance
using a live migration. * `REBOOT` - Run maintenance using a reboot.
returned: on success
sample: LIVE_MIGRATE
type: str
shape:
description:
- The shape of an instance. The shape determines the number of CPUs,
amount of memory, and other resources allocated to the instance.
- You can enumerate all available shapes by calling L(ListShapes,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/Shape/ListShapes).
returned: on success
sample: shape_example
type: str
shape_config:
contains:
baseline_ocpu_utilization:
description:
- The baseline OCPU utilization for a subcore burstable VM instance.
Leave this attribute blank for a non-burstable instance, or explicitly
specify non-burstable with `BASELINE_1_1`.
- 'The following values are supported: - `BASELINE_1_8` - baseline
usage is 1/8 of an OCPU. - `BASELINE_1_2` - baseline usage is
1/2 of an OCPU. - `BASELINE_1_1` - baseline usage is an entire
OCPU. This represents a non-burstable instance.'
returned: on success
sample: BASELINE_1_8
type: str
memory_in_gbs:
description:
- The total amount of memory available to the instance, in gigabytes.
returned: on success
sample: 3.4
type: float
nvmes:
description:
- The number of NVMe drives to be used for storage. A single drive
has 6.8 TB available.
returned: on success
sample: 56
type: int
ocpus:
description:
- The total number of OCPUs available to the instance.
returned: on success
sample: 3.4
type: float
vcpus:
description:
- The total number of VCPUs available to the instance. This can
be used instead of OCPUs, in which case the actual number of OCPUs
will be calculated based on this value and the actual hardware.
This must be a multiple of 2.
returned: on success
sample: 56
type: int
description:
- ''
returned: on success
type: complex
source_details:
contains:
boot_volume_id:
description:
- The OCID of the boot volume used to boot the instance.
returned: on success
sample: ocid1.bootvolume.oc1..xxxxxxEXAMPLExxxxxx
type: str
boot_volume_size_in_gbs:
description:
- The size of the boot volume in GBs. The minimum value is 50 GB
and the maximum value is 32,768 GB (32 TB).
returned: on success
sample: 56
type: int
boot_volume_vpus_per_gb:
description:
- The number of volume performance units (VPUs) that will be applied
to this volume per GB, representing the Block Volume service's
elastic performance options. See L(Block Volume Performance Levels,https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels)
for more information.
- 'Allowed values:'
- ' * `10`: Represents Balanced option.'
- ' * `20`: Represents Higher Performance option.'
- ' * `30`-`120`: Represents the Ultra High Performance option.'
- For performance autotune enabled volumes, it would be the Default(Minimum)
VPUs/GB.
returned: on success
sample: 56
type: int
image_id:
description:
- The OCID of the image used to boot the instance.
returned: on success
sample: ocid1.image.oc1..xxxxxxEXAMPLExxxxxx
type: str
instance_source_image_filter_details:
contains:
compartment_id:
description:
- The OCID of the compartment containing images to search
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
defined_tags_filter:
description:
- Filter based on these defined tags. Each key is predefined
and scoped to a namespace. For more information, see L(Resource
Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
returned: on success
sample: {}
type: dict
operating_system:
description:
- The image's operating system.
- 'Example: `Oracle Linux`'
returned: on success
sample: operating_system_example
type: str
operating_system_version:
description:
- The image's operating system version.
- 'Example: `7.2`'
returned: on success
sample: operating_system_version_example
type: str
description:
- ''
returned: on success
type: complex
kms_key_id:
description:
- The OCID of the Vault service key to assign as the master encryption
key for the boot volume.
returned: on success
sample: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
type: str
source_type:
description:
- The source type for the instance. Use `image` when specifying
the image OCID. Use `bootVolume` when specifying the boot volume
OCID.
returned: on success
sample: bootVolume
type: str
description:
- ''
returned: on success
type: complex
description:
- ''
returned: on success
type: complex
options:
contains:
block_volumes:
contains:
attach_details:
contains:
device:
description:
- The device name.
returned: on success
sample: device_example
type: str
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's
changeable. Avoid entering confidential information.
returned: on success
sample: display_name_example
type: str
is_pv_encryption_in_transit_enabled:
description:
- Whether to enable in-transit encryption for the data volume's
paravirtualized attachment. The default value is false.
returned: on success
sample: true
type: bool
is_read_only:
description:
- Whether the attachment should be created in read-only mode.
returned: on success
sample: true
type: bool
is_shareable:
description:
- Whether the attachment should be created in shareable mode.
If an attachment is created in shareable mode, then other
instances can attach the same volume, provided that they also
create their attachments in shareable mode. Only certain volume
types can be attached in shareable mode. Defaults to false
if not specified.
returned: on success
sample: true
type: bool
type:
description:
- The type of volume. The only supported values are "iscsi"
and "paravirtualized".
returned: on success
sample: iscsi
type: str
use_chap:
description:
- Whether to use CHAP authentication for the volume attachment.
Defaults to false.
returned: on success
sample: true
type: bool
description:
- ''
returned: on success
type: complex
create_details:
contains:
autotune_policies:
contains:
autotune_type:
description:
- This specifies the type of autotunes supported by OCI.
returned: on success
sample: DETACHED_VOLUME
type: str
max_vpus_per_gb:
description:
- This will be the maximum VPUs/GB performance level that
the volume will be auto-tuned temporarily based on performance
monitoring.
returned: on success
sample: 56
type: int
description:
- The list of autotune policies enabled for this volume.
returned: on success
type: complex
availability_domain:
description:
- The availability domain of the volume.
- 'Example: `Uocm:PHX-AD-1`'
returned: on success
sample: Uocm:PHX-AD-1
type: str
backup_policy_id:
description:
- If provided, specifies the ID of the volume backup policy
to assign to the newly created volume. If omitted, no policy
will be assigned.
returned: on success
sample: ocid1.backuppolicy.oc1..xxxxxxEXAMPLExxxxxx
type: str
block_volume_replicas:
contains:
availability_domain:
description:
- The availability domain of the block volume replica.
- 'Example: `Uocm:PHX-AD-1`'
returned: on success
sample: Uocm:PHX-AD-1
type: str
display_name:
description:
- The display name of the block volume replica. You may
optionally specify a *display name* for the block volume
replica, otherwise a default is provided.
returned: on success
sample: display_name_example
type: str
description:
- The list of block volume replicas to be enabled for this volume
in the specified destination availability domains.
returned: on success
type: complex
compartment_id:
description:
- The OCID of the compartment that contains the volume.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and
scoped to a namespace. For more information, see L(Resource
Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's
changeable. Avoid entering confidential information.
returned: on success
sample: display_name_example
type: str
freeform_tags:
description:
- Free-form tags for this resource. Each tag is a simple key-value
pair with no predefined name, type, or namespace. For more
information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
is_auto_tune_enabled:
description:
- Specifies whether the auto-tune performance is enabled for
this boot volume. This field is deprecated. Use the `InstanceConfigurationDetachedVolumeAutotunePolicy`
instead to enable the volume for detached autotune.
returned: on success
sample: true
type: bool
kms_key_id:
description:
- The OCID of the Vault service key to assign as the master
encryption key for the volume.
returned: on success
sample: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
type: str
size_in_gbs:
description:
- The size of the volume in GBs.
returned: on success
sample: 56
type: int
source_details:
contains:
id:
description:
- The OCID of the volume.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
type:
description:
- ''
returned: on success
sample: volume
type: str
description:
- ''
returned: on success
type: complex
vpus_per_gb:
description:
- The number of volume performance units (VPUs) that will be
applied to this volume per GB, representing the Block Volume
service's elastic performance options. See L(Block Volume
Performance Levels,https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels)
for more information.
- 'Allowed values:'
- ' * `0`: Represents Lower Cost option.'
- ' * `10`: Represents Balanced option.'
- ' * `20`: Represents Higher Performance option.'
- ' * `30`-`120`: Represents the Ultra High Performance option.'
- For performance autotune enabled volumes, it would be the
Default(Minimum) VPUs/GB.
returned: on success
sample: 56
type: int
description:
- ''
returned: on success
type: complex
volume_id:
description:
- The OCID of the volume.
returned: on success
sample: ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- Block volume parameters.
returned: on success
type: complex
instance_type:
description:
- The type of instance details. Supported instanceType is compute
returned: on success
sample: instance_type_example
type: str
launch_details:
contains:
agent_config:
contains:
are_all_plugins_disabled:
description:
- Whether Oracle Cloud Agent can run all the available plugins.
This includes the management and monitoring plugins.
- To get a list of available plugins, use the L(ListInstanceagentAvailablePlugins,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins)
operation in the Oracle Cloud Agent API. For more information
about the available plugins, see L(Managing Plugins with Oracle
Cloud Agent,https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-
plugins.htm).
returned: on success
sample: true
type: bool
is_management_disabled:
description:
- Whether Oracle Cloud Agent can run all the available management
plugins. Default value is false (management plugins are enabled).
- 'These are the management plugins: OS Management Service Agent
and Compute Instance Run Command.'
- The management plugins are controlled by this parameter and
by the per-plugin configuration in the `pluginsConfig` object.
- '- If `isManagementDisabled` is true, all of the management
plugins are disabled, regardless of the per-plugin configuration.
- If `isManagementDisabled` is false, all of the management
plugins are enabled. You can optionally disable individual
management plugins by providing a value in the `pluginsConfig`
object.'
returned: on success
sample: true
type: bool
is_monitoring_disabled:
description:
- Whether Oracle Cloud Agent can gather performance metrics
and monitor the instance using the monitoring plugins. Default
value is false (monitoring plugins are enabled).
- 'These are the monitoring plugins: Compute Instance Monitoring
and Custom Logs Monitoring.'
- The monitoring plugins are controlled by this parameter and
by the per-plugin configuration in the `pluginsConfig` object.
- '- If `isMonitoringDisabled` is true, all of the monitoring
plugins are disabled, regardless of the per-plugin configuration.
- If `isMonitoringDisabled` is false, all of the monitoring
plugins are enabled. You can optionally disable individual
monitoring plugins by providing a value in the `pluginsConfig`
object.'
returned: on success
sample: true
type: bool
plugins_config:
contains:
desired_state:
description:
- Whether the plugin should be enabled or disabled.
- To enable the monitoring and management plugins, the `isMonitoringDisabled`
and `isManagementDisabled` attributes must also be set
to false.
returned: on success
sample: ENABLED
type: str
name:
description:
- The plugin name. To get a list of available plugins, use
the L(ListInstanceagentAvailablePlugins,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins)
operation in the Oracle Cloud Agent API. For more information
about the available plugins, see L(Managing Plugins with
Oracle Cloud Agent,https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).
returned: on success
sample: name_example
type: str
description:
- The configuration of plugins associated with this instance.
returned: on success
type: complex
description:
- ''
returned: on success
type: complex
availability_config:
contains:
is_live_migration_preferred:
description:
- Whether to live migrate supported VM instances to a healthy
physical VM host without disrupting running instances during
infrastructure maintenance events. If null, Oracle chooses
the best option for migrating the VM during infrastructure
maintenance events.
returned: on success
sample: true
type: bool
recovery_action:
description:
- The lifecycle state for an instance when it is recovered after
infrastructure maintenance. * `RESTORE_INSTANCE` - The instance
is restored to the lifecycle state it was in before the maintenance
event. If the instance was running, it is automatically rebooted.
This is the default action when a value is not set. * `STOP_INSTANCE`
- The instance is recovered in the stopped state.
returned: on success
sample: RESTORE_INSTANCE
type: str
description:
- ''
returned: on success
type: complex
availability_domain:
description:
- The availability domain of the instance.
- 'Example: `Uocm:PHX-AD-1`'
returned: on success
sample: Uocm:PHX-AD-1
type: str
capacity_reservation_id:
description:
- The OCID of the compute capacity reservation this instance is
launched under.
returned: on success
sample: ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx
type: str
compartment_id:
description:
- The OCID of the compartment containing the instance. Instances
created from instance configurations are placed in the same compartment
as the instance that was used to create the instance configuration.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
create_vnic_details:
contains:
assign_private_dns_record:
description:
- Whether the VNIC should be assigned a private DNS record.
See the `assignPrivateDnsRecord` attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/CreateVnicDetails/)
for more information.
returned: on success
sample: true
type: bool
assign_public_ip:
description:
- Whether the VNIC should be assigned a public IP address. See
the `assignPublicIp` attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/CreateVnicDetails/)
for more information.
returned: on success
sample: true
type: bool
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and
scoped to a namespace. For more information, see L(Resource
Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's
changeable. Avoid entering confidential information.
returned: on success
sample: display_name_example
type: str
freeform_tags:
description:
- Free-form tags for this resource. Each tag is a simple key-value
pair with no predefined name, type, or namespace. For more
information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
hostname_label:
description:
- The hostname for the VNIC's primary private IP. See the `hostnameLabel`
attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more
information.
returned: on success
sample: hostname_label_example
type: str
nsg_ids:
description:
- A list of the OCIDs of the network security groups (NSGs)
to add the VNIC to. For more information about NSGs, see L(NetworkSecurityGroup,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).
returned: on success
sample: []
type: list
private_ip:
description:
- A private IP address of your choice to assign to the VNIC.
See the `privateIp` attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more
information.
returned: on success
sample: private_ip_example
type: str
skip_source_dest_check:
description:
- Whether the source/destination check is disabled on the VNIC.
See the `skipSourceDestCheck` attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more
information.
returned: on success
sample: true
type: bool
subnet_id:
description:
- The OCID of the subnet to create the VNIC in. See the `subnetId`
attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more
information.
returned: on success
sample: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- ''
returned: on success
type: complex
dedicated_vm_host_id:
description:
- The OCID of the dedicated virtual machine host to place the instance
on.
- Dedicated VM hosts can be used when launching individual instances
from an instance configuration. They cannot be used to launch
instance pools.
returned: on success
sample: ocid1.dedicatedvmhost.oc1..xxxxxxEXAMPLExxxxxx
type: str
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped
to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's changeable.
Avoid entering confidential information.
returned: on success
sample: display_name_example
type: str
extended_metadata:
description:
- Additional metadata key/value pairs that you provide. They serve
the same purpose and functionality as fields in the `metadata`
object.
- They are distinguished from `metadata` fields in that these can
be nested JSON objects (whereas `metadata` fields are string/string
maps only).
- The combined size of the `metadata` and `extendedMetadata` objects
can be a maximum of 32,000 bytes.
returned: on success
sample: {}
type: dict
fault_domain:
description:
- A fault domain is a grouping of hardware and infrastructure within
an availability domain. Each availability domain contains three
fault domains. Fault domains let you distribute your instances
so that they are not on the same physical hardware within a single
availability domain. A hardware failure or Compute hardware maintenance
that affects one fault domain does not affect instances in other
fault domains.
- If you do not specify the fault domain, the system selects one
for you.
- To get a list of fault domains, use the L(ListFaultDomains,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/identity/20160918/FaultDomain/ListFaultDomains)
operation in the Identity and Access Management Service API.
- 'Example: `FAULT-DOMAIN-1`'
returned: on success
sample: FAULT-DOMAIN-1
type: str
freeform_tags:
description:
- Free-form tags for this resource. Each tag is a simple key-value
pair with no predefined name, type, or namespace. For more information,
see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
instance_options:
contains:
are_legacy_imds_endpoints_disabled:
description:
- Whether to disable the legacy (/v1) instance metadata service
endpoints. Customers who have migrated to /v2 should set this
to true for added security. Default is false.
returned: on success
sample: true
type: bool
description:
- ''
returned: on success
type: complex
ipxe_script:
description:
- This is an advanced option.
- When a bare metal or virtual machine instance boots, the iPXE
firmware that runs on the instance is configured to run an iPXE
script to continue the boot process.
- If you want more control over the boot process, you can provide
your own custom iPXE script that will run when the instance boots;
however, you should be aware that the same iPXE script will run
every time an instance boots; not only after the initial LaunchInstance
call.
- 'The default iPXE script connects to the instance''s local boot
volume over iSCSI and performs a network boot. If you use a custom
iPXE script and want to network-boot from the instance''s local
boot volume over iSCSI the same way as the default iPXE script,
you should use the following iSCSI IP address: 169.254.0.2, and
boot volume IQN: iqn.2015-02.oracle.boot.'
- For more information about the Bring Your Own Image feature of
Oracle Cloud Infrastructure, see L(Bring Your Own Image,https://docs.cloud.oracle.com/iaas/Content/Compute/References/bringyourownimage.htm).
- For more information about iPXE, see http://ipxe.org.
returned: on success
sample: ipxe_script_example
type: str
is_pv_encryption_in_transit_enabled:
description:
- Whether to enable in-transit encryption for the data volume's
paravirtualized attachment. The default value is false.
returned: on success
sample: true
type: bool
launch_mode:
description:
- 'Specifies the configuration mode for launching virtual machine
(VM) instances. The configuration modes are: * `NATIVE` - VM instances
launch with iSCSI boot and VFIO devices. The default value for
platform images. * `EMULATED` - VM instances launch with emulated
devices, such as the E1000 network driver and emulated SCSI disk
controller. * `PARAVIRTUALIZED` - VM instances launch with paravirtualized
devices using VirtIO drivers. * `CUSTOM` - VM instances launch
with custom configuration settings specified in the `LaunchOptions`
parameter.'
returned: on success
sample: NATIVE
type: str
launch_options:
contains:
boot_volume_type:
description:
- Emulation type for the boot volume. * `ISCSI` - ISCSI attached
block storage device. * `SCSI` - Emulated SCSI disk. * `IDE`
- Emulated IDE disk. * `VFIO` - Direct attached Virtual Function
storage. This is the default option for local data volumes
on platform images. * `PARAVIRTUALIZED` - Paravirtualized
disk. This is the default for boot volumes and remote block
storage volumes on platform images.
returned: on success
sample: ISCSI
type: str
firmware:
description:
- Firmware used to boot VM. Select the option that matches your
operating system. * `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. * `UEFI_64` - Boot
VM using UEFI style firmware compatible with 64 bit operating
systems. This is the default for platform images.
returned: on success
sample: BIOS
type: str
is_consistent_volume_naming_enabled:
description:
- Whether to enable consistent volume naming feature. Defaults
to false.
returned: on success
sample: true
type: bool
is_pv_encryption_in_transit_enabled:
description:
- Deprecated. Instead use `isPvEncryptionInTransitEnabled` in
L(InstanceConfigurationLaunchInstanceDetails,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails).
returned: on success
sample: true
type: bool
network_type:
description:
- Emulation type for the physical network interface card (NIC).
* `E1000` - Emulated Gigabit ethernet controller. Compatible
with Linux e1000 network driver. * `VFIO` - Direct attached
Virtual Function network controller. This is the networking
type when you launch an instance using hardware-assisted (SR-IOV)
networking. * `PARAVIRTUALIZED` - VM instances launch with
paravirtualized devices using VirtIO drivers.
returned: on success
sample: E1000
type: str
remote_data_volume_type:
description:
- Emulation type for volume. * `ISCSI` - ISCSI attached block
storage device. * `SCSI` - Emulated SCSI disk. * `IDE` - Emulated
IDE disk. * `VFIO` - Direct attached Virtual Function storage.
This is the default option for local data volumes on platform
images. * `PARAVIRTUALIZED` - Paravirtualized disk. This is
the default for boot volumes and remote block storage volumes
on platform images.
returned: on success
sample: ISCSI
type: str
description:
- ''
returned: on success
type: complex
metadata:
description:
- Custom metadata key/value pairs that you provide, such as the
SSH public key required to connect to the instance.
- '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:'
- '* Provide information to L(Cloud-Init,https://cloudinit.readthedocs.org/en/latest/)
to be used for various system initialization tasks.'
- '* Get information about the instance, including the custom metadata
that you provide when you launch the instance.'
- '**Providing Cloud-Init Metadata**'
- 'You can use the following metadata key names to provide information
to Cloud-Init:'
- '**"ssh_authorized_keys"** - Provide one or more public SSH keys
to be included in the `~/.ssh/authorized_keys` file for the default
user on the instance. Use a newline character to separate multiple
keys. The SSH keys must be in the format necessary for the `authorized_keys`
file, as shown in the example below.'
- '**"user_data"** - Provide your own base64-encoded data to be
used by Cloud-Init to run custom scripts or provide custom Cloud-Init
configuration. For information about how to take advantage of
user data, see the L(Cloud-Init Documentation,http://cloudinit.readthedocs.org/en/latest/topics/format.html).'
- '**Metadata Example**'
- ' "metadata" : { "quake_bot_level" : "Severe", "ssh_authorized_keys"
: "ssh-rsa <your_public_SSH_key>== rsa-key-20160227", "user_data"
: "<your_public_SSH_key>==" } **Getting Metadata on the Instance**'
- 'To get information about your instance, connect to the instance
using SSH and issue any of the following GET requests:'
- ' curl -H "Authorization: Bearer Oracle" http://169.254.169.254/opc/v2/instance/
curl -H "Authorization: Bearer Oracle" http://169.254.169.254/opc/v2/instance/metadata/
curl -H "Authorization: Bearer Oracle" http://169.254.169.254/opc/v2/instance/metadata/<any-key-name>'
- You'll get back a response that includes all the instance information;
only the metadata information; or the metadata information for
the specified key name, respectively.
- The combined size of the `metadata` and `extendedMetadata` objects
can be a maximum of 32,000 bytes.
returned: on success
sample: {}
type: dict
platform_config:
contains:
are_virtual_instructions_enabled:
description:
- Whether virtualization instructions are available. For example,
Secure Virtual Machine for AMD shapes or VT-x for Intel shapes.
returned: on success
sample: true
type: bool
is_access_control_service_enabled:
description:
- Whether the Access Control Service is enabled on the instance.
When enabled, the platform can enforce PCIe device isolation,
required for VFIO device pass-through.
returned: on success
sample: true
type: bool
is_input_output_memory_management_unit_enabled:
description:
- Whether the input-output memory management unit is enabled.
returned: on success
sample: true
type: bool
is_measured_boot_enabled:
description:
- Whether the Measured Boot feature is enabled on the instance.
returned: on success
sample: true
type: bool
is_memory_encryption_enabled:
description:
- Whether the instance is a confidential instance. If this value
is `true`, the instance is a confidential instance. The default
value is `false`.
returned: on success
sample: true
type: bool
is_secure_boot_enabled:
description:
- Whether Secure Boot is enabled on the instance.
returned: on success
sample: true
type: bool
is_symmetric_multi_threading_enabled:
description:
- Whether symmetric multithreading is enabled on the instance.
Symmetric multithreading is also called simultaneous multithreading
(SMT) or Intel Hyper-Threading.
- Intel and AMD processors have two hardware execution threads
per core (OCPU). SMT permits multiple independent threads
of execution, to better use the resources and increase the
efficiency of the CPU. When multithreading is disabled, only
one thread is permitted to run on each core, which can provide
higher or more predictable performance for some workloads.
returned: on success
sample: true
type: bool
is_trusted_platform_module_enabled:
description:
- Whether the Trusted Platform Module (TPM) is enabled on the
instance.
returned: on success
sample: true
type: bool
numa_nodes_per_socket:
description:
- The number of NUMA nodes per socket (NPS).
returned: on success
sample: NPS0
type: str
percentage_of_cores_enabled:
description:
- The percentage of cores enabled. Value must be a multiple
of 25%. If the requested percentage results in a fractional
number of cores, the system rounds up the number of cores
across processors and provisions an instance with a whole
number of cores.
- If the applications that you run on the instance use a core-based
licensing model and need fewer cores than the full size of
the shape, you can disable cores to reduce your licensing
costs. The instance itself is billed for the full shape, regardless
of whether all cores are enabled.
returned: on success
sample: 56
type: int
type:
description:
- The type of platform being configured.
returned: on success
sample: AMD_MILAN_BM
type: str
description:
- ''
returned: on success
type: complex
preemptible_instance_config:
contains:
preemption_action:
contains:
preserve_boot_volume:
description:
- Whether to preserve the boot volume that was used to launch
the preemptible instance when the instance is terminated.
Defaults to false if not specified.
returned: on success
sample: true
type: bool
type:
description:
- The type of action to run when the instance is interrupted
for eviction.
returned: on success
sample: TERMINATE
type: str
description:
- ''
returned: on success
type: complex
description:
- ''
returned: on success
type: complex
preferred_maintenance_action:
description:
- The preferred maintenance action for an instance. The default
is LIVE_MIGRATE, if live migration is supported. * `LIVE_MIGRATE`
- Run maintenance using a live migration. * `REBOOT` - Run maintenance
using a reboot.
returned: on success
sample: LIVE_MIGRATE
type: str
shape:
description:
- The shape of an instance. The shape determines the number of CPUs,
amount of memory, and other resources allocated to the instance.
- You can enumerate all available shapes by calling L(ListShapes,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/Shape/ListShapes).
returned: on success
sample: shape_example
type: str
shape_config:
contains:
baseline_ocpu_utilization:
description:
- The baseline OCPU utilization for a subcore burstable VM instance.
Leave this attribute blank for a non-burstable instance, or
explicitly specify non-burstable with `BASELINE_1_1`.
- 'The following values are supported: - `BASELINE_1_8` - baseline
usage is 1/8 of an OCPU. - `BASELINE_1_2` - baseline usage
is 1/2 of an OCPU. - `BASELINE_1_1` - baseline usage is an
entire OCPU. This represents a non-burstable instance.'
returned: on success
sample: BASELINE_1_8
type: str
memory_in_gbs:
description:
- The total amount of memory available to the instance, in gigabytes.
returned: on success
sample: 3.4
type: float
nvmes:
description:
- The number of NVMe drives to be used for storage. A single
drive has 6.8 TB available.
returned: on success
sample: 56
type: int
ocpus:
description:
- The total number of OCPUs available to the instance.
returned: on success
sample: 3.4
type: float
vcpus:
description:
- The total number of VCPUs available to the instance. This
can be used instead of OCPUs, in which case the actual number
of OCPUs will be calculated based on this value and the actual
hardware. This must be a multiple of 2.
returned: on success
sample: 56
type: int
description:
- ''
returned: on success
type: complex
source_details:
contains:
boot_volume_id:
description:
- The OCID of the boot volume used to boot the instance.
returned: on success
sample: ocid1.bootvolume.oc1..xxxxxxEXAMPLExxxxxx
type: str
boot_volume_size_in_gbs:
description:
- The size of the boot volume in GBs. The minimum value is 50
GB and the maximum value is 32,768 GB (32 TB).
returned: on success
sample: 56
type: int
boot_volume_vpus_per_gb:
description:
- The number of volume performance units (VPUs) that will be
applied to this volume per GB, representing the Block Volume
service's elastic performance options. See L(Block Volume
Performance Levels,https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels)
for more information.
- 'Allowed values:'
- ' * `10`: Represents Balanced option.'
- ' * `20`: Represents Higher Performance option.'
- ' * `30`-`120`: Represents the Ultra High Performance option.'
- For performance autotune enabled volumes, it would be the
Default(Minimum) VPUs/GB.
returned: on success
sample: 56
type: int
image_id:
description:
- The OCID of the image used to boot the instance.
returned: on success
sample: ocid1.image.oc1..xxxxxxEXAMPLExxxxxx
type: str
instance_source_image_filter_details:
contains:
compartment_id:
description:
- The OCID of the compartment containing images to search
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
defined_tags_filter:
description:
- Filter based on these defined tags. Each key is predefined
and scoped to a namespace. For more information, see L(Resource
Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
returned: on success
sample: {}
type: dict
operating_system:
description:
- The image's operating system.
- 'Example: `Oracle Linux`'
returned: on success
sample: operating_system_example
type: str
operating_system_version:
description:
- The image's operating system version.
- 'Example: `7.2`'
returned: on success
sample: operating_system_version_example
type: str
description:
- ''
returned: on success
type: complex
kms_key_id:
description:
- The OCID of the Vault service key to assign as the master
encryption key for the boot volume.
returned: on success
sample: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
type: str
source_type:
description:
- The source type for the instance. Use `image` when specifying
the image OCID. Use `bootVolume` when specifying the boot
volume OCID.
returned: on success
sample: bootVolume
type: str
description:
- ''
returned: on success
type: complex
description:
- ''
returned: on success
type: complex
secondary_vnics:
contains:
create_vnic_details:
contains:
assign_private_dns_record:
description:
- Whether the VNIC should be assigned a private DNS record.
See the `assignPrivateDnsRecord` attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/CreateVnicDetails/)
for more information.
returned: on success
sample: true
type: bool
assign_public_ip:
description:
- Whether the VNIC should be assigned a public IP address. See
the `assignPublicIp` attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/CreateVnicDetails/)
for more information.
returned: on success
sample: true
type: bool
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and
scoped to a namespace. For more information, see L(Resource
Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's
changeable. Avoid entering confidential information.
returned: on success
sample: display_name_example
type: str
freeform_tags:
description:
- Free-form tags for this resource. Each tag is a simple key-value
pair with no predefined name, type, or namespace. For more
information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
hostname_label:
description:
- The hostname for the VNIC's primary private IP. See the `hostnameLabel`
attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more
information.
returned: on success
sample: hostname_label_example
type: str
nsg_ids:
description:
- A list of the OCIDs of the network security groups (NSGs)
to add the VNIC to. For more information about NSGs, see L(NetworkSecurityGroup,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).
returned: on success
sample: []
type: list
private_ip:
description:
- A private IP address of your choice to assign to the VNIC.
See the `privateIp` attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more
information.
returned: on success
sample: private_ip_example
type: str
skip_source_dest_check:
description:
- Whether the source/destination check is disabled on the VNIC.
See the `skipSourceDestCheck` attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more
information.
returned: on success
sample: true
type: bool
subnet_id:
description:
- The OCID of the subnet to create the VNIC in. See the `subnetId`
attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more
information.
returned: on success
sample: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- ''
returned: on success
type: complex
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's changeable.
Avoid entering confidential information.
returned: on success
sample: display_name_example
type: str
nic_index:
description:
- Which physical network interface card (NIC) the VNIC will use.
Defaults to 0. Certain bare metal instance shapes have two active
physical NICs (0 and 1). If you add a secondary VNIC to one of
these instances, you can specify which NIC the VNIC will use.
For more information, see L(Virtual Network Interface Cards (VNICs),https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).
returned: on success
sample: 56
type: int
description:
- Secondary VNIC parameters.
returned: on success
type: complex
description:
- The Compute Instance Configuration parameters.
returned: on success
type: complex
secondary_vnics:
contains:
create_vnic_details:
contains:
assign_private_dns_record:
description:
- Whether the VNIC should be assigned a private DNS record. See
the `assignPrivateDnsRecord` attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/CreateVnicDetails/)
for more information.
returned: on success
sample: true
type: bool
assign_public_ip:
description:
- Whether the VNIC should be assigned a public IP address. See the
`assignPublicIp` attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/CreateVnicDetails/)
for more information.
returned: on success
sample: true
type: bool
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped
to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's changeable.
Avoid entering confidential information.
returned: on success
sample: display_name_example
type: str
freeform_tags:
description:
- Free-form tags for this resource. Each tag is a simple key-value
pair with no predefined name, type, or namespace. For more information,
see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
hostname_label:
description:
- The hostname for the VNIC's primary private IP. See the `hostnameLabel`
attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.
returned: on success
sample: hostname_label_example
type: str
nsg_ids:
description:
- A list of the OCIDs of the network security groups (NSGs) to add
the VNIC to. For more information about NSGs, see L(NetworkSecurityGroup,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).
returned: on success
sample: []
type: list
private_ip:
description:
- A private IP address of your choice to assign to the VNIC. See
the `privateIp` attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.
returned: on success
sample: private_ip_example
type: str
skip_source_dest_check:
description:
- Whether the source/destination check is disabled on the VNIC.
See the `skipSourceDestCheck` attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.
returned: on success
sample: true
type: bool
subnet_id:
description:
- The OCID of the subnet to create the VNIC in. See the `subnetId`
attribute of L(CreateVnicDetails,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.
returned: on success
sample: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- ''
returned: on success
type: complex
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's changeable.
Avoid entering confidential information.
returned: on success
sample: display_name_example
type: str
nic_index:
description:
- Which physical network interface card (NIC) the VNIC will use. Defaults
to 0. Certain bare metal instance shapes have two active physical
NICs (0 and 1). If you add a secondary VNIC to one of these instances,
you can specify which NIC the VNIC will use. For more information,
see L(Virtual Network Interface Cards (VNICs),https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).
returned: on success
sample: 56
type: int
description:
- Secondary VNIC parameters.
returned: on success
type: complex
description:
- ''
- Returned for get operation
returned: on success
type: complex
time_created:
description:
- The date and time the instance configuration was created, in the format defined
by L(RFC3339,https://tools.ietf.org/html/rfc3339).
- 'Example: `2016-08-25T21:10:29.600Z`'
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- List of InstanceConfiguration resources
returned: on success
sample:
- compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
deferred_fields: []
defined_tags:
Operations:
CostCenter: US
display_name: display_name_example
freeform_tags:
Department: Finance
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
instance_details:
block_volumes:
- attach_details:
device: device_example
display_name: display_name_example
is_pv_encryption_in_transit_enabled: true
is_read_only: true
is_shareable: true
type: iscsi
use_chap: true
create_details:
autotune_policies:
- autotune_type: DETACHED_VOLUME
max_vpus_per_gb: 56
availability_domain: Uocm:PHX-AD-1
backup_policy_id: ocid1.backuppolicy.oc1..xxxxxxEXAMPLExxxxxx
block_volume_replicas:
- availability_domain: Uocm:PHX-AD-1
display_name: display_name_example
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
defined_tags:
Operations:
CostCenter: US
display_name: display_name_example
freeform_tags:
Department: Finance
is_auto_tune_enabled: true
kms_key_id: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
size_in_gbs: 56
source_details:
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: volume
vpus_per_gb: 56
volume_id: ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx
instance_type: compute
launch_details:
agent_config:
are_all_plugins_disabled: true
is_management_disabled: true
is_monitoring_disabled: true
plugins_config:
- desired_state: ENABLED
name: name_example
availability_config:
is_live_migration_preferred: true
recovery_action: RESTORE_INSTANCE
availability_domain: Uocm:PHX-AD-1
capacity_reservation_id: ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
create_vnic_details:
assign_private_dns_record: true
assign_public_ip: true
defined_tags:
Operations:
CostCenter: US
display_name: display_name_example
freeform_tags:
Department: Finance
hostname_label: hostname_label_example
nsg_ids: []
private_ip: private_ip_example
skip_source_dest_check: true
subnet_id: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
dedicated_vm_host_id: ocid1.dedicatedvmhost.oc1..xxxxxxEXAMPLExxxxxx
defined_tags:
Operations:
CostCenter: US
display_name: display_name_example
extended_metadata: {}
fault_domain: FAULT-DOMAIN-1
freeform_tags:
Department: Finance
instance_options:
are_legacy_imds_endpoints_disabled: true
ipxe_script: ipxe_script_example
is_pv_encryption_in_transit_enabled: true
launch_mode: NATIVE
launch_options:
boot_volume_type: ISCSI
firmware: BIOS
is_consistent_volume_naming_enabled: true
is_pv_encryption_in_transit_enabled: true
network_type: E1000
remote_data_volume_type: ISCSI
metadata: {}
platform_config:
are_virtual_instructions_enabled: true
is_access_control_service_enabled: true
is_input_output_memory_management_unit_enabled: true
is_measured_boot_enabled: true
is_memory_encryption_enabled: true
is_secure_boot_enabled: true
is_symmetric_multi_threading_enabled: true
is_trusted_platform_module_enabled: true
numa_nodes_per_socket: NPS0
percentage_of_cores_enabled: 56
type: AMD_MILAN_BM
preemptible_instance_config:
preemption_action:
preserve_boot_volume: true
type: TERMINATE
preferred_maintenance_action: LIVE_MIGRATE
shape: shape_example
shape_config:
baseline_ocpu_utilization: BASELINE_1_8
memory_in_gbs: 3.4
nvmes: 56
ocpus: 3.4
vcpus: 56
source_details:
boot_volume_id: ocid1.bootvolume.oc1..xxxxxxEXAMPLExxxxxx
boot_volume_size_in_gbs: 56
boot_volume_vpus_per_gb: 56
image_id: ocid1.image.oc1..xxxxxxEXAMPLExxxxxx
instance_source_image_filter_details:
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
defined_tags_filter: {}
operating_system: operating_system_example
operating_system_version: operating_system_version_example
kms_key_id: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
source_type: bootVolume
options:
- block_volumes:
- attach_details:
device: device_example
display_name: display_name_example
is_pv_encryption_in_transit_enabled: true
is_read_only: true
is_shareable: true
type: iscsi
use_chap: true
create_details:
autotune_policies:
- autotune_type: DETACHED_VOLUME
max_vpus_per_gb: 56
availability_domain: Uocm:PHX-AD-1
backup_policy_id: ocid1.backuppolicy.oc1..xxxxxxEXAMPLExxxxxx
block_volume_replicas:
- availability_domain: Uocm:PHX-AD-1
display_name: display_name_example
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
defined_tags:
Operations:
CostCenter: US
display_name: display_name_example
freeform_tags:
Department: Finance
is_auto_tune_enabled: true
kms_key_id: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
size_in_gbs: 56
source_details:
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: volume
vpus_per_gb: 56
volume_id: ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx
instance_type: instance_type_example
launch_details:
agent_config:
are_all_plugins_disabled: true
is_management_disabled: true
is_monitoring_disabled: true
plugins_config:
- desired_state: ENABLED
name: name_example
availability_config:
is_live_migration_preferred: true
recovery_action: RESTORE_INSTANCE
availability_domain: Uocm:PHX-AD-1
capacity_reservation_id: ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
create_vnic_details:
assign_private_dns_record: true
assign_public_ip: true
defined_tags:
Operations:
CostCenter: US
display_name: display_name_example
freeform_tags:
Department: Finance
hostname_label: hostname_label_example
nsg_ids: []
private_ip: private_ip_example
skip_source_dest_check: true
subnet_id: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
dedicated_vm_host_id: ocid1.dedicatedvmhost.oc1..xxxxxxEXAMPLExxxxxx
defined_tags:
Operations:
CostCenter: US
display_name: display_name_example
extended_metadata: {}
fault_domain: FAULT-DOMAIN-1
freeform_tags:
Department: Finance
instance_options:
are_legacy_imds_endpoints_disabled: true
ipxe_script: ipxe_script_example
is_pv_encryption_in_transit_enabled: true
launch_mode: NATIVE
launch_options:
boot_volume_type: ISCSI
firmware: BIOS
is_consistent_volume_naming_enabled: true
is_pv_encryption_in_transit_enabled: true
network_type: E1000
remote_data_volume_type: ISCSI
metadata: {}
platform_config:
are_virtual_instructions_enabled: true
is_access_control_service_enabled: true
is_input_output_memory_management_unit_enabled: true
is_measured_boot_enabled: true
is_memory_encryption_enabled: true
is_secure_boot_enabled: true
is_symmetric_multi_threading_enabled: true
is_trusted_platform_module_enabled: true
numa_nodes_per_socket: NPS0
percentage_of_cores_enabled: 56
type: AMD_MILAN_BM
preemptible_instance_config:
preemption_action:
preserve_boot_volume: true
type: TERMINATE
preferred_maintenance_action: LIVE_MIGRATE
shape: shape_example
shape_config:
baseline_ocpu_utilization: BASELINE_1_8
memory_in_gbs: 3.4
nvmes: 56
ocpus: 3.4
vcpus: 56
source_details:
boot_volume_id: ocid1.bootvolume.oc1..xxxxxxEXAMPLExxxxxx
boot_volume_size_in_gbs: 56
boot_volume_vpus_per_gb: 56
image_id: ocid1.image.oc1..xxxxxxEXAMPLExxxxxx
instance_source_image_filter_details:
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
defined_tags_filter: {}
operating_system: operating_system_example
operating_system_version: operating_system_version_example
kms_key_id: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
source_type: bootVolume
secondary_vnics:
- create_vnic_details:
assign_private_dns_record: true
assign_public_ip: true
defined_tags:
Operations:
CostCenter: US
display_name: display_name_example
freeform_tags:
Department: Finance
hostname_label: hostname_label_example
nsg_ids: []
private_ip: private_ip_example
skip_source_dest_check: true
subnet_id: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
display_name: display_name_example
nic_index: 56
secondary_vnics:
- create_vnic_details:
assign_private_dns_record: true
assign_public_ip: true
defined_tags:
Operations:
CostCenter: US
display_name: display_name_example
freeform_tags:
Department: Finance
hostname_label: hostname_label_example
nsg_ids: []
private_ip: private_ip_example
skip_source_dest_check: true
subnet_id: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
display_name: display_name_example
nic_index: 56
time_created: '2013-10-20T19:20:30+01:00'
type: complex