Skip to content

cloudmigrations.oracle.com/v1beta1

Back to API Reference

APIVersion: cloudmigrations.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages

No customer-visible package currently exposes cloudmigrations.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
Migration Namespaced Sample -
MigrationAsset Namespaced Sample -
MigrationPlan Namespaced Sample -
ReplicationSchedule Namespaced Sample -
TargetAsset Namespaced Sample -

Migration

Migration is the Schema for the migrations API.

  • Plural: migrations
  • Scope: Namespaced
  • APIVersion: cloudmigrations.oracle.com/v1beta1
  • Sample: Sample (config/samples/cloudmigrations_v1beta1_migration.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

MigrationSpec defines the desired state of Migration.

Field Description Type Required Default Enum
compartmentId Compartment identifier string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName Migration identifier string Yes - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {"bar-key": "value"} map[string, string] No - -
isCompleted Indicates whether migration is marked as complete. boolean No - -
migrationConfig MigrationConfig defines nested fields for Migration.MigrationConfig. object No - -
migrationType Type of migration project (OCI/OLVM). This determines the target environment for the migration. string No - -
replicationScheduleId Replication schedule identifier string No - -

Spec.migrationConfig

Back to Migration spec

MigrationConfig defines nested fields for Migration.MigrationConfig.

Field Description Type Required Default Enum
subnetId The OCID of the subnet to use for replication string No - -

Status

MigrationStatus defines the observed state of Migration.

Field Description Type Required Default Enum
compartmentId Compartment Identifier string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName Migration Identifier that can be renamed string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {"bar-key": "value"} map[string, string] No - -
id Unique identifier that is immutable on creation string No - -
isCompleted Indicates whether migration is marked as completed. boolean No - -
lifecycleDetails 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. string No - -
lifecycleState The current state of migration. string No - -
migrationConfig MigrationConfig defines nested fields for Migration.MigrationConfig. object No - -
migrationType Type of migration project (OCI/OLVM). This determines the target environment for the migration. string No - -
replicationScheduleId Replication schedule identifier string No - -
status - object Yes - -
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The time when the migration project was created. An RFC3339 formatted datetime string string No - -
timeUpdated The time when the migration project was updated. An RFC3339 formatted datetime string string No - -

Status.migrationConfig

Back to Migration status

MigrationConfig defines nested fields for Migration.MigrationConfig.

Field Description Type Required Default Enum
subnetId The OCID of the subnet to use for replication string No - -

Status.status

Back to Migration status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to Migration status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to Migration status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to Migration status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

MigrationAsset

MigrationAsset is the Schema for the migrationassets API.

  • Plural: migrationassets
  • Scope: Namespaced
  • APIVersion: cloudmigrations.oracle.com/v1beta1
  • Sample: Sample (config/samples/cloudmigrations_v1beta1_migrationasset.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

MigrationAssetSpec defines the desired state of MigrationAsset.

Field Description Type Required Default Enum
availabilityDomain Availability domain string Yes - -
dependsOn List of migration assets that depends on this asset. list[string] No - -
displayName A user-friendly name. If empty, then source asset name will be used. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
inventoryAssetId OCID of an asset for an inventory. string Yes - -
migrationId OCID of the associated migration. string Yes - -
replicationCompartmentId Replication compartment identifier string Yes - -
replicationLocationDetail MigrationAssetReplicationLocationDetail defines nested fields for MigrationAsset.ReplicationLocationDetail. object No - -
replicationScheduleId Replication schedule identifier string No - -
snapShotBucketName Name of snapshot bucket string Yes - -

Spec.replicationLocationDetail

Back to MigrationAsset spec

MigrationAssetReplicationLocationDetail defines nested fields for MigrationAsset.ReplicationLocationDetail.

Field Description Type Required Default Enum
metadata Properties for each of the replication location types Unknown nested fields are preserved. object (preserves unknown fields) No - -
replicationLocationType The type of replication location string No - -

Status

MigrationAssetStatus defines the observed state of MigrationAsset.

Field Description Type Required Default Enum
availabilityDomain Availability domain string No - -
compartmentId Compartment Identifier string No - -
dependedOnBy List of migration assets that depend on the asset. list[string] No - -
dependsOn List of migration assets that depends on the asset. list[string] No - -
destinationDisks Mapping of source disk id to destination disk details map[string, object] No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
id Asset ID generated by mirgration service. It is used in the mirgration service pipeline. string No - -
lifecycleDetails 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. string No - -
lifecycleState The current state of the migration asset. string No - -
migrationId OCID of the associated migration. string No - -
notifications List of notifications list[string] No - -
parentSnapshot The parent snapshot of the migration asset to be used by the replication task. string No - -
replicationCompartmentId Replication compartment identifier string No - -
replicationLocationDetail MigrationAssetReplicationLocationDetail defines nested fields for MigrationAsset.ReplicationLocationDetail. object No - -
replicationScheduleId Replication schedule identifier string No - -
snapShotBucketName Name of snapshot bucket string No - -
snapshotInfo The snapshot information. string No - -
snapshots Key-value pair representing disks ID mapped to the OCIDs of replicated or hydration server volume snapshots. Example: {"bar-key": "value"} map[string, object] No - -
sourceAssetData Key-value pair representing asset metadata keys and values scoped to a namespace. Example: {"bar-key": "value"} map[string, object (preserves unknown fields)] No - -
sourceAssetId OCID that is referenced to an asset for an inventory. string No - -
status - object Yes - -
tenancyId Tenancy identifier string No - -
timeCreated The time when the migration asset was created. An RFC3339 formatted datetime string. string No - -
timeUpdated The time when the migration asset was updated. An RFC3339 formatted datetime string. string No - -
type The type of asset referenced for inventory. string No - -

Status.destinationDisks{}

Back to MigrationAsset status

MigrationAssetDestinationDisks defines nested fields for MigrationAsset.DestinationDisks.

Field Description Type Required Default Enum
uuid UUID of disk string No - -

Status.replicationLocationDetail

Back to MigrationAsset status

MigrationAssetReplicationLocationDetail defines nested fields for MigrationAsset.ReplicationLocationDetail.

Field Description Type Required Default Enum
metadata Properties for each of the replication location types Unknown nested fields are preserved. object (preserves unknown fields) No - -
replicationLocationType The type of replication location string No - -

Status.snapshots{}

Back to MigrationAsset status

MigrationAssetSnapshots defines nested fields for MigrationAsset.Snapshots.

Field Description Type Required Default Enum
unmodifiedVolumeId ID of the unmodified volume string No - -
uuid ID of the vCenter disk obtained from Inventory. string No - -
volumeId ID of the hydration server volume string No - -
volumeType The hydration server volume type string No - -

Status.status

Back to MigrationAsset status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to MigrationAsset status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to MigrationAsset status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to MigrationAsset status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

MigrationPlan

MigrationPlan is the Schema for the migrationplans API.

  • Plural: migrationplans
  • Scope: Namespaced
  • APIVersion: cloudmigrations.oracle.com/v1beta1
  • Sample: Sample (config/samples/cloudmigrations_v1beta1_migrationplan.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

MigrationPlanSpec defines the desired state of MigrationPlan.

Field Description Type Required Default Enum
compartmentId Compartment identifier string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName Migration plan identifier string Yes - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {"bar-key": "value"} map[string, string] No - -
migrationId The OCID of the associated migration. string Yes - -
sourceMigrationPlanId Source migraiton plan ID to be cloned. string No - -
strategies List of strategies for the resources to be migrated. list[object] No - -
targetEnvironments List of target environments. list[object] No - -

Spec.strategies[]

Back to MigrationPlan spec

MigrationPlanStrategy defines nested fields for MigrationPlan.Strategy.

Field Description Type Required Default Enum
adjustmentMultiplier The real resource usage is multiplied to this number before making any recommendation. number No - -
jsonData - string No - -
metricTimeWindow The current state of the migration plan. string No - -
metricType The current state of the migration plan. string No - -
percentile Percentile value string No - -
resourceType The type of resource. string Yes - -
strategyType - string No - -

Spec.targetEnvironments[]

Back to MigrationPlan spec

MigrationPlanTargetEnvironment defines nested fields for MigrationPlan.TargetEnvironment.

Field Description Type Required Default Enum
availabilityDomain Availability Domain of the VM configuration. string No - -
clusterAssetId Inventory asset id of the olvm cluster string No - -
dedicatedVmHost OCID of the dedicated VM configuration host. string No - -
faultDomain Fault domain of the VM configuration. string No - -
jsonData - string No - -
msLicense Microsoft license for the VM configuration. string No - -
olvmTemplates OLVM OS type to inventory asset id of the template map[string, string] No - -
preferredShapeType Preferred VM shape type provided by the customer. string No - -
subnet OCID of the VM configuration subnet. string No - -
targetCompartmentId Target compartment identifier string No - -
targetEnvironmentType - string No - -
vcn OCID of the VM configuration VCN. string No - -
vnicProfileAssetId Inventory asset Id of the vnic profile string No - -

Status

MigrationPlanStatus defines the observed state of MigrationPlan.

Field Description Type Required Default Enum
calculatedLimits Limits of the resources that are needed for migration. Example: map[string, integer] No - -
compartmentId The OCID of the compartment containing the migration plan. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {"bar-key": "value"} map[string, string] No - -
id The unique Oracle ID (OCID) that is immutable on creation. string No - -
lifecycleDetails 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. string No - -
lifecycleState The current state of the migration plan. string No - -
migrationId The OCID of the associated migration. string No - -
migrationPlanStats MigrationPlanStats defines nested fields for MigrationPlan.MigrationPlanStats. object No - -
referenceToRmsStack OCID of the referenced ORM job. string No - -
sourceMigrationPlanId Source migraiton plan ID to be cloned. string No - -
status - object Yes - -
strategies List of strategies for the resources to be migrated. list[object] No - -
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
targetEnvironments List of target environments. list[object] No - -
timeCreated The time when the migration plan was created. An RFC3339 formatted datetime string. string No - -
timeUpdated The time when the migration plan was updated. An RFC3339 formatted datetime string. string No - -

Status.migrationPlanStats

Back to MigrationPlan status

MigrationPlanStats defines nested fields for MigrationPlan.MigrationPlanStats.

Field Description Type Required Default Enum
costToMigrate MigrationPlanStatsCostToMigrate defines nested fields for MigrationPlan.MigrationPlanStats.CostToMigrate. object No - -
currentMonthlyCost MigrationPlanStatsCurrentMonthlyCost defines nested fields for MigrationPlan.MigrationPlanStats.CurrentMonthlyCost. object No - -
timeUpdated The time when the migration plan was calculated. An RFC3339 formatted datetime string. string No - -
totalEstimatedCost MigrationPlanStatsTotalEstimatedCost defines nested fields for MigrationPlan.MigrationPlanStats.TotalEstimatedCost. object No - -
vmCount The total count of VMs in migration integer No - -

Status.migrationPlanStats.costToMigrate

Back to MigrationPlan status

MigrationPlanStatsCostToMigrate defines nested fields for MigrationPlan.MigrationPlanStats.CostToMigrate.

Field Description Type Required Default Enum
assetCount Number of assets used in this calculation. integer No - -
currencyCode Currency code as defined by ISO-4217. string No - -
ociDataTransferCosts Data transfer costs from OCI. number No - -
sourceDataTransferCosts Data transfer costs from source cloud provider. number No - -

Status.migrationPlanStats.currentMonthlyCost

Back to MigrationPlan status

MigrationPlanStatsCurrentMonthlyCost defines nested fields for MigrationPlan.MigrationPlanStats.CurrentMonthlyCost.

Field Description Type Required Default Enum
assetCount Number of assets used in this calculation. integer No - -
computeAmount Current monthly compute costs. number No - -
currencyCode Currency code as defined by ISO-4217. string No - -
storageAmount Current monthly storage costs. number No - -

Status.migrationPlanStats.totalEstimatedCost

Back to MigrationPlan status

MigrationPlanStatsTotalEstimatedCost defines nested fields for MigrationPlan.MigrationPlanStats.TotalEstimatedCost.

Field Description Type Required Default Enum
compute MigrationPlanStatsTotalEstimatedCostCompute defines nested fields for MigrationPlan.MigrationPlanStats.TotalEstimatedCost.Compute. object No - -
currencyCode Currency code in the ISO format. string No - -
osImage MigrationPlanStatsTotalEstimatedCostOsImage defines nested fields for MigrationPlan.MigrationPlanStats.TotalEstimatedCost.OsImage. object No - -
storage MigrationPlanStatsTotalEstimatedCostStorage defines nested fields for MigrationPlan.MigrationPlanStats.TotalEstimatedCost.Storage. object No - -
subscriptionId Subscription ID string No - -
totalEstimationPerMonth Total estimation per month number No - -
totalEstimationPerMonthBySubscription Total estimation per month by subscription. number No - -

Status.migrationPlanStats.totalEstimatedCost.compute

Back to MigrationPlan status

MigrationPlanStatsTotalEstimatedCostCompute defines nested fields for MigrationPlan.MigrationPlanStats.TotalEstimatedCost.Compute.

Field Description Type Required Default Enum
gpuCount Total number of GPU number No - -
gpuPerHour GPU per hour number No - -
gpuPerHourBySubscription GPU per hour by subscription number No - -
memoryAmountGb Total usage of memory number No - -
memoryGbPerHour Gigabyte per hour number No - -
memoryGbPerHourBySubscription Gigabyte per hour by subscription number No - -
ocpuCount Total number of OCPUs number No - -
ocpuPerHour OCPU per hour number No - -
ocpuPerHourBySubscription OCPU per hour by subscription number No - -
totalPerHour Total per hour number No - -
totalPerHourBySubscription Total usage per hour by subscription number No - -

Status.migrationPlanStats.totalEstimatedCost.osImage

Back to MigrationPlan status

MigrationPlanStatsTotalEstimatedCostOsImage defines nested fields for MigrationPlan.MigrationPlanStats.TotalEstimatedCost.OsImage.

Field Description Type Required Default Enum
totalPerHour Total price per hour number No - -
totalPerHourBySubscription Total price per hour by subscription number No - -

Status.migrationPlanStats.totalEstimatedCost.storage

Back to MigrationPlan status

MigrationPlanStatsTotalEstimatedCostStorage defines nested fields for MigrationPlan.MigrationPlanStats.TotalEstimatedCost.Storage.

Field Description Type Required Default Enum
totalGbPerMonth Gigabyte storage capacity per month. number No - -
totalGbPerMonthBySubscription Gigabyte storage capacity per month by subscription. number No - -
volumes Volume estimation list[object] No - -

Status.migrationPlanStats.totalEstimatedCost.storage.volumes[]

Back to MigrationPlan status

MigrationPlanStatsTotalEstimatedCostStorageVolume defines nested fields for MigrationPlan.MigrationPlanStats.TotalEstimatedCost.Storage.Volume.

Field Description Type Required Default Enum
capacityGb Gigabyte storage capacity number No - -
description Volume description string No - -
totalGbPerMonth Gigabyte storage capacity per month. number No - -
totalGbPerMonthBySubscription Gigabyte storage capacity per month by subscription number No - -

Status.status

Back to MigrationPlan status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to MigrationPlan status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to MigrationPlan status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to MigrationPlan status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Status.strategies[]

Back to MigrationPlan status

MigrationPlanStrategy defines nested fields for MigrationPlan.Strategy.

Field Description Type Required Default Enum
adjustmentMultiplier The real resource usage is multiplied to this number before making any recommendation. number No - -
jsonData - string No - -
metricTimeWindow The current state of the migration plan. string No - -
metricType The current state of the migration plan. string No - -
percentile Percentile value string No - -
resourceType The type of resource. string Yes - -
strategyType - string No - -

Status.targetEnvironments[]

Back to MigrationPlan status

MigrationPlanTargetEnvironment defines nested fields for MigrationPlan.TargetEnvironment.

Field Description Type Required Default Enum
availabilityDomain Availability Domain of the VM configuration. string No - -
clusterAssetId Inventory asset id of the olvm cluster string No - -
dedicatedVmHost OCID of the dedicated VM configuration host. string No - -
faultDomain Fault domain of the VM configuration. string No - -
jsonData - string No - -
msLicense Microsoft license for the VM configuration. string No - -
olvmTemplates OLVM OS type to inventory asset id of the template map[string, string] No - -
preferredShapeType Preferred VM shape type provided by the customer. string No - -
subnet OCID of the VM configuration subnet. string No - -
targetCompartmentId Target compartment identifier string No - -
targetEnvironmentType - string No - -
vcn OCID of the VM configuration VCN. string No - -
vnicProfileAssetId Inventory asset Id of the vnic profile string No - -

ReplicationSchedule

ReplicationSchedule is the Schema for the replicationschedules API.

  • Plural: replicationschedules
  • Scope: Namespaced
  • APIVersion: cloudmigrations.oracle.com/v1beta1
  • Sample: Sample (config/samples/cloudmigrations_v1beta1_replicationschedule.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ReplicationScheduleSpec defines the desired state of ReplicationSchedule.

Field Description Type Required Default Enum
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the replication schedule should be created. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName A user-friendly name for a replication schedule. Does not have to be unique, and is mutable. Avoid entering confidential information. string Yes - -
executionRecurrences Recurrence specification for replication schedule execution. string Yes - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {"bar-key": "value"} map[string, string] No - -

Status

ReplicationScheduleStatus defines the observed state of ReplicationSchedule.

Field Description Type Required Default Enum
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the replication schedule exists. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName A name of the replication schedule. string No - -
executionRecurrences Recurrence specification for the replication schedule execution. string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {"bar-key": "value"} map[string, string] No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the replication schedule. string No - -
lifecycleDetails The detailed state of the replication schedule. string No - -
lifecycleState Current state of the replication schedule. string No - -
status - object Yes - -
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The time when the replication schedule was created in RFC3339 format. string No - -
timeUpdated The time when the replication schedule was last updated in RFC3339 format. string No - -

Status.status

Back to ReplicationSchedule status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to ReplicationSchedule status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to ReplicationSchedule status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to ReplicationSchedule status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

TargetAsset

TargetAsset is the Schema for the targetassets API.

  • Plural: targetassets
  • Scope: Namespaced
  • APIVersion: cloudmigrations.oracle.com/v1beta1
  • Sample: Sample (config/samples/cloudmigrations_v1beta1_targetasset.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

TargetAssetSpec defines the desired state of TargetAsset.

Field Description Type Required Default Enum
blockVolumesPerformance Performance of the block volumes. integer No - -
isExcludedFromExecution A boolean indicating whether the asset should be migrated. boolean Yes - -
jsonData - string No - -
migrationPlanId OCID of the associated migration plan. string Yes - -
msLicense Microsoft license for the VM configuration. string No - -
preferredShapeType Preferred VM shape type that you provide. string No - -
type - string No - -
userSpec TargetAssetUserSpec defines nested fields for TargetAsset.UserSpec. object No - -

Spec.userSpec

Back to TargetAsset spec

TargetAssetUserSpec defines nested fields for TargetAsset.UserSpec.

Field Description Type Required Default Enum
agentConfig TargetAssetUserSpecAgentConfig defines nested fields for TargetAsset.UserSpec.AgentConfig. object No - -
availabilityDomain The availability domain of the instance. Example: Uocm:PHX-AD-1 string No - -
capacityReservationId 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 (https://docs.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm#default). string No - -
compartmentId The OCID of the compartment. string No - -
createVnicDetails TargetAssetUserSpecCreateVnicDetails defines nested fields for TargetAsset.UserSpec.CreateVnicDetails. object No - -
dedicatedVmHostId The OCID of the dedicated VM host. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
faultDomain 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 string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {"bar-key": "value"} map[string, string] No - -
hostnameLabel Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match. string No - -
instanceOptions TargetAssetUserSpecInstanceOptions defines nested fields for TargetAsset.UserSpec.InstanceOptions. object No - -
ipxeScript 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 (https://docs.oracle.com/iaas/Content/Compute/References/bringyourownimage.htm). For more information about iPXE, see http://ipxe.org. string No - -
isPvEncryptionInTransitEnabled 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. boolean No - -
preemptibleInstanceConfig TargetAssetUserSpecPreemptibleInstanceConfig defines nested fields for TargetAsset.UserSpec.PreemptibleInstanceConfig. object No - -
shape 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. string No - -
shapeConfig TargetAssetUserSpecShapeConfig defines nested fields for TargetAsset.UserSpec.ShapeConfig. object No - -
sourceDetails TargetAssetUserSpecSourceDetails defines nested fields for TargetAsset.UserSpec.SourceDetails. object No - -

Spec.userSpec.agentConfig

Back to TargetAsset spec

TargetAssetUserSpecAgentConfig defines nested fields for TargetAsset.UserSpec.AgentConfig.

Field Description Type Required Default Enum
areAllPluginsDisabled 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 (https://docs.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm). boolean No - -
isManagementDisabled 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. boolean No - -
isMonitoringDisabled 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. boolean No - -
pluginsConfig The configuration of plugins associated with this instance. list[object] No - -

Spec.userSpec.agentConfig.pluginsConfig[]

Back to TargetAsset spec

TargetAssetUserSpecAgentConfigPluginsConfig defines nested fields for TargetAsset.UserSpec.AgentConfig.PluginsConfig.

Field Description Type Required Default Enum
desiredState 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. string Yes - -
name 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 (https://docs.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm). string Yes - -

Spec.userSpec.createVnicDetails

Back to TargetAsset spec

TargetAssetUserSpecCreateVnicDetails defines nested fields for TargetAsset.UserSpec.CreateVnicDetails.

Field Description Type Required Default Enum
assignPrivateDnsRecord 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. boolean No - -
assignPublicIp 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 (https://docs.oracle.com/iaas/Content/Network/Tasks/managingIPaddresses.htm). Note: There's a limit to the number of PublicIp 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 (https://docs.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm). Example: false If you specify a vlanId, then assignPublicIp must be set to false. See Vlan. boolean No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {"bar-key": "value"} map[string, string] No - -
hostnameLabel 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 (https://tools.ietf.org/html/rfc952) and RFC 1123 (https://tools.ietf.org/html/rfc1123). 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 (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm). 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. string No - -
nsgIds 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. list[string] No - -
privateIp 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 string No - -
skipSourceDestCheck 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 (https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip). 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 boolean No - -
subnetId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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. string No - -
vlanId 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 (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. See Vlan. Provide a vlanId instead of a subnetId. If you provide both vlanId and subnetId, the request fails. string No - -

Spec.userSpec.instanceOptions

Back to TargetAsset spec

TargetAssetUserSpecInstanceOptions defines nested fields for TargetAsset.UserSpec.InstanceOptions.

Field Description Type Required Default Enum
areLegacyImdsEndpointsDisabled 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. boolean No - -

Spec.userSpec.preemptibleInstanceConfig

Back to TargetAsset spec

TargetAssetUserSpecPreemptibleInstanceConfig defines nested fields for TargetAsset.UserSpec.PreemptibleInstanceConfig.

Field Description Type Required Default Enum
preemptionAction TargetAssetUserSpecPreemptibleInstanceConfigPreemptionAction defines nested fields for TargetAsset.UserSpec.PreemptibleInstanceConfig.PreemptionAction. object Yes - -

Spec.userSpec.preemptibleInstanceConfig.preemptionAction

Back to TargetAsset spec

TargetAssetUserSpecPreemptibleInstanceConfigPreemptionAction defines nested fields for TargetAsset.UserSpec.PreemptibleInstanceConfig.PreemptionAction.

Field Description Type Required Default Enum
jsonData - string No - -
preserveBootVolume 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. boolean No - -
type - string No - -

Spec.userSpec.shapeConfig

Back to TargetAsset spec

TargetAssetUserSpecShapeConfig defines nested fields for TargetAsset.UserSpec.ShapeConfig.

Field Description Type Required Default Enum
baselineOcpuUtilization 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. string No - -
memoryInGBs The total amount of memory in gigabytes that is available to the instance. number No - -
ocpus The total number of OCPUs available to the instance. number No - -

Spec.userSpec.sourceDetails

Back to TargetAsset spec

TargetAssetUserSpecSourceDetails defines nested fields for TargetAsset.UserSpec.SourceDetails.

Field Description Type Required Default Enum
bootVolumeId The OCID of the boot volume used to boot the instance. string No - -
bootVolumeSizeInGBs The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB). integer (int64) No - -
bootVolumeVpusPerGB 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 (https://docs.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 volumes with the auto-tuned performance feature enabled, this is set to the default (minimum) VPUs/GB. integer (int64) No - -
imageId The OCID of the image used to boot the instance. string No - -
jsonData - string No - -
kmsKeyId The OCID of the key management key to assign as the master encryption key for the boot volume. string No - -
sourceType - string No - -

Status

TargetAssetStatus defines the observed state of TargetAsset.

Field Description Type Required Default Enum
blockVolumesPerformance Performance of the block volumes. integer No - -
compartmentId Compartment identifier string No - -
compatibilityMessages Messages about the compatibility issues. list[object] No - -
createdResourceId Created resource identifier string No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
estimatedCost TargetAssetEstimatedCost defines nested fields for TargetAsset.EstimatedCost. object No - -
id Unique identifier that is immutable on creation. string No - -
isExcludedFromExecution A boolean indicating whether the asset should be migrated. boolean No - -
jsonData - string No - -
lifecycleDetails 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. string No - -
lifecycleState The current state of the target asset. string No - -
migrationAsset TargetAssetMigrationAsset defines nested fields for TargetAsset.MigrationAsset. object No - -
migrationPlanId OCID of the associated migration plan. string No - -
msLicense Microsoft license for VM configuration. string No - -
preferredShapeType Preferred VM shape type that you provide. string No - -
recommendedSpec TargetAssetRecommendedSpec defines nested fields for TargetAsset.RecommendedSpec. object No - -
status - object Yes - -
testSpec TargetAssetTestSpec defines nested fields for TargetAsset.TestSpec. object No - -
timeAssessed The time when the assessment was done. An RFC3339 formatted datetime string. string No - -
timeCreated The time when the target asset was created. An RFC3339 formatted datetime string. string No - -
timeUpdated The time when the target asset was updated. An RFC3339 formatted datetime string. string No - -
type - string No - -
userSpec TargetAssetUserSpec defines nested fields for TargetAsset.UserSpec. object No - -

Status.compatibilityMessages[]

Back to TargetAsset status

TargetAssetCompatibilityMessage defines nested fields for TargetAsset.CompatibilityMessage.

Field Description Type Required Default Enum
message Detailed description of the compatibility issue. string No - -
name Name of the compatibility issue. string No - -
severity Severity level of the compatibility issue. string No - -

Status.estimatedCost

Back to TargetAsset status

TargetAssetEstimatedCost defines nested fields for TargetAsset.EstimatedCost.

Field Description Type Required Default Enum
compute TargetAssetEstimatedCostCompute defines nested fields for TargetAsset.EstimatedCost.Compute. object No - -
currencyCode Currency code in the ISO format. string No - -
osImage TargetAssetEstimatedCostOsImage defines nested fields for TargetAsset.EstimatedCost.OsImage. object No - -
storage TargetAssetEstimatedCostStorage defines nested fields for TargetAsset.EstimatedCost.Storage. object No - -
subscriptionId Subscription ID string No - -
totalEstimationPerMonth Total estimation per month number No - -
totalEstimationPerMonthBySubscription Total estimation per month by subscription. number No - -

Status.estimatedCost.compute

Back to TargetAsset status

TargetAssetEstimatedCostCompute defines nested fields for TargetAsset.EstimatedCost.Compute.

Field Description Type Required Default Enum
gpuCount Total number of GPU number No - -
gpuPerHour GPU per hour number No - -
gpuPerHourBySubscription GPU per hour by subscription number No - -
memoryAmountGb Total usage of memory number No - -
memoryGbPerHour Gigabyte per hour number No - -
memoryGbPerHourBySubscription Gigabyte per hour by subscription number No - -
ocpuCount Total number of OCPUs number No - -
ocpuPerHour OCPU per hour number No - -
ocpuPerHourBySubscription OCPU per hour by subscription number No - -
totalPerHour Total per hour number No - -
totalPerHourBySubscription Total usage per hour by subscription number No - -

Status.estimatedCost.osImage

Back to TargetAsset status

TargetAssetEstimatedCostOsImage defines nested fields for TargetAsset.EstimatedCost.OsImage.

Field Description Type Required Default Enum
totalPerHour Total price per hour number No - -
totalPerHourBySubscription Total price per hour by subscription number No - -

Status.estimatedCost.storage

Back to TargetAsset status

TargetAssetEstimatedCostStorage defines nested fields for TargetAsset.EstimatedCost.Storage.

Field Description Type Required Default Enum
totalGbPerMonth Gigabyte storage capacity per month. number No - -
totalGbPerMonthBySubscription Gigabyte storage capacity per month by subscription. number No - -
volumes Volume estimation list[object] No - -

Status.estimatedCost.storage.volumes[]

Back to TargetAsset status

TargetAssetEstimatedCostStorageVolume defines nested fields for TargetAsset.EstimatedCost.Storage.Volume.

Field Description Type Required Default Enum
capacityGb Gigabyte storage capacity number No - -
description Volume description string No - -
totalGbPerMonth Gigabyte storage capacity per month. number No - -
totalGbPerMonthBySubscription Gigabyte storage capacity per month by subscription number No - -

Status.migrationAsset

Back to TargetAsset status

TargetAssetMigrationAsset defines nested fields for TargetAsset.MigrationAsset.

Field Description Type Required Default Enum
availabilityDomain Availability domain string No - -
compartmentId Compartment Identifier string No - -
dependedOnBy List of migration assets that depend on the asset. list[string] No - -
dependsOn List of migration assets that depends on the asset. list[string] No - -
destinationDisks Mapping of source disk id to destination disk details map[string, object] No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
id Asset ID generated by mirgration service. It is used in the mirgration service pipeline. string No - -
lifecycleDetails 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. string No - -
lifecycleState The current state of the migration asset. string No - -
migrationId OCID of the associated migration. string No - -
notifications List of notifications list[string] No - -
parentSnapshot The parent snapshot of the migration asset to be used by the replication task. string No - -
replicationCompartmentId Replication compartment identifier string No - -
replicationLocationDetail TargetAssetMigrationAssetReplicationLocationDetail defines nested fields for TargetAsset.MigrationAsset.ReplicationLocationDetail. object No - -
replicationScheduleId Replication schedule identifier string No - -
snapShotBucketName Name of snapshot bucket string No - -
snapshots Key-value pair representing disks ID mapped to the OCIDs of replicated or hydration server volume snapshots. Example: {"bar-key": "value"} map[string, object] No - -
sourceAssetData Key-value pair representing asset metadata keys and values scoped to a namespace. Example: {"bar-key": "value"} map[string, object (preserves unknown fields)] No - -
sourceAssetId OCID that is referenced to an asset for an inventory. string No - -
tenancyId Tenancy identifier string No - -
timeCreated The time when the migration asset was created. An RFC3339 formatted datetime string. string No - -
timeUpdated The time when the migration asset was updated. An RFC3339 formatted datetime string. string No - -
type The type of asset referenced for inventory. string No - -

Status.migrationAsset.destinationDisks{}

Back to TargetAsset status

TargetAssetMigrationAssetDestinationDisks defines nested fields for TargetAsset.MigrationAsset.DestinationDisks.

Field Description Type Required Default Enum
uuid UUID of disk string No - -

Status.migrationAsset.replicationLocationDetail

Back to TargetAsset status

TargetAssetMigrationAssetReplicationLocationDetail defines nested fields for TargetAsset.MigrationAsset.ReplicationLocationDetail.

Field Description Type Required Default Enum
metadata Properties for each of the replication location types Unknown nested fields are preserved. object (preserves unknown fields) No - -
replicationLocationType The type of replication location string No - -

Status.migrationAsset.snapshots{}

Back to TargetAsset status

TargetAssetMigrationAssetSnapshots defines nested fields for TargetAsset.MigrationAsset.Snapshots.

Field Description Type Required Default Enum
unmodifiedVolumeId ID of the unmodified volume string No - -
uuid ID of the vCenter disk obtained from Inventory. string No - -
volumeId ID of the hydration server volume string No - -
volumeType The hydration server volume type string No - -

Status.recommendedSpec

Back to TargetAsset status

TargetAssetRecommendedSpec defines nested fields for TargetAsset.RecommendedSpec.

Field Description Type Required Default Enum
agentConfig TargetAssetRecommendedSpecAgentConfig defines nested fields for TargetAsset.RecommendedSpec.AgentConfig. object No - -
availabilityDomain The availability domain of the instance. Example: Uocm:PHX-AD-1 string No - -
capacityReservationId 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 (https://docs.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm#default). string No - -
compartmentId The OCID of the compartment. string No - -
createVnicDetails TargetAssetRecommendedSpecCreateVnicDetails defines nested fields for TargetAsset.RecommendedSpec.CreateVnicDetails. object No - -
dedicatedVmHostId The OCID of the dedicated VM host. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
faultDomain 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 string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {"bar-key": "value"} map[string, string] No - -
hostnameLabel Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match. string No - -
instanceOptions TargetAssetRecommendedSpecInstanceOptions defines nested fields for TargetAsset.RecommendedSpec.InstanceOptions. object No - -
ipxeScript 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 (https://docs.oracle.com/iaas/Content/Compute/References/bringyourownimage.htm). For more information about iPXE, see http://ipxe.org. string No - -
isPvEncryptionInTransitEnabled 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. boolean No - -
preemptibleInstanceConfig TargetAssetRecommendedSpecPreemptibleInstanceConfig defines nested fields for TargetAsset.RecommendedSpec.PreemptibleInstanceConfig. object No - -
shape 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. string No - -
shapeConfig TargetAssetRecommendedSpecShapeConfig defines nested fields for TargetAsset.RecommendedSpec.ShapeConfig. object No - -
sourceDetails TargetAssetRecommendedSpecSourceDetails defines nested fields for TargetAsset.RecommendedSpec.SourceDetails. object No - -

Status.recommendedSpec.agentConfig

Back to TargetAsset status

TargetAssetRecommendedSpecAgentConfig defines nested fields for TargetAsset.RecommendedSpec.AgentConfig.

Field Description Type Required Default Enum
areAllPluginsDisabled 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 (https://docs.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm). boolean No - -
isManagementDisabled 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. boolean No - -
isMonitoringDisabled 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. boolean No - -
pluginsConfig The configuration of plugins associated with this instance. list[object] No - -

Status.recommendedSpec.agentConfig.pluginsConfig[]

Back to TargetAsset status

TargetAssetRecommendedSpecAgentConfigPluginsConfig defines nested fields for TargetAsset.RecommendedSpec.AgentConfig.PluginsConfig.

Field Description Type Required Default Enum
desiredState 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. string No - -
name 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 (https://docs.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm). string No - -

Status.recommendedSpec.createVnicDetails

Back to TargetAsset status

TargetAssetRecommendedSpecCreateVnicDetails defines nested fields for TargetAsset.RecommendedSpec.CreateVnicDetails.

Field Description Type Required Default Enum
assignPrivateDnsRecord 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. boolean No - -
assignPublicIp 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 (https://docs.oracle.com/iaas/Content/Network/Tasks/managingIPaddresses.htm). Note: There's a limit to the number of PublicIp 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 (https://docs.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm). Example: false If you specify a vlanId, then assignPublicIp must be set to false. See Vlan. boolean No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {"bar-key": "value"} map[string, string] No - -
hostnameLabel 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 (https://tools.ietf.org/html/rfc952) and RFC 1123 (https://tools.ietf.org/html/rfc1123). 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 (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm). 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. string No - -
nsgIds 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. list[string] No - -
privateIp 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 string No - -
skipSourceDestCheck 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 (https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip). 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 boolean No - -
subnetId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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. string No - -
vlanId 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 (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. See Vlan. Provide a vlanId instead of a subnetId. If you provide both vlanId and subnetId, the request fails. string No - -

Status.recommendedSpec.instanceOptions

Back to TargetAsset status

TargetAssetRecommendedSpecInstanceOptions defines nested fields for TargetAsset.RecommendedSpec.InstanceOptions.

Field Description Type Required Default Enum
areLegacyImdsEndpointsDisabled 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. boolean No - -

Status.recommendedSpec.preemptibleInstanceConfig

Back to TargetAsset status

TargetAssetRecommendedSpecPreemptibleInstanceConfig defines nested fields for TargetAsset.RecommendedSpec.PreemptibleInstanceConfig.

Field Description Type Required Default Enum
preemptionAction TargetAssetRecommendedSpecPreemptibleInstanceConfigPreemptionAction defines nested fields for TargetAsset.RecommendedSpec.PreemptibleInstanceConfig.PreemptionAction. object No - -

Status.recommendedSpec.preemptibleInstanceConfig.preemptionAction

Back to TargetAsset status

TargetAssetRecommendedSpecPreemptibleInstanceConfigPreemptionAction defines nested fields for TargetAsset.RecommendedSpec.PreemptibleInstanceConfig.PreemptionAction.

Field Description Type Required Default Enum
jsonData - string No - -
preserveBootVolume 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. boolean No - -
type - string No - -

Status.recommendedSpec.shapeConfig

Back to TargetAsset status

TargetAssetRecommendedSpecShapeConfig defines nested fields for TargetAsset.RecommendedSpec.ShapeConfig.

Field Description Type Required Default Enum
baselineOcpuUtilization 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. string No - -
memoryInGBs The total amount of memory in gigabytes that is available to the instance. number No - -
ocpus The total number of OCPUs available to the instance. number No - -

Status.recommendedSpec.sourceDetails

Back to TargetAsset status

TargetAssetRecommendedSpecSourceDetails defines nested fields for TargetAsset.RecommendedSpec.SourceDetails.

Field Description Type Required Default Enum
bootVolumeId The OCID of the boot volume used to boot the instance. string No - -
bootVolumeSizeInGBs The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB). integer (int64) No - -
bootVolumeVpusPerGB 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 (https://docs.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 volumes with the auto-tuned performance feature enabled, this is set to the default (minimum) VPUs/GB. integer (int64) No - -
imageId The OCID of the image used to boot the instance. string No - -
jsonData - string No - -
kmsKeyId The OCID of the key management key to assign as the master encryption key for the boot volume. string No - -
sourceType - string No - -

Status.status

Back to TargetAsset status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to TargetAsset status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to TargetAsset status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to TargetAsset status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Status.testSpec

Back to TargetAsset status

TargetAssetTestSpec defines nested fields for TargetAsset.TestSpec.

Field Description Type Required Default Enum
agentConfig TargetAssetTestSpecAgentConfig defines nested fields for TargetAsset.TestSpec.AgentConfig. object No - -
availabilityDomain The availability domain of the instance. Example: Uocm:PHX-AD-1 string No - -
capacityReservationId 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 (https://docs.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm#default). string No - -
compartmentId The OCID of the compartment. string No - -
createVnicDetails TargetAssetTestSpecCreateVnicDetails defines nested fields for TargetAsset.TestSpec.CreateVnicDetails. object No - -
dedicatedVmHostId The OCID of the dedicated VM host. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
faultDomain 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 string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {"bar-key": "value"} map[string, string] No - -
hostnameLabel Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match. string No - -
instanceOptions TargetAssetTestSpecInstanceOptions defines nested fields for TargetAsset.TestSpec.InstanceOptions. object No - -
ipxeScript 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 (https://docs.oracle.com/iaas/Content/Compute/References/bringyourownimage.htm). For more information about iPXE, see http://ipxe.org. string No - -
isPvEncryptionInTransitEnabled 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. boolean No - -
preemptibleInstanceConfig TargetAssetTestSpecPreemptibleInstanceConfig defines nested fields for TargetAsset.TestSpec.PreemptibleInstanceConfig. object No - -
shape 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. string No - -
shapeConfig TargetAssetTestSpecShapeConfig defines nested fields for TargetAsset.TestSpec.ShapeConfig. object No - -
sourceDetails TargetAssetTestSpecSourceDetails defines nested fields for TargetAsset.TestSpec.SourceDetails. object No - -

Status.testSpec.agentConfig

Back to TargetAsset status

TargetAssetTestSpecAgentConfig defines nested fields for TargetAsset.TestSpec.AgentConfig.

Field Description Type Required Default Enum
areAllPluginsDisabled 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 (https://docs.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm). boolean No - -
isManagementDisabled 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. boolean No - -
isMonitoringDisabled 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. boolean No - -
pluginsConfig The configuration of plugins associated with this instance. list[object] No - -

Status.testSpec.agentConfig.pluginsConfig[]

Back to TargetAsset status

TargetAssetTestSpecAgentConfigPluginsConfig defines nested fields for TargetAsset.TestSpec.AgentConfig.PluginsConfig.

Field Description Type Required Default Enum
desiredState 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. string No - -
name 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 (https://docs.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm). string No - -

Status.testSpec.createVnicDetails

Back to TargetAsset status

TargetAssetTestSpecCreateVnicDetails defines nested fields for TargetAsset.TestSpec.CreateVnicDetails.

Field Description Type Required Default Enum
assignPrivateDnsRecord 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. boolean No - -
assignPublicIp 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 (https://docs.oracle.com/iaas/Content/Network/Tasks/managingIPaddresses.htm). Note: There's a limit to the number of PublicIp 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 (https://docs.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm). Example: false If you specify a vlanId, then assignPublicIp must be set to false. See Vlan. boolean No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {"bar-key": "value"} map[string, string] No - -
hostnameLabel 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 (https://tools.ietf.org/html/rfc952) and RFC 1123 (https://tools.ietf.org/html/rfc1123). 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 (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm). 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. string No - -
nsgIds 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. list[string] No - -
privateIp 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 string No - -
skipSourceDestCheck 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 (https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip). 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 boolean No - -
subnetId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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. string No - -
vlanId 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 (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. See Vlan. Provide a vlanId instead of a subnetId. If you provide both vlanId and subnetId, the request fails. string No - -

Status.testSpec.instanceOptions

Back to TargetAsset status

TargetAssetTestSpecInstanceOptions defines nested fields for TargetAsset.TestSpec.InstanceOptions.

Field Description Type Required Default Enum
areLegacyImdsEndpointsDisabled 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. boolean No - -

Status.testSpec.preemptibleInstanceConfig

Back to TargetAsset status

TargetAssetTestSpecPreemptibleInstanceConfig defines nested fields for TargetAsset.TestSpec.PreemptibleInstanceConfig.

Field Description Type Required Default Enum
preemptionAction TargetAssetTestSpecPreemptibleInstanceConfigPreemptionAction defines nested fields for TargetAsset.TestSpec.PreemptibleInstanceConfig.PreemptionAction. object No - -

Status.testSpec.preemptibleInstanceConfig.preemptionAction

Back to TargetAsset status

TargetAssetTestSpecPreemptibleInstanceConfigPreemptionAction defines nested fields for TargetAsset.TestSpec.PreemptibleInstanceConfig.PreemptionAction.

Field Description Type Required Default Enum
jsonData - string No - -
preserveBootVolume 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. boolean No - -
type - string No - -

Status.testSpec.shapeConfig

Back to TargetAsset status

TargetAssetTestSpecShapeConfig defines nested fields for TargetAsset.TestSpec.ShapeConfig.

Field Description Type Required Default Enum
baselineOcpuUtilization 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. string No - -
memoryInGBs The total amount of memory in gigabytes that is available to the instance. number No - -
ocpus The total number of OCPUs available to the instance. number No - -

Status.testSpec.sourceDetails

Back to TargetAsset status

TargetAssetTestSpecSourceDetails defines nested fields for TargetAsset.TestSpec.SourceDetails.

Field Description Type Required Default Enum
bootVolumeId The OCID of the boot volume used to boot the instance. string No - -
bootVolumeSizeInGBs The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB). integer (int64) No - -
bootVolumeVpusPerGB 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 (https://docs.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 volumes with the auto-tuned performance feature enabled, this is set to the default (minimum) VPUs/GB. integer (int64) No - -
imageId The OCID of the image used to boot the instance. string No - -
jsonData - string No - -
kmsKeyId The OCID of the key management key to assign as the master encryption key for the boot volume. string No - -
sourceType - string No - -

Status.userSpec

Back to TargetAsset status

TargetAssetUserSpec defines nested fields for TargetAsset.UserSpec.

Field Description Type Required Default Enum
agentConfig TargetAssetUserSpecAgentConfig defines nested fields for TargetAsset.UserSpec.AgentConfig. object No - -
availabilityDomain The availability domain of the instance. Example: Uocm:PHX-AD-1 string No - -
capacityReservationId 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 (https://docs.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm#default). string No - -
compartmentId The OCID of the compartment. string No - -
createVnicDetails TargetAssetUserSpecCreateVnicDetails defines nested fields for TargetAsset.UserSpec.CreateVnicDetails. object No - -
dedicatedVmHostId The OCID of the dedicated VM host. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
faultDomain 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 string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {"bar-key": "value"} map[string, string] No - -
hostnameLabel Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match. string No - -
instanceOptions TargetAssetUserSpecInstanceOptions defines nested fields for TargetAsset.UserSpec.InstanceOptions. object No - -
ipxeScript 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 (https://docs.oracle.com/iaas/Content/Compute/References/bringyourownimage.htm). For more information about iPXE, see http://ipxe.org. string No - -
isPvEncryptionInTransitEnabled 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. boolean No - -
preemptibleInstanceConfig TargetAssetUserSpecPreemptibleInstanceConfig defines nested fields for TargetAsset.UserSpec.PreemptibleInstanceConfig. object No - -
shape 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. string No - -
shapeConfig TargetAssetUserSpecShapeConfig defines nested fields for TargetAsset.UserSpec.ShapeConfig. object No - -
sourceDetails TargetAssetUserSpecSourceDetails defines nested fields for TargetAsset.UserSpec.SourceDetails. object No - -

Status.userSpec.agentConfig

Back to TargetAsset status

TargetAssetUserSpecAgentConfig defines nested fields for TargetAsset.UserSpec.AgentConfig.

Field Description Type Required Default Enum
areAllPluginsDisabled 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 (https://docs.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm). boolean No - -
isManagementDisabled 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. boolean No - -
isMonitoringDisabled 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. boolean No - -
pluginsConfig The configuration of plugins associated with this instance. list[object] No - -

Status.userSpec.agentConfig.pluginsConfig[]

Back to TargetAsset status

TargetAssetUserSpecAgentConfigPluginsConfig defines nested fields for TargetAsset.UserSpec.AgentConfig.PluginsConfig.

Field Description Type Required Default Enum
desiredState 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. string Yes - -
name 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 (https://docs.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm). string Yes - -

Status.userSpec.createVnicDetails

Back to TargetAsset status

TargetAssetUserSpecCreateVnicDetails defines nested fields for TargetAsset.UserSpec.CreateVnicDetails.

Field Description Type Required Default Enum
assignPrivateDnsRecord 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. boolean No - -
assignPublicIp 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 (https://docs.oracle.com/iaas/Content/Network/Tasks/managingIPaddresses.htm). Note: There's a limit to the number of PublicIp 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 (https://docs.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm). Example: false If you specify a vlanId, then assignPublicIp must be set to false. See Vlan. boolean No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {"bar-key": "value"} map[string, string] No - -
hostnameLabel 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 (https://tools.ietf.org/html/rfc952) and RFC 1123 (https://tools.ietf.org/html/rfc1123). 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 (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm). 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. string No - -
nsgIds 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. list[string] No - -
privateIp 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 string No - -
skipSourceDestCheck 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 (https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip). 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 boolean No - -
subnetId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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. string No - -
vlanId 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 (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. See Vlan. Provide a vlanId instead of a subnetId. If you provide both vlanId and subnetId, the request fails. string No - -

Status.userSpec.instanceOptions

Back to TargetAsset status

TargetAssetUserSpecInstanceOptions defines nested fields for TargetAsset.UserSpec.InstanceOptions.

Field Description Type Required Default Enum
areLegacyImdsEndpointsDisabled 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. boolean No - -

Status.userSpec.preemptibleInstanceConfig

Back to TargetAsset status

TargetAssetUserSpecPreemptibleInstanceConfig defines nested fields for TargetAsset.UserSpec.PreemptibleInstanceConfig.

Field Description Type Required Default Enum
preemptionAction TargetAssetUserSpecPreemptibleInstanceConfigPreemptionAction defines nested fields for TargetAsset.UserSpec.PreemptibleInstanceConfig.PreemptionAction. object Yes - -

Status.userSpec.preemptibleInstanceConfig.preemptionAction

Back to TargetAsset status

TargetAssetUserSpecPreemptibleInstanceConfigPreemptionAction defines nested fields for TargetAsset.UserSpec.PreemptibleInstanceConfig.PreemptionAction.

Field Description Type Required Default Enum
jsonData - string No - -
preserveBootVolume 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. boolean No - -
type - string No - -

Status.userSpec.shapeConfig

Back to TargetAsset status

TargetAssetUserSpecShapeConfig defines nested fields for TargetAsset.UserSpec.ShapeConfig.

Field Description Type Required Default Enum
baselineOcpuUtilization 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. string No - -
memoryInGBs The total amount of memory in gigabytes that is available to the instance. number No - -
ocpus The total number of OCPUs available to the instance. number No - -

Status.userSpec.sourceDetails

Back to TargetAsset status

TargetAssetUserSpecSourceDetails defines nested fields for TargetAsset.UserSpec.SourceDetails.

Field Description Type Required Default Enum
bootVolumeId The OCID of the boot volume used to boot the instance. string No - -
bootVolumeSizeInGBs The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB). integer (int64) No - -
bootVolumeVpusPerGB 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 (https://docs.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 volumes with the auto-tuned performance feature enabled, this is set to the default (minimum) VPUs/GB. integer (int64) No - -
imageId The OCID of the image used to boot the instance. string No - -
jsonData - string No - -
kmsKeyId The OCID of the key management key to assign as the master encryption key for the boot volume. string No - -
sourceType - string No - -