EsxiHostClientCompositeOperations

class oci.ocvp.EsxiHostClientCompositeOperations(client, **kwargs)

This class provides a wrapper around EsxiHostClient and offers convenience methods for operations that would otherwise need to be chained together. For example, instead of performing an action on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource to enter a given state, you can call a single method in this class to accomplish the same functionality

Methods

__init__(client, **kwargs) Creates a new EsxiHostClientCompositeOperations object
create_esxi_host_and_wait_for_state(…[, …]) Calls create_esxi_host() and waits for the WorkRequest to enter the given state(s).
delete_esxi_host_and_wait_for_state(esxi_host_id) Calls delete_esxi_host() and waits for the WorkRequest to enter the given state(s).
update_esxi_host_and_wait_for_state(…[, …]) Calls update_esxi_host() and waits for the EsxiHost acted upon to enter the given state(s).
__init__(client, **kwargs)

Creates a new EsxiHostClientCompositeOperations object

Parameters:client (EsxiHostClient) – The service client which will be wrapped by this object
create_esxi_host_and_wait_for_state(create_esxi_host_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_esxi_host() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • create_esxi_host_details (CreateEsxiHostDetails) – (required) Details for the ESXi host.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_esxi_host()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
delete_esxi_host_and_wait_for_state(esxi_host_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_esxi_host() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • esxi_host_id (str) –

    (required) The OCID of the ESXi host.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_esxi_host()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_esxi_host_and_wait_for_state(esxi_host_id, update_esxi_host_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_esxi_host() and waits for the EsxiHost acted upon to enter the given state(s).

Parameters:
  • esxi_host_id (str) –

    (required) The OCID of the ESXi host.

  • update_esxi_host_details (UpdateEsxiHostDetails) – (required) The information to be updated.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_esxi_host()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait