ComputeManagementClient

class oci.core.ComputeManagementClient(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
attach_instance_pool_instance(…) Attaches an instance to an instance pool.
attach_load_balancer(instance_pool_id, …) Attach a load balancer to the instance pool.
change_cluster_network_compartment(…) Moves a cluster network into a different compartment within the same tenancy.
change_instance_configuration_compartment(…) Moves an instance configuration into a different compartment within the same tenancy.
change_instance_pool_compartment(…) Moves an instance pool into a different compartment within the same tenancy.
create_cluster_network(…) Creates a cluster network.
create_instance_configuration(…) Creates an instance configuration.
create_instance_pool(…) Create an instance pool.
delete_instance_configuration(…) Deletes an instance configuration.
detach_instance_pool_instance(…) Detaches an instance from an instance pool.
detach_load_balancer(instance_pool_id, …) Detach a load balancer from the instance pool.
get_cluster_network(cluster_network_id, **kwargs) Gets information about the specified cluster network.
get_instance_configuration(…) Gets the specified instance configuration
get_instance_pool(instance_pool_id, **kwargs) Gets the specified instance pool
get_instance_pool_instance(instance_pool_id, …) Gets information about an instance that belongs to an instance pool.
get_instance_pool_load_balancer_attachment(…) Gets information about a load balancer that is attached to the specified instance pool.
launch_instance_configuration(…) Launches an instance from an instance configuration.
list_cluster_network_instances(…) Lists the instances in the specified cluster network.
list_cluster_networks(compartment_id, **kwargs) Lists the cluster networks in the specified compartment.
list_instance_configurations(compartment_id, …) Lists the instance configurations in the specified compartment.
list_instance_pool_instances(compartment_id, …) List the instances in the specified instance pool.
list_instance_pools(compartment_id, **kwargs) Lists the instance pools in the specified compartment.
reset_instance_pool(instance_pool_id, **kwargs) Performs the reset (immediate power off and power on) action on the specified instance pool, which performs the action on all the instances in the pool.
softreset_instance_pool(instance_pool_id, …) Performs the softreset (ACPI shutdown and power on) action on the specified instance pool, which performs the action on all the instances in the pool.
start_instance_pool(instance_pool_id, **kwargs) Performs the start (power on) action on the specified instance pool, which performs the action on all the instances in the pool.
stop_instance_pool(instance_pool_id, **kwargs) Performs the stop (immediate power off) action on the specified instance pool, which performs the action on all the instances in the pool.
terminate_cluster_network(…) Terminates the specified cluster network.
terminate_instance_pool(instance_pool_id, …) Terminate the specified instance pool.
update_cluster_network(cluster_network_id, …) Updates the specified cluster network.
update_instance_configuration(…) Updates the free-form tags, defined tags, and display name of an instance configuration.
update_instance_pool(instance_pool_id, …) Update the specified instance pool.
__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.

  • circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client will not have circuit breakers enabled by default, users can use their own circuit breaker strategy or the convenient DEFAULT_CIRCUIT_BREAKER_STRATEGY provided by the SDK to enable it. The specifics of circuit breaker strategy are described here.
  • circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
attach_instance_pool_instance(instance_pool_id, attach_instance_pool_instance_details, **kwargs)

Attaches an instance to an instance pool. For information about the prerequisites that an instance must meet before you can attach it to a pool, see Attaching an Instance to an Instance Pool.

Parameters:
  • instance_pool_id (str) –

    (required) The OCID of the instance pool.

  • attach_instance_pool_instance_details (oci.core.models.AttachInstancePoolInstanceDetails) – (required) Attach an instance to a pool
  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 InstancePoolInstance

Return type:

Response

Example:

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

attach_load_balancer(instance_pool_id, attach_load_balancer_details, **kwargs)

Attach a load balancer to the instance pool.

Parameters:
  • instance_pool_id (str) –

    (required) The OCID of the instance pool.

  • attach_load_balancer_details (oci.core.models.AttachLoadBalancerDetails) – (required) Load balancer being attached
  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 InstancePool

Return type:

Response

Example:

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

change_cluster_network_compartment(cluster_network_id, change_cluster_network_compartment_details, **kwargs)

Moves a cluster network 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 a cluster network to a different compartment, associated resources such as the instances in the cluster network, boot volumes, and VNICs are not moved.

Parameters:
  • cluster_network_id (str) –

    (required) The OCID of the cluster network.

  • change_cluster_network_compartment_details (oci.core.models.ChangeClusterNetworkCompartmentDetails) – (required) Request to change the compartment of given cluster network.
  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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_cluster_network_compartment API.

change_instance_configuration_compartment(instance_configuration_id, change_instance_configuration_compartment_details, **kwargs)

Moves an instance configuration 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 configuration to a different compartment, associated resources such as instance pools are not moved.

Important: Most of the properties for an existing instance configuration, including the compartment, cannot be modified after you create the instance configuration. Although you can move an instance configuration to a different compartment, you will not be able to use the instance configuration to manage instance pools in the new compartment. If you want to update an instance configuration to point to a different compartment, you should instead create a new instance configuration in the target compartment using CreateInstanceConfiguration.

Parameters:
  • instance_configuration_id (str) – (required) The OCID of the instance configuration.
  • change_instance_configuration_compartment_details (oci.core.models.ChangeInstanceConfigurationCompartmentDetails) – (required) Request to change the compartment of given instance configuration.
  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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_configuration_compartment API.

change_instance_pool_compartment(instance_pool_id, change_instance_pool_compartment_details, **kwargs)

Moves an instance pool 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 pool to a different compartment, associated resources such as the instances in the pool, boot volumes, VNICs, and autoscaling configurations are not moved.

Parameters:
  • instance_pool_id (str) –

    (required) The OCID of the instance pool.

  • change_instance_pool_compartment_details (oci.core.models.ChangeInstancePoolCompartmentDetails) – (required) Request to change the compartment of given instance pool.
  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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_pool_compartment API.

create_cluster_network(create_cluster_network_details, **kwargs)

Creates a cluster network. For more information about cluster networks, see Managing Cluster Networks.

Parameters:
  • create_cluster_network_details (oci.core.models.CreateClusterNetworkDetails) – (required) Cluster network 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 ClusterNetwork

Return type:

Response

Example:

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

create_instance_configuration(create_instance_configuration, **kwargs)

Creates an instance configuration. An instance configuration is a template that defines the settings to use when creating Compute instances.

Parameters:
  • create_instance_configuration (oci.core.models.CreateInstanceConfigurationBase) – (required) Instance configuration 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 InstanceConfiguration

Return type:

Response

Example:

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

create_instance_pool(create_instance_pool_details, **kwargs)

Create an instance pool.

Parameters:
  • create_instance_pool_details (oci.core.models.CreateInstancePoolDetails) – (required) Instance pool 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 InstancePool

Return type:

Response

Example:

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

delete_instance_configuration(instance_configuration_id, **kwargs)

Deletes an instance configuration.

Parameters:
  • instance_configuration_id (str) – (required) The OCID of the instance configuration.
  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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_configuration API.

detach_instance_pool_instance(instance_pool_id, detach_instance_pool_instance_details, **kwargs)

Detaches an instance from an instance pool.

Parameters:
  • instance_pool_id (str) –

    (required) The OCID of the instance pool.

  • detach_instance_pool_instance_details (oci.core.models.DetachInstancePoolInstanceDetails) – (required) Instance being detached
  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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_instance_pool_instance API.

detach_load_balancer(instance_pool_id, detach_load_balancer_details, **kwargs)

Detach a load balancer from the instance pool.

Parameters:
  • instance_pool_id (str) –

    (required) The OCID of the instance pool.

  • detach_load_balancer_details (oci.core.models.DetachLoadBalancerDetails) – (required) Load balancer being detached
  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 InstancePool

Return type:

Response

Example:

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

get_cluster_network(cluster_network_id, **kwargs)

Gets information about the specified cluster network.

Parameters:
  • cluster_network_id (str) –

    (required) The OCID of the cluster network.

  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 ClusterNetwork

Return type:

Response

Example:

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

get_instance_configuration(instance_configuration_id, **kwargs)

Gets the specified instance configuration

Parameters:
  • instance_configuration_id (str) – (required) The OCID of the instance configuration.
  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 InstanceConfiguration

Return type:

Response

Example:

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

get_instance_pool(instance_pool_id, **kwargs)

Gets the specified instance pool

Parameters:
  • instance_pool_id (str) –

    (required) The OCID of the instance pool.

  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 InstancePool

Return type:

Response

Example:

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

get_instance_pool_instance(instance_pool_id, instance_id, **kwargs)

Gets information about an instance that belongs to an instance pool.

Parameters:
  • instance_pool_id (str) –

    (required) The OCID of the instance pool.

  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 InstancePoolInstance

Return type:

Response

Example:

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

get_instance_pool_load_balancer_attachment(instance_pool_id, instance_pool_load_balancer_attachment_id, **kwargs)

Gets information about a load balancer that is attached to the specified instance pool.

Parameters:
  • instance_pool_id (str) –

    (required) The OCID of the instance pool.

  • instance_pool_load_balancer_attachment_id (str) – (required) The OCID of the load balancer 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 InstancePoolLoadBalancerAttachment

Return type:

Response

Example:

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

launch_instance_configuration(instance_configuration_id, instance_configuration, **kwargs)

Launches an instance from an instance configuration.

If the instance configuration does not include all of the parameters that are required to launch an instance, such as the availability domain and subnet ID, you must provide these parameters when you launch an instance from the instance configuration. For more information, see the InstanceConfiguration resource.

Parameters:
  • instance_configuration_id (str) – (required) The OCID of the instance configuration.
  • instance_configuration (oci.core.models.InstanceConfigurationInstanceDetails) – (required) Instance configuration 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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_configuration API.

list_cluster_network_instances(compartment_id, cluster_network_id, **kwargs)

Lists the instances in the specified cluster network.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • cluster_network_id (str) –

    (required) The OCID of the cluster network.

  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 InstanceSummary

Return type:

Response

Example:

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

list_cluster_networks(compartment_id, **kwargs)

Lists the cluster networks in the specified compartment.

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.
  • 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”, “SCALING”, “STARTING”, “STOPPING”, “TERMINATING”, “STOPPED”, “TERMINATED”, “RUNNING”

  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 ClusterNetworkSummary

Return type:

Response

Example:

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

list_instance_configurations(compartment_id, **kwargs)

Lists the instance configurations in the specified 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”

  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 InstanceConfigurationSummary

Return type:

Response

Example:

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

list_instance_pool_instances(compartment_id, instance_pool_id, **kwargs)

List the instances in the specified instance pool.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • instance_pool_id (str) –

    (required) The OCID of the instance pool.

  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 InstanceSummary

Return type:

Response

Example:

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

list_instance_pools(compartment_id, **kwargs)

Lists the instance pools in the specified compartment.

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.
  • 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”, “SCALING”, “STARTING”, “STOPPING”, “TERMINATING”, “STOPPED”, “TERMINATED”, “RUNNING”

  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 InstancePoolSummary

Return type:

Response

Example:

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

reset_instance_pool(instance_pool_id, **kwargs)

Performs the reset (immediate power off and power on) action on the specified instance pool, which performs the action on all the instances in the pool.

Parameters:
  • instance_pool_id (str) –

    (required) The OCID of the instance pool.

  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 InstancePool

Return type:

Response

Example:

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

softreset_instance_pool(instance_pool_id, **kwargs)

Performs the softreset (ACPI shutdown and power on) action on the specified instance pool, which performs the action on all the instances in the pool.

Softreset gracefully reboots the instances by sending a shutdown command to the operating systems. After waiting 15 minutes for the OS to shut down, the instances are powered off and then powered back on.

Parameters:
  • instance_pool_id (str) –

    (required) The OCID of the instance pool.

  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 InstancePool

Return type:

Response

Example:

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

start_instance_pool(instance_pool_id, **kwargs)

Performs the start (power on) action on the specified instance pool, which performs the action on all the instances in the pool.

Parameters:
  • instance_pool_id (str) –

    (required) The OCID of the instance pool.

  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 InstancePool

Return type:

Response

Example:

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

stop_instance_pool(instance_pool_id, **kwargs)

Performs the stop (immediate power off) action on the specified instance pool, which performs the action on all the instances in the pool.

Parameters:
  • instance_pool_id (str) –

    (required) The OCID of the instance pool.

  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 InstancePool

Return type:

Response

Example:

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

terminate_cluster_network(cluster_network_id, **kwargs)

Terminates the specified cluster network.

When you delete a cluster network, all of its resources are permanently deleted, including associated instances and instance pools.

Parameters:
  • cluster_network_id (str) –

    (required) The OCID of the cluster network.

  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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_cluster_network API.

terminate_instance_pool(instance_pool_id, **kwargs)

Terminate the specified instance pool.

Warning: When you delete an instance pool, the resources that were created by the pool are permanently deleted, including associated instances, attached boot volumes, and block volumes.

If an autoscaling configuration applies to the instance pool, the autoscaling configuration will be deleted asynchronously after the pool is deleted. You can also manually delete the autoscaling configuration using the DeleteAutoScalingConfiguration operation in the Autoscaling API.

Parameters:
  • instance_pool_id (str) –

    (required) The OCID of the instance pool.

  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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_pool API.

update_cluster_network(cluster_network_id, update_cluster_network_details, **kwargs)

Updates the specified cluster network. The OCID of the cluster network remains the same.

Parameters:
  • cluster_network_id (str) –

    (required) The OCID of the cluster network.

  • update_cluster_network_details (oci.core.models.UpdateClusterNetworkDetails) – (required) Update cluster network
  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 ClusterNetwork

Return type:

Response

Example:

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

update_instance_configuration(instance_configuration_id, update_instance_configuration_details, **kwargs)

Updates the free-form tags, defined tags, and display name of an instance configuration.

Parameters:
  • instance_configuration_id (str) – (required) The OCID of the instance configuration.
  • update_instance_configuration_details (oci.core.models.UpdateInstanceConfigurationDetails) – (required) Updates the freeFormTags, definedTags, and display name of an instance configuration.
  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 InstanceConfiguration

Return type:

Response

Example:

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

update_instance_pool(instance_pool_id, update_instance_pool_details, **kwargs)

Update the specified instance pool.

The OCID of the instance pool remains the same.

Parameters:
  • instance_pool_id (str) –

    (required) The OCID of the instance pool.

  • update_instance_pool_details (oci.core.models.UpdateInstancePoolDetails) – (required) Update instance pool configuration
  • 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. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. 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 InstancePool

Return type:

Response

Example:

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