com.vmware.vmc.draas package¶
Submodules¶
com.vmware.vmc.draas.model_client module¶
-
class
com.vmware.vmc.draas.model_client.
AbstractEntity
(updated=None, user_id=None, created=None, updated_by_user_id=None, version=None, updated_by_user_name=None, user_name=None, id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
updated (
datetime.datetime
) –user_id (
str
) – User id that last updated this recordcreated (
datetime.datetime
) –updated_by_user_id (
str
) – User id that last updated this recordversion (
long
) – Version of this entity format: int32updated_by_user_name (
str
) – User name that last updated this recorduser_name (
str
) – User name that last updated this recordid (
str
) –
-
class
com.vmware.vmc.draas.model_client.
ActivateSiteRecoveryConfig
(srm_extension_key_suffix=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
srm_extension_key_suffix (
str
orNone
) – Optional custom extension key suffix for SRM. If not specified, default extension key will be used. The custom extension suffix must contain 13 characters or less, be composed of letters, numbers, ., -, and _ characters. The extension suffix must begin and end with a letter or number. The suffix is appended to com.vmware.vcDr- to form the full extension key.
-
class
com.vmware.vmc.draas.model_client.
ErrorResponse
(status=None, path=None, retryable=None, error_code=None, error_messages=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
status (
long
) – HTTP status codepath (
str
) – Originating request URIretryable (
bool
) – If true, client should retry operationerror_code (
str
) – unique error codeerror_messages (
list
ofstr
) – localized error messages
-
class
com.vmware.vmc.draas.model_client.
ProvisionSrmConfig
(internal=None, srm_extension_key_suffix=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
internal (
bool
orNone
) – Internal flag to allow to invoke additional SRM provisioning API on NSX-V SDDCs.srm_extension_key_suffix (
str
orNone
) – Optional custom extension key suffix for SRM. If not specified, default extension key will be used.
-
class
com.vmware.vmc.draas.model_client.
ReplicaDisk
(space_requirement=None, name=None, collection_id=None, datastores_for_single_host_move=None, movable=None, disk_id=None, datastore_mo_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
space_requirement (
float
orNone
) –name (
str
orNone
) –collection_id (
str
orNone
) –datastores_for_single_host_move (
list
ofvmware.vapi.struct.VapiStruct
orNone
) –movable (
bool
orNone
) –disk_id (
str
orNone
) –datastore_mo_id (
str
orNone
) –
-
class
com.vmware.vmc.draas.model_client.
ReplicaDiskCollection
(collection_id=None, generated=None, disks=None, placeholder_vm_mo_id=None, name=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
collection_id (
str
orNone
) –generated (
datetime.datetime
orNone
) –disks (
list
ofReplicaDisk
orNone
) –placeholder_vm_mo_id (
str
orNone
) –name (
str
orNone
) –
-
class
com.vmware.vmc.draas.model_client.
SiteRecovery
(updated=None, user_id=None, created=None, updated_by_user_id=None, version=None, updated_by_user_name=None, user_name=None, id=None, site_recovery_state=None, vr_node=None, srm_nodes=None, sddc_id=None, draas_h5_url=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
updated (
datetime.datetime
) –user_id (
str
) – User id that last updated this recordcreated (
datetime.datetime
) –updated_by_user_id (
str
) – User id that last updated this recordversion (
long
) – Version of this entity format: int32updated_by_user_name (
str
) – User name that last updated this recorduser_name (
str
) – User name that last updated this recordid (
str
) –site_recovery_state (
str
orNone
) –Possible values are:
vr_node (
SiteRecoveryNode
orNone
) –srm_nodes (
list
ofSiteRecoveryNode
orNone
) –sddc_id (
str
orNone
) –draas_h5_url (
str
orNone
) –
-
SITE_RECOVERY_STATE_ACTIVATED
= 'ACTIVATED'¶
-
SITE_RECOVERY_STATE_ACTIVATING
= 'ACTIVATING'¶
-
SITE_RECOVERY_STATE_CANCELED
= 'CANCELED'¶
-
SITE_RECOVERY_STATE_DEACTIVATED
= 'DEACTIVATED'¶
-
SITE_RECOVERY_STATE_DEACTIVATING
= 'DEACTIVATING'¶
-
SITE_RECOVERY_STATE_DELETED
= 'DELETED'¶
-
SITE_RECOVERY_STATE_FAILED
= 'FAILED'¶
-
class
com.vmware.vmc.draas.model_client.
SiteRecoveryNode
(vm_moref_id=None, ip_address=None, hostname=None, id=None, state=None, type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
vm_moref_id (
str
orNone
) –ip_address (
str
orNone
) –hostname (
str
orNone
) –id (
str
orNone
) –state (
str
orNone
) –Possible values are:
type (
str
orNone
) –Possible values are:
-
STATE_CANCELED
= 'CANCELED'¶
-
STATE_DELETING
= 'DELETING'¶
-
STATE_DEPLOYING
= 'DEPLOYING'¶
-
STATE_FAILED
= 'FAILED'¶
-
STATE_PROVISIONED
= 'PROVISIONED'¶
-
STATE_READY
= 'READY'¶
-
TYPE_SRM
= 'SRM'¶
-
TYPE_VRMS
= 'VRMS'¶
-
TYPE_VRS
= 'VRS'¶
-
class
com.vmware.vmc.draas.model_client.
SiteRecoveryNodeVersion
(version_source=None, node_id=None, build_number=None, appliance_version=None, node_ip=None, full_version=None, node_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
version_source (
str
orNone
) –Possible values are:
node_id (
str
orNone
) –build_number (
str
orNone
) –appliance_version (
str
orNone
) –node_ip (
str
orNone
) –full_version (
str
orNone
) –node_type (
str
orNone
) –Possible values are:
-
NODE_TYPE_SRM
= 'SRM'¶
-
NODE_TYPE_VRMS
= 'VRMS'¶
-
NODE_TYPE_VRS
= 'VRS'¶
-
VERSION_SOURCE_LS
= 'ls'¶
-
VERSION_SOURCE_VAMICLI
= 'vamicli'¶
-
class
com.vmware.vmc.draas.model_client.
SiteRecoveryVersions
(generated=None, sddc_id=None, node_versions=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
generated (
datetime.datetime
orNone
) –sddc_id (
str
orNone
) –node_versions (
list
ofSiteRecoveryNodeVersion
orNone
) – list of site recovery node version
-
class
com.vmware.vmc.draas.model_client.
StubFactory
(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
- Parameters
stub_config (
vmware.vapi.bindings.stub.StubConfiguration
) – Stub config instance
-
class
com.vmware.vmc.draas.model_client.
Task
(updated=None, user_id=None, created=None, updated_by_user_id=None, version=None, updated_by_user_name=None, user_name=None, id=None, status=None, resource_id=None, start_time=None, retries=None, task_type=None, task_progress_phases=None, tenant_id=None, error_message=None, parent_task_id=None, progress_percent=None, estimated_remaining_minutes=None, params=None, end_time=None, task_version=None, resource_type=None, sub_status=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
updated (
datetime.datetime
) –user_id (
str
) – User id that last updated this recordcreated (
datetime.datetime
) –updated_by_user_id (
str
) – User id that last updated this recordversion (
long
) – Version of this entity format: int32updated_by_user_name (
str
) – User name that last updated this recorduser_name (
str
) – User name that last updated this recordid (
str
) –status (
str
orNone
) –Possible values are:
resource_id (
str
orNone
) – UUID of resources task is acting uponstart_time (
str
orNone
) –retries (
long
orNone
) –task_type (
str
orNone
) –task_progress_phases (
list
ofTaskProgressPhase
orNone
) – Task progress phases involved in current task executiontenant_id (
str
orNone
) –error_message (
str
orNone
) –parent_task_id (
str
orNone
) –progress_percent (
long
orNone
) – Estimated progress percentage the task executed format: int32estimated_remaining_minutes (
long
orNone
) – Estimated remaining time in minute of the task execution, < 0 means no estimation for the task. format: int32params (
vmware.vapi.struct.VapiStruct
orNone
) –end_time (
datetime.datetime
orNone
) –task_version (
str
orNone
) –resource_type (
str
orNone
) – Type of resource being acted uponsub_status (
str
orNone
) –
-
STATUS_CANCELED
= 'CANCELED'¶
-
STATUS_CANCELING
= 'CANCELING'¶
-
STATUS_FAILED
= 'FAILED'¶
-
STATUS_FINISHED
= 'FINISHED'¶
-
STATUS_STARTED
= 'STARTED'¶
-
class
com.vmware.vmc.draas.model_client.
TaskProgressPhase
(id=None, name=None, progress_percent=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
A task progress can be (but does NOT have to be) divided to more meaningful progress phases.
Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
id (
str
) – The identifier of the task progress phasename (
str
) – The display name of the task progress phaseprogress_percent (
long
) – The percentage of the phase that has completed format: int32