ComputeClient

class oci.core.ComputeClient(config, **kwargs)

API covering the [Networking](/iaas/Content/Network/Concepts/overview.htm), [Compute](/iaas/Content/Compute/Concepts/computeoverview.htm), and [Block Volume](/iaas/Content/Block/Concepts/overview.htm) services. Use this API to manage resources such as virtual cloud networks (VCNs), compute instances, and block storage volumes.

Methods

__init__(config, **kwargs) Creates a new service client
add_image_shape_compatibility_entry(…) Adds a shape to the compatible shapes list for the image.
attach_boot_volume(…) Attaches the specified boot volume to the specified instance.
attach_vnic(attach_vnic_details, **kwargs) Creates a secondary VNIC and attaches it to the specified instance.
attach_volume(attach_volume_details, **kwargs) Attaches the specified storage volume to the specified instance.
capture_console_history(…) Captures the most recent serial console data (up to a megabyte) for the specified instance.
change_compute_capacity_reservation_compartment(…) Moves a compute capacity reservation into a different compartment.
change_compute_image_capability_schema_compartment(…) Moves a compute image capability schema into a different compartment within the same tenancy.
change_dedicated_vm_host_compartment(…) Moves a dedicated virtual machine host from one compartment to another.
change_image_compartment(image_id, …) Moves an image into a different compartment within the same tenancy.
change_instance_compartment(instance_id, …) Moves an instance into a different compartment within the same tenancy.
create_app_catalog_subscription(…) Create a subscription for listing resource version for a compartment.
create_compute_capacity_reservation(…) Creates a new compute capacity reservation in the specified compartment and availability domain.
create_compute_image_capability_schema(…) Creates compute image capability schema.
create_dedicated_vm_host(…) Creates a new dedicated virtual machine host in the specified compartment and the specified availability domain.
create_image(create_image_details, **kwargs) Creates a boot disk image for the specified instance or imports an exported image from the Oracle Cloud Infrastructure Object Storage service.
create_instance_console_connection(…) Creates a new console connection to the specified instance.
delete_app_catalog_subscription(listing_id, …) Delete a subscription for a listing resource version for a compartment.
delete_compute_capacity_reservation(…) Deletes the specified compute capacity reservation.
delete_compute_image_capability_schema(…) Deletes the specified Compute Image Capability Schema
delete_console_history(…) Deletes the specified console history metadata and the console history data.
delete_dedicated_vm_host(…) Deletes the specified dedicated virtual machine host.
delete_image(image_id, **kwargs) Deletes an image.
delete_instance_console_connection(…) Deletes the specified instance console connection.
detach_boot_volume(…) Detaches a boot volume from an instance.
detach_vnic(vnic_attachment_id, **kwargs) Detaches and deletes the specified secondary VNIC.
detach_volume(volume_attachment_id, **kwargs) Detaches a storage volume from an instance.
export_image(image_id, export_image_details, …) Exports the specified image to the Oracle Cloud Infrastructure Object Storage service.
get_app_catalog_listing(listing_id, **kwargs) Gets the specified listing.
get_app_catalog_listing_agreements(…) Retrieves the agreements for a particular resource version of a listing.
get_app_catalog_listing_resource_version(…) Gets the specified listing resource version.
get_boot_volume_attachment(…) Gets information about the specified boot volume attachment.
get_compute_capacity_reservation(…) Gets information about the specified compute capacity reservation.
get_compute_global_image_capability_schema(…) Gets the specified Compute Global Image Capability Schema
get_compute_global_image_capability_schema_version(…) Gets the specified Compute Global Image Capability Schema Version
get_compute_image_capability_schema(…) Gets the specified Compute Image Capability Schema
get_console_history(…) Shows the metadata for the specified console history.
get_console_history_content(…) Gets the actual console history data (not the metadata).
get_dedicated_vm_host(dedicated_vm_host_id, …) Gets information about the specified dedicated virtual machine host.
get_image(image_id, **kwargs) Gets the specified image.
get_image_shape_compatibility_entry(…) Retrieves an image shape compatibility entry.
get_instance(instance_id, **kwargs) Gets information about the specified instance.
get_instance_console_connection(…) Gets the specified instance console connection’s information.
get_vnic_attachment(vnic_attachment_id, **kwargs) Gets the information for the specified VNIC attachment.
get_volume_attachment(volume_attachment_id, …) Gets information about the specified volume attachment.
get_windows_instance_initial_credentials(…) Gets the generated credentials for the instance.
instance_action(instance_id, action, **kwargs) Performs one of the following power actions on the specified instance:
launch_instance(launch_instance_details, …) Creates a new instance in the specified compartment and the specified availability domain.
list_app_catalog_listing_resource_versions(…) Gets all resource versions for a particular listing.
list_app_catalog_listings(**kwargs) Lists the published listings.
list_app_catalog_subscriptions(…) Lists subscriptions for a compartment.
list_boot_volume_attachments(…) Lists the boot volume attachments in the specified compartment.
list_compute_capacity_reservation_instance_shapes(…) Lists the shapes that can be reserved within the specified compartment.
list_compute_capacity_reservation_instances(…) Lists the instances launched under a capacity reservation.
list_compute_capacity_reservations(…) Lists the compute capacity reservations that match the specified criteria and compartment.
list_compute_global_image_capability_schema_versions(…) Lists Compute Global Image Capability Schema versions in the specified compartment.
list_compute_global_image_capability_schemas(…) Lists Compute Global Image Capability Schema in the specified compartment.
list_compute_image_capability_schemas(**kwargs) Lists Compute Image Capability Schema in the specified compartment.
list_console_histories(compartment_id, **kwargs) Lists the console history metadata for the specified compartment or instance.
list_dedicated_vm_host_instance_shapes(…) Lists the shapes that can be used to launch a virtual machine instance on a dedicated virtual machine host within the specified compartment.
list_dedicated_vm_host_instances(…) Returns the list of instances on the dedicated virtual machine hosts that match the specified criteria.
list_dedicated_vm_host_shapes(…) Lists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment.
list_dedicated_vm_hosts(compartment_id, **kwargs) Returns the list of dedicated virtual machine hosts that match the specified criteria in the specified compartment.
list_image_shape_compatibility_entries(…) Lists the compatible shapes for the specified image.
list_images(compartment_id, **kwargs) Lists the available images in the specified compartment, including `platform images`__ and `custom images`__ that have been created.
list_instance_console_connections(…) Lists the console connections for the specified compartment or instance.
list_instance_devices(instance_id, **kwargs) Gets a list of all the devices for given instance.
list_instances(compartment_id, **kwargs) Lists the instances in the specified compartment and the specified availability domain.
list_shapes(compartment_id, **kwargs) Lists the shapes that can be used to launch an instance within the specified compartment.
list_vnic_attachments(compartment_id, **kwargs) Lists the VNIC attachments in the specified compartment.
list_volume_attachments(compartment_id, **kwargs) Lists the volume attachments in the specified compartment.
remove_image_shape_compatibility_entry(…) Removes a shape from the compatible shapes list for the image.
terminate_instance(instance_id, **kwargs) Terminates the specified instance.
update_compute_capacity_reservation(…) Updates the display name, defined tag, and freeform tag fields for the specified compute capacity reservation.
update_compute_image_capability_schema(…) Updates the specified Compute Image Capability Schema
update_console_history(…) Updates the specified console history metadata.
update_dedicated_vm_host(…) Updates the displayName, freeformTags, and definedTags attributes for the specified dedicated virtual machine host.
update_image(image_id, update_image_details, …) Updates the display name of the image.
update_instance(instance_id, …) Updates certain fields on the specified instance.
update_instance_console_connection(…) Updates the defined tags and free-form tags for the specified instance console connection.
update_volume_attachment(…) Updates information about the specified volume attachment.
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

add_image_shape_compatibility_entry(image_id, shape_name, **kwargs)

Adds a shape to the compatible shapes list for the image.

Parameters:
  • image_id (str) –

    (required) The `OCID`__ of the image.

  • shape_name (str) – (required) Shape name.
  • add_image_shape_compatibility_entry_details (oci.core.models.AddImageShapeCompatibilityEntryDetails) – (optional) Image shape compatibility details
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ImageShapeCompatibilityEntry

Return type:

Response

Example:

Click here to see an example of how to use add_image_shape_compatibility_entry API.

attach_boot_volume(attach_boot_volume_details, **kwargs)

Attaches the specified boot volume to the specified instance.

Parameters:
  • attach_boot_volume_details (oci.core.models.AttachBootVolumeDetails) – (required) Attach boot volume request
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type BootVolumeAttachment

Return type:

Response

Example:

Click here to see an example of how to use attach_boot_volume API.

attach_vnic(attach_vnic_details, **kwargs)

Creates a secondary VNIC and attaches it to the specified instance. For more information about secondary VNICs, see `Virtual Network Interface Cards (VNICs)`__.

Parameters:
  • attach_vnic_details (oci.core.models.AttachVnicDetails) – (required) Attach VNIC details.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VnicAttachment

Return type:

Response

Example:

Click here to see an example of how to use attach_vnic API.

attach_volume(attach_volume_details, **kwargs)

Attaches the specified storage volume to the specified instance.

Parameters:
  • attach_volume_details (oci.core.models.AttachVolumeDetails) – (required) Attach volume request
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VolumeAttachment

Return type:

Response

Example:

Click here to see an example of how to use attach_volume API.

capture_console_history(capture_console_history_details, **kwargs)

Captures the most recent serial console data (up to a megabyte) for the specified instance.

The CaptureConsoleHistory operation works with the other console history operations as described below.

1. Use CaptureConsoleHistory to request the capture of up to a megabyte of the most recent console history. This call returns a ConsoleHistory object. The object will have a state of REQUESTED. 2. Wait for the capture operation to succeed by polling GetConsoleHistory with the identifier of the console history metadata. The state of the ConsoleHistory object will go from REQUESTED to GETTING-HISTORY and then SUCCEEDED (or FAILED). 3. Use GetConsoleHistoryContent to get the actual console history data (not the metadata). 4. Optionally, use DeleteConsoleHistory to delete the console history metadata and the console history data.

Parameters:
  • capture_console_history_details (oci.core.models.CaptureConsoleHistoryDetails) – (required) Console history details
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ConsoleHistory

Return type:

Response

Example:

Click here to see an example of how to use capture_console_history API.

change_compute_capacity_reservation_compartment(capacity_reservation_id, change_compute_capacity_reservation_compartment_details, **kwargs)

Moves a compute capacity reservation into a different compartment. For information about moving resources between compartments, see `Moving Resources to a Different Compartment`__.

Parameters:
  • capacity_reservation_id (str) – (required) The OCID of the compute capacity reservation.
  • change_compute_capacity_reservation_compartment_details (oci.core.models.ChangeComputeCapacityReservationCompartmentDetails) – (required) The configuration details for the move operation.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_compute_capacity_reservation_compartment API.

change_compute_image_capability_schema_compartment(compute_image_capability_schema_id, change_compute_image_capability_schema_compartment_details, **kwargs)

Moves a compute image capability schema into a different compartment within the same tenancy. For information about moving resources between compartments, see

Parameters:
  • compute_image_capability_schema_id (str) – (required) The id of the compute image capability schema or the image ocid
  • change_compute_image_capability_schema_compartment_details (oci.core.models.ChangeComputeImageCapabilitySchemaCompartmentDetails) – (required) Compute Image Capability Schema change compartment details
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_compute_image_capability_schema_compartment API.

change_dedicated_vm_host_compartment(dedicated_vm_host_id, change_dedicated_vm_host_compartment_details, **kwargs)

Moves a dedicated virtual machine host from one compartment to another.

Parameters:
  • dedicated_vm_host_id (str) – (required) The OCID of the dedicated VM host.
  • change_dedicated_vm_host_compartment_details (oci.core.models.ChangeDedicatedVmHostCompartmentDetails) – (required) The request to move the dedicated virtual machine host to a different compartment.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_dedicated_vm_host_compartment API.

change_image_compartment(image_id, change_image_compartment_details, **kwargs)

Moves an image into a different compartment within the same tenancy. For information about moving resources between compartments, see `Moving Resources to a Different Compartment`__.

Parameters:
  • image_id (str) –

    (required) The `OCID`__ of the image.

  • change_image_compartment_details (oci.core.models.ChangeImageCompartmentDetails) – (required) Request to change the compartment of a given image.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_image_compartment API.

change_instance_compartment(instance_id, change_instance_compartment_details, **kwargs)

Moves an instance into a different compartment within the same tenancy. For information about moving resources between compartments, see `Moving Resources to a Different Compartment`__.

When you move an instance to a different compartment, associated resources such as boot volumes and VNICs are not moved.

Parameters:
  • instance_id (str) –

    (required) The `OCID`__ of the instance.

  • change_instance_compartment_details (oci.core.models.ChangeInstanceCompartmentDetails) – (required) Request to change the compartment of a given instance.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_instance_compartment API.

create_app_catalog_subscription(create_app_catalog_subscription_details, **kwargs)

Create a subscription for listing resource version for a compartment. It will take some time to propagate to all regions.

Parameters:
  • create_app_catalog_subscription_details (oci.core.models.CreateAppCatalogSubscriptionDetails) – (required) Request for the creation of a subscription for listing resource version for a compartment.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AppCatalogSubscription

Return type:

Response

Example:

Click here to see an example of how to use create_app_catalog_subscription API.

create_compute_capacity_reservation(create_compute_capacity_reservation_details, **kwargs)

Creates a new compute capacity reservation in the specified compartment and availability domain. Compute capacity reservations let you reserve instances in a compartment. When you launch an instance using this reservation, you are assured that you have enough space for your instance, and you won’t get out of capacity errors. For more information, see `Reserved Capacity`__.

Parameters:
  • create_compute_capacity_reservation_details (oci.core.models.CreateComputeCapacityReservationDetails) –

    (required) Details for creating a new compute capacity reservation.

    Caution: Avoid using any confidential information when you use the API to supply string values.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ComputeCapacityReservation

Return type:

Response

Example:

Click here to see an example of how to use create_compute_capacity_reservation API.

create_compute_image_capability_schema(create_compute_image_capability_schema_details, **kwargs)

Creates compute image capability schema.

Parameters:
  • create_compute_image_capability_schema_details (oci.core.models.CreateComputeImageCapabilitySchemaDetails) – (required) Compute Image Capability Schema creation details
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ComputeImageCapabilitySchema

Return type:

Response

Example:

Click here to see an example of how to use create_compute_image_capability_schema API.

create_dedicated_vm_host(create_dedicated_vm_host_details, **kwargs)

Creates a new dedicated virtual machine host in the specified compartment and the specified availability domain. Dedicated virtual machine hosts enable you to run your Compute virtual machine (VM) instances on dedicated servers that are a single tenant and not shared with other customers. For more information, see `Dedicated Virtual Machine Hosts`__.

Parameters:
  • create_dedicated_vm_host_details (oci.core.models.CreateDedicatedVmHostDetails) – (required) The details for creating a new dedicated virtual machine host.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DedicatedVmHost

Return type:

Response

Example:

Click here to see an example of how to use create_dedicated_vm_host API.

create_image(create_image_details, **kwargs)

Creates a boot disk image for the specified instance or imports an exported image from the Oracle Cloud Infrastructure Object Storage service.

When creating a new image, you must provide the OCID of the instance you want to use as the basis for the image, and the OCID of the compartment containing that instance. For more information about images, see `Managing Custom Images`__.

When importing an exported image from Object Storage, you specify the source information in image_source_details().

When importing an image based on the namespace, bucket name, and object name, use image_source_via_object_storage_tuple_details().

When importing an image based on the Object Storage URL, use image_source_via_object_storage_uri_details(). See `Object Storage URLs`__ and `Using Pre-Authenticated Requests`__ for constructing URLs for image import/export.

For more information about importing exported images, see `Image Import/Export`__.

You may optionally specify a display name for the image, which is simply a friendly name or description. It does not have to be unique, and you can change it. See update_image(). Avoid entering confidential information.

Parameters:
  • create_image_details (oci.core.models.CreateImageDetails) – (required) Image creation details
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Image

Return type:

Response

Example:

Click here to see an example of how to use create_image API.

create_instance_console_connection(create_instance_console_connection_details, **kwargs)

Creates a new console connection to the specified instance. After the console connection has been created and is available, you connect to the console using SSH.

For more information about instance console connections, see `Troubleshooting Instances Using Instance Console Connections`__.

Parameters:
  • create_instance_console_connection_details (oci.core.models.CreateInstanceConsoleConnectionDetails) – (required) Request object for creating an InstanceConsoleConnection
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type InstanceConsoleConnection

Return type:

Response

Example:

Click here to see an example of how to use create_instance_console_connection API.

delete_app_catalog_subscription(listing_id, compartment_id, resource_version, **kwargs)

Delete a subscription for a listing resource version for a compartment.

Parameters:
  • listing_id (str) – (required) The OCID of the listing.
  • compartment_id (str) –

    (required) The `OCID`__ of the compartment.

  • resource_version (str) – (required) Listing Resource Version.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_app_catalog_subscription API.

delete_compute_capacity_reservation(capacity_reservation_id, **kwargs)

Deletes the specified compute capacity reservation.

Parameters:
  • capacity_reservation_id (str) – (required) The OCID of the compute capacity reservation.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_compute_capacity_reservation API.

delete_compute_image_capability_schema(compute_image_capability_schema_id, **kwargs)

Deletes the specified Compute Image Capability Schema

Parameters:
  • compute_image_capability_schema_id (str) – (required) The id of the compute image capability schema or the image ocid
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_compute_image_capability_schema API.

delete_console_history(instance_console_history_id, **kwargs)

Deletes the specified console history metadata and the console history data.

Parameters:
  • instance_console_history_id (str) – (required) The OCID of the console history.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_console_history API.

delete_dedicated_vm_host(dedicated_vm_host_id, **kwargs)

Deletes the specified dedicated virtual machine host.

If any VM instances are assigned to the dedicated virtual machine host, the delete operation will fail and the service will return a 409 response code.

Parameters:
  • dedicated_vm_host_id (str) – (required) The OCID of the dedicated VM host.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_dedicated_vm_host API.

delete_image(image_id, **kwargs)

Deletes an image.

Parameters:
  • image_id (str) –

    (required) The `OCID`__ of the image.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_image API.

delete_instance_console_connection(instance_console_connection_id, **kwargs)

Deletes the specified instance console connection.

Parameters:
  • instance_console_connection_id (str) – (required) The OCID of the instance console connection.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_instance_console_connection API.

detach_boot_volume(boot_volume_attachment_id, **kwargs)

Detaches a boot volume from an instance. You must specify the OCID of the boot volume attachment.

This is an asynchronous operation. The attachment’s lifecycleState will change to DETACHING temporarily until the attachment is completely removed.

Parameters:
  • boot_volume_attachment_id (str) – (required) The OCID of the boot volume attachment.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use detach_boot_volume API.

detach_vnic(vnic_attachment_id, **kwargs)

Detaches and deletes the specified secondary VNIC. This operation cannot be used on the instance’s primary VNIC. When you terminate an instance, all attached VNICs (primary and secondary) are automatically detached and deleted.

Important: If the VNIC has a PrivateIp that is the `target of a route rule`__, deleting the VNIC causes that route rule to blackhole and the traffic will be dropped.

Parameters:
  • vnic_attachment_id (str) – (required) The OCID of the VNIC attachment.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use detach_vnic API.

detach_volume(volume_attachment_id, **kwargs)

Detaches a storage volume from an instance. You must specify the OCID of the volume attachment.

This is an asynchronous operation. The attachment’s lifecycleState will change to DETACHING temporarily until the attachment is completely removed.

Parameters:
  • volume_attachment_id (str) – (required) The OCID of the volume attachment.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use detach_volume API.

export_image(image_id, export_image_details, **kwargs)

Exports the specified image to the Oracle Cloud Infrastructure Object Storage service. You can use the Object Storage URL, or the namespace, bucket name, and object name when specifying the location to export to.

For more information about exporting images, see `Image Import/Export`__.

To perform an image export, you need write access to the Object Storage bucket for the image, see `Let Users Write Objects to Object Storage Buckets`__.

See `Object Storage URLs`__ and `Using Pre-Authenticated Requests`__ for constructing URLs for image import/export.

Parameters:
  • image_id (str) –

    (required) The `OCID`__ of the image.

  • export_image_details (oci.core.models.ExportImageDetails) – (required) Details for the image export.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Image

Return type:

Response

Example:

Click here to see an example of how to use export_image API.

get_app_catalog_listing(listing_id, **kwargs)

Gets the specified listing.

Parameters:
  • listing_id (str) – (required) The OCID of the listing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AppCatalogListing

Return type:

Response

Example:

Click here to see an example of how to use get_app_catalog_listing API.

get_app_catalog_listing_agreements(listing_id, resource_version, **kwargs)

Retrieves the agreements for a particular resource version of a listing.

Parameters:
  • listing_id (str) – (required) The OCID of the listing.
  • resource_version (str) – (required) Listing Resource Version.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AppCatalogListingResourceVersionAgreements

Return type:

Response

Example:

Click here to see an example of how to use get_app_catalog_listing_agreements API.

get_app_catalog_listing_resource_version(listing_id, resource_version, **kwargs)

Gets the specified listing resource version.

Parameters:
  • listing_id (str) – (required) The OCID of the listing.
  • resource_version (str) – (required) Listing Resource Version.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AppCatalogListingResourceVersion

Return type:

Response

Example:

Click here to see an example of how to use get_app_catalog_listing_resource_version API.

get_boot_volume_attachment(boot_volume_attachment_id, **kwargs)

Gets information about the specified boot volume attachment.

Parameters:
  • boot_volume_attachment_id (str) – (required) The OCID of the boot volume attachment.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type BootVolumeAttachment

Return type:

Response

Example:

Click here to see an example of how to use get_boot_volume_attachment API.

get_compute_capacity_reservation(capacity_reservation_id, **kwargs)

Gets information about the specified compute capacity reservation.

Parameters:
  • capacity_reservation_id (str) – (required) The OCID of the compute capacity reservation.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ComputeCapacityReservation

Return type:

Response

Example:

Click here to see an example of how to use get_compute_capacity_reservation API.

get_compute_global_image_capability_schema(compute_global_image_capability_schema_id, **kwargs)

Gets the specified Compute Global Image Capability Schema

Parameters:
  • compute_global_image_capability_schema_id (str) –

    (required) The `OCID`__ of the compute global image capability schema

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ComputeGlobalImageCapabilitySchema

Return type:

Response

Example:

Click here to see an example of how to use get_compute_global_image_capability_schema API.

get_compute_global_image_capability_schema_version(compute_global_image_capability_schema_id, compute_global_image_capability_schema_version_name, **kwargs)

Gets the specified Compute Global Image Capability Schema Version

Parameters:
  • compute_global_image_capability_schema_id (str) –

    (required) The `OCID`__ of the compute global image capability schema

  • compute_global_image_capability_schema_version_name (str) – (required) The name of the compute global image capability schema version
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ComputeGlobalImageCapabilitySchemaVersion

Return type:

Response

Example:

Click here to see an example of how to use get_compute_global_image_capability_schema_version API.

get_compute_image_capability_schema(compute_image_capability_schema_id, **kwargs)

Gets the specified Compute Image Capability Schema

Parameters:
  • compute_image_capability_schema_id (str) – (required) The id of the compute image capability schema or the image ocid
  • is_merge_enabled (bool) – (optional) Merge the image capability schema with the global image capability schema
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ComputeImageCapabilitySchema

Return type:

Response

Example:

Click here to see an example of how to use get_compute_image_capability_schema API.

get_console_history(instance_console_history_id, **kwargs)

Shows the metadata for the specified console history. See capture_console_history() for details about using the console history operations.

Parameters:
  • instance_console_history_id (str) – (required) The OCID of the console history.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ConsoleHistory

Return type:

Response

Example:

Click here to see an example of how to use get_console_history API.

get_console_history_content(instance_console_history_id, **kwargs)

Gets the actual console history data (not the metadata). See capture_console_history() for details about using the console history operations.

Parameters:
  • instance_console_history_id (str) – (required) The OCID of the console history.
  • offset (int) – (optional) Offset of the snapshot data to retrieve.
  • length (int) – (optional) Length of the snapshot data to retrieve.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type bytes

Return type:

Response

Example:

Click here to see an example of how to use get_console_history_content API.

get_dedicated_vm_host(dedicated_vm_host_id, **kwargs)

Gets information about the specified dedicated virtual machine host.

Parameters:
  • dedicated_vm_host_id (str) – (required) The OCID of the dedicated VM host.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DedicatedVmHost

Return type:

Response

Example:

Click here to see an example of how to use get_dedicated_vm_host API.

get_image(image_id, **kwargs)

Gets the specified image.

Parameters:
  • image_id (str) –

    (required) The `OCID`__ of the image.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Image

Return type:

Response

Example:

Click here to see an example of how to use get_image API.

get_image_shape_compatibility_entry(image_id, shape_name, **kwargs)

Retrieves an image shape compatibility entry.

Parameters:
  • image_id (str) –

    (required) The `OCID`__ of the image.

  • shape_name (str) – (required) Shape name.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ImageShapeCompatibilityEntry

Return type:

Response

Example:

Click here to see an example of how to use get_image_shape_compatibility_entry API.

get_instance(instance_id, **kwargs)

Gets information about the specified instance.

Parameters:
  • instance_id (str) –

    (required) The `OCID`__ of the instance.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Instance

Return type:

Response

Example:

Click here to see an example of how to use get_instance API.

get_instance_console_connection(instance_console_connection_id, **kwargs)

Gets the specified instance console connection’s information.

Parameters:
  • instance_console_connection_id (str) – (required) The OCID of the instance console connection.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type InstanceConsoleConnection

Return type:

Response

Example:

Click here to see an example of how to use get_instance_console_connection API.

get_vnic_attachment(vnic_attachment_id, **kwargs)

Gets the information for the specified VNIC attachment.

Parameters:
  • vnic_attachment_id (str) – (required) The OCID of the VNIC attachment.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VnicAttachment

Return type:

Response

Example:

Click here to see an example of how to use get_vnic_attachment API.

get_volume_attachment(volume_attachment_id, **kwargs)

Gets information about the specified volume attachment.

Parameters:
  • volume_attachment_id (str) – (required) The OCID of the volume attachment.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VolumeAttachment

Return type:

Response

Example:

Click here to see an example of how to use get_volume_attachment API.

get_windows_instance_initial_credentials(instance_id, **kwargs)

Gets the generated credentials for the instance. Only works for instances that require a password to log in, such as Windows. For certain operating systems, users will be forced to change the initial credentials.

Parameters:
  • instance_id (str) –

    (required) The `OCID`__ of the instance.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type InstanceCredentials

Return type:

Response

Example:

Click here to see an example of how to use get_windows_instance_initial_credentials API.

instance_action(instance_id, action, **kwargs)

Performs one of the following power actions on the specified instance:

  • START - Powers on the instance.
  • STOP - Powers off the instance.
  • RESET - Powers off the instance and then powers it back on.
  • SOFTSTOP - Gracefully shuts down the instance by sending a shutdown command to the operating system.

After waiting 15 minutes for the OS to shut down, the instance is powered off. If the applications that run on the instance take more than 15 minutes to shut down, they could be improperly stopped, resulting in data corruption. To avoid this, manually shut down the instance using the commands available in the OS before you softstop the instance.

  • SOFTRESET - Gracefully reboots the instance by sending a shutdown command to the operating system.

After waiting 15 minutes for the OS to shut down, the instance is powered off and then powered back on.

  • SENDDIAGNOSTICINTERRUPT - For advanced users. **Warning: Sending a diagnostic interrupt to a live system can

cause data corruption or system failure.** Sends a diagnostic interrupt that causes the instance’s OS to crash and then reboot. Before you send a diagnostic interrupt, you must configure the instance to generate a crash dump file when it crashes. The crash dump captures information about the state of the OS at the time of the crash. After the OS restarts, you can analyze the crash dump to diagnose the issue. For more information, see `Sending a Diagnostic Interrupt`__.

For more information about managing instance lifecycle states, see `Stopping and Starting an Instance`__.

Parameters:
  • instance_id (str) –

    (required) The `OCID`__ of the instance.

  • action (str) –

    (required) The action to perform on the instance.

    Allowed values are: “STOP”, “START”, “SOFTRESET”, “RESET”, “SOFTSTOP”, “SENDDIAGNOSTICINTERRUPT”

  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Instance

Return type:

Response

Example:

Click here to see an example of how to use instance_action API.

launch_instance(launch_instance_details, **kwargs)

Creates a new instance in the specified compartment and the specified availability domain. For general information about instances, see `Overview of the Compute Service`__.

For information about access control and compartments, see `Overview of the IAM Service`__.

For information about availability domains, see `Regions and Availability Domains`__. To get a list of availability domains, use the ListAvailabilityDomains operation in the Identity and Access Management Service API.

All Oracle Cloud Infrastructure resources, including instances, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource’s OCID by using a List API operation on that resource type, or by viewing the resource in the Console.

To launch an instance using an image or a boot volume use the sourceDetails parameter in LaunchInstanceDetails.

When you launch an instance, it is automatically attached to a virtual network interface card (VNIC), called the primary VNIC. The VNIC has a private IP address from the subnet’s CIDR. You can either assign a private IP address of your choice or let Oracle automatically assign one. You can choose whether the instance has a public IP address. To retrieve the addresses, use the list_vnic_attachments() operation to get the VNIC ID for the instance, and then call get_vnic() with the VNIC ID.

You can later add secondary VNICs to an instance. For more information, see `Virtual Network Interface Cards (VNICs)`__.

To launch an instance from a Marketplace image listing, you must provide the image ID of the listing resource version that you want, but you also must subscribe to the listing before you try to launch the instance. To subscribe to the listing, use the get_app_catalog_listing_agreements() operation to get the signature for the terms of use agreement for the desired listing resource version. Then, call create_app_catalog_subscription() with the signature. To get the image ID for the LaunchInstance operation, call get_app_catalog_listing_resource_version().

Parameters:
  • launch_instance_details (oci.core.models.LaunchInstanceDetails) – (required) Instance details
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Instance

Return type:

Response

Example:

Click here to see an example of how to use launch_instance API.

list_app_catalog_listing_resource_versions(listing_id, **kwargs)

Gets all resource versions for a particular listing.

Parameters:
  • listing_id (str) – (required) The OCID of the listing.
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AppCatalogListingResourceVersionSummary

Return type:

Response

Example:

Click here to see an example of how to use list_app_catalog_listing_resource_versions API.

list_app_catalog_listings(**kwargs)

Lists the published listings.

Parameters:
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • publisher_name (str) – (optional) A filter to return only the publisher that matches the given publisher name exactly.
  • publisher_type (str) – (optional) A filter to return only publishers that match the given publisher type exactly. Valid types are OCI, ORACLE, TRUSTED, STANDARD.
  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AppCatalogListingSummary

Return type:

Response

Example:

Click here to see an example of how to use list_app_catalog_listings API.

list_app_catalog_subscriptions(compartment_id, **kwargs)

Lists subscriptions for a compartment.

Parameters:
  • compartment_id (str) –

    (required) The `OCID`__ of the compartment.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • listing_id (str) – (optional) A filter to return only the listings that matches the given listing id.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AppCatalogSubscriptionSummary

Return type:

Response

Example:

Click here to see an example of how to use list_app_catalog_subscriptions API.

list_boot_volume_attachments(availability_domain, compartment_id, **kwargs)

Lists the boot volume attachments in the specified compartment. You can filter the list by specifying an instance OCID, boot volume OCID, or both.

Parameters:
  • availability_domain (str) –

    (required) The name of the availability domain.

    Example: Uocm:PHX-AD-1

  • compartment_id (str) –

    (required) The `OCID`__ of the compartment.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • instance_id (str) – (optional) The OCID of the instance.
  • boot_volume_id (str) – (optional) The OCID of the boot volume.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of BootVolumeAttachment

Return type:

Response

Example:

Click here to see an example of how to use list_boot_volume_attachments API.

list_compute_capacity_reservation_instance_shapes(compartment_id, **kwargs)

Lists the shapes that can be reserved within the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The `OCID`__ of the compartment.

  • availability_domain (str) –

    (optional) The name of the availability domain.

    Example: Uocm:PHX-AD-1

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ComputeCapacityReservationInstanceShapeSummary

Return type:

Response

Example:

Click here to see an example of how to use list_compute_capacity_reservation_instance_shapes API.

list_compute_capacity_reservation_instances(capacity_reservation_id, **kwargs)

Lists the instances launched under a capacity reservation. You can filter results by specifying criteria.

Parameters:
  • capacity_reservation_id (str) – (required) The OCID of the compute capacity reservation.
  • availability_domain (str) –

    (optional) The name of the availability domain.

    Example: Uocm:PHX-AD-1

  • compartment_id (str) –

    (optional) The `OCID`__ of the compartment.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of CapacityReservationInstanceSummary

Return type:

Response

Example:

Click here to see an example of how to use list_compute_capacity_reservation_instances API.

list_compute_capacity_reservations(compartment_id, **kwargs)

Lists the compute capacity reservations that match the specified criteria and compartment.

You can limit the list by specifying a compute capacity reservation display name (the list will include all the identically-named compute capacity reservations in the compartment).

Parameters:
  • compartment_id (str) –

    (required) The `OCID`__ of the compartment.

  • availability_domain (str) –

    (optional) The name of the availability domain.

    Example: Uocm:PHX-AD-1

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state.

    Allowed values are: “ACTIVE”, “CREATING”, “UPDATING”, “MOVING”, “DELETED”, “DELETING”

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ComputeCapacityReservationSummary

Return type:

Response

Example:

Click here to see an example of how to use list_compute_capacity_reservations API.

list_compute_global_image_capability_schema_versions(compute_global_image_capability_schema_id, **kwargs)

Lists Compute Global Image Capability Schema versions in the specified compartment.

Parameters:
  • compute_global_image_capability_schema_id (str) –

    (required) The `OCID`__ of the compute global image capability schema

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ComputeGlobalImageCapabilitySchemaVersionSummary

Return type:

Response

Example:

Click here to see an example of how to use list_compute_global_image_capability_schema_versions API.

list_compute_global_image_capability_schemas(**kwargs)

Lists Compute Global Image Capability Schema in the specified compartment.

Parameters:
  • compartment_id (str) – (optional) A filter to return only resources that match the given compartment OCID exactly.
  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ComputeGlobalImageCapabilitySchemaSummary

Return type:

Response

Example:

Click here to see an example of how to use list_compute_global_image_capability_schemas API.

list_compute_image_capability_schemas(**kwargs)

Lists Compute Image Capability Schema in the specified compartment. You can also query by a specific imageId.

Parameters:
  • compartment_id (str) – (optional) A filter to return only resources that match the given compartment OCID exactly.
  • image_id (str) –

    (optional) The `OCID`__ of an image.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ComputeImageCapabilitySchemaSummary

Return type:

Response

Example:

Click here to see an example of how to use list_compute_image_capability_schemas API.

list_console_histories(compartment_id, **kwargs)

Lists the console history metadata for the specified compartment or instance.

Parameters:
  • compartment_id (str) –

    (required) The `OCID`__ of the compartment.

  • availability_domain (str) –

    (optional) The name of the availability domain.

    Example: Uocm:PHX-AD-1

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • instance_id (str) – (optional) The OCID of the instance.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “REQUESTED”, “GETTING-HISTORY”, “SUCCEEDED”, “FAILED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ConsoleHistory

Return type:

Response

Example:

Click here to see an example of how to use list_console_histories API.

list_dedicated_vm_host_instance_shapes(compartment_id, **kwargs)

Lists the shapes that can be used to launch a virtual machine instance on a dedicated virtual machine host within the specified compartment. You can filter the list by compatibility with a specific dedicated virtual machine host shape.

Parameters:
  • compartment_id (str) –

    (required) The `OCID`__ of the compartment.

  • availability_domain (str) –

    (optional) The name of the availability domain.

    Example: Uocm:PHX-AD-1

  • dedicated_vm_host_shape (str) – (optional) Dedicated VM host shape name
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DedicatedVmHostInstanceShapeSummary

Return type:

Response

Example:

Click here to see an example of how to use list_dedicated_vm_host_instance_shapes API.

list_dedicated_vm_host_instances(compartment_id, dedicated_vm_host_id, **kwargs)

Returns the list of instances on the dedicated virtual machine hosts that match the specified criteria.

Parameters:
  • compartment_id (str) –

    (required) The `OCID`__ of the compartment.

  • dedicated_vm_host_id (str) – (required) The OCID of the dedicated VM host.
  • availability_domain (str) –

    (optional) The name of the availability domain.

    Example: Uocm:PHX-AD-1

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DedicatedVmHostInstanceSummary

Return type:

Response

Example:

Click here to see an example of how to use list_dedicated_vm_host_instances API.

list_dedicated_vm_host_shapes(compartment_id, **kwargs)

Lists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The `OCID`__ of the compartment.

  • availability_domain (str) –

    (optional) The name of the availability domain.

    Example: Uocm:PHX-AD-1

  • instance_shape_name (str) – (optional) The name for the instance’s shape.
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DedicatedVmHostShapeSummary

Return type:

Response

Example:

Click here to see an example of how to use list_dedicated_vm_host_shapes API.

list_dedicated_vm_hosts(compartment_id, **kwargs)

Returns the list of dedicated virtual machine hosts that match the specified criteria in the specified compartment.

You can limit the list by specifying a dedicated virtual machine host display name. The list will include all the identically-named dedicated virtual machine hosts in the compartment.

Parameters:
  • compartment_id (str) –

    (required) The `OCID`__ of the compartment.

  • availability_domain (str) –

    (optional) The name of the availability domain.

    Example: Uocm:PHX-AD-1

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state.

    Allowed values are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • instance_shape_name (str) – (optional) The name for the instance’s shape.
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • remaining_memory_in_gbs_greater_than_or_equal_to (float) – (optional) The remaining memory of the dedicated VM host, in GBs.
  • remaining_ocpus_greater_than_or_equal_to (float) – (optional) The available OCPUs of the dedicated VM host.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DedicatedVmHostSummary

Return type:

Response

Example:

Click here to see an example of how to use list_dedicated_vm_hosts API.

list_image_shape_compatibility_entries(image_id, **kwargs)

Lists the compatible shapes for the specified image.

Parameters:
  • image_id (str) –

    (required) The `OCID`__ of the image.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ImageShapeCompatibilitySummary

Return type:

Response

Example:

Click here to see an example of how to use list_image_shape_compatibility_entries API.

list_images(compartment_id, **kwargs)

Lists the available images in the specified compartment, including `platform images`__ and `custom images`__ that have been created.

The list of images that’s returned is ordered to first show all platform images, then all custom images. The order of images might change when new images are released.

Parameters:
  • compartment_id (str) –

    (required) The `OCID`__ of the compartment.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • operating_system (str) –

    (optional) The image’s operating system.

    Example: Oracle Linux

  • operating_system_version (str) –

    (optional) The image’s operating system version.

    Example: 7.2

  • shape (str) – (optional) Shape name.
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “PROVISIONING”, “IMPORTING”, “AVAILABLE”, “EXPORTING”, “DISABLED”, “DELETED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of Image

Return type:

Response

Example:

Click here to see an example of how to use list_images API.

list_instance_console_connections(compartment_id, **kwargs)

Lists the console connections for the specified compartment or instance.

For more information about instance console connections, see `Troubleshooting Instances Using Instance Console Connections`__.

Parameters:
  • compartment_id (str) –

    (required) The `OCID`__ of the compartment.

  • instance_id (str) – (optional) The OCID of the instance.
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of InstanceConsoleConnection

Return type:

Response

Example:

Click here to see an example of how to use list_instance_console_connections API.

list_instance_devices(instance_id, **kwargs)

Gets a list of all the devices for given instance. You can optionally filter results by device availability.

Parameters:
  • instance_id (str) –

    (required) The `OCID`__ of the instance.

  • is_available (bool) – (optional) A filter to return only available devices or only used devices.
  • name (str) – (optional) A filter to return only devices that match the given name exactly.
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of Device

Return type:

Response

Example:

Click here to see an example of how to use list_instance_devices API.

list_instances(compartment_id, **kwargs)

Lists the instances in the specified compartment and the specified availability domain. You can filter the results by specifying an instance name (the list will include all the identically-named instances in the compartment).

Parameters:
  • compartment_id (str) –

    (required) The `OCID`__ of the compartment.

  • availability_domain (str) –

    (optional) The name of the availability domain.

    Example: Uocm:PHX-AD-1

  • capacity_reservation_id (str) – (optional) The OCID of the compute capacity reservation.
  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “MOVING”, “PROVISIONING”, “RUNNING”, “STARTING”, “STOPPING”, “STOPPED”, “CREATING_IMAGE”, “TERMINATING”, “TERMINATED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of Instance

Return type:

Response

Example:

Click here to see an example of how to use list_instances API.

list_shapes(compartment_id, **kwargs)

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

Parameters:
  • compartment_id (str) –

    (required) The `OCID`__ of the compartment.

  • availability_domain (str) –

    (optional) The name of the availability domain.

    Example: Uocm:PHX-AD-1

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • image_id (str) –

    (optional) The `OCID`__ of an image.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of Shape

Return type:

Response

Example:

Click here to see an example of how to use list_shapes API.

list_vnic_attachments(compartment_id, **kwargs)

Lists the VNIC attachments in the specified compartment. A VNIC attachment resides in the same compartment as the attached instance. The list can be filtered by instance, VNIC, or availability domain.

Parameters:
  • compartment_id (str) –

    (required) The `OCID`__ of the compartment.

  • availability_domain (str) –

    (optional) The name of the availability domain.

    Example: Uocm:PHX-AD-1

  • instance_id (str) – (optional) The OCID of the instance.
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • vnic_id (str) – (optional) The OCID of the VNIC.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of VnicAttachment

Return type:

Response

Example:

Click here to see an example of how to use list_vnic_attachments API.

list_volume_attachments(compartment_id, **kwargs)

Lists the volume attachments in the specified compartment. You can filter the list by specifying an instance OCID, volume OCID, or both.

Currently, the only supported volume attachment type are IScsiVolumeAttachment and ParavirtualizedVolumeAttachment.

Parameters:
  • compartment_id (str) –

    (required) The `OCID`__ of the compartment.

  • availability_domain (str) –

    (optional) The name of the availability domain.

    Example: Uocm:PHX-AD-1

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see `List Pagination`__.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see `List Pagination`__.

  • instance_id (str) – (optional) The OCID of the instance.
  • volume_id (str) – (optional) The OCID of the volume.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of VolumeAttachment

Return type:

Response

Example:

Click here to see an example of how to use list_volume_attachments API.

remove_image_shape_compatibility_entry(image_id, shape_name, **kwargs)

Removes a shape from the compatible shapes list for the image.

Parameters:
  • image_id (str) –

    (required) The `OCID`__ of the image.

  • shape_name (str) – (required) Shape name.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use remove_image_shape_compatibility_entry API.

terminate_instance(instance_id, **kwargs)

Terminates the specified instance. Any attached VNICs and volumes are automatically detached when the instance terminates.

To preserve the boot volume associated with the instance, specify true for PreserveBootVolumeQueryParam. To delete the boot volume when the instance is deleted, specify false or do not specify a value for PreserveBootVolumeQueryParam.

This is an asynchronous operation. The instance’s lifecycleState will change to TERMINATING temporarily until the instance is completely removed.

Parameters:
  • instance_id (str) –

    (required) The `OCID`__ of the instance.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • preserve_boot_volume (bool) – (optional) Specifies whether to delete or preserve the boot volume when terminating an instance. The default value is false.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use terminate_instance API.

update_compute_capacity_reservation(capacity_reservation_id, update_compute_capacity_reservation_details, **kwargs)

Updates the display name, defined tag, and freeform tag fields for the specified compute capacity reservation. Fields that are not provided in the request will not be updated. Avoid entering confidential information.

The update also modifies the reservation configurations of the specified compute capacity reservation.

Parameters:
  • capacity_reservation_id (str) – (required) The OCID of the compute capacity reservation.
  • update_compute_capacity_reservation_details (oci.core.models.UpdateComputeCapacityReservationDetails) – (required) Update compute capacity reservation details.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_compute_capacity_reservation API.

update_compute_image_capability_schema(compute_image_capability_schema_id, update_compute_image_capability_schema_details, **kwargs)

Updates the specified Compute Image Capability Schema

Parameters:
  • compute_image_capability_schema_id (str) – (required) The id of the compute image capability schema or the image ocid
  • update_compute_image_capability_schema_details (oci.core.models.UpdateComputeImageCapabilitySchemaDetails) – (required) Updates the freeFormTags, definedTags, and display name of the image capability schema
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ComputeImageCapabilitySchema

Return type:

Response

Example:

Click here to see an example of how to use update_compute_image_capability_schema API.

update_console_history(instance_console_history_id, update_console_history_details, **kwargs)

Updates the specified console history metadata.

Parameters:
  • instance_console_history_id (str) – (required) The OCID of the console history.
  • update_console_history_details (oci.core.models.UpdateConsoleHistoryDetails) – (required) Update instance fields
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ConsoleHistory

Return type:

Response

Example:

Click here to see an example of how to use update_console_history API.

update_dedicated_vm_host(dedicated_vm_host_id, update_dedicated_vm_host_details, **kwargs)

Updates the displayName, freeformTags, and definedTags attributes for the specified dedicated virtual machine host. If an attribute value is not included, it will not be updated.

Parameters:
  • dedicated_vm_host_id (str) – (required) The OCID of the dedicated VM host.
  • update_dedicated_vm_host_details (oci.core.models.UpdateDedicatedVmHostDetails) – (required) Update dedicated VM host details
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DedicatedVmHost

Return type:

Response

Example:

Click here to see an example of how to use update_dedicated_vm_host API.

update_image(image_id, update_image_details, **kwargs)

Updates the display name of the image. Avoid entering confidential information.

Parameters:
  • image_id (str) –

    (required) The `OCID`__ of the image.

  • update_image_details (oci.core.models.UpdateImageDetails) – (required) Updates the image display name field. Avoid entering confidential information.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Image

Return type:

Response

Example:

Click here to see an example of how to use update_image API.

update_instance(instance_id, update_instance_details, **kwargs)

Updates certain fields on the specified instance. Fields that are not provided in the request will not be updated. Avoid entering confidential information.

Changes to metadata fields will be reflected in the instance metadata service (this may take up to a minute).

The OCID of the instance remains the same.

Parameters:
  • instance_id (str) –

    (required) The `OCID`__ of the instance.

  • update_instance_details (oci.core.models.UpdateInstanceDetails) – (required) Update instance fields
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Instance

Return type:

Response

Example:

Click here to see an example of how to use update_instance API.

update_instance_console_connection(instance_console_connection_id, update_instance_console_connection_details, **kwargs)

Updates the defined tags and free-form tags for the specified instance console connection.

Parameters:
  • instance_console_connection_id (str) – (required) The OCID of the instance console connection.
  • update_instance_console_connection_details (oci.core.models.UpdateInstanceConsoleConnectionDetails) – (required) Update instanceConsoleConnection tags
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type InstanceConsoleConnection

Return type:

Response

Example:

Click here to see an example of how to use update_instance_console_connection API.

update_volume_attachment(volume_attachment_id, update_volume_attachment_details, **kwargs)

Updates information about the specified volume attachment.

Parameters:
  • volume_attachment_id (str) – (required) The OCID of the volume attachment.
  • update_volume_attachment_details (oci.core.models.UpdateVolumeAttachmentDetails) – (required) Update information about the specified volume attachment.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VolumeAttachment

Return type:

Response

Example:

Click here to see an example of how to use update_volume_attachment API.