EsxiHostClientCompositeOperations¶
- class oci.ocvp.EsxiHostClientCompositeOperations(client, work_request_clients=None, **kwargs)¶
This class provides a wrapper around
EsxiHostClientand 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 functionalityMethods:
__init__(client[, work_request_clients])Creates a new EsxiHostClientCompositeOperations object
create_esxi_host_and_wait_for_state(...[, ...])Calls
create_esxi_host()and waits for theWorkRequestto enter the given state(s).delete_esxi_host_and_wait_for_state(esxi_host_id)Calls
delete_esxi_host()and waits for theWorkRequestto enter the given state(s).inplace_upgrade_and_wait_for_state(esxi_host_id)Calls
inplace_upgrade()and waits for theWorkRequestto enter the given state(s).replace_host_and_wait_for_state(...[, ...])Calls
replace_host()and waits for theWorkRequestto enter the given state(s).swap_billing_and_wait_for_state(...[, ...])Calls
swap_billing()and waits for theWorkRequestto enter the given state(s).update_esxi_host_and_wait_for_state(...[, ...])Calls
update_esxi_host()and waits for theEsxiHostacted upon to enter the given state(s).- __init__(client, work_request_clients=None, **kwargs)¶
Creates a new EsxiHostClientCompositeOperations object
- Parameters
client (EsxiHostClient) – The service client which will be wrapped by this object
work_request_clients (dict) –
(optional) Service-local clients keyed by generated client class name, for example
{'WorkRequestClient': work_request_client}. By default, regional clients are created when needed using the wrapped client’s signer, endpoint and constructor options.Automatically created work-request clients are cached. Before each wait, their endpoint and signer are refreshed from the wrapped client; other client settings and HTTP session changes are not synchronized. Do not modify the wrapped client’s endpoint or signer while a wait is in progress.
Supply a client for non-regional endpoints or customized HTTP sessions. These clients are separate from the shared Work Requests service.
- 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 theWorkRequestto enter the given state(s).- Parameters
create_esxi_host_details (oci.ocvp.models.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
statusoperation_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 passmax_interval_secondsormax_interval_secondsas 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 theWorkRequestto 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
statusoperation_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 passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- inplace_upgrade_and_wait_for_state(esxi_host_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
inplace_upgrade()and waits for theWorkRequestto 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
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
inplace_upgrade()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- replace_host_and_wait_for_state(esxi_host_id, replace_host_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
replace_host()and waits for theWorkRequestto enter the given state(s).- Parameters
esxi_host_id (str) –
(required) The OCID of the ESXi host.
replace_host_details (oci.ocvp.models.ReplaceHostDetails) – (required) The details for replacing ESXi host
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
replace_host()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- swap_billing_and_wait_for_state(esxi_host_id, swap_billing_host_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
swap_billing()and waits for theWorkRequestto enter the given state(s).- Parameters
esxi_host_id (str) –
(required) The OCID of the ESXi host.
swap_billing_host_id (str) –
(required) The OCID of the active ESXi Host to swap billing with current host.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
swap_billing()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas 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 theEsxiHostacted upon to enter the given state(s).- Parameters
esxi_host_id (str) –
(required) The OCID of the ESXi host.
update_esxi_host_details (oci.ocvp.models.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_stateoperation_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 passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait