diff --git a/openapi/docs/build/doctrees/vmc/console/setup.doctree b/openapi/docs/build/doctrees/vmc/console/setup.doctree deleted file mode 100644 index 8ba9575e..00000000 Binary files a/openapi/docs/build/doctrees/vmc/console/setup.doctree and /dev/null differ diff --git a/openapi/docs/build/doctrees/vmc/draas/vmware.vmc_draas.api.doctree b/openapi/docs/build/doctrees/vmc/draas/vmware.vmc_draas.api.doctree deleted file mode 100644 index 678418ff..00000000 Binary files a/openapi/docs/build/doctrees/vmc/draas/vmware.vmc_draas.api.doctree and /dev/null differ diff --git a/openapi/docs/build/doctrees/vmc/draas/vmware.vmc_draas.doctree b/openapi/docs/build/doctrees/vmc/draas/vmware.vmc_draas.doctree deleted file mode 100644 index 4d425583..00000000 Binary files a/openapi/docs/build/doctrees/vmc/draas/vmware.vmc_draas.doctree and /dev/null differ diff --git a/openapi/docs/build/doctrees/vmc/draas/vmware.vmc_draas.models.doctree b/openapi/docs/build/doctrees/vmc/draas/vmware.vmc_draas.models.doctree deleted file mode 100644 index 251ac0a4..00000000 Binary files a/openapi/docs/build/doctrees/vmc/draas/vmware.vmc_draas.models.doctree and /dev/null differ diff --git a/openapi/docs/build/html/_sources/vmc/console/setup.rst.txt b/openapi/docs/build/html/_sources/vmc/console/setup.rst.txt deleted file mode 100644 index 552eb49d..00000000 --- a/openapi/docs/build/html/_sources/vmc/console/setup.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -setup module -============ - -.. automodule:: setup - :members: - :undoc-members: - :show-inheritance: diff --git a/openapi/docs/build/html/_sources/vmc/draas/vmware.vmc_draas.api.rst.txt b/openapi/docs/build/html/_sources/vmc/draas/vmware.vmc_draas.api.rst.txt deleted file mode 100644 index c42ea393..00000000 --- a/openapi/docs/build/html/_sources/vmc/draas/vmware.vmc_draas.api.rst.txt +++ /dev/null @@ -1,30 +0,0 @@ -vmware.vmc\_draas.api package -============================= - -Submodules ----------- - -vmware.vmc\_draas.api.site\_recovery\_api module ------------------------------------------------- - -.. automodule:: vmware.vmc_draas.api.site_recovery_api - :members: - :undoc-members: - :show-inheritance: - -vmware.vmc\_draas.api.task\_api module --------------------------------------- - -.. automodule:: vmware.vmc_draas.api.task_api - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: vmware.vmc_draas.api - :members: - :undoc-members: - :show-inheritance: diff --git a/openapi/docs/build/html/_sources/vmc/draas/vmware.vmc_draas.models.rst.txt b/openapi/docs/build/html/_sources/vmc/draas/vmware.vmc_draas.models.rst.txt deleted file mode 100644 index 971812fb..00000000 --- a/openapi/docs/build/html/_sources/vmc/draas/vmware.vmc_draas.models.rst.txt +++ /dev/null @@ -1,134 +0,0 @@ -vmware.vmc\_draas.models package -================================ - -Submodules ----------- - -vmware.vmc\_draas.models.abstract\_entity module ------------------------------------------------- - -.. automodule:: vmware.vmc_draas.models.abstract_entity - :members: - :undoc-members: - :show-inheritance: - -vmware.vmc\_draas.models.activate\_site\_recovery\_config module ----------------------------------------------------------------- - -.. automodule:: vmware.vmc_draas.models.activate_site_recovery_config - :members: - :undoc-members: - :show-inheritance: - -vmware.vmc\_draas.models.error\_response module ------------------------------------------------ - -.. automodule:: vmware.vmc_draas.models.error_response - :members: - :undoc-members: - :show-inheritance: - -vmware.vmc\_draas.models.provision\_srm\_config module ------------------------------------------------------- - -.. automodule:: vmware.vmc_draas.models.provision_srm_config - :members: - :undoc-members: - :show-inheritance: - -vmware.vmc\_draas.models.replica\_disk module ---------------------------------------------- - -.. automodule:: vmware.vmc_draas.models.replica_disk - :members: - :undoc-members: - :show-inheritance: - -vmware.vmc\_draas.models.replica\_disk\_collection module ---------------------------------------------------------- - -.. automodule:: vmware.vmc_draas.models.replica_disk_collection - :members: - :undoc-members: - :show-inheritance: - -vmware.vmc\_draas.models.site\_recovery module ----------------------------------------------- - -.. automodule:: vmware.vmc_draas.models.site_recovery - :members: - :undoc-members: - :show-inheritance: - -vmware.vmc\_draas.models.site\_recovery\_all\_of module -------------------------------------------------------- - -.. automodule:: vmware.vmc_draas.models.site_recovery_all_of - :members: - :undoc-members: - :show-inheritance: - -vmware.vmc\_draas.models.site\_recovery\_node module ----------------------------------------------------- - -.. automodule:: vmware.vmc_draas.models.site_recovery_node - :members: - :undoc-members: - :show-inheritance: - -vmware.vmc\_draas.models.site\_recovery\_node\_all\_of module -------------------------------------------------------------- - -.. automodule:: vmware.vmc_draas.models.site_recovery_node_all_of - :members: - :undoc-members: - :show-inheritance: - -vmware.vmc\_draas.models.site\_recovery\_node\_version module -------------------------------------------------------------- - -.. automodule:: vmware.vmc_draas.models.site_recovery_node_version - :members: - :undoc-members: - :show-inheritance: - -vmware.vmc\_draas.models.site\_recovery\_versions module --------------------------------------------------------- - -.. automodule:: vmware.vmc_draas.models.site_recovery_versions - :members: - :undoc-members: - :show-inheritance: - -vmware.vmc\_draas.models.task module ------------------------------------- - -.. automodule:: vmware.vmc_draas.models.task - :members: - :undoc-members: - :show-inheritance: - -vmware.vmc\_draas.models.task\_all\_of module ---------------------------------------------- - -.. automodule:: vmware.vmc_draas.models.task_all_of - :members: - :undoc-members: - :show-inheritance: - -vmware.vmc\_draas.models.task\_progress\_phase module ------------------------------------------------------ - -.. automodule:: vmware.vmc_draas.models.task_progress_phase - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: vmware.vmc_draas.models - :members: - :undoc-members: - :show-inheritance: diff --git a/openapi/docs/build/html/_sources/vmc/draas/vmware.vmc_draas.rst.txt b/openapi/docs/build/html/_sources/vmc/draas/vmware.vmc_draas.rst.txt deleted file mode 100644 index dc0b4ab2..00000000 --- a/openapi/docs/build/html/_sources/vmc/draas/vmware.vmc_draas.rst.txt +++ /dev/null @@ -1,55 +0,0 @@ -vmware.vmc\_draas package -========================= - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - vmware.vmc_draas.api - vmware.vmc_draas.models - -Submodules ----------- - -vmware.vmc\_draas.api\_client module ------------------------------------- - -.. automodule:: vmware.vmc_draas.api_client - :members: - :undoc-members: - :show-inheritance: - -vmware.vmc\_draas.configuration module --------------------------------------- - -.. automodule:: vmware.vmc_draas.configuration - :members: - :undoc-members: - :show-inheritance: - -vmware.vmc\_draas.exceptions module ------------------------------------ - -.. automodule:: vmware.vmc_draas.exceptions - :members: - :undoc-members: - :show-inheritance: - -vmware.vmc\_draas.rest module ------------------------------ - -.. automodule:: vmware.vmc_draas.rest - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: vmware.vmc_draas - :members: - :undoc-members: - :show-inheritance: diff --git a/openapi/docs/build/html/vmc/console/setup.html b/openapi/docs/build/html/vmc/console/setup.html deleted file mode 100644 index 4aaeb372..00000000 --- a/openapi/docs/build/html/vmc/console/setup.html +++ /dev/null @@ -1,212 +0,0 @@ - - - - - - - - - - setup module — VMware Automation SDK for Python 0.1.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

setup module

-
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/openapi/docs/build/html/vmc/draas/setup.html b/openapi/docs/build/html/vmc/draas/setup.html deleted file mode 100644 index 24b0c122..00000000 --- a/openapi/docs/build/html/vmc/draas/setup.html +++ /dev/null @@ -1,212 +0,0 @@ - - - - - - - - - - setup module — VMware Automation SDK for Python 0.1.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

setup module

-
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/openapi/docs/build/html/vmc/draas/vmware.vmc_draas.api.html b/openapi/docs/build/html/vmc/draas/vmware.vmc_draas.api.html deleted file mode 100644 index 0a54e025..00000000 --- a/openapi/docs/build/html/vmc/draas/vmware.vmc_draas.api.html +++ /dev/null @@ -1,796 +0,0 @@ - - - - - - - - - - vmware.vmc_draas.api package — VMware Automation SDK for Python 0.1.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

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

-
-
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/openapi/docs/build/html/vmc/draas/vmware.vmc_draas.html b/openapi/docs/build/html/vmc/draas/vmware.vmc_draas.html deleted file mode 100644 index 7e785ed8..00000000 --- a/openapi/docs/build/html/vmc/draas/vmware.vmc_draas.html +++ /dev/null @@ -1,1034 +0,0 @@ - - - - - - - - - - vmware.vmc_draas package — VMware Automation SDK for Python 0.1.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

vmware.vmc_draas package

- -
-

Submodules

-
-
-

vmware.vmc_draas.api_client 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_client.ApiClient(configuration=None, header_name=None, header_value=None, cookie=None, pool_threads=1)
-

Bases: object

-

Generic API client for OpenAPI client library builds.

-

OpenAPI generic API client. This client handles the client- -server communication, and is invariant across implementations. Specifics of -the methods and models for each application are generated from the OpenAPI -templates.

-

NOTE: This class is auto generated by OpenAPI Generator. -Ref: https://openapi-generator.tech -Do not edit the class manually.

-
-
Parameters
-
    -
  • configuration – .Configuration object for this client

  • -
  • header_name – a header to pass when making calls to the API.

  • -
  • header_value – a header value to pass when making calls to -the API.

  • -
  • cookie – a cookie to include in the header when making calls -to the API

  • -
  • pool_threads – The number of threads to use for async requests -to the API. More threads means more concurrent API requests.

  • -
-
-
-
-
-NATIVE_TYPES_MAPPING = {'bool': <class 'bool'>, 'date': <class 'datetime.date'>, 'datetime': <class 'datetime.datetime'>, 'float': <class 'float'>, 'int': <class 'int'>, 'long': <class 'int'>, 'object': <class 'object'>, 'str': <class 'str'>}
-
- -
-
-PRIMITIVE_TYPES = (<class 'float'>, <class 'bool'>, <class 'bytes'>, <class 'str'>, <class 'int'>)
-
- -
-
-call_api(resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, response_type=None, auth_settings=None, async_req=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None, _host=None)
-

Makes the HTTP request (synchronous) and returns deserialized data.

-

To make an async_req request, set the async_req parameter.

-
-
Parameters
-
    -
  • resource_path – Path to method endpoint.

  • -
  • method – Method to call.

  • -
  • path_params – Path parameters in the url.

  • -
  • query_params – Query parameters in the url.

  • -
  • header_params – Header parameters to be -placed in the request header.

  • -
  • body – Request body.

  • -
  • dict (files) – Request post form parameters, -for application/x-www-form-urlencoded, multipart/form-data.

  • -
  • list (auth_settings) – Auth Settings names for the request.

  • -
  • response – Response data type.

  • -
  • dict – key -> filename, value -> filepath, -for multipart/form-data.

  • -
  • bool (async_req) – execute request asynchronously

  • -
  • _return_http_data_only – response data without head status code -and headers

  • -
  • collection_formats – dict of collection formats for path, query, -header, and post parameters.

  • -
  • _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
-

If async_req parameter is True, -the request will be called asynchronously. -The method will return the request thread. -If parameter async_req is False or missing, -then the method will return the response directly.

-
-
-
- -
-
-close()
-
- -
-
-deserialize(response, response_type)
-

Deserializes response into an object.

-
-
Parameters
-
    -
  • response – RESTResponse object to be deserialized.

  • -
  • response_type – class literal for -deserialized object, or string of class name.

  • -
-
-
Returns
-

deserialized object.

-
-
-
- -
-
-files_parameters(files=None)
-

Builds form parameters.

-
-
Parameters
-

files – File parameters.

-
-
Returns
-

Form parameters with files.

-
-
-
- -
-
-parameters_to_tuples(params, collection_formats)
-

Get parameters as list of tuples, formatting collections.

-
-
Parameters
-
    -
  • params – Parameters as dict or list of two-tuples

  • -
  • collection_formats (dict) – Parameter collection formats

  • -
-
-
Returns
-

Parameters as list of tuples, collections formatted

-
-
-
- -
-
-property pool
-

Create thread pool on first request -avoids instantiating unused threadpool for blocking clients.

-
- -
-
-request(method, url, query_params=None, headers=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
-

Makes the HTTP request using RESTClient.

-
- -
-
-sanitize_for_serialization(obj)
-

Builds a JSON POST object.

-

If obj is None, return None. -If obj is str, int, long, float, bool, return directly. -If obj is datetime.datetime, datetime.date

-
-

convert to string in iso8601 format.

-
-

If obj is list, sanitize each element in the list. -If obj is dict, return the dict. -If obj is OpenAPI model, return the properties dict.

-
-
Parameters
-

obj – The data to serialize.

-
-
Returns
-

The serialized form of data.

-
-
-
- -
-
-select_header_accept(accepts)
-

Returns Accept based on an array of accepts provided.

-
-
Parameters
-

accepts – List of headers.

-
-
Returns
-

Accept (e.g. application/json).

-
-
-
- -
-
-select_header_content_type(content_types)
-

Returns Content-Type based on an array of content_types provided.

-
-
Parameters
-

content_types – List of content-types.

-
-
Returns
-

Content-Type (e.g. application/json).

-
-
-
- -
-
-set_default_header(header_name, header_value)
-
- -
-
-update_params_for_auth(headers, querys, auth_settings)
-

Updates header and query params based on authentication setting.

-
-
Parameters
-
    -
  • headers – Header parameters dict to be updated.

  • -
  • querys – Query parameters tuple list to be updated.

  • -
  • auth_settings – Authentication setting identifiers list.

  • -
-
-
-
- -
-
-property user_agent
-

User agent for this API client

-
- -
- -
-
-

vmware.vmc_draas.configuration 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.configuration.Configuration(host='https://vmc.vmware.com', api_key=None, api_key_prefix=None, username=None, password=None, discard_unknown_keys=False, disabled_client_side_validations='')
-

Bases: object

-

NOTE: This class is auto generated by OpenAPI Generator

-
-

Ref: https://openapi-generator.tech -Do not edit the class manually.

-
-
param host
-

Base url

-
-
param api_key
-

Dict to store API key(s). -Each entry in the dict specifies an API key. -The dict key is the name of the security scheme in the OAS specification. -The dict value is the API key secret.

-
-
param api_key_prefix
-

Dict to store API prefix (e.g. Bearer) -The dict key is the name of the security scheme in the OAS specification. -The dict value is an API key prefix when generating the auth data.

-
-
param username
-

Username for HTTP basic authentication

-
-
param password
-

Password for HTTP basic authentication

-
-
param discard_unknown_keys
-

Boolean value indicating whether to discard -unknown properties. A server may send a response that includes additional -properties that are not known by the client in the following scenarios: -1. The OpenAPI document is incomplete, i.e. it does not match the server

-
-

implementation.

-
-
    -
  1. The client was generated using an older version of the OpenAPI document -and the server has been upgraded since then.

  2. -
-

If a schema in the OpenAPI document defines the additionalProperties attribute, -then all undeclared properties received by the server are injected into the -additional properties map. In that case, there are undeclared properties, and -nothing to discard.

-
-
param disabled_client_side_validations (string)
-

Comma-separated list of -JSON schema validation keywords to disable JSON schema structural validation -rules. The following keywords may be specified: multipleOf, maximum, -exclusiveMaximum, minimum, exclusiveMinimum, maxLength, minLength, pattern, -maxItems, minItems. -By default, the validation is performed for data generated locally by the client -and data received from the server, independent of any validation performed by -the server side. If the input data does not satisfy the JSON schema validation -rules specified in the OpenAPI document, an exception is raised. -If disabled_client_side_validations is set, structural validation is -disabled. This can be useful to troubleshoot data validation problem, such as -when the OpenAPI document validation rules do not match the actual API data -received by the server.

-
-
Example
-

-
-

API Key Authentication Example. -Given the following security scheme in the OpenAPI specification:

-
-
-
components:
-
securitySchemes:
-
cookieAuth: # name for the security scheme

type: apiKey -in: cookie -name: JSESSIONID # cookie name

-
-
-
-
-
-
-
-

You can programmatically set the cookie:

-
-
-
conf = vmware.vmc_draas.Configuration(

api_key={‘cookieAuth’: ‘abc123’} -api_key_prefix={‘cookieAuth’: ‘JSESSIONID’}

-
-
-

)

-
-
-
The following cookie will be added to the HTTP request:

Cookie: JSESSIONID abc123

-
-
-
-

Constructor

-
-
-assert_hostname
-

Set this to True/False to enable/disable SSL hostname verification.

-
- -
-
-auth_settings()
-

Gets Auth Settings dict for api client.

-
-
Returns
-

The Auth Settings information dict.

-
-
-
- -
-
-cert_file
-

client certificate file

-
- -
-
-connection_pool_maxsize
-

urllib3 connection pool’s maximum number of connections saved -per pool. urllib3 uses 1 connection as default value, but this is -not the best value when you are making a lot of possibly parallel -requests to the same host, which is often the case here. -cpu_count * 5 is used as default value to increase performance.

-
- -
-
-property debug
-

Debug switch

-
- -
-
-get_api_key_with_prefix(identifier)
-

Gets API key (with prefix if set).

-
-
Parameters
-

identifier – The identifier of apiKey.

-
-
Returns
-

The token for api key authentication.

-
-
-
- -
-
-get_basic_auth_token()
-

Gets HTTP basic authentication header (string).

-
-
Returns
-

The token for basic HTTP authentication.

-
-
-
- -
-
-classmethod get_default_copy()
-

Return new instance of configuration.

-

This method returns newly created, based on default constructor, -object of Configuration class or returns a copy of default -configuration passed by the set_default method.

-
-
Returns
-

The configuration object.

-
-
-
- -
-
-get_host_from_settings(index, variables=None)
-

Gets host URL based on the index and variables -:param index: array index of the host settings -:param variables: hash of variable and the corresponding value -:return: URL based on host settings

-
- -
-
-get_host_settings()
-

Gets an array of host settings

-
-
Returns
-

An array of host settings

-
-
-
- -
-
-host
-

Default Base url

-
- -
-
-key_file
-

client key file

-
- -
-
-logger
-

Logging Settings

-
- -
-
-property logger_file
-

Debug file location

-
- -
-
-logger_file_handler
-

Log file handler

-
- -
-
-property logger_format
-

Log format

-
- -
-
-logger_stream_handler
-

Log stream handler

-
- -
-
-password
-

Password for HTTP basic authentication

-
- -
-
-proxy
-

Proxy URL

-
- -
-
-proxy_headers
-

Proxy headers

-
- -
-
-refresh_api_key_hook
-

function hook to refresh API key if expired

-
- -
-
-retries
-

Adding retries to override urllib3 default value 3

-
- -
-
-safe_chars_for_path_param
-

Safe chars for path_param

-
- -
-
-classmethod set_default(default)
-

Set default instance of configuration.

-

It stores default configuration, which can be -returned by get_default_copy method.

-
-
Parameters
-

default – object of Configuration

-
-
-
- -
-
-ssl_ca_cert
-

Set this to customize the certificate file to verify the peer.

-
- -
-
-temp_folder_path
-

Temp file folder for downloading files

-
- -
-
-to_debug_report()
-

Gets the essential information for debugging.

-
-
Returns
-

The report for debugging.

-
-
-
- -
-
-username
-

Username for HTTP basic authentication

-
- -
-
-verify_ssl
-

SSL/TLS verification -Set this to false to skip verifying SSL certificate when calling API -from https server.

-
- -
- -
-
-

vmware.vmc_draas.exceptions 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

-
-
-exception vmware.vmc_draas.exceptions.ApiAttributeError(msg, path_to_item=None)
-

Bases: vmware.vmc_draas.exceptions.OpenApiException, AttributeError

-

Raised when an attribute reference or assignment fails.

-
-
Args:

msg (str): the exception message

-
-
Keyword Args:
-
path_to_item (None/list) the path to the exception in the

received_data dict

-
-
-
-
-
- -
-
-exception vmware.vmc_draas.exceptions.ApiException(status=None, reason=None, http_resp=None)
-

Bases: vmware.vmc_draas.exceptions.OpenApiException

-
- -
-
-exception vmware.vmc_draas.exceptions.ApiKeyError(msg, path_to_item=None)
-

Bases: vmware.vmc_draas.exceptions.OpenApiException, KeyError

-
-
Args:

msg (str): the exception message

-
-
Keyword Args:
-
path_to_item (None/list) the path to the exception in the

received_data dict

-
-
-
-
-
- -
-
-exception vmware.vmc_draas.exceptions.ApiTypeError(msg, path_to_item=None, valid_classes=None, key_type=None)
-

Bases: vmware.vmc_draas.exceptions.OpenApiException, TypeError

-

Raises an exception for TypeErrors

-
-
Args:

msg (str): the exception message

-
-
Keyword Args:
-
path_to_item (list): a list of keys an indices to get to the

current_item -None if unset

-
-
valid_classes (tuple): the primitive classes that current item

should be an instance of -None if unset

-
-
key_type (bool): False if our value is a value in a dict

True if it is a key in a dict -False if our item is an item in a list -None if unset

-
-
-
-
-
- -
-
-exception vmware.vmc_draas.exceptions.ApiValueError(msg, path_to_item=None)
-

Bases: vmware.vmc_draas.exceptions.OpenApiException, ValueError

-
-
Args:

msg (str): the exception message

-
-
Keyword Args:
-
path_to_item (list) the path to the exception in the

received_data dict. None if unset

-
-
-
-
-
- -
-
-exception vmware.vmc_draas.exceptions.OpenApiException
-

Bases: Exception

-

The base exception class for all OpenAPIExceptions

-
- -
-
-vmware.vmc_draas.exceptions.render_path(path_to_item)
-

Returns a string representation of a path

-
- -
-
-

vmware.vmc_draas.rest 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.rest.RESTClientObject(configuration, pools_size=4, maxsize=None)
-

Bases: object

-
-
-DELETE(url, headers=None, query_params=None, body=None, _preload_content=True, _request_timeout=None)
-
- -
-
-GET(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)
-
- -
-
-HEAD(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)
-
- -
-
-OPTIONS(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
-
- -
-
-PATCH(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
-
- -
-
-POST(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
-
- -
-
-PUT(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
-
- -
-
-request(method, url, query_params=None, headers=None, body=None, post_params=None, _preload_content=True, _request_timeout=None)
-

Perform requests.

-
-
Parameters
-
    -
  • method – http request method

  • -
  • url – http request url

  • -
  • query_params – query parameters in the url

  • -
  • headers – http request headers

  • -
  • body – request json body, for application/json

  • -
  • post_params – request post parameters, -application/x-www-form-urlencoded -and multipart/form-data

  • -
  • _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.

  • -
-
-
-
- -
- -
-
-class vmware.vmc_draas.rest.RESTResponse(resp)
-

Bases: io.IOBase

-
-
-getheader(name, default=None)
-

Returns a given response header.

-
- -
-
-getheaders()
-

Returns a dictionary of the response headers.

-
- -
- -
-
-

Module contents

-

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

-
-
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/openapi/docs/build/html/vmc/draas/vmware.vmc_draas.models.html b/openapi/docs/build/html/vmc/draas/vmware.vmc_draas.models.html deleted file mode 100644 index 94e9bc0e..00000000 --- a/openapi/docs/build/html/vmc/draas/vmware.vmc_draas.models.html +++ /dev/null @@ -1,2356 +0,0 @@ - - - - - - - - - - vmware.vmc_draas.models package — VMware Automation SDK for Python 0.1.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

vmware.vmc_draas.models package

-
-

Submodules

-
-
-

vmware.vmc_draas.models.abstract_entity 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.models.abstract_entity.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, local_vars_configuration=None)
-

Bases: object

-

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

-

Do not edit the class manually.

-

AbstractEntity - a model defined in OpenAPI

-
-
-attribute_map = {'created': 'created', 'id': 'id', 'updated': 'updated', 'updated_by_user_id': 'updated_by_user_id', 'updated_by_user_name': 'updated_by_user_name', 'user_id': 'user_id', 'user_name': 'user_name', 'version': 'version'}
-
- -
-
-property created
-

Gets the created of this AbstractEntity. # noqa: E501

-
-
Returns
-

The created of this AbstractEntity. # noqa: E501

-
-
Return type
-

datetime

-
-
-
- -
-
-property id
-

Gets the id of this AbstractEntity. # noqa: E501

-
-
Returns
-

The id of this AbstractEntity. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-openapi_types = {'created': 'datetime', 'id': 'str', 'updated': 'datetime', 'updated_by_user_id': 'str', 'updated_by_user_name': 'str', 'user_id': 'str', 'user_name': 'str', 'version': 'int'}
-
- -
-
-to_dict()
-

Returns the model properties as a dict

-
- -
-
-to_str()
-

Returns the string representation of the model

-
- -
-
-property updated
-

Gets the updated of this AbstractEntity. # noqa: E501

-
-
Returns
-

The updated of this AbstractEntity. # noqa: E501

-
-
Return type
-

datetime

-
-
-
- -
-
-property updated_by_user_id
-

Gets the updated_by_user_id of this AbstractEntity. # noqa: E501

-

User id that last updated this record # noqa: E501

-
-
Returns
-

The updated_by_user_id of this AbstractEntity. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property updated_by_user_name
-

Gets the updated_by_user_name of this AbstractEntity. # noqa: E501

-

User name that last updated this record # noqa: E501

-
-
Returns
-

The updated_by_user_name of this AbstractEntity. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property user_id
-

Gets the user_id of this AbstractEntity. # noqa: E501

-

User id that last updated this record # noqa: E501

-
-
Returns
-

The user_id of this AbstractEntity. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property user_name
-

Gets the user_name of this AbstractEntity. # noqa: E501

-

User name that last updated this record # noqa: E501

-
-
Returns
-

The user_name of this AbstractEntity. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property version
-

Gets the version of this AbstractEntity. # noqa: E501

-

Version of this entity # noqa: E501

-
-
Returns
-

The version of this AbstractEntity. # noqa: E501

-
-
Return type
-

int

-
-
-
- -
- -
-
-

vmware.vmc_draas.models.activate_site_recovery_config 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.models.activate_site_recovery_config.ActivateSiteRecoveryConfig(srm_extension_key_suffix=None, local_vars_configuration=None)
-

Bases: object

-

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

-

Do not edit the class manually.

-

ActivateSiteRecoveryConfig - a model defined in OpenAPI

-
-
-attribute_map = {'srm_extension_key_suffix': 'srm_extension_key_suffix'}
-
- -
-
-openapi_types = {'srm_extension_key_suffix': 'str'}
-
- -
-
-property srm_extension_key_suffix
-

Gets the srm_extension_key_suffix of this ActivateSiteRecoveryConfig. # noqa: E501

-

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. # noqa: E501

-
-
Returns
-

The srm_extension_key_suffix of this ActivateSiteRecoveryConfig. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-to_dict()
-

Returns the model properties as a dict

-
- -
-
-to_str()
-

Returns the string representation of the model

-
- -
- -
-
-

vmware.vmc_draas.models.error_response 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.models.error_response.ErrorResponse(status=None, path=None, retryable=None, error_code=None, error_messages=None, local_vars_configuration=None)
-

Bases: object

-

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

-

Do not edit the class manually.

-

ErrorResponse - a model defined in OpenAPI

-
-
-attribute_map = {'error_code': 'error_code', 'error_messages': 'error_messages', 'path': 'path', 'retryable': 'retryable', 'status': 'status'}
-
- -
-
-property error_code
-

Gets the error_code of this ErrorResponse. # noqa: E501

-

unique error code # noqa: E501

-
-
Returns
-

The error_code of this ErrorResponse. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property error_messages
-

Gets the error_messages of this ErrorResponse. # noqa: E501

-

localized error messages # noqa: E501

-
-
Returns
-

The error_messages of this ErrorResponse. # noqa: E501

-
-
Return type
-

list[str]

-
-
-
- -
-
-openapi_types = {'error_code': 'str', 'error_messages': 'list[str]', 'path': 'str', 'retryable': 'bool', 'status': 'int'}
-
- -
-
-property path
-

Gets the path of this ErrorResponse. # noqa: E501

-

Originating request URI # noqa: E501

-
-
Returns
-

The path of this ErrorResponse. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property retryable
-

Gets the retryable of this ErrorResponse. # noqa: E501

-

If true, client should retry operation # noqa: E501

-
-
Returns
-

The retryable of this ErrorResponse. # noqa: E501

-
-
Return type
-

bool

-
-
-
- -
-
-property status
-

Gets the status of this ErrorResponse. # noqa: E501

-

HTTP status code # noqa: E501

-
-
Returns
-

The status of this ErrorResponse. # noqa: E501

-
-
Return type
-

int

-
-
-
- -
-
-to_dict()
-

Returns the model properties as a dict

-
- -
-
-to_str()
-

Returns the string representation of the model

-
- -
- -
-
-

vmware.vmc_draas.models.provision_srm_config 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.models.provision_srm_config.ProvisionSrmConfig(srm_extension_key_suffix=None, local_vars_configuration=None)
-

Bases: object

-

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

-

Do not edit the class manually.

-

ProvisionSrmConfig - a model defined in OpenAPI

-
-
-attribute_map = {'srm_extension_key_suffix': 'srm_extension_key_suffix'}
-
- -
-
-openapi_types = {'srm_extension_key_suffix': 'str'}
-
- -
-
-property srm_extension_key_suffix
-

Gets the srm_extension_key_suffix of this ProvisionSrmConfig. # noqa: E501

-

Optional custom extension key suffix for SRM. If not specified, default extension key will be used. # noqa: E501

-
-
Returns
-

The srm_extension_key_suffix of this ProvisionSrmConfig. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-to_dict()
-

Returns the model properties as a dict

-
- -
-
-to_str()
-

Returns the string representation of the model

-
- -
- -
-
-

vmware.vmc_draas.models.replica_disk 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.models.replica_disk.ReplicaDisk(space_requirement=None, name=None, collection_id=None, datastores_for_single_host_move=None, movable=None, disk_id=None, datastore_mo_id=None, local_vars_configuration=None)
-

Bases: object

-

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

-

Do not edit the class manually.

-

ReplicaDisk - a model defined in OpenAPI

-
-
-attribute_map = {'collection_id': 'collection_id', 'datastore_mo_id': 'datastore_mo_id', 'datastores_for_single_host_move': 'datastores_for_single_host_move', 'disk_id': 'disk_id', 'movable': 'movable', 'name': 'name', 'space_requirement': 'space_requirement'}
-
- -
-
-property collection_id
-

Gets the collection_id of this ReplicaDisk. # noqa: E501

-
-
Returns
-

The collection_id of this ReplicaDisk. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property datastore_mo_id
-

Gets the datastore_mo_id of this ReplicaDisk. # noqa: E501

-
-
Returns
-

The datastore_mo_id of this ReplicaDisk. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property datastores_for_single_host_move
-

Gets the datastores_for_single_host_move of this ReplicaDisk. # noqa: E501

-
-
Returns
-

The datastores_for_single_host_move of this ReplicaDisk. # noqa: E501

-
-
Return type
-

list[object]

-
-
-
- -
-
-property disk_id
-

Gets the disk_id of this ReplicaDisk. # noqa: E501

-
-
Returns
-

The disk_id of this ReplicaDisk. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property movable
-

Gets the movable of this ReplicaDisk. # noqa: E501

-
-
Returns
-

The movable of this ReplicaDisk. # noqa: E501

-
-
Return type
-

bool

-
-
-
- -
-
-property name
-

Gets the name of this ReplicaDisk. # noqa: E501

-
-
Returns
-

The name of this ReplicaDisk. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-openapi_types = {'collection_id': 'str', 'datastore_mo_id': 'str', 'datastores_for_single_host_move': 'list[object]', 'disk_id': 'str', 'movable': 'bool', 'name': 'str', 'space_requirement': 'float'}
-
- -
-
-property space_requirement
-

Gets the space_requirement of this ReplicaDisk. # noqa: E501

-
-
Returns
-

The space_requirement of this ReplicaDisk. # noqa: E501

-
-
Return type
-

float

-
-
-
- -
-
-to_dict()
-

Returns the model properties as a dict

-
- -
-
-to_str()
-

Returns the string representation of the model

-
- -
- -
-
-

vmware.vmc_draas.models.replica_disk_collection 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.models.replica_disk_collection.ReplicaDiskCollection(collection_id=None, generated=None, disks=None, placeholder_vm_mo_id=None, name=None, local_vars_configuration=None)
-

Bases: object

-

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

-

Do not edit the class manually.

-

ReplicaDiskCollection - a model defined in OpenAPI

-
-
-attribute_map = {'collection_id': 'collection_id', 'disks': 'disks', 'generated': 'generated', 'name': 'name', 'placeholder_vm_mo_id': 'placeholder_vm_mo_id'}
-
- -
-
-property collection_id
-

Gets the collection_id of this ReplicaDiskCollection. # noqa: E501

-
-
Returns
-

The collection_id of this ReplicaDiskCollection. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property disks
-

Gets the disks of this ReplicaDiskCollection. # noqa: E501

-
-
Returns
-

The disks of this ReplicaDiskCollection. # noqa: E501

-
-
Return type
-

list[ReplicaDisk]

-
-
-
- -
-
-property generated
-

Gets the generated of this ReplicaDiskCollection. # noqa: E501

-
-
Returns
-

The generated of this ReplicaDiskCollection. # noqa: E501

-
-
Return type
-

datetime

-
-
-
- -
-
-property name
-

Gets the name of this ReplicaDiskCollection. # noqa: E501

-
-
Returns
-

The name of this ReplicaDiskCollection. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-openapi_types = {'collection_id': 'str', 'disks': 'list[ReplicaDisk]', 'generated': 'datetime', 'name': 'str', 'placeholder_vm_mo_id': 'str'}
-
- -
-
-property placeholder_vm_mo_id
-

Gets the placeholder_vm_mo_id of this ReplicaDiskCollection. # noqa: E501

-
-
Returns
-

The placeholder_vm_mo_id of this ReplicaDiskCollection. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-to_dict()
-

Returns the model properties as a dict

-
- -
-
-to_str()
-

Returns the string representation of the model

-
- -
- -
-
-

vmware.vmc_draas.models.site_recovery 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.models.site_recovery.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, local_vars_configuration=None)
-

Bases: object

-

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

-

Do not edit the class manually.

-

SiteRecovery - a model defined in OpenAPI

-
-
-attribute_map = {'created': 'created', 'draas_h5_url': 'draas_h5_url', 'id': 'id', 'sddc_id': 'sddc_id', 'site_recovery_state': 'site_recovery_state', 'srm_nodes': 'srm_nodes', 'updated': 'updated', 'updated_by_user_id': 'updated_by_user_id', 'updated_by_user_name': 'updated_by_user_name', 'user_id': 'user_id', 'user_name': 'user_name', 'version': 'version', 'vr_node': 'vr_node'}
-
- -
-
-property created
-

Gets the created of this SiteRecovery. # noqa: E501

-
-
Returns
-

The created of this SiteRecovery. # noqa: E501

-
-
Return type
-

datetime

-
-
-
- -
-
-property draas_h5_url
-

Gets the draas_h5_url of this SiteRecovery. # noqa: E501

-
-
Returns
-

The draas_h5_url of this SiteRecovery. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property id
-

Gets the id of this SiteRecovery. # noqa: E501

-
-
Returns
-

The id of this SiteRecovery. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-openapi_types = {'created': 'datetime', 'draas_h5_url': 'str', 'id': 'str', 'sddc_id': 'str', 'site_recovery_state': 'str', 'srm_nodes': 'list[SiteRecoveryNode]', 'updated': 'datetime', 'updated_by_user_id': 'str', 'updated_by_user_name': 'str', 'user_id': 'str', 'user_name': 'str', 'version': 'int', 'vr_node': 'SiteRecoveryNode'}
-
- -
-
-property sddc_id
-

Gets the sddc_id of this SiteRecovery. # noqa: E501

-
-
Returns
-

The sddc_id of this SiteRecovery. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property site_recovery_state
-

Gets the site_recovery_state of this SiteRecovery. # noqa: E501

-
-
Returns
-

The site_recovery_state of this SiteRecovery. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property srm_nodes
-

Gets the srm_nodes of this SiteRecovery. # noqa: E501

-
-
Returns
-

The srm_nodes of this SiteRecovery. # noqa: E501

-
-
Return type
-

list[SiteRecoveryNode]

-
-
-
- -
-
-to_dict()
-

Returns the model properties as a dict

-
- -
-
-to_str()
-

Returns the string representation of the model

-
- -
-
-property updated
-

Gets the updated of this SiteRecovery. # noqa: E501

-
-
Returns
-

The updated of this SiteRecovery. # noqa: E501

-
-
Return type
-

datetime

-
-
-
- -
-
-property updated_by_user_id
-

Gets the updated_by_user_id of this SiteRecovery. # noqa: E501

-

User id that last updated this record # noqa: E501

-
-
Returns
-

The updated_by_user_id of this SiteRecovery. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property updated_by_user_name
-

Gets the updated_by_user_name of this SiteRecovery. # noqa: E501

-

User name that last updated this record # noqa: E501

-
-
Returns
-

The updated_by_user_name of this SiteRecovery. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property user_id
-

Gets the user_id of this SiteRecovery. # noqa: E501

-

User id that last updated this record # noqa: E501

-
-
Returns
-

The user_id of this SiteRecovery. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property user_name
-

Gets the user_name of this SiteRecovery. # noqa: E501

-

User name that last updated this record # noqa: E501

-
-
Returns
-

The user_name of this SiteRecovery. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property version
-

Gets the version of this SiteRecovery. # noqa: E501

-

Version of this entity # noqa: E501

-
-
Returns
-

The version of this SiteRecovery. # noqa: E501

-
-
Return type
-

int

-
-
-
- -
-
-property vr_node
-

Gets the vr_node of this SiteRecovery. # noqa: E501

-
-
Returns
-

The vr_node of this SiteRecovery. # noqa: E501

-
-
Return type
-

SiteRecoveryNode

-
-
-
- -
- -
-
-

vmware.vmc_draas.models.site_recovery_all_of 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.models.site_recovery_all_of.SiteRecoveryAllOf(site_recovery_state=None, vr_node=None, srm_nodes=None, sddc_id=None, draas_h5_url=None, local_vars_configuration=None)
-

Bases: object

-

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

-

Do not edit the class manually.

-

SiteRecoveryAllOf - a model defined in OpenAPI

-
-
-attribute_map = {'draas_h5_url': 'draas_h5_url', 'sddc_id': 'sddc_id', 'site_recovery_state': 'site_recovery_state', 'srm_nodes': 'srm_nodes', 'vr_node': 'vr_node'}
-
- -
-
-property draas_h5_url
-

Gets the draas_h5_url of this SiteRecoveryAllOf. # noqa: E501

-
-
Returns
-

The draas_h5_url of this SiteRecoveryAllOf. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-openapi_types = {'draas_h5_url': 'str', 'sddc_id': 'str', 'site_recovery_state': 'str', 'srm_nodes': 'list[SiteRecoveryNode]', 'vr_node': 'SiteRecoveryNode'}
-
- -
-
-property sddc_id
-

Gets the sddc_id of this SiteRecoveryAllOf. # noqa: E501

-
-
Returns
-

The sddc_id of this SiteRecoveryAllOf. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property site_recovery_state
-

Gets the site_recovery_state of this SiteRecoveryAllOf. # noqa: E501

-
-
Returns
-

The site_recovery_state of this SiteRecoveryAllOf. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property srm_nodes
-

Gets the srm_nodes of this SiteRecoveryAllOf. # noqa: E501

-
-
Returns
-

The srm_nodes of this SiteRecoveryAllOf. # noqa: E501

-
-
Return type
-

list[SiteRecoveryNode]

-
-
-
- -
-
-to_dict()
-

Returns the model properties as a dict

-
- -
-
-to_str()
-

Returns the string representation of the model

-
- -
-
-property vr_node
-

Gets the vr_node of this SiteRecoveryAllOf. # noqa: E501

-
-
Returns
-

The vr_node of this SiteRecoveryAllOf. # noqa: E501

-
-
Return type
-

SiteRecoveryNode

-
-
-
- -
- -
-
-

vmware.vmc_draas.models.site_recovery_node 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.models.site_recovery_node.SiteRecoveryNode(local_vars_configuration=None)
-

Bases: object

-

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

-

Do not edit the class manually.

-

SiteRecoveryNode - a model defined in OpenAPI

-
-
-attribute_map = {}
-
- -
-
-openapi_types = {}
-
- -
-
-to_dict()
-

Returns the model properties as a dict

-
- -
-
-to_str()
-

Returns the string representation of the model

-
- -
- -
-
-

vmware.vmc_draas.models.site_recovery_node_all_of 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.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf(vm_moref_id=None, ip_address=None, hostname=None, id=None, state=None, type=None, local_vars_configuration=None)
-

Bases: object

-

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

-

Do not edit the class manually.

-

SiteRecoveryNodeAllOf - a model defined in OpenAPI

-
-
-attribute_map = {'hostname': 'hostname', 'id': 'id', 'ip_address': 'ip_address', 'state': 'state', 'type': 'type', 'vm_moref_id': 'vm_moref_id'}
-
- -
-
-property hostname
-

Gets the hostname of this SiteRecoveryNodeAllOf. # noqa: E501

-
-
Returns
-

The hostname of this SiteRecoveryNodeAllOf. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property id
-

Gets the id of this SiteRecoveryNodeAllOf. # noqa: E501

-
-
Returns
-

The id of this SiteRecoveryNodeAllOf. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property ip_address
-

Gets the ip_address of this SiteRecoveryNodeAllOf. # noqa: E501

-
-
Returns
-

The ip_address of this SiteRecoveryNodeAllOf. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-openapi_types = {'hostname': 'str', 'id': 'str', 'ip_address': 'str', 'state': 'str', 'type': 'str', 'vm_moref_id': 'str'}
-
- -
-
-property state
-

Gets the state of this SiteRecoveryNodeAllOf. # noqa: E501

-
-
Returns
-

The state of this SiteRecoveryNodeAllOf. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-to_dict()
-

Returns the model properties as a dict

-
- -
-
-to_str()
-

Returns the string representation of the model

-
- -
-
-property type
-

Gets the type of this SiteRecoveryNodeAllOf. # noqa: E501

-
-
Returns
-

The type of this SiteRecoveryNodeAllOf. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property vm_moref_id
-

Gets the vm_moref_id of this SiteRecoveryNodeAllOf. # noqa: E501

-
-
Returns
-

The vm_moref_id of this SiteRecoveryNodeAllOf. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
- -
-
-

vmware.vmc_draas.models.site_recovery_node_version 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.models.site_recovery_node_version.SiteRecoveryNodeVersion(version_source=None, node_id=None, build_number=None, appliance_version=None, node_ip=None, full_version=None, node_type=None, local_vars_configuration=None)
-

Bases: object

-

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

-

Do not edit the class manually.

-

SiteRecoveryNodeVersion - a model defined in OpenAPI

-
-
-property appliance_version
-

Gets the appliance_version of this SiteRecoveryNodeVersion. # noqa: E501

-
-
Returns
-

The appliance_version of this SiteRecoveryNodeVersion. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-attribute_map = {'appliance_version': 'appliance_version', 'build_number': 'build_number', 'full_version': 'full_version', 'node_id': 'node_id', 'node_ip': 'node_ip', 'node_type': 'node_type', 'version_source': 'version_source'}
-
- -
-
-property build_number
-

Gets the build_number of this SiteRecoveryNodeVersion. # noqa: E501

-
-
Returns
-

The build_number of this SiteRecoveryNodeVersion. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property full_version
-

Gets the full_version of this SiteRecoveryNodeVersion. # noqa: E501

-
-
Returns
-

The full_version of this SiteRecoveryNodeVersion. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property node_id
-

Gets the node_id of this SiteRecoveryNodeVersion. # noqa: E501

-
-
Returns
-

The node_id of this SiteRecoveryNodeVersion. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property node_ip
-

Gets the node_ip of this SiteRecoveryNodeVersion. # noqa: E501

-
-
Returns
-

The node_ip of this SiteRecoveryNodeVersion. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property node_type
-

Gets the node_type of this SiteRecoveryNodeVersion. # noqa: E501

-
-
Returns
-

The node_type of this SiteRecoveryNodeVersion. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-openapi_types = {'appliance_version': 'str', 'build_number': 'str', 'full_version': 'str', 'node_id': 'str', 'node_ip': 'str', 'node_type': 'str', 'version_source': 'str'}
-
- -
-
-to_dict()
-

Returns the model properties as a dict

-
- -
-
-to_str()
-

Returns the string representation of the model

-
- -
-
-property version_source
-

Gets the version_source of this SiteRecoveryNodeVersion. # noqa: E501

-
-
Returns
-

The version_source of this SiteRecoveryNodeVersion. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
- -
-
-

vmware.vmc_draas.models.site_recovery_versions 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.models.site_recovery_versions.SiteRecoveryVersions(generated=None, sddc_id=None, node_versions=None, local_vars_configuration=None)
-

Bases: object

-

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

-

Do not edit the class manually.

-

SiteRecoveryVersions - a model defined in OpenAPI

-
-
-attribute_map = {'generated': 'generated', 'node_versions': 'node_versions', 'sddc_id': 'sddc_id'}
-
- -
-
-property generated
-

Gets the generated of this SiteRecoveryVersions. # noqa: E501

-
-
Returns
-

The generated of this SiteRecoveryVersions. # noqa: E501

-
-
Return type
-

datetime

-
-
-
- -
-
-property node_versions
-

Gets the node_versions of this SiteRecoveryVersions. # noqa: E501

-

list of site recovery node version # noqa: E501

-
-
Returns
-

The node_versions of this SiteRecoveryVersions. # noqa: E501

-
-
Return type
-

list[SiteRecoveryNodeVersion]

-
-
-
- -
-
-openapi_types = {'generated': 'datetime', 'node_versions': 'list[SiteRecoveryNodeVersion]', 'sddc_id': 'str'}
-
- -
-
-property sddc_id
-

Gets the sddc_id of this SiteRecoveryVersions. # noqa: E501

-
-
Returns
-

The sddc_id of this SiteRecoveryVersions. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-to_dict()
-

Returns the model properties as a dict

-
- -
-
-to_str()
-

Returns the string representation of the model

-
- -
- -
-
-

vmware.vmc_draas.models.task 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.models.task.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, local_vars_configuration=None)
-

Bases: object

-

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

-

Do not edit the class manually.

-

Task - a model defined in OpenAPI

-
-
-attribute_map = {'created': 'created', 'end_time': 'end_time', 'error_message': 'error_message', 'estimated_remaining_minutes': 'estimated_remaining_minutes', 'id': 'id', 'params': 'params', 'parent_task_id': 'parent_task_id', 'progress_percent': 'progress_percent', 'resource_id': 'resource_id', 'resource_type': 'resource_type', 'retries': 'retries', 'start_time': 'start_time', 'status': 'status', 'sub_status': 'sub_status', 'task_progress_phases': 'task_progress_phases', 'task_type': 'task_type', 'task_version': 'task_version', 'tenant_id': 'tenant_id', 'updated': 'updated', 'updated_by_user_id': 'updated_by_user_id', 'updated_by_user_name': 'updated_by_user_name', 'user_id': 'user_id', 'user_name': 'user_name', 'version': 'version'}
-
- -
-
-property created
-

Gets the created of this Task. # noqa: E501

-
-
Returns
-

The created of this Task. # noqa: E501

-
-
Return type
-

datetime

-
-
-
- -
-
-property end_time
-

Gets the end_time of this Task. # noqa: E501

-
-
Returns
-

The end_time of this Task. # noqa: E501

-
-
Return type
-

datetime

-
-
-
- -
-
-property error_message
-

Gets the error_message of this Task. # noqa: E501

-
-
Returns
-

The error_message of this Task. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property estimated_remaining_minutes
-

Gets the estimated_remaining_minutes of this Task. # noqa: E501

-

Estimated remaining time in minute of the task execution, < 0 means no estimation for the task. # noqa: E501

-
-
Returns
-

The estimated_remaining_minutes of this Task. # noqa: E501

-
-
Return type
-

int

-
-
-
- -
-
-property id
-

Gets the id of this Task. # noqa: E501

-
-
Returns
-

The id of this Task. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-openapi_types = {'created': 'datetime', 'end_time': 'datetime', 'error_message': 'str', 'estimated_remaining_minutes': 'int', 'id': 'str', 'params': 'object', 'parent_task_id': 'str', 'progress_percent': 'int', 'resource_id': 'str', 'resource_type': 'str', 'retries': 'int', 'start_time': 'str', 'status': 'str', 'sub_status': 'str', 'task_progress_phases': 'list[TaskProgressPhase]', 'task_type': 'str', 'task_version': 'str', 'tenant_id': 'str', 'updated': 'datetime', 'updated_by_user_id': 'str', 'updated_by_user_name': 'str', 'user_id': 'str', 'user_name': 'str', 'version': 'int'}
-
- -
-
-property params
-

Gets the params of this Task. # noqa: E501

-
-
Returns
-

The params of this Task. # noqa: E501

-
-
Return type
-

object

-
-
-
- -
-
-property parent_task_id
-

Gets the parent_task_id of this Task. # noqa: E501

-
-
Returns
-

The parent_task_id of this Task. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property progress_percent
-

Gets the progress_percent of this Task. # noqa: E501

-

Estimated progress percentage the task executed # noqa: E501

-
-
Returns
-

The progress_percent of this Task. # noqa: E501

-
-
Return type
-

int

-
-
-
- -
-
-property resource_id
-

Gets the resource_id of this Task. # noqa: E501

-

UUID of resources task is acting upon # noqa: E501

-
-
Returns
-

The resource_id of this Task. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property resource_type
-

Gets the resource_type of this Task. # noqa: E501

-

Type of resource being acted upon # noqa: E501

-
-
Returns
-

The resource_type of this Task. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property retries
-

Gets the retries of this Task. # noqa: E501

-
-
Returns
-

The retries of this Task. # noqa: E501

-
-
Return type
-

int

-
-
-
- -
-
-property start_time
-

Gets the start_time of this Task. # noqa: E501

-
-
Returns
-

The start_time of this Task. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property status
-

Gets the status of this Task. # noqa: E501

-
-
Returns
-

The status of this Task. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property sub_status
-

Gets the sub_status of this Task. # noqa: E501

-
-
Returns
-

The sub_status of this Task. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property task_progress_phases
-

Gets the task_progress_phases of this Task. # noqa: E501

-

Task progress phases involved in current task execution # noqa: E501

-
-
Returns
-

The task_progress_phases of this Task. # noqa: E501

-
-
Return type
-

list[TaskProgressPhase]

-
-
-
- -
-
-property task_type
-

Gets the task_type of this Task. # noqa: E501

-
-
Returns
-

The task_type of this Task. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property task_version
-

Gets the task_version of this Task. # noqa: E501

-
-
Returns
-

The task_version of this Task. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property tenant_id
-

Gets the tenant_id of this Task. # noqa: E501

-
-
Returns
-

The tenant_id of this Task. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-to_dict()
-

Returns the model properties as a dict

-
- -
-
-to_str()
-

Returns the string representation of the model

-
- -
-
-property updated
-

Gets the updated of this Task. # noqa: E501

-
-
Returns
-

The updated of this Task. # noqa: E501

-
-
Return type
-

datetime

-
-
-
- -
-
-property updated_by_user_id
-

Gets the updated_by_user_id of this Task. # noqa: E501

-

User id that last updated this record # noqa: E501

-
-
Returns
-

The updated_by_user_id of this Task. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property updated_by_user_name
-

Gets the updated_by_user_name of this Task. # noqa: E501

-

User name that last updated this record # noqa: E501

-
-
Returns
-

The updated_by_user_name of this Task. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property user_id
-

Gets the user_id of this Task. # noqa: E501

-

User id that last updated this record # noqa: E501

-
-
Returns
-

The user_id of this Task. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property user_name
-

Gets the user_name of this Task. # noqa: E501

-

User name that last updated this record # noqa: E501

-
-
Returns
-

The user_name of this Task. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property version
-

Gets the version of this Task. # noqa: E501

-

Version of this entity # noqa: E501

-
-
Returns
-

The version of this Task. # noqa: E501

-
-
Return type
-

int

-
-
-
- -
- -
-
-

vmware.vmc_draas.models.task_all_of 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.models.task_all_of.TaskAllOf(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, local_vars_configuration=None)
-

Bases: object

-

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

-

Do not edit the class manually.

-

TaskAllOf - a model defined in OpenAPI

-
-
-attribute_map = {'end_time': 'end_time', 'error_message': 'error_message', 'estimated_remaining_minutes': 'estimated_remaining_minutes', 'params': 'params', 'parent_task_id': 'parent_task_id', 'progress_percent': 'progress_percent', 'resource_id': 'resource_id', 'resource_type': 'resource_type', 'retries': 'retries', 'start_time': 'start_time', 'status': 'status', 'sub_status': 'sub_status', 'task_progress_phases': 'task_progress_phases', 'task_type': 'task_type', 'task_version': 'task_version', 'tenant_id': 'tenant_id'}
-
- -
-
-property end_time
-

Gets the end_time of this TaskAllOf. # noqa: E501

-
-
Returns
-

The end_time of this TaskAllOf. # noqa: E501

-
-
Return type
-

datetime

-
-
-
- -
-
-property error_message
-

Gets the error_message of this TaskAllOf. # noqa: E501

-
-
Returns
-

The error_message of this TaskAllOf. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property estimated_remaining_minutes
-

Gets the estimated_remaining_minutes of this TaskAllOf. # noqa: E501

-

Estimated remaining time in minute of the task execution, < 0 means no estimation for the task. # noqa: E501

-
-
Returns
-

The estimated_remaining_minutes of this TaskAllOf. # noqa: E501

-
-
Return type
-

int

-
-
-
- -
-
-openapi_types = {'end_time': 'datetime', 'error_message': 'str', 'estimated_remaining_minutes': 'int', 'params': 'object', 'parent_task_id': 'str', 'progress_percent': 'int', 'resource_id': 'str', 'resource_type': 'str', 'retries': 'int', 'start_time': 'str', 'status': 'str', 'sub_status': 'str', 'task_progress_phases': 'list[TaskProgressPhase]', 'task_type': 'str', 'task_version': 'str', 'tenant_id': 'str'}
-
- -
-
-property params
-

Gets the params of this TaskAllOf. # noqa: E501

-
-
Returns
-

The params of this TaskAllOf. # noqa: E501

-
-
Return type
-

object

-
-
-
- -
-
-property parent_task_id
-

Gets the parent_task_id of this TaskAllOf. # noqa: E501

-
-
Returns
-

The parent_task_id of this TaskAllOf. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property progress_percent
-

Gets the progress_percent of this TaskAllOf. # noqa: E501

-

Estimated progress percentage the task executed # noqa: E501

-
-
Returns
-

The progress_percent of this TaskAllOf. # noqa: E501

-
-
Return type
-

int

-
-
-
- -
-
-property resource_id
-

Gets the resource_id of this TaskAllOf. # noqa: E501

-

UUID of resources task is acting upon # noqa: E501

-
-
Returns
-

The resource_id of this TaskAllOf. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property resource_type
-

Gets the resource_type of this TaskAllOf. # noqa: E501

-

Type of resource being acted upon # noqa: E501

-
-
Returns
-

The resource_type of this TaskAllOf. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property retries
-

Gets the retries of this TaskAllOf. # noqa: E501

-
-
Returns
-

The retries of this TaskAllOf. # noqa: E501

-
-
Return type
-

int

-
-
-
- -
-
-property start_time
-

Gets the start_time of this TaskAllOf. # noqa: E501

-
-
Returns
-

The start_time of this TaskAllOf. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property status
-

Gets the status of this TaskAllOf. # noqa: E501

-
-
Returns
-

The status of this TaskAllOf. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property sub_status
-

Gets the sub_status of this TaskAllOf. # noqa: E501

-
-
Returns
-

The sub_status of this TaskAllOf. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property task_progress_phases
-

Gets the task_progress_phases of this TaskAllOf. # noqa: E501

-

Task progress phases involved in current task execution # noqa: E501

-
-
Returns
-

The task_progress_phases of this TaskAllOf. # noqa: E501

-
-
Return type
-

list[TaskProgressPhase]

-
-
-
- -
-
-property task_type
-

Gets the task_type of this TaskAllOf. # noqa: E501

-
-
Returns
-

The task_type of this TaskAllOf. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property task_version
-

Gets the task_version of this TaskAllOf. # noqa: E501

-
-
Returns
-

The task_version of this TaskAllOf. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property tenant_id
-

Gets the tenant_id of this TaskAllOf. # noqa: E501

-
-
Returns
-

The tenant_id of this TaskAllOf. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-to_dict()
-

Returns the model properties as a dict

-
- -
-
-to_str()
-

Returns the string representation of the model

-
- -
- -
-
-

vmware.vmc_draas.models.task_progress_phase 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.models.task_progress_phase.TaskProgressPhase(id=None, name=None, progress_percent=None, local_vars_configuration=None)
-

Bases: object

-

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

-

Do not edit the class manually.

-

TaskProgressPhase - a model defined in OpenAPI

-
-
-attribute_map = {'id': 'id', 'name': 'name', 'progress_percent': 'progress_percent'}
-
- -
-
-property id
-

Gets the id of this TaskProgressPhase. # noqa: E501

-

The identifier of the task progress phase # noqa: E501

-
-
Returns
-

The id of this TaskProgressPhase. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-property name
-

Gets the name of this TaskProgressPhase. # noqa: E501

-

The display name of the task progress phase # noqa: E501

-
-
Returns
-

The name of this TaskProgressPhase. # noqa: E501

-
-
Return type
-

str

-
-
-
- -
-
-openapi_types = {'id': 'str', 'name': 'str', 'progress_percent': 'int'}
-
- -
-
-property progress_percent
-

Gets the progress_percent of this TaskProgressPhase. # noqa: E501

-

The percentage of the phase that has completed # noqa: E501

-
-
Returns
-

The progress_percent of this TaskProgressPhase. # noqa: E501

-
-
Return type
-

int

-
-
-
- -
-
-to_dict()
-

Returns the model properties as a dict

-
- -
-
-to_str()
-

Returns the string representation of the model

-
- -
- -
-
-

Module contents

-

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

-
-
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file