oracle.oci.oci_cloud_migrations_target_asset_facts – Fetches details about one or multiple TargetAsset resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.1.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install oracle.oci
.
To use it in a playbook, specify: oracle.oci.oci_cloud_migrations_target_asset_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple TargetAsset resources in Oracle Cloud Infrastructure
Returns a list of target assets.
If target_asset_id is specified, the details of a single TargetAsset will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
api_user
string
|
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
config_file_location ). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|
api_user_fingerprint
string
|
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
config_file_location ). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|
api_user_key_file
string
|
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
config_file_location ). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided. |
|
api_user_key_pass_phrase
string
|
Passphrase used by the key referenced in
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 config_file_location ). |
|
auth_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
auth_type
string
|
|
The type of authentication to use for making API requests. By default
auth_type="api_key" based authentication is performed and the API key (see 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 auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance. |
cert_bundle
string
|
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.
|
|
config_file_location
string
|
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.
|
|
config_profile_name
string
|
The profile to load from the config file referenced by
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 config_file_location . |
|
display_name
string
|
A filter to return only resources that match the entire given display name.
aliases: name |
|
lifecycle_state
string
|
|
The current state of the target asset.
|
migration_plan_id
string
|
Unique migration plan identifier
|
|
realm_specific_endpoint_template_enabled
boolean
|
|
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.
|
region
string
|
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
config_file_location ). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions. |
|
sort_by
string
|
|
The field to sort by. Only one sort order can be provided. The default order for 'timeCreated' is descending. The default order for 'displayName' is ascending.
|
sort_order
string
|
|
The sort order to use, either 'ASC' or 'DESC'.
|
target_asset_id
string
|
Unique target asset identifier
Required to get a specific target_asset.
aliases: id |
|
tenancy
string
|
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
config_file_location ). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific target_asset
oci_cloud_migrations_target_asset_facts:
# required
target_asset_id: "ocid1.targetasset.oc1..xxxxxxEXAMPLExxxxxx"
- name: List target_assets
oci_cloud_migrations_target_asset_facts:
# optional
migration_plan_id: "ocid1.migrationplan.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
target_asset_id: "ocid1.targetasset.oc1..xxxxxxEXAMPLExxxxxx"
lifecycle_state: CREATING
sort_order: ASC
sort_by: timeCreated
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||||
---|---|---|---|---|---|---|
target_assets
complex
|
on success |
List of TargetAsset resources
Sample:
[{'block_volumes_performance': 56, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'compatibility_messages': [{'message': 'message_example', 'name': 'NOT_ENOUGH_DATA', 'severity': 'ERROR'}], 'created_resource_id': 'ocid1.createdresource.oc1..xxxxxxEXAMPLExxxxxx', 'display_name': 'display_name_example', 'estimated_cost': {'compute': {'gpu_count': 10, 'gpu_per_hour': 10, 'gpu_per_hour_by_subscription': 10, 'memory_amount_gb': 10, 'memory_gb_per_hour': 10, 'memory_gb_per_hour_by_subscription': 10, 'ocpu_count': 10, 'ocpu_per_hour': 10, 'ocpu_per_hour_by_subscription': 10, 'total_per_hour': 10, 'total_per_hour_by_subscription': 10}, 'currency_code': 'currency_code_example', 'os_image': {'total_per_hour': 10, 'total_per_hour_by_subscription': 10}, 'storage': {'total_gb_per_month': 10, 'total_gb_per_month_by_subscription': 10, 'volumes': [{'capacity_gb': 10, 'description': 'description_example', 'total_gb_per_month': 10, 'total_gb_per_month_by_subscription': 10}]}, 'subscription_id': 'ocid1.subscription.oc1..xxxxxxEXAMPLExxxxxx', 'total_estimation_per_month': 10, 'total_estimation_per_month_by_subscription': 10}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_excluded_from_execution': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'migration_asset': {'availability_domain': 'Uocm:PHX-AD-1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'depended_on_by': [], 'depends_on': [], 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'migration_id': 'ocid1.migration.oc1..xxxxxxEXAMPLExxxxxx', 'notifications': [], 'parent_snapshot': 'parent_snapshot_example', 'replication_compartment_id': 'ocid1.replicationcompartment.oc1..xxxxxxEXAMPLExxxxxx', 'replication_schedule_id': 'ocid1.replicationschedule.oc1..xxxxxxEXAMPLExxxxxx', 'snap_shot_bucket_name': 'snap_shot_bucket_name_example', 'snapshot_info': 'snapshot_info_example', 'snapshots': {'unmodified_volume_id': 'ocid1.unmodifiedvolume.oc1..xxxxxxEXAMPLExxxxxx', 'uuid': 'uuid_example', 'volume_id': 'ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx', 'volume_type': 'BOOT'}, 'source_asset_data': {}, 'source_asset_id': 'ocid1.sourceasset.oc1..xxxxxxEXAMPLExxxxxx', 'tenancy_id': 'ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type': 'type_example'}, 'migration_plan_id': 'ocid1.migrationplan.oc1..xxxxxxEXAMPLExxxxxx', 'ms_license': 'ms_license_example', 'preferred_shape_type': 'VM', 'recommended_spec': {'agent_config': {'are_all_plugins_disabled': True, 'is_management_disabled': True, 'is_monitoring_disabled': True, 'plugins_config': [{'desired_state': 'ENABLED', 'name': 'name_example'}]}, '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', 'vlan_id': 'ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx'}, 'dedicated_vm_host_id': 'ocid1.dedicatedvmhost.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'fault_domain': 'FAULT-DOMAIN-1', 'freeform_tags': {'Department': 'Finance'}, 'hostname_label': 'hostname_label_example', 'instance_options': {'are_legacy_imds_endpoints_disabled': True}, 'ipxe_script': 'ipxe_script_example', 'is_pv_encryption_in_transit_enabled': True, 'preemptible_instance_config': {'preemption_action': {'preserve_boot_volume': True, 'type': 'TERMINATE'}}, 'shape': 'shape_example', 'shape_config': {'baseline_ocpu_utilization': 'BASELINE_1_8', 'memory_in_gbs': 3.4, 'ocpus': 3.4}, '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', 'kms_key_id': 'ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx', 'source_type': 'bootVolume'}}, 'test_spec': {'agent_config': {'are_all_plugins_disabled': True, 'is_management_disabled': True, 'is_monitoring_disabled': True, 'plugins_config': [{'desired_state': 'ENABLED', 'name': 'name_example'}]}, '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', 'vlan_id': 'ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx'}, 'dedicated_vm_host_id': 'ocid1.dedicatedvmhost.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'fault_domain': 'FAULT-DOMAIN-1', 'freeform_tags': {'Department': 'Finance'}, 'hostname_label': 'hostname_label_example', 'instance_options': {'are_legacy_imds_endpoints_disabled': True}, 'ipxe_script': 'ipxe_script_example', 'is_pv_encryption_in_transit_enabled': True, 'preemptible_instance_config': {'preemption_action': {'preserve_boot_volume': True, 'type': 'TERMINATE'}}, 'shape': 'shape_example', 'shape_config': {'baseline_ocpu_utilization': 'BASELINE_1_8', 'memory_in_gbs': 3.4, 'ocpus': 3.4}, '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', 'kms_key_id': 'ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx', 'source_type': 'bootVolume'}}, 'time_assessed': '2013-10-20T19:20:30+01:00', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type': 'INSTANCE', 'user_spec': {'agent_config': {'are_all_plugins_disabled': True, 'is_management_disabled': True, 'is_monitoring_disabled': True, 'plugins_config': [{'desired_state': 'ENABLED', 'name': 'name_example'}]}, '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', 'vlan_id': 'ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx'}, 'dedicated_vm_host_id': 'ocid1.dedicatedvmhost.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'fault_domain': 'FAULT-DOMAIN-1', 'freeform_tags': {'Department': 'Finance'}, 'hostname_label': 'hostname_label_example', 'instance_options': {'are_legacy_imds_endpoints_disabled': True}, 'ipxe_script': 'ipxe_script_example', 'is_pv_encryption_in_transit_enabled': True, 'preemptible_instance_config': {'preemption_action': {'preserve_boot_volume': True, 'type': 'TERMINATE'}}, 'shape': 'shape_example', 'shape_config': {'baseline_ocpu_utilization': 'BASELINE_1_8', 'memory_in_gbs': 3.4, 'ocpus': 3.4}, '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', 'kms_key_id': 'ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx', 'source_type': 'bootVolume'}}}]
|
||||
block_volumes_performance
integer
|
on success |
Performance of the block volumes.
Returned for get operation
Sample:
56
|
||||
compartment_id
string
|
on success |
Compartment identifier
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||||
compatibility_messages
complex
|
on success |
Messages about the compatibility issues.
|
||||
message
string
|
on success |
Detailed description of the compatibility issue.
Sample:
message_example
|
||||
name
string
|
on success |
Name of the compatibility issue.
Sample:
NOT_ENOUGH_DATA
|
||||
severity
string
|
on success |
Severity level of the compatibility issue.
Sample:
ERROR
|
||||
created_resource_id
string
|
on success |
Created resource identifier
Sample:
ocid1.createdresource.oc1..xxxxxxEXAMPLExxxxxx
|
||||
display_name
string
|
on success |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Sample:
display_name_example
|
||||
estimated_cost
complex
|
on success |
|
||||
compute
complex
|
on success |
|
||||
gpu_count
float
|
on success |
Total number of GPU
Sample:
10
|
||||
gpu_per_hour
float
|
on success |
GPU per hour
Sample:
10
|
||||
gpu_per_hour_by_subscription
float
|
on success |
GPU per hour by subscription
Sample:
10
|
||||
memory_amount_gb
float
|
on success |
Total usage of memory
Sample:
10
|
||||
memory_gb_per_hour
float
|
on success |
Gigabyte per hour
Sample:
10
|
||||
memory_gb_per_hour_by_subscription
float
|
on success |
Gigabyte per hour by subscription
Sample:
10
|
||||
ocpu_count
float
|
on success |
Total number of OCPUs
Sample:
10
|
||||
ocpu_per_hour
float
|
on success |
OCPU per hour
Sample:
10
|
||||
ocpu_per_hour_by_subscription
float
|
on success |
OCPU per hour by subscription
Sample:
10
|
||||
total_per_hour
float
|
on success |
Total per hour
Sample:
10
|
||||
total_per_hour_by_subscription
float
|
on success |
Total usage per hour by subscription
Sample:
10
|
||||
currency_code
string
|
on success |
Currency code in the ISO format.
Sample:
currency_code_example
|
||||
os_image
complex
|
on success |
|
||||
total_per_hour
float
|
on success |
Total price per hour
Sample:
10
|
||||
total_per_hour_by_subscription
float
|
on success |
Total price per hour by subscription
Sample:
10
|
||||
storage
complex
|
on success |
|
||||
total_gb_per_month
float
|
on success |
Gigabyte storage capacity per month.
Sample:
10
|
||||
total_gb_per_month_by_subscription
float
|
on success |
Gigabyte storage capacity per month by subscription.
Sample:
10
|
||||
volumes
complex
|
on success |
Volume estimation
|
||||
capacity_gb
float
|
on success |
Gigabyte storage capacity
Sample:
10
|
||||
description
string
|
on success |
Volume description
Sample:
description_example
|
||||
total_gb_per_month
float
|
on success |
Gigabyte storage capacity per month.
Sample:
10
|
||||
total_gb_per_month_by_subscription
float
|
on success |
Gigabyte storage capacity per month by subscription
Sample:
10
|
||||
subscription_id
string
|
on success |
Subscription ID
Sample:
ocid1.subscription.oc1..xxxxxxEXAMPLExxxxxx
|
||||
total_estimation_per_month
float
|
on success |
Total estimation per month
Sample:
10
|
||||
total_estimation_per_month_by_subscription
float
|
on success |
Total estimation per month by subscription.
Sample:
10
|
||||
id
string
|
on success |
Unique identifier that is immutable on creation.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||||
is_excluded_from_execution
boolean
|
on success |
A boolean indicating whether the asset should be migrated.
Sample:
True
|
||||
lifecycle_details
string
|
on success |
A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
Sample:
lifecycle_details_example
|
||||
lifecycle_state
string
|
on success |
The current state of the target asset.
Sample:
CREATING
|
||||
migration_asset
complex
|
on success |
|
||||
availability_domain
string
|
on success |
Availability domain
Sample:
Uocm:PHX-AD-1
|
||||
compartment_id
string
|
on success |
Compartment Identifier
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||||
depended_on_by
list
/ elements=string
|
on success |
List of migration assets that depend on the asset.
|
||||
depends_on
list
/ elements=string
|
on success |
List of migration assets that depends on the asset.
|
||||
display_name
string
|
on success |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Sample:
display_name_example
|
||||
id
string
|
on success |
Asset ID generated by mirgration service. It is used in the mirgration service pipeline.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||||
lifecycle_details
string
|
on success |
A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
Sample:
lifecycle_details_example
|
||||
lifecycle_state
string
|
on success |
The current state of the migration asset.
Sample:
CREATING
|
||||
migration_id
string
|
on success |
OCID of the associated migration.
Sample:
ocid1.migration.oc1..xxxxxxEXAMPLExxxxxx
|
||||
notifications
list
/ elements=string
|
on success |
List of notifications
|
||||
parent_snapshot
string
|
on success |
The parent snapshot of the migration asset to be used by the replication task.
Sample:
parent_snapshot_example
|
||||
replication_compartment_id
string
|
on success |
Replication compartment identifier
Sample:
ocid1.replicationcompartment.oc1..xxxxxxEXAMPLExxxxxx
|
||||
replication_schedule_id
string
|
on success |
Replication schedule identifier
Sample:
ocid1.replicationschedule.oc1..xxxxxxEXAMPLExxxxxx
|
||||
snap_shot_bucket_name
string
|
on success |
Name of snapshot bucket
Sample:
snap_shot_bucket_name_example
|
||||
snapshot_info
string
|
on success |
The snapshot information.
Sample:
snapshot_info_example
|
||||
snapshots
complex
|
on success |
Key-value pair representing disks ID mapped to the OCIDs of replicated or hydration server volume snapshots. Example: `{"bar-key": "value"}`
|
||||
unmodified_volume_id
string
|
on success |
ID of the unmodified volume
Sample:
ocid1.unmodifiedvolume.oc1..xxxxxxEXAMPLExxxxxx
|
||||
uuid
string
|
on success |
ID of the vCenter disk obtained from Inventory.
Sample:
uuid_example
|
||||
volume_id
string
|
on success |
ID of the hydration server volume
Sample:
ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx
|
||||
volume_type
string
|
on success |
The hydration server volume type
Sample:
BOOT
|
||||
source_asset_data
dictionary
|
on success |
Key-value pair representing asset metadata keys and values scoped to a namespace. Example: `{"bar-key": "value"}`
|
||||
source_asset_id
string
|
on success |
OCID that is referenced to an asset for an inventory.
Sample:
ocid1.sourceasset.oc1..xxxxxxEXAMPLExxxxxx
|
||||
tenancy_id
string
|
on success |
Tenancy identifier
Sample:
ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx
|
||||
time_created
string
|
on success |
The time when the migration asset was created. An RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
||||
time_updated
string
|
on success |
The time when the migration asset was updated. An RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
||||
type
string
|
on success |
The type of asset referenced for inventory.
Sample:
type_example
|
||||
migration_plan_id
string
|
on success |
OCID of the associated migration plan.
Sample:
ocid1.migrationplan.oc1..xxxxxxEXAMPLExxxxxx
|
||||
ms_license
string
|
on success |
Microsoft license for VM configuration.
Returned for get operation
Sample:
ms_license_example
|
||||
preferred_shape_type
string
|
on success |
Preferred VM shape type that you provide.
Returned for get operation
Sample:
VM
|
||||
recommended_spec
complex
|
on success |
Returned for get operation
|
||||
agent_config
complex
|
on success |
|
||||
are_all_plugins_disabled
boolean
|
on success |
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 ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.
Sample:
True
|
||||
is_management_disabled
boolean
|
on success |
Whether Oracle Cloud Agent can run all the available management plugins. By default, the 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 the per-plugin configuration in the `pluginsConfig` object.
- If `isManagementDisabled` is true, all the management plugins are disabled, regardless of the per-plugin configuration. - If `isManagementDisabled` is false, all the management plugins are enabled. You can optionally disable individual management plugins by providing a value in the `pluginsConfig` object.
Sample:
True
|
||||
is_monitoring_disabled
boolean
|
on success |
Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. By default, the 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 the monitoring plugins are disabled, regardless of the per-plugin configuration. - If `isMonitoringDisabled` is false, all the monitoring plugins are enabled. You can optionally disable individual monitoring plugins by providing a value in the `pluginsConfig` object.
Sample:
True
|
||||
plugins_config
complex
|
on success |
The configuration of plugins associated with this instance.
|
||||
desired_state
string
|
on success |
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.
Sample:
ENABLED
|
||||
name
string
|
on success |
The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.
Sample:
name_example
|
||||
availability_domain
string
|
on success |
The availability domain of the instance.
Example: `Uocm:PHX-AD-1`
Sample:
Uocm:PHX-AD-1
|
||||
capacity_reservation_id
string
|
on success |
The OCID of the compute capacity reservation under which this instance is launched. You can opt out of all default reservations by specifying an empty string as input for this field. For more information, see Capacity Reservations.
Sample:
ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx
|
||||
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||||
create_vnic_details
complex
|
on success |
|
||||
assign_private_dns_record
boolean
|
on success |
Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. By default, the value is true.
If you specify a `hostnameLabel`, then `assignPrivateDnsRecord` must be set to true.
Sample:
True
|
||||
assign_public_ip
boolean
|
on success |
Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the Subnet), then no public IP address is assigned. If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then a public IP address is assigned. If set to true and `prohibitPublicIpOnVnic` = true, an error is returned.
**Note:** This public IP address is associated with the primary private IP on the VNIC. For more information, see IP Addresses.
**Note:** There's a limit to the number of public IPs a VNIC or instance can have. If you try to create a secondary VNIC with an assigned public IP for an instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see Public IP Addresses.
Example: `false`
If you specify a `vlanId`, then `assignPublicIp` must be set to false. See Vlan.
Sample:
True
|
||||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||||
display_name
string
|
on success |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Sample:
display_name_example
|
||||
freeform_tags
dictionary
|
on success |
Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
||||
hostname_label
string
|
on success |
The hostname for the VNIC's primary private IP. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, `bminstance-1` in FQDN `bminstance-1.subnet123.vcn1.oraclevcn.com`). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.
For more information, see DNS in Your Virtual Cloud Network.
When launching an instance, use this `hostnameLabel` instead of the deprecated `hostnameLabel` in LaunchInstanceDetails. If you provide both, the values must match.
Example: `bminstance-1`
If you specify a `vlanId`, the `hostnameLabel` cannot be specified. VNICs on a VLAN can not be assigned a hostname. See Vlan.
Sample:
hostname_label_example
|
||||
nsg_ids
list
/ elements=string
|
on success |
List of OCIDs of the network security groups (NSGs) that are added to the VNIC. For more information about NSGs, see NetworkSecurityGroup.
If a `vlanId` is specified, the `nsgIds` cannot be specified. The `vlanId` indicates that the VNIC will belong to a VLAN instead of a subnet. With VLANs, all VNICs in the VLAN belong to the NSGs that are associated with the VLAN. See Vlan.
|
||||
private_ip
string
|
on success |
A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's *primary* private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.
If you specify a `vlanId`, the `privateIp` cannot be specified. See Vlan.
Example: `10.0.3.3`
Sample:
private_ip_example
|
||||
skip_source_dest_check
boolean
|
on success |
Whether the source/destination check is disabled on the VNIC. Defaults to `false`, which means the check is performed. For information about why you should skip the source/destination check, see Using a Private IP as a Route Target.
If you specify a `vlanId`, the `skipSourceDestCheck` cannot be specified because the source/destination check is always disabled for VNICs in a VLAN. See Vlan.
Example: `true`
Sample:
True
|
||||
subnet_id
string
|
on success |
The OCID of the subnet to create the VNIC. When launching an instance, use this `subnetId` instead of the deprecated `subnetId` in LaunchInstanceDetails. At least one of them is required; if you provide both, the values must match.
If you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN instead of a subnet, provide a `vlanId` instead of a `subnetId`. If you provide both `vlanId` and `subnetId`, the request fails.
Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
|
||||
vlan_id
string
|
on success |
Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the OCID of the VLAN. See Vlan.
Provide a `vlanId` instead of a `subnetId`. If you provide both `vlanId` and `subnetId`, the request fails.
Sample:
ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx
|
||||
dedicated_vm_host_id
string
|
on success |
The OCID of the dedicated VM host.
Sample:
ocid1.dedicatedvmhost.oc1..xxxxxxEXAMPLExxxxxx
|
||||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||||
display_name
string
|
on success |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Sample:
display_name_example
|
||||
fault_domain
string
|
on success |
A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains lets 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 ListFaultDomains operation in the Identity and Access Management Service API.
Example: `FAULT-DOMAIN-1`
Sample:
FAULT-DOMAIN-1
|
||||
freeform_tags
dictionary
|
on success |
Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
||||
hostname_label
string
|
on success |
Deprecated. Instead use `hostnameLabel` in CreateVnicDetails. If you provide both, the values must match.
Sample:
hostname_label_example
|
||||
instance_options
complex
|
on success |
|
||||
are_legacy_imds_endpoints_disabled
boolean
|
on success |
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.
Sample:
True
|
||||
ipxe_script
string
|
on success |
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. Be aware that the same iPXE script will run every time an instance boots, not only after the initial LaunchInstance call.
By default, the 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 in the same way as the default iPXE script, use the following iSCSI IP address: 169.254.0.2, and boot volume IQN: iqn.2015-02.oracle.boot.
If your instance boot volume type is paravirtualized, the boot volume is attached to the instance through virtio-scsi and no iPXE script is used. If your instance boot volume type is paravirtualized and you use custom iPXE to perform network-boot into your instance, the primary boot volume is attached as a data volume through the virtio-scsi drive.
For more information about the Bring Your Own Image feature of Oracle Cloud Infrastructure, see Bring Your Own Image.
For more information about iPXE, see http://ipxe.org.
Sample:
ipxe_script_example
|
||||
is_pv_encryption_in_transit_enabled
boolean
|
on success |
Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. By default, the value is false.
Sample:
True
|
||||
preemptible_instance_config
complex
|
on success |
|
||||
preemption_action
complex
|
on success |
|
||||
preserve_boot_volume
boolean
|
on success |
Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. By default, it is false if not specified.
Sample:
True
|
||||
type
string
|
on success |
The type of action to run when the instance is interrupted for eviction.
Sample:
TERMINATE
|
||||
shape
string
|
on success |
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 ListShapes.
Sample:
shape_example
|
||||
shape_config
complex
|
on success |
|
||||
baseline_ocpu_utilization
string
|
on success |
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.
Sample:
BASELINE_1_8
|
||||
memory_in_gbs
float
|
on success |
The total amount of memory in gigabytes that is available to the instance.
Sample:
3.4
|
||||
ocpus
float
|
on success |
The total number of OCPUs available to the instance.
Sample:
3.4
|
||||
source_details
complex
|
on success |
|
||||
boot_volume_id
string
|
on success |
The OCID of the boot volume used to boot the instance.
Sample:
ocid1.bootvolume.oc1..xxxxxxEXAMPLExxxxxx
|
||||
boot_volume_size_in_gbs
integer
|
on success |
The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB).
Sample:
56
|
||||
boot_volume_vpus_per_gb
integer
|
on success |
The number of volume performance units (VPUs) that will be applied to this volume per GB that represents the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
Allowed values:
* `10`: Represents Balanced option.
* `20`: Represents Higher Performance option.
* `30`-`120`: Represents the Ultra High Performance option.
For volumes with the auto-tuned performance feature enabled, this is set to the default (minimum) VPUs/GB.
Sample:
56
|
||||
image_id
string
|
on success |
The OCID of the image used to boot the instance.
Sample:
ocid1.image.oc1..xxxxxxEXAMPLExxxxxx
|
||||
kms_key_id
string
|
on success |
The OCID of the key management key to assign as the master encryption key for the boot volume.
Sample:
ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
|
||||
source_type
string
|
on success |
The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID.
Sample:
bootVolume
|
||||
test_spec
complex
|
on success |
Returned for get operation
|
||||
agent_config
complex
|
on success |
|
||||
are_all_plugins_disabled
boolean
|
on success |
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 ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.
Sample:
True
|
||||
is_management_disabled
boolean
|
on success |
Whether Oracle Cloud Agent can run all the available management plugins. By default, the 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 the per-plugin configuration in the `pluginsConfig` object.
- If `isManagementDisabled` is true, all the management plugins are disabled, regardless of the per-plugin configuration. - If `isManagementDisabled` is false, all the management plugins are enabled. You can optionally disable individual management plugins by providing a value in the `pluginsConfig` object.
Sample:
True
|
||||
is_monitoring_disabled
boolean
|
on success |
Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. By default, the 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 the monitoring plugins are disabled, regardless of the per-plugin configuration. - If `isMonitoringDisabled` is false, all the monitoring plugins are enabled. You can optionally disable individual monitoring plugins by providing a value in the `pluginsConfig` object.
Sample:
True
|
||||
plugins_config
complex
|
on success |
The configuration of plugins associated with this instance.
|
||||
desired_state
string
|
on success |
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.
Sample:
ENABLED
|
||||
name
string
|
on success |
The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.
Sample:
name_example
|
||||
availability_domain
string
|
on success |
The availability domain of the instance.
Example: `Uocm:PHX-AD-1`
Sample:
Uocm:PHX-AD-1
|
||||
capacity_reservation_id
string
|
on success |
The OCID of the compute capacity reservation under which this instance is launched. You can opt out of all default reservations by specifying an empty string as input for this field. For more information, see Capacity Reservations.
Sample:
ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx
|
||||
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||||
create_vnic_details
complex
|
on success |
|
||||
assign_private_dns_record
boolean
|
on success |
Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. By default, the value is true.
If you specify a `hostnameLabel`, then `assignPrivateDnsRecord` must be set to true.
Sample:
True
|
||||
assign_public_ip
boolean
|
on success |
Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the Subnet), then no public IP address is assigned. If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then a public IP address is assigned. If set to true and `prohibitPublicIpOnVnic` = true, an error is returned.
**Note:** This public IP address is associated with the primary private IP on the VNIC. For more information, see IP Addresses.
**Note:** There's a limit to the number of public IPs a VNIC or instance can have. If you try to create a secondary VNIC with an assigned public IP for an instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see Public IP Addresses.
Example: `false`
If you specify a `vlanId`, then `assignPublicIp` must be set to false. See Vlan.
Sample:
True
|
||||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||||
display_name
string
|
on success |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Sample:
display_name_example
|
||||
freeform_tags
dictionary
|
on success |
Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
||||
hostname_label
string
|
on success |
The hostname for the VNIC's primary private IP. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, `bminstance-1` in FQDN `bminstance-1.subnet123.vcn1.oraclevcn.com`). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.
For more information, see DNS in Your Virtual Cloud Network.
When launching an instance, use this `hostnameLabel` instead of the deprecated `hostnameLabel` in LaunchInstanceDetails. If you provide both, the values must match.
Example: `bminstance-1`
If you specify a `vlanId`, the `hostnameLabel` cannot be specified. VNICs on a VLAN can not be assigned a hostname. See Vlan.
Sample:
hostname_label_example
|
||||
nsg_ids
list
/ elements=string
|
on success |
List of OCIDs of the network security groups (NSGs) that are added to the VNIC. For more information about NSGs, see NetworkSecurityGroup.
If a `vlanId` is specified, the `nsgIds` cannot be specified. The `vlanId` indicates that the VNIC will belong to a VLAN instead of a subnet. With VLANs, all VNICs in the VLAN belong to the NSGs that are associated with the VLAN. See Vlan.
|
||||
private_ip
string
|
on success |
A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's *primary* private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.
If you specify a `vlanId`, the `privateIp` cannot be specified. See Vlan.
Example: `10.0.3.3`
Sample:
private_ip_example
|
||||
skip_source_dest_check
boolean
|
on success |
Whether the source/destination check is disabled on the VNIC. Defaults to `false`, which means the check is performed. For information about why you should skip the source/destination check, see Using a Private IP as a Route Target.
If you specify a `vlanId`, the `skipSourceDestCheck` cannot be specified because the source/destination check is always disabled for VNICs in a VLAN. See Vlan.
Example: `true`
Sample:
True
|
||||
subnet_id
string
|
on success |
The OCID of the subnet to create the VNIC. When launching an instance, use this `subnetId` instead of the deprecated `subnetId` in LaunchInstanceDetails. At least one of them is required; if you provide both, the values must match.
If you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN instead of a subnet, provide a `vlanId` instead of a `subnetId`. If you provide both `vlanId` and `subnetId`, the request fails.
Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
|
||||
vlan_id
string
|
on success |
Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the OCID of the VLAN. See Vlan.
Provide a `vlanId` instead of a `subnetId`. If you provide both `vlanId` and `subnetId`, the request fails.
Sample:
ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx
|
||||
dedicated_vm_host_id
string
|
on success |
The OCID of the dedicated VM host.
Sample:
ocid1.dedicatedvmhost.oc1..xxxxxxEXAMPLExxxxxx
|
||||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||||
display_name
string
|
on success |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Sample:
display_name_example
|
||||
fault_domain
string
|
on success |
A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains lets 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 ListFaultDomains operation in the Identity and Access Management Service API.
Example: `FAULT-DOMAIN-1`
Sample:
FAULT-DOMAIN-1
|
||||
freeform_tags
dictionary
|
on success |
Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
||||
hostname_label
string
|
on success |
Deprecated. Instead use `hostnameLabel` in CreateVnicDetails. If you provide both, the values must match.
Sample:
hostname_label_example
|
||||
instance_options
complex
|
on success |
|
||||
are_legacy_imds_endpoints_disabled
boolean
|
on success |
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.
Sample:
True
|
||||
ipxe_script
string
|
on success |
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. Be aware that the same iPXE script will run every time an instance boots, not only after the initial LaunchInstance call.
By default, the 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 in the same way as the default iPXE script, use the following iSCSI IP address: 169.254.0.2, and boot volume IQN: iqn.2015-02.oracle.boot.
If your instance boot volume type is paravirtualized, the boot volume is attached to the instance through virtio-scsi and no iPXE script is used. If your instance boot volume type is paravirtualized and you use custom iPXE to perform network-boot into your instance, the primary boot volume is attached as a data volume through the virtio-scsi drive.
For more information about the Bring Your Own Image feature of Oracle Cloud Infrastructure, see Bring Your Own Image.
For more information about iPXE, see http://ipxe.org.
Sample:
ipxe_script_example
|
||||
is_pv_encryption_in_transit_enabled
boolean
|
on success |
Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. By default, the value is false.
Sample:
True
|
||||
preemptible_instance_config
complex
|
on success |
|
||||
preemption_action
complex
|
on success |
|
||||
preserve_boot_volume
boolean
|
on success |
Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. By default, it is false if not specified.
Sample:
True
|
||||
type
string
|
on success |
The type of action to run when the instance is interrupted for eviction.
Sample:
TERMINATE
|
||||
shape
string
|
on success |
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 ListShapes.
Sample:
shape_example
|
||||
shape_config
complex
|
on success |
|
||||
baseline_ocpu_utilization
string
|
on success |
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.
Sample:
BASELINE_1_8
|
||||
memory_in_gbs
float
|
on success |
The total amount of memory in gigabytes that is available to the instance.
Sample:
3.4
|
||||
ocpus
float
|
on success |
The total number of OCPUs available to the instance.
Sample:
3.4
|
||||
source_details
complex
|
on success |
|
||||
boot_volume_id
string
|
on success |
The OCID of the boot volume used to boot the instance.
Sample:
ocid1.bootvolume.oc1..xxxxxxEXAMPLExxxxxx
|
||||
boot_volume_size_in_gbs
integer
|
on success |
The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB).
Sample:
56
|
||||
boot_volume_vpus_per_gb
integer
|
on success |
The number of volume performance units (VPUs) that will be applied to this volume per GB that represents the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
Allowed values:
* `10`: Represents Balanced option.
* `20`: Represents Higher Performance option.
* `30`-`120`: Represents the Ultra High Performance option.
For volumes with the auto-tuned performance feature enabled, this is set to the default (minimum) VPUs/GB.
Sample:
56
|
||||
image_id
string
|
on success |
The OCID of the image used to boot the instance.
Sample:
ocid1.image.oc1..xxxxxxEXAMPLExxxxxx
|
||||
kms_key_id
string
|
on success |
The OCID of the key management key to assign as the master encryption key for the boot volume.
Sample:
ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
|
||||
source_type
string
|
on success |
The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID.
Sample:
bootVolume
|
||||
time_assessed
string
|
on success |
The time when the assessment was done. An RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
||||
time_created
string
|
on success |
The time when the target asset was created. An RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
||||
time_updated
string
|
on success |
The time when the target asset was updated. An RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
||||
type
string
|
on success |
The type of target asset.
Sample:
INSTANCE
|
||||
user_spec
complex
|
on success |
Returned for get operation
|
||||
agent_config
complex
|
on success |
|
||||
are_all_plugins_disabled
boolean
|
on success |
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 ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.
Sample:
True
|
||||
is_management_disabled
boolean
|
on success |
Whether Oracle Cloud Agent can run all the available management plugins. By default, the 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 the per-plugin configuration in the `pluginsConfig` object.
- If `isManagementDisabled` is true, all the management plugins are disabled, regardless of the per-plugin configuration. - If `isManagementDisabled` is false, all the management plugins are enabled. You can optionally disable individual management plugins by providing a value in the `pluginsConfig` object.
Sample:
True
|
||||
is_monitoring_disabled
boolean
|
on success |
Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. By default, the 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 the monitoring plugins are disabled, regardless of the per-plugin configuration. - If `isMonitoringDisabled` is false, all the monitoring plugins are enabled. You can optionally disable individual monitoring plugins by providing a value in the `pluginsConfig` object.
Sample:
True
|
||||
plugins_config
complex
|
on success |
The configuration of plugins associated with this instance.
|
||||
desired_state
string
|
on success |
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.
Sample:
ENABLED
|
||||
name
string
|
on success |
The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.
Sample:
name_example
|
||||
availability_domain
string
|
on success |
The availability domain of the instance.
Example: `Uocm:PHX-AD-1`
Sample:
Uocm:PHX-AD-1
|
||||
capacity_reservation_id
string
|
on success |
The OCID of the compute capacity reservation under which this instance is launched. You can opt out of all default reservations by specifying an empty string as input for this field. For more information, see Capacity Reservations.
Sample:
ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx
|
||||
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||||
create_vnic_details
complex
|
on success |
|
||||
assign_private_dns_record
boolean
|
on success |
Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. By default, the value is true.
If you specify a `hostnameLabel`, then `assignPrivateDnsRecord` must be set to true.
Sample:
True
|
||||
assign_public_ip
boolean
|
on success |
Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the Subnet), then no public IP address is assigned. If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then a public IP address is assigned. If set to true and `prohibitPublicIpOnVnic` = true, an error is returned.
**Note:** This public IP address is associated with the primary private IP on the VNIC. For more information, see IP Addresses.
**Note:** There's a limit to the number of public IPs a VNIC or instance can have. If you try to create a secondary VNIC with an assigned public IP for an instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see Public IP Addresses.
Example: `false`
If you specify a `vlanId`, then `assignPublicIp` must be set to false. See Vlan.
Sample:
True
|
||||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||||
display_name
string
|
on success |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Sample:
display_name_example
|
||||
freeform_tags
dictionary
|
on success |
Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
||||
hostname_label
string
|
on success |
The hostname for the VNIC's primary private IP. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, `bminstance-1` in FQDN `bminstance-1.subnet123.vcn1.oraclevcn.com`). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.
For more information, see DNS in Your Virtual Cloud Network.
When launching an instance, use this `hostnameLabel` instead of the deprecated `hostnameLabel` in LaunchInstanceDetails. If you provide both, the values must match.
Example: `bminstance-1`
If you specify a `vlanId`, the `hostnameLabel` cannot be specified. VNICs on a VLAN can not be assigned a hostname. See Vlan.
Sample:
hostname_label_example
|
||||
nsg_ids
list
/ elements=string
|
on success |
List of OCIDs of the network security groups (NSGs) that are added to the VNIC. For more information about NSGs, see NetworkSecurityGroup.
If a `vlanId` is specified, the `nsgIds` cannot be specified. The `vlanId` indicates that the VNIC will belong to a VLAN instead of a subnet. With VLANs, all VNICs in the VLAN belong to the NSGs that are associated with the VLAN. See Vlan.
|
||||
private_ip
string
|
on success |
A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's *primary* private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.
If you specify a `vlanId`, the `privateIp` cannot be specified. See Vlan.
Example: `10.0.3.3`
Sample:
private_ip_example
|
||||
skip_source_dest_check
boolean
|
on success |
Whether the source/destination check is disabled on the VNIC. Defaults to `false`, which means the check is performed. For information about why you should skip the source/destination check, see Using a Private IP as a Route Target.
If you specify a `vlanId`, the `skipSourceDestCheck` cannot be specified because the source/destination check is always disabled for VNICs in a VLAN. See Vlan.
Example: `true`
Sample:
True
|
||||
subnet_id
string
|
on success |
The OCID of the subnet to create the VNIC. When launching an instance, use this `subnetId` instead of the deprecated `subnetId` in LaunchInstanceDetails. At least one of them is required; if you provide both, the values must match.
If you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN instead of a subnet, provide a `vlanId` instead of a `subnetId`. If you provide both `vlanId` and `subnetId`, the request fails.
Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
|
||||
vlan_id
string
|
on success |
Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the OCID of the VLAN. See Vlan.
Provide a `vlanId` instead of a `subnetId`. If you provide both `vlanId` and `subnetId`, the request fails.
Sample:
ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx
|
||||
dedicated_vm_host_id
string
|
on success |
The OCID of the dedicated VM host.
Sample:
ocid1.dedicatedvmhost.oc1..xxxxxxEXAMPLExxxxxx
|
||||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||||
display_name
string
|
on success |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Sample:
display_name_example
|
||||
fault_domain
string
|
on success |
A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains lets 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 ListFaultDomains operation in the Identity and Access Management Service API.
Example: `FAULT-DOMAIN-1`
Sample:
FAULT-DOMAIN-1
|
||||
freeform_tags
dictionary
|
on success |
Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
||||
hostname_label
string
|
on success |
Deprecated. Instead use `hostnameLabel` in CreateVnicDetails. If you provide both, the values must match.
Sample:
hostname_label_example
|
||||
instance_options
complex
|
on success |
|
||||
are_legacy_imds_endpoints_disabled
boolean
|
on success |
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.
Sample:
True
|
||||
ipxe_script
string
|
on success |
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. Be aware that the same iPXE script will run every time an instance boots, not only after the initial LaunchInstance call.
By default, the 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 in the same way as the default iPXE script, use the following iSCSI IP address: 169.254.0.2, and boot volume IQN: iqn.2015-02.oracle.boot.
If your instance boot volume type is paravirtualized, the boot volume is attached to the instance through virtio-scsi and no iPXE script is used. If your instance boot volume type is paravirtualized and you use custom iPXE to perform network-boot into your instance, the primary boot volume is attached as a data volume through the virtio-scsi drive.
For more information about the Bring Your Own Image feature of Oracle Cloud Infrastructure, see Bring Your Own Image.
For more information about iPXE, see http://ipxe.org.
Sample:
ipxe_script_example
|
||||
is_pv_encryption_in_transit_enabled
boolean
|
on success |
Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. By default, the value is false.
Sample:
True
|
||||
preemptible_instance_config
complex
|
on success |
|
||||
preemption_action
complex
|
on success |
|
||||
preserve_boot_volume
boolean
|
on success |
Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. By default, it is false if not specified.
Sample:
True
|
||||
type
string
|
on success |
The type of action to run when the instance is interrupted for eviction.
Sample:
TERMINATE
|
||||
shape
string
|
on success |
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 ListShapes.
Sample:
shape_example
|
||||
shape_config
complex
|
on success |
|
||||
baseline_ocpu_utilization
string
|
on success |
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.
Sample:
BASELINE_1_8
|
||||
memory_in_gbs
float
|
on success |
The total amount of memory in gigabytes that is available to the instance.
Sample:
3.4
|
||||
ocpus
float
|
on success |
The total number of OCPUs available to the instance.
Sample:
3.4
|
||||
source_details
complex
|
on success |
|
||||
boot_volume_id
string
|
on success |
The OCID of the boot volume used to boot the instance.
Sample:
ocid1.bootvolume.oc1..xxxxxxEXAMPLExxxxxx
|
||||
boot_volume_size_in_gbs
integer
|
on success |
The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB).
Sample:
56
|
||||
boot_volume_vpus_per_gb
integer
|
on success |
The number of volume performance units (VPUs) that will be applied to this volume per GB that represents the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
Allowed values:
* `10`: Represents Balanced option.
* `20`: Represents Higher Performance option.
* `30`-`120`: Represents the Ultra High Performance option.
For volumes with the auto-tuned performance feature enabled, this is set to the default (minimum) VPUs/GB.
Sample:
56
|
||||
image_id
string
|
on success |
The OCID of the image used to boot the instance.
Sample:
ocid1.image.oc1..xxxxxxEXAMPLExxxxxx
|
||||
kms_key_id
string
|
on success |
The OCID of the key management key to assign as the master encryption key for the boot volume.
Sample:
ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
|
||||
source_type
string
|
on success |
The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID.
Sample:
bootVolume
|
Authors¶
Oracle (@oracle)