vmware.vmc_draas.api package

Submodules

vmware.vmc_draas.api.site_recovery_api module

VMC DRaaS APIs

• All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: `   curl -s -X POST \       -d "refresh_token=${REFRESH_TOKEN}" \       https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize | jq -r .access_token   ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field * Most VMC DRaaS APIs require a sddc identifier. This can be obtained by issuing a GET on /vmc/api/orgs/{org}/sddcs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Contact: anushah@vmware.com Generated by: https://openapi-generator.tech

class vmware.vmc_draas.api.site_recovery_api.SiteRecoveryApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

activate_site_recovery(org, sddc, **kwargs)

Activate site recovery for the specified sddc # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.activate_site_recovery(org, sddc, async_req=True) >>> result = thread.get()

Parameters

• bool (async_req) – execute request asynchronously

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• activate_site_recovery_config (ActivateSiteRecoveryConfig) – Customization, for example can specify custom extension key suffix for SRM.

• _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

activate_site_recovery_with_http_info(org, sddc, **kwargs)

Activate site recovery for the specified sddc # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.activate_site_recovery_with_http_info(org, sddc, async_req=True) >>> result = thread.get()

Parameters

• bool (async_req) – execute request asynchronously

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• activate_site_recovery_config (ActivateSiteRecoveryConfig) – Customization, for example can specify custom extension key suffix for SRM.

• _return_http_data_only – response data without head status code and headers

• _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

deactivate_site_recovery(org, sddc, **kwargs)

Deactivate site recovery for the specified sddc # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.deactivate_site_recovery(org, sddc, async_req=True) >>> result = thread.get()

Parameters

• bool (async_req) – execute request asynchronously

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• force (bool) – If = ‘true’, will deactivate site recovery forcefully.

• deactivate_hcx (bool) – If = ‘true’, will deactivate HCX.

• _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

deactivate_site_recovery_with_http_info(org, sddc, **kwargs)

Deactivate site recovery for the specified sddc # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.deactivate_site_recovery_with_http_info(org, sddc, async_req=True) >>> result = thread.get()

Parameters

• bool (async_req) – execute request asynchronously

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• force (bool) – If = ‘true’, will deactivate site recovery forcefully.

• deactivate_hcx (bool) – If = ‘true’, will deactivate HCX.

• _return_http_data_only – response data without head status code and headers

• _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

delete_srm(org, sddc, srm_node, **kwargs)

Delete a SRM server. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_srm(org, sddc, srm_node, async_req=True) >>> result = thread.get()

Parameters

• bool (async_req) – execute request asynchronously

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• srm_node (str) – SRM node identifier (required)

• _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

delete_srm_with_http_info(org, sddc, srm_node, **kwargs)

Delete a SRM server. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_srm_with_http_info(org, sddc, srm_node, async_req=True) >>> result = thread.get()

Parameters

• bool (async_req) – execute request asynchronously

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• srm_node (str) – SRM node identifier (required)

• _return_http_data_only – response data without head status code and headers

• _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_replica_disk_collections(org, sddc, **kwargs)

Query replica disk collections # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_replica_disk_collections(org, sddc, async_req=True) >>> result = thread.get()

Parameters

• bool (async_req) – execute request asynchronously

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• datastore_mo_id (str) – Represents the datastore moref id to search.

• _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

list[ReplicaDiskCollection] If the method is called asynchronously, returns the request thread.

get_replica_disk_collections_with_http_info(org, sddc, **kwargs)

Query replica disk collections # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_replica_disk_collections_with_http_info(org, sddc, async_req=True) >>> result = thread.get()

Parameters

• bool (async_req) – execute request asynchronously

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• datastore_mo_id (str) – Represents the datastore moref id to search.

• _return_http_data_only – response data without head status code and headers

• _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(list[ReplicaDiskCollection], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_site_recovery(org, sddc, **kwargs)

Query site recovery configuration for the specified sddc # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_site_recovery(org, sddc, async_req=True) >>> result = thread.get()

Parameters

• bool (async_req) – execute request asynchronously

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

SiteRecovery If the method is called asynchronously, returns the request thread.

get_site_recovery_versions(org, sddc, **kwargs)

Query site recovery versions for the specified sddc # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_site_recovery_versions(org, sddc, async_req=True) >>> result = thread.get()

Parameters

• bool (async_req) – execute request asynchronously

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• version_source (str) – Represents the source for getting the version from.

• _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

SiteRecoveryVersions If the method is called asynchronously, returns the request thread.

get_site_recovery_versions_with_http_info(org, sddc, **kwargs)

Query site recovery versions for the specified sddc # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_site_recovery_versions_with_http_info(org, sddc, async_req=True) >>> result = thread.get()

Parameters

• bool (async_req) – execute request asynchronously

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• version_source (str) – Represents the source for getting the version from.

• _return_http_data_only – response data without head status code and headers

• _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(SiteRecoveryVersions, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_site_recovery_with_http_info(org, sddc, **kwargs)

Query site recovery configuration for the specified sddc # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_site_recovery_with_http_info(org, sddc, async_req=True) >>> result = thread.get()

Parameters

• bool (async_req) – execute request asynchronously

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• _return_http_data_only – response data without head status code and headers

• _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(SiteRecovery, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

provision_additional_srm(org, sddc, **kwargs)

Provision an additional SRM server. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.provision_additional_srm(org, sddc, async_req=True) >>> result = thread.get()

Parameters

• bool (async_req) – execute request asynchronously

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• provision_srm_config (ProvisionSrmConfig) – Customization, for example can specify custom extension key suffix for SRM.

• _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

provision_additional_srm_with_http_info(org, sddc, **kwargs)

Provision an additional SRM server. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.provision_additional_srm_with_http_info(org, sddc, async_req=True) >>> result = thread.get()

Parameters

• bool (async_req) – execute request asynchronously

• org (str) – Organization identifier (required)

• sddc (str) – sddc identifier (required)

• provision_srm_config (ProvisionSrmConfig) – Customization, for example can specify custom extension key suffix for SRM.

• _return_http_data_only – response data without head status code and headers

• _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc_draas.api.task_api module

VMC DRaaS APIs

• All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: `   curl -s -X POST \       -d "refresh_token=${REFRESH_TOKEN}" \       https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize | jq -r .access_token   ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field * Most VMC DRaaS APIs require a sddc identifier. This can be obtained by issuing a GET on /vmc/api/orgs/{org}/sddcs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Contact: anushah@vmware.com Generated by: https://openapi-generator.tech

class vmware.vmc_draas.api.task_api.TaskApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

vmc_draas_api_orgs_org_tasks_task_get(org, task, **kwargs)

Get task details # noqa: E501

Retrieve details of a task. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.vmc_draas_api_orgs_org_tasks_task_get(org, task, async_req=True) >>> result = thread.get()

Parameters

• bool (async_req) – execute request asynchronously

• org (str) – Organization identifier (required)

• task (str) – task identifier (required)

• _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

vmc_draas_api_orgs_org_tasks_task_get_with_http_info(org, task, **kwargs)

Get task details # noqa: E501

Retrieve details of a task. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.vmc_draas_api_orgs_org_tasks_task_get_with_http_info(org, task, async_req=True) >>> result = thread.get()

Parameters

• bool (async_req) – execute request asynchronously

• org (str) – Organization identifier (required)

• task (str) – task identifier (required)

• _return_http_data_only – response data without head status code and headers

• _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

Module contents